Merge pull request #88 from stefan-qsd/develop

APNS2 push support
pubnub · Feb 21, 2020 · d88b9a7 · d88b9a7
2 parents 99055dd + edf9639
commit d88b9a7
Show file tree

Hide file tree

Showing 14 changed files with 250 additions and 23 deletions.
diff --git a/.pubnub.yml b/.pubnub.yml
@@ -1,8 +1,13 @@
 name: python
-version: 4.3.0
+version: 4.4.0
 schema: 1
 scm: github.com/pubnub/python
 changelog:
+  - version: v4.4.0
+    date: Feb 20, 2020
+    changes:
+      - type: feature
+        text: Add support for APNS2 Push API
   - version: v4.3.0
     date: Jan 28, 2020
     changes:
@@ -178,11 +183,18 @@ features:
     - CHANNEL-GROUPS-REMOVE-CHANNELS
     - CHANNEL-GROUPS-REMOVE-GROUPS
     - CHANNEL-GROUPS-LIST-CHANNELS-IN-GROUP
+  others:
+    - TELEMETRY
+    - CREATE-PUSH-PAYLOAD
   push:
     - PUSH-ADD-DEVICE-TO-CHANNELS
     - PUSH-REMOVE-DEVICE-FROM-CHANNELS
     - PUSH-LIST-CHANNELS-FROM-DEVICE
     - PUSH-REMOVE-DEVICE
