Merge pull request #49 from seamapi/implement-events-get

Author: xplato

seamapi/events.py

@@ -95,3 +95,55 @@ def list(
 
         events = res.json()["events"]
         return events
+
+    def get(
+        self,
+        event_id: Optional[str] = None,
+        event_type: Optional[str] = None,
+        device_id: Optional[str] = None
+    ) -> Event:
+        """Get an Event.
+
+        Parameters
+        ----------
+            event_id : Optional[str]
+                Event ID to filter events by
+            event_type : Optional[str]
+                Event type to filter events by
+            device_id : Optional[str]
+                Device ID to filter events by
+
+        Raises
+        ------
+        Exception
+            If the API request wasn't successful.
+
+        Returns
+        ------
+            An event or None.
+        """
+        params = {}
+
+        arguments = {
+            "event_id": event_id,
+            "event_type": event_type,
+            "device_id": device_id
+        }
+
+        for name in arguments:
+            if arguments[name]:
+                params.update({ name: arguments[name] })
+
+        res = requests.get(
+            f"{self.seam.api_url}/events/get",
+            headers={"Authorization": f"Bearer {self.seam.api_key}"},
+            params=params,
+        )
+        
+        if not res.ok:
+            raise Exception(res.text)
+
+        if not res.json().get("event", None):
+            return None
+
+        return res.json()["event"]

tests/events/test_events.py

@@ -3,9 +3,22 @@
 
 SINCE="2021-01-01T00:00:00.000Z"
 EVENT_TYPE = "device.connected"
+FAKE_UUID = "00000000-0000-0000-0000-000000000000"
 
 def test_events(seam: Seam):
     run_august_factory(seam)
 
     events = seam.events.list(since=SINCE)
-    assert events[0]['event_type'] == EVENT_TYPE
+    assert events[0]['event_type'] == EVENT_TYPE
+
+    event_by_id = seam.events.get(event_id=events[0]['event_id'])
+    assert event_by_id['event_id'] == events[0]['event_id']
+
+    event_by_type = seam.events.get(event_type=events[0]['event_type'])
+    assert event_by_type['event_type'] == events[0]['event_type']
+
+    event_by_device_id = seam.events.get(device_id=events[0]['device_id'])
+    assert event_by_device_id['device_id'] == events[0]['device_id']
+
+    none_event = seam.events.get(event_id=FAKE_UUID)
+    assert none_event is None