http: api: implement basic blueprints support

Author: rnovatorov

src/enapter/cli/http/api/blueprint_command.py

@@ -0,0 +1,31 @@
+import argparse
+
+from enapter import cli
+
+from .blueprint_download_command import BlueprintDownloadCommand
+from .blueprint_upload_command import BlueprintUploadCommand
+
+
+class BlueprintCommand(cli.Command):
+
+    @staticmethod
+    def register(parent: cli.Subparsers) -> None:
+        parser = parent.add_parser(
+            "blueprint", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        subparsers = parser.add_subparsers(dest="blueprint_command", required=True)
+        for command in [
+            BlueprintDownloadCommand,
+            BlueprintUploadCommand,
+        ]:
+            command.register(subparsers)
+
+    @staticmethod
+    async def run(args: argparse.Namespace) -> None:
+        match args.blueprint_command:
+            case "download":
+                await BlueprintDownloadCommand.run(args)
+            case "upload":
+                await BlueprintUploadCommand.run(args)
+            case _:
+                raise NotImplementedError(args.command_command)

src/enapter/cli/http/api/blueprint_download_command.py

@@ -0,0 +1,36 @@
+import argparse
+import logging
+import pathlib
+
+from enapter import cli, http
+
+LOGGER = logging.getLogger(__name__)
+
+
+class BlueprintDownloadCommand(cli.Command):
+
+    @staticmethod
+    def register(parent: cli.Subparsers) -> None:
+        parser = parent.add_parser(
+            "download", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        parser.add_argument("id", help="ID of the blueprint to download")
+        parser.add_argument(
+            "-o", "--output", type=pathlib.Path, help="Output file path", required=True
+        )
+        parser.add_argument(
+            "-v",
+            "--view",
+            choices=["original", "compiled"],
+            default="original",
+            help="Blueprint view type",
+        )
+
+    @staticmethod
+    async def run(args: argparse.Namespace) -> None:
+        async with http.api.Client(http.api.Config.from_env()) as client:
+            content = await client.blueprints.download(
+                args.id, view=http.api.blueprints.BlueprintView(args.view.upper())
+            )
+            with open(args.output, "wb") as f:
+                f.write(content)

src/enapter/cli/http/api/blueprint_upload_command.py

@@ -0,0 +1,29 @@
+import argparse
+import json
+import logging
+import pathlib
+
+from enapter import cli, http
+
+LOGGER = logging.getLogger(__name__)
+
+
+class BlueprintUploadCommand(cli.Command):
+
+    @staticmethod
+    def register(parent: cli.Subparsers) -> None:
+        parser = parent.add_parser(
+            "upload", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        parser.add_argument(
+            "path", type=pathlib.Path, help="Path to a directory or a zip file"
+        )
+
+    @staticmethod
+    async def run(args: argparse.Namespace) -> None:
+        async with http.api.Client(http.api.Config.from_env()) as client:
+            if args.path.is_dir():
+                blueprint = await client.blueprints.upload_directory(args.path)
+            else:
+                blueprint = await client.blueprints.upload_file(args.path)
+            print(json.dumps(blueprint.to_dto()))

src/enapter/cli/http/api/command.py

@@ -2,6 +2,7 @@
 
 from enapter import cli
 
+from .blueprint_command import BlueprintCommand
 from .device_command import DeviceCommand
 from .site_command import SiteCommand
 
@@ -15,6 +16,7 @@ def register(parent: cli.Subparsers) -> None:
         )
         subparsers = parser.add_subparsers(dest="api_command", required=True)
         for command in [
+            BlueprintCommand,
             DeviceCommand,
             SiteCommand,
         ]:
@@ -23,6 +25,8 @@ def register(parent: cli.Subparsers) -> None:
     @staticmethod
     async def run(args: argparse.Namespace) -> None:
         match args.api_command:
+            case "blueprint":
+                await BlueprintCommand.run(args)
             case "device":
                 await DeviceCommand.run(args)
             case "site":

src/enapter/http/api/__init__.py

@@ -2,6 +2,15 @@
 from .config import Config
 from .errors import Error, MultiError, check_error
 
-from . import devices, sites  # isort: skip
+from . import devices, sites, blueprints  # isort: skip
 
-__all__ = ["Client", "Config", "devices", "sites", "Error", "MultiError", "check_error"]
+__all__ = [
+    "Client",
+    "Config",
+    "devices",
+    "blueprints",
+    "sites",
+    "Error",
+    "MultiError",
+    "check_error",
+]

src/enapter/http/api/blueprints/__init__.py

@@ -0,0 +1,8 @@
+from .blueprint import Blueprint, BlueprintView
+from .client import Client
+
+__all__ = [
+    "Client",
+    "Blueprint",
+    "BlueprintView",
+]

src/enapter/http/api/blueprints/blueprint.py

@@ -0,0 +1,30 @@
+import dataclasses
+import datetime
+import enum
+from typing import Any, Self
+
+
+class BlueprintView(enum.Enum):
+
+    ORIGINAL = "ORIGINAL"
+    COMPILED = "COMPILED"
+
+
+@dataclasses.dataclass
+class Blueprint:
+
+    id: str
+    created_at: datetime.datetime
+
+    @classmethod
+    def from_dto(cls, dto: dict[str, Any]) -> Self:
+        return cls(
+            id=dto["id"],
+            created_at=datetime.datetime.fromisoformat(dto["created_at"]),
+        )
+
+    def to_dto(self) -> dict[str, Any]:
+        return {
+            "id": self.id,
+            "created_at": self.created_at.isoformat(),
+        }

src/enapter/http/api/blueprints/client.py

@@ -0,0 +1,41 @@
+import io
+import pathlib
+import zipfile
+
+import httpx
+
+from enapter.http import api
+
+from .blueprint import Blueprint, BlueprintView
+
+
+class Client:
+
+    def __init__(self, client: httpx.AsyncClient) -> None:
+        self._client = client
+
+    async def upload_file(self, path: pathlib.Path) -> Blueprint:
+        with path.open("rb") as file:
+            data = file.read()
+        return await self.upload(data)
+
+    async def upload_directory(self, path: pathlib.Path) -> Blueprint:
+        buffer = io.BytesIO()
+        with zipfile.ZipFile(buffer, "w", zipfile.ZIP_DEFLATED) as zip_file:
+            for file_path in path.rglob("*"):
+                zip_file.write(file_path, arcname=file_path.relative_to(path))
+        return await self.upload(buffer.getvalue())
+
+    async def upload(self, data: bytes) -> Blueprint:
+        url = "v3/blueprints/upload"
+        response = await self._client.post(url, content=data)
+        api.check_error(response)
+        return Blueprint.from_dto(response.json()["blueprint"])
+
+    async def download(
+        self, blueprint_id: str, view: BlueprintView = BlueprintView.ORIGINAL
+    ) -> bytes:
+        url = f"v3/blueprints/{blueprint_id}/zip"
+        response = await self._client.get(url, params={"view": view.value})
+        api.check_error(response)
+        return response.content

src/enapter/http/api/client.py

@@ -2,7 +2,7 @@
 
 import httpx
 
-from enapter.http.api import devices, sites
+from enapter.http.api import blueprints, devices, sites
 
 from .config import Config
 
@@ -37,3 +37,7 @@ def devices(self) -> devices.Client:
     @property
     def sites(self) -> sites.Client:
         return sites.Client(client=self._client)
+
+    @property
+    def blueprints(self) -> blueprints.Client:
+        return blueprints.Client(client=self._client)