PubNub SDK v5.4.0 release.

Author: client-engineering-bot

.pubnub.yml

@@ -1,5 +1,5 @@
 name: python
-version: 5.3.1
+version: 5.4.0
 schema: 1
 scm: github.com/pubnub/python
 sdks:
@@ -169,6 +169,12 @@ sdks:
                 license-url: https://github.com/aio-libs/aiohttp/blob/master/LICENSE.txt
                 is-required: Required
 changelog:
+  - version: v5.4.0
+    date: 2021-10-07
+    changes:
+      -
+        text: "Parse_token method refactored."
+        type: feature
   - version: v5.3.1
     date: 2021-09-09
     changes:
@@ -469,9 +475,10 @@ features:
     - ACCESS-GRANT
     - ACCESS-GRANT-MANAGE
     - ACCESS-GRANT-DELETE
-    - ACCESS-GRANT-V3
-    - ACCESS-TOKEN-MANAGEMENT
-    - ACCESS-SECRET-KEY-ALL-ACCESS    
+    - ACCESS-SECRET-KEY-ALL-ACCESS
+    - ACCESS-GRANT-TOKEN
+    - ACCESS-PARSE-TOKEN
+    - ACCESS-SET-TOKEN
   channel-groups:
     - CHANNEL-GROUPS-ADD-CHANNELS
     - CHANNEL-GROUPS-REMOVE-CHANNELS

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [v5.4.0](https://github.com/pubnub/python/releases/tag/v5.4.0)
+
+[Full Changelog](https://github.com/pubnub/python/compare/v5.3.1...v5.4.0)
+
+- 🌟️ Parse_token method refactored. 
+
 ## [v5.3.1](https://github.com/pubnub/python/releases/tag/v5.3.1)
 
 [Full Changelog](https://github.com/pubnub/python/compare/v5.3.0...v5.3.1)

pubnub/managers.py

@@ -516,6 +516,42 @@ def set_token(self, token):
     def get_token(self):
         return self.token
 
+    @classmethod
+    def parse_token(cls, token):
+        token = cls.unwrap_token(token)
+
+        parsed_token = {
+            "version": token["v"],
+            "timestamp": token["t"],
+            "ttl": token["ttl"],
+            "authorized_uuid": token.get("uuid"),
+            "resources": {},
+            "patterns": {},
+            "meta": token["meta"]
+        }
+
+        perm_type_name_mapping = {
+            "res": "resources",
+            "pat": "patterns"
+        }
+
+        for resource_type in perm_type_name_mapping:
+            for resource in token[resource_type]:
+                if resource == "uuid":
+                    parsed_token[perm_type_name_mapping[resource_type]]["uuids"] = utils.parse_pam_permissions(
+                        token[resource_type][resource]
+                    )
+                elif resource == "grp":
+                    parsed_token[perm_type_name_mapping[resource_type]]["groups"] = utils.parse_pam_permissions(
+                        token[resource_type][resource]
+                    )
+                elif resource == "chan":
+                    parsed_token[perm_type_name_mapping[resource_type]]["channels"] = utils.parse_pam_permissions(
+                        token[resource_type][resource]
+                    )
+
+        return parsed_token
+
     @staticmethod
     def unwrap_token(token):
         token = token.replace("_", "/").replace("-", "+")

pubnub/pubnub_core.py

@@ -65,7 +65,7 @@
 
 class PubNubCore:
     """A base class for PubNub Python API implementations"""
-    SDK_VERSION = "5.3.1"
+    SDK_VERSION = "5.4.0"
     SDK_NAME = "PubNub-Python"
 
     TIMESTAMP_DIVIDER = 1000
@@ -268,7 +268,7 @@ def delete_messages(self):
         return HistoryDelete(self)
 
     def parse_token(self, token):
-        return self._token_manager.unwrap_token(token)
+        return self._token_manager.parse_token(token)
 
     def set_token(self, token):
         self._token_manager.set_token(token)

pubnub/utils.py

@@ -271,3 +271,51 @@ def decode_utf8_dict(dic):
         return new_l
     else:
         return dic
+
+
+def has_permission(perms, perm):
+    return (perms & perm) == perm
+
+
+def has_read_permission(perms):
+    return has_permission(perms, PAMPermissions.READ.value)
+
+
+def has_write_permission(perms):
+    return has_permission(perms, PAMPermissions.WRITE.value)
+
+
+def has_delete_permission(perms):
+    return has_permission(perms, PAMPermissions.DELETE.value)
+
+
+def has_manage_permission(perms):
+    return has_permission(perms, PAMPermissions.MANAGE.value)
+
+
+def has_get_permission(perms):
+    return has_permission(perms, PAMPermissions.GET.value)
+
+
+def has_update_permission(perms):
+    return has_permission(perms, PAMPermissions.UPDATE.value)
+
+
+def has_join_permission(perms):
+    return has_permission(perms, PAMPermissions.JOIN.value)
+
+
+def parse_pam_permissions(resource):
+    new_res = {}
+    for res_name, perms in resource.items():
+        new_res[res_name] = {
+            "read": has_read_permission(perms),
+            "write": has_write_permission(perms),
+            "manage": has_manage_permission(perms),
+            "delete": has_delete_permission(perms),
+            "get": has_get_permission(perms),
+            "update": has_update_permission(perms),
+            "join": has_join_permission(perms)
+        }
+
+    return new_res

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='pubnub',
-    version='5.3.1',
+    version='5.4.0',
     description='PubNub Real-time push service in the cloud',
     author='PubNub',
     author_email='support@pubnub.com',

tests/acceptance/pam/steps/given_steps.py

@@ -4,11 +4,7 @@
 from pubnub.models.consumer.v3.channel import Channel
 from pubnub.models.consumer.v3.group import Group
 from pubnub.models.consumer.v3.uuid import UUID
-
-from tests.helper import (
-    has_join_permission, has_get_permission, has_read_permission, has_write_permission,
-    has_delete_permission, has_update_permission, has_manage_permission, PAM_TOKEN_WITH_ALL_PERMS_GRANTED
-)
+from tests.helper import PAM_TOKEN_WITH_ALL_PERMS_GRANTED
 
 
 @given("I have a keyset with access manager enabled")
@@ -33,32 +29,32 @@ def step_impl(context, ttl):
 
 @given("token pattern permission READ")
 def step_impl(context):
-    assert has_read_permission(context.token_resource)
+    assert context.token_resource["read"]
 
 
 @given("token pattern permission WRITE")
 def step_impl(context):
-    assert has_write_permission(context.token_resource)
+    assert context.token_resource["write"]
 
 
 @given("token pattern permission MANAGE")
 def step_impl(context):
-    assert has_manage_permission(context.token_resource)
+    assert context.token_resource["manage"]
 
 
 @given("token pattern permission UPDATE")
 def step_impl(context):
-    has_update_permission(context.token_resource)
+    assert context.token_resource["update"]
 
 
 @given("token pattern permission JOIN")
 def step_impl(context):
-    has_join_permission(context.token_resource)
+    assert context.token_resource["join"]
 
 
 @given("token pattern permission DELETE")
 def step_impl(context):
-    has_delete_permission(context.token_resource)
+    assert context.token_resource["delete"]
 
 
 @given("the {uuid_pattern} UUID pattern access permissions")
@@ -73,27 +69,27 @@ def step_impl(context, uuid_pattern):
 
 @given("token resource permission WRITE")
 def step_impl(context):
-    assert has_write_permission(context.token_resource)
+    assert context.token_resource["write"]
 
 
 @given("token resource permission MANAGE")
 def step_impl(context):
-    has_manage_permission(context.token_resource)
+    assert context.token_resource["manage"]
 
 
 @given("token resource permission UPDATE")
 def step_impl(context):
-    assert has_update_permission(context.token_resource)
+    assert context.token_resource["update"]
 
 
 @given("token resource permission JOIN")
 def step_impl(context):
-    assert has_join_permission(context.token_resource)
+    assert context.token_resource["join"]
 
 
 @given("token resource permission DELETE")
 def step_impl(context):
-    assert has_delete_permission(context.token_resource)
+    assert context.token_resource["delete"]
 
 
 @given("grant pattern permission READ")
@@ -143,7 +139,7 @@ def step_impl(context, group_pattern):
 
 @given("token pattern permission GET")
 def step_impl(context):
-    assert has_get_permission(context.token_resource)
+    assert context.token_resource["get"]
 
 
 @given("grant resource permission WRITE")
@@ -208,7 +204,7 @@ def step_impl(context, channel_pattern):
 
 @given("token resource permission GET")
 def step_impl(context):
-    assert has_get_permission(context.token_resource)
+    assert context.token_resource["get"]
 
 
 @given("I have a known token containing UUID pattern Permissions")
@@ -228,7 +224,7 @@ def step_impl(context):
 
 @given("token resource permission READ")
 def step_impl(context):
-    assert has_read_permission(context.token_resource)
+    assert context.token_resource["read"]
 
 
 @given("the authorized UUID {authorized_uuid}")

tests/acceptance/pam/steps/then_steps.py

@@ -13,46 +13,46 @@ def step_impl(context):
 
 @then("the token has {channel} CHANNEL resource access permissions")
 def step_impl(context, channel):
-    context.token_resource = context.parsed_token["res"]["chan"].get(channel.strip("'"))
+    context.token_resource = context.parsed_token["resources"]["channels"].get(channel.strip("'"))
     assert context.token_resource
 
 
 @then("the token contains the authorized UUID {test_uuid}")
 def step_impl(context, test_uuid):
-    assert context.parsed_token.get("uuid") == test_uuid.strip('"')
+    assert context.parsed_token.get("authorized_uuid") == test_uuid.strip('"')
 
 
 @then("the parsed token output contains the authorized UUID {authorized_uuid}")
 def step_impl(context, authorized_uuid):
-    assert context.parsed_token.get("uuid") == authorized_uuid.strip('"')
+    assert context.parsed_token.get("authorized_uuid") == authorized_uuid.strip('"')
 
 
 @then("the token has {uuid} UUID resource access permissions")
 def step_impl(context, uuid):
-    context.token_resource = context.parsed_token["res"]["uuid"].get(uuid.strip("'"))
+    context.token_resource = context.parsed_token["resources"]["uuids"].get(uuid.strip("'"))
     assert context.token_resource
 
 
 @then("the token has {pattern} UUID pattern access permissions")
 def step_impl(context, pattern):
-    context.token_resource = context.parsed_token["pat"]["uuid"].get(pattern.strip("'"))
+    context.token_resource = context.parsed_token["patterns"]["uuids"].get(pattern.strip("'"))
 
 
 @then("the token has {channel_group} CHANNEL_GROUP resource access permissions")
 def step_impl(context, channel_group):
-    context.token_resource = context.parsed_token["res"]["grp"].get(channel_group.strip("'"))
+    context.token_resource = context.parsed_token["resources"]["groups"].get(channel_group.strip("'"))
     assert context.token_resource
 
 
 @then("the token has {channel_pattern} CHANNEL pattern access permissions")
 def step_impl(context, channel_pattern):
-    context.token_resource = context.parsed_token["pat"]["chan"].get(channel_pattern.strip("'"))
+    context.token_resource = context.parsed_token["patterns"]["channels"].get(channel_pattern.strip("'"))
     assert context.token_resource
 
 
 @then("the token has {channel_group} CHANNEL_GROUP pattern access permissions")
 def step_impl(context, channel_group):
-    context.token_resource = context.parsed_token["pat"]["grp"].get(channel_group.strip("'"))
+    context.token_resource = context.parsed_token["patterns"]["groups"].get(channel_group.strip("'"))
     assert context.token_resource
 
 

tests/helper.py

@@ -7,7 +7,6 @@
 from pubnub import utils
 from pubnub.crypto import PubNubCryptodome
 from pubnub.pnconfiguration import PNConfiguration
-from pubnub.enums import PAMPermissions
 
 
 PAM_TOKEN_WITH_ALL_PERMS_GRANTED = (
@@ -191,35 +190,3 @@ def pn_await(self, timeout=5):
 
         self.t.cancel()
         self.lock.release()
-
-
-def has_permission(perms, perm):
-    return (perms & perm) == perm
-
-
-def has_read_permission(perms):
-    return has_permission(perms, PAMPermissions.READ.value)
-
-
-def has_write_permission(perms):
-    return has_permission(perms, PAMPermissions.WRITE.value)
-
-
-def has_delete_permission(perms):
-    return has_permission(perms, PAMPermissions.DELETE.value)
-
-
-def has_manage_permission(perms):
-    return has_permission(perms, PAMPermissions.MANAGE.value)
-
-
-def has_get_permission(perms):
-    return has_permission(perms, PAMPermissions.GET.value)
-
-
-def has_update_permission(perms):
-    return has_permission(perms, PAMPermissions.UPDATE.value)
-
-
-def has_join_permission(perms):
-    return has_permission(perms, PAMPermissions.JOIN.value)