leneda-client 0.5.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

leneda/client.py

@@ -8,14 +8,15 @@ energy consumption and production data for electricity and gas.
 import json
 import logging
 from datetime import datetime, timedelta
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Awaitable, Callable, Dict, List, Optional, Union
 
 import aiohttp
-from aiohttp import ClientTimeout
+from aiohttp import ClientResponseError, ClientTimeout
 
-from .exceptions import ForbiddenException, UnauthorizedException
+from .exceptions import ForbiddenException, MeteringPointNotFoundException, UnauthorizedException
 from .models import (
     AggregatedMeteringData,
+    AuthenticationProbeResult,
     MeteringData,
 )
 from .obis_codes import ObisCode
@@ -115,7 +116,7 @@ class LenedaClient:
 
                     # Parse the response
                     if response.content:
-                        response_data = await response.json()
+                        response_data: dict = await response.json()
                         logger.debug(f"Response status: {response.status}")
                         logger.debug(f"Response data: {json.dumps(response_data, indent=2)}")
                         return response_data
@@ -133,6 +134,39 @@ class LenedaClient:
             logger.error(f"JSON decode error: {e}")
             raise
 
+    async def _make_metering_request(
+        self, request_callable: Callable[..., Awaitable[dict[Any, Any]]], *args: Any, **kwargs: Any
+    ) -> dict[Any, Any]:
+        """
+        Make a request to a metering data endpoint with 404 error handling.
+
+        This wrapper around any request callable specifically handles 404 errors for metering data
+        endpoints by raising MeteringPointNotFoundException.
+
+        Args:
+            request_callable: The callable to execute (e.g., self._make_request)
+            *args: Arguments to pass to the callable
+            **kwargs: Keyword arguments to pass to the callable
+
+        Returns:
+            The JSON response from the API
+
+        Raises:
+            MeteringPointNotFoundException: If the API returns a 404 status code
+            UnauthorizedException: If the API returns a 401 status code
+            ForbiddenException: If the API returns a 403 status code
+            aiohttp.ClientError: For other request errors
+            json.JSONDecodeError: If the response cannot be parsed as JSON
+        """
+        try:
+            return await request_callable(*args, **kwargs)
+        except aiohttp.ClientResponseError as e:
+            if e.status == 404:
+                raise MeteringPointNotFoundException(
+                    "Metering point not found. The requested metering point may not exist or you may not have access to it."
+                )
+            raise
+
     async def get_metering_data(
         self,
         metering_point_code: str,
@@ -167,7 +201,9 @@ class LenedaClient:
         }
 
         # Make the request
-        response_data = await self._make_request(method="GET", endpoint=endpoint, params=params)
+        response_data = await self._make_metering_request(
+            self._make_request, method="GET", endpoint=endpoint, params=params
+        )
 
         # Parse the response into a MeteringData object
         return MeteringData.from_dict(response_data)
@@ -212,7 +248,9 @@ class LenedaClient:
         }
 
         # Make the request
-        response_data = await self._make_request(method="GET", endpoint=endpoint, params=params)
+        response_data = await self._make_metering_request(
+            self._make_request, method="GET", endpoint=endpoint, params=params
+        )
 
         # Parse the response into an AggregatedMeteringData object
         return AggregatedMeteringData.from_dict(response_data)
@@ -320,3 +358,41 @@ class LenedaClient:
             if await self.probe_metering_point_obis_code(metering_point_code, obis_code):
                 supported_codes.append(obis_code)
         return supported_codes
+
+    async def probe_credentials(self) -> AuthenticationProbeResult:
+        """
+        Probe if credentials are valid.
+
+        NOTE: This is an experimental function, as the Leneda API does not provide a native way to verify credentials only.
+        Use with caution, may break or yield unexpected results.
+
+        This method attempts to verify authentication by making a request to the metering data access endpoint
+        with invalid parameters. If the API returns a 400 status code, it indicates that authentication is successful
+        but the request parameters are invalid. If it returns a 401 status code, authentication has failed.
+
+        We make a request with invalid parameters because we don't want to actually lodge a metering data access request,
+        we just want to verify that the credentials are valid.
+
+        Returns:
+            AuthenticationProbeResult: SUCCESS if authentication is valid, FAILURE if authentication failed,
+            or UNKNOWN if the result cannot be determined
+
+        Raises:
+            ForbiddenException: If the API returns a 403 status code
+        """
+        try:
+            await self.request_metering_data_access("", "", [], [])
+        except UnauthorizedException:
+            return AuthenticationProbeResult.FAILURE
+        except ClientResponseError as e:
+            # We expect a 400 response if authentication is successful and our request is invalid
+            if e.status == 400:
+                # Update the config entry with new token
+                return AuthenticationProbeResult.SUCCESS
+            return AuthenticationProbeResult.UNKNOWN
+        except ForbiddenException:
+            raise
+        except Exception:
+            return AuthenticationProbeResult.UNKNOWN
+
+        return AuthenticationProbeResult.UNKNOWN

