Merge pull request #46 from devicehive/develop

New release

Author: platon

README.md

@@ -1,4 +1,6 @@
-![build status](https://travis-ci.org/devicehive/devicehive-python.svg?branch=stable)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/devicehive.svg)](https://pypi.python.org/pypi/devicehive)
+[![Build Status](https://travis-ci.org/devicehive/devicehive-python.svg?branch=master)](https://travis-ci.org/devicehive/devicehive-python)
 
 # Devicehive
 
@@ -18,7 +20,7 @@ Example:
 from devicehive import DeviceHiveApi
 
 
-url = 'http://playground-dev.devicehive.com/api/rest'
+url = 'http://playground.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 device_hive_api = DeviceHiveApi(url, refresh_token=refresh_token)
 ```
@@ -28,7 +30,7 @@ device_hive_api = DeviceHiveApi(url, refresh_token=refresh_token)
 If you want to use `Websocket` protocol you need only to specify the url:
 
 ```python
-url = 'ws://playground-dev.devicehive.com/api/websocket'
+url = 'ws://playground.devicehive.com/api/websocket'
 ```
 
 ### Authentication
@@ -45,23 +47,23 @@ Examples:
 from devicehive import DeviceHiveApi
 
 
-url = 'ws://playground-dev.devicehive.com/api/websocket'
+url = 'ws://playground.devicehive.com/api/websocket'
 device_hive_api = DeviceHiveApi(url, refresh_token='SOME_REFRESH_TOKEN')
 ```
 
 ```python
 from devicehive import DeviceHiveApi
 
 
-url = 'ws://playground-dev.devicehive.com/api/websocket'
+url = 'ws://playground.devicehive.com/api/websocket'
 device_hive_api = DeviceHiveApi(url, access_token='SOME_ACCESS_TOKEN')
 ```
 
 ```python
 from devicehive import DeviceHiveApi
 
 
-url = 'ws://playground-dev.devicehive.com/api/websocket'
+url = 'ws://playground.devicehive.com/api/websocket'
 device_hive_api = DeviceHiveApi(url, login='SOME_LOGIN', password='SOME_PASSWORD')
 ```
 
@@ -85,7 +87,7 @@ Example:
 from devicehive import DeviceHiveApi
 
 
-url = 'http://playground-dev.devicehive.com/api/rest'
+url = 'http://playground.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 device_hive_api = DeviceHiveApi(url, refresh_token=refresh_token)
 info = device_hive_api.get_info()
@@ -112,7 +114,7 @@ Example:
 from devicehive import DeviceHiveApi
 
 
-url = 'http://playground-dev.devicehive.com/api/rest'
+url = 'http://playground.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 device_hive_api = DeviceHiveApi(url, refresh_token=refresh_token)
 name = 'user.login.lastTimeoutSent'
@@ -141,7 +143,7 @@ Example:
 from devicehive import DeviceHiveApi
 
 
-url = 'http://playground-dev.devicehive.com/api/rest'
+url = 'http://playground.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 device_hive_api = DeviceHiveApi(url, refresh_token=refresh_token)
 tokens = device_hive_api.create_token(1)
@@ -159,6 +161,18 @@ objects. All args are optional.
 
 `put_device(device_id, name, data, network_id, is_blocked)` method returns `Device` object. Only `device_id` is required.
 
+`list_commands(device_id, start, end, command, status, sort_field, sort_order, take, skip)` method returns list of `Command` 
+objects. Only `device_id` is required.
+
+`send_command(device_id, command_name, parameters, lifetime, timestamp, status, result)` method returns `Command` object. 
+Only `device_id` and `command_name` are required.
+
+`list_notifications(device_id, start, end, notification, sort_field, sort_order, take, skip)` method returns list of `Notification` 
+object. Only `device_id` is required.
+
+`send_notification(device_id, notification_name, parameters, timestamp)` method returns `Notification` object. 
+Only `device_id` and `notification_name` are required.
+
 #### Device object
 
 Properties:
@@ -213,7 +227,7 @@ Example:
 from devicehive import DeviceHiveApi
 
 
-url = 'http://playground-dev.devicehive.com/api/rest'
+url = 'http://playground.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 device_hive_api = DeviceHiveApi(url, refresh_token=refresh_token)
 device_id = 'example-device'
@@ -247,15 +261,15 @@ Properties:
 Methods:
 
 * `save()` method does not return anything.
-* `remove()` method does not return anything.
+* `remove(force)` method does not return anything. All args are optional.
 
 Example:
 
 ```python
 from devicehive import DeviceHiveApi
 
 
-url = 'http://playground-dev.devicehive.com/api/rest'
+url = 'http://playground.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 device_hive_api = DeviceHiveApi(url, refresh_token=refresh_token)
 network_name = 'example-name'
@@ -283,15 +297,15 @@ Properties:
 Methods:
 
 * `save()` method does not return anything.
-* `remove()` method does not return anything.
+* `remove(force)` method does not return anything. All args are optional.
 
 Example:
 
 ```python
 from devicehive import DeviceHiveApi
 
 
-url = 'http://playground-dev.devicehive.com/api/rest'
+url = 'http://playground.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 device_hive_api = DeviceHiveApi(url, refresh_token=refresh_token)
 device_type_name = 'example-name'
@@ -345,7 +359,7 @@ from devicehive import DeviceHiveApi
 from devicehive.user import User
 
 
-url = 'http://playground-dev.devicehive.com/api/rest'
+url = 'http://playground.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 device_hive_api = DeviceHiveApi(url, refresh_token=refresh_token)
 login = 'example-login'
@@ -434,7 +448,7 @@ class SimpleHandler(Handler):
         print(notification.notification)
 
 
-url = 'http://playground-dev.devicehive.com/api/rest'
+url = 'http://playground.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 dh = DeviceHive(SimpleHandler)
 dh.connect(url, refresh_token=refresh_token)
@@ -469,7 +483,7 @@ device_hive = DeviceHive(SimpleHandler, 'some_arg', some_kwarg='some_kwarg')
 If you want to use `Websocket` protocol you need only to specify the url:
 
 ```python
-url = 'ws://playground-dev.devicehive.com/api/websocket'
+url = 'ws://playground.devicehive.com/api/websocket'
 ```
 
 ### Authentication
@@ -483,17 +497,17 @@ There are three ways of initial authentication:
 Examples:
 
 ```python
-url = 'ws://playground-dev.devicehive.com/api/websocket'
+url = 'ws://playground.devicehive.com/api/websocket'
 device_hive.connect(url, refresh_token='SOME_REFRESH_TOKEN')
 ```
 
 ```python
-url = 'ws://playground-dev.devicehive.com/api/websocket'
+url = 'ws://playground.devicehive.com/api/websocket'
 device_hive.connect(url, access_token='SOME_ACCESS_TOKEN')
 ```
 
 ```python
-url = 'ws://playground-dev.devicehive.com/api/websocket'
+url = 'ws://playground.devicehive.com/api/websocket'
 device_hive.connect(url, login='SOME_LOGIN', password='SOME_PASSWORD')
 ```
 
@@ -671,6 +685,18 @@ class SimpleHandler(Handler):
 
 `self.api.put_device(device_id, name, data, network_id, device_type_id, is_blocked)` method does not return anything. `put_device` method of `DeviceHiveApi` class is the wrapper on top of this call.
 
+`self.api.list_commands(device_id, start, end, command, status, sort_field, sort_order, take, skip)` method returns list of `Command` 
+objects. `list_commands` method of `DeviceHiveApi` class is the wrapper on top of this call.
+
+`self.api.send_command(device_id, command_name, parameters, lifetime, timestamp, status, result)` method returns `Command` object. 
+`send_command` method of `DeviceHiveApi` class is the wrapper on top of this call.
+
+`self.api.list_notifications(device_id, start, end, notification, sort_field, sort_order, take, skip)` method returns list of `Notification` 
+objects. `list_notifications` method of `DeviceHiveApi` class is the wrapper on top of this call.
+
+`self.api.send_notification(device_id, notification_name, parameters, timestamp)` method returns `Notification` object. 
+`send_notification` method of `DeviceHiveApi` class is the wrapper on top of this call.
+
 See the description of `DeviceHiveApi` [device](#devices) methods for more details.
 
 #### API device object
@@ -864,7 +890,7 @@ class ReceiverHandler(Handler):
         print('Notification "%s" received' % notification.notification)
 
 
-url = 'ws://playground-dev.devicehive.com/api/websocket'
+url = 'ws://playground.devicehive.com/api/websocket'
 refresh_token = 'SOME_REFRESH_TOKEN'
 dh = DeviceHive(ReceiverHandler)
 dh.connect(url, refresh_token=refresh_token)
@@ -907,7 +933,7 @@ class SenderHandler(Handler):
             self._send_notifications()
 
 
-url = 'http://playground-dev.devicehive.com/api/rest'
+url = 'http://playground.devicehive.com/api/rest'
 refresh_token = 'SOME_REFRESH_TOKEN'
 dh = DeviceHive(SenderHandler)
 dh.connect(url, refresh_token=refresh_token)

devicehive/api.py

@@ -19,6 +19,8 @@
 from devicehive.api_request import AuthApiRequest
 from devicehive.api_request import AuthSubscriptionApiRequest
 from devicehive.device import Device
+from devicehive.command import Command
+from devicehive.notification import Notification
 from devicehive.subscription import CommandsSubscription, \
     NotificationsSubscription
 from devicehive.network import Network
@@ -249,6 +251,90 @@ def put_device(self, device_id, name=None, data=None, network_id=None,
         device.get(device_id)
         return device
 
+    def list_commands(self, device_id, start=None, end=None, command=None,
+                      status=None, sort_field=None, sort_order=None, take=None,
+                      skip=None):
+        auth_api_request = AuthApiRequest(self)
+        auth_api_request.url('device/{deviceId}/command', deviceId=device_id)
+        auth_api_request.action('command/list')
+        auth_api_request.param('start', start)
+        auth_api_request.param('end', end)
+        auth_api_request.param('command', command)
+        auth_api_request.param('status', status)
+        auth_api_request.param('sortField', sort_field)
+        auth_api_request.param('sortOrder', sort_order)
+        auth_api_request.param('take', take)
+        auth_api_request.param('skip', skip)
+        auth_api_request.response_key('commands')
+        commands = auth_api_request.execute('List commands failure.')
+        return [Command(self, command) for command in commands]
+
+    def send_command(self, device_id, command_name, parameters=None,
+                     lifetime=None, timestamp=None, status=None, result=None):
+        command = {Command.COMMAND_KEY: command_name}
+        if parameters:
+            command[Command.PARAMETERS_KEY] = parameters
+        if lifetime:
+            command[Command.LIFETIME_KEY] = lifetime
+        if timestamp:
+            command[Command.TIMESTAMP_KEY] = timestamp
+        if status:
+            command[Command.STATUS_KEY] = status
+        if result:
+            command[Command.RESULT_KEY] = result
+        auth_api_request = AuthApiRequest(self)
+        auth_api_request.method('POST')
+        auth_api_request.url('device/{deviceId}/command', deviceId=device_id)
+        auth_api_request.action('command/insert')
+        auth_api_request.set('command', command, True)
+        auth_api_request.response_key('command')
+        command = auth_api_request.execute('Command send failure.')
+        command[Command.DEVICE_ID_KEY] = device_id
+        command[Command.COMMAND_KEY] = command_name
+        command[Command.PARAMETERS_KEY] = parameters
+        command[Command.LIFETIME_KEY] = lifetime
+        command[Command.STATUS_KEY] = status
+        command[Command.RESULT_KEY] = result
+        return Command(self, command)
+
+    def list_notifications(self, device_id, start=None, end=None,
+                           notification=None, sort_field=None, sort_order=None,
+                           take=None, skip=None):
+        auth_api_request = AuthApiRequest(self)
+        auth_api_request.url('device/{deviceId}/notification',
+                             deviceId=device_id)
+        auth_api_request.action('notification/list')
+        auth_api_request.param('start', start)
+        auth_api_request.param('end', end)
+        auth_api_request.param('notification', notification)
+        auth_api_request.param('sortField', sort_field)
+        auth_api_request.param('sortOrder', sort_order)
+        auth_api_request.param('take', take)
+        auth_api_request.param('skip', skip)
+        auth_api_request.response_key('notifications')
+        notifications = auth_api_request.execute('List notifications failure.')
+        return [Notification(notification) for notification in notifications]
+
+    def send_notification(self, device_id, notification_name, parameters=None,
+                          timestamp=None):
+        notification = {'notification': notification_name}
+        if parameters:
+            notification['parameters'] = parameters
+        if timestamp:
+            notification['timestamp'] = timestamp
+        auth_api_request = AuthApiRequest(self)
+        auth_api_request.method('POST')
+        auth_api_request.url('device/{deviceId}/notification',
+                             deviceId=device_id)
+        auth_api_request.action('notification/insert')
+        auth_api_request.set('notification', notification, True)
+        auth_api_request.response_key('notification')
+        notification = auth_api_request.execute('Notification send failure.')
+        notification[Notification.DEVICE_ID_KEY] = device_id
+        notification[Notification.NOTIFICATION_KEY] = notification_name
+        notification[Notification.PARAMETERS_KEY] = parameters
+        return Notification(notification)
+
     def list_networks(self, name=None, name_pattern=None, sort_field=None,
                       sort_order=None, take=None, skip=None):
         auth_api_request = AuthApiRequest(self)