Merge pull request #50 from devicehive/develop

New release

devicehive/api.py

@@ -35,36 +35,112 @@ def __init__(self, transport, auth):
         self._transport = transport
         self._token = Token(self, auth)
         self._connected = True
-        self._subscription_calls = {self.subscribe_insert_commands: set(),
-                                    self.subscribe_update_commands: set(),
-                                    self.subscribe_notifications: set()}
+        self._subscriptions = set()
         self.server_timestamp = None
 
-    @staticmethod
-    def _hashable_args(args):
-        args = list(args)
-        for i in range(len(args)):
-            if not isinstance(args[i], list):
-                continue
-            args[i] = tuple(args[i])
-        return tuple(args)
-
-    def _set_subscription_call(self, call, args):
-        args = self._hashable_args(args)
-        if args in self._subscription_calls[call]:
+    def _subscribe_insert_commands(self, device_id=None, network_ids=(),
+                                   device_type_ids=(), names=(),
+                                   timestamp=None):
+        action = 'command/insert'
+        join_names = ','.join(map(str, names))
+        join_network_ids = ','.join(map(str, network_ids))
+        join_device_type_ids = ','.join(map(str, device_type_ids))
+        if not timestamp:
+            timestamp = self.server_timestamp
+        auth_subscription_api_request = AuthSubscriptionApiRequest(self)
+        auth_subscription_api_request.action(action)
+        auth_subscription_api_request.url('device/command/poll')
+        auth_subscription_api_request.param('deviceId', device_id)
+        auth_subscription_api_request.param('networkIds', join_network_ids)
+        auth_subscription_api_request.param('deviceTypeIds',
+                                            join_device_type_ids)
+        auth_subscription_api_request.param('names', join_names)
+        auth_subscription_api_request.param('timestamp', timestamp)
+        auth_subscription_api_request.response_key('command')
+        api_request = ApiRequest(self)
+        api_request.action('command/subscribe')
+        api_request.set('deviceId', device_id)
+        api_request.set('networkIds', network_ids)
+        api_request.set('deviceTypeIds', device_type_ids)
+        api_request.set('names', names)
+        api_request.set('timestamp', timestamp)
+        api_request.subscription_request(auth_subscription_api_request)
+        return api_request.execute('Subscribe insert commands failure.')
+
+    def _subscribe_update_commands(self, device_id=None, network_ids=(),
+                                   device_type_ids=(), names=(),
+                                   timestamp=None):
+        action = 'command/update'
+        join_names = ','.join(map(str, names))
+        join_network_ids = ','.join(map(str, network_ids))
+        join_device_type_ids = ','.join(map(str, device_type_ids))
+        if not timestamp:
+            timestamp = self.server_timestamp
+        auth_subscription_api_request = AuthSubscriptionApiRequest(self)
+        auth_subscription_api_request.action(action)
+        auth_subscription_api_request.url('device/command/poll')
+        auth_subscription_api_request.param('returnUpdatedCommands', True)
+        auth_subscription_api_request.param('deviceId', device_id)
+        auth_subscription_api_request.param('networkIds', join_network_ids)
+        auth_subscription_api_request.param('deviceTypeIds',
+                                            join_device_type_ids)
+        auth_subscription_api_request.param('names', join_names)
+        auth_subscription_api_request.param('timestamp', timestamp)
+        auth_subscription_api_request.response_timestamp_key('lastUpdated')
+        auth_subscription_api_request.response_key('command')
+        api_request = ApiRequest(self)
+        api_request.action('command/subscribe')
+        api_request.set('returnUpdatedCommands', True)
+        api_request.set('deviceId', device_id)
+        api_request.set('networkIds', network_ids)
+        api_request.set('deviceTypeIds', device_type_ids)
+        api_request.set('names', names)
+        api_request.set('timestamp', timestamp)
+        api_request.subscription_request(auth_subscription_api_request)
+        return api_request.execute('Subscribe update commands failure.')
+
+    def _subscribe_notifications(self, device_id=None, network_ids=(),
+                                 device_type_ids=(), names=(),
+                                 timestamp=None):
+        action = 'notification/insert'
+        join_names = ','.join(map(str, names))
+        join_network_ids = ','.join(map(str, network_ids))
+        join_device_type_ids = ','.join(map(str, device_type_ids))
+        if not timestamp:
+            timestamp = self.server_timestamp
+        auth_subscription_api_request = AuthSubscriptionApiRequest(self)
+        auth_subscription_api_request.action(action)
+        auth_subscription_api_request.url('device/notification/poll')
+        auth_subscription_api_request.param('deviceId', device_id)
+        auth_subscription_api_request.param('networkIds', join_network_ids)
+        auth_subscription_api_request.param('deviceTypeIds',
+                                            join_device_type_ids)
+        auth_subscription_api_request.param('names', join_names)
+        auth_subscription_api_request.param('timestamp', timestamp)
+        auth_subscription_api_request.response_key('notification')
+        api_request = ApiRequest(self)
+        api_request.action('notification/subscribe')
+        api_request.set('deviceId', device_id)
+        api_request.set('networkIds', network_ids)
+        api_request.set('deviceTypeIds', device_type_ids)
+        api_request.set('names', names)
+        api_request.set('timestamp', timestamp)
+        api_request.subscription_request(auth_subscription_api_request)
+        return api_request.execute('Subscribe notifications failure.')
+
+    def _add_subscription(self, subscription):
+        if subscription in self._subscriptions:
             return
