Add optional TTL parameter for publish (#152)

* Optional TTL in publish

* Tests

* PubNub SDK 7.1.0 release.

Co-authored-by: PubNub Release Bot <[email protected]>

Author: Sebastian Molenda

.pubnub.yml

@@ -1,5 +1,5 @@
 name: python
-version: 7.0.2
+version: 7.1.0
 schema: 1
 scm: github.com/pubnub/python
 sdks:
@@ -18,7 +18,7 @@ sdks:
         distributions:
           - distribution-type: library
             distribution-repository: package
-            package-name: pubnub-7.0.2
+            package-name: pubnub-7.1.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-7.0.2
-            location: https://github.com/pubnub/python/releases/download/7.0.2/pubnub-7.0.2.tar.gz
+            package-name: pubnub-7.1.0
+            location: https://github.com/pubnub/python/releases/download/7.1.0/pubnub-7.1.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: 2023-01-17
+    version: 7.1.0
+    changes:
+      - type: feature
+        text: "Add optional TTL parameter for publish endpoint."
   - date: 2022-11-24
     version: 7.0.2
     changes:

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 7.1.0
+January 17 2023
+
+#### Added
+- Add optional TTL parameter for publish endpoint.
+
 ## 7.0.2
 November 24 2022
 

pubnub/endpoints/pubsub/publish.py

@@ -21,6 +21,7 @@ def __init__(self, pubnub):
         self._meta = None
         self._replicate = None
         self._ptto = None
+        self._ttl = None
 
     def channel(self, channel):
         self._channel = str(channel)
@@ -49,6 +50,10 @@ def meta(self, meta):
         self._meta = meta
         return self
 
+    def ttl(self, ttl):
+        self._ttl = ttl
+        return self
+
     def build_data(self):
         if self._use_post is True:
             cipher = self.pubnub.config.cipher_key
@@ -70,6 +75,9 @@ def encoded_params(self):
     def custom_params(self):
         params = TimeTokenOverrideMixin.custom_params(self)
 
+        if self._ttl:
+            params['ttl'] = self._ttl
+
         if self._meta:
             params['meta'] = utils.write_value_as_string(self._meta)
 

pubnub/pubnub_core.py

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

setup.py

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

tests/integrational/fixtures/native_sync/publish/publish_ttl_0.yaml

@@ -0,0 +1,36 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      User-Agent:
+      - PubNub-Python/7.0.2
+    method: GET
+    uri: https://ps.pndsn.com/publish/pub-c-739aa0fc-3ed5-472b-af26-aca1b333ec52/sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe/0/ch1/0/%22hi%22?seqn=1
+  response:
+    body:
+      string: '[1,"Sent","16738723726258763"]'
+    headers:
+      Access-Control-Allow-Methods:
+      - GET
+      Access-Control-Allow-Origin:
+      - '*'
+      Cache-Control:
+      - no-cache
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '30'
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Date:
+      - Mon, 16 Jan 2023 12:32:52 GMT
+    status:
+      code: 200
+      message: OK
+version: 1

tests/integrational/fixtures/native_sync/publish/publish_ttl_100.yaml

@@ -0,0 +1,36 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      User-Agent:
+      - PubNub-Python/7.0.2
+    method: GET
+    uri: https://ps.pndsn.com/publish/pub-c-739aa0fc-3ed5-472b-af26-aca1b333ec52/sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe/0/ch1/0/%22hi%22?seqn=1&ttl=100
+  response:
+    body:
+      string: '[1,"Sent","16738723727729716"]'
+    headers:
+      Access-Control-Allow-Methods:
+      - GET
+      Access-Control-Allow-Origin:
+      - '*'
+      Cache-Control:
+      - no-cache
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '30'
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Date:
+      - Mon, 16 Jan 2023 12:32:52 GMT
+    status:
+      code: 200
+      message: OK
+version: 1

tests/integrational/native_sync/test_publish.py

@@ -341,3 +341,33 @@ def test_single_quote_character_message_encoded_ok(self):
             .sync()
 
         assert envelope
+
+    @pn_vcr.use_cassette('tests/integrational/fixtures/native_sync/publish/publish_ttl_0.yaml',
+                         filter_query_parameters=['uuid', 'pnsdk'])
+    def test_publish_ttl_0(self):
+        try:
+            env = PubNub(pnconf).publish() \
+                .channel("ch1") \
+                .message("hi") \
+                .ttl(0) \
+                .sync()
+
+            assert isinstance(env.result, PNPublishResult)
+            assert env.result.timetoken > 1
+        except PubNubException as e:
+            self.fail(e)
+
+    @pn_vcr.use_cassette('tests/integrational/fixtures/native_sync/publish/publish_ttl_100.yaml',
+                         filter_query_parameters=['uuid', 'pnsdk'])
+    def test_publish_ttl_100(self):
+        try:
+            env = PubNub(pnconf).publish() \
+                .channel("ch1") \
+                .message("hi") \
+                .ttl(100) \
+                .sync()
+
+            assert isinstance(env.result, PNPublishResult)
+            assert env.result.timetoken > 1
+        except PubNubException as e:
+            self.fail(e)