pypetkitapi 0.1.0__tar.gz → 0.2.0__tar.gz

{pypetkitapi-0.1.0 → pypetkitapi-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pypetkitapi
-Version: 0.1.0
+Version: 0.2.0
 Summary: Python client for PetKit API
 Home-page: https://github.com/Jezza34000/pypetkit
 License: MIT

{pypetkitapi-0.1.0 → pypetkitapi-0.2.0}/pypetkitapi/client.py

@@ -1,5 +1,6 @@
 """Pypetkit Client: A Python library for interfacing with PetKit"""
 
+import asyncio
 from datetime import datetime, timedelta
 from enum import StrEnum
 import hashlib
@@ -22,7 +23,14 @@ from pypetkitapi.const import (
     PetkitURL,
 )
 from pypetkitapi.containers import AccountData, Device, RegionInfo, SessionInfo
-from pypetkitapi.exceptions import PypetkitError
+from pypetkitapi.exceptions import (
+    PetkitAuthenticationError,
+    PetkitInvalidHTTPResponseCodeError,
+    PetkitInvalidResponseFormat,
+    PetkitRegionalServerNotFoundError,
+    PetkitTimeoutError,
+    PypetkitError,
+)
 from pypetkitapi.feeder_container import Feeder
 from pypetkitapi.litter_container import Litter
 from pypetkitapi.water_fountain_container import WaterFountain
@@ -49,12 +57,13 @@ class PetKitClient:
         """Initialize the PetKit Client."""
         self.username = username
         self.password = password
-        self.region = region
+        self.region = region.lower()
         self.timezone = timezone
 
     async def _generate_header(self) -> dict[str, str]:
         """Create header for interaction with devices."""
         session_id = self._session.id if self._session is not None else ""
+
         return {
             "Accept": Header.ACCEPT.value,
             "Accept-Language": Header.ACCEPT_LANG,
@@ -92,7 +101,11 @@ class PetKitClient:
         _LOGGER.debug("Finding region server for region: %s", self.region)
 
         regional_server = next(
-            (server for server in self._servers_list if server.name == self.region),
+            (
+                server
+                for server in self._servers_list
+                if server.name.lower() == self.region
+            ),
             None,
         )
 
@@ -102,7 +115,7 @@ class PetKitClient:
             )
             self._base_url = regional_server.gateway
             return
-        _LOGGER.debug("Region %s not found in server list", self.region)
+        raise PetkitRegionalServerNotFoundError(self.region)
 
     async def request_login_code(self) -> bool:
         """Request a login code to be sent to the user's email."""
@@ -124,6 +137,8 @@ class PetKitClient:
         # Retrieve the list of servers
         await self._get_base_url()
 
+        _LOGGER.debug("Logging in to PetKit server")
+
         # Prepare the data to send
         data = LOGIN_DATA.copy()
         data["encrypt"] = "1"
@@ -198,6 +213,7 @@ class PetKitClient:
 
     async def get_devices_data(self) -> None:
         """Get the devices data from the PetKit servers."""
+        start_time = datetime.now()
         if not self.account_data:
             await self._get_account_data()
 
@@ -207,19 +223,25 @@ class PetKitClient:
             if account.device_list:
                 device_list.extend(account.device_list)
 
-        _LOGGER.info("%s devices found for this account", len(device_list))
+        _LOGGER.debug("Fetch %s devices for this account", len(device_list))
+
+        tasks = []
         for device in device_list:
             _LOGGER.debug("Fetching devices data: %s", device)
             device_type = device.device_type.lower()
-            # TODO: Fetch device records
             if device_type in DEVICES_FEEDER:
-                await self._fetch_device_data(device, Feeder)
+                tasks.append(self._fetch_device_data(device, Feeder))
             elif device_type in DEVICES_LITTER_BOX:
-                await self._fetch_device_data(device, Litter)
+                tasks.append(self._fetch_device_data(device, Litter))
             elif device_type in DEVICES_WATER_FOUNTAIN:
-                await self._fetch_device_data(device, WaterFountain)
+                tasks.append(self._fetch_device_data(device, WaterFountain))
             else:
                 _LOGGER.warning("Unknown device type: %s", device_type)
+        await asyncio.gather(*tasks)
+
+        end_time = datetime.now()
+        total_time = end_time - start_time
+        _LOGGER.debug("Petkit fetch took : %s", total_time)
 
     async def _fetch_device_data(
         self,
@@ -241,7 +263,7 @@ class PetKitClient:
         )
         device_data = data_class(**response)
         device_data.device_type = device.device_type  # Add the device_type attribute
-        _LOGGER.info("Adding device type: %s", device.device_type)
+        _LOGGER.debug("Reading device type : %s", device.device_type)
         self.device_list.append(device_data)
 
     async def send_api_request(
@@ -334,14 +356,7 @@ class PrepReq:
                     data=data,
                     headers=_headers,
                 ) as resp:
-                    response = await resp.json()
-                    if ERR_KEY in response:
-                        error_msg = response[ERR_KEY].get("msg", "Unknown error")
-                        raise PypetkitError(f"Request failed: {error_msg}")
-                    if RES_KEY in response:
-                        _LOGGER.debug("Request response: %s", response)
-                        return response[RES_KEY]
-                    raise PypetkitError("Unexpected response format")
+                    return await self._handle_response(resp, _url)
             except ContentTypeError:
                 """If we get an error, lets log everything for debugging."""
                 try:
@@ -353,3 +368,41 @@ class PrepReq:
                 _LOGGER.info("Resp raw: %s", resp_raw)
                 # Still raise the err so that it's clear it failed.
                 raise
+            except TimeoutError:
+                raise PetkitTimeoutError("The request timed out") from None
+
+    @staticmethod
+    async def _handle_response(response: aiohttp.ClientResponse, url: str) -> dict:
+        """Handle the response from the PetKit API."""
+
+        try:
+            response.raise_for_status()
+        except aiohttp.ClientResponseError as e:
+            raise PetkitInvalidHTTPResponseCodeError(
+                f"Request failed with status code {e.status}"
+            ) from e
+
+        try:
+            response_json = await response.json()
+        except ContentTypeError:
+            raise PetkitInvalidResponseFormat(
+                "Response is not in JSON format"
+            ) from None
+
+        if ERR_KEY in response_json:
+            error_msg = response_json[ERR_KEY].get("msg", "Unknown error")
+            if any(
+                endpoint in url
+                for endpoint in [
+                    PetkitEndpoint.LOGIN,
+                    PetkitEndpoint.GET_LOGIN_CODE,
+                    PetkitEndpoint.REFRESH_SESSION,
+                ]
+            ):
+                raise PetkitAuthenticationError(f"Login failed: {error_msg}")
+            raise PypetkitError(f"Request failed: {error_msg}")
+
+        if RES_KEY in response_json:
+            return response_json[RES_KEY]
+
+        raise PypetkitError("Unexpected response format")

{pypetkitapi-0.1.0 → pypetkitapi-0.2.0}/pypetkitapi/const.py

@@ -57,7 +57,7 @@ class Header(StrEnum):
     AGENT = "okhttp/3.12.11"
     CLIENT = f"{Client.PLATFORM_TYPE}({Client.OS_VERSION};{Client.MODEL_NAME})"
     TIMEZONE = "1.0"
-    TIMEZONE_ID = "Europe/Paris"
+    TIMEZONE_ID = "Europe/Paris"  # TODO: Make this dynamic, check if this really matters (record hours?)
     LOCALE = "en-US"
     IMG_VERSION = "1.0"
     HOUR = "24"
@@ -69,8 +69,8 @@ CLIENT_NFO = {
     "osVersion": Client.OS_VERSION.value,
     "platform": Client.PLATFORM_TYPE.value,
     "source": Client.SOURCE.value,
-    "timezone": Header.TIMEZONE.value,
-    "timezoneId": Header.TIMEZONE_ID.value,
+    "timezone": Header.TIMEZONE.value,  # TODO: Make this dynamic
+    "timezoneId": Header.TIMEZONE_ID.value,  # TODO: Make this dynamic
     "version": Header.API_VERSION.value,
 }
 

pypetkitapi-0.2.0/pypetkitapi/exceptions.py

@@ -0,0 +1,40 @@
+"""PyPetkit exceptions."""
+
+from __future__ import annotations
+
+
+class PypetkitError(Exception):
+    """Class for PyPetkit exceptions."""
+
+
+class PetkitTimeoutError(PypetkitError):
+    """Class for PyPetkit timeout exceptions."""
+
+
+class PetkitConnectionError(PypetkitError):
+    """Class for PyPetkit connection exceptions."""
+
+
+class PetkitRegionalServerNotFoundError(PypetkitError):
+    """Exception raised when the specified region server is not found."""
+
+    def __init__(self, region: str):
+        """Initialize the exception."""
+        self.region = region
+        self.message = (
+            f"Region you provided: '{region}' was not found in the server list. "
+            f"Are you sure you provided the correct region?"
+        )
+        super().__init__(self.message)
+
+
+class PetkitInvalidHTTPResponseCodeError(PypetkitError):
+    """Class for PyPetkit invalid HTTP Response exceptions."""
+
+
+class PetkitInvalidResponseFormat(PypetkitError):
+    """Class for PyPetkit invalid Response Format exceptions."""
+
+
+class PetkitAuthenticationError(PypetkitError):
+    """Class for PyPetkit authentication exceptions."""

{pypetkitapi-0.1.0 → pypetkitapi-0.2.0}/pypetkitapi/feeder_container.py

@@ -141,6 +141,7 @@ class StateFeeder(BaseModel):
     door: int | None = None
     feed_state: FeedState | None = Field(None, alias="feedState")
     feeding: int | None = None
+    error_msg: str | None = Field(None, alias="errorMsg")
     ota: int | None = None
     overall: int | None = None
     pim: int | None = None
@@ -163,10 +164,10 @@ class Feeder(BaseModel):
     bt_mac: str | None = Field(None, alias="btMac")
     cloud_product: CloudProduct | None = Field(None, alias="cloudProduct")
     created_at: str | None = Field(None, alias="createdAt")
-    firmware: str | None = None
-    firmware_details: list[FirmwareDetail] | None = Field(None, alias="firmwareDetails")
-    hardware: int | None = None
-    id: int | None = None
+    firmware: float
+    firmware_details: list[FirmwareDetail] = Field(alias="firmwareDetails")
+    hardware: int
+    id: int
     locale: str | None = None
     mac: str | None = None
     model_code: int | None = Field(None, alias="modelCode")
@@ -177,7 +178,7 @@ class Feeder(BaseModel):
     settings: SettingsFeeder | None = None
     share_open: int | None = Field(None, alias="shareOpen")
     signup_at: str | None = Field(None, alias="signupAt")
-    sn: str | None = None
+    sn: str
     state: StateFeeder | None = None
     timezone: float | None = None
     p2p_type: int | None = Field(None, alias="p2pType")

{pypetkitapi-0.1.0 → pypetkitapi-0.2.0}/pypetkitapi/litter_container.py

@@ -91,6 +91,7 @@ class StateLitter(BaseModel):
     box_full: bool | None = Field(None, alias="boxFull")
     box_state: int | None = Field(None, alias="boxState")
     deodorant_left_days: int | None = Field(None, alias="deodorantLeftDays")
+    error_msg: str | None = Field(None, alias="errorMsg")
     frequent_restroom: int | None = Field(None, alias="frequentRestroom")
     liquid_empty: bool | None = Field(None, alias="liquidEmpty")
     liquid_lack: bool | None = Field(None, alias="liquidLack")
@@ -140,10 +141,10 @@ class Litter(BaseModel):
     auto_upgrade: int | None = Field(None, alias="autoUpgrade")
     bt_mac: str | None = Field(None, alias="btMac")
     created_at: str | None = Field(None, alias="createdAt")
-    firmware: str | None = None
-    firmware_details: list[FirmwareDetail] | None = Field(None, alias="firmwareDetails")
-    hardware: int | None = None
-    id: int | None = None
+    firmware: float
+    firmware_details: list[FirmwareDetail] = Field(alias="firmwareDetails")
+    hardware: int
+    id: int
     is_pet_out_tips: int | None = Field(None, alias="isPetOutTips")
     locale: str | None = None
     mac: str | None = None
@@ -156,7 +157,7 @@ class Litter(BaseModel):
     settings: SettingsLitter | None = None
     share_open: int | None = Field(None, alias="shareOpen")
     signup_at: str | None = Field(None, alias="signupAt")
-    sn: str | None = None
+    sn: str
     state: StateLitter | None = None
     timezone: float | None = None
     cloud_product: CloudProduct | None = Field(None, alias="cloudProduct")  # For T5/T6

{pypetkitapi-0.1.0 → pypetkitapi-0.2.0}/pypetkitapi/water_fountain_container.py

@@ -100,9 +100,9 @@ class WaterFountain(BaseModel):
     filter_expected_days: int | None = Field(None, alias="filterExpectedDays")
     filter_percent: int | None = Field(None, alias="filterPercent")
     filter_warning: int | None = Field(None, alias="filterWarning")
-    firmware: int | None = None
-    hardware: int | None = None
-    id: int | None = None
+    firmware: float
+    hardware: int
+    id: int
     is_night_no_disturbing: int | None = Field(None, alias="isNightNoDisturbing")
     lack_warning: int | None = Field(None, alias="lackWarning")
     locale: str | None = None
@@ -110,14 +110,14 @@ class WaterFountain(BaseModel):
     mac: str | None = None
     mode: int | None = None
     module_status: int | None = Field(None, alias="moduleStatus")
-    name: str | None = None
+    name: str
     record_automatic_add_water: int | None = Field(
         None, alias="recordAutomaticAddWater"
     )
     schedule: Schedule | None = None
     secret: str | None = None
     settings: SettingsFountain | None = None
-    sn: str | None = None
+    sn: str
     status: Status | None = None
     sync_time: str | None = Field(None, alias="syncTime")
     timezone: float | None = None

{pypetkitapi-0.1.0 → pypetkitapi-0.2.0}/pyproject.toml

@@ -187,7 +187,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pypetkitapi"
-version = "0.1.0"
+version = "0.2.0"
 description = "Python client for PetKit API"
 authors = ["Jezza34000 <info@mail.com>"]
 readme = "README.md"
@@ -204,7 +204,7 @@ black = "^24.10.0"
 ruff = "^0.8.1"
 
 [tool.bumpver]
-current_version = "0.1.0"
+current_version = "0.2.0"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "bump version {old_version} -> {new_version}"
 tag_message = "{new_version}"
@@ -217,7 +217,8 @@ push = true
 
 [tool.bumpver.file_patterns]
 "pyproject.toml" = [
-    'current_version = "{version}"',
+    '^version = "{version}"',
+    '^current_version = "{version}"',
 ]
 
 [tool.tox]

pypetkitapi-0.1.0/pypetkitapi/exceptions.py

@@ -1,15 +0,0 @@
-"""PyPetkit exceptions."""
-
-from __future__ import annotations
-
-
-class PypetkitError(Exception):
-    """Class for PyPetkit exceptions."""
-
-
-class PetkitTimeoutError(PypetkitError):
-    """Class for PyPetkit timeout exceptions."""
-
-
-class PetkitConnectionError(PypetkitError):
-    """Class for PyPetkit connection exceptions."""