-        self._subscription_calls[call].add(args)
+        self._subscriptions.add(subscription)
 
-    def remove_subscription_call(self, call, args):
-        args = self._hashable_args(args)
-        if args not in self._subscription_calls[call]:
+    def remove_subscription(self, subscription):
+        if subscription not in self._subscriptions:
             return
-        self._subscription_calls[call].remove(args)
+        self._subscriptions.remove(subscription)
 
     def apply_subscription_calls(self):
-        for call in self._subscription_calls:
-            for args in self._subscription_calls[call]:
-                call(*args)
+        for subscription in self._subscriptions:
+            subscription.subscribe()
 
     @property
     def transport(self):
@@ -150,115 +226,32 @@ def refresh_token(self):
         return self._token.access_token
 
     def subscribe_insert_commands(self, device_id=None, network_ids=(),
-                                  device_type_ids=(), names=(),
-                                  timestamp=None):
-        action = 'command/insert'
-        join_names = ','.join(map(str, names))
-        join_network_ids = ','.join(map(str, network_ids))
-        join_device_type_ids = ','.join(map(str, device_type_ids))
-        request_timestamp = None
-        if not timestamp:
-            request_timestamp = self.server_timestamp
-        auth_subscription_api_request = AuthSubscriptionApiRequest(self)
-        auth_subscription_api_request.action(action)
-        auth_subscription_api_request.url('device/command/poll')
-        auth_subscription_api_request.param('deviceId', device_id)
-        auth_subscription_api_request.param('networkIds', join_network_ids)
-        auth_subscription_api_request.param('deviceTypeIds',
-                                            join_device_type_ids)
-        auth_subscription_api_request.param('names', join_names)
-        auth_subscription_api_request.param('timestamp', request_timestamp)
-        auth_subscription_api_request.response_key('command')
-        api_request = ApiRequest(self)
-        api_request.action('command/subscribe')
-        api_request.set('deviceId', device_id)
-        api_request.set('networkIds', network_ids)
-        api_request.set('deviceTypeIds', device_type_ids)
-        api_request.set('names', names)
-        api_request.set('timestamp', request_timestamp)
-        api_request.subscription_request(auth_subscription_api_request)
-        subscription = api_request.execute('Subscribe insert commands failure.')
-        call = self.subscribe_insert_commands
+                                  device_type_ids=(), names=(), timestamp=None):
+        call = self._subscribe_insert_commands
         args = (device_id, network_ids, device_type_ids, names, timestamp)
-        commands_subscription = CommandsSubscription(self, subscription,
-                                                     call, args)
-        self._set_subscription_call(call, args)
+        commands_subscription = CommandsSubscription(self, call, args)
+        commands_subscription.subscribe()
+        self._add_subscription(commands_subscription)
         return commands_subscription
 
     def subscribe_update_commands(self, device_id=None, network_ids=(),
                                   device_type_ids=(), names=(),
                                   timestamp=None):
-        action = 'command/update'
-        join_names = ','.join(map(str, names))
-        join_network_ids = ','.join(map(str, network_ids))
-        join_device_type_ids = ','.join(map(str, device_type_ids))
-        request_timestamp = None
-        if not timestamp:
-            request_timestamp = self.server_timestamp
-        auth_subscription_api_request = AuthSubscriptionApiRequest(self)
-        auth_subscription_api_request.action(action)
-        auth_subscription_api_request.url('device/command/poll')
-        auth_subscription_api_request.param('returnUpdatedCommands', True)
-        auth_subscription_api_request.param('deviceId', device_id)
-        auth_subscription_api_request.param('networkIds', join_network_ids)
-        auth_subscription_api_request.param('deviceTypeIds',
-                                            join_device_type_ids)
-        auth_subscription_api_request.param('names', join_names)
-        auth_subscription_api_request.param('timestamp', request_timestamp)
-        auth_subscription_api_request.response_timestamp_key('lastUpdated')
-        auth_subscription_api_request.response_key('command')
-        api_request = ApiRequest(self)
-        api_request.action('command/subscribe')
-        api_request.set('returnUpdatedCommands', True)
-        api_request.set('deviceId', device_id)
-        api_request.set('networkIds', network_ids)
-        api_request.set('deviceTypeIds', device_type_ids)
-        api_request.set('names', names)
-        api_request.set('timestamp', request_timestamp)
-        api_request.subscription_request(auth_subscription_api_request)
-        subscription = api_request.execute('Subscribe update commands failure.')
-        call = self.subscribe_update_commands
+        call = self._subscribe_update_commands
         args = (device_id, network_ids, device_type_ids, names, timestamp)
