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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rcer_iot_client_pkg
-Version: 0.5.0
+Version: 0.5.2
 Summary: A client library for IoT projects in the RCER initiative
 License: MIT
 Author: pedropablozavalat
@@ -45,23 +45,29 @@ api_client = EpiiAPI()
 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
+from rcer_iot_client_pkg import EpiiAPIConfig
 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
+    config = EpiiAPIConfig(
+        ftp_port=FTP_PORT,
+        ftp_host=FTP_HOST,
+        ftp_user=FTP_USER,
+        ftp_password=FTP_PASSWORD,
+        sharepoint_client_id=SHAREPOINT_CLIENT_ID,
+        sharepoint_client_secret=SHAREPOINT_CLIENT_SECRET,
+        sharepoint_tenant_id=SHAREPOINT_TENANT_ID,
+        sharepoint_tenant_name=SHAREPOINT_TENANT_NAME,
+        sharepoint_site_name=SHAREPOINT_SITE_NAME
     )
+    response = await api_client.update_thies_data(config)
     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.
+- Store sensitive data like `FTP_PASSWORD`, `FTP_USER`, and SharePoint credentials securely. Use environment variables or a secrets management tool to avoid hardcoding sensitive information in your codebase.
 
 ## Development
 

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

@@ -24,23 +24,29 @@ api_client = EpiiAPI()
 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
+from rcer_iot_client_pkg import EpiiAPIConfig
 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
+    config = EpiiAPIConfig(
+        ftp_port=FTP_PORT,
+        ftp_host=FTP_HOST,
+        ftp_user=FTP_USER,
+        ftp_password=FTP_PASSWORD,
+        sharepoint_client_id=SHAREPOINT_CLIENT_ID,
+        sharepoint_client_secret=SHAREPOINT_CLIENT_SECRET,
+        sharepoint_tenant_id=SHAREPOINT_TENANT_ID,
+        sharepoint_tenant_name=SHAREPOINT_TENANT_NAME,
+        sharepoint_site_name=SHAREPOINT_SITE_NAME
     )
+    response = await api_client.update_thies_data(config)
     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.
+- Store sensitive data like `FTP_PASSWORD`, `FTP_USER`, and SharePoint credentials securely. Use environment variables or a secrets management tool to avoid hardcoding sensitive information in your codebase.
 
 ## Development
 

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

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

{rcer_iot_client_pkg-0.5.0 → rcer_iot_client_pkg-0.5.2}/src/rcer_iot_client_pkg/__init__.py

@@ -4,5 +4,6 @@ from importlib.metadata import version
 __version__ = version("rcer_iot_client_pkg")
 
 from .services.epii.api import EpiiAPI
+from .general_types.api.update_thies_data_types import EpiiAPIConfig
 
-__all__ = ["EpiiAPI"]
+__all__ = ["EpiiAPI", "EpiiAPIConfig"]

rcer_iot_client_pkg-0.5.2/src/rcer_iot_client_pkg/general_types/api/__init__.py

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

{rcer_iot_client_pkg-0.5.0 → rcer_iot_client_pkg-0.5.2}/src/rcer_iot_client_pkg/general_types/error_types/api/update_thies_data_error_types.py

@@ -1,3 +1,6 @@
+import json
+
+
 class ThiesConnectionError(Exception):
     """Raised when unable to connect to the THIES FTP Server"""
 
@@ -26,5 +29,15 @@ class ThiesFetchingError(Exception):
 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):
-        return "An error occurred while retrieving file names from the RCER cloud"
+        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__()

{rcer_iot_client_pkg-0.5.0 → rcer_iot_client_pkg-0.5.2}/src/rcer_iot_client_pkg/libs/sharepoint_client/clients/sharepoint_rest_api.py

@@ -65,17 +65,22 @@ class SharepointRestAPI(SharepointClientContract):
             }
 
     async def __aenter__(self) -> "SharepointRestAPI":
