Add message_type and space_id to publish

Author: seba-aln

pubnub/endpoints/pubsub/publish.py

@@ -15,7 +15,9 @@ class Publish(Endpoint, TimeTokenOverrideMixin):
     def __init__(self, pubnub):
         super(Publish, self).__init__(pubnub)
         self._channel = None
+        self._space = None
         self._message = None
+        self._message_type = None
         self._should_store = None
         self._use_post = None
         self._meta = None
@@ -27,10 +29,18 @@ def channel(self, channel):
         self._channel = str(channel)
         return self
 
+    def space(self, space):
+        self._space = str(space)
+        return self
+
     def message(self, message):
         self._message = message
         return self
 
+    def message_type(self, message_type):
+        self._message_type = message_type
+        return self
+
     def use_post(self, use_post):
         self._use_post = bool(use_post)
         return self
@@ -91,6 +101,12 @@ def custom_params(self):
         if self.pubnub.config.auth_key is not None:
             params["auth"] = utils.url_encode(self.pubnub.config.auth_key)
 
+        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 build_path(self):

pubnub/models/consumer/message_type.py

@@ -0,0 +1,21 @@
+class PNMessageType:
+    _internal_type: str = 0
+    _user_type: str = None
+
+    def __init__(self, user_type: str = None) -> None:
+        self._user_type = user_type
+
+    def set_internal_type(self, internal_type: str):
+        self._internal_type = internal_type
+
+    def from_response(user_type: str = None, internal_type: str = None):
+        message_type = PNMessageType(user_type)
+        if internal_type is not None:
+            message_type.set_internal_type(internal_type)
+        return message_type
+
+    def __str__(self) -> str:
+        return self._user_type if self._user_type is not None else str(self._internal_type)
+
+    def toJSON(self) -> str:
+        return str(self)

tests/integrational/fixtures/native_sync/publish/publish_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/publish/pub-c-739aa0fc-3ed5-472b-af26-aca1b333ec52/sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe/0/ch1/0/%22hi%22?seqn=1&space-id=sp1
+  response:
+    body:
+      string: '[1,"Sent","16742188428215060"]'
+    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 12:47:22 GMT
+    status:
+      code: 200
+      message: OK
+version: 1

tests/integrational/fixtures/native_sync/publish/publish_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/publish/pub-c-739aa0fc-3ed5-472b-af26-aca1b333ec52/sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe/0/ch1/0/%22hi%22?seqn=1&type=test_message
+  response:
+    body:
+      string: '[1,"Sent","16742222446704312"]'
+    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 13:44:04 GMT
+    status:
+      code: 200
+      message: OK
+version: 1

tests/integrational/native_sync/test_publish.py

@@ -8,6 +8,7 @@
 from tests.helper import pnconf, pnconf_demo_copy, pnconf_enc, pnconf_file_copy
 from tests.integrational.vcr_helper import pn_vcr
 from unittest.mock import patch
+from urllib.parse import urlparse, parse_qs
 
 pubnub.set_stream_logger('pubnub', logging.DEBUG)
 
@@ -371,3 +372,36 @@ def test_publish_ttl_100(self):
             assert env.result.timetoken > 1
         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:
+            try:
+                env = PubNub(pnconf).publish().channel("ch1").message("hi").message_type('test_message').sync()
+                assert isinstance(env.result, PNPublishResult)
+                assert env.result.timetoken > 1
+                assert len(cassette) == 1
+                uri = urlparse(cassette.requests[0].uri)
+                query = parse_qs(uri.query)
+                assert 'type' in query.keys()
+                assert query['type'] == ['test_message']
+            except PubNubException as e:
+                self.fail(e)
+
+    def test_publish_space_id(self):
+        with pn_vcr.use_cassette('tests/integrational/fixtures/native_sync/publish/publish_space_id.yaml',
+                                 filter_query_parameters=['uuid', 'pnsdk']) as cassette:
+            try:
+                env = PubNub(pnconf).publish().channel('ch1').space('sp1').message("hi").sync()
+
+                assert isinstance(env.result, PNPublishResult)
+                assert env.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']
+            except PubNubException as e:
+                self.fail(e)