-        commands_subscription = CommandsSubscription(self, subscription,
-                                                     call, args)
-        self._set_subscription_call(call, args)
+        commands_subscription = CommandsSubscription(self, call, args)
+        commands_subscription.subscribe()
+        self._add_subscription(commands_subscription)
         return commands_subscription
 
     def subscribe_notifications(self, device_id=None, network_ids=(),
                                 device_type_ids=(), names=(),
                                 timestamp=None):
-        action = 'notification/insert'
-        join_names = ','.join(map(str, names))
-        join_network_ids = ','.join(map(str, network_ids))
-        join_device_type_ids = ','.join(map(str, device_type_ids))
-        request_timestamp = None
-        if not timestamp:
-            request_timestamp = self.server_timestamp
-        auth_subscription_api_request = AuthSubscriptionApiRequest(self)
-        auth_subscription_api_request.action(action)
-        auth_subscription_api_request.url('device/notification/poll')
-        auth_subscription_api_request.param('deviceId', device_id)
-        auth_subscription_api_request.param('networkIds', join_network_ids)
-        auth_subscription_api_request.param('deviceTypeIds',
-                                            join_device_type_ids)
-        auth_subscription_api_request.param('names', join_names)
-        auth_subscription_api_request.param('timestamp', request_timestamp)
-        auth_subscription_api_request.response_key('notification')
-        api_request = ApiRequest(self)
-        api_request.action('notification/subscribe')
-        api_request.set('deviceId', device_id)
-        api_request.set('networkIds', network_ids)
-        api_request.set('deviceTypeIds', device_type_ids)
-        api_request.set('names', names)
-        api_request.set('timestamp', request_timestamp)
-        api_request.subscription_request(auth_subscription_api_request)
-        subscription = api_request.execute('Subscribe notifications failure.')
-        call = self.subscribe_notifications
+        call = self._subscribe_notifications
         args = (device_id, network_ids, device_type_ids, names, timestamp)
-        notifications_subscription = NotificationsSubscription(self,
-                                                               subscription,
-                                                               call, args)
-        self._set_subscription_call(call, args)
+        notifications_subscription = NotificationsSubscription(self, call, args)
+        notifications_subscription.subscribe()
+        self._add_subscription(notifications_subscription)
         return notifications_subscription
 
     def list_devices(self, name=None, name_pattern=None, network_id=None,

devicehive/subscription.py

@@ -23,26 +23,37 @@ class BaseSubscription(object):
 
     ID_KEY = 'subscriptionId'
 
-    def __init__(self, api, subscription=None, call=None, args=None):
+    def __init__(self, api, call, args):
         self._api = api
-        self._id = None
-        if subscription:
-            self._id = subscription[self.ID_KEY]
         self._call = call
-        self._args = args
+        self._args = self._hashable_args(args)
+        self._id = None
+
+    @staticmethod
+    def _hashable_args(args):
+        args = list(args)
+        for i in range(len(args)):
+            if not isinstance(args[i], list):
+                continue
+            args[i] = tuple(args[i])
+        return tuple(args)
 
     def _ensure_exists(self):
         if self._id:
             return
         raise SubscriptionError('Subscription does not exist.')
 
+    def _get_subscription_type(self):
+        raise NotImplementedError
+
+    def subscribe(self):
+        subscription = self._call(*self._args)
+        self._id = subscription[self.ID_KEY]
+
     @property
     def id(self):
         return self._id
 
-    def _get_subscription_type(self):
-        raise NotImplementedError
-
     def remove(self):
         self._ensure_exists()
         remove_subscription_api_request = RemoveSubscriptionApiRequest()
@@ -52,9 +63,8 @@ def remove(self):
         api_request.set('subscriptionId', self._id)
         api_request.remove_subscription_request(remove_subscription_api_request)
         api_request.execute('Unsubscribe failure.')
+        self._api.remove_subscription(self)
         self._id = None
-        if self._call and self._args:
-            self._api.remove_subscription_call(self._call, self._args)
 
 
 class CommandsSubscription(BaseSubscription):

setup.py

@@ -23,7 +23,7 @@
 
 
 setup(name='devicehive',
-      version='2.1.5',
+      version='2.1.6',
       author='DataArt (http://dataart.com)',
       author_email='[email protected]',
       url='https://devicehive.com',