Add first models

Author: iMicknl

tahoma_api/client.py

@@ -10,13 +10,15 @@
 import json
 
 from .exceptions import *
+from .models import *
+
+API_URL = "https://tahomalink.com/enduser-mobile-web/enduserAPI/"  # /doc for API doc
 
-API_URL = 'https://tahomalink.com/enduser-mobile-web/enduserAPI/'  # /doc for API doc
 
 class TahomaClient(object):
     """ Interface class for the Tahoma API """
 
-    def __init__(self, username, password):
+    def __init__(self, username, password, api_url=API_URL):
         """
         Constructor
 
@@ -26,53 +28,52 @@ def __init__(self, username, password):
 
         self.username = username
         self.password = password
-
+        self.api_url = api_url
 
         self._devices = None
 
-
         self.__roles = []
 
     async def login(self):
-        
-        payload = {
-            'userId': self.username,
-            'userPassword': self.password
-        }
+
+        payload = {"userId": self.username, "userPassword": self.password}
 
         async with aiohttp.ClientSession() as session:
-            async with session.post(API_URL + 'login', data=payload) as response:
+            async with session.post(self.api_url + "login", data=payload) as response:
 
                 result = await response.json()
 
                 # 401
                 # {'errorCode': 'AUTHENTICATION_ERROR', 'error': 'Bad credentials'}
                 # {'errorCode': 'AUTHENTICATION_ERROR', 'error': 'Your setup cannot be accessed through this application'}
                 if response.status == 401:
-                    if result['errorCode'] == 'AUTHENTICATION_ERROR':
+                    if result["errorCode"] == "AUTHENTICATION_ERROR":
+
+                        if "Too many requests" in result["error"]:
+                            print(result["error"])
 
-                        if 'Too many requests' in result['error']:
-                            print(result['error'])
+                        if (
+                            "Your setup cannot be accessed through this application"
+                            in result["error"]
+                        ):
+                            print(result["error"])
 
-                        if 'Your setup cannot be accessed through this application' in result['error']:
-                            print(result['error'])
+                        if "Bad credentials" in result["error"]:
+                            print(result["error"])
 
-                        if 'Bad credentials' in result['error']:
-                            print(result['error'])
+                        print(result["error"])
 
-                        print(result['error'])
+                        return False  # todo throw error
 
-                        return False # todo throw error
-                   
                 # 401
                 # {'errorCode': 'AUTHENTICATION_ERROR', 'error': 'Too many requests, try again later : login with xxx@xxx.tld'}
                 # TODO Add retry logic on too many requests + for debug, log requests + timespans
-   
+
                 # 200
                 # {'success': True, 'roles': [{'name': 'ENDUSER'}]}
                 if response.status == 200:
-                    if result['success'] == True:
-                        self.__roles = result['roles']
+                    if result["success"] == True:
+                        self.__roles = result["roles"]
                         self.__cookies = response.cookies
 
                         return True
@@ -81,24 +82,26 @@ async def login(self):
                 print(response.status)
                 print(result)
 
-    async def get_devices(self, refresh=False):
+    async def get_devices(self, refresh=False) -> List[Device]:
+
+        if self._devices and refresh == False:
+            return self._devices
 
-        if self._devices is None or refresh == True:
+        cookies = self.__cookies
 
-            cookies = self.__cookies
+        # 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:
 
-            async with aiohttp.ClientSession() as session:
-                async with session.get(API_URL + 'setup/devices', cookies=cookies) as response:
+                result = await response.json()
 
-                    result = await response.json()
+                # for device in result.items()
 
-                    if (response.status is 200):
-                        self._devices = result
+                if response.status is 200:
+                    devices = [Device(**d) for d in result]
+                    self._devices = devices
 
-                        return result
-                    
-                    # TODO add retry logic for unauthorized?
+                    return devices
 
-                    else:
-                        return []
-                    # TODO Save cookies

tahoma_api/models.py

@@ -0,0 +1,73 @@
+from typing import Any, Dict, List, Optional, Union
+
+# TODO Rewrite camelCase to snake_case
+class Device:
+    __slots__ = (
+        "creationTime",
+        "lastUpdateTime",
+        "label",
+        "deviceURL",
+        "shortcut",
+        "controllableName",
+        "definition",
+        "states",
+        "dataProperties",
+        "widgetName",
+        "uiClass",
+        "qualifiedName",
+        "type",
+    )
+
+    def __init__(
+        self,
+        *,
+        label: str,
+        deviceURL: str,
+        controllableName: str,
+        definition: Dict[List[Any]],
+        states: List[Dict[str, Any]],
+        dataProperties: Optional[List[Dict[str, Any]]] = None,
+        widgetName: Optional[str] = None,
+        uiClass: str,
+        qualifiedName: Optional[str] = None,
+        type: str,
+        **kwargs: Any
+    ):
+        self.deviceURL = deviceURL
+        self.controllableName = controllableName
+        self.states = [State(**s) for s in states]
+
+
+class StateDefinition:
+    __slots__ = (
+        "qualifiedName",
+        "type",
+        "values",
+    )
+
+    def __init__(
+        self, qualifiedName: str, type: str, values: Optional[str], **kwargs: Any
+    ):
+        self.qualifiedName = qualifiedName
+        self.type = type
+        self.values = values
+
+
+class CommandDefinition:
+    __slots__ = (
+        "commandName",
+        "nparams",
+    )
+
+    def __init__(self, commandName: str, nparams: int, **kwargs: Any):
+        self.commandName = commandName
+        self.nparams = nparams
+
+
+class State:
+    __slots__ = "name", "value", "type"
+
+    def __init__(self, name: str, value: str, type: str, **kwargs: Any):
+        self.name = name
+        self.value = value
+        self.type = type