PubNub SDK v5.1.2 release.

Author: client-engineering-bot

.pubnub.yml

@@ -1,8 +1,14 @@
 name: python
-version: 5.1.1
+version: 5.1.2
 schema: 1
 scm: github.com/pubnub/python
 changelog:
+  - version: v5.1.2
+    date: Apr 15, 2021
+    changes:
+      -
+        text: "Request headers required by the Grant Token functionality added."
+        type: bug
   - version: v5.1.1
     date: Mar 29, 2021
     changes:

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [v5.1.2](https://github.com/pubnub/python/releases/tag/v5.1.2)
+
+[Full Changelog](https://github.com/pubnub/python/compare/v5.1.1...v5.1.2)
+
+- 🐛 Request headers required by the Grant Token functionality added. 
+
 ## [v5.1.1](https://github.com/pubnub/python/releases/tag/v5.1.1)
 
 [Full Changelog](https://github.com/pubnub/python/compare/v5.1.0...v5.1.1)

pubnub/endpoints/access/grant_token.py

@@ -19,10 +19,10 @@ def __init__(self, pubnub):
         Endpoint.__init__(self, pubnub)
         self._ttl = None
         self._meta = None
-        self._channelList = []
-        self._groupList = []
-        self._userList = []
-        self._spaceList = []
+        self._channels = []
+        self._groups = []
+        self._users = []
+        self._spaces = []
 
         self._sort_params = True
 
@@ -34,28 +34,36 @@ def meta(self, meta):
         self._meta = meta
         return self
 
+    def channels(self, channels):
+        self._channels = channels
+        return self
+
+    def groups(self, groups):
+        self._groups = groups
+        return self
+
     def users(self, users):
-        self._userList = users
+        self._users = users
         return self
 
     def spaces(self, spaces):
-        self._spaceList = spaces
+        self._spaces = spaces
         return self
 
     def custom_params(self):
         return {}
 
     def build_data(self):
-        params = {'ttl': str(int(self._ttl))}
+        params = {'ttl': str(self._ttl)}
 
         permissions = {}
         resources = {}
         patterns = {}
 
-        utils.parse_resources(self._channelList, "channels", resources, patterns)
-        utils.parse_resources(self._groupList, "groups", resources, patterns)
-        utils.parse_resources(self._userList, "users", resources, patterns)
-        utils.parse_resources(self._spaceList, "spaces", 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)
 
         permissions['resources'] = resources
         permissions['patterns'] = patterns
@@ -90,14 +98,6 @@ def create_response(self, envelope):
     def is_auth_required(self):
         return False
 
-    def affected_channels(self):
-        # generate a list of channels when they become supported in PAMv3
-        return None
-
-    def affected_channels_groups(self):
-        # generate a list of groups when they become supported in PAMv3
-        return None
-
     def request_timeout(self):
         return self.pubnub.config.non_subscribe_request_timeout
 
@@ -111,8 +111,10 @@ def name(self):
         return "Grant Token"
 
     def validate_resources(self):
-        if (self._userList is None or len(self._userList) == 0) and \
-           (self._spaceList is None or len(self._spaceList) == 0):
+        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):
             raise PubNubException(pn_error=PNERR_RESOURCES_MISSING)
 
     def validate_ttl(self):

pubnub/endpoints/endpoint.py

@@ -3,7 +3,7 @@
 import logging
 
 from pubnub import utils
-from pubnub.enums import PNStatusCategory
+from pubnub.enums import PNStatusCategory, HttpMethod
 from pubnub.errors import (
     PNERR_SUBSCRIBE_KEY_MISSING, PNERR_PUBLISH_KEY_MISSING, PNERR_CHANNEL_OR_GROUP_MISSING,
     PNERR_SECRET_KEY_MISSING, PNERR_CHANNEL_MISSING, PNERR_FILE_OBJECT_MISSING,
@@ -88,7 +88,7 @@ def use_base_path(self):
         return True
 
     def request_headers(self):
-        if self.http_method() == "POST":
+        if self.http_method() == HttpMethod.POST:
             return {"Content-type": "application/json"}
         else:
             return {}

pubnub/pubnub_core.py

@@ -65,7 +65,7 @@
 
 class PubNubCore:
     """A base class for PubNub Python API implementations"""
-    SDK_VERSION = "5.1.1"
+    SDK_VERSION = "5.1.2"
     SDK_NAME = "PubNub-Python"
 
     TIMESTAMP_DIVIDER = 1000

pubnub/request_handlers/requests_handler.py

@@ -230,7 +230,7 @@ def _invoke_request(self, p_options, e_options, base_origin):
             url = e_options.path
 
         if e_options.request_headers:
-            p_options.update(e_options.request_headers)
+            p_options.headers.update(e_options.request_headers)
 
         args = {
             "method": e_options.method_string,

pubnub/utils.py

@@ -198,7 +198,7 @@ def sign_request(endpoint, pn, custom_params, method, body):
 
 
 def parse_resources(resource_list, resource_set_name, resources, patterns):
-    if resource_list is not None:
+    if resource_list:
         for pn_resource in resource_list:
             resource_object = {}
 

setup.py

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

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

@@ -0,0 +1,45 @@
+interactions:
+- request:
+    body: '{"ttl": "15", "permissions": {"resources": {"channels": {"foo": 1, "bar":
+      1}, "groups": {"foo": 1, "bar": 1}, "users": {}, "spaces": {}}, "patterns":
+      {"channels": {}, "groups": {}, "users": {}, "spaces": {}}, "meta": {}}}'
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '221'
+      Content-type:
+      - application/json
+      User-Agent:
+      - PubNub-Python/5.1.1
+    method: POST
+    uri: https://ps.pndsn.com/v3/pam/sub-c-7ba2ac4c-4836-11e6-85a4-0619f8945a4f/grant
+  response:
+    body:
+      string: '{"data":{"message":"Success","token":"p0F2AkF0GmB4Sd9DdHRsD0NyZXOkRGNoYW6iY2ZvbwFjYmFyAUNncnCiY2ZvbwFjYmFyAUN1c3KgQ3NwY6BDcGF0pERjaGFuoENncnCgQ3VzcqBDc3BjoERtZXRhoENzaWdYIBHsbMOeRAHUvsCURvZ3Yehv74QvPT4xqfHY5JPONmyJ"},"service":"Access
+        Manager","status":200}'
+    headers:
+      Access-Control-Allow-Headers:
+      - Origin, X-Requested-With, Content-Type, Accept
+      Access-Control-Allow-Methods:
+      - GET
+      Access-Control-Allow-Origin:
+      - '*'
+      Cache-Control:
+      - no-cache, no-store, must-revalidate
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '257'
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Date:
+      - Thu, 15 Apr 2021 14:12:47 GMT
+    status:
+      code: 200
+      message: OK
+version: 1

