rcer-iot-client-pkg 0.5.0__py3-none-any.whl → 0.5.2__py3-none-any.whl

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/general_types/api/__init__.py

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

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/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/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.dist-info → rcer_iot_client_pkg-0.5.2.dist-info}/METADATA

@@ -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.dist-info → rcer_iot_client_pkg-0.5.2.dist-info}/RECORD

@@ -1,19 +1,12 @@
-rcer_iot_client_pkg/__init__.py,sha256=Uy9WDPvHbwKUs7JeDHgQi_MGuXn6m7lKVniJgj49xOo,186
+rcer_iot_client_pkg/__init__.py,sha256=ynL8ADM5u2SQTdGfqVLDWEu9bYQnp6znMCEXnhu5zRA,272
 rcer_iot_client_pkg/general_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rcer_iot_client_pkg/general_types/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rcer_iot_client_pkg/general_types/api/__init__.py,sha256=1afRFS8AkxkxOWmcNLFI3H1lb-w_5dVJMMDKobBYlOY,80
 rcer_iot_client_pkg/general_types/api/update_thies_data_types.py,sha256=NqViiGKm1FdhgxJrNkLBLzqI-8SnPieAYv21kEN752U,963
 rcer_iot_client_pkg/general_types/error_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rcer_iot_client_pkg/general_types/error_types/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rcer_iot_client_pkg/general_types/error_types/api/update_thies_data_error_types.py,sha256=lDVcK7RrqT4s0Bzxa5nEyIsNee93GaIRCyPV9k0s4-o,928
+rcer_iot_client_pkg/general_types/error_types/api/update_thies_data_error_types.py,sha256=Wl9zd7qM2KeZF-h28dqSd6L9N8azOEagD837zoBgpAc,1269
 rcer_iot_client_pkg/general_types/error_types/common/__init__.py,sha256=yOBLZbt64Ki9Q0IJ0tMAubgq7PtrQ7XQ3RgtAzyOjiE,170
 rcer_iot_client_pkg/general_types/error_types/common/common_types.py,sha256=n5yuw-gVtkrtNfmaZ83ZkYxYHGl4jynOLUB9C8Tr32w,474
-rcer_iot_client_pkg/libs/async_http_client/__init__.py,sha256=LF1KEh5Dhu0j9qZhSBGOsD-PWUFKEvS2oE0eUCyNLd0,279
-rcer_iot_client_pkg/libs/async_http_client/async_http_client.py,sha256=wlOvjThS8wnpyqdcY7HbeEx1X3eVNKxJ8DuCJtx0wFk,1135
-rcer_iot_client_pkg/libs/async_http_client/async_http_client_contract.py,sha256=PCoTt4R6vFwjvyOTETQ8jEw1uqzAQC3PYiIlg_d7iRI,816
-rcer_iot_client_pkg/libs/async_http_client/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rcer_iot_client_pkg/libs/async_http_client/clients/aiohttp_client.py,sha256=exJ7yq_9ukKoGhdyEwUEe8N5syvEsv2vsQ5eJcQbKSc,1837
-rcer_iot_client_pkg/libs/async_http_client/types/__init__.py,sha256=TnJOBj5R6rVA5XAiId5dpQM6KjMIfi8KJkCCav7n930,154
-rcer_iot_client_pkg/libs/async_http_client/types/async_http_client_types.py,sha256=d-_rHQ21ajTr5AI66fH3-cpJzF8VhSqG0BHbVrlwND8,329
 rcer_iot_client_pkg/libs/ftp_client/__init__.py,sha256=dW2Yutgc7mJJJzgKLhWKXMgQ6KIWJYfFa1sGpjHH5xU,191
 rcer_iot_client_pkg/libs/ftp_client/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rcer_iot_client_pkg/libs/ftp_client/clients/aioftp_client.py,sha256=5CI9J4axAeoqlN-cYToVcPF9sAZEk0vIOhPOHrhlpk4,1633
@@ -22,7 +15,7 @@ rcer_iot_client_pkg/libs/ftp_client/ftp_client_contract.py,sha256=2x1MPZNFVw3l-s
 rcer_iot_client_pkg/libs/ftp_client/types/__init__.py,sha256=syfwf9feP4QK7fkCTfl4j8l11ic-jHtfi1DE2chaWbs,155
 rcer_iot_client_pkg/libs/ftp_client/types/ftp_client_types.py,sha256=e4SmYkewldulaD8ms2q75zVgLFXyBxBqoa_L-IQOmso,256
 rcer_iot_client_pkg/libs/sharepoint_client/__init__.py,sha256=v7h-cNsK-BaPp-hTU3NWRNXYRD9ztU-hsCk0eNRPIKA,334
