igloohome-api 0.0.3__py3-none-any.whl

igloohome_api/__init__.py

@@ -0,0 +1,140 @@
+"""Library for accessing igloohome API"""
+from typing import Any
+from dacite import from_dict
+
+import aiohttp
+import jwt
+from dataclasses import dataclass
+
+_OAUTH2_HOST = "https://auth.igloohome.co"
+_OAUTH2_TOKEN_PATH = "/oauth2/token"
+_OAUTH2_SCOPE_EVERYTHING = OAUTH2_SCOPE = "igloohomeapi/algopin-hourly igloohomeapi/algopin-daily igloohomeapi/algopin-permanent igloohomeapi/algopin-onetime igloohomeapi/create-pin-bridge-proxied-job igloohomeapi/delete-pin-bridge-proxied-job igloohomeapi/lock-bridge-proxied-job igloohomeapi/unlock-bridge-proxied-job igloohomeapi/get-devices igloohomeapi/get-job-status igloohomeapi/get-properties"
+
+_BASE_URL = "https://api.igloodeveloper.co"
+_BASE_PATH = "igloohome"
+_DEVICES_PATH_SEGMENT = "devices"
+
+@dataclass
+class GetDevicesResponsePayload:
+    id: str
+    type: str
+    deviceId: str
+    deviceName: str
+    pairedAt: str
+    homeId: Any
+    linkedDevices: Any
+
+
+@dataclass
+class GetDevicesResponse:
+    nextCursor: str
+    payload: list[GetDevicesResponsePayload]
+
+class Auth:
+    def __init__(
+            self,
+            session: aiohttp.ClientSession,
+            client_id: str,
+            client_secret: str,
+            host: str = _OAUTH2_HOST,
+            scope: str = _OAUTH2_SCOPE_EVERYTHING,
+    ) -> None:
+        self.access_token = None
+        self.session = session
+        self.client_id = client_id
+        self.client_secret = client_secret
+        self.host = host
+        self.scope = scope
+
+    async def async_get_access_token(self) -> str:
+        form = aiohttp.FormData()
+        form.add_field("grant_type", "client_credentials")
+        form.add_field("scope", self.scope)
+        response = await self.session.post(
+            url=self.host + _OAUTH2_TOKEN_PATH,
+            auth=aiohttp.BasicAuth(
+                login=self.client_id, password=self.client_secret
+            ),
+            data=form,
+        )
+        json = await response.json()
+        if response.status == 200:
+            self.access_token = json["access_token"]
+            return self.access_token
+        else:
+            raise AuthException(f'Failed to get access token. responseCode=${response.status}')
+
+    async def async_get_valid_access_token(self) -> str:
+        """Gets a valid access token."""
+        if self.access_token is None:
+            access_token = await self.async_get_access_token()
+            return access_token
+        elif is_access_token_valid(self.access_token):
+            return self.access_token
+        else:
+            return await self.async_get_access_token()
+
+    async def request(self, method: str, url: str, **kwargs) -> aiohttp.ClientResponse:
+        """Make a request."""
+        headers = kwargs.get("headers")
+
+        if headers is None:
+            headers = {}
+        else:
+            headers = dict(headers)
+
+        headers["Authorization"] = f"Bearer {await self.async_get_valid_access_token()}"
+        headers["Accept"] = "application/json"
+
+        return await self.session.request(
+            method, url, **kwargs, headers=headers,
+        )
+
+
+def is_access_token_valid(access_token: str) -> bool:
+    """Check if the access token is valid."""
+    try:
+        # Expiry is automatically verified during decoding. Will raise ExpiredSignatureError.
+        # See: https://pyjwt.readthedocs.io/en/stable/usage.html#expiration-time-claim-exp
+        claims = jwt.decode(access_token, options={"require": ["exp"]})
+    except Exception:
+        return False
+
+
+class AuthException(Exception):
+    pass
+
+class Api:
+    def __init__(
+            self,
+            auth: Auth,
+            host: str = _BASE_URL
+    ):
+        self.auth = auth
+        self.host = host
+
+    async def get_devices(self) -> GetDevicesResponse:
+        response = await self.auth.request(
+            "get",
+            f'{self.host}/{_BASE_PATH}/{_DEVICES_PATH_SEGMENT}',
+        )
+        if response.status == 200:
+            return from_dict(GetDevicesResponse, await response.json())
+        else:
+            raise ApiException("Response failure", response.status)
+
+
+class ApiException(Exception):
+    def __init__(self, message: str, response_code: int):
+        self.message = message
+        self.response_code = response_code
+
+    def __str__(self):
+        return f'ApiException(message={self.message}, response_code={self.response_code})'
+
+
+async def _create_exception(response: aiohttp.ClientResponse) -> ApiException:
+    return ApiException(
+        message=f'Unsuccessful request. code={response.status}, message={await response.text()}',
+        response_code=response.status
+    )

igloohome_api-0.0.3.dist-info/METADATA

@@ -0,0 +1,46 @@
+Metadata-Version: 2.3
+Name: igloohome-api
+Version: 0.0.3
+Summary: A python package for iglooaccess' API
+Project-URL: Homepage, https://github.com/keithle888/igloohome-api
+Project-URL: Issues, https://github.com/keithle888/igloohome-api/issues
+Author-email: keithle888 <keithle888@gmail.com>
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: aiohttp~=3.10.10
+Requires-Dist: dacite~=1.8.1
+Requires-Dist: pyjwt~=2.9.0
+Description-Content-Type: text/markdown
+
+# igloohome-api
+A python HTTP library based on `aiohttp` to make use of [igloohome's REST API](https://igloocompany.stoplight.io/docs/igloohome-api/1w1cuv56ge5xq-overview).
+This library is designed to be used via the [iglooaccess](https://www.igloocompany.co/iglooaccess) service.
+
+## Requirements
+An account on the iglooaccess portal needs to be created to get a `client_id` & `client_secret` for authentication.
+
+## Usage
+
+### Authentication
+```python
+from igloohome_api import Auth
+from aiohttp import ClientSession
+
+session = ClientSession()
+auth = Auth(
+    client_id="<client_id>",
+    client_secret="<client_secret>",
+    session=session,
+)
+```
+
+### API usage
+```python
+frim igloohome_api import Api
+
+api = Api(auth)
+
+devices = await api.get_devices()
+```

igloohome_api-0.0.3.dist-info/RECORD

@@ -0,0 +1,5 @@
+igloohome_api/__init__.py,sha256=ISCm3BWpjnvOujkTleoqMEI_7CQzsUtNDon0R9_MKZk,4593
+igloohome_api-0.0.3.dist-info/METADATA,sha256=BTLpLYNKiJW2oo2TVUnKd3JSviUCMxc997R9cWVqjos,1353
+igloohome_api-0.0.3.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+igloohome_api-0.0.3.dist-info/licenses/LICENSE,sha256=Oz9BF-ql3skRL4OjnpK0WsBlvC1Y4AmKL9Kq_HbELZM,1066
+igloohome_api-0.0.3.dist-info/RECORD,,

igloohome_api-0.0.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.26.3
+Root-Is-Purelib: true
+Tag: py3-none-any

igloohome_api-0.0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Keith Leow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.