feat(here-now): add limit and offset configuration options

Add `limit` (default `1000`) and `offset` parameters for `here_now` to fetch presence in portions.

Author: parfeon

pubnub/endpoints/presence/here_now.py

@@ -29,6 +29,8 @@ def __init__(self, pubnub, channels: Union[str, List[str]] = None, channel_group
 
         self._include_state = include_state
         self._include_uuids = include_uuids
+        self._offset = None
+        self._limit = 1000
 
     def channels(self, channels: Union[str, List[str]]) -> 'HereNow':
         utils.extend_list(self._channels, channels)
@@ -46,8 +48,16 @@ def include_uuids(self, include_uuids) -> 'HereNow':
         self._include_uuids = include_uuids
         return self
 
+    def limit(self, limit: int) -> 'HereNow':
+        self._limit = limit
+        return self
+
+    def offset(self, offset: int) -> 'HereNow':
+        self._offset = offset
+        return self
+
     def custom_params(self):
-        params = {}
+        params = { 'limit': self._limit }
 
         if len(self._channel_groups) > 0:
             params['channel-group'] = utils.join_items_and_encode(self._channel_groups)
@@ -58,6 +68,9 @@ def custom_params(self):
         if not self._include_uuids:
             params['disable_uuids'] = "1"
 
+        if self._offset is not None:
+            params['offset'] = self._offset
+
         return params
 
     def build_path(self):

tests/functional/test_here_now.py

@@ -30,23 +30,25 @@ def test_here_now(self):
 
         self.assertEqual(self.here_now.build_params_callback()({}), {
             'pnsdk': sdk_name,
-            'uuid': self.pubnub.uuid
+            'uuid': self.pubnub.uuid,
+            'limit': 1000,
         })
 
     def test_here_now_groups(self):
-        self.here_now.channel_groups("gr1")
+        self.here_now.channel_groups("gr1").limit(10000)
 
         self.assertEqual(self.here_now.build_path(), HereNow.HERE_NOW_PATH
                          % (pnconf.subscribe_key, ","))
 
         self.assertEqual(self.here_now.build_params_callback()({}), {
             'channel-group': 'gr1',
             'pnsdk': sdk_name,
-            'uuid': self.pubnub.uuid
+            'uuid': self.pubnub.uuid,
+            'limit': 10000,
         })
 
     def test_here_now_with_options(self):
-        self.here_now.channels(["ch1"]).channel_groups("gr1").include_state(True).include_uuids(False)
+        self.here_now.channels(["ch1"]).channel_groups("gr1").include_state(True).include_uuids(False).offset(3)
 
         self.assertEqual(self.here_now.build_path(), HereNow.HERE_NOW_PATH
                          % (pnconf.subscribe_key, "ch1"))
@@ -56,5 +58,7 @@ def test_here_now_with_options(self):
             'state': '1',
             'disable_uuids': '1',
             'pnsdk': sdk_name,
-            'uuid': self.pubnub.uuid
+            'uuid': self.pubnub.uuid,
+            'limit': 1000,
+            'offset': 3,
         })