Merge pull request #17 from devicehive/develop

2.0.1 release

Author: Nikolay-Kha

README.md

@@ -18,6 +18,7 @@ class SimpleHandler(Handler):
     def handle_connect(self):
         info = self.api.get_info()
         print(info)
+        self.api.disconnect()
 ```
 
 `handle_connect` is the only one required method. If you want to handle server 
@@ -31,9 +32,12 @@ from devicehive import Handler
 class SimpleHandler(Handler):
 
     def handle_connect(self):
-        self.api.subscribe_insert_commands()
-        self.api.subscribe_update_commands()
-        self.api.subscribe_notifications()
+        device_ids = ['example-device-1', 'example-device-2']
+        for device_id in device_ids:
+            self.api.put_device(device_id)
+        self.api.subscribe_insert_commands(device_ids)
+        self.api.subscribe_update_commands(device_ids)
+        self.api.subscribe_notifications(device_ids)
 
     def handle_command_insert(self, command):
         print(command.command)
@@ -58,6 +62,9 @@ from devicehive import DeviceHive
 class SimpleHandler(Handler):
 
     def handle_connect(self):
+        device_ids = ['example-device-1', 'example-device-2']
+        for device_id in device_ids:
+            self.api.put_device(device_id)
         self.api.subscribe_insert_commands()
         self.api.subscribe_update_commands()
         self.api.subscribe_notifications()
@@ -76,7 +83,6 @@ url = 'http://playground.dev.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 dh = DeviceHive(SimpleHandler)
 dh.connect(url, refresh_token=refresh_token)
-dh.join()
 ```
 
 ### Custom handler args
@@ -98,6 +104,7 @@ class SimpleHandler(Handler):
     def handle_connect(self):
         info = self.api.get_info()
         print(info)
+        self.api.disconnect()
 
 dh = DeviceHive(SimpleHandler, 'some_arg', some_kwarg='some_kwarg')
 ```
@@ -143,12 +150,14 @@ custom handler with `self.api`.
 ### Info
 
 `self.api.get_info()` returns `dict` with the next fields:
+
 * `api_version`
 * `server_timestamp`
 * `rest_server_url`
 * `websocket_server_url`
 
 `self.api.get_cluster_info()` returns `dict` with the next fields:
+
 * `bootstrap.servers`
 * `zookeeper.connect`
 
@@ -164,11 +173,13 @@ class SimpleHandler(Handler):
         print(info)
         cluster_info = self.api.get_cluster_info()
         print(cluster_info)
+        self.api.disconnect()
 ```
 
 ### Properties
 
 `self.api.get_property(name)` returns `dict` with the next fields:
+
 * `entity_version`
 * `name`
 * `value`
@@ -191,12 +202,14 @@ class SimpleHandler(Handler):
         entity_version = self.api.get_property(name, 'value')
         print(entity_version)
         self.api.delete_property(name)
+        self.api.disconnect()
 ```
 
 ### Tokens
 
 `self.api.create_token(user_id, expiration, actions, network_ids, device_ids)`
 returns `dict` with the next fields:
+
 * `access_token`
 * `refresh_token`
 
@@ -216,6 +229,7 @@ class SimpleHandler(Handler):
         print(tokens)
         access_token = self.api.refresh_token()
         print(access_token)
+        self.api.disconnect()
 ```
 
 ### Commands subscription and unsubscription
@@ -300,38 +314,32 @@ Only `device_id` arg is required.
 #### Device object
 
 Properties:
+
 * `id` (read only)
 * `name`
 * `data`
 * `network_id`
 * `is_blocked`
 
 Methods:
+
 * `save()` Does not return anything.
 * `remove()` Does not return anything.
-* `subscribe_insert_commands(names, timestamp)` Does not return anything. All
-args are optional.
+* `subscribe_insert_commands(names, timestamp)` Does not return anything. All args are optional.
 * `unsubscribe_insert_commands()` Does not return anything.
-* `subscribe_update_commands(names, timestamp)` Does not return anything.
-All args are optional.
+* `subscribe_update_commands(names, timestamp)` Does not return anything. All args are optional.
 * `unsubscribe_update_commands()` Does not return anything.
