Added event timer support and updated README in anticipation of publish.

Author: andrewsayre

README.md

@@ -1,6 +1,9 @@
 # pysmartapp
-A python implementation of the WebHook-based SmartThings SmartApp (work in process).  Please see the [SmartApp documentation](https://smartthings.developer.samsung.com/develop/guides/smartapps/basics.html) for more information.
-
 [![Build Status](https://travis-ci.org/andrewsayre/pysmartapp.svg?branch=master)](https://travis-ci.org/andrewsayre/pysmartapp)
 [![Coverage Status](https://coveralls.io/repos/github/andrewsayre/pysmartapp/badge.svg?branch=master)](https://coveralls.io/github/andrewsayre/pysmartapp?branch=master)
-[![image](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
+[![image](https://img.shields.io/pypi/v/pysmartapp.svg)](https://pypi.org/project/pysmartapp/)
+[![image](https://img.shields.io/pypi/pyversions/pysmartapp.svg)](https://pypi.org/project/pysmartapp/)
+[![image](https://img.shields.io/pypi/l/pysmartapp.svg)](https://pypi.org/project/pysmartapp/)
+[![image](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
+
+A python implementation of the WebHook-based [SmartThings SmartApp](https://smartthings.developer.samsung.com/develop/guides/smartapps/basics.html).

pysmartapp/consts.py

@@ -10,3 +10,4 @@
 LIFECYCLE_OAUTH_CALLBACK = 'OAUTH_CALLBACK'
 LIFECYCLE_UNINSTALL = 'UNINSTALL'
 EVENT_TYPE_DEVICE = 'DEVICE_EVENT'
+EVENT_TYPE_TIMER = 'TIMER_EVENT'

pysmartapp/event.py

@@ -2,7 +2,7 @@
 
 from typing import Sequence
 
-from .consts import EVENT_TYPE_DEVICE
+from .consts import EVENT_TYPE_DEVICE, EVENT_TYPE_TIMER
 from .request import EmptyDataResponse, Request, Response
 
 
@@ -32,6 +32,17 @@ def __init__(self, data: dict):
             self._attribute = device_event['attribute']
             self._value = device_event['value']
             self._state_change = device_event['stateChange']
+        self._timer_name = None
+        self._timer_type = None
+        self._timer_time = None
+        self._timer_expression = None
+        if self._event_type == EVENT_TYPE_TIMER:
+            timer_event = data['timerEvent']
+            self._event_id = timer_event['eventId']
+            self._timer_name = timer_event['name']
+            self._timer_type = timer_event['type']
+            self._timer_time = timer_event['time']
+            self._timer_expression = timer_event['expression']
 
     @property
     def event_type(self) -> str:
@@ -83,6 +94,26 @@ def state_change(self) -> bool:
         """Get whether this is a new state change."""
         return self._state_change
 
+    @property
+    def timer_name(self) -> str:
+        """Get the name of the timer schedule."""
+        return self._timer_name
+
+    @property
+    def timer_type(self) -> str:
+        """Get the type of time."""
+        return self._timer_type
+
+    @property
+    def timer_time(self) -> str:
+        """Get the time the timer fired."""
+        return self._timer_time
+
+    @property
+    def timer_expression(self) -> str:
+        """Get the timer firing expression."""
+        return self._timer_expression
+
 
 class EventRequest(Request):
     """Define the EventRequest class."""

tests/fixtures/event_request.json

@@ -24,6 +24,16 @@
           "value" :"active",
           "stateChange": true
         }
+      },
+      {
+        "eventType": "TIMER_EVENT",
+        "timerEvent": {
+          "eventId": "string",
+          "name": "lights_off_timeout",
+          "type": "CRON",
+          "time": "2017-09-13T04:18:12.469Z",
+          "expression": "string"
+        }
       }
     ]
   },

tests/test_event.py

@@ -1,6 +1,7 @@
 """"Tests for the event module."""
 
-from pysmartapp.consts import EVENT_TYPE_DEVICE, LIFECYCLE_EVENT
+from pysmartapp.consts import (EVENT_TYPE_DEVICE, EVENT_TYPE_TIMER,
+                               LIFECYCLE_EVENT)
 from pysmartapp.event import Event, EventRequest
 
 from .utilities import get_fixture
@@ -27,14 +28,14 @@ def test_init():
         assert req.installed_app_config == {}
         assert req.settings == data['settings']
         assert req.auth_token == 'f01894ce-013a-434a-b51e-f82126fd72e4'
-        assert len(req.events) == 1
+        assert len(req.events) == 2
 
 
 class TestEvent:
     """Tests for the Event class."""
 
     @staticmethod
-    def test_init():
+    def test_init_device_event():
         """Tests the init method."""
         # Arrange
         data = get_fixture('event_request')['eventData']['events'][0]
@@ -51,3 +52,18 @@ def test_init():
         assert evt.attribute == 'motion'
         assert evt.value == 'active'
         assert evt.state_change
+
+    @staticmethod
+    def test_init_timer_event():
+        """Tests the init method."""
+        # Arrange
+        data = get_fixture('event_request')['eventData']['events'][1]
+        # Act
+        evt = Event(data)
+        # Assert
+        assert evt.event_type == EVENT_TYPE_TIMER
+        assert evt.event_id == 'string'
+        assert evt.timer_name == 'lights_off_timeout'
+        assert evt.timer_type == 'CRON'
+        assert evt.timer_time == '2017-09-13T04:18:12.469Z'
+        assert evt.timer_expression == 'string'