PubNub SDK v5.2.0 release.

Author: client-engineering-bot

.pubnub.yml

@@ -1,5 +1,5 @@
 name: python
-version: 5.1.4
+version: 5.2.0
 schema: 1
 scm: github.com/pubnub/python
 sdks:
@@ -169,8 +169,14 @@ sdks:
                 license-url: https://github.com/aio-libs/aiohttp/blob/master/LICENSE.txt
                 is-required: Required
 changelog:
+  - version: v5.2.0
+    date: 2021-08-31
+    changes:
+      -
+        text: "Furthermore PAMv3 tokens can now be used within other PubNub features."
+        type: feature
   - version: v5.1.4
-    date: Jun 29, 2021
+    date: 2021-06-29
     changes:
       -
         text: "Additionally, example code for the FastAPI integration was added."
@@ -179,7 +185,7 @@ changelog:
     date: 2021-04-26
     changes:
       -
-        text: "Disabling default request headers within the Endpoind."
+        text: "Disabling default request headers within the Endpoint."
         type: bug
   - version: v5.1.2
     date: 2021-04-15

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [v5.2.0](https://github.com/pubnub/python/releases/tag/v5.2.0)
+
+[Full Changelog](https://github.com/pubnub/python/compare/v5.1.4...v5.2.0)
+
+- 🌟️ Furthermore PAMv3 tokens can now be used within other PubNub features. 
+
 ## [v5.1.4](https://github.com/pubnub/python/releases/tag/v5.1.4)
 
 [Full Changelog](https://github.com/pubnub/python/compare/v5.1.3...v5.1.4)

DEVELOPER.md

@@ -1,7 +1,7 @@
 # Developers manual
 
 ## Supported Python versions
-We support Python 2.7 and >=3.4
+We support Python 3.6, 3.7, 3.8, 3.9
 
 ## Supported platforms
 We maintain and test our SDK using Travis.CI and Ubuntu.
@@ -30,26 +30,17 @@ There are 2 types of calls:
 
 You can find more examples here https://github.com/pubnub/python/blob/master/tests/integrational/asyncio/test_invocations.py
 
-### Tornado
-Tornado supports by Python 2.7 and Python >= 3.3.
-There are 2 types of calls:
-- using `result()` - only a result will be returned; in case of exception it will be raised natively
-- using `future()` - a wrapper (Envelope) for a result and a status; in case of exception it can be checked using env.is_error()
-
-You can find more examples here https://github.com/pubnub/python/blob/master/tests/integrational/tornado/test_invocations.py
-
-### Twisted
-Twisted is supported by Python 2.7 only.
-
 ## Tests
 * Test runner: py.test
 * Source code checker: flake
+* BDD tests runner: behave - one needs to place needed feature file under acceptance/name_of_the_feature directory.
+   An example: `behave tests/acceptance/pam`
 
 ## Daemon mode with Native SDK
 Daemon mode for all requests are disabled by default. This means that all asynchronous requests including will block the main thread until all the children be closed. If SDK user want to use Java-like behaviour when it's up to him to decide should he wait for response completion or continue program execution, he has to explicitly set daemon mode to true:
 
 ```python
-pubnub.config.daemon = true
+pubnub.config.daemon = True
 ```
 
 ## SubscribeListener

pubnub/endpoints/access/grant_token.py

@@ -1,6 +1,6 @@
 from pubnub import utils
 from pubnub.endpoints.endpoint import Endpoint
-from pubnub.errors import PNERR_RESOURCES_MISSING, PNERR_TTL_MISSING, PNERR_INVALID_META
+from pubnub.errors import PNERR_TTL_MISSING, PNERR_INVALID_META, PNERR_RESOURCES_MISSING
 from pubnub.exceptions import PubNubException
 from pubnub.enums import HttpMethod, PNOperationType
 from pubnub.models.consumer.v3.access_manager import PNGrantTokenResult
@@ -9,20 +9,14 @@
 class GrantToken(Endpoint):
     GRANT_TOKEN_PATH = "/v3/pam/%s/grant"
 
-    READ = 1
-    WRITE = 2
-    MANAGE = 4
-    DELETE = 8
-    CREATE = 16
-
     def __init__(self, pubnub):
         Endpoint.__init__(self, pubnub)
         self._ttl = None
         self._meta = None
+        self._authorized_uuid = None
         self._channels = []
         self._groups = []
-        self._users = []
-        self._spaces = []
+        self._uuids = []
 
         self._sort_params = True
 
@@ -34,6 +28,10 @@ def meta(self, meta):
         self._meta = meta
         return self
 
+    def authorized_uuid(self, uuid):
+        self._authorized_uuid = uuid
+        return self
+
     def channels(self, channels):
         self._channels = channels
         return self
@@ -42,40 +40,40 @@ def groups(self, groups):
         self._groups = groups
         return self
 
-    def users(self, users):
-        self._users = users
-        return self
-
-    def spaces(self, spaces):
-        self._spaces = spaces
+    def uuids(self, uuids):
+        self._uuids = uuids
         return self
 
     def custom_params(self):
         return {}
 
     def build_data(self):
-        params = {'ttl': str(self._ttl)}
+        params = {'ttl': int(self._ttl)}
 
         permissions = {}
         resources = {}
         patterns = {}
 
         utils.parse_resources(self._channels, "channels", resources, patterns)
         utils.parse_resources(self._groups, "groups", resources, patterns)
-        utils.parse_resources(self._users, "users", resources, patterns)
-        utils.parse_resources(self._spaces, "spaces", 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)
 
         permissions['resources'] = resources
         permissions['patterns'] = patterns
 
-        if self._meta is not None:
+        if self._meta:
             if isinstance(self._meta, dict):
                 permissions['meta'] = self._meta
             else:
                 raise PubNubException(pn_error=PNERR_INVALID_META)
         else:
             permissions['meta'] = {}
 
+        if self._authorized_uuid:
+            permissions["uuid"] = self._authorized_uuid
+
         params['permissions'] = permissions
 
         return utils.write_value_as_string(params)
@@ -111,12 +109,9 @@ def name(self):
         return "Grant Token"
 
     def validate_resources(self):
-        if (self._channels is None or len(self._channels) == 0) and \
-           (self._groups is None or len(self._groups) == 0) and \
-           (self._users is None or len(self._users) == 0) and \
-           (self._spaces is None or len(self._spaces) == 0):
+        if not any((self._channels, self._groups, self._uuids)):
             raise PubNubException(pn_error=PNERR_RESOURCES_MISSING)
 
     def validate_ttl(self):
-        if self._ttl is None:
+        if not self._ttl:
             raise PubNubException(pn_error=PNERR_TTL_MISSING)

pubnub/endpoints/endpoint.py

@@ -183,19 +183,13 @@ def callback(params_to_merge):
             for query_key, query_value in self.pubnub._telemetry_manager.operation_latencies().items():
                 custom_params[query_key] = query_value
 
-            if self.is_auth_required() and self.pubnub.config.auth_key is not None:
-                custom_params['auth'] = self.pubnub.config.auth_key
-
-            if self.pubnub.config.disable_token_manager is False and self.pubnub.config.auth_key is None:
-                tms_properties = self.get_tms_properties()
-                if tms_properties is not None:
-                    token = self.pubnub.get_token(tms_properties)
-                    if token is not None:
-                        custom_params['auth'] = token
-                    else:
-                        logger.warning("No token found for: " + str(tms_properties))
-
-            if self.pubnub.config.secret_key is not None:
+            if self.is_auth_required():
+                if self.pubnub._get_token():
+                    custom_params["auth"] = self.pubnub._get_token()
+                elif self.pubnub.config.auth_key:
+                    custom_params["auth"] = self.pubnub.config.auth_key
+
+            if self.pubnub.config.secret_key:
                 utils.sign_request(self, self.pubnub, custom_params, self.http_method(), self.build_data())
 
             custom_params.update(self.encoded_params())
@@ -283,6 +277,3 @@ def create_exception(self, category, response, response_info, exception):
         exception.status = status
 
         return exception
-
-    def get_tms_properties(self):
-        return None

pubnub/enums.py

@@ -1,3 +1,6 @@
+from enum import Enum
+
+
 class HttpMethod(object):
     GET = 1
     POST = 2
@@ -135,3 +138,14 @@ class PNMatchType(object):
 class PNPushEnvironment(object):
     DEVELOPMENT = "development"
     PRODUCTION = "production"
+
+
+class PAMPermissions(Enum):
+    READ = 1
+    WRITE = 2
+    MANAGE = 4
+    DELETE = 8
+    CREATE = 16
+    GET = 32
+    UPDATE = 64
+    JOIN = 128

pubnub/errors.py

@@ -32,7 +32,6 @@
 PNERR_RESOURCES_MISSING = "Resources missing"
 PNERR_TTL_MISSING = "TTL missing"
 PNERR_INVALID_META = "Invalid meta parameter"
-PNERR_PERMISSION_MISSING = "Permission missing"
 PNERR_INVALID_ACCESS_TOKEN = "Invalid access token"
 PNERR_MESSAGE_ACTION_MISSING = "Message action is missing"
 PNERR_MESSAGE_ACTION_TYPE_MISSING = "Message action type is missing"

pubnub/managers.py

@@ -8,7 +8,7 @@
 from cbor2 import loads
 
 from . import utils
-from .enums import PNStatusCategory, PNReconnectionPolicy, PNOperationType, PNResourceType, PNMatchType
+from .enums import PNStatusCategory, PNReconnectionPolicy, PNOperationType
 from .models.consumer.common import PNStatus
 from .models.server.subscribe import SubscribeEnvelope
 from .dtos import SubscribeOperation, UnsubscribeOperation
@@ -507,68 +507,19 @@ def endpoint_name_for_operation(operation_type):
 
 
 class TokenManager:
-
     def __init__(self):
-        self._map = {}
-        self.init_map()
-
-    def init_map(self):
-        resources = [PNResourceType.USER, PNResourceType.SPACE]
-
-        for resource in resources:
-            skeleton_map = {
-                PNMatchType.RESOURCE: {},
-                PNMatchType.PATTERN: {}
-            }
-            self._map[resource] = skeleton_map
+        self.token = None
 
     def set_token(self, token):
-        unwrapped_token = self.unwrap_token(token)
-        self.store_token(unwrapped_token, token)
-
-    def set_tokens(self, tokens):
-        for token in tokens:
-            self.set_token(token)
-
-    def get_token(self, tms_properties):
-        resource_token = self.get_token_by_match(tms_properties, PNMatchType.RESOURCE)
-
-        if resource_token is None:
-            return self.get_token_by_match(tms_properties, PNMatchType.PATTERN)
-
-        return resource_token
-
-    def get_tokens(self):
-        return self._map
-
-    def get_tokens_by_resource(self, resource_type):
-        return self._map[resource_type]
-
-    def store_token(self, unwrapped_token, token):
-        match_types = [
-            PNMatchType.RESOURCE,
-            PNMatchType.PATTERN
-        ]
-
-        for asset in match_types:
-            short_match_type = self.get_shortened_match_type(asset)
-
-            if short_match_type in unwrapped_token:
-                res_object = unwrapped_token[short_match_type]
-
-                for r_type in res_object.keys():
-                    single_res_object = res_object[r_type]
-                    for r_name in single_res_object.keys():
-                        if asset == PNMatchType.PATTERN:
-                            self._map[self.get_extended_resource_type(r_type)][asset].clear()
+        self.token = token
 
-                        self._map[self.get_extended_resource_type(r_type)][asset][r_name] = token
+    def get_token(self):
+        return self.token
 
-    def unwrap_token(self, token):
-        raw = token
-
-        raw = raw.replace("_", "/").replace("-", "+")
-        byte_array = base64.b64decode(raw)
+    @staticmethod
+    def unwrap_token(token):
+        token = token.replace("_", "/").replace("-", "+")
+        byte_array = base64.b64decode(token)
 
         try:
             unwrapped_obj = loads(byte_array)
@@ -577,45 +528,3 @@ def unwrap_token(self, token):
             return decoded_obj
         except Exception:
             raise PubNubException(pn_error=PNERR_INVALID_ACCESS_TOKEN)
-
-    def get_token_by_match(self, tms_properties, match_type):
-        if tms_properties is None or tms_properties.resource_type is None or tms_properties.resource_id is None:
-            return None
-
-        if match_type != PNMatchType.PATTERN:
-            if tms_properties.resource_id in self._map[tms_properties.resource_type][match_type]:
-                token = self._map[tms_properties.resource_type][match_type][tms_properties.resource_id]
-                if token is not None:
-                    return token
-        else:
-            string_token_wrapper_dict = self._map[tms_properties.resource_type][match_type]
-            if len(string_token_wrapper_dict.keys()) > 0:
-                first_key = list(string_token_wrapper_dict.keys())[0]
-                return string_token_wrapper_dict[first_key]
-
-        return None
-
-    def get_extended_resource_type(self, r_type_abbr):
-        if r_type_abbr == "usr":
-            return PNResourceType.USER
-        if r_type_abbr == "spc":
-            return PNResourceType.SPACE
-
-        return r_type_abbr
-
-    def get_shortened_match_type(self, match_type):
-        if match_type == PNMatchType.RESOURCE:
-            return "res"
-        if match_type == PNMatchType.PATTERN:
-            return "pat"
-
-        return match_type
-
-
-class TokenManagerProperties:
-    def __init__(self, resource_type, resource_id):
-        self.resource_type = resource_type
-        self.resource_id = resource_id
-
-    def __str__(self):
-        return "resource_type: " + self.resource_type + ", resource_id: " + self.resource_id