Add event listeners test

Author: iMicknl

tahoma_api/client.py

@@ -30,9 +30,9 @@ def __init__(self, username, password, api_url=API_URL):
         self.password = password
         self.api_url = api_url
 
-        self._devices = None
-
-        self.__roles = []
+        self.__cookies = None
+        self.__devices = None
+        self.__roles = None
 
     async def login(self):
 
@@ -51,6 +51,7 @@ async def login(self):
 
                         if "Too many requests" in result["error"]:
                             print(result["error"])
+                            raise Exception
 
                         if (
                             "Your setup cannot be accessed through this application"
@@ -83,25 +84,64 @@ async def login(self):
                 print(result)
 
     async def get_devices(self, refresh=False) -> List[Device]:
-
-        if self._devices and refresh == False:
+        if self.__devices and refresh == False:
             return self._devices
 
-        cookies = self.__cookies
+        response = await self.__make_http_request("GET", "setup/devices")
 
-        # TODO add retry logic for unauthorized? 
-        async with aiohttp.ClientSession() as session:
-            async with session.get(
-                self.api_url + "setup/devices", cookies=cookies
-            ) as response:
+        devices = [Device(**d) for d in response]
+        self.__devices = devices
 
-                result = await response.json()
+        return devices
+
+    async def register_event_listener(self) -> str:
+        """ 
+        Register a new setup event listener on the current session and return a new listener id. 
+        Only one listener may be registered on a given session. 
+        Registering an new listener will invalidate the previous one if any. 
+        Note that registering an event listener drastically reduces the session timeout : listening sessions are expected to call the /events/{listenerId}/fetch API on a regular basis.
+        """
+        response = await self.__make_http_request("POST", "events/register")
+        listener_id = response.get("id")
 
-                # for device in result.items()
+        return listener_id
 
-                if response.status is 200:
-                    devices = [Device(**d) for d in result]
-                    self._devices = devices
+    async def fetch_event_listener(self, listener_id: str) -> List[Any]:
+        """
+        Fetch new events from a registered event listener. Fetched events are removed from the listener buffer. Return an empty response if no event is available.
+        Per-session rate-limit : 1 calls per 1 SECONDS period for this particular operation (polling)
+        """
+        response = await self.__make_http_request("POST", f"events/{listener_id}/fetch")
 
-                    return devices
+        return response
+
+    async def __make_http_request(
+        self, method: str, endpoint: str, payload: Optional[Any] = None
+    ) -> Any:
+        """Make a request to the TaHoma API"""
+        cookies = self.__cookies
+        supported_methods = ["GET", "POST"]
+
+        if method not in supported_methods:
+            raise Exception
+
+        async with aiohttp.ClientSession() as session:
+            if method == "GET":
+                async with session.get(
+                    self.api_url + endpoint, cookies=cookies
+                ) as response:
+                    result = await response.json()
+
+            if method == "POST":
+                async with session.post(
+                    self.api_url + endpoint, cookies=cookies, data=payload
+                ) as response:
+                    result = await response.json()
+
+        if response.status == 200:
+            return result
+
+        if response.status > 400 and response.status < 500:
+            # implement retry logic
+            print("TODO")
 

tahoma_api/models.py

@@ -3,6 +3,7 @@
 # TODO Rewrite camelCase to snake_case
 class Device:
     __slots__ = (
+        "id",
         "creationTime",
         "lastUpdateTime",
         "label",
@@ -12,7 +13,10 @@ class Device:
         "definition",
         "states",
         "dataProperties",
+        "available",
+        "enabled",
         "widgetName",
+        "widget",
         "uiClass",
         "qualifiedName",
         "type",
@@ -24,7 +28,7 @@ def __init__(
         label: str,
         deviceURL: str,
         controllableName: str,
-        definition: Dict[List[Any]],
+        # definition: Dict[List[Any]],
         states: List[Dict[str, Any]],
         dataProperties: Optional[List[Dict[str, Any]]] = None,
         widgetName: Optional[str] = None,
@@ -33,7 +37,9 @@ def __init__(
         type: str,
         **kwargs: Any
     ):
+        self.id = deviceURL
         self.deviceURL = deviceURL
+        self.label = label
         self.controllableName = controllableName
         self.states = [State(**s) for s in states]
 

test.py

@@ -1,18 +1,27 @@
 import asyncio
 from tahoma_api import TahomaClient
+import time
 
 username = ""
 password = ""
 
+
 async def main():
     client = TahomaClient(username, password)
-    
+
     try:
         login = await client.login()
-        devices = await client.get_states()
+        devices = await client.get_devices()
+
+        for device in devices:
+            print(f"{device.label} ({device.id})")
 
-        print(devices)
+        listener_id = await client.register_event_listener()
 
+        while True:
+            events = await client.fetch_event_listener(listener_id)
+            print(events)
+            time.sleep(2)
 
     except Exception as exception:
         print(exception)