+    - PUSH-TYPE-APNS
+    - PUSH-TYPE-APNS2
+    - PUSH-TYPE-FCM
+    - PUSH-TYPE-MPNS
   presence:
     - PRESENCE-HERE-NOW
     - PRESENCE-WHERE-NOW

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## [4.4.0](https://github.com/pubnub/python/tree/v4.4.0)
+
+  [Full Changelog](https://github.com/pubnub/python/compare/v4.3.0...v4.4.0)
+
+- 🌟 Add support for APNS2 Push API
+
 ## [4.3.0](https://github.com/pubnub/python/tree/v4.3.0)
 
   [Full Changelog](https://github.com/pubnub/python/compare/v4.2.1...v4.3.0)

diff --git a/pubnub/endpoints/push/add_channels_to_push.py b/pubnub/endpoints/push/add_channels_to_push.py
@@ -1,22 +1,27 @@
 import six
 
 from pubnub.endpoints.endpoint import Endpoint
-from pubnub.errors import PNERR_CHANNEL_MISSING, PNERR_PUSH_DEVICE_MISSING, PNERROR_PUSH_TYPE_MISSING
+from pubnub.errors import PNERR_CHANNEL_MISSING, PNERR_PUSH_DEVICE_MISSING, PNERROR_PUSH_TYPE_MISSING, \
+    PNERR_PUSH_TOPIC_MISSING
 from pubnub.exceptions import PubNubException
-from pubnub.enums import HttpMethod, PNOperationType
+from pubnub.enums import HttpMethod, PNOperationType, PNPushType, PNPushEnvironment
 from pubnub.models.consumer.push import PNPushAddChannelResult
 from pubnub import utils
 
 
 class AddChannelsToPush(Endpoint):
     # v1/push/sub-key/{subKey}/devices/{pushToken}
     ADD_PATH = "/v1/push/sub-key/%s/devices/%s"
+    # v2/push/sub-key/{subKey}/devices-apns2/{deviceApns2}
+    ADD_PATH_APNS2 = "/v2/push/sub-key/%s/devices-apns2/%s"
 
     def __init__(self, pubnub):
         Endpoint.__init__(self, pubnub)
         self._channels = None
         self._device_id = None
         self._push_type = None
+        self._topic = None
+        self._environment = None
 
     def channels(self, channels):
         self._channels = channels
@@ -30,17 +35,37 @@ def push_type(self, push_type):
         self._push_type = push_type
         return self
 
+    def topic(self, topic):
+        self._topic = topic
+        return self
+
+    def environment(self, environment):
+        self._environment = environment
+        return self
+
     def custom_params(self):
         params = {}
 
         params['add'] = utils.join_items(self._channels)
-        params['type'] = utils.push_type_to_string(self._push_type)
+
+        if self._push_type != PNPushType.APNS2:
+            params['type'] = utils.push_type_to_string(self._push_type)
+        else:
+            if self._environment is None:
+                self._environment = PNPushEnvironment.DEVELOPMENT
+
+            params['environment'] = self._environment
+            params['topic'] = self._topic
 
         return params
 
     def build_path(self):
-        return AddChannelsToPush.ADD_PATH % (
-            self.pubnub.config.subscribe_key, self._device_id)
+        if self._push_type != PNPushType.APNS2:
+            return AddChannelsToPush.ADD_PATH % (
+                self.pubnub.config.subscribe_key, self._device_id)
+        else:
+            return AddChannelsToPush.ADD_PATH_APNS2 % (
+                self.pubnub.config.subscribe_key, self._device_id)
 
     def http_method(self):
         return HttpMethod.GET
@@ -57,6 +82,10 @@ def validate_params(self):
         if self._push_type is None:
             raise PubNubException(pn_error=PNERROR_PUSH_TYPE_MISSING)
 
+        if self._push_type == PNPushType.APNS2:
+            if not isinstance(self._topic, six.string_types) or len(self._topic) == 0:
+                raise PubNubException(pn_error=PNERR_PUSH_TOPIC_MISSING)
+
     def create_response(self, envelope):
         return PNPushAddChannelResult()
 

diff --git a/pubnub/endpoints/push/list_push_provisions.py b/pubnub/endpoints/push/list_push_provisions.py
@@ -1,21 +1,25 @@
 import six
 
 from pubnub.endpoints.endpoint import Endpoint
-from pubnub.errors import PNERR_PUSH_DEVICE_MISSING, PNERROR_PUSH_TYPE_MISSING
+from pubnub.errors import PNERR_PUSH_DEVICE_MISSING, PNERROR_PUSH_TYPE_MISSING, PNERR_PUSH_TOPIC_MISSING
 from pubnub.exceptions import PubNubException
-from pubnub.enums import HttpMethod, PNOperationType
+from pubnub.enums import HttpMethod, PNOperationType, PNPushType, PNPushEnvironment
 from pubnub.models.consumer.push import PNPushListProvisionsResult
 from pubnub import utils
 
 
 class ListPushProvisions(Endpoint):
     # v1/push/sub-key/{subKey}/devices/{pushToken}
     LIST_PATH = "/v1/push/sub-key/%s/devices/%s"
+    # v2/push/sub-key/{subKey}/devices-apns2/{deviceApns2}
+    LIST_PATH_APNS2 = "/v2/push/sub-key/%s/devices-apns2/%s"
 
     def __init__(self, pubnub):
         Endpoint.__init__(self, pubnub)
         self._device_id = None
         self._push_type = None
+        self._topic = None
+        self._environment = None
 
     def device_id(self, device_id):
         self._device_id = device_id
@@ -25,16 +29,35 @@ def push_type(self, push_type):
         self._push_type = push_type
         return self
 
+    def topic(self, topic):
+        self._topic = topic
+        return self
+
+    def environment(self, environment):
+        self._environment = environment
+        return self
+
     def custom_params(self):
         params = {}
 
-        params['type'] = utils.push_type_to_string(self._push_type)
+        if self._push_type != PNPushType.APNS2:
+            params['type'] = utils.push_type_to_string(self._push_type)
+        else:
+            if self._environment is None:
+                self._environment = PNPushEnvironment.DEVELOPMENT
+
+            params['environment'] = self._environment
+            params['topic'] = self._topic
 
         return params
 
     def build_path(self):
-        return ListPushProvisions.LIST_PATH % (
-            self.pubnub.config.subscribe_key, self._device_id)
+        if self._push_type != PNPushType.APNS2:
+            return ListPushProvisions.LIST_PATH % (
+                self.pubnub.config.subscribe_key, self._device_id)
+        else:
+            return ListPushProvisions.LIST_PATH_APNS2 % (
+                self.pubnub.config.subscribe_key, self._device_id)
 
     def http_method(self):
         return HttpMethod.GET
@@ -48,6 +71,10 @@ def validate_params(self):
         if self._push_type is None:
             raise PubNubException(pn_error=PNERROR_PUSH_TYPE_MISSING)
 
+        if self._push_type == PNPushType.APNS2:
+            if not isinstance(self._topic, six.string_types) or len(self._topic) == 0:
+                raise PubNubException(pn_error=PNERR_PUSH_TOPIC_MISSING)
+
     def create_response(self, channels):
         if channels is not None and len(channels) > 0 and isinstance(channels, list):
             return PNPushListProvisionsResult(channels)

diff --git a/pubnub/endpoints/push/remove_channels_from_push.py b/pubnub/endpoints/push/remove_channels_from_push.py
@@ -1,22 +1,27 @@
 import six
 
 from pubnub.endpoints.endpoint import Endpoint
-from pubnub.errors import PNERR_CHANNEL_MISSING, PNERR_PUSH_DEVICE_MISSING, PNERROR_PUSH_TYPE_MISSING
+from pubnub.errors import PNERR_CHANNEL_MISSING, PNERR_PUSH_DEVICE_MISSING, PNERROR_PUSH_TYPE_MISSING, \
+    PNERR_PUSH_TOPIC_MISSING
 from pubnub.exceptions import PubNubException
-from pubnub.enums import HttpMethod, PNOperationType
+from pubnub.enums import HttpMethod, PNOperationType, PNPushType, PNPushEnvironment
 from pubnub.models.consumer.push import PNPushRemoveChannelResult
 from pubnub import utils
 
 
 class RemoveChannelsFromPush(Endpoint):
     # v1/push/sub-key/{subKey}/devices/{pushToken}
     REMOVE_PATH = "/v1/push/sub-key/%s/devices/%s"
+    # v2/push/sub-key/{subKey}/devices-apns2/{deviceApns2}
+    REMOVE_PATH_APNS2 = "/v2/push/sub-key/%s/devices-apns2/%s"
 
     def __init__(self, pubnub):
         Endpoint.__init__(self, pubnub)
         self._channels = None
         self._device_id = None
         self._push_type = None
+        self._topic = None
+        self._environment = None
 
     def channels(self, channels):
         self._channels = channels
@@ -30,14 +35,35 @@ def push_type(self, push_type):
         self._push_type = push_type
         return self
 
+    def topic(self, topic):
+        self._topic = topic
+        return self
+
+    def environment(self, environment):
+        self._environment = environment
+        return self
+
     def custom_params(self):
-        params = {'remove': utils.join_items(self._channels), 'type': utils.push_type_to_string(self._push_type)}
+        params = {'remove': utils.join_items(self._channels)}
+
+        if self._push_type != PNPushType.APNS2:
+            params['type'] = utils.push_type_to_string(self._push_type)
+        else:
+            if self._environment is None:
+                self._environment = PNPushEnvironment.DEVELOPMENT
+
+            params['environment'] = self._environment
+            params['topic'] = self._topic
 
         return params
 
     def build_path(self):
-        return RemoveChannelsFromPush.REMOVE_PATH % (
-            self.pubnub.config.subscribe_key, self._device_id)
+        if self._push_type != PNPushType.APNS2:
+            return RemoveChannelsFromPush.REMOVE_PATH % (
+                self.pubnub.config.subscribe_key, self._device_id)
+        else:
+            return RemoveChannelsFromPush.REMOVE_PATH_APNS2 % (
+                self.pubnub.config.subscribe_key, self._device_id)
 
     def http_method(self):
         return HttpMethod.GET
@@ -54,6 +80,10 @@ def validate_params(self):
         if self._push_type is None:
             raise PubNubException(pn_error=PNERROR_PUSH_TYPE_MISSING)
 
+        if self._push_type == PNPushType.APNS2:
+            if not isinstance(self._topic, six.string_types) or len(self._topic) == 0:
+                raise PubNubException(pn_error=PNERR_PUSH_TOPIC_MISSING)
+
     def create_response(self, envelope):
         return PNPushRemoveChannelResult()
 

diff --git a/pubnub/endpoints/push/remove_device.py b/pubnub/endpoints/push/remove_device.py
@@ -1,21 +1,25 @@
 import six
 
 from pubnub.endpoints.endpoint import Endpoint
-from pubnub.errors import PNERR_PUSH_DEVICE_MISSING, PNERROR_PUSH_TYPE_MISSING
+from pubnub.errors import PNERR_PUSH_DEVICE_MISSING, PNERROR_PUSH_TYPE_MISSING, PNERR_PUSH_TOPIC_MISSING
 from pubnub.exceptions import PubNubException
-from pubnub.enums import HttpMethod, PNOperationType
+from pubnub.enums import HttpMethod, PNOperationType, PNPushType, PNPushEnvironment
 from pubnub.models.consumer.push import PNPushRemoveAllChannelsResult
 from pubnub import utils
 
 
 class RemoveDeviceFromPush(Endpoint):
     # v1/push/sub-key/{subKey}/devices/{pushToken}/remove
     REMOVE_PATH = "/v1/push/sub-key/%s/devices/%s/remove"
+    # v2/push/sub-key/{subKey}/devices-apns2/{deviceApns2}/remove
+    REMOVE_PATH_APNS2 = "/v2/push/sub-key/%s/devices-apns2/%s/remove"
 
     def __init__(self, pubnub):
         Endpoint.__init__(self, pubnub)
         self._device_id = None
         self._push_type = None
+        self._topic = None
+        self._environment = None
 
     def device_id(self, device_id):
         self._device_id = device_id
@@ -25,16 +29,35 @@ def push_type(self, push_type):
         self._push_type = push_type
         return self
 
+    def topic(self, topic):
+        self._topic = topic
+        return self
+
+    def environment(self, environment):
+        self._environment = environment
+        return self
+
     def custom_params(self):
         params = {}
 
-        params['type'] = utils.push_type_to_string(self._push_type)
+        if self._push_type != PNPushType.APNS2:
+            params['type'] = utils.push_type_to_string(self._push_type)
+        else:
+            if self._environment is None:
+                self._environment = PNPushEnvironment.DEVELOPMENT
+
+            params['environment'] = self._environment
+            params['topic'] = self._topic
 
         return params
 
     def build_path(self):
-        return RemoveDeviceFromPush.REMOVE_PATH % (
-            self.pubnub.config.subscribe_key, self._device_id)
+        if self._push_type != PNPushType.APNS2:
+            return RemoveDeviceFromPush.REMOVE_PATH % (
+                self.pubnub.config.subscribe_key, self._device_id)
+        else:
+            return RemoveDeviceFromPush.REMOVE_PATH_APNS2 % (
+                self.pubnub.config.subscribe_key, self._device_id)
 
     def http_method(self):
         return HttpMethod.GET
@@ -48,6 +71,10 @@ def validate_params(self):
         if self._push_type is None:
             raise PubNubException(pn_error=PNERROR_PUSH_TYPE_MISSING)
 
+        if self._push_type == PNPushType.APNS2:
+            if not isinstance(self._topic, six.string_types) or len(self._topic) == 0:
+                raise PubNubException(pn_error=PNERR_PUSH_TOPIC_MISSING)
+
     def create_response(self, envelope):
         return PNPushRemoveAllChannelsResult()
 

diff --git a/pubnub/enums.py b/pubnub/enums.py
@@ -103,6 +103,7 @@ class PNPushType(object):
     APNS = 1
     MPNS = 2
     GCM = 3
+    APNS2 = 4
 
 
 class PNResourceType(object):
@@ -115,3 +116,8 @@ class PNResourceType(object):
 class PNMatchType(object):
     RESOURCE = "resource"
     PATTERN = "pattern"
+
+
+class PNPushEnvironment(object):
+    DEVELOPMENT = "development"
+    PRODUCTION = "production"
diff --git a/pubnub/errors.py b/pubnub/errors.py
@@ -41,3 +41,5 @@
 PNERR_HISTORY_MESSAGE_ACTIONS_MULTIPLE_CHANNELS = "History can return message action data for a single channel only. " \
                                                   "Either pass a single channel or disable the include_message_action" \
                                                   "s flag. "
+
+PNERR_PUSH_TOPIC_MISSING = "Push notification topic is missing. Required only if push type is APNS2."
diff --git a/pubnub/pubnub_core.py b/pubnub/pubnub_core.py
@@ -56,7 +56,7 @@
 
 class PubNubCore:
     """A base class for PubNub Python API implementations"""
-    SDK_VERSION = "4.3.0"
+    SDK_VERSION = "4.4.0"
     SDK_NAME = "PubNub-Python"
 
     TIMESTAMP_DIVIDER = 1000