Refactor authentication strategy to use server configuration diraectly and update related server handling

Author: iMicknl

pyoverkiz/auth/factory.py

@@ -23,26 +23,21 @@
     SessionLoginStrategy,
     SomfyAuthStrategy,
 )
-from pyoverkiz.const import SUPPORTED_SERVERS
 from pyoverkiz.enums import APIType, Server
 from pyoverkiz.models import ServerConfig
 
 
 def build_auth_strategy(
-    server_key: str | Server | None,
+    *,
     server_config: ServerConfig,
     credentials: Credentials,
     session: ClientSession,
     ssl_context: ssl.SSLContext | bool,
 ) -> Any:
     """Build the correct auth strategy for the given server and credentials."""
-    # Normalize server key
-    try:
-        key = Server(server_key) if server_key else _match_server_key(server_config)
-    except ValueError:
-        key = None
+    server: Server | None = server_config.server
 
-    if key == Server.SOMFY_EUROPE:
+    if server == Server.SOMFY_EUROPE:
         return SomfyAuthStrategy(
             _ensure_username_password(credentials),
             session,
@@ -51,7 +46,7 @@ def build_auth_strategy(
             server_config.type,
         )
 
-    if key in {
+    if server in {
         Server.ATLANTIC_COZYTOUCH,
         Server.THERMOR_COZYTOUCH,
         Server.SAUTER_COZYTOUCH,
@@ -64,7 +59,7 @@ def build_auth_strategy(
             server_config.type,
         )
 
-    if key == Server.NEXITY:
+    if server == Server.NEXITY:
         return NexityAuthStrategy(
             _ensure_username_password(credentials),
             session,
@@ -73,7 +68,7 @@ def build_auth_strategy(
             server_config.type,
         )
 
-    if key == Server.REXEL:
+    if server == Server.REXEL:
         return RexelAuthStrategy(
             _ensure_rexel(credentials),
             session,
@@ -111,15 +106,6 @@ def build_auth_strategy(
     )
 
 
-def _match_server_key(server: ServerConfig) -> Server:
-    """Find the `Server` enum corresponding to a `ServerConfig` entry."""
-    for key, value in SUPPORTED_SERVERS.items():
-        if server is value or server.endpoint == value.endpoint:
-            return Server(key)
-
-    raise ValueError("Unable to match server to a known Server enum.")
-
-
 def _ensure_username_password(credentials: Credentials) -> UsernamePasswordCredentials:
     """Validate that credentials are username/password based."""
     if not isinstance(credentials, UsernamePasswordCredentials):

pyoverkiz/client.py

@@ -172,9 +172,7 @@ def __init__(
             # work with Overkiz self-signed gateway certificates
             self._ssl.verify_flags &= ~ssl.VERIFY_X509_STRICT
 
-        inferred_server_key = server_key or self._resolve_server_key()
         self._auth = build_auth_strategy(
-            inferred_server_key,
             self.server_config,
             credentials,
             self.session,
@@ -211,6 +209,9 @@ def _normalize_server(server: ServerConfig | Server | str) -> ServerConfig:
 
     def _resolve_server_key(self) -> Server:
         """Infer a `Server` enum for the current server configuration."""
+        if self.server_config.server:
+            return self.server_config.server
+
         for key, value in SUPPORTED_SERVERS.items():
             if (
                 self.server_config is value
@@ -243,7 +244,7 @@ async def login(
         """
         await self._auth.login()
 
-        if self.api_type == APIType.LOCAL:
+        if self.server_config.type == APIType.LOCAL:
             if register_event_listener:
                 await self.register_event_listener()
             else:

pyoverkiz/const.py

@@ -42,96 +42,112 @@
 
 SUPPORTED_SERVERS: dict[str, ServerConfig] = {
     Server.ATLANTIC_COZYTOUCH: ServerConfig(
+        server=Server.ATLANTIC_COZYTOUCH,
         name="Atlantic Cozytouch",
         endpoint="https://ha110-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Atlantic",
         type=APIType.CLOUD,
     ),
     Server.BRANDT: ServerConfig(
+        server=Server.BRANDT,
         name="Brandt Smart Control",
         endpoint="https://ha3-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Brandt",
         type=APIType.CLOUD,
     ),
     Server.FLEXOM: ServerConfig(
+        server=Server.FLEXOM,
         name="Flexom",
         endpoint="https://ha108-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Bouygues",
         type=APIType.CLOUD,
     ),
     Server.HEXAOM_HEXACONNECT: ServerConfig(
+        server=Server.HEXAOM_HEXACONNECT,
         name="Hexaom HexaConnect",
         endpoint="https://ha5-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hexaom",
         type=APIType.CLOUD,
     ),
     Server.HI_KUMO_ASIA: ServerConfig(
+        server=Server.HI_KUMO_ASIA,
         name="Hitachi Hi Kumo (Asia)",
         endpoint="https://ha203-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hitachi",
         type=APIType.CLOUD,
     ),
     Server.HI_KUMO_EUROPE: ServerConfig(
+        server=Server.HI_KUMO_EUROPE,
         name="Hitachi Hi Kumo (Europe)",
         endpoint="https://ha117-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hitachi",
         type=APIType.CLOUD,
     ),
     Server.HI_KUMO_OCEANIA: ServerConfig(
+        server=Server.HI_KUMO_OCEANIA,
         name="Hitachi Hi Kumo (Oceania)",
         endpoint="https://ha203-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hitachi",
         type=APIType.CLOUD,
     ),
     Server.NEXITY: ServerConfig(
+        server=Server.NEXITY,
         name="Nexity Eugénie",
         endpoint="https://ha106-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Nexity",
         type=APIType.CLOUD,
     ),
     Server.REXEL: ServerConfig(
+        server=Server.REXEL,
         name="Rexel Energeasy Connect",
         endpoint=REXEL_BACKEND_API,
         manufacturer="Rexel",
         type=APIType.CLOUD,
     ),
     Server.SAUTER_COZYTOUCH: ServerConfig(  # duplicate of Atlantic Cozytouch
+        server=Server.SAUTER_COZYTOUCH,
         name="Sauter Cozytouch",
         endpoint="https://ha110-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Sauter",
         type=APIType.CLOUD,
     ),
     Server.SIMU_LIVEIN2: ServerConfig(  # alias of https://tahomalink.com
+        server=Server.SIMU_LIVEIN2,
         name="SIMU (LiveIn2)",
         endpoint="https://ha101-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Somfy",
         type=APIType.CLOUD,
     ),
     Server.SOMFY_EUROPE: ServerConfig(  # alias of https://tahomalink.com
+        server=Server.SOMFY_EUROPE,
         name="Somfy (Europe)",
         endpoint="https://ha101-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Somfy",
         type=APIType.CLOUD,
     ),
     Server.SOMFY_AMERICA: ServerConfig(
+        server=Server.SOMFY_AMERICA,
         name="Somfy (North America)",
         endpoint="https://ha401-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Somfy",
         type=APIType.CLOUD,
     ),
     Server.SOMFY_OCEANIA: ServerConfig(
+        server=Server.SOMFY_OCEANIA,
         name="Somfy (Oceania)",
         endpoint="https://ha201-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Somfy",
         type=APIType.CLOUD,
     ),
     Server.THERMOR_COZYTOUCH: ServerConfig(  # duplicate of Atlantic Cozytouch
+        server=Server.THERMOR_COZYTOUCH,
         name="Thermor Cozytouch",
         endpoint="https://ha110-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Thermor",
         type=APIType.CLOUD,
     ),
     Server.UBIWIZZ: ServerConfig(
+        server=Server.UBIWIZZ,
         name="Ubiwizz",
         endpoint="https://ha129-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Decelect",

pyoverkiz/models.py

@@ -24,7 +24,7 @@
 )
 from pyoverkiz.enums.command import OverkizCommand, OverkizCommandParam
 from pyoverkiz.enums.protocol import Protocol
-from pyoverkiz.enums.server import APIType
+from pyoverkiz.enums.server import APIType, Server
 from pyoverkiz.obfuscate import obfuscate_email, obfuscate_id, obfuscate_string
 from pyoverkiz.types import DATA_TYPE_TO_PYTHON, StateType
 
@@ -963,6 +963,7 @@ def __init__(
 class ServerConfig:
     """Connection target details for an Overkiz-compatible server."""
 
+    server: Server | None = None
     name: str
     endpoint: str
     manufacturer: str

pyoverkiz/utils.py

@@ -5,7 +5,7 @@
 import re
 
 from pyoverkiz.const import LOCAL_API_PATH
-from pyoverkiz.enums.server import APIType
+from pyoverkiz.enums.server import APIType, Server
 from pyoverkiz.models import ServerConfig
 
 
@@ -15,13 +15,15 @@ def create_local_server_config(
     name: str = "Somfy Developer Mode",
     manufacturer: str = "Somfy",
     type: APIType = APIType.LOCAL,
+    server: Server | None = Server.SOMFY_DEVELOPER_MODE,
     configuration_url: str | None = None,
 ) -> ServerConfig:
     """Generate server configuration for a local API (Somfy Developer mode)."""
     return create_server_config(
         name=name,
         endpoint=f"https://{host}{LOCAL_API_PATH}",
         manufacturer=manufacturer,
+        server=server,
         configuration_url=configuration_url,
         type=type,
     )
@@ -32,11 +34,13 @@ def create_server_config(
     name: str,
     endpoint: str,
     manufacturer: str,
+    server: Server | None = None,
     type: APIType = APIType.CLOUD,
     configuration_url: str | None = None,
 ) -> ServerConfig:
     """Generate server configuration with the provided endpoint and metadata."""
     return ServerConfig(
+        server=server,
         name=name,
         endpoint=endpoint,
         manufacturer=manufacturer,