Add id, base, security, and securityDefinitions. (#56)

Author: mrstegeman

CHANGELOG.md

@@ -1,10 +1,12 @@
 # webthing Changelog
 
 ## [Unreleased]
-### Added
-- Ability to set a base URL path on server.
 ### Changed
 - Things now use `title` rather than `name`.
+- Things now require a unique ID in the form of a URI.
+### Added
+- Ability to set a base URL path on server.
+- Support for `id`, `base`, `security`, and `securityDefinitions` keys in thing description.
 
 ## [0.11.3] - 2019-04-10
 ### Changed

README.rst

@@ -54,7 +54,12 @@ First we create a new Thing:
 
 .. code:: python
 
-    light = Thing('My Lamp', ['OnOffSwitch', 'Light'], 'A web connected lamp')
+    light = Thing(
+        'urn:dev:ops:my-lamp-1234',
+        'My Lamp',
+        ['OnOffSwitch', 'Light'],
+        'A web connected lamp'
+    )
 
 Now we can add the required properties.
 
@@ -122,9 +127,12 @@ First we create a new Thing:
 
 .. code:: python
 
-  sensor = Thing('My Humidity Sensor',
-                 ['MultiLevelSensor'],
-                 'A web connected humidity sensor')
+  sensor = Thing(
+      'urn:dev:ops:my-humidity-sensor-1234',
+      'My Humidity Sensor',
+       ['MultiLevelSensor'],
+       'A web connected humidity sensor'
+  )
 
 Then we create and add the appropriate property:
 

example/multiple-things.py

@@ -29,10 +29,13 @@ class ExampleDimmableLight(Thing):
     """A dimmable light that logs received commands to stdout."""
 
     def __init__(self):
-        Thing.__init__(self,
-                       'My Lamp',
-                       ['OnOffSwitch', 'Light'],
-                       'A web connected lamp')
+        Thing.__init__(
+            self,
+            'urn:dev:ops:my-lamp-1234',
+            'My Lamp',
+            ['OnOffSwitch', 'Light'],
+            'A web connected lamp'
+        )
 
         self.add_property(
             Property(self,
@@ -101,10 +104,13 @@ class FakeGpioHumiditySensor(Thing):
     """A humidity sensor which updates its measurement every few seconds."""
 
     def __init__(self):
-        Thing.__init__(self,
-                       'My Humidity Sensor',
-                       ['MultiLevelSensor'],
-                       'A web connected humidity sensor')
+        Thing.__init__(
+            self,
+            'urn:dev:ops:my-humidity-sensor-1234',
+            'My Humidity Sensor',
+            ['MultiLevelSensor'],
+            'A web connected humidity sensor'
+        )
 
         self.level = Value(0.0)
         self.add_property(

example/single-thing.py

@@ -24,7 +24,12 @@ def perform_action(self):
 
 
 def make_thing():
-    thing = Thing('My Lamp', ['OnOffSwitch', 'Light'], 'A web connected lamp')
+    thing = Thing(
+        'urn:dev:ops:my-lamp-1234',
+        'My Lamp',
+        ['OnOffSwitch', 'Light'],
+        'A web connected lamp'
+    )
 
     thing.add_property(
         Property(thing,

webthing/server.py

@@ -144,6 +144,17 @@ def get(self):
                 'rel': 'alternate',
                 'href': '{}{}'.format(ws_href, thing.get_href()),
             })
+            description['base'] = '{}://{}{}'.format(
+                self.request.protocol,
+                self.request.headers.get('Host', ''),
+                thing.get_href()
+            )
+            description['securityDefinitions'] = {
+                'nosec_sc': {
+                    'scheme': 'nosec',
+                },
+            }
+            description['security'] = 'nosec_sc'
             descriptions.append(description)
 
         self.write(json.dumps(descriptions))
@@ -216,6 +227,17 @@ def get(self, thing_id='0'):
             'rel': 'alternate',
             'href': '{}{}'.format(ws_href, self.thing.get_href()),
         })
+        description['base'] = '{}://{}{}'.format(
+            self.request.protocol,
+            self.request.headers.get('Host', ''),
+            self.thing.get_href()
+        )
+        description['securityDefinitions'] = {
+            'nosec_sc': {
+                'scheme': 'nosec',
+            },
+        }
+        description['security'] = 'nosec_sc'
 
         self.write(json.dumps(description))
         self.finish()

webthing/thing.py

@@ -9,17 +9,19 @@
 class Thing:
     """A Web Thing."""
 
-    def __init__(self, title, type_=[], description=''):
+    def __init__(self, id_, title, type_=[], description=''):
         """
         Initialize the object.
 
+        id_ -- the thing's unique ID - must be a URI
         title -- the thing's title
         type_ -- the thing's type(s)
         description -- description of the thing
         """
         if not isinstance(type_, list):
             type_ = [type_]
 
+        self.id = id_
         self.context = 'https://iot.mozilla.org/schemas'
         self.type = type_
         self.title = title
@@ -40,8 +42,8 @@ def as_thing_description(self):
         Returns the state as a dictionary.
         """
         thing = {
+            'id': self.id,
             'title': self.title,
-            'href': self.href_prefix if self.href_prefix else '/',
             '@context': self.context,
             '@type': self.type,
             'properties': self.get_property_descriptions(),
@@ -127,6 +129,14 @@ def set_ui_href(self, href):
         """
         self.ui_href = href
 
+    def get_id(self):
+        """
+        Get the ID of the thing.
+
+        Returns the ID as a string.
+        """
+        return self.id
+
     def get_title(self):
         """
         Get the title of the thing.