saviialib 0.9.1__py3-none-any.whl → 1.6.0__py3-none-any.whl

saviialib/__init__.py

@@ -3,7 +3,77 @@ from importlib.metadata import version
 
 __version__ = version("saviialib")
 
-from .services.epii.api import EpiiAPI
-from .general_types.api.epii_api_types import EpiiAPIConfig
+from .general_types.api.saviia_api_types import SaviiaAPIConfig
 
-__all__ = ["EpiiAPI", "EpiiAPIConfig"]
+from typing import Dict, Type, Any, overload, Literal, List
+
+from saviialib.services.backup.api import SaviiaBackupAPI
+from saviialib.services.thies.api import SaviiaThiesAPI
+from saviialib.general_types.api.saviia_thies_api_types import SaviiaThiesConfig
+from saviialib.general_types.api.saviia_backup_api_types import SaviiaBackupConfig
+
+__all__ = ["SaviiaAPI", "SaviiaAPIConfig"]
+
+
+class SaviiaAPI:
+    API_REGISTRY: Dict[str, Type] = {
+        "thies": SaviiaThiesAPI,
+        "backup": SaviiaBackupAPI,
+    }
+
+    @overload
+    def get(self, name: Literal["thies"]) -> SaviiaThiesAPI: ...
+    @overload
+    def get(self, name: Literal["backup"]) -> SaviiaBackupAPI: ...
+
+    def __init__(self, config: SaviiaAPIConfig):
+        """
+        Receive a dictionary of configurations, with the same key
+        as those registered in API_REGISTRY.
+
+        :params configs: Dictionary of configurations for each API.
+
+        Example:
+            configs = {
+                "thies": SaviiaThiesConfig(...),
+                "backup": SaviiaBackupConfig(...)
+            }
+        """
+        self._instances: Dict[str, Any] = {}
+
+        for name, api_class in SaviiaAPI.API_REGISTRY.items():
+            if name == "thies":
+                service_config = SaviiaThiesConfig(
+                    ftp_host=config.ftp_host,
+                    ftp_port=config.ftp_port,
+                    ftp_user=config.ftp_user,
+                    ftp_password=config.ftp_password,
+                    sharepoint_client_id=config.sharepoint_client_id,
+                    sharepoint_client_secret=config.sharepoint_client_secret,
+                    sharepoint_tenant_id=config.sharepoint_tenant_id,
+                    sharepoint_tenant_name=config.sharepoint_tenant_name,
+                    sharepoint_site_name=config.sharepoint_site_name,
+                    logger=config.logger,
+                )
+            elif name == "backup":
+                service_config = SaviiaBackupConfig(
+                    sharepoint_client_id=config.sharepoint_client_id,
+                    sharepoint_client_secret=config.sharepoint_client_secret,
+                    sharepoint_tenant_id=config.sharepoint_tenant_id,
+                    sharepoint_tenant_name=config.sharepoint_tenant_name,
+                    sharepoint_site_name=config.sharepoint_site_name,
+                    logger=config.logger,
+                )
+
+            self._instances[name] = api_class(service_config)
+
+    def get(self, name: Literal["thies", "backup"]) -> Any:
+        """Returns the API instance associated with the given name."""
+        try:
+            return self._instances[name]
+        except KeyError:
+            raise ValueError(f"API '{name}' is not registered or not configured.")
+
+    def list_available(self) -> List[str]:
+        """List of available registered APIs."""
+        return list(self._instances.keys())

saviialib/general_types/api/__init__.py

@@ -1,3 +0,0 @@
-from .epii_api_types import EpiiUpdateThiesConfig, EpiiSharepointBackupConfig
-
-__all__ = ["EpiiUpdateThiesConfig", "EpiiSharepointBackupConfig"]

saviialib/general_types/api/{epii_api_types.py → saviia_api_types.py}

@@ -1,10 +1,11 @@
 from dataclasses import dataclass
+from logging import Logger
 
 
 @dataclass
