saviialib 1.6.1__py3-none-any.whl

saviialib/__init__.py

@@ -0,0 +1,79 @@
+# read version from installed package
+from importlib.metadata import version
+
+__version__ = version("saviialib")
+
+from .general_types.api.saviia_api_types import SaviiaAPIConfig
+
+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/saviia_api_types.py

@@ -0,0 +1,48 @@
+from dataclasses import dataclass
+from logging import Logger
+
+
+@dataclass
+class SaviiaAPIConfig:
+    """
+    Configuration for SAVIIA API.
+
+    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
+
+
+@dataclass
+class FtpClientConfig:
+    ftp_host: str
+    ftp_port: int
+    ftp_user: str
+    ftp_password: str
+
+
+@dataclass
+class SharepointConfig:
+    sharepoint_client_id: str
+    sharepoint_client_secret: str
+    sharepoint_tenant_id: str
+    sharepoint_tenant_name: str
+    sharepoint_site_name: 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/saviia_api_error_types.py

@@ -0,0 +1,113 @@
+import json
+
+
+class ThiesConnectionError(Exception):
+    """Raised when unable to connect to the THIES FTP Server"""
+
+    def __init__(self, *args, reason):
+        super().__init__(*args, reason)
+        self.reason = reason
+
+    def __str__(self):
+        return "Unable to connect to THIES FTP Server. " + self.reason.__str__()
+
+
+class ThiesFetchingError(Exception):
+    """Raised when no files are found to upload to the server."""
+
+    def __init__(self, *args, reason):
+        super().__init__(*args, reason)
+        self.reason = reason
+
+    def __str__(self):
+        return (
+            "An error ocurred while retrieving files from THIES FTP Server. "
+            + self.reason.__str__()
+        )
+
+
+class SharePointFetchingError(Exception):
+    """Raised when there is an error fetching file names from the RCER cloud."""
+
+    def __init__(self, *args, reason):
+        super().__init__(*args, reason)
+        self.reason = reason
+
+    def __str__(self):
+        try:
+            _, internal_metadata = self.reason.__str__().split(",", 1)
+            internal_metadata_dict = json.loads(internal_metadata)
+            return internal_metadata_dict["error_description"]
+
+        except json.decoder.JSONDecodeError:
+            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."""
+
+    def __init__(self, *args, reason):
+        super().__init__(*args, reason)
+        self.reason = reason
+
+    def __str__(self):
+        return (
+            "An error occurred while uploading files to the Microsoft SharePoint folder. "
+            + self.reason.__str__()
+        )
+
+
+class BackupUploadError(Exception):
+    """Raised when there is an error when occurs the migration from the local backup to
+    sharepoint cloud."""
+
+    def __init__(self, *args, reason):
+        super().__init__(*args, reason)
+        self.reason = reason
+
+    def __str__(self):
+        return (
+            "An error occurred during the migration from the local backup to SharePoint cloud. "
+            "Search the logs for more information. " + self.reason.__str__()
+        )
+
+
+class BackupSourcePathError(Exception):
+    """Raised when the local backup source path is invalid."""
+
+    def __init__(self, *args, reason):
+        super().__init__(*args, reason)
+        self.reason = reason
+
+    def __str__(self):
+        return "Invalid local backup source path. " + self.reason.__str__()
+
+
+class BackupEmptyError(Exception):
+    """Raised when the local backup folder is empty."""
+
+    def __init__(self, *args):
+        super().__init__(*args)
+
+    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/__init__.py

@@ -0,0 +1,7 @@
+from .common_types import (
+    EmptyDataError,
+    FtpClientError,
+    SharepointClientError,
+)
+
+__all__ = ["EmptyDataError", "SharepointClientError", "FtpClientError"]

saviialib/general_types/error_types/common/common_types.py

@@ -0,0 +1,26 @@
+class EmptyDataError(Exception):
+    def __init__(self, *args, reason):
+        super().__init__(*args, reason)
+        self.reason = reason
+
+    def __str__(self):
+        return "The data provided is empty. " + self.reason.__str__()
+
+
+class SharepointClientError(Exception):
+    def __str__(self):
+        return "SharePoint API REST Client initialization fails."
+
+
+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/files_client/__init__.py

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

saviialib/libs/files_client/clients/aiofiles_client.py