tests/integrational/native_sync/test_grant.py

@@ -1,14 +1,19 @@
 from pubnub.pubnub import PubNub
+from pubnub.models.consumer.v3.channel import Channel
+from pubnub.models.consumer.v3.group import Group
 from tests.integrational.vcr_helper import pn_vcr
 from tests.helper import pnconf_pam_copy
 from pubnub.models.consumer.access_manager import PNAccessManagerGrantResult
+from pubnub.models.consumer.v3.access_manager import PNGrantTokenResult
 
 pubnub = PubNub(pnconf_pam_copy())
 pubnub.config.uuid = "test_grant"
 
 
-@pn_vcr.use_cassette('tests/integrational/fixtures/native_sync/pam/grant_with_spaces.yaml',
-                     filter_query_parameters=['uuid', 'seqn', 'pnsdk', 'timestamp', 'signature'])
+@pn_vcr.use_cassette(
+    'tests/integrational/fixtures/native_sync/pam/grant_with_spaces.yaml',
+    filter_query_parameters=['uuid', 'seqn', 'pnsdk', 'timestamp', 'signature']
+)
 def test_grant_auth_key_with_spaces():
     envelope = pubnub.grant()\
         .read(True)\
@@ -19,3 +24,21 @@ def test_grant_auth_key_with_spaces():
         .sync()
 
     assert isinstance(envelope.result, PNAccessManagerGrantResult)
+
+
+@pn_vcr.use_cassette(
+    'tests/integrational/fixtures/native_sync/pam/grant_token.yaml',
+    filter_query_parameters=['uuid', 'seqn', 'pnsdk', 'timestamp', 'signature']
+)
+def test_grant_token():
+    channels = ("foo", "bar")
+    groups = ("foo", "bar")
+
+    envelope = pubnub.grant_token()\
+        .channels([Channel.id(channel).read() for channel in channels])\
+        .groups([Group.id(group).read() for group in groups])\
+        .ttl(15)\
+        .sync()
+
+    assert isinstance(envelope.result, PNGrantTokenResult)
+    assert envelope.result.get_token()