Add delete methods to sdk.

Author: James Dalessio

README.md

@@ -245,6 +245,10 @@ device = exp.create_device({ 'subtype': 'scala:device:player' })
 
 Returns an iterable of devices matching the given query parameters. `params` is a dictionary of query parameters. Iterable also has attributes matching the raw API response document properties (i.e. `total` and `results`).
 
+**`exp.delete_device(uuid=None)`**
+
+Deletes the device with the given uuid.
+
 **`device.get_location()`**
 
 Returns the device's [location](#locations) or `None`.
@@ -258,6 +262,7 @@ Returns a list of the device's [zones](#zones).
 Returns the device's [experience](#experiences) or `None`
 
 
+
 ## Things
 
 Things inherit all [common resource methods and attributes](#resources).
@@ -278,6 +283,12 @@ thing = exp.create_thing({ 'subtype': 'scala:thing:rfid', 'id': '[rfid]', 'name'
 
 Returns an iterable of things matching the given query parameters. `params` is a dictionary of query parameters. Iterable also has attributes matching the raw API response document properties (i.e. `total` and `results`).
 
+
+**`exp.delete_thing(uuid=None)`**
+
+Deletes the thing with the given uuid.
+
+
 **`thing.get_location()`**
 
 Returns the thing's [location](#locations) or `None`.
@@ -291,6 +302,8 @@ Returns a list of the thing's [#zones](#zones).
 Returns the device's [experience](#experiences) or `None`
 
 
+
+
 ## Experiences
 
 Experiences inherit all [common resource methods and attributes](#resources).
@@ -316,6 +329,7 @@ Returns an iterable of experiences matching the given query parameters. `params`
 Returns an iterable of [devices](#devices) that are part of this experience. `params` is a dictionary of query parameters. Iterable also has attributes matching the raw API response document properties (i.e. `total` and `results`).
 
 
+
 ## Locations
 Locations inherit all [common resource methods and attributes](#resources).
 
@@ -336,6 +350,11 @@ Returns a location created based on the supplied document.
 Returns an iterable of locations matching the given query parameters. `params` is a dictionary of query parameters. Iterable also has attributes matching the raw API response document properties (i.e. `total` and `results`).
 
 
+**`exp.delete_location(uuid=None)`**
+
+Deletes the location with the given uuid.
+
+
 **`location.get_devices(params=None)`**
 
 Returns an iterable of [devices](#devices) that are part of this location. `params` is a dictionary of query parameters. Iterable also has attributes matching the raw API response document properties (i.e. `total` and `results`).
@@ -353,6 +372,7 @@ Returns a list of [zones](#zones) that are part of this location.
 Returns a url pointing to the location's layout image.
 
 
+
 ## Zones
 Zones inherit the [common resource methods and attributes](#resources) `save()`, `refresh()`, and `get_channel()`.
 
@@ -404,14 +424,21 @@ Returns an iterable of feeds matching the given query parameters. `params` is a
 feeds = exp.find_feeds({ 'subtype': 'scala:feed:facebook' })
 ```
 
+
+**`exp.delete_feed(uuid=None)`**
+
+Deletes the feed with the given uuid.
+
+
 **`feed.get_data(**params)`**
 
 Returns the feed's data. For dynamic feeds specify key value query params in `params`.
 
 
+
 ## Data
 
-Data items inherit the [common resource methods and attributes](#resources) `save()`, `refresh()`, and `get_channel()`.
+Data items inherit the [common resource methods and attributes](#resources) `save()`, `refresh()`, `delete()`, and `get_channel()`.
 There is a limit of 16MB per data document.
 
 *Note that data values must be a javascript object, but can contain other primitives.*
@@ -442,6 +469,11 @@ Returns an iterable of data items matching the given query parameters. `params`
 items = exp.find_data({ 'group': 'cats' })
 ```
 
+**`exp.delete_data(group=None, key=None)`**
+
+Deletes the data item with the given group and key.
+
+
 **`data.key`**
 
 The data item's key. Settable.
@@ -455,6 +487,7 @@ The data item's group. Settable
 The data item's value. Settable.
 
 
+
 ## Content
 Content items inherit all [common resource methods and attributes](#resources) except `save()`.
 
@@ -534,6 +567,11 @@ channel = experience.get_channel()
 channel.broadcast('hello?')
 ```
 
+**`resource.delete()`**
+
+Deletes the resource.
+
+
 ## Custom Requests
 
 These methods all users to send custom authenticated API calls. `params` is a dictionary of url params, `payload` is a JSON serializable type, and `timeout` is the duration, in seconds, to wait for the request to complete. `path` is relative to the api host root. All methods will return a JSON serializable type.

exp_sdk/api.py

@@ -68,6 +68,16 @@ def _get_channel_name (self):
   def _get_resource_path (self):
     return '{0}/{1}'.format(self._collection_path, self.uuid)
 
+  @classmethod
+  def delete_ (cls, uuid, sdk):
+    if not uuid or not isinstance(uuid, basestring):
+      return None
+    path = '{0}/{1}'.format(cls._collection_path, uuid)
+    return sdk.api.delete(path)
+
+  def delete (self):
+    return self._sdk.api.delete(self._get_resource_path())
+
   @classmethod
   def get (cls, uuid, sdk):
     if not uuid or not isinstance(uuid, basestring):
@@ -318,7 +328,13 @@ def save (self):
   def _get_channel_name (self):
     return 'data:{0}:{1}'.format(self.group, self.key)
 
+  @classmethod
+  def delete_ (cls, group, key, sdk):
+    path = '{0}/{1}/{2}'.format(cls._collection_path, group, key)
+    sdk.api.delete(path)
 
+  def delete (self):
+    self._sdk.api.delete(self._get_resource_path())
 
 
 class Content (CommonResource):

exp_sdk/exp.py

@@ -143,6 +143,9 @@ def find_devices (self, params=None):
   def create_device (self, document=None):
     return self._sdk.api.Device.create(document, self._sdk)
 
+  def delete_device (self, uuid=None):
+    return self._sdk.api.Device.delete_(uuid, self._sdk)
+
 
   def get_thing (self, uuid=None):
     return self._sdk.api.Thing.get(uuid, self._sdk)
@@ -153,6 +156,9 @@ def find_things (self, params=None):
   def create_thing (self, document=None):
     return self._sdk.api.Thing.create(document, self._sdk)
 
+  def delete_thing (self, uuid=None):
+    return self._sdk.api.Thing.delete_(uuid, self._sdk)
+
 
   def get_experience (self, uuid=None):
     return self._sdk.api.Experience.get(uuid, self._sdk)
@@ -166,6 +172,9 @@ def find_experiences (self, params=None):
   def create_experience (self, document=None):
     return self._sdk.api.Experience.create(document, self._sdk)
 
+  def delete_experience (self, uuid=None):
+    return self._sdk.api.Experience.delete_(uuid, self._sdk)
+
 
   def get_location (self, uuid=None):
     return self._sdk.api.Location.get(uuid, self._sdk)
@@ -176,13 +185,15 @@ def get_current_location(self):
   def get_current_zones(self):
     return self._sdk.api.Zone.get_current(self._sdk)
 
-
   def find_locations (self, params=None):
     return self._sdk.api.Location.find(params, self._sdk)
 
   def create_location (self, document=None):
     return self._sdk.api.Location.create(document, self._sdk)
 
+  def delete_location (self, uuid=None):
+    return self._sdk.api.Location.delete_(uuid, self._sdk)
+
 
   def get_feed (self, uuid=None):
     return self._sdk.api.Feed.get(uuid, self._sdk)
@@ -193,6 +204,9 @@ def find_feeds (self, params=None):
   def create_feed (self, document=None):
     return self._sdk.api.Feed.create(document, self._sdk)
 
+  def delete_feed (self, uuid=None):
+    return self._sdk.api.Feed.delete_(uuid, self._sdk);
+
 
   def get_data (self, group='default', key=None):
     return self._sdk.api.Data.get(group, key, self._sdk)
@@ -203,6 +217,9 @@ def find_data (self, params=None):
   def create_data (self, group=None, key=None, value=None):
     return self._sdk.api.Data.create(group, key, value, self._sdk)
 
+  def delete_data(self, group=None, key=None):
+    return self._sdk.api.Data.delete_(group, key, self._sdk)
+
 
   def get_content (self, uuid=None):
     return self._sdk.api.Content.get(uuid, self._sdk)

setup.py

@@ -3,12 +3,12 @@
 setup(
   name='exp-sdk',
   packages= ['exp_sdk'],
-  version='1.0.6',
+  version='1.0.7',
   description='EXP Python SDK',
   author='Scala',
   author_email='[email protected]',
   url='https://github.com/scalainc/exp-python2-sdk',
-  download_url='https://github.com/scalainc/exp-python2-sdk/tarball/1.0.6',
+  download_url='https://github.com/scalainc/exp-python2-sdk/tarball/1.0.7',
   install_requires=["requests", "socketIO_client"],
   license='MIT',
   keywords=['scala', 'exp', 'sdk', 'signage'],

tests/test_data.py

@@ -36,3 +36,17 @@ def test_update (self):
     data = self.exp.get_data(data.group, data.key)
     if data.value['test2'] != 'a':
       raise Exception
+
+  def test_delete (self):
+    data = self.create_valid()
+    key = data.key
+    group = data.group
+    data.delete()
+    if self.exp.get_data(group, key):
+      raise Exception
+    data = self.create_valid()
+    key = data.key
+    group = data.group
+    self.exp.delete_data(group, key)
+    if self.exp.get_data(group, key):
+      raise Exception

tests/test_devices.py

@@ -47,5 +47,15 @@ def test_get_current (self):
     exp = self.exp_sdk.start(**self.user_credentials)
     if exp.get_current_device():
       raise Exception()
-  
-    
+
+  def test_delete (self):
+    device = self.create_valid()
+    uuid = device.uuid
+    device.delete()
+    if self.exp.get_device(uuid):
+      raise Exception
+    device = self.create_valid()
+    uuid = device.uuid
+    self.exp.delete_device(uuid)
+    if self.exp.get_device(uuid):
+      raise Exception

tests/test_experiences.py

@@ -39,4 +39,15 @@ def test_get_current (self):
     exp = self.exp_sdk.start(**self.user_credentials)
     if exp.get_current_experience():
       raise Exception()
-      
+
+  def test_delete (self):
+    experience = self.create_valid()
+    uuid = experience.uuid
+    experience.delete()
+    if self.exp.get_experience(uuid):
+      raise Exception
+    experience = self.create_valid()
+    uuid = experience.uuid
+    self.exp.delete_experience(uuid)
+    if self.exp.get_experience(uuid):
+      raise Exception

tests/test_feeds.py

@@ -24,3 +24,14 @@ def test_dynamic (self):
     data = feed.get_data(searchValue='19713')
     if data['search']['search'] != '19713':
       raise Exception
+
+  def test_delete (self):
+    feed = self.create_valid()
+    feed.delete()
+    if self.exp.get_feed(uuid):
+      raise Exception
+    feed = self.create_valid()
+    uuid = feed.uuid
+    self.exp.delete_feed(uuid)
+    if self.exp.get_feed(uuid):
+      raise Exception

tests/test_locations.py

@@ -54,3 +54,15 @@ def test_get_current (self):
     exp = self.exp_sdk.start(**self.user_credentials)
     if exp.get_current_location():
       raise Exception()
+
+  def test_delete (self):
+    location = self.create_valid()
+    uuid = location.uuid
+    location.delete()
+    if self.exp.get_location(uuid):
+      raise Exception
+    location = self.create_valid()
+    uuid = location.uuid
+    self.exp.delete_location(uuid)
+    if self.exp.get_location(uuid):
+      raise Exception

tests/test_things.py

@@ -1,4 +1,3 @@
-
 import unittest
 
 from . import utils
@@ -32,3 +31,14 @@ def test_get_zones (self):
     if zones[0].key != 'key_2':
       raise Exception
 
+  def test_delete (self):
+    thing = self.create_valid()
+    uuid = thing.uuid
+    thing.delete()
+    if self.exp.get_thing(uuid):
+      raise Exception
+    thing = self.create_valid()
+    uuid = thing.uuid
+    self.exp.delete_thing(uuid)
+    if self.exp.get_thing(uuid):
+      raise Exception