Rollback username and password to constructor

Author: tetienne

pyoverkiz/clients/overkiz.py

@@ -62,8 +62,8 @@ async def refresh_listener(invocation: Mapping[str, Any]) -> None:
 class OverkizClient(ABC):
     """Abstract class for the Overkiz API"""
 
-    # username: str
-    # password: str = field(repr=lambda _: "***")
+    username: str
+    password: str = field(repr=lambda _: "***")
     name: str
     endpoint: str
     manufacturer: str
@@ -74,9 +74,6 @@ class OverkizClient(ABC):
     devices: list[Device] = field(factory=list, init=False)
     gateways: list[Gateway] = field(factory=list, init=False)
 
-    # TODO: Add support for registering event listener
-    #
-
     @abstractmethod
     async def _login(
         self,
@@ -85,14 +82,12 @@ async def _login(
     ) -> bool:
         """Login to the server."""
 
-    async def login(
-        self, username: str, password: str, register_event_listener: bool = True
-    ) -> bool:
+    async def login(self, register_event_listener: bool = True) -> bool:
         """
         Authenticate and create an API session allowing access to the other operations.
         Caller must provide one of [userId+userPassword, userId+ssoToken, accessToken, jwt]
         """
-        if await self._login(username, password):
+        if await self._login(self.username, self.password):
             if register_event_listener:
                 await self.register_event_listener()
         return False

pyoverkiz/const.py

@@ -10,103 +10,131 @@
 from pyoverkiz.clients.overkiz import OverkizClient
 from pyoverkiz.clients.somfy import SomfyClient
 
-SUPPORTED_SERVERS: dict[str, Callable[[ClientSession], OverkizClient]] = {
-    "atlantic_cozytouch": lambda session: AtlanticCozytouchClient(
+SUPPORTED_SERVERS: dict[str, Callable[[str, str, ClientSession], OverkizClient]] = {
+    "atlantic_cozytouch": lambda username, password, session: AtlanticCozytouchClient(
         name="Atlantic Cozytouch",
         endpoint="https://ha110-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Atlantic",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
-    "brandt": lambda session: DefaultClient(
+    "brandt": lambda username, password, session: DefaultClient(
         name="Brandt Smart Control",
         endpoint="https://ha3-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Brandt",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
-    "flexom": lambda session: DefaultClient(
+    "flexom": lambda username, password, session: DefaultClient(
         name="Flexom",
         endpoint="https://ha108-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Bouygues",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
-    "hexaom_hexaconnect": lambda session: DefaultClient(
+    "hexaom_hexaconnect": lambda username, password, session: DefaultClient(
         name="Hexaom HexaConnect",
         endpoint="https://ha5-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hexaom",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
-    "hi_kumo_asia": lambda session: DefaultClient(
+    "hi_kumo_asia": lambda username, password, session: DefaultClient(
         name="Hitachi Hi Kumo (Asia)",
         endpoint="https://ha203-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hitachi",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
-    "hi_kumo_europe": lambda session: DefaultClient(
+    "hi_kumo_europe": lambda username, password, session: DefaultClient(
         name="Hitachi Hi Kumo (Europe)",
         endpoint="https://ha117-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hitachi",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
-    "hi_kumo_oceania": lambda session: DefaultClient(
+    "hi_kumo_oceania": lambda username, password, session: DefaultClient(
         name="Hitachi Hi Kumo (Oceania)",
         endpoint="https://ha203-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hitachi",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
-    "nexity": lambda session: NexityClient(
+    "nexity": lambda username, password, session: NexityClient(
         name="Nexity Eugénie",
         endpoint="https://ha106-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Nexity",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
-    "rexel": lambda session: DefaultClient(
+    "rexel": lambda username, password, session: DefaultClient(
         name="Rexel Energeasy Connect",
         endpoint="https://ha112-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Rexel",
         configuration_url="https://utilisateur.energeasyconnect.com/user/#/zone/equipements",
         session=session,
+        username=username,
+        password=password,
     ),
-    "simu_livein2": lambda session: DefaultClient(  # alias of https://tahomalink.com
+    "simu_livein2": lambda username, password, session: DefaultClient(  # alias of https://tahomalink.com
         name="SIMU (LiveIn2)",
         endpoint="https://ha101-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Somfy",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
-    "somfy_europe": lambda session: SomfyClient(  # alias of https://tahomalink.com
+    "somfy_europe": lambda username, password, session: SomfyClient(  # alias of https://tahomalink.com
         name="Somfy (Europe)",
         endpoint="https://ha101-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Somfy",
         configuration_url="https://www.tahomalink.com",
         session=session,
+        username=username,
+        password=password,
     ),
-    "somfy_america": lambda session: DefaultClient(
+    "somfy_america": lambda username, password, session: DefaultClient(
         name="Somfy (North America)",
         endpoint="https://ha401-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Somfy",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
-    "somfy_oceania": lambda session: DefaultClient(
+    "somfy_oceania": lambda username, password, session: DefaultClient(
         name="Somfy (Oceania)",
         endpoint="https://ha201-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Somfy",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
-    "ubiwizz": lambda session: DefaultClient(
+    "ubiwizz": lambda username, password, session: DefaultClient(
         name="Ubiwizz",
         endpoint="https://ha129-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Decelect",
         configuration_url=None,
         session=session,
+        username=username,
+        password=password,
     ),
 }

tests/test_client.py

@@ -15,7 +15,7 @@
 class TestOverkizClient:
     @fixture
     def client(self):
-        return SUPPORTED_SERVERS["somfy_europe"](aiohttp.ClientSession())
+        return SUPPORTED_SERVERS["somfy_europe"]("foo", "pass", aiohttp.ClientSession())
 
     @pytest.mark.asyncio
     async def test_get_devices_basic(self, client):