MessageType and SpaceId for Signal endpoint

Author: seba-aln

pubnub/endpoints/signal.py

@@ -11,6 +11,8 @@ def __init__(self, pubnub):
         Endpoint.__init__(self, pubnub)
         self._channel = None
         self._message = None
+        self._space = None
+        self._message_type = None
 
     def channel(self, channel):
         self._channel = str(channel)
@@ -20,6 +22,14 @@ def message(self, message):
         self._message = message
         return self
 
+    def space(self, space):
+        self._space = str(space)
+        return self
+
+    def message_type(self, message_type):
+        self._message_type = message_type
+        return self
+
     def build_path(self):
         stringified_message = utils.write_value_as_string(self._message)
         msg = utils.url_encode(stringified_message)
@@ -29,7 +39,15 @@ def build_path(self):
         )
 
     def custom_params(self):
-        return {}
+        params = {}
+
+        if self._message_type is not None:
+            params['type'] = str(self._message_type)
+
+        if self._space is not None:
+            params['space-id'] = str(self._space)
+
+        return params
 
     def http_method(self):
         return HttpMethod.GET

tests/integrational/fixtures/native_sync/signal/with_space_id.yaml

@@ -0,0 +1,36 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      User-Agent:
+      - PubNub-Python/7.1.0
+    method: GET
+    uri: https://ps.pndsn.com/signal/demo/demo/0/ch1/0/null?space-id=sp1
+  response:
+    body:
+      string: '[1,"Sent","16742259451827459"]'
+    headers:
+      Access-Control-Allow-Methods:
+      - GET
+      Access-Control-Allow-Origin:
+      - '*'
+      Cache-Control:
+      - no-cache
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '30'
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Date:
+      - Fri, 20 Jan 2023 14:45:45 GMT
+    status:
+      code: 200
+      message: OK
+version: 1

tests/integrational/fixtures/native_sync/signal/with_user_message_type.yaml

@@ -0,0 +1,36 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      User-Agent:
+      - PubNub-Python/7.1.0
+    method: GET
+    uri: https://ps.pndsn.com/signal/demo/demo/0/ch1/0/null?type=test_signal
+  response:
+    body:
+      string: '[1,"Sent","16742259449318974"]'
+    headers:
+      Access-Control-Allow-Methods:
+      - GET
+      Access-Control-Allow-Origin:
+      - '*'
+      Cache-Control:
+      - no-cache
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '30'
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Date:
+      - Fri, 20 Jan 2023 14:45:44 GMT
+    status:
+      code: 200
+      message: OK
+version: 1

tests/integrational/native_sync/test_publish.py

@@ -373,8 +373,6 @@ def test_publish_ttl_100(self):
         except PubNubException as e:
             self.fail(e)
 
-    @pn_vcr.use_cassette('tests/integrational/fixtures/native_sync/publish/publish_user_message_type.yaml',
-                         filter_query_parameters=['uuid', 'pnsdk'])
     def test_publish_user_message_type(self):
         with pn_vcr.use_cassette('tests/integrational/fixtures/native_sync/publish/publish_user_message_type.yaml',
                                  filter_query_parameters=['uuid', 'pnsdk']) as cassette:

tests/integrational/native_sync/test_signal.py

@@ -4,6 +4,7 @@
 from pubnub.structures import Envelope
 from tests.helper import pnconf_demo_copy
 from tests.integrational.vcr_helper import pn_vcr
+from urllib.parse import urlparse, parse_qs
 
 
 @pn_vcr.use_cassette('tests/integrational/fixtures/native_sync/signal/single.yaml',
@@ -18,3 +19,31 @@ def test_single_channel():
     assert envelope.result.timetoken == '15640049765289377'
     assert isinstance(envelope.result, PNSignalResult)
     assert isinstance(envelope.status, PNStatus)
+
+
+def test_signal_with_user_message_type():
+    with pn_vcr.use_cassette('tests/integrational/fixtures/native_sync/signal/with_user_message_type.yaml',
+                             filter_query_parameters=['uuid', 'pnsdk']) as cassette:
+        envelope = PubNub(pnconf_demo_copy()).signal().channel("ch1").message_type('test_signal').sync()
+        assert isinstance(envelope, Envelope)
+        assert not envelope.status.is_error()
+        assert int(envelope.result.timetoken) > 0
+        assert len(cassette) == 1
+        uri = urlparse(cassette.requests[0].uri)
+        query = parse_qs(uri.query)
+        assert 'type' in query.keys()
+        assert query['type'] == ['test_signal']
+
+
+def test_signal_with_space_id():
+    with pn_vcr.use_cassette('tests/integrational/fixtures/native_sync/signal/with_space_id.yaml',
+                             filter_query_parameters=['uuid', 'pnsdk']) as cassette:
+        envelope = PubNub(pnconf_demo_copy()).signal().channel('ch1').space('sp1').sync()
+
+        assert isinstance(envelope, Envelope)
+        assert int(envelope.result.timetoken) > 1
+        assert len(cassette) == 1
+        uri = urlparse(cassette.requests[0].uri)
+        query = parse_qs(uri.query)
+        assert 'space-id' in query.keys()
+        assert query['space-id'] == ['sp1']