Grant Token with SUM (#129)

* Grant Token with SUM

* Add tests

* PubNub SDK v6.5.0 release.

Co-authored-by: Client Engineering Bot <60980775+Client Engineering [email protected]>

Author: seba-aln

.pubnub.yml

@@ -1,5 +1,5 @@
 name: python
-version: 6.4.1
+version: 6.5.0
 schema: 1
 scm: github.com/pubnub/python
 sdks:
@@ -18,7 +18,7 @@ sdks:
         distributions:
           - distribution-type: library
             distribution-repository: package
-            package-name: pubnub-6.4.1
+            package-name: pubnub-6.5.0
             location: https://pypi.org/project/pubnub/
             supported-platforms:
               supported-operating-systems:
@@ -97,8 +97,8 @@ sdks:
           -
             distribution-type: library
             distribution-repository: git release
-            package-name: pubnub-6.4.1
-            location: https://github.com/pubnub/python/releases/download/v6.4.1/pubnub-6.4.1.tar.gz
+            package-name: pubnub-6.5.0
+            location: https://github.com/pubnub/python/releases/download/v6.5.0/pubnub-6.5.0.tar.gz
             supported-platforms:
               supported-operating-systems:
                 Linux:
@@ -169,6 +169,11 @@ sdks:
                 license-url: https://github.com/aio-libs/aiohttp/blob/master/LICENSE.txt
                 is-required: Required
 changelog:
+  - date: 2022-07-27
+    version: v6.5.0
+    changes:
+      - type: feature
+        text: "Grant token now supports Users and Spaces."
   - date: 2022-07-14
     version: v6.4.1
     changes:

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v6.5.0
+July 27 2022
+
+#### Added
+- Grant token now supports Users and Spaces.
+
 ## v6.4.1
 July 14 2022
 

pubnub/endpoints/access/grant_token.py

@@ -32,6 +32,18 @@ def authorized_uuid(self, uuid):
         self._authorized_uuid = uuid
         return self
 
+    def authorized_user(self, user):
+        self._authorized_uuid = user
+        return self
+
+    def spaces(self, spaces):
+        self._channels = spaces
+        return self
+
+    def users(self, users):
+        self._uuids = users
+        return self
+
     def channels(self, channels):
         self._channels = channels
         return self
@@ -58,7 +70,7 @@ def build_data(self):
         utils.parse_resources(self._groups, "groups", resources, patterns)
         utils.parse_resources(self._uuids, "uuids", resources, patterns)
         utils.parse_resources(self._uuids, "users", resources, patterns)
-        utils.parse_resources(self._uuids, "spaces", resources, patterns)
+        utils.parse_resources(self._channels, "spaces", resources, patterns)
 
         permissions['resources'] = resources
         permissions['patterns'] = patterns

pubnub/pubnub_core.py

@@ -83,7 +83,7 @@
 
 class PubNubCore:
     """A base class for PubNub Python API implementations"""
-    SDK_VERSION = "6.4.1"
+    SDK_VERSION = "6.5.0"
     SDK_NAME = "PubNub-Python"
 
     TIMESTAMP_DIVIDER = 1000

setup.py

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

tests/integrational/fixtures/native_sync/pam/grant_token_user_space.yaml

@@ -0,0 +1,46 @@
+interactions:
+- request:
+    body: '{"ttl": 60, "permissions": {"resources": {"channels": {"some_space_id":
+      3}, "groups": {}, "uuids": {}, "users": {}, "spaces": {"some_space_id": 3}},
+      "patterns": {"channels": {"some_*": 3}, "groups": {}, "uuids": {}, "users":
+      {}, "spaces": {"some_*": 3}}, "meta": {}, "uuid": "some_user_id"}}'
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '291'
+      Content-type:
+      - application/json
+      User-Agent:
+      - PubNub-Python/6.4.1
+    method: POST
+    uri: https://ps.pndsn.com/v3/pam/sub-c-7ba2ac4c-4836-11e6-85a4-0619f8945a4f/grant
+  response:
+    body:
+      string: !!binary |
+        H4sIAAAAAAAA/1WQzW6DMBCEX6XyOUj8VChwQwGcpq1pjYqBS2UMgQQDaWySQpR3r9Oqh5xWMzuz
+        K30XUFJJgXsBXSUErSvggnhkTAmwAHJoq145X0Foem2ow+5lKzvkl2ssoP/tsy6ZDx94T2E4DsSY
+        C9PgqYXOGUE8NXnr6ahn/ap+v3l2KJnpyDxxZgbDvZqH3FO3UjQNATZKwtshULk05hiiISN2k/fo
+        VJBk+1wjP7c2Z7VX3ejOv+9jmae4+dfF+i+nMpxx9U/1KSmzJ2+KlqRZ6sxsZ2gHO+qgjRbE2rQi
+        kkf6G88ePy2NYhgV4LoAojqeduzGxvtF8/BKe8XqqBAJSeUogGvq+vUH2oM+x00BAAA=
+    headers:
+      Connection:
+      - keep-alive
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Date:
+      - Tue, 26 Jul 2022 09:39:47 GMT
+      Transfer-Encoding:
+      - chunked
+      cache-control:
+      - no-cache, no-store, must-revalidate
+      content-encoding:
+      - gzip
+    status:
+      code: 200
+      message: OK
+version: 1

