Merge pull request #74 from pubnub/develop

Release version

Author: qsoftdevelopment

.pubnub.yml

@@ -1,8 +1,13 @@
 name: python
-version: 4.1.4
+version: 4.1.5
 schema: 1
 scm: github.com/pubnub/python
 changelog:
+  - version: v4.1.5
+    date: Aug 9, 2019
+    changes:
+      - type: improvement
+        text: implement Signal
   - version: v4.1.4
     date: Apr 10, 2019
     changes:
@@ -162,6 +167,9 @@ features:
     - SUBSCRIBE-WITH-TIMETOKEN
     - SUBSCRIBE-WILDCARD
     - SUBSCRIBE-PUBLISHER-UUID
+    - SUBSCRIBE-SIGNAL-LISTENER
+  signal:
+    - SIGNAL-SEND
 
 supported-platforms:
   -

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [4.1.5](https://github.com/pubnub/python/tree/v4.1.5)
+
+  [Full Changelog](https://github.com/pubnub/python/compare/v4.1.4...v4.1.5)
+
+- 🐛implement signal
+
 ## [4.1.4](https://github.com/pubnub/python/tree/v4.1.4)
 
   [Full Changelog](https://github.com/pubnub/python/compare/v4.1.3...v4.1.4)

pubnub/callbacks.py

@@ -22,6 +22,9 @@ def message(self, pubnub, message):
     def presence(self, pubnub, presence):
         pass
 
+    def signal(self, pubnub, signal):
+        pass
+
 
 class ReconnectionCallback(object):
     @abstractmethod

pubnub/endpoints/signal.py

@@ -0,0 +1,58 @@
+from pubnub import utils
+from pubnub.endpoints.endpoint import Endpoint
+from pubnub.enums import HttpMethod, PNOperationType
+from pubnub.models.consumer.signal import PNSignalResult
+
+
+class Signal(Endpoint):
+    SIGNAL_PATH = '/signal/%s/%s/0/%s/0/%s'
+
+    def __init__(self, pubnub):
+        Endpoint.__init__(self, pubnub)
+        self._channel = None
+        self._message = None
+
+    def channel(self, channel):
+        self._channel = str(channel)
+        return self
+
+    def message(self, message):
+        self._message = message
+        return self
+
+    def build_path(self):
+        stringified_message = utils.write_value_as_string(self._message)
+        msg = utils.url_encode(stringified_message)
+        return Signal.SIGNAL_PATH % (
+            self.pubnub.config.publish_key, self.pubnub.config.subscribe_key,
+            utils.url_encode(self._channel), msg
+        )
+
+    def custom_params(self):
+        return {}
+
+    def http_method(self):
+        return HttpMethod.GET
+
+    def is_auth_required(self):
+        return True
+
+    def validate_params(self):
+        self.validate_subscribe_key()
+        self.validate_publish_key()
+        self.validate_channel()
+
+    def create_response(self, result):  # pylint: disable=W0221
+        return PNSignalResult(result)
+
+    def request_timeout(self):
+        return self.pubnub.config.non_subscribe_request_timeout
+
+    def connect_timeout(self):
+        return self.pubnub.config.connect_timeout
+
+    def operation_type(self):
+        return PNOperationType.PNSignalOperation
+
+    def name(self):
+        return "Signal"

pubnub/enums.py

@@ -61,6 +61,7 @@ class PNOperationType(object):
     PNHistoryDeleteOperation = 23
     PNMessageCountOperation = 24
     PNFireOperation = 25
+    PNSignalOperation = 26
 
 
 class PNHeartbeatNotificationOptions(object):

pubnub/managers.py

@@ -203,6 +203,10 @@ def announce_message(self, message):
         for callback in self._listeners:
             callback.message(self._pubnub, message)
 
+    def announce_signal(self, signal):
+        for callback in self._listeners:
+            callback.signal(self._pubnub, signal)
+
     def announce_presence(self, presence):
         for callback in self._listeners:
             callback.presence(self._pubnub, presence)
@@ -446,6 +450,7 @@ def endpoint_name_for_operation(operation_type):
             PNOperationType.PNAccessManagerRevoke: 'pam',
 
             PNOperationType.PNTimeOperation: 'pam',
+            PNOperationType.PNSignalOperation: 'sig',
         }[operation_type]
 
         return endpoint

pubnub/models/consumer/pubsub.py

@@ -32,6 +32,10 @@ def __init__(self, message, subscription, channel, timetoken, user_metadata=None
         self.publisher = publisher
 
 
+class PNSignalMessageResult(PNMessageResult):
+    pass
+
+
 class PNPresenceEventResult(object):
     def __init__(self, event, uuid, timestamp, occupancy, subscription, channel,
                  timetoken, state, user_metadata=None):

pubnub/models/consumer/signal.py

@@ -0,0 +1,12 @@
+class PNSignalResult(object):
+    def __init__(self, result):
+        """
+        Representation of signal server response
+
+        :param result: result of signal operation
+        """
+        self.timetoken = result[2]
+        self._result = result
+
+    def __str__(self):
+        return "Signal success with timetoken %s" % self.timetoken

pubnub/models/server/subscribe.py

@@ -32,11 +32,13 @@ def __init__(self):
         self.origination_timetoken = None
         self.publish_metadata = None
         self.only_channel_subscription = False
+        self.is_signal = False
 
     @classmethod
     def from_json(cls, json_input):
         message = SubscribeMessage()
-        message.shard = json_input['a']
+        if 'a' in json_input:
+            message.shard = json_input['a']
         if 'b' in json_input:
             message.subscription_match = json_input['b']
         message.channel = json_input['c']
@@ -48,7 +50,8 @@ def from_json(cls, json_input):
         if 'o' in json_input:
             message.origination_timetoken = json_input['o']
         message.publish_metadata = PublishMetadata.from_json(json_input['p'])
-
+        if 'e' in json_input and json_input['e'] == 1:
+            message.is_signal = True
         return message
 
 

pubnub/pubnub_core.py

@@ -24,6 +24,7 @@
 from .endpoints.presence.where_now import WhereNow
 from .endpoints.history_delete import HistoryDelete
 from .endpoints.message_count import MessageCount
+from .endpoints.signal import Signal
 
 from .endpoints.push.add_channels_to_push import AddChannelsToPush
 from .endpoints.push.remove_channels_from_push import RemoveChannelsFromPush
@@ -165,6 +166,9 @@ def message_counts(self):
     def fire(self):
         return Fire(self)
 
+    def signal(self):
+        return Signal(self)
+
     def time(self):
         return Time(self)