flespi-sdk 0.1.0__py3-none-any.whl

flespi_sdk/__init__.py

@@ -0,0 +1,49 @@
+from flespi_sdk.account import Account
+
+
+def main() -> None:
+    print("Hello from plespi!")
+
+
+async def login_with_token(token: str) -> Account:
+    """
+    Login to flespi with token
+    :param token: token
+    :return: Account object
+    """
+    if not token:
+        raise ValueError("Token is required")
+    if not isinstance(token, str):
+        raise ValueError("Token must be a string")
+
+    account = Account()
+    await account.set_token(token)
+    return account
+
+
+async def login_with_realm(
+    realm_public_id: str, realm_username: str, realm_password: str
+):
+    """
+    Login to flespi with realm
+    :param realm_public_id: realm public id
+    :param realm_username: realm username
+    :param realm_password: realm password
+    :return: Account object
+    """
+    if not realm_public_id:
+        raise ValueError("Realm public id is required")
+    if not isinstance(realm_public_id, str):
+        raise ValueError("Realm public id must be a string")
+    if not realm_username:
+        raise ValueError("Realm username is required")
+    if not isinstance(realm_username, str):
+        raise ValueError("Realm username must be a string")
+    if not realm_password:
+        raise ValueError("Realm password is required")
+    if not isinstance(realm_password, str):
+        raise ValueError("Realm password must be a string")
+
+    account = Account()
+    await account.realm_login(realm_public_id, realm_username, realm_password)
+    return account

flespi_sdk/account.py

@@ -0,0 +1,75 @@
+from aiohttp import ClientSession
+
+from flespi_sdk.modules.metadata import Metadata
+from flespi_sdk.modules.mqtt import MQTT
+from flespi_sdk.modules.subaccounts import Subaccounts
+
+
+class Account:
+    def __init__(
+        self, session: ClientSession | None = None, id: int | None = None
+    ) -> None:
+        self.id = id
+        self.session = session or ClientSession("https://flespi.io")
+
+        self._init_modules()
+
+    async def stop(self) -> None:
+        """
+        Close the aiohttp session.
+        """
+        await self.session.close()
+
+    async def set_token(self, token: str) -> None:
+        await self._reset(token)
+
+    async def realm_login(
+        self,
+        realm_public_id: str,
+        realm_username: str,
+        realm_password: str,
+    ) -> None:
+        """
+        Login to a realm and set the Authorization header for subsequent requests.
+        :param realm_public_id: Public ID of the realm.
+        :param realm_username: Username for the realm.
+        :param realm_password: Password for the realm.
+        :raises Exception: If the login fails.
+        """
+        if not realm_public_id or not realm_username or not realm_password:
+            raise ValueError("All parameters are required")
+
+        async with self.session.post(
+            f"/realm/{realm_public_id}/login",
+            json={"username": realm_username, "password": realm_password},
+        ) as response:
+            if response.status != 200:
+                raise Exception("Login failed")
+            response_json = await response.json()
+
+            token = response_json["result"][0]["token"]
+
+            await self._reset(token)
+
+    async def _reset(self, token: str | None = None) -> None:
+        """
+        Reset the account by resetting token and clearing the CID from all subsystems.
+        """
+        async with self.session.get(
+            "/platform/customer", headers=dict(Authorization=f"FlespiToken {token}")
+        ) as response:
+            if response.status != 200:
+                raise Exception("Failed to get account ID: " + str(response.status))
+            response_json = await response.json()
+            result = response_json["result"]
+            id = result[0]["id"]
+            if not id:
+                raise Exception("Failed to get account ID: " + response_json)
+            self.id = id
+            self.session.headers["Authorization"] = f"FlespiToken {token}"
+            self._init_modules()
+
+    def _init_modules(self):
+        self.metadata = Metadata(self.session, self.id)
+        self.subaccounts = Subaccounts(self.session, self.id)
+        self.mqtt = MQTT(self.session, self.id)

flespi_sdk/cli.py