tests/integrational/fixtures/native_sync/pam/grant_token_with_uuid_and_channels.yaml

@@ -0,0 +1,46 @@
+interactions:
+- request:
+    body: '{"ttl": 60, "permissions": {"resources": {"channels": {"some_channel_id":
+      3}, "groups": {}, "uuids": {}, "users": {}, "spaces": {"some_channel_id": 3}},
+      "patterns": {"channels": {"some_*": 3}, "groups": {}, "uuids": {}, "users":
+      {}, "spaces": {"some_*": 3}}, "meta": {}, "uuid": "some_uuid"}}'
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '292'
+      Content-type:
+      - application/json
+      User-Agent:
+      - PubNub-Python/6.4.1
+    method: POST
+    uri: https://ps.pndsn.com/v3/pam/sub-c-7ba2ac4c-4836-11e6-85a4-0619f8945a4f/grant
+  response:
+    body:
+      string: !!binary |
+        H4sIAAAAAAAA/3WQT2+CMADFv8rSs4dS1GwkHmSFurGRwDKqXJZa/gQEKrSgYvzuw7lk08Tje/m9
+        d/gdQcQUA8YRlLGULI2BAT5azocARkCJTVwNTW3ZaL6xISnfElW6OFr4kuA95mXQbz/9nBG7FfSp
+        XyOtWCJXrOikDek+YdTDHooO3DEx1838LqMHPa9NK1oG2/DMEhv+/YaXzUHcfP3rr/fWmgZwxX4z
+        KS6cHmiM+pijoqLPuOF5NyV44nTOzsvqafmyyPjj+FX7onnq5K7ujlOhhbBLdrMZOI2AjJsu42c/
+        8x89D++sGnw1gyapmGolMBCEp28eF9ZaUQEAAA==
+    headers:
+      Connection:
+      - keep-alive
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Date:
+      - Tue, 26 Jul 2022 09:39:47 GMT
+      Transfer-Encoding:
+      - chunked
+      cache-control:
+      - no-cache, no-store, must-revalidate
+      content-encoding:
+      - gzip
+    status:
+      code: 200
+      message: OK
+version: 1

tests/integrational/native_sync/test_grant_token.py

@@ -0,0 +1,44 @@
+
+from pubnub.pubnub import PubNub
+from pubnub.models.consumer.v3.access_manager import PNGrantTokenResult
+from pubnub.models.consumer.v3.channel import Channel
+from pubnub.models.consumer.v3.space import Space
+from tests.helper import pnconf_pam_copy
+from tests.integrational.vcr_helper import pn_vcr
+
+pubnub = PubNub(pnconf_pam_copy())
+pubnub.config.uuid = "test_grant"
+
+
+@pn_vcr.use_cassette(
+    'tests/integrational/fixtures/native_sync/pam/grant_token_with_uuid_and_channels.yaml',
+    filter_query_parameters=['uuid', 'seqn', 'pnsdk', 'timestamp', 'signature']
+)
+def test_grant_auth_key_with_uuid_and_channels():
+    envelope = pubnub.grant_token()\
+        .ttl(60)\
+        .authorized_uuid('some_uuid')\
+        .channels([
+            Channel().id('some_channel_id').read().write(),
+            Channel().pattern('some_*').read().write()
+        ])\
+        .sync()
+    assert isinstance(envelope.result, PNGrantTokenResult)
+    assert envelope.result.token
+
+
+@pn_vcr.use_cassette(
+    'tests/integrational/fixtures/native_sync/pam/grant_token_user_space.yaml',
+    filter_query_parameters=['uuid', 'seqn', 'pnsdk', 'timestamp', 'signature']
+)
+def test_grant_auth_key_with_user_id_and_spaces():
+    envelope = pubnub.grant_token()\
+        .ttl(60)\
+        .authorized_user('some_user_id')\
+        .spaces([
+            Space().id('some_space_id').read().write(),
+            Space().pattern('some_*').read().write()
+        ])\
+        .sync()
+    assert isinstance(envelope.result, PNGrantTokenResult)
+    assert envelope.result.token