@@ -0,0 +1,44 @@
+import aiofiles
+from saviialib.libs.directory_client.directory_client import (
+    DirectoryClient,
+    DirectoryClientArgs,
+)
+from saviialib.libs.files_client.files_client_contract import FilesClientContract
+from saviialib.libs.files_client.types.files_client_types import (
+    FilesClientInitArgs,
+    ReadArgs,
+    WriteArgs,
+)
+import json
+
+
+class AioFilesClient(FilesClientContract):
+    def __init__(self, args: FilesClientInitArgs):
+        self.dir_client = DirectoryClient(DirectoryClientArgs(client_name="os_client"))
+
+    async def read(self, args: ReadArgs) -> str | bytes:
+        if args.mode == "json":
+            async with aiofiles.open(
+                args.file_path, "r", encoding=args.encoding or "utf-8"
+            ) as file:
+                content = await file.read()
+                return json.loads(content)
+
+        encoding = None if args.mode == "rb" else args.encoding
+        async with aiofiles.open(args.file_path, args.mode, encoding=encoding) as file:
+            return await file.read()
+
+    async def write(self, args: WriteArgs) -> None:
+        file_path = (
+            self.dir_client.join_paths(args.destination_path, args.file_name)
+            if args.destination_path
+            else args.file_name
+        )
+        if args.mode == "json":
+            async with aiofiles.open(file_path, "w", encoding="utf-8") as file:
+                json_str = json.dumps(args.file_content, ensure_ascii=False, indent=2)
+                await file.write(json_str)
+            return
+
+        async with aiofiles.open(file_path, args.mode) as file:
+            await file.write(args.file_content)

saviialib/libs/files_client/clients/csv_client.py

@@ -0,0 +1,42 @@
+import csv
+from asyncio import to_thread
+
+from saviialib.libs.directory_client.directory_client import (
+    DirectoryClient,
+    DirectoryClientArgs,
+)
+from saviialib.libs.files_client.files_client_contract import FilesClientContract
+from saviialib.libs.files_client.types.files_client_types import (
+    FilesClientInitArgs,
+    ReadArgs,
+    WriteArgs,
+)
+
+
+class CsvClient(FilesClientContract):
+    def __init__(self, args: FilesClientInitArgs):
+        self.dir_client = DirectoryClient(DirectoryClientArgs(client_name="os_client"))
+
+    async def read(self, args: ReadArgs) -> str | bytes:
+        raise OSError("This method is not implemented yet.")
+
+    async def write(self, args: WriteArgs) -> None:
+        file_type = args.file_name.split(".")[-1]
+        file_content = args.file_content
+        header = file_content[0].keys()
+        if file_type == "tsv":
+            delimiter = "\t"
+        else:  # Default CSV.
+            delimiter = ","
+
+        if args.destination_path == "":
+            dest_path = self.dir_client.join_paths(args.file_name)
+        else:
+            dest_path = self.dir_client.join_paths(
+                args.destination_path, args.file_name
+            )
+
+        with open(dest_path, "w", newline="") as file:
+            writer = csv.DictWriter(file, fieldnames=header, delimiter=delimiter)  # type: ignore
+            await to_thread(writer.writeheader)
+            await to_thread(writer.writerows, file_content)  # type: ignore

saviialib/libs/files_client/files_client.py

@@ -0,0 +1,26 @@
+from .clients.aiofiles_client import AioFilesClient
+from .clients.csv_client import CsvClient
+from .files_client_contract import FilesClientContract
+from .types.files_client_types import FilesClientInitArgs, ReadArgs, WriteArgs
+
+
+class FilesClient(FilesClientContract):
+    CLIENTS = {"aiofiles_client", "csv_client"}
+
+    def __init__(self, args: FilesClientInitArgs) -> None:
+        if args.client_name not in FilesClient.CLIENTS:
+            msg = f"Unsupported client {args.client_name}"
+            raise KeyError(msg)
+
+        if args.client_name == "aiofiles_client":
+            self.client_obj = AioFilesClient(args)
+        elif args.client_name == "csv_client":
+            self.client_obj = CsvClient(args)
+
+        self.client_name = args.client_name
+
+    async def read(self, args: ReadArgs):
+        return await self.client_obj.read(args)
+
+    async def write(self, args: WriteArgs):
+        return await self.client_obj.write(args)

saviialib/libs/files_client/files_client_contract.py

@@ -0,0 +1,13 @@
+from abc import ABC, abstractmethod
+
+from .types.files_client_types import ReadArgs, WriteArgs
+
+
+class FilesClientContract(ABC):
+    @abstractmethod
+    async def read(self, args: ReadArgs) -> str | bytes:
+        pass
+
+    @abstractmethod
+    async def write(self, arg: WriteArgs) -> None:
+        pass