-rcer_iot_client_pkg/libs/sharepoint_client/clients/sharepoint_rest_api.py,sha256=e0f4F8_Elt-y8dgxLqviQUy8PR8E2Qn60ecP0v78VQM,5269
+rcer_iot_client_pkg/libs/sharepoint_client/clients/sharepoint_rest_api.py,sha256=Jxa8ZODVHVMdIwTCcE1tNS7z2JJDPMbgSshLvQ7H0Uk,5430
 rcer_iot_client_pkg/libs/sharepoint_client/sharepoint_client.py,sha256=UYfAhckzmal5-Jjvbz0P4gt64w5gOYJYksVSHXdJPiQ,1234
 rcer_iot_client_pkg/libs/sharepoint_client/sharepoint_client_contract.py,sha256=xqNHzCjp7GvUGGUox9YTJj2QJgTc5819t2etOk8X26o,485
 rcer_iot_client_pkg/libs/sharepoint_client/types/sharepoint_client_types.py,sha256=gfXhvKuqZjxSdbgbEgGF1EKYDDq7CjK9Tdth-Waq5xo,414
@@ -33,13 +26,13 @@ rcer_iot_client_pkg/services/epii/constants/update_thies_data_constants.py,sha25
 rcer_iot_client_pkg/services/epii/controllers/__init__.py,sha256=mCdGgKGDgGxCtRoiZN9Rki-fTOyOuJWw9e7festpQYA,98
 rcer_iot_client_pkg/services/epii/controllers/types/__init__.py,sha256=xzky-oTSojLNkWETp_k8a4dcXYvYSQY0VhWo23Yhb8U,195
 rcer_iot_client_pkg/services/epii/controllers/types/update_thies_data_types.py,sha256=M5rYsjgqTndhPIRi77McxLyTrjmGsoVUIAGPETNXz9U,374
-rcer_iot_client_pkg/services/epii/controllers/update_thies_data.py,sha256=Suxehwi1onUsc2rWGbzO1vBsBp0RfgCp6FUqe-lrY20,4054
+rcer_iot_client_pkg/services/epii/controllers/update_thies_data.py,sha256=YWoXXNVaddCt8D_rTb8cU7gYR6l1VNwrjtldbqLIQ3A,4060
 rcer_iot_client_pkg/services/epii/use_cases/types/__init__.py,sha256=u6fyodOEJE2j6FMqJux40Xf9ccYAi-UUYxqT-Kzc0kE,199
 rcer_iot_client_pkg/services/epii/use_cases/types/update_thies_data_types.py,sha256=C0TU50KKYodpaX87OnG0MnHyGY4gRzmluUHk-esCEVU,635
 rcer_iot_client_pkg/services/epii/use_cases/update_thies_data.py,sha256=Tc12NUnZ0or2Tz5BA9jE62I5XxmKvZ__v4w5dTBk_5A,5052
 rcer_iot_client_pkg/services/epii/utils/__init__.py,sha256=cYt2tvq65_OMjFaqb8-CCC7IGCQgFd4ziEUWJV7s1iY,98
 rcer_iot_client_pkg/services/epii/utils/update_thies_data_utils.py,sha256=-q8t-xZmpwFDADGlDu0S7EKvZK7R0GUR6JqOxQShWgE,415
-rcer_iot_client_pkg-0.5.0.dist-info/LICENSE,sha256=NWpf6b38xgBWPBo5HZsCbdfp9hZSliEbRqWQgm0fkOo,1076
-rcer_iot_client_pkg-0.5.0.dist-info/METADATA,sha256=0gMjeJqGyVtA_p-VFp6DIYOyLROhFAatUDXGCT_Qw48,3483
-rcer_iot_client_pkg-0.5.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-rcer_iot_client_pkg-0.5.0.dist-info/RECORD,,
+rcer_iot_client_pkg-0.5.2.dist-info/LICENSE,sha256=NWpf6b38xgBWPBo5HZsCbdfp9hZSliEbRqWQgm0fkOo,1076
+rcer_iot_client_pkg-0.5.2.dist-info/METADATA,sha256=BWgFty5jiYYErS5W7KgoFumdMKUy6ZfciJ3r309PkzA,3860
+rcer_iot_client_pkg-0.5.2.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+rcer_iot_client_pkg-0.5.2.dist-info/RECORD,,

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/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/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/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/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/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