pubnub · qsoftdevelopment · Mar 19, 2019 · Sep 11, 2018 · Sep 11, 2018 · Sep 11, 2018
@@ -1,8 +1,13 @@
 name: python
-version: 4.1.2
+version: 4.1.3
 schema: 1
 scm: github.com/pubnub/python
 changelog:
+  - version: v4.1.3
+    date: Feb 25, 2019
+    changes:
+      - type: improvement
+        text: implement history Message Counts
  - version: v4.1.2
    date: Sep 20, 2018
    changes:
@@ -140,6 +145,7 @@ features:
    - STORAGE-INCLUDE-TIMETOKEN
    - STORAGE-START-END
    - STORAGE-COUNT
+    - STORAGE-MESSAGE-COUNT
  time:
    - TIME-TIME
  subscribe:
@@ -161,7 +167,6 @@ supported-platforms:
      - Windows 7 or later, amd64, 386
    editors:
      - python 2.7.13
-      - python 3.3.6
      - python 3.4.5
      - python 3.5.2
      - python 3.6.0
@@ -175,7 +180,6 @@ supported-platforms:
      - Windows 7 or later, amd64, 386
    editors:
      - python 2.7.13
-      - python 3.3.6
      - python 3.4.5
      - python 3.5.2
      - python 3.6.0

@@ -1,7 +1,6 @@
 language: python
 python:
  - "2.7"
-  - "3.3"
  - "3.4"
  - "3.5"
  - "3.6"

