PubNub SDK v4.6.1 release.

Author: client-engineering-bot

.pubnub.yml

@@ -1,8 +1,14 @@
 name: python
-version: 4.6.0
+version: 4.6.1
 schema: 1
 scm: github.com/pubnub/python
 changelog:
+  - version: v4.6.1
+    date: Oct 27, 2020
+    changes:
+      -
+        text: "Passing uuid to the get_state endpoint call added."
+        type: bug
   - version: v4.6.0
     date: Oct 22, 2020
     changes:

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [v4.6.1](https://github.com/pubnub/python/releases/tag/v4.6.1)
+
+[Full Changelog](https://github.com/pubnub/python/compare/v4.6.0...v4.6.1)
+
+- 🐛 Passing uuid to the get_state endpoint call added. 
+
 ## [v4.6.0](https://github.com/pubnub/python/releases/tag/v4.6.0)
 
 [Full Changelog](https://github.com/pubnub/python/compare/v4.5.4...v4.6.0)

pubnub/endpoints/presence/get_state.py

@@ -2,21 +2,27 @@
 from pubnub.endpoints.endpoint import Endpoint
 from pubnub.enums import HttpMethod, PNOperationType
 from pubnub.models.consumer.presence import PNGetStateResult
+from pubnub.endpoints.validators import UUIDValidatorMixin
 
 
-class GetState(Endpoint):
+class GetState(Endpoint, UUIDValidatorMixin):
     # /v2/presence/sub-key/<subscribe_key>/channel/<channel>/uuid/<uuid>/data?state=<state>
     GET_STATE_PATH = "/v2/presence/sub-key/%s/channel/%s/uuid/%s"
 
     def __init__(self, pubnub):
         Endpoint.__init__(self, pubnub)
         self._channels = []
         self._groups = []
+        self._uuid = self.pubnub.uuid
 
     def channels(self, channels):
         utils.extend_list(self._channels, channels)
         return self
 
+    def uuid(self, uuid):
+        self._uuid = uuid
+        return self
+
     def channel_groups(self, channel_groups):
         utils.extend_list(self._groups, channel_groups)
         return self
@@ -33,16 +39,16 @@ def build_path(self):
         return GetState.GET_STATE_PATH % (
             self.pubnub.config.subscribe_key,
             utils.join_channels(self._channels),
-            utils.url_encode(self.pubnub.uuid)
+            utils.url_encode(self._uuid)
         )
 
     def http_method(self):
         return HttpMethod.GET
 
     def validate_params(self):
         self.validate_subscribe_key()
-
         self.validate_channels_and_groups()
+        self.validate_uuid()
 
     def create_response(self, envelope):
         if len(self._channels) == 1 and len(self._groups) == 0:

pubnub/endpoints/presence/where_now.py

@@ -1,14 +1,11 @@
-import six
-
 from pubnub import utils
 from pubnub.endpoints.endpoint import Endpoint
 from pubnub.enums import HttpMethod, PNOperationType
-from pubnub.errors import PNERR_UUID_MISSING
-from pubnub.exceptions import PubNubException
 from pubnub.models.consumer.presence import PNWhereNowResult
+from pubnub.endpoints.validators import UUIDValidatorMixin
 
 
-class WhereNow(Endpoint):
+class WhereNow(Endpoint, UUIDValidatorMixin):
     # /v2/presence/sub-key/<subscribe_key>/uuid/<uuid>
     WHERE_NOW_PATH = "/v2/presence/sub-key/%s/uuid/%s"
 
@@ -31,9 +28,7 @@ def http_method(self):
 
     def validate_params(self):
         self.validate_subscribe_key()
-
-        if self._uuid is None or not isinstance(self._uuid, six.string_types):
-            raise PubNubException(pn_error=PNERR_UUID_MISSING)
+        self.validate_uuid()
 
     def is_auth_required(self):
         return True

pubnub/endpoints/validators.py

@@ -0,0 +1,10 @@
+import six
+
+from pubnub.errors import PNERR_UUID_MISSING
+from pubnub.exceptions import PubNubException
+
+
+class UUIDValidatorMixin:
+    def validate_uuid(self):
+        if self._uuid is None or not isinstance(self._uuid, six.string_types):
+            raise PubNubException(pn_error=PNERR_UUID_MISSING)

pubnub/pubnub_core.py

@@ -63,7 +63,7 @@
 
 class PubNubCore:
     """A base class for PubNub Python API implementations"""
-    SDK_VERSION = "4.6.0"
+    SDK_VERSION = "4.6.1"
     SDK_NAME = "PubNub-Python"
 
     TIMESTAMP_DIVIDER = 1000

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='pubnub',
-    version='4.6.0',
+    version='4.6.1',
     description='PubNub Real-time push service in the cloud',
     author='PubNub',
     author_email='[email protected]',

tests/integrational/fixtures/native_sync/state/state_with_user_defined_uuid.yaml

@@ -0,0 +1,44 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      User-Agent:
+      - PubNub-Python/4.6.0
+    method: GET
+    uri: https://ps.pndsn.com/v2/presence/sub-key/sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe/channel/state-native-sync-ch/uuid/state-native-sync-uuid
+  response:
+    body:
+      string: '{"status": 200, "message": "OK", "payload": {"count": 5, "name": "Alex"},
+        "uuid": "state-native-sync-uuid", "channel": "state-native-sync-ch", "service":
+        "Presence"}'
+    headers:
+      Accept-Ranges:
+      - bytes
+      Access-Control-Allow-Methods:
+      - OPTIONS, GET, POST
+      Access-Control-Allow-Origin:
+      - '*'
+      Age:
+      - '0'
+      Cache-Control:
+      - no-cache
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '165'
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Date:
+      - Mon, 26 Oct 2020 16:37:28 GMT
+      Server:
+      - Pubnub Presence
+    status:
+      code: 200
+      message: OK
+version: 1

tests/integrational/native_sync/test_state.py

@@ -78,3 +78,17 @@ def test_super_call(self):
         assert env.result.channels[ch2]['name'] == "Alex"
         assert env.result.channels[ch1]['count'] == 5
         assert env.result.channels[ch2]['count'] == 5
+
+    @pn_vcr.use_cassette('tests/integrational/fixtures/native_sync/state/state_with_user_defined_uuid.yaml',
+                         filter_query_parameters=['uuid', 'pnsdk'], match_on=['state_object_in_query'])
+    def test_get_state_passes_user_defined_uuid(self):
+        ch = "state-native-sync-ch"
+        pubnub = PubNub(pnconf_copy())
+        pubnub.config.uuid = "test_uuid"
+        client_uuid = "state-native-sync-uuid"
+
+        envelope = pubnub.get_state().channels(ch).uuid(client_uuid).sync()
+
+        assert isinstance(envelope.result, PNGetStateResult)
+        assert envelope.result.channels[ch]['name'] == "Alex"
+        assert envelope.result.channels[ch]['count'] == 5