Rename server as client

Author: tetienne

README.md

@@ -47,8 +47,8 @@ PASSWORD = ""
 async def main() -> None:
 
     session = ClientSession()
-    server = SUPPORTED_SERVERS["somfy_europe"](session)
-    async with server as client:
+    client = SUPPORTED_SERVERS["somfy_europe"](session)
+    async with client as client:
         try:
             await client.login(USERNAME, PASSWORD)
         except Exception as exception:  # pylint: disable=broad-except
@@ -69,6 +69,7 @@ async def main() -> None:
 
 
 asyncio.run(main())
+
 ```
 
 ## Development

pyoverkiz/servers/atlantic_cozytouch.py renamed to pyoverkiz/clients/atlantic_cozytouch.py

@@ -2,19 +2,19 @@
 
 from aiohttp import FormData
 
+from pyoverkiz.clients.overkiz import OverkizClient
 from pyoverkiz.exceptions import (
     CozyTouchBadCredentialsException,
     CozyTouchServiceException,
 )
-from pyoverkiz.servers.overkiz_server import OverkizServer
 
 COZYTOUCH_ATLANTIC_API = "https://apis.groupe-atlantic.com"
 COZYTOUCH_CLIENT_ID = (
     "Q3RfMUpWeVRtSUxYOEllZkE3YVVOQmpGblpVYToyRWNORHpfZHkzNDJVSnFvMlo3cFNKTnZVdjBh"
 )
 
 
-class AtlanticCozytouch(OverkizServer):
+class AtlanticCozytouchClient(OverkizClient):
     async def _login(self, username: str, password: str) -> bool:
         """
         Authenticate and create an API session allowing access to the other operations.

pyoverkiz/servers/default.py renamed to pyoverkiz/clients/default.py

@@ -1,7 +1,7 @@
-from pyoverkiz.servers.overkiz_server import OverkizServer
+from pyoverkiz.clients.overkiz import OverkizClient
 
 
-class DefaultServer(OverkizServer):
+class DefaultClient(OverkizClient):
     async def _login(self, username: str, password: str) -> bool:
         """
         Authenticate and create an API session allowing access to the other operations.

pyoverkiz/servers/nexity.py renamed to pyoverkiz/clients/nexity.py

@@ -7,16 +7,16 @@
 from botocore.config import Config
 from warrant_lite import WarrantLite
 
+from pyoverkiz.clients.overkiz import OverkizClient
 from pyoverkiz.exceptions import NexityBadCredentialsException, NexityServiceException
-from pyoverkiz.servers.overkiz_server import OverkizServer
 
 NEXITY_API = "https://api.egn.prd.aws-nexity.fr"
 NEXITY_COGNITO_CLIENT_ID = "3mca95jd5ase5lfde65rerovok"
 NEXITY_COGNITO_USER_POOL = "eu-west-1_wj277ucoI"
 NEXITY_COGNITO_REGION = "eu-west-1"
 
 
-class NexityServer(OverkizServer):
+class NexityClient(OverkizClient):
     async def _login(self, username: str, password: str) -> bool:
         """
         Authenticate and create an API session allowing access to the other operations.

pyoverkiz/servers/overkiz_server.py renamed to pyoverkiz/clients/overkiz.py

@@ -1,4 +1,4 @@
-""" Python wrapper for the OverKiz API """
+""" Python wrapper for the OverKiz API"""
 
 from __future__ import annotations
 
@@ -59,8 +59,8 @@ async def refresh_listener(invocation: Mapping[str, Any]) -> None:
 
 
 @define(kw_only=True)
-class OverkizServer(ABC):
-    """Interface class for the Overkiz API"""
+class OverkizClient(ABC):
+    """Abstract class for the Overkiz API"""
 
     # username: str
     # password: str = field(repr=lambda _: "***")
@@ -134,7 +134,7 @@ async def delete(self, path: str) -> None:
         ) as response:
             await self.check_response(response)
 
-    async def __aenter__(self) -> OverkizServer:
+    async def __aenter__(self) -> OverkizClient:
         return self
 
     async def __aexit__(

pyoverkiz/servers/somfy.py renamed to pyoverkiz/clients/somfy.py

@@ -5,16 +5,16 @@
 
 from aiohttp import FormData
 
+from pyoverkiz.clients.overkiz import OverkizClient
 from pyoverkiz.exceptions import SomfyBadCredentialsException, SomfyServiceException
-from pyoverkiz.servers.overkiz_server import OverkizServer
 from pyoverkiz.types import JSON
 
 SOMFY_API = "https://accounts.somfy.com"
 SOMFY_CLIENT_ID = "0d8e920c-1478-11e7-a377-02dd59bd3041_1ewvaqmclfogo4kcsoo0c8k4kso884owg08sg8c40sk4go4ksg"
 SOMFY_CLIENT_SECRET = "12k73w1n540g8o4cokg0cw84cog840k84cwggscwg884004kgk"
 
 
-class SomfyServer(OverkizServer):
+class SomfyClient(OverkizClient):
 
     _access_token: str | None = None
     _refresh_token: str | None = None

pyoverkiz/const.py

@@ -4,105 +4,105 @@
 
 from aiohttp import ClientSession
 
-from pyoverkiz.servers.atlantic_cozytouch import AtlanticCozytouch
-from pyoverkiz.servers.default import DefaultServer
-from pyoverkiz.servers.nexity import NexityServer
-from pyoverkiz.servers.overkiz_server import OverkizServer
-from pyoverkiz.servers.somfy import SomfyServer
+from pyoverkiz.clients.atlantic_cozytouch import AtlanticCozytouchClient
+from pyoverkiz.clients.default import DefaultClient
+from pyoverkiz.clients.nexity import NexityClient
+from pyoverkiz.clients.overkiz import OverkizClient
+from pyoverkiz.clients.somfy import SomfyClient
 
-SUPPORTED_SERVERS: dict[str, Callable[[ClientSession], OverkizServer]] = {
-    "atlantic_cozytouch": lambda session: AtlanticCozytouch(
+SUPPORTED_SERVERS: dict[str, Callable[[ClientSession], OverkizClient]] = {
+    "atlantic_cozytouch": lambda session: AtlanticCozytouchClient(
         name="Atlantic Cozytouch",
         endpoint="https://ha110-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Atlantic",
         configuration_url=None,
         session=session,
     ),
-    "brandt": lambda session: DefaultServer(
+    "brandt": lambda session: DefaultClient(
         name="Brandt Smart Control",
         endpoint="https://ha3-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Brandt",
         configuration_url=None,
         session=session,
     ),
-    "flexom": lambda session: DefaultServer(
+    "flexom": lambda session: DefaultClient(
         name="Flexom",
         endpoint="https://ha108-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Bouygues",
         configuration_url=None,
         session=session,
     ),
-    "hexaom_hexaconnect": lambda session: DefaultServer(
+    "hexaom_hexaconnect": lambda session: DefaultClient(
         name="Hexaom HexaConnect",
         endpoint="https://ha5-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hexaom",
         configuration_url=None,
         session=session,
     ),
-    "hi_kumo_asia": lambda session: DefaultServer(
+    "hi_kumo_asia": lambda session: DefaultClient(
         name="Hitachi Hi Kumo (Asia)",
         endpoint="https://ha203-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hitachi",
         configuration_url=None,
         session=session,
     ),
-    "hi_kumo_europe": lambda session: DefaultServer(
+    "hi_kumo_europe": lambda session: DefaultClient(
         name="Hitachi Hi Kumo (Europe)",
         endpoint="https://ha117-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hitachi",
         configuration_url=None,
         session=session,
     ),
-    "hi_kumo_oceania": lambda session: DefaultServer(
+    "hi_kumo_oceania": lambda session: DefaultClient(
         name="Hitachi Hi Kumo (Oceania)",
         endpoint="https://ha203-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Hitachi",
         configuration_url=None,
         session=session,
     ),
-    "nexity": lambda session: NexityServer(
+    "nexity": lambda session: NexityClient(
         name="Nexity Eugénie",
         endpoint="https://ha106-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Nexity",
         configuration_url=None,
         session=session,
     ),
-    "rexel": lambda session: DefaultServer(
+    "rexel": lambda 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,
     ),
-    "simu_livein2": lambda session: DefaultServer(  # alias of https://tahomalink.com
+    "simu_livein2": lambda 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,
     ),
-    "somfy_europe": lambda session: SomfyServer(  # alias of https://tahomalink.com
+    "somfy_europe": lambda 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,
     ),
-    "somfy_america": lambda session: DefaultServer(
+    "somfy_america": lambda session: DefaultClient(
         name="Somfy (North America)",
         endpoint="https://ha401-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Somfy",
         configuration_url=None,
         session=session,
     ),
-    "somfy_oceania": lambda session: DefaultServer(
+    "somfy_oceania": lambda session: DefaultClient(
         name="Somfy (Oceania)",
         endpoint="https://ha201-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Somfy",
         configuration_url=None,
         session=session,
     ),
-    "ubiwizz": lambda session: DefaultServer(
+    "ubiwizz": lambda session: DefaultClient(
         name="Ubiwizz",
         endpoint="https://ha129-1.overkiz.com/enduser-mobile-web/enduserAPI/",
         manufacturer="Decelect",