rcer-iot-client-pkg 0.3.1__tar.gz → 0.5.0__tar.gz

{rcer_iot_client_pkg-0.3.1 → rcer_iot_client_pkg-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rcer_iot_client_pkg
-Version: 0.3.1
+Version: 0.5.0
 Summary: A client library for IoT projects in the RCER initiative
 License: MIT
 Author: pedropablozavalat
@@ -30,6 +30,39 @@ This library provides a robust and efficient client for interacting with IoT dev
 pip install rcer_iot_client_pkg
 ```
 
+## Usage
+
+### Initialize the EPii API Client
+To start using the library, you need to create an `EpiiAPI` client instance:
+
+```python
+from rcer_iot_client_pkg import EpiiAPI
+
+api_client = EpiiAPI()
+```
+
+### Update THIES Data Logger Files
+The library provides a method to synchronize THIES Data Logger files with the RCER SharePoint client. This method updates the folder containing binary files with meteorological data:
+
+```python
+import asyncio
+
+async def update_thies_data():
+    response = await api_client.update_thies_data(
+        ftp_port=PORT,
+        ftp_host=LOCAL_HOST,
+        ftp_password=PASSWORD,
+        ftp_user=USER
+    )
+    return response
+
+asyncio.run(update_thies_data())
+```
+
+**Notes:** 
+- Store sensitive data like `PASSWORD` and `USER` securely, e.g., in environment variables or a secrets file.
+- Ensure `asyncio` is installed to run concurrent code with `EpiiAPI` methods.
+
 ## Development
 
 This project includes a `Makefile` to simplify common tasks. Below are the available commands:

{rcer_iot_client_pkg-0.3.1 → rcer_iot_client_pkg-0.5.0}/README.md

@@ -9,6 +9,39 @@ This library provides a robust and efficient client for interacting with IoT dev
 pip install rcer_iot_client_pkg
 ```
 
+## Usage
+
+### Initialize the EPii API Client
+To start using the library, you need to create an `EpiiAPI` client instance:
+
+```python
+from rcer_iot_client_pkg import EpiiAPI
+
+api_client = EpiiAPI()
+```
+
+### Update THIES Data Logger Files
+The library provides a method to synchronize THIES Data Logger files with the RCER SharePoint client. This method updates the folder containing binary files with meteorological data:
+
+```python
+import asyncio
+
+async def update_thies_data():
+    response = await api_client.update_thies_data(
+        ftp_port=PORT,
+        ftp_host=LOCAL_HOST,
+        ftp_password=PASSWORD,
+        ftp_user=USER
+    )
+    return response
+
+asyncio.run(update_thies_data())
+```
+
+**Notes:** 
+- Store sensitive data like `PASSWORD` and `USER` securely, e.g., in environment variables or a secrets file.
+- Ensure `asyncio` is installed to run concurrent code with `EpiiAPI` methods.
+
 ## Development
 
 This project includes a `Makefile` to simplify common tasks. Below are the available commands:

{rcer_iot_client_pkg-0.3.1 → rcer_iot_client_pkg-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rcer_iot_client_pkg"
-version = "0.3.1"
+version = "0.5.0"
 description = "A client library for IoT projects in the RCER initiative"
 authors = ["pedropablozavalat"]
 license = "MIT"

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/general_types/api/update_thies_data_types.py

@@ -0,0 +1,29 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class EpiiAPIConfig:
+    """
+    Configuration for Epii 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_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

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/general_types/error_types/api/update_thies_data_error_types.py

@@ -0,0 +1,30 @@
+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 __str__(self):
+        return "An error occurred while retrieving file names from the RCER cloud"

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/general_types/error_types/common/__init__.py

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

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/general_types/error_types/common/common_types.py

@@ -0,0 +1,17 @@
+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."

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/libs/ftp_client/__init__.py

@@ -0,0 +1,4 @@
+from .ftp_client import FTPClient
+from .types import FtpClientInitArgs, FtpListFilesArgs, FtpReadFileArgs
+
+__all__ = ["FTPClient", "FtpClientInitArgs", "FtpListFilesArgs", "FtpReadFileArgs"]

{rcer_iot_client_pkg-0.3.1 → rcer_iot_client_pkg-0.5.0}/src/rcer_iot_client_pkg/libs/ftp_client/clients/aioftp_client.py

@@ -1,37 +1,45 @@
 from aioftp import Client
-
+from aioftp.errors import StatusCodeError
 from rcer_iot_client_pkg.libs.ftp_client.ftp_client_contract import (
     FTPClientContract,
 )
 from rcer_iot_client_pkg.libs.ftp_client.types.ftp_client_types import (
     FtpClientInitArgs,
-    ListFilesArgs,
-    ReadFileArgs,
+    FtpListFilesArgs,
+    FtpReadFileArgs,
 )
 
 
 class AioFTPClient(FTPClientContract):
     def __init__(self, args: FtpClientInitArgs) -> None:
-        self.host = args.host
-        self.port = args.port
-        self.password = args.password
-        self.user = args.user
+        self.host = args.config.ftp_host
+        self.port = args.config.ftp_port
+        self.password = args.config.ftp_password
+        self.user = args.config.ftp_user
         self.client = Client()
 
     async def _async_start(self) -> None:
-        try: 
+        try:
             await self.client.connect(host=self.host, port=self.port)
+        except OSError:
+            raise ConnectionRefusedError(
+                f"{self.host}:{self.port} isn't active. "
+                "Please ensure the server is running and accessible."
+            )
+        try:
             await self.client.login(user=self.user, password=self.password)
-        except Exception:
-            raise RuntimeError("Unexpected error occurred while trying to connect to the FTP server")
+        except StatusCodeError:
+            raise ConnectionAbortedError(
+                "Authentication failed. Please verify your credentials and try again."
+            )
 
-    async def list_files(self, args: ListFilesArgs) -> list[str]:
+    async def list_files(self, args: FtpListFilesArgs) -> list[str]:
         await self._async_start()
         return [
             path.name async for path, _ in self.client.list(args.path, recursive=False)
         ]
 
-    async def read_file(self, args: ReadFileArgs) -> bytes:
+    async def read_file(self, args: FtpReadFileArgs) -> bytes:
         await self._async_start()
         async with self.client.download_stream(args.file_path) as stream:
             return await stream.read()

{rcer_iot_client_pkg-0.3.1 → rcer_iot_client_pkg-0.5.0}/src/rcer_iot_client_pkg/libs/ftp_client/ftp_client.py

@@ -1,6 +1,6 @@
 from .clients.aioftp_client import AioFTPClient
 from .ftp_client_contract import FTPClientContract
-from .types.ftp_client_types import FtpClientInitArgs, ListFilesArgs, ReadFileArgs
+from .types.ftp_client_types import FtpClientInitArgs, FtpListFilesArgs, FtpReadFileArgs
 
 
 class FTPClient(FTPClientContract):
@@ -15,8 +15,8 @@ class FTPClient(FTPClientContract):
             self.client_obj = AioFTPClient(args)
         self.client_name = args.client_name
 
-    def list_files(self, args: ListFilesArgs) -> list[str]:
+    def list_files(self, args: FtpListFilesArgs) -> list[str]:
         return self.client_obj.list_files(args)
 
-    def read_file(self, args: ReadFileArgs) -> bytes:
+    def read_file(self, args: FtpReadFileArgs) -> bytes:
         return self.client_obj.read_file(args)

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/libs/ftp_client/ftp_client_contract.py

@@ -0,0 +1,13 @@
+from abc import ABC, abstractmethod
+
+from .types.ftp_client_types import FtpListFilesArgs, FtpReadFileArgs
+
+
+class FTPClientContract(ABC):
+    @abstractmethod
+    def list_files(self, args: FtpListFilesArgs) -> list[str]:
+        pass
+
+    @abstractmethod
+    def read_file(self, args: FtpReadFileArgs) -> bytes:
+        pass

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/libs/ftp_client/types/__init__.py

@@ -0,0 +1,3 @@
+from .ftp_client_types import FtpClientInitArgs, FtpListFilesArgs, FtpReadFileArgs
+
+__all__ = ["FtpClientInitArgs", "FtpListFilesArgs", "FtpReadFileArgs"]

{rcer_iot_client_pkg-0.3.1 → rcer_iot_client_pkg-0.5.0}/src/rcer_iot_client_pkg/libs/ftp_client/types/ftp_client_types.py

@@ -1,20 +1,18 @@
 from dataclasses import dataclass
+from typing import Any
 
 
 @dataclass
 class FtpClientInitArgs:
-    host: str
-    user: str
-    password: str
+    config: Any
     client_name: str = "aioftp_client"
-    port: int = 21
 
 
 @dataclass
-class ListFilesArgs:
+class FtpListFilesArgs:
     path: str
 
 
 @dataclass
-class ReadFileArgs:
+class FtpReadFileArgs:
     file_path: str

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/libs/sharepoint_client/__init__.py

@@ -0,0 +1,15 @@
+from .sharepoint_client import SharepointClient
+from .types.sharepoint_client_types import (
+    SharepointClientInitArgs,
+    SpListFilesArgs,
+    SpListFoldersArgs,
+    SpUploadFileArgs,
+)
+
+__all__ = [
+    "SharepointClientInitArgs",
+    "SharepointClient",
+    "SpListFilesArgs",
+    "SpListFoldersArgs",
+    "SpUploadFileArgs",
+]

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/libs/sharepoint_client/clients/sharepoint_rest_api.py

@@ -0,0 +1,134 @@
+import os
+from typing import Any
+
+from aiohttp import ClientError, ClientSession
+from dotenv import load_dotenv
+
+from rcer_iot_client_pkg.libs.sharepoint_client.sharepoint_client_contract import (
+    SharepointClientContract,
+)
+from rcer_iot_client_pkg.libs.sharepoint_client.types.sharepoint_client_types import (
+    SpListFilesArgs,
+    SpListFoldersArgs,
+    SpUploadFileArgs,
+    SharepointClientInitArgs,
+)
+
+load_dotenv()
+
+
+class SharepointRestAPI(SharepointClientContract):
+    def __init__(self, args: SharepointClientInitArgs):
+        self.session: ClientSession | None = None
+        self.base_headers = {}
+        self.credentials = {}
+        self.base_url = ""
+        self.tenant_id = args.config.sharepoint_tenant_id
+        self.tenant_name = args.config.sharepoint_tenant_name
+        self.client_secret = args.config.sharepoint_client_secret
+        self.client_id = args.config.sharepoint_client_id
+        self.site_name = args.config.sharepoint_site_name
+
+    async def _load_form_digest_value(self) -> str:
+        try:
+            response = await self.session.post("contextinfo")
+            response_json = await response.json()
+            return response_json["FormDigestValue"]
+        except ClientError as error:
+            raise ConnectionError(error) from error
+
+    async def _load_credentials(self) -> dict:
+        resource_base = "00000003-0000-0ff1-ce00-000000000000"
+        resource = f"{resource_base}/{self.tenant_name}.sharepoint.com@{self.tenant_id}"
+        url = f"https://accounts.accesscontrol.windows.net/{self.tenant_id}/tokens/OAuth/2"
+        payload = {
+            "grant_type": "client_credentials",
+            "client_id": f"{self.client_id}@{self.tenant_id}",
+            "client_secret": self.client_secret,
+            "resource": resource,
+        }
+        headers = {
+            "Content-Type": "application/x-www-form-urlencoded",
+        }
+
+        async with ClientSession() as session:
+            # Load access token
+            response = await session.post(url, data=payload, headers=headers)
+            if response.status != 200:
+                raise ClientError(
+                    f"Failed to fetch credentials: {response.status}, {await response.text()}"
+                )
+            response_json = await response.json()
+
+            return {
+                "access_token": response_json["access_token"],
+            }
+
+    async def __aenter__(self) -> "SharepointRestAPI":
+        self.credentials = await self._load_credentials()
+        site_url = f"https://{self.tenant_name}.sharepoint.com"
+
+        self.base_headers = {
+            "Authorization": f"Bearer {self.credentials['access_token']}",
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+        }
+        self.base_url = f"{site_url}/sites/{self.site_name}/_api/"
+        self.session = ClientSession(headers=self.base_headers, base_url=self.base_url)
+        return self
+
+    async def __aexit__(
+        self, _exc_type: type[BaseException], _exc_val: BaseException, _exc_tb: Any
+    ) -> None:
+        await self.session.close()
+
+    async def list_files(self, args: SpListFilesArgs) -> list:
+        try:
+            folder_relative_url = (
+                f"GetFolderByServerRelativeUrl('{args.folder_relative_url}')"
+            )
+            endpoint = f"web/{folder_relative_url}/Files"
+            response = await self.session.get(endpoint.lstrip("/"))
+            response.raise_for_status()
+            response_json = await response.json()
+            return response_json
+        except ClientError as error:
+            raise ConnectionError(error) from error
+
+    async def list_folders(self, args: SpListFoldersArgs) -> list:
+        try:
+            folder_relative_url = (
+                f"GetFolderByServerRelativeUrl('{args.folder_relative_url}')"
+            )
+            endpoint = f"web/{folder_relative_url}/Folder"
+            response = await self.session.get(endpoint.lstrip("/"))
+            response.raise_for_status()
+            return await response.json()
+        except ClientError as error:
+            raise ConnectionError(error) from error
+
+    async def upload_file(self, args: SpUploadFileArgs) -> dict:
+        try:
+            # Load form digest value
+            form_digest_value = await self._load_form_digest_value()
+            headers = {
+                **self.base_headers,
+                "X-RequestDigest": form_digest_value,
+                "Content-Type": "application/octet-stream",
+            }
+            # Upload the file in the requested folder
+            folder_relative_url = (
+                f"GetFolderByServerRelativeUrl('{args.folder_relative_url}')"
+            )
+            # Read the file
+            source_file_path = os.path.basename(args.file_path)
+            with open(source_file_path, "rb") as file:
+                data = file.read()
+
+            endpoint = f"web/{folder_relative_url}/Files/add(url='{source_file_path}',overwrite=false)"
+            response = await self.session.post(endpoint, data=data, headers=headers)
+
+            response.raise_for_status()
+            return await response.json()
+        except ClientError as error:
+            raise ConnectionError(error) from error

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/libs/sharepoint_client/sharepoint_client.py

@@ -0,0 +1,34 @@
+from .clients.sharepoint_rest_api import SharepointRestAPI
+from .sharepoint_client_contract import SharepointClientContract
+from .types.sharepoint_client_types import (
+    SharepointClientInitArgs,
+    SpListFilesArgs,
+    SpListFoldersArgs,
+    SpUploadFileArgs,
+)
+
+
+class SharepointClient(SharepointClientContract):
+    CLIENTS = {"sharepoint_rest_api"}
+
+    def __init__(self, args: SharepointClientInitArgs):
+        if args.client_name not in SharepointClient.CLIENTS:
+            msg = f"Unsupported client {args.client_name}"
+            raise KeyError(msg)
+        elif args.client_name == "sharepoint_rest_api":
+            self.client_obj = SharepointRestAPI(args)
+
+    async def __aenter__(self):
+        return await self.client_obj.__aenter__()
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        await self.client_obj.__aexit__(exc_type, exc_val, exc_tb)
+
+    async def list_files(self, args: SpListFilesArgs) -> list:
+        return await self.client_obj.list_files(args)
+
+    async def list_folders(self, args: SpListFoldersArgs) -> list:
+        return self.client_obj.list_files(args)
+
+    async def upload_file(self, args: SpUploadFileArgs) -> dict:
+        return self.client_obj.upload_file(args)

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/libs/sharepoint_client/sharepoint_client_contract.py

@@ -0,0 +1,21 @@
+from abc import ABC, abstractmethod
+
+from .types.sharepoint_client_types import (
+    SpListFilesArgs,
+    SpListFoldersArgs,
+    SpUploadFileArgs,
+)
+
+
+class SharepointClientContract(ABC):
+    @abstractmethod
+    async def list_files(self, args: SpListFilesArgs) -> list:
+        pass
+
+    @abstractmethod
+    async def list_folders(self, args: SpListFoldersArgs) -> list:
+        pass
+
+    @abstractmethod
+    async def upload_file(self, args: SpUploadFileArgs) -> dict:
+        pass

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/libs/sharepoint_client/types/sharepoint_client_types.py

@@ -0,0 +1,25 @@
+from dataclasses import dataclass
+from typing import Any
+
+
+@dataclass
+class SharepointClientInitArgs:
+    config: Any
+    client_name: str = "sharepoint_rest_api"
+
+
+@dataclass
+class SpListFilesArgs:
+    folder_relative_url: str
+
+
+@dataclass
+class SpListFoldersArgs:
+    folder_relative_url: str
+
+
+@dataclass
+class SpUploadFileArgs:
+    file_path: str
+    folder_relative_url: str
+    file_content: bytes = bytes()

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/services/epii/api.py

@@ -0,0 +1,24 @@
+from typing import Any, Dict
+
+from .controllers.types.update_thies_data_types import UpdateThiesDataControllerInput
+from .controllers.update_thies_data import UpdateThiesDataController
+from rcer_iot_client_pkg.general_types.api.update_thies_data_types import EpiiAPIConfig
+
+
+class EpiiAPI:
+    """
+    EpiiAPI is a service class that provides methods to interact with Patagonia Center system.
+    """
+
+    async def update_thies_data(self, config: EpiiAPIConfig) -> Dict[str, Any]:
+        """
+        This method establishes a connection to an FTP server using the provided
+        credentials and updates data related to THIES Data Logger.
+        Args:
+            config (EpiiAPIConfig): configuration class for FTP Server and Microsoft SharePoint credentials.
+        Returns:
+            response (dict): A dictionary representation of the API response.
+        """
+        controller = UpdateThiesDataController(UpdateThiesDataControllerInput(config))
+        response = await controller.execute()
+        return response.__dict__

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/services/epii/constants/update_thies_data_constants.py

@@ -0,0 +1,5 @@
+SHAREPOINT_BASE_URL = "/sites/uc365_CentrosyEstacionesRegionalesUC/Shared Documents/General/Test_Raspberry/THIES"
+SHAREPOINT_THIES_FOLDERS = ["AVG", "EXT"]
+
+FTP_SERVER_PATH_AVG_FILES = "ftp/thies/BINFILES/ARCH_AV1"
+FTP_SERVER_PATH_EXT_FILES = "ftp/thies/BINFILES/ARCH_EX1"

{rcer_iot_client_pkg-0.3.1 → rcer_iot_client_pkg-0.5.0}/src/rcer_iot_client_pkg/services/epii/controllers/types/update_thies_data_types.py

@@ -1,13 +1,11 @@
 from dataclasses import dataclass, field
 from typing import Dict
+from rcer_iot_client_pkg.general_types.api.update_thies_data_types import EpiiAPIConfig
 
 
 @dataclass
 class UpdateThiesDataControllerInput:
-    ftp_host: str
-    ftp_port: str
-    ftp_user: str
-    ftp_password: str
+    config: EpiiAPIConfig
 
 
 @dataclass

{rcer_iot_client_pkg-0.3.1 → rcer_iot_client_pkg-0.5.0}/src/rcer_iot_client_pkg/services/epii/controllers/update_thies_data.py

@@ -1,12 +1,14 @@
 from http import HTTPStatus
 
 from rcer_iot_client_pkg.general_types.error_types.api.update_thies_data_error_types import (
-    FetchCloudFileNamesError,
-    ThiesUploadEmptyError,
+    SharePointFetchingError,
+    ThiesConnectionError,
+    ThiesFetchingError,
 )
 from rcer_iot_client_pkg.general_types.error_types.common.common_types import (
+    EmptyDataError,
     FtpClientError,
-    HttpClientError,
+    SharepointClientError,
 )
 from rcer_iot_client_pkg.services.epii.controllers.types.update_thies_data_types import (
     UpdateThiesDataControllerInput,
@@ -14,6 +16,8 @@ from rcer_iot_client_pkg.services.epii.controllers.types.update_thies_data_types
 )
 from rcer_iot_client_pkg.services.epii.use_cases.types import (
     UpdateThiesDataUseCaseInput,
+    SharepointConfig,
+    FtpClientConfig,
 )
 from rcer_iot_client_pkg.services.epii.use_cases.update_thies_data import (
     UpdateThiesDataUseCase,
@@ -23,7 +27,21 @@ from rcer_iot_client_pkg.services.epii.use_cases.update_thies_data import (
 class UpdateThiesDataController:
     def __init__(self, input: UpdateThiesDataControllerInput):
         self.use_case = UpdateThiesDataUseCase(
-            UpdateThiesDataUseCaseInput(**input.__dict__)
+            UpdateThiesDataUseCaseInput(
+                ftp_config=FtpClientConfig(
+                    ftp_host=input.config.ftp_host,
+                    ftp_password=input.config.ftp_password,
+                    ftp_port=input.config.ftp_port,
+                    ftp_user=input.config.ftp_user,
+                ),
+                sharepoint_config=SharepointConfig(
+                    sharepoint_client_id=input.config.sharepoint_client_id,
+                    sharepoint_client_secret=input.config.sharepoint_client_secret,
+                    sharepoint_site_name=input.config.sharepoint_site_name,
+                    sharepoint_tenant_name=input.config.sharepoint_tenant_name,
+                    sharepoint_tenant_id=input.config.sharepoint_tenant_id,
+                ),
+            )
         )
 
     async def execute(self) -> UpdateThiesDataControllerOutput:
@@ -34,6 +52,11 @@ class UpdateThiesDataController:
                 status=HTTPStatus.OK.value,
                 metadata={"data": data},
             )
+        except EmptyDataError:
+            return UpdateThiesDataControllerOutput(
+                message="No files to upload", status=HTTPStatus.NO_CONTENT
+            )
+
         except (AttributeError, NameError, ValueError) as error:
             return UpdateThiesDataControllerOutput(
                 message="An unexpected error occurred during use case initialization.",
@@ -47,22 +70,30 @@ class UpdateThiesDataController:
                 metadata={"error": error.__str__()},
             )
 
-        except HttpClientError as error:
+        except SharepointClientError as error:
             return UpdateThiesDataControllerOutput(
-                message="Http Client initialization fails.",
+                message="Sharepoint Client initialization fails.",
                 status=HTTPStatus.BAD_REQUEST.value,
                 metadata={"error": error.__str__()},
             )
 
-        except FetchCloudFileNamesError as error:
+        except SharePointFetchingError as error:
             return UpdateThiesDataControllerOutput(
                 message="An error occurred while retrieving file names from the RCER cloud",
                 status=HTTPStatus.INTERNAL_SERVER_ERROR.value,
                 metadata={"error": error.__str__()},
             )
-        except ThiesUploadEmptyError as error:
+
+        except ThiesFetchingError as error:
             return UpdateThiesDataControllerOutput(
-                message="No files were found to upload.",
+                message="An error ocurred while retrieving file names from THIES FTP Server.",
                 status=HTTPStatus.NO_CONTENT.value,
                 metadata={"error": error.__str__()},
             )
+
+        except ThiesConnectionError as error:
+            return UpdateThiesDataControllerOutput(
+                message="Unable to connect to THIES Data Logger FTP Server.",
+                status=HTTPStatus.INTERNAL_SERVER_ERROR.value,
+                metadata={"error": error.__str__()},
+            )

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/services/epii/use_cases/types/__init__.py

@@ -0,0 +1,7 @@
+from .update_thies_data_types import (
+    FtpClientConfig,
+    SharepointConfig,
+    UpdateThiesDataUseCaseInput,
+)
+
+__all__ = ["UpdateThiesDataUseCaseInput", "FtpClientConfig", "SharepointConfig"]

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/services/epii/use_cases/types/update_thies_data_types.py

@@ -0,0 +1,32 @@
+from dataclasses import dataclass, field
+from typing import Dict
+
+
+@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
+
+
+@dataclass
+class UpdateThiesDataUseCaseInput:
+    ftp_config: FtpClientConfig
+    sharepoint_config: SharepointConfig
+
+
+@dataclass
+class UpdateThiesDataUseCaseOutput:
+    message: str
+    status: int = 0
+    metadata: Dict[str, str] = field(default_factory=dict)

{rcer_iot_client_pkg-0.3.1 → rcer_iot_client_pkg-0.5.0}/src/rcer_iot_client_pkg/services/epii/use_cases/update_thies_data.py

@@ -1,32 +1,34 @@
 from dotenv import load_dotenv
 
-import rcer_iot_client_pkg.services.epii.use_cases.constants as c
+import rcer_iot_client_pkg.services.epii.constants.update_thies_data_constants as c
 from rcer_iot_client_pkg.general_types.error_types.api.update_thies_data_error_types import (
-    FetchCloudFileNamesError,
-    FetchThiesFileContentError,
-    ThiesUploadEmptyError,
+    SharePointFetchingError,
+    ThiesConnectionError,
+    ThiesFetchingError,
 )
 from rcer_iot_client_pkg.general_types.error_types.common import (
     EmptyDataError,
     FtpClientError,
-    HttpClientError,
-)
-from rcer_iot_client_pkg.libs.async_http_client import (
-    AsyncHTTPClient,
-    AsyncHttpClientInitArgs,
-    GetArgs,
+    SharepointClientError,
 )
 from rcer_iot_client_pkg.libs.ftp_client import (
     FTPClient,
     FtpClientInitArgs,
-    ListFilesArgs,
-    ReadFileArgs,
+    FtpListFilesArgs,
+    FtpReadFileArgs,
+)
+from rcer_iot_client_pkg.libs.sharepoint_client import (
+    SharepointClient,
+    SharepointClientInitArgs,
+    SpListFilesArgs,
 )
 from rcer_iot_client_pkg.services.epii.use_cases.types import (
     UpdateThiesDataUseCaseInput,
+    FtpClientConfig,
+    SharepointConfig,
 )
 from rcer_iot_client_pkg.services.epii.utils import (
-    generate_file_content,
+    parse_execute_response,
 )
 
 load_dotenv()
@@ -34,91 +36,85 @@ load_dotenv()
 
 class UpdateThiesDataUseCase:
     def __init__(self, input: UpdateThiesDataUseCaseInput):
-        self.ftp_port = input.ftp_port
-        self.ftp_host = input.ftp_host
-        self.ftp_password = input.ftp_password
-        self.ftp_user = input.ftp_user
-        self.sharepoint_client = self._initialize_sharepoint_client()
-        self.thies_ftp_client = self._initialize_thies_ftp_client()
+        self.sharepoint_client = self._initialize_sharepoint_client(
+            input.sharepoint_config
+        )
+        self.thies_ftp_client = self._initialize_thies_ftp_client(input.ftp_config)
         self.uploading = set()
 
-    def _initialize_sharepoint_client(self) -> AsyncHTTPClient:
+    def _initialize_sharepoint_client(
+        self, config: SharepointConfig
+    ) -> SharepointClient:
         """Initialize the HTTP client."""
         try:
-            return AsyncHTTPClient(
-                AsyncHttpClientInitArgs(
-                    client_name="aiohttp_client",
-                    access_token="temporal-token",
-                    base_url="https://graph.microsoft.com/v1.0/",
-                )
+            return SharepointClient(
+                SharepointClientInitArgs(config, client_name="sharepoint_rest_api")
             )
         except ConnectionError as error:
-            raise HttpClientError(error)
+            raise SharepointClientError(error)
 
-    def _initialize_thies_ftp_client(self) -> FTPClient:
+    def _initialize_thies_ftp_client(self, config: FtpClientConfig) -> FTPClient:
         """Initialize the FTP client."""
         try:
-            return FTPClient(
-                FtpClientInitArgs(
-                    client_name="aioftp_client",
-                    host=self.ftp_host,
-                    user=self.ftp_user,
-                    password=self.ftp_password,
-                    port=self.ftp_port,
-                )
-            )
+            return FTPClient(FtpClientInitArgs(config, client_name="aioftp_client"))
         except RuntimeError as error:
             raise FtpClientError(error)
 
-    async def fetch_cloud_file_names(self, folder_name: str) -> set[str]:
+    async def fetch_cloud_file_names(self) -> set[str]:
         """Fetch file names from the RCER cloud."""
+
         try:
             cloud_files = set()
             async with self.sharepoint_client:
-                for file_type in c.FILE_TYPES:
-                    destination_path = f"Onedrive_UC/noveno-semestre/IPRE-RCER/{folder_name}/{file_type}"
-                    endpoint = f"drives/{c.DRIVE_ID}/root:/{destination_path}:/children"
-                    response = await self.sharepoint_client.get(
-                        GetArgs(endpoint=endpoint)
+                for folder in c.SHAREPOINT_THIES_FOLDERS:
+                    args = SpListFilesArgs(
+                        folder_relative_url=f"{c.SHAREPOINT_BASE_URL}/{folder}"
                     )
+                    response = await self.sharepoint_client.list_files(args)
                     cloud_files.update(
-                        {f"{file_type}_{item['name']}" for item in response["value"]}
+                        {f"{folder}_{item['Name']}" for item in response["value"]}
                     )
             return cloud_files
         except ConnectionError as error:
-            raise FetchCloudFileNamesError(error)
+            raise SharePointFetchingError(reason=error)
 
     async def fetch_thies_file_names(self) -> set[str]:
         """Fetch file names from the THIES FTP server."""
         try:
             avg_files = await self.thies_ftp_client.list_files(
-                ListFilesArgs(path=c.PATH_AVG_FILES)
+                FtpListFilesArgs(path=c.FTP_SERVER_PATH_AVG_FILES)
             )
             ext_files = await self.thies_ftp_client.list_files(
-                ListFilesArgs(path=c.PATH_EXT_FILES)
+                FtpListFilesArgs(path=c.FTP_SERVER_PATH_EXT_FILES)
             )
             return {f"AVG_{name}" for name in avg_files} | {
                 f"EXT_{name}" for name in ext_files
             }
-        except ConnectionError:
-            raise ThiesUploadEmptyError
+        except ConnectionRefusedError as error:
+            raise ThiesConnectionError(reason=error)
+        except ConnectionAbortedError as error:
+            raise ThiesFetchingError(reason=error)
 
     async def fetch_thies_file_content(self) -> dict[str, bytes]:
         """Fetch the content of files from the THIES FTP server."""
-        content_files = {}
-        for file in self.uploading:
-            try:
+        try:
+            content_files = {}
+            for file in self.uploading:
                 origin, filename = file.split("_", 1)
                 file_path = (
-                    f"{c.PATH_AVG_FILES}/{filename}"
+                    f"{c.FTP_SERVER_PATH_AVG_FILES}/{filename}"
                     if origin == "AVG"
-                    else f"{c.PATH_EXT_FILES}/{filename}"
+                    else f"{c.FTP_SERVER_PATH_EXT_FILES}/{filename}"
+                )
+                content = await self.thies_ftp_client.read_file(
+                    FtpReadFileArgs(file_path)
                 )
-                content = await self.thies_ftp_client.read_file(ReadFileArgs(file_path))
                 content_files[filename] = content
-            except ConnectionError as error:
-                raise FetchThiesFileContentError(error)
-        return content_files
+            return content_files
+        except ConnectionRefusedError as error:
+            raise ThiesConnectionError(reason=error)
+        except ConnectionAbortedError as error:
+            raise ThiesFetchingError(reason=error)
 
     async def execute(self) -> dict:
         """Synchronize data from the THIES Center to the cloud."""
@@ -126,12 +122,14 @@ class UpdateThiesDataUseCase:
             thies_files = await self.fetch_thies_file_names()
         except RuntimeError as error:
             raise FtpClientError(error)
-
-        cloud_files = await self.fetch_cloud_file_names(folder_name="thies")
+        try:
+            cloud_files = await self.fetch_cloud_file_names()
+        except RuntimeError as error:
+            raise SharepointClient(error)
         self.uploading = thies_files - cloud_files
         if not self.uploading:
-            raise EmptyDataError
+            raise EmptyDataError(reason="No files to upload.")
 
         thies_file_contents = await self.fetch_thies_file_content()
-        data = generate_file_content(thies_file_contents)
+        data = parse_execute_response(thies_file_contents)
         return data

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/services/epii/utils/__init__.py

@@ -0,0 +1,3 @@
+from .update_thies_data_utils import parse_execute_response
+
+__all__ = ["parse_execute_response"]

{rcer_iot_client_pkg-0.3.1 → rcer_iot_client_pkg-0.5.0}/src/rcer_iot_client_pkg/services/epii/utils/update_thies_data_utils.py

@@ -6,7 +6,7 @@ from rcer_iot_client_pkg.libs.zero_dependency.utils.datetime_utils import (
 )
 
 
-def generate_file_content(
+def parse_execute_response(
     file_contents: dict[str, Any],
 ) -> dict[str, dict[str, int | str]]:
     return {

rcer_iot_client_pkg-0.3.1/src/rcer_iot_client_pkg/general_types/error_types/api/update_thies_data_error_types.py

@@ -1,19 +0,0 @@
-class ThiesUploadEmptyError(Exception):
-    """Raised when no files are found to upload to the server."""
-
-    def __str__(self):
-        return "No files were found to upload."
-
-
-class FetchCloudFileNamesError(Exception):
-    """Raised when there is an error fetching file names from the RCER cloud."""
-
-    def __str__(self):
-        return "An error occurred while retrieving file names from the RCER cloud"
-
-
-class FetchThiesFileContentError(Exception):
-    """Raised when there is an error fetching the content of a Thies file."""
-
-    def __str__(self):
-        return "An error occurred while retrieving the content of a Thies file"

rcer_iot_client_pkg-0.3.1/src/rcer_iot_client_pkg/general_types/error_types/common/__init__.py

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

rcer_iot_client_pkg-0.3.1/src/rcer_iot_client_pkg/general_types/error_types/common/common_types.py

@@ -1,13 +0,0 @@
-class EmptyDataError(Exception):
-    def __str__(self):
-        return "The data provided is empty."
-
-
-class HttpClientError(Exception):
-    def __str__(self):
-        return "Http Client initialization fails."
-
-
-class FtpClientError(Exception):
-    def __str__(self):
-        return "Ftp Client initialization fails."

rcer_iot_client_pkg-0.3.1/src/rcer_iot_client_pkg/libs/ftp_client/__init__.py

@@ -1,4 +0,0 @@
-from .ftp_client import FTPClient
-from .types import FtpClientInitArgs, ListFilesArgs, ReadFileArgs
-
-__all__ = ["FTPClient", "FtpClientInitArgs", "ListFilesArgs", "ReadFileArgs"]

rcer_iot_client_pkg-0.3.1/src/rcer_iot_client_pkg/libs/ftp_client/ftp_client_contract.py

@@ -1,13 +0,0 @@
-from abc import ABC, abstractmethod
-
-from .types.ftp_client_types import ListFilesArgs, ReadFileArgs
-
-
-class FTPClientContract(ABC):
-    @abstractmethod
-    def list_files(self, args: ListFilesArgs) -> list[str]:
-        pass
-
-    @abstractmethod
-    def read_file(self, args: ReadFileArgs) -> bytes:
-        pass

rcer_iot_client_pkg-0.3.1/src/rcer_iot_client_pkg/libs/ftp_client/types/__init__.py

@@ -1,3 +0,0 @@
-from .ftp_client_types import FtpClientInitArgs, ListFilesArgs, ReadFileArgs
-
-__all__ = ["FtpClientInitArgs", "ListFilesArgs", "ReadFileArgs"]

rcer_iot_client_pkg-0.3.1/src/rcer_iot_client_pkg/services/epii/api.py

@@ -1,24 +0,0 @@
-from typing import Dict
-
-from .controllers.types.update_thies_data_types import UpdateThiesDataControllerInput
-from .controllers.update_thies_data import UpdateThiesDataController
-
-
-class EpiiAPI:
-    async def update_thies_data(
-        self,
-        ftp_port: int,
-        ftp_host: str,
-        ftp_password: str,
-        ftp_user: str,
-    ) -> Dict[str, any]:
-        controller = UpdateThiesDataController(
-            UpdateThiesDataControllerInput(
-                ftp_port=ftp_port,
-                ftp_host=ftp_host,
-                ftp_password=ftp_password,
-                ftp_user=ftp_user,
-            )
-        )
-        response = await controller.execute()
-        return response.__dict__

rcer_iot_client_pkg-0.3.1/src/rcer_iot_client_pkg/services/epii/use_cases/constants.py

@@ -1,4 +0,0 @@
-PATH_AVG_FILES = "ftp/thies/BINFILES/ARCH_AV1"
-PATH_EXT_FILES = "ftp/thies/BINFILES/ARCH_EX1"
-DRIVE_ID = "b!Row14jaFrU-1q8qzrvj3OmPPTYWXizFEpJmI-wsfH5pXxA0qQwgQS50m2xvPCZem"
-FILE_TYPES = ["AVG", "EXT"]

rcer_iot_client_pkg-0.3.1/src/rcer_iot_client_pkg/services/epii/use_cases/types/__init__.py

@@ -1,3 +0,0 @@
-from .update_thies_data_types import UpdateThiesDataUseCaseInput
-
-__all__ = ["UpdateThiesDataUseCaseInput"]

rcer_iot_client_pkg-0.3.1/src/rcer_iot_client_pkg/services/epii/use_cases/types/update_thies_data_types.py

@@ -1,17 +0,0 @@
-from dataclasses import dataclass, field
-from typing import Dict
-
-
-@dataclass
-class UpdateThiesDataUseCaseInput:
-    ftp_host: str
-    ftp_port: str
-    ftp_user: str
-    ftp_password: str
-
-
-@dataclass
-class UpdateThiesDataUseCaseOutput:
-    message: str
-    status: int = 0
-    metadata: Dict[str, str] = field(default_factory=dict)

rcer_iot_client_pkg-0.3.1/src/rcer_iot_client_pkg/services/epii/utils/__init__.py

@@ -1,3 +0,0 @@
-from .update_thies_data_utils import generate_file_content
-
-__all__ = ["generate_file_content"]