@@ -1,3 +1,8 @@
+## [4.1.3](https://github.com/pubnub/python/tree/v4.1.3)
+
+  [Full Changelog](https://github.com/pubnub/python/compare/v4.1.2...v4.1.3)
+
+- 🐛Implement history message counts

 ## [4.1.2](https://github.com/pubnub/python/tree/v4.1.2)


@@ -1,7 +1,7 @@
 # Developers manual

 ## Supported Python versions
-We support Python 2.7 and >=3.3
+We support Python 2.7 and >=3.4

 ## Supported platforms
 We maintain and test our SDK using Travis.CI and Ubuntu.

@@ -5,7 +5,7 @@
 [![PyPI](https://img.shields.io/pypi/pyversions/pubnub.svg)](https://pypi.python.org/pypi/pubnub/)
 [![Docs](https://img.shields.io/badge/docs-online-blue.svg)](https://www.pubnub.com/docs/python/pubnub-python-sdk-v4)

-The SDK supports Python 2.7, 3.3, 3.4, 3.5, 3.6, 3.7 and pypy.
+The SDK supports Python 2.7, 3.4, 3.5, 3.6, 3.7 and pypy.

 ## Documentation


@@ -0,0 +1 @@
+skips: ['B101']
@@ -15,7 +15,7 @@ def main():
    def my_publish_callback(result, status):
        # Check whether request successfully completed or not
        if not status.is_error():
-            envelope = result  # NOQA:W292
+            envelope = result  # noqa
            pass  # Message successfully published to specified channel.
        else:
            pass  # Handle message publish error. Check 'category' property to find out possible issue

@@ -34,8 +34,8 @@ def custom_params(self):
        return {'add': utils.join_items(self._channels)}

    def build_path(self):
-            return AddChannelToChannelGroup.ADD_PATH % (
-                self.pubnub.config.subscribe_key, utils.url_encode(self._channel_group))
+        return AddChannelToChannelGroup.ADD_PATH % (
+            self.pubnub.config.subscribe_key, utils.url_encode(self._channel_group))

    def http_method(self):
        return HttpMethod.GET

@@ -25,8 +25,8 @@ def custom_params(self):
        return {}

    def build_path(self):
-            return ListChannelsInChannelGroup.LIST_PATH % (
-                self.pubnub.config.subscribe_key, utils.url_encode(self._channel_group))
+        return ListChannelsInChannelGroup.LIST_PATH % (
+            self.pubnub.config.subscribe_key, utils.url_encode(self._channel_group))

    def http_method(self):
        return HttpMethod.GET

@@ -34,8 +34,8 @@ def custom_params(self):
        return {'remove': utils.join_items(self._channels)}

    def build_path(self):
-            return RemoveChannelFromChannelGroup.REMOVE_PATH % (
-                self.pubnub.config.subscribe_key, utils.url_encode(self._channel_group))
+        return RemoveChannelFromChannelGroup.REMOVE_PATH % (
+            self.pubnub.config.subscribe_key, utils.url_encode(self._channel_group))

    def http_method(self):
        return HttpMethod.GET

@@ -25,8 +25,8 @@ def custom_params(self):
        return {}

    def build_path(self):
-            return RemoveChannelGroup.REMOVE_PATH % (
-                self.pubnub.config.subscribe_key, utils.url_encode(self._channel_group))
+        return RemoveChannelGroup.REMOVE_PATH % (
+            self.pubnub.config.subscribe_key, utils.url_encode(self._channel_group))

    def http_method(self):
        return HttpMethod.GET

@@ -193,7 +193,7 @@ def validate_secret_key(self):
            raise PubNubException(pn_error=PNERR_SECRET_KEY_MISSING)

    def validate_channel(self):
-        if self._channel is None or len(self._channel) is 0:
+        if self._channel is None or len(self._channel) == 0:
            raise PubNubException(pn_error=PNERR_CHANNEL_MISSING)

    def validate_channels_and_groups(self):

@@ -71,10 +71,10 @@ def custom_params(self):
        return params

    def build_path(self):
-            return History.HISTORY_PATH % (
-                self.pubnub.config.subscribe_key,
-                utils.url_encode(self._channel)
-            )
+        return History.HISTORY_PATH % (
+            self.pubnub.config.subscribe_key,
+            utils.url_encode(self._channel)
+        )

    def http_method(self):
        return HttpMethod.GET

@@ -36,10 +36,10 @@ def custom_params(self):
        return params

    def build_path(self):
-            return HistoryDelete.HISTORY_DELETE_PATH % (
-                self.pubnub.config.subscribe_key,
-                utils.url_encode(self._channel)
-            )
+        return HistoryDelete.HISTORY_DELETE_PATH % (
+            self.pubnub.config.subscribe_key,
+            utils.url_encode(self._channel)
+        )

    def http_method(self):
        return HttpMethod.DELETE

@@ -0,0 +1,66 @@
+from pubnub import utils
+from pubnub.endpoints.endpoint import Endpoint
+from pubnub.enums import HttpMethod, PNOperationType
+from pubnub.exceptions import PubNubException
+from pubnub.models.consumer.message_count import PNMessageCountResult
+
+
+class MessageCount(Endpoint):
+    MESSAGE_COUNT_PATH = '/v3/history/sub-key/%s/message-counts/%s'
+
+    def __init__(self, pubnub):
+        Endpoint.__init__(self, pubnub)
+        self._channel = []
+        self._channels_timetoken = []
+
+    def channel(self, channel):
+        utils.extend_list(self._channel, channel)
+        return self
+
+    def channel_timetokens(self, timetokens):
+        timetokens = [str(item) for item in timetokens]
+        utils.extend_list(self._channels_timetoken, timetokens)
+        return self
+
+    def custom_params(self):
+        params = {}
+        if len(self._channels_timetoken) > 0:
+            if len(self._channels_timetoken) > 1:
+                params['channelsTimetoken'] = utils.join_items(self._channels_timetoken)
+            else:
+                params['timetoken'] = self._channels_timetoken[0]
+        return params
+
+    def build_path(self):
+        return MessageCount.MESSAGE_COUNT_PATH % (
+            self.pubnub.config.subscribe_key,
+            utils.join_channels(self._channel)
+        )
+
+    def http_method(self):
+        return HttpMethod.GET
+
+    def is_auth_required(self):
+        return True
+
+    def validate_params(self):
+        self.validate_subscribe_key()
+        self.validate_channel()
+
+        if len(self._channels_timetoken) != len(self._channel):
+            raise PubNubException('The number of channels and the number of timetokens do not match.')
+
+    def create_response(self, result):  # pylint: disable=W0221
+        return PNMessageCountResult(result)
+
+    def request_timeout(self):
+        return self.pubnub.config.non_subscribe_request_timeout
+
+    def connect_timeout(self):
+        return self.pubnub.config.connect_timeout
+
+    def operation_type(self):
+        return PNOperationType.PNMessageCountOperation
+
+    def name(self):
+        return "Message Count"
@@ -30,11 +30,11 @@ def custom_params(self):
        return params

    def build_path(self):
-            return GetState.GET_STATE_PATH % (
-                self.pubnub.config.subscribe_key,
-                utils.join_channels(self._channels),
-                utils.url_encode(self.pubnub.uuid)
-            )
+        return GetState.GET_STATE_PATH % (
+            self.pubnub.config.subscribe_key,
+            utils.join_channels(self._channels),
+            utils.url_encode(self.pubnub.uuid)
+        )

    def http_method(self):
        return HttpMethod.GET

@@ -39,7 +39,7 @@ def custom_params(self):
        return params

    def build_path(self):
-            return Leave.LEAVE_PATH % (self.pubnub.config.subscribe_key, utils.join_channels(self._channels))
+        return Leave.LEAVE_PATH % (self.pubnub.config.subscribe_key, utils.join_channels(self._channels))

    def http_method(self):
        return HttpMethod.GET

@@ -46,11 +46,11 @@ def custom_params(self):
        return params

    def build_path(self):
-            return SetState.SET_STATE_PATH % (
-                self.pubnub.config.subscribe_key,
-                utils.join_channels(self._channels),
-                utils.url_encode(self.pubnub.uuid)
-            )
+        return SetState.SET_STATE_PATH % (
+            self.pubnub.config.subscribe_key,
+            utils.join_channels(self._channels),
+            utils.url_encode(self.pubnub.uuid)
+        )

    def http_method(self):
        return HttpMethod.GET
@@ -66,7 +66,7 @@ def validate_params(self):
            raise PubNubException(pn_error=PNERR_STATE_MISSING)

    def create_response(self, envelope):
-        if 'status' in envelope and envelope['status'] is 200:
+        if 'status' in envelope and envelope['status'] == 200:
            return PNSetStateResult(envelope['payload'])
        else:
            return envelope

@@ -39,8 +39,8 @@ def custom_params(self):
        return params

    def build_path(self):
-            return AddChannelsToPush.ADD_PATH % (
-                self.pubnub.config.subscribe_key, self._device_id)
+        return AddChannelsToPush.ADD_PATH % (
+            self.pubnub.config.subscribe_key, self._device_id)

    def http_method(self):
        return HttpMethod.GET

@@ -33,8 +33,8 @@ def custom_params(self):
        return params

    def build_path(self):
-            return ListPushProvisions.LIST_PATH % (
-                self.pubnub.config.subscribe_key, self._device_id)
+        return ListPushProvisions.LIST_PATH % (
+            self.pubnub.config.subscribe_key, self._device_id)

    def http_method(self):
        return HttpMethod.GET

@@ -36,8 +36,8 @@ def custom_params(self):
        return params

    def build_path(self):
-            return RemoveChannelsFromPush.REMOVE_PATH % (
-                self.pubnub.config.subscribe_key, self._device_id)
+        return RemoveChannelsFromPush.REMOVE_PATH % (
+            self.pubnub.config.subscribe_key, self._device_id)

    def http_method(self):
        return HttpMethod.GET

@@ -33,8 +33,8 @@ def custom_params(self):
        return params

    def build_path(self):
-            return RemoveDeviceFromPush.REMOVE_PATH % (
-                self.pubnub.config.subscribe_key, self._device_id)
+        return RemoveDeviceFromPush.REMOVE_PATH % (
+            self.pubnub.config.subscribe_key, self._device_id)

    def http_method(self):
        return HttpMethod.GET

@@ -10,7 +10,7 @@ def custom_params(self):
        return {}

    def build_path(self):
-            return Time.TIME_PATH
+        return Time.TIME_PATH

    def http_method(self):
        return HttpMethod.GET

@@ -59,6 +59,7 @@ class PNOperationType(object):
    PNAccessManagerGrant = 21
    PNAccessManagerRevoke = 22
    PNHistoryDeleteOperation = 23
+    PNMessageCountOperation = 24


 class PNHeartbeatNotificationOptions(object):

@@ -421,6 +421,7 @@ def endpoint_name_for_operation(operation_type):

            PNOperationType.PNHistoryOperation: 'hist',
            PNOperationType.PNHistoryDeleteOperation: 'hist',
+            PNOperationType.PNMessageCountOperation: 'mc',

            PNOperationType.PNUnsubscribeOperation: 'pres',
            PNOperationType.PNWhereNowOperation: 'pres',

@@ -0,0 +1,12 @@
+class PNMessageCountResult(object):
+    def __init__(self, result):
+        """
+        Representation of message count server response
+
+        :param result: result of message count operation
+        """
+        self._result = result
+        self.channels = result['channels']
+
+    def __str__(self):
+        return "Message count for channels: {}".format(self.channels)
@@ -480,7 +480,7 @@ def _perform_heartbeat_loop(self):
                if heartbeat_verbosity == PNHeartbeatNotificationOptions.ALL:
                    self._listener_manager.announce_status(envelope.status)

-        except PubNubAsyncioException as e:
+        except PubNubAsyncioException:
            pass
            # TODO: check correctness
            # if e.status is not None and e.status.category == PNStatusCategory.PNTimeoutCategory:

@@ -22,6 +22,7 @@
 from .endpoints.presence.here_now import HereNow
 from .endpoints.presence.where_now import WhereNow
 from .endpoints.history_delete import HistoryDelete
+from .endpoints.message_count import MessageCount

 from .endpoints.push.add_channels_to_push import AddChannelsToPush
 from .endpoints.push.remove_channels_from_push import RemoveChannelsFromPush
@@ -157,6 +158,9 @@ def remove_device_from_push(self):
    def history(self):
        return History(self)

+    def message_counts(self):
+        return MessageCount(self)
+
    def time(self):
        return Time(self)
-Original file line number
+Diff line change
@@ -1,7 +1,6 @@
     language: python
     python:
       - "2.7"
-      - "3.3"
       - "3.4"
       - "3.5"
       - "3.6"
-          Expand Down