-class EpiiAPIConfig:
+class SaviiaAPIConfig:
     """
-    Configuration for Epii API.
+    Configuration for SAVIIA API.
 
     Attributes:
         ftp_port (int): Port number of the FTP server.
@@ -27,6 +28,7 @@ class EpiiAPIConfig:
     sharepoint_tenant_id: str
     sharepoint_tenant_name: str
     sharepoint_site_name: str
+    logger: Logger
 
 
 @dataclass
@@ -44,39 +46,3 @@ class SharepointConfig:
     sharepoint_tenant_id: str
     sharepoint_tenant_name: str
     sharepoint_site_name: str
-
-
-@dataclass
-class EpiiUpdateThiesConfig:
-    ftp_port: int
-    ftp_host: str
-    ftp_user: str
-    ftp_password: str
-    sharepoint_client_id: str
-    sharepoint_client_secret: str
-    sharepoint_tenant_id: str
-    sharepoint_tenant_name: str
-    sharepoint_site_name: str
-
-
-@dataclass
-class EpiiSharepointBackupConfig:
-    """
-    Configuration for backing up files to SharePoint.
-
-    Attributes:
-        sharepoint_client_id (str): Client ID for SharePoint authentication.
-        sharepoint_client_secret (str): Client secret for SharePoint authentication.
-        sharepoint_tenant_id (str): Tenant ID for SharePoint authentication.
-        sharepoint_tenant_name (str): Tenant name for SharePoint.
-        sharepoint_site_name (str): Site name in SharePoint.
-        local_backup_source_path (str): Local path to backup.
-    """
-
-    sharepoint_client_id: str
-    sharepoint_client_secret: str
-    sharepoint_tenant_id: str
-    sharepoint_tenant_name: str
-    sharepoint_site_name: str
-    local_backup_source_path: str
-    destination_folders: str

saviialib/general_types/api/saviia_backup_api_types.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass
+from logging import Logger
+
+
+@dataclass
+class SaviiaBackupConfig:
+    """
+    Configuration for backing up files to SharePoint.
+
+    Attributes:
+        sharepoint_client_id (str): Client ID for SharePoint authentication.
+        sharepoint_client_secret (str): Client secret for SharePoint authentication.
+        sharepoint_tenant_id (str): Tenant ID for SharePoint authentication.
+        sharepoint_tenant_name (str): Tenant name for SharePoint.
+        sharepoint_site_name (str): Site name in SharePoint.
+        local_backup_source_path (str): Local path to backup.
+    """
+
+    sharepoint_client_id: str
+    sharepoint_client_secret: str
+    sharepoint_tenant_id: str
+    sharepoint_tenant_name: str
+    sharepoint_site_name: str
+    logger: Logger

saviialib/general_types/api/saviia_netcamera_api_types.py

@@ -0,0 +1,11 @@
+from dataclasses import dataclass
+from logging import Logger
+
+
+@dataclass
+class SaviiaNetcameraConfig:
+    username: str
+    password: str
+    protocol: str
+    logger: Logger
+    destination_path: str = "/"

saviialib/general_types/api/saviia_shakes_api_types.py

@@ -0,0 +1,21 @@
+from dataclasses import dataclass
+from logging import Logger
+
+
+@dataclass
+class SaviiaShakesConfig:
+    """
+    Configuration for Raspberry shakes activities as Miniseed extraction, photo record and video record.
+
+    Attributes:
+        sftp_user (str): Username for SFTP Client connection
+        sftp_password (str): Password for SFTP Client connection
+        sftp_port (str): SFTP Server Port. Default port is 22.
+        ssh_key_path (str): Path to the SSH Private key for client-side authentication.
+    """
+
+    sftp_user: str
+    sftp_password: str
+    ssh_key_path: str
+    logger: Logger
+    sftp_port: int = 22

saviialib/general_types/api/saviia_thies_api_types.py

@@ -0,0 +1,31 @@
+from dataclasses import dataclass
+from logging import Logger
+
+
+@dataclass
+class SaviiaThiesConfig:
+    """
+    Configuration for Saviia Thies.
+
+    Attributes:
+        ftp_port (int): Port number of the FTP server.
+        ftp_host (str): Hostname or IP address of the FTP server.
+        ftp_user (str): Username for the FTP server.
+        ftp_password (str): Password for the FTP server.
+        sharepoint_client_id (str): Client ID for SharePoint authentication.
+        sharepoint_client_secret (str): Client secret for SharePoint authentication.
+        sharepoint_tenant_id (str): Tenant ID for SharePoint authentication.
+        sharepoint_tenant_name (str): Tenant name for SharePoint.
+        sharepoint_site_name (str): Site name in SharePoint.
+    """
+
+    ftp_host: str
+    ftp_port: int
+    ftp_user: str
+    ftp_password: str
+    sharepoint_client_id: str
+    sharepoint_client_secret: str
+    sharepoint_tenant_id: str
+    sharepoint_tenant_name: str
+    sharepoint_site_name: str
+    logger: Logger

saviialib/general_types/error_types/api/{epii_api_error_types.py → saviia_api_error_types.py}

@@ -43,6 +43,18 @@ class SharePointFetchingError(Exception):
             return self.reason.__str__()
 
 
+class SharePointDirectoryError(Exception):
+    def __init__(self, *args, reason):
+        super().__init__(*args, reason)
+        self.reason = reason
+
+    def __str__(self):
+        return (
+            "An error occurred while fetching the folders from Microsoft SharePoint. "
+            + self.reason.__str__()
+        )
+
+
 class SharePointUploadError(Exception):
     """Raised when there is an error uploading files to the Microsoft SharePoint folder."""
 
@@ -91,3 +103,11 @@ class BackupEmptyError(Exception):
 
     def __str__(self):
         return "The local backup folder is empty. "
+
+
+class ShakesNoContentError(Exception):
+    def __init__(self, *args):
+        super().__init__(*args)
+
+    def __str__(self):
+        return "All the miniSEED files have been downloaded and are in the local directory."

saviialib/general_types/error_types/api/saviia_netcamera_error_types.py

@@ -0,0 +1,7 @@
+class NetcameraConnectionError(Exception):
+    def __init__(self, *args, reason):
+        super().__init__(*args, reason)
+        self.reason = reason
+
+    def __str__(self):
+        return "Netcamera Connection failed. " + self.reason.__str__()

saviialib/general_types/error_types/common/common_types.py

@@ -15,3 +15,12 @@ class SharepointClientError(Exception):
 class FtpClientError(Exception):
     def __str__(self):
         return "Ftp Client initialization fails."
+
+
+class SftpClientError(Exception):
+    def __init__(self, *args, reason):
+        super().__init__(*args, reason)
+        self.reason = reason
+
+    def __str__(self):
+        return "SFTP Client initialization fails." + self.reason.__str__()

saviialib/libs/directory_client/__init__.py

@@ -0,0 +1,4 @@
+from .directory_client import DirectoryClient
+from .types.directory_client_types import DirectoryClientArgs
+
+__all__ = ["DirectoryClient", "DirectoryClientArgs"]

saviialib/libs/directory_client/client/os_client.py

@@ -0,0 +1,55 @@
+from saviialib.libs.directory_client.directory_client_contract import (
+    DirectoryClientContract,
+)
+import os
+import asyncio
+
+
+class OsClient(DirectoryClientContract):
+    @staticmethod
+    def join_paths(*paths: str) -> str:
+        return os.path.join(*paths)
+
+    @staticmethod
+    async def path_exists(path: str) -> bool:
+        return await asyncio.to_thread(os.path.exists, path)
+
+    @staticmethod
+    async def listdir(path: str, more_info: bool = False) -> list:
+        def _listdir_with_size(path):
+            items = []
+            for name in os.listdir(path):
+                full_path = os.path.join(path, name)
+                is_dir = os.path.isdir(full_path)
+                size = os.stat(full_path).st_size if not is_dir else 0
+                items.append((name, size))
+            return items
+
+        if more_info:
+            return await asyncio.to_thread(_listdir_with_size, path)
+        return await asyncio.to_thread(os.listdir, path)
+
+    @staticmethod
+    async def isdir(path: str) -> bool:
+        return await asyncio.to_thread(os.path.isdir, path)
+
+    @staticmethod
+    async def makedirs(path: str) -> None:
+        return await asyncio.to_thread(os.makedirs, path, exist_ok=True)
+
+    @staticmethod
+    async def remove_file(path: str) -> None:
+        if await asyncio.to_thread(os.path.exists, path):
+            await asyncio.to_thread(os.remove, path)
+
+    @staticmethod
+    async def walk(path: str):
+        return await asyncio.to_thread(os.walk, path)
+
+    @staticmethod
+    def relative_path(full_path: str, base_folder: str):
+        return os.path.relpath(full_path, base_folder)
+
+    @staticmethod
+    def get_basename(path: str):
+        return os.path.basename(path)

saviialib/libs/directory_client/directory_client.py

@@ -0,0 +1,44 @@
+from .client.os_client import OsClient
+from .directory_client_contract import DirectoryClientContract
+from .types.directory_client_types import DirectoryClientArgs
+from typing import Iterator
+
+
+class DirectoryClient(DirectoryClientContract):
+    CLIENTS = {"os_client"}
+
+    def __init__(self, args: DirectoryClientArgs) -> None:
+        if args.client_name not in DirectoryClient.CLIENTS:
+            msg = f"Unsupported client {args.client_name}"
+            raise KeyError(msg)
+
+        if args.client_name == "os_client":
+            self.client_obj = OsClient()
+        self.client_name = args.client_name
+
+    def join_paths(self, *paths: str) -> str:
+        return self.client_obj.join_paths(*paths)
+
+    async def path_exists(self, path: str) -> bool:
+        return await self.client_obj.path_exists(path)
+
+    async def listdir(self, path: str, more_info: bool = False) -> list:
+        return await self.client_obj.listdir(path, more_info)
+
+    async def isdir(self, path: str) -> bool:
+        return await self.client_obj.isdir(path)
+
+    async def makedirs(self, path: str) -> None:
+        return await self.client_obj.makedirs(path)
+
+    async def remove_file(self, path: str) -> None:
+        return await self.client_obj.remove_file(path)
+
+    async def walk(self, path: str) -> Iterator:
+        return await self.client_obj.walk(path)
+
+    def relative_path(self, full_path: str, base_folder: str):
+        return self.client_obj.relative_path(full_path, base_folder)
+
+    def get_basename(self, path: str):
+        return self.client_obj.get_basename(path)

saviialib/libs/directory_client/directory_client_contract.py

@@ -0,0 +1,40 @@
+from abc import ABC, abstractmethod
+from typing import Iterator
+
+
+class DirectoryClientContract(ABC):
+    @abstractmethod
+    def join_paths(self, *paths: str) -> str:
+        pass
+
+    @abstractmethod
+    async def path_exists(self, path: str) -> bool:
+        pass
+
+    @abstractmethod
+    async def listdir(self, path: str, more_info: bool = False) -> list:
+        pass
+
+    @abstractmethod
+    async def isdir(self, path) -> bool:
+        pass
+
+    @abstractmethod
+    async def makedirs(self, path: str) -> None:
+        pass
+
+    @abstractmethod
+    async def remove_file(self, path: str) -> None:
+        pass
+
+    @abstractmethod
+    async def walk(self, path: str) -> Iterator:
+        pass
+
+    @abstractmethod
+    def relative_path(self, full_path: str, base_folder: str):
+        pass
+
+    @abstractmethod
+    def get_basename(self, path: str):
+        pass

saviialib/libs/directory_client/types/directory_client_types.py

@@ -0,0 +1,6 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class DirectoryClientArgs:
+    client_name: str = "os_client"

saviialib/libs/ffmpeg_client/__init__.py

@@ -0,0 +1,8 @@
+from .ffmpeg_client import (
+    FfmpegClient,
+    FfmpegClientInitArgs,
+    RecordPhotoArgs,
+    RecordVideoArgs,
+)
+
+__all__ = ["FfmpegClient", "FfmpegClientInitArgs", "RecordPhotoArgs", "RecordVideoArgs"]

saviialib/libs/ffmpeg_client/clients/ffmpeg_asyncio_client.py

@@ -0,0 +1,101 @@
+from saviialib.libs.ffmpeg_client.types.ffmpeg_client_types import (
+    FfmpegClientInitArgs,
+    RecordPhotoArgs,
+    RecordVideoArgs,
+)
+from saviialib.libs.ffmpeg_client.ffmpeg_client_contract import FfmpegClientContract
+from typing import List
+import asyncio
+import shutil
+
+from saviialib.libs.directory_client import DirectoryClient, DirectoryClientArgs
+from saviialib.libs.zero_dependency.utils.datetime_utils import today, datetime_to_str
+
+
+class FfmpegAsyncioClient(FfmpegClientContract):
+    def __init__(self, args: FfmpegClientInitArgs) -> None:
+        self.dir_client = DirectoryClient(DirectoryClientArgs("os_client"))
+
+    def _setup_io_args(
+        self,
+        rtsp_user: str,
+        rtsp_pwd: str,
+        ip: str,
+        dest_path: str,
+        record_prefix: str,
+        record_type: str,
+    ):
+        input_arg = f"rtsp://{rtsp_user}:{rtsp_pwd}@{ip}/stream1"
+        output_file = (
+            record_prefix
+            + "_"
+            + datetime_to_str(today(), date_format="%m-%d-%Y_%H-%M-%S")
+            + f".{record_type}"
+        )
+        output_arg = self.dir_client.join_paths(dest_path, output_file)
+        return input_arg, output_arg
+
+    async def _ensure_ffmpeg_available(self):
+        if shutil.which("ffmpeg"):
+            return
+        install_cmd = ["apk", "add", "ffmpeg"]  # Only for Home Assistant OS
+        process = await asyncio.create_subprocess_shell(
+            *install_cmd,
+            stdout=asyncio.subprocess.DEVNULL,
+            stdin=asyncio.subprocess.PIPE,
+        )
+        _, stderr = await process.communicate()
+        if process.returncode != 0:
+            raise ConnectionAbortedError("Failed to install ffmpeg: ", stderr.decode())
+
+    async def _setup_command(
+        self, input_arg: str, output_arg: str, extra: dict
+    ) -> List[str]:
+        await self._ensure_ffmpeg_available()  # Validate ffmpeg module is installed.
+        cmd = ["ffmpeg", "-y", "-i", input_arg, output_arg]
+        for k, v in extra.values():
+            cmd.insert(-1, k)
+            cmd.insert(-1, v)
+        return list(map(str, cmd))
+
+    async def record_video(self, args: RecordVideoArgs):
+        input_arg, output_arg = self._setup_io_args(
+            args.rtsp_user,
+            args.rtsp_password,
+            args.ip_address,
+            args.destination_path,
+            "Video",
+            args.extension,
+        )
+        cmd = await self._setup_command(
+            input_arg, output_arg, extra={"-t": args.duration}
+        )
+        process = await asyncio.create_subprocess_exec(
+            *cmd, stderr=asyncio.subprocess.PIPE, stdout=asyncio.subprocess.PIPE
+        )
+        _, stderr = await process.communicate()
+        if process.returncode != 0:
+            raise ConnectionError(
+                "Unexpected error while recording the video: ", stderr.decode()
+            )
+
+    async def record_photo(self, args: RecordPhotoArgs):
+        input_arg, output_arg = self._setup_io_args(
+            args.rtsp_user,
+            args.rtsp_password,
+            args.ip_address,
+            args.destination_path,
+            "Photo",
+            args.extension,
+        )
+        cmd = await self._setup_command(
+            input_arg, output_arg, extra={"-frames:v": args.frames}
+        )
+        process = await asyncio.create_subprocess_exec(
+            *cmd, stderr=asyncio.subprocess.PIPE, stdout=asyncio.subprocess.PIPE
+        )
+        _, stderr = await process.communicate()
+        if process.returncode != 0:
+            raise ConnectionError(
+                "Unexpected error while recording the photo: ", stderr.decode()
+            )

saviialib/libs/ffmpeg_client/ffmpeg_client.py

@@ -0,0 +1,25 @@
+from .ffmpeg_client_contract import FfmpegClientContract
+from .types.ffmpeg_client_types import (
+    RecordPhotoArgs,
+    RecordVideoArgs,
+    FfmpegClientInitArgs,
+)
+from .clients.ffmpeg_asyncio_client import FfmpegAsyncioClient
+
+
+class FfmpegClient(FfmpegClientContract):
+    CLIENTS = {"ffmpeg_asyncio"}
+
+    def __init__(self, args: FfmpegClientInitArgs) -> None:
+        if args.client_name not in FfmpegClient.CLIENTS:
+            msg = f"Unsupported client {args.client_name}"
+            raise KeyError(msg)
+        if args.client_name == "ffmpeg_asyncio":
+            self.client_obj = FfmpegAsyncioClient(args)
+        self.client_name = args.client_name
+
+    def record_photo(self, args: RecordPhotoArgs):
+        return self.client_obj.record_photo(args)
+
+    def record_video(self, args: RecordVideoArgs):
+        return self.client_obj.record_video(args)

saviialib/libs/ffmpeg_client/ffmpeg_client_contract.py

@@ -0,0 +1,12 @@
+from abc import ABC, abstractmethod
+from .types.ffmpeg_client_types import RecordPhotoArgs, RecordVideoArgs
+
+
+class FfmpegClientContract(ABC):
+    @abstractmethod
+    async def record_photo(self, args: RecordPhotoArgs):
+        pass
+
+    @abstractmethod
+    async def record_video(self, args: RecordVideoArgs):
+        pass

saviialib/libs/ffmpeg_client/types/ffmpeg_client_types.py

@@ -0,0 +1,28 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class FfmpegClientInitArgs:
+    client_name: str
+
+
+@dataclass
+class RecordPhotoArgs:
+    ip_address: str
+    destination_path: str
+    rtsp_user: str
+    rtsp_password: str
+    port: str
+    extension: str
+    frames: int
+
+
+@dataclass
+class RecordVideoArgs:
+    destination_path: str
+    ip_address: str
+    port: str
+    rtsp_user: str
+    rtsp_password: str
+    extension: str
+    duration: int

saviialib/libs/files_client/__init__.py

@@ -1,4 +1,4 @@
 from .files_client import FilesClient
-from .types.files_client_types import FilesClientInitArgs, ReadArgs
+from .types.files_client_types import FilesClientInitArgs, ReadArgs, WriteArgs
 
-__all__ = ["FilesClient", "FilesClientInitArgs", "ReadArgs"]
+__all__ = ["FilesClient", "FilesClientInitArgs", "ReadArgs", "WriteArgs"]