-* `list_commands(start, end, command, status, sort_field, sort_order, take,
-                 skip)` Returns list of `Command` objects. All args are
-                 optional.
-* `send_command(command_name, parameters, lifetime, timestamp, status, result)`
-Returns `Command` object. Only `command_name` is required.
-* `subscribe_notifications(names, timestamp)` Does not return anything. All args
-are optional.
+* `list_commands(start, end, command, status, sort_field, sort_order, take, skip)` Returns list of `Command` objects. All args are optional.
+* `send_command(command_name, parameters, lifetime, timestamp, status, result)` Returns `Command` object. Only `command_name` is required.
+* `subscribe_notifications(names, timestamp)` Does not return anything. All args are optional.
 * `unsubscribe_notifications()` Does not return anything.
-* `list_notifications(start, end, notification, sort_field, sort_order, take,
-                      skip)` Returns list of `Notification` objects. All args
-                      are optional.
-* `send_notification(notification_name, parameters, timestamp)` Returns
-`Notification` object. Only `notification_name` is required.
+* `list_notifications(start, end, notification, sort_field, sort_order, take, skip)` Returns list of `Notification` objects. All args are optional.
+* `send_notification(notification_name, parameters, timestamp)` Returns `Notification` object. Only `notification_name` is required.
 
 #### Command object
 
 Properties:
+
 * `id` (read only)
 * `user_id` (read only)
 * `command` (read only)
@@ -343,11 +351,13 @@ Properties:
 * `result`
 
 Methods:
+
 * `save()` Does not return anything.
 
 #### Notification object
 
 Properties:
+
 * `device_id` (read only)
 * `id` (read only)
 * `notification` (read only)
@@ -372,6 +382,7 @@ class SimpleHandler(Handler):
             print('Device: %s, name: %s, data: %s' % (device.id, device.name,
                                                       device.data))
             device.remove()
+        self.api.disconnect()
 ```
 
 ### Networks
@@ -386,15 +397,16 @@ returns list of `Network` objects. All args are optional.
 #### Network object
 
 Properties:
+
 * `id` (read only)
 * `name`
 * `description`
 
 Methods:
+
 * `save()` Does not return anything.
 * `remove()` Does not return anything.
-* `list_devices(name, name_pattern, sort_field, sort_order, take, skip)`
-Returns list of `Device` objects. All args are optional.
+* `list_devices(name, name_pattern, sort_field, sort_order, take, skip)` Returns list of `Device` objects. All args are optional.
 
 Example:
 ```python
@@ -408,6 +420,7 @@ class SimpleHandler(Handler):
         network_description = 'example-description'
         network = self.api.create_network(network_name, network_description)
         print(network.name)
+        self.api.disconnect()
 ```
 
 ### Users
@@ -425,6 +438,7 @@ class SimpleHandler(Handler):
 #### User object
 
 Properties:
+
 * `id` (read only)
 * `login` (read only)
 * `last_login` (read only)
@@ -434,6 +448,7 @@ Properties:
 * `data`
 
 Methods:
+
 * `save()` Does not return anything.
 * `update_password(password)` Does not return anything.
 * `remove()` Does not return anything.
@@ -456,6 +471,7 @@ class SimpleHandler(Handler):
         data = {'key': 'value'}
         user = self.api.create_user(login, password, role, data)
         print(user.login)
+        self.api.disconnect()
 ```
 
 ## Extended example:
@@ -497,8 +513,6 @@ url = 'ws://playground.dev.devicehive.com/api/websocket'
 refresh_token = 'SOME_REFRESH_TOKEN'
 dh = DeviceHive(ReceiverHandler)
 dh.connect(url, refresh_token=refresh_token)
-dh.join()
-dh.print_exception()
 ```
 
 On the next step we will create `sender.py`
@@ -524,6 +538,7 @@ class SenderHandler(Handler):
             notification = '%s-notification' % num_notification
             self._device.send_notification(notification)
             print('Sending notification "%s"' % notification)
+        self.api.disconnect()
 
     def handle_connect(self):
         self._device = self.api.get_device(self._device_id)
@@ -541,8 +556,6 @@ url = 'http://playground.dev.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 dh = DeviceHive(SenderHandler)
 dh.connect(url, refresh_token=refresh_token)
-dh.join()
-dh.print_exception()
 ```
 
 Run `python receiver.py` in the first terminal. And `python sender.py` in the

devicehive/api.py

@@ -15,6 +15,7 @@ class Api(object):
     def __init__(self, transport, auth):
         self._transport = transport
         self._token = Token(self, auth)
+        self._connected = True
         self._subscriptions = {}
         self._removed_subscription_ids = {}
         self.server_timestamp = None
@@ -53,6 +54,10 @@ def transport(self):
     def token(self):
         return self._token
 
+    @property
+    def connected(self):
+        return self._connected
+
     def ensure_subscription_not_exist(self, action, device_ids):
         for device_id in device_ids:
             if not self.subscription_id(action, device_id):