@@ -0,0 +1,46 @@
+import sys
+import argparse
+from flespi_sdk.account import Account
+
+
+async def get_account(prog: str = sys.argv[0]) -> Account:
+    parser = argparse.ArgumentParser(
+        prog=prog,
+        description="CLI for Flespi SDK",
+        epilog=f"Examples:\n  {prog} <token>\n  {prog} <realm> <username> <password>",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+    parser.add_argument(
+        "args",
+        nargs="+",
+        help=(
+            "Arguments for login:\n"
+            "  - Provide 1 argument: <token>\n"
+            "  - Provide 3 arguments: <realm> <username> <password>"
+        ),
+    )
+
+    args = parser.parse_args()
+
+    if len(args.args) == 1:
+        token = args.args[0]
+        account = Account()
+        try:
+            await account.set_token(token)
+        except Exception as e:
+            await account.stop()
+            raise e
+        return account
+    elif len(args.args) == 3:
+        realm, username, password = args.args
+        account = Account()
+        try:
+            await account.realm_login(realm, username, password)
+        except Exception as e:
+            await account.stop()
+            raise e
+        return account
+    else:
+        parser.error(
+            "Invalid number of arguments. Provide 1 argument (token) or 3 arguments (realm, username, password)."
+        )

flespi_sdk/modules/metadata/__init__.py

@@ -0,0 +1,80 @@
+import aiohttp
+
+from flespi_sdk.modules.subsystem import Module
+
+
+class Metadata(Module):
+    def __init__(self, session: aiohttp.ClientSession, cid: int | None = None):
+        super().__init__(session, cid)
+
+    async def get(self) -> dict:
+        """
+        Get metadata for the current account.
+        :return: Metadata as a dictionary.
+        """
+        params = {"fields": "metadata"}
+        async with self.session.get(
+            "platform/customer", params=params, headers=self.get_headers()
+        ) as response:
+            result = await self.get_result(response)
+            return result[0]["metadata"]
+
+    async def set(self, metadata: dict) -> None:
+        """ "
+        "Set metadata for the current account.
+        :param metadata: Metadata as a dictionary.
+        """
+        async with self.session.put(
+            "platform/customer",
+            json={"metadata": metadata},
+            headers=self.get_headers(),
+        ) as response:
+            await self.get_result(response)
+
+    async def get_value(self, key_path: str):
+        """
+        Get a specific value from the metadata.
+        :param key_path: The key path to the value in the metadata.
+        :return: The value from the metadata.
+        """
+        metadata = await self.get()
+        keys = key_path.split(".")
+        value = metadata
+        for key in keys:
+            if key in value:
+                value = value[key]
+            else:
+                return None
+        return value
+
+    async def set_value(self, key_path: str, value) -> None:
+        """
+        Set a specific value in the metadata.
+        :param key_path: The key path to the value in the metadata.
+        :param value: The value to set.
+        """
+        metadata = await self.get()
+        keys = key_path.split(".")
+        d = metadata
+        for key in keys[:-1]:
+            if key not in d:
+                d[key] = {}
+            d = d[key]
+        d[keys[-1]] = value
+        await self.set(metadata)
+
+    async def delete_value(self, key_path: str) -> None:
+        """
+        Delete a specific key from the metadata.
+        :param key_path: The key path to the value in the metadata.
+        """
+        metadata = await self.get()
+        keys = key_path.split(".")
+        value = metadata
+        for key in keys[:-1]:
+            if key in value:
+                value = value[key]
+            else:
+                return None
+        del value[keys[-1]]
+        await self.set(metadata)

flespi_sdk/modules/mqtt/__init__.py

@@ -0,0 +1,77 @@
+import urllib.parse
+
+import aiohttp
+from flespi_sdk.modules.subsystem import Module
+
+
+class MQTT(Module):
+    def __init__(self, session: aiohttp.ClientSession, cid: int | None = None):
+        super().__init__(session, cid)
+
+    async def list(self, topic: str):
+        """
+        Get messages from the specified MQTT topic.
+        :param topic: The MQTT topic to get messages from.
+        :return: List of messages from the specified topic.
+        """
+        params = {"fields": "cid,topic,payload,user_properties"}
+        async with self.session.get(
+            f"/mqtt/messages/{urllib.parse.quote_plus(topic)}",
+            params=params,
+            headers=self.get_headers(),
+        ) as response:
+            result = await self.get_result(response)
+            direct_messages = [msg for msg in result if msg["cid"] == self.cid]
+            for msg in direct_messages:
+                del msg["cid"]
+            return direct_messages
+
+    async def get(self, topic: str):
+        """
+        Get a specific message from the specified MQTT topic.
+        :param topic: The MQTT topic to get the message from.
+        :return: The message from the specified topic.
+        """
+        msgs = await self.list(topic)
+        if len(msgs) > 1:
+            raise ValueError(
+                f"Multiple messages found for topic '{topic}'. Use list() to get all messages."
+            )
+        elif len(msgs) == 0:
+            raise ValueError(f"No messages found for topic '{topic}'.")
+        else:
+            return msgs[0]
+
+    async def publish(
+        self, topic: str, payload: str | None = None, retained: bool = False
+    ):
+        """
+         Publish a message to the specified MQTT topic.
+        :param topic: The MQTT topic to publish the message to.
+        :param payload: The message payload.
+        :param retained: Whether the message should be retained.
+        """
+        message = {
+            "topic": topic,
+            "retained": retained,
+            "payload": payload,
+        }
+        async with self.session.post(
+            "/mqtt/messages",
+            json=message,
+            headers=self.get_headers(),
+        ) as response:
+            result = await self.get_result(response)
+            return result
+
+    async def delete(self, topic: str):
+        """
+        Delete a message from the specified MQTT topic.
+        :param topic: The MQTT topic to delete the message from.
+        """
+        async with self.session.delete(
+            f"/mqtt/messages/{urllib.parse.quote_plus(topic)}",
+            headers=self.get_headers(),
+        ) as response:
+            result = await self.get_result(response)
+            return result

flespi_sdk/modules/subaccounts/__init__.py

@@ -0,0 +1,31 @@
+import aiohttp
+
+from flespi_sdk.modules.subsystem import Module
+
+
+class Subaccounts(Module):
+    def __init__(self, session: aiohttp.ClientSession, cid: int | None = None):
+        super().__init__(session, cid)
+
+    async def get_by_id(self, id: str):
+        from flespi_sdk.account import Account
+
+        async with self.session.get(
+            f"/platform/subaccounts/{id},cid={self.cid}", headers=self.get_headers()
+        ) as response:
+            result = await self.get_result(response)
+            subacc = result[0]
+            return Account(
+                self.session,
+                id=subacc["id"],
+            )
+
+    async def list(self, selector: str = "all"):
+        from flespi_sdk.account import Account
+
+        async with self.session.get(
+            f"/platform/subaccounts/{selector},cid={self.cid}",
+            headers=self.get_headers(),
+        ) as response:
+            result = await self.get_result(response)
+            return [Account(self.session, id=subacc["id"]) for subacc in result]

flespi_sdk/modules/subsystem.py

@@ -0,0 +1,22 @@
+from aiohttp import ClientSession
+
+
+class Module:
+    def __init__(self, session: ClientSession, cid: int | None = None):
+        self.cid = cid
+        self.session = session
+
+    def reset(self, cid: int):
+        self.cid = cid
+
+    def get_headers(self):
+        if self.cid:
+            return {"X-Flespi-CID": str(self.cid)}
+        raise ValueError("CID is not set. Please set the CID before using this method.")
+
+    async def get_result(self, response):
+        if response.status != 200:
+            raise Exception("Status code: " + str(response.status))
+        response_json = await response.json()
+        result = response_json["result"]
+        return result

flespi_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: flespi-sdk
+Version: 0.1.0
+Summary: Add your description here
+Author-email: Sergey Shevchik <sergey.shevchik@gmail.com>
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.11.15

flespi_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+flespi_sdk/__init__.py,sha256=INx-TmKYpKi9SC0-UMqtqKwnMnHK88oXyvh3tTFY668,1462
+flespi_sdk/account.py,sha256=mnFLKR204ln09UIRXGQcGf0tURK5wgWg8mlo8vN3o3w,2656
+flespi_sdk/cli.py,sha256=6OcRQAu-LLFTYGGY_S0SNTXgHlazr3NaMDqPQ7QLg_E,1346
+flespi_sdk/modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+flespi_sdk/modules/subsystem.py,sha256=6ZKVL-ZtqbA_n1tbuzStu3EV7WYtZepWtuF7G_yIqEA,675
+flespi_sdk/modules/metadata/__init__.py,sha256=SVj_OogLsLEOwOS2snP3iW03NmENe8sIW1MbeKK5iTo,2501
+flespi_sdk/modules/mqtt/__init__.py,sha256=jiN4RniDru1YJF_EMHSIIjUgDsboeJc730ktu7P7a8E,2695
+flespi_sdk/modules/subaccounts/__init__.py,sha256=OElPCprLOqV1hZ-evBi-sWp_KNTnUImdgLXqVvsO2No,1031
+flespi_sdk-0.1.0.dist-info/METADATA,sha256=VJJ7knUJZZQe2gp5oLLUqLoPdN0YcNQGWH6zTliftEM,203
+flespi_sdk-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+flespi_sdk-0.1.0.dist-info/RECORD,,

flespi_sdk-0.1.0.dist-info/WHEEL

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