Add more properties to Device (#15)

Author: iMicknl

tahoma_api/client.py

@@ -7,7 +7,7 @@
 from aiohttp import ClientResponse
 
 from tahoma_api.exceptions import BadCredentialsException, TooManyRequestsException
-from tahoma_api.models import Command, Device, Scenario, State
+from tahoma_api.models import Command, Device, Event, Execution, Scenario, State
 
 JSON = Union[Dict[str, Any], List[Dict[str, Any]]]
 
@@ -36,7 +36,7 @@ def __init__(self, username: str, password: str, api_url: str = API_URL) -> None
 
     async def close(self) -> None:
         """Close the session."""
-        return await self.session.close()
+        await self.session.close()
 
     async def login(self) -> bool:
         """
@@ -92,30 +92,31 @@ async def register_event_listener(self) -> str:
 
         return listener_id
 
-    async def fetch_event_listener(self, listener_id: str) -> List[Any]:
+    async def fetch_event_listener(self, listener_id: str) -> List[Event]:
         """
         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.__post(f"events/{listener_id}/fetch")
+        events = [Event(**e) for e in humps.decamelize(response)]
 
-        return response
+        return events
 
-    async def get_current_execution(self, exec_id: str) -> List[Any]:
+    async def get_current_execution(self, exec_id: str) -> List[Execution]:
         """ Get an action group execution currently running """
-        response = await self.__get(f"/exec/current/{exec_id}")
-        # TODO Strongly type executions
+        response = await self.__get(f"exec/current/{exec_id}")
+        executions = [Execution(**e) for e in humps.decamelize(response)]
 
-        return response
+        return executions
 
-    async def get_current_executions(self) -> List[Any]:
+    async def get_current_executions(self) -> List[Execution]:
         """ Get all action groups executions currently running """
-        response = await self.__get("/exec/current")
-        # TODO Strongly type executions
+        response = await self.__get("exec/current")
+        executions = [Execution(**e) for e in humps.decamelize(response)]
 
-        return response
+        return executions
 
     async def execute_command(
         self,

tahoma_api/models.py

@@ -7,6 +7,7 @@
 class Device:
     __slots__ = (
         "id",
+        "attributes",
         "controllable_name",
         "creation_time",
         "last_update_time",
@@ -28,7 +29,9 @@ class Device:
     def __init__(
         self,
         *,
+        attributes: Optional[List[Dict[str, Any]]] = None,
         available: bool,
+        enabled: bool,
         label: str,
         deviceurl: str,
         controllable_name: str,
@@ -42,32 +45,39 @@ def __init__(
         **_: Any
     ) -> None:
         self.id = deviceurl
+        self.attributes = [State(**a) for a in attributes] if attributes else None
         self.available = available
-        self.definition = definition
+        self.definition = Definition(**definition)
         self.deviceurl = deviceurl
+        self.enabled = enabled
         self.label = label
         self.controllable_name = controllable_name
-        self.states = states
-        # self.states = [State(**s) for s in states]
+        self.states = [State(**s) for s in states] if states else None
         self.data_properties = data_properties
         self.widget = widget
         self.ui_class = ui_class
         self.qualified_name = qualified_name
         self.type = type
 
 
-# class Definition:
-#     __slots__ = (
-#         "commands",
-#         "states",
-#         "widget_name",
-#         "ui_class",
-#         "ui_classifiers" "type",
-#     )
+class Definition:
+    __slots__ = ("commands", "states", "widget_name", "ui_class", "qualified_name")
 
-#     def __init__(self, command_name: str, nparams: int, **_: Any) -> None:
-#         self.command_name = command_name
-#         self.nparams = nparams
+    def __init__(
+        self,
+        *,
+        commands: List[Dict[str, Any]],
+        states: Optional[List[Dict[str, Any]]] = None,
+        widget_name: str,
+        ui_class: str,
+        qualified_name: str,
+        **_: Any
+    ) -> None:
+        self.commands = [CommandDefinition(**cd) for cd in commands]
+        self.states = [StateDefinition(**sd) for sd in states] if states else None
+        self.widget_name = widget_name
+        self.ui_class = ui_class
+        self.qualified_name = qualified_name
 
 
 class StateDefinition:
@@ -78,7 +88,11 @@ class StateDefinition:
     )
 
     def __init__(
-        self, qualified_name: str, type: str, values: Optional[str], **_: Any
+        self,
+        qualified_name: str,
+        type: str,
+        values: Optional[List[str]] = None,
+        **_: Any
     ) -> None:
         self.qualified_name = qualified_name
         self.type = type
@@ -125,6 +139,69 @@ class CommandMode(Enum):
     internal = "internal"
 
 
+class Event:
+    __slots__ = (
+        "timestamp",
+        "name",
+        "gateway_id",
+        "exec_id",
+        "deviceurl",
+        "device_states",
+        "old_state",
+        "new_state",
+        "owner_key",
+    )
+
+    def __init__(
+        self,
+        timestamp: int,
+        name: str,
+        gateway_id: Optional[str] = None,
+        exec_id: Optional[str] = None,
+        deviceurl: Optional[str] = None,
+        device_states: Optional[List[Dict[str, Any]]] = None,
+        old_state: Optional[str] = None,
+        new_state: Optional[str] = None,
+        **_: Any
+    ):
+        self.timestamp = timestamp
+        self.name = name
+        self.gateway_id = gateway_id
+        self.exec_id = exec_id
+        self.deviceurl = deviceurl
+        self.device_states = (
+            [State(**s) for s in device_states] if device_states else None
+        )
+        self.old_state = old_state
+        self.new_state = new_state
+
+
+class Execution:
+
+    __slots__ = (
+        "id",
+        "description",
+        "owner",
+        "state",
+        "action_group",
+    )
+
+    def __init__(
+        self,
+        id: str,
+        description: str,
+        owner: str,
+        state: str,
+        action_group: List[Dict[str, Any]],
+        **_: Any
+    ):
+        self.id = id
+        self.description = description
+        self.owner = owner
+        self.state = state
+        self.action_group = action_group
+
+
 class Scenario:
     __slots__ = ("label", "oid")