@@ -99,6 +104,37 @@ def removed_subscription_id_exists(self, action, subscription_id):
             return False
         return subscription_id in subscription_ids
 
+    def resubscribe(self):
+        subscription_calls = {}
+        for action in self._subscriptions:
+            subscription_calls[action] = []
+            for subscription in self._subscriptions[action]:
+                found = False
+                for subscription_call in subscription_calls[action]:
+                    if subscription_call['names'] == subscription['names']:
+                        found = True
+                        device_id = subscription['device_id']
+                        subscription_call['device_ids'].append(device_id)
+                        break
+                if not found:
+                    device_id = subscription['device_id']
+                    subscription_call = {'device_ids': [device_id],
+                                         'names': subscription['names']}
+                    subscription_calls[action].append(subscription_call)
+        self._subscriptions = {}
+        action = 'command/insert'
+        if action in subscription_calls:
+            for subscription_call in subscription_calls[action]:
+                self.subscribe_insert_commands(**subscription_call)
+        action = 'command/update'
+        if action in subscription_calls:
+            for subscription_call in subscription_calls[action]:
+                self.subscribe_update_commands(**subscription_call)
+        action = 'notification/insert'
+        if action in subscription_calls:
+            for subscription_call in subscription_calls[action]:
+                self.subscribe_notifications(**subscription_call)
+
     def get_info(self):
         api_request = ApiRequest(self)
         api_request.url('info')
@@ -419,3 +455,9 @@ def create_user(self, login, password, role, data):
         user[User.STATUS_KEY] = status
         user[User.DATA_KEY] = data
         return User(self, user)
+
+    def disconnect(self):
+        self._connected = False
+        if not self._transport.connected:
+            return
+        self._transport.disconnect()

devicehive/api_handler.py

@@ -22,12 +22,18 @@ def __init__(self, transport, auth, handler_class, handler_args,
                                       **handler_kwargs)
         self._handle_connect = False
 
+    @property
+    def handler(self):
+        return self._handler
+
     def handle_connect(self):
         self._api.token.auth()
         self._api.server_timestamp = self._api.get_info()['server_timestamp']
         if not self._handle_connect:
-            self._handler.handle_connect()
             self._handle_connect = True
+            self._handler.handle_connect()
+            return
+        self._api.resubscribe()
 
     def handle_event(self, event):
         api_event = ApiEvent(event)
@@ -47,5 +53,4 @@ def handle_event(self, event):
             return self._handler.handle_notification(notification)
 
     def handle_disconnect(self):
-        # TODO: handle disconnect here.
         pass

devicehive/device_hive.py

@@ -1,6 +1,7 @@
 from devicehive.data_formats.json_data_format import JsonDataFormat
 from devicehive.api_handler import ApiHandler
-import traceback
+import time
+import six
 
 
 class DeviceHive(object):
@@ -35,20 +36,29 @@ def connect(self, transport_url, **options):
                 'password': options.pop('password', None),
                 'refresh_token': options.pop('refresh_token', None),
                 'access_token': options.pop('access_token', None)}
+        connect_timeout = options.pop('connect_timeout', 30)
+        max_num_connect = options.pop('max_num_connect', 10)
+        connect_interval = options.pop('connect_interval', 1)
         self._api_handler_options['auth'] = auth
         self._init_transport()
-        self._transport.connect(transport_url, **options)
-
-    def join(self, timeout=None):
-        self._transport.join(timeout)
-
-    def exception_info(self):
-        return self._transport.exception_info
-
-    def print_exception(self):
-        transport_exception_info = self._transport.exception_info
-        if not transport_exception_info:
-            return
-        traceback.print_exception(transport_exception_info[0],
-                                  transport_exception_info[1],
-                                  transport_exception_info[2])
+        connect_time = time.time()
+        num_connect = 0
+        while True:
+            if self._transport.connected:
+                self._transport.disconnect()
+            self._transport.connect(transport_url, **options)
+            self._transport.join()
+            exception_info = self._transport.exception_info
+            if exception_info and not isinstance(exception_info[1],
+                                                 self._transport.error):
+                six.reraise(*exception_info)
+            if not self._transport.handler.handler.api.connected:
+                return
+            if time.time() - connect_time < connect_timeout:
+                num_connect += 1
+                if num_connect > max_num_connect:
+                    six.reraise(*exception_info)
+                time.sleep(connect_interval)
+                continue
+            connect_time = time.time()
+            num_connect = 0