leneda/exceptions.py

@@ -19,3 +19,9 @@ class ForbiddenException(LenedaException):
     """Raised when access is forbidden (403 Forbidden), typically due to geoblocking or other access restrictions."""
 
     pass
+
+
+class MeteringPointNotFoundException(LenedaException):
+    """Raised when a metering point is not found."""
+
+    pass

leneda/models.py

@@ -8,6 +8,7 @@ making it easier to work with the data in a type-safe manner.
 import logging
 from dataclasses import dataclass, field
 from datetime import datetime
+from enum import Enum
 from typing import Any, Dict, List
 
 from dateutil import parser
@@ -237,3 +238,11 @@ class AggregatedMeteringData:
             f"AggregatedMeteringData(unit={self.unit}, "
             f"items_count={len(self.aggregated_time_series)})"
         )
+
+
+class AuthenticationProbeResult(Enum):
+    """Result of an authentication probe."""
+
+    SUCCESS = "SUCCESS"
+    FAILURE = "FAILURE"
+    UNKNOWN = "UNKNOWN"

leneda/version.py

@@ -1,3 +1,3 @@
 """Version information."""
 
-__version__ = "0.5.0"
+__version__ = "0.6.0"

{leneda_client-0.5.0.dist-info → leneda_client-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: leneda-client
-Version: 0.5.0
+Version: 0.6.0
 Summary: Python client for the Leneda energy data platform
 Home-page: https://github.com/fedus/leneda-client
 Author: fedus

leneda_client-0.6.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+leneda/__init__.py,sha256=-BHIXBfTTbX6EKDHr2Bq7rPzsPNYrrkgs9AJqWJR_1Q,732
+leneda/client.py,sha256=v41E1jFqe5MLMAoSOCtSYm8ZYWJwXCo-rBmKwMpDjB4,15875
+leneda/exceptions.py,sha256=eyQpEYdLAU_BkXbZeldS6XgXeQJEIKp4dBeyzwlKOfA,580
+leneda/models.py,sha256=Dwn99_h9D7bKnBZY_3WJ5bwA6XyBliEYK6A9kBhKtmk,8111
+leneda/obis_codes.py,sha256=VfsJQN1U80eZ5g1bIteDCLkkmBQ0AIkkm_zNAeM1Dog,7507
+leneda/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+leneda/version.py,sha256=5C-KzeFwke_CL13dukzT7o-_j-Sv7xz_3L5EqVn3hI0,50
+leneda_client-0.6.0.dist-info/licenses/LICENSE,sha256=nAhDs625lK6v8oLqjWCABKBKlwxVoRDFXQvoZPfOtKQ,1062
+leneda_client-0.6.0.dist-info/METADATA,sha256=kVCSco-qeUMd6V0mr6RF02C4Ivb87VAW8hFNsSKfSyQ,3515
+leneda_client-0.6.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+leneda_client-0.6.0.dist-info/top_level.txt,sha256=PANScm25ep7WLjKiph0fhJPb8s_sa_uLHemnBpQBaJ8,7
+leneda_client-0.6.0.dist-info/RECORD,,

{leneda_client-0.5.0.dist-info → leneda_client-0.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.7.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

leneda_client-0.5.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-leneda/__init__.py,sha256=-BHIXBfTTbX6EKDHr2Bq7rPzsPNYrrkgs9AJqWJR_1Q,732
-leneda/client.py,sha256=aATrm5lI6O97cvVpwdtXGQA5kF3P6I4PZIE6G7y50AQ,12413
-leneda/exceptions.py,sha256=q00gjI5VwXAMF2I1gXfQidZMzbCF6UOSo4i1Wnb-inU,460
-leneda/models.py,sha256=jdU2cIZZDExUSiSfz9zaYjJepr0m3v_x5b1fyOaEI8Q,7930
-leneda/obis_codes.py,sha256=VfsJQN1U80eZ5g1bIteDCLkkmBQ0AIkkm_zNAeM1Dog,7507
-leneda/version.py,sha256=ScwrsoTG4Jp3gCphFH5AJNnhCl94poCw0wfA4QqStu0,50
-leneda_client-0.5.0.dist-info/licenses/LICENSE,sha256=nAhDs625lK6v8oLqjWCABKBKlwxVoRDFXQvoZPfOtKQ,1062
-leneda_client-0.5.0.dist-info/METADATA,sha256=lDNsYdQxINFuJtLRcqG2rGW1zRIc9z-34_Kzx3BnSp4,3515
-leneda_client-0.5.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-leneda_client-0.5.0.dist-info/top_level.txt,sha256=PANScm25ep7WLjKiph0fhJPb8s_sa_uLHemnBpQBaJ8,7
-leneda_client-0.5.0.dist-info/RECORD,,