-        self.credentials = await self._load_credentials()
-        site_url = f"https://{self.tenant_name}.sharepoint.com"
+        try:
+            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
+            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
+        except ClientError as error:
+            raise ConnectionError(error)
 
     async def __aexit__(
         self, _exc_type: type[BaseException], _exc_val: BaseException, _exc_tb: Any

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

@@ -73,14 +73,14 @@ class UpdateThiesDataController:
         except SharepointClientError as error:
             return UpdateThiesDataControllerOutput(
                 message="Sharepoint Client initialization fails.",
-                status=HTTPStatus.BAD_REQUEST.value,
+                status=HTTPStatus.INTERNAL_SERVER_ERROR.value,
                 metadata={"error": error.__str__()},
             )
 
         except SharePointFetchingError as error:
             return UpdateThiesDataControllerOutput(
-                message="An error occurred while retrieving file names from the RCER cloud",
-                status=HTTPStatus.INTERNAL_SERVER_ERROR.value,
+                message="An error occurred while retrieving file names from Microsoft SharePoint",
+                status=HTTPStatus.BAD_REQUEST.value,
                 metadata={"error": error.__str__()},
             )
 

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

@@ -1,10 +0,0 @@
-"""Export defined type classes."""
-
-from .async_http_client import AsyncHTTPClient
-from .types.async_http_client_types import (
-    AsyncHttpClientInitArgs,
-    GetArgs,
-    UploadFileArgs,
-)
-
-__all__ = ["AsyncHTTPClient", "AsyncHttpClientInitArgs", "GetArgs", "UploadFileArgs"]

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

@@ -1,34 +0,0 @@
-from typing import Any
-
-from .async_http_client_contract import AsyncHTTPClientContract
-from .clients.aiohttp_client import AioHttpClient
-from .types.async_http_client_types import (
-    AsyncHttpClientInitArgs,
-    GetArgs,
-    UploadFileArgs,
-)
-
-
-class AsyncHTTPClient(AsyncHTTPClientContract):
-    CLIENTS = {"aiohttp_client"}
-
-    def __init__(self, args: AsyncHttpClientInitArgs) -> None:
-        if args.client_name not in AsyncHTTPClient.CLIENTS:
-            msg = f"Unsupported client '{args.client_name}'"
-            raise KeyError(msg)
-        self.client_name = args.client_name
-
-        if args.client_name == "aiohttp_client":
-            self.client_obj = AioHttpClient(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 get(self, args: GetArgs) -> dict[str, Any]:
-        return await self.client_obj.get(args)
-
-    async def upload_file(self, args: UploadFileArgs) -> dict[str, Any]:
-        return await self.client_obj.upload_file(args)

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/libs/async_http_client/async_http_client_contract.py

@@ -1,29 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import Any
-
-from .types.async_http_client_types import GetArgs, UploadFileArgs
-
-
-class AsyncHTTPClientContract(ABC):
-    """
-    A contract for asynchronous HTTP client implementations.
-
-    This abstract base class defines the required methods for performing
-    HTTP GET requests and uploading files asynchronously.
-
-    Methods.
-    -------
-    get(args: GetArgs) -> dict[str, Any]
-        Perform an HTTP GET request with the specified arguments.
-
-    upload_file(args: UploadFileArgs) -> dict[str, Any]
-        Upload a file using the specified arguments.
-    """
-
-    @abstractmethod
-    async def get(self, args: GetArgs) -> dict[str, Any]:
-        pass
-
-    @abstractmethod
-    async def upload_file(self, args: UploadFileArgs) -> dict[str, Any]:
-        pass

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/libs/async_http_client/clients/aiohttp_client.py

@@ -1,50 +0,0 @@
-from typing import Any
-
-from aiohttp import ClientError, ClientSession
-
-from rcer_iot_client_pkg.libs.async_http_client.async_http_client_contract import (
-    AsyncHTTPClientContract,
-)
-from rcer_iot_client_pkg.libs.async_http_client.types.async_http_client_types import (
-    AsyncHttpClientInitArgs,
-    GetArgs,
-    UploadFileArgs,
-)
-
-
-class AioHttpClient(AsyncHTTPClientContract):
-    def __init__(self, args: AsyncHttpClientInitArgs) -> None:
-        self.access_token = args.access_token
-        self.base_url = args.base_url
-        self.headers = self._build_headers()
-        self.session: ClientSession | None = None
-
-    def _build_headers(self) -> dict:
-        return {"Authorization": f"Bearer {self.access_token}"}
-
-    async def __aenter__(self) -> "AioHttpClient":
-        self.session = ClientSession(headers=self.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 get(self, args: GetArgs) -> dict[str, Any]:
-        try:
-            endpoint, params = args.endpoint.lstrip("/"), args.params
-            response = await self.session.get(endpoint, params=params)
-            response.raise_for_status()
-            return await response.json()
-        except ClientError as error:
-            raise ConnectionError(error) from error
-
-    async def upload_file(self, args: UploadFileArgs) -> dict[str, Any]:
-        try:
-            endpoint, file_bytes = args.endpoint.lstrip("/"), args.file_bytes
-            response = await self.session.put(endpoint, data=file_bytes)
-            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/async_http_client/types/__init__.py

@@ -1,3 +0,0 @@
-from .async_http_client_types import AsyncHttpClientInitArgs, GetArgs, UploadFileArgs
-
-__all__ = ["AsyncHttpClientInitArgs", "GetArgs", "UploadFileArgs"]

rcer_iot_client_pkg-0.5.0/src/rcer_iot_client_pkg/libs/async_http_client/types/async_http_client_types.py

@@ -1,17 +0,0 @@
-from pydantic import BaseModel, Field
-
-
-class AsyncHttpClientInitArgs(BaseModel):
-    access_token: str
-    base_url: str
-    client_name: str = "aiohttp_client"
-
-
-class GetArgs(BaseModel):
-    endpoint: str
-    params: dict | None = Field(default=None)
-
-
-class UploadFileArgs(BaseModel):
-    endpoint: str
-    file_bytes: bytes