Implementing support for APNS mutable-content field (#143)

* Implementing support for APNS content-mutable field

* Corrected the mutable-content option name

* Renamed custom_fields to custom_data; Updated CHANGELOG

* Cleaned up tests for clarity

Author: hiranya911

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Unreleased
 
--
+- [added] Added the `mutable_content` optional field to the `messaging.Aps`
+  type.
+- [added] Added support for specifying arbitrary custom key-value
+  fields in the `messaging.Aps` type.
 
 # v2.9.1
 

firebase_admin/messaging.py

@@ -343,16 +343,22 @@ class Aps(object):
             notification (optional).
         category: String identifier representing the message type (optional).
         thread_id: An app-specific string identifier for grouping messages (optional).
+        mutable_content: A boolean indicating whether to support mutating notifications at
+            the client using app extensions (optional).
+        custom_data: A dict of custom key-value pairs to be included in the Aps dictionary
+            (optional).
     """
 
     def __init__(self, alert=None, badge=None, sound=None, content_available=None, category=None,
-                 thread_id=None):
+                 thread_id=None, mutable_content=None, custom_data=None):
         self.alert = alert
         self.badge = badge
         self.sound = sound
         self.content_available = content_available
         self.category = category
         self.thread_id = thread_id
+        self.mutable_content = mutable_content
+        self.custom_data = custom_data
 
 
 class ApsAlert(object):
@@ -624,6 +630,16 @@ def encode_aps(cls, aps):
         }
         if aps.content_available is True:
             result['content-available'] = 1
+        if aps.mutable_content is True:
+            result['mutable-content'] = 1
+        if aps.custom_data is not None:
+            if not isinstance(aps.custom_data, dict):
+                raise ValueError('Aps.custom_data must be a dict.')
+            for key, val in aps.custom_data.items():
+                _Validators.check_string('Aps.custom_data key', key)
+                if key in result:
+                    raise ValueError('Multiple specifications for {0} in Aps.'.format(key))
+                result[key] = val
         return cls.remove_null_values(result)
 
     @classmethod

tests/test_messaging.py

@@ -537,11 +537,9 @@ def test_apns_payload(self):
 
 class TestApsEncoder(object):
 
-    def _check_aps(self, aps):
-        with pytest.raises(ValueError) as excinfo:
-            check_encoding(messaging.Message(
-                topic='topic', apns=messaging.APNSConfig(payload=messaging.APNSPayload(aps=aps))))
-        return excinfo
+    def _encode_aps(self, aps):
+        return check_encoding(messaging.Message(
+            topic='topic', apns=messaging.APNSConfig(payload=messaging.APNSPayload(aps=aps))))
 
     @pytest.mark.parametrize('data', NON_OBJECT_ARGS)
     def test_invalid_aps(self, data):
@@ -555,38 +553,68 @@ def test_invalid_aps(self, data):
     @pytest.mark.parametrize('data', NON_STRING_ARGS)
     def test_invalid_alert(self, data):
         aps = messaging.Aps(alert=data)
-        excinfo = self._check_aps(aps)
+        with pytest.raises(ValueError) as excinfo:
+            self._encode_aps(aps)
         expected = 'Aps.alert must be a string or an instance of ApsAlert class.'
         assert str(excinfo.value) == expected
 
     @pytest.mark.parametrize('data', [list(), tuple(), dict(), 'foo'])
     def test_invalid_badge(self, data):
         aps = messaging.Aps(badge=data)
-        excinfo = self._check_aps(aps)
+        with pytest.raises(ValueError) as excinfo:
+            self._encode_aps(aps)
         expected = 'Aps.badge must be a number.'
         assert str(excinfo.value) == expected
 
     @pytest.mark.parametrize('data', NON_STRING_ARGS)
     def test_invalid_sound(self, data):
         aps = messaging.Aps(sound=data)
-        excinfo = self._check_aps(aps)
+        with pytest.raises(ValueError) as excinfo:
+            self._encode_aps(aps)
         expected = 'Aps.sound must be a string.'
         assert str(excinfo.value) == expected
 
     @pytest.mark.parametrize('data', NON_STRING_ARGS)
     def test_invalid_category(self, data):
         aps = messaging.Aps(category=data)
-        excinfo = self._check_aps(aps)
+        with pytest.raises(ValueError) as excinfo:
+            self._encode_aps(aps)
         expected = 'Aps.category must be a string.'
         assert str(excinfo.value) == expected
 
     @pytest.mark.parametrize('data', NON_STRING_ARGS)
     def test_invalid_thread_id(self, data):
         aps = messaging.Aps(thread_id=data)
-        excinfo = self._check_aps(aps)
+        with pytest.raises(ValueError) as excinfo:
+            self._encode_aps(aps)
         expected = 'Aps.thread_id must be a string.'
         assert str(excinfo.value) == expected
 
+    @pytest.mark.parametrize('data', ['', list(), tuple(), True, False, 1, 0, ])
+    def test_invalid_custom_data_dict(self, data):
+        if isinstance(data, dict):
+            return
+        aps = messaging.Aps(custom_data=data)
+        with pytest.raises(ValueError) as excinfo:
+            self._encode_aps(aps)
+        expected = 'Aps.custom_data must be a dict.'
+        assert str(excinfo.value) == expected
+
+    @pytest.mark.parametrize('data', [True, False, 1, 0])
+    def test_invalid_custom_field_name(self, data):
+        aps = messaging.Aps(custom_data={data: 'foo'})
+        with pytest.raises(ValueError) as excinfo:
+            self._encode_aps(aps)
+        expected = 'Aps.custom_data key must be a string.'
+        assert str(excinfo.value) == expected
+
+    def test_multiple_field_specifications(self):
+        aps = messaging.Aps(thread_id='foo', custom_data={'thread-id': 'foo'})
+        with pytest.raises(ValueError) as excinfo:
+            self._encode_aps(aps)
+        expected = 'Multiple specifications for thread-id in Aps.'
+        assert str(excinfo.value) == expected
+
     def test_aps(self):
         msg = messaging.Message(
             topic='topic',
@@ -597,6 +625,7 @@ def test_aps(self):
                         badge=42,
                         sound='s',
                         content_available=True,
+                        mutable_content=True,
                         category='c',
                         thread_id='t'
                     ),
@@ -612,6 +641,7 @@ def test_aps(self):
                         'badge': 42,
                         'sound': 's',
                         'content-available': 1,
+                        'mutable-content': 1,
                         'category': 'c',
                         'thread-id': 't',
                     },
@@ -620,6 +650,32 @@ def test_aps(self):
         }
         check_encoding(msg, expected)
 
+    def test_aps_custom_data(self):
+        msg = messaging.Message(
+            topic='topic',
+            apns=messaging.APNSConfig(
+                payload=messaging.APNSPayload(
+                    aps=messaging.Aps(
+                        alert='alert text',
+                        custom_data={'k1': 'v1', 'k2': 1},
+                    ),
+                )
+            )
+        )
+        expected = {
+            'topic': 'topic',
+            'apns': {
+                'payload': {
+                    'aps': {
+                        'alert': 'alert text',
+                        'k1': 'v1',
+                        'k2': 1,
+                    },
+                }
+            },
+        }
+        check_encoding(msg, expected)
+
 
 class TestApsAlertEncoder(object):