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

rcer_iot_client_pkg/__init__.py

@@ -4,6 +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
+from .general_types.api.update_thies_data_types import EpiiUpdateThiesConfig
 
-__all__ = ["EpiiAPI", "EpiiAPIConfig"]
+__all__ = ["EpiiAPI", "EpiiUpdateThiesConfig"]

rcer_iot_client_pkg/general_types/api/__init__.py

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

rcer_iot_client_pkg/general_types/api/update_thies_data_types.py

@@ -2,7 +2,7 @@ from dataclasses import dataclass
 
 
 @dataclass
-class EpiiAPIConfig:
+class EpiiUpdateThiesConfig:
     """
     Configuration for Epii API.
 
@@ -16,6 +16,7 @@ class EpiiAPIConfig:
         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.
+        logger (Logger): Logger object for logging during synchronisation of files from THIES Data Logger
     """
 
     ftp_port: int

rcer_iot_client_pkg/general_types/error_types/api/update_thies_data_error_types.py

@@ -41,3 +41,17 @@ class SharePointFetchingError(Exception):
 
         except json.decoder.JSONDecodeError:
             return 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__()
+        )

rcer_iot_client_pkg/libs/sharepoint_client/clients/sharepoint_rest_api.py

@@ -1,4 +1,3 @@
-import os
 from typing import Any
 
 from aiohttp import ClientError, ClientSession
@@ -125,12 +124,9 @@ class SharepointRestAPI(SharepointClientContract):
             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()
+            data = args.file_content
 
-            endpoint = f"web/{folder_relative_url}/Files/add(url='{source_file_path}',overwrite=false)"
+            endpoint = f"web/{folder_relative_url}/Files/add(url='{args.file_name}',overwrite=true)"
             response = await self.session.post(endpoint, data=data, headers=headers)
 
             response.raise_for_status()

rcer_iot_client_pkg/libs/sharepoint_client/sharepoint_client.py

@@ -28,7 +28,7 @@ class SharepointClient(SharepointClientContract):
         return await self.client_obj.list_files(args)
 
     async def list_folders(self, args: SpListFoldersArgs) -> list:
-        return self.client_obj.list_files(args)
+        return await self.client_obj.list_files(args)
 
     async def upload_file(self, args: SpUploadFileArgs) -> dict:
-        return self.client_obj.upload_file(args)
+        return await self.client_obj.upload_file(args)

rcer_iot_client_pkg/libs/sharepoint_client/types/sharepoint_client_types.py

@@ -20,6 +20,6 @@ class SpListFoldersArgs:
 
 @dataclass
 class SpUploadFileArgs:
-    file_path: str
     folder_relative_url: str
+    file_name: str
     file_content: bytes = bytes()

rcer_iot_client_pkg/services/epii/api.py

@@ -2,7 +2,9 @@ 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
+from rcer_iot_client_pkg.general_types.api.update_thies_data_types import (
+    EpiiUpdateThiesConfig,
+)
 
 
 class EpiiAPI:
@@ -10,12 +12,12 @@ 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]:
+    async def update_thies_data(self, config: EpiiUpdateThiesConfig) -> 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.
+            config (EpiiUpdateThiesConfig): configuration class for FTP Server and Microsoft SharePoint credentials.
         Returns:
             response (dict): A dictionary representation of the API response.
         """

rcer_iot_client_pkg/services/epii/constants/update_thies_data_constants.py

@@ -1,4 +1,4 @@
-SHAREPOINT_BASE_URL = "/sites/uc365_CentrosyEstacionesRegionalesUC/Shared Documents/General/Test_Raspberry/THIES"
+SHAREPOINT_BASE_URL = "/sites/uc365_CentrosyEstacionesRegionalesUC/Shared%20Documents/General/Test_Raspberry/THIES"
 SHAREPOINT_THIES_FOLDERS = ["AVG", "EXT"]
 
 FTP_SERVER_PATH_AVG_FILES = "ftp/thies/BINFILES/ARCH_AV1"

rcer_iot_client_pkg/services/epii/controllers/types/update_thies_data_types.py

@@ -1,11 +1,13 @@
 from dataclasses import dataclass, field
 from typing import Dict
-from rcer_iot_client_pkg.general_types.api.update_thies_data_types import EpiiAPIConfig
+from rcer_iot_client_pkg.general_types.api.update_thies_data_types import (
+    EpiiUpdateThiesConfig,
+)
 
 
 @dataclass
 class UpdateThiesDataControllerInput:
-    config: EpiiAPIConfig
+    config: EpiiUpdateThiesConfig
 
 
 @dataclass

rcer_iot_client_pkg/services/epii/controllers/update_thies_data.py

@@ -4,6 +4,7 @@ from rcer_iot_client_pkg.general_types.error_types.api.update_thies_data_error_t
     SharePointFetchingError,
     ThiesConnectionError,
     ThiesFetchingError,
+    SharePointUploadError,
 )
 from rcer_iot_client_pkg.general_types.error_types.common.common_types import (
     EmptyDataError,
@@ -54,7 +55,7 @@ class UpdateThiesDataController:
             )
         except EmptyDataError:
             return UpdateThiesDataControllerOutput(
-                message="No files to upload", status=HTTPStatus.NO_CONTENT
+                message="No files to upload", status=HTTPStatus.NO_CONTENT.value
             )
 
         except (AttributeError, NameError, ValueError) as error:
@@ -84,6 +85,13 @@ class UpdateThiesDataController:
                 metadata={"error": error.__str__()},
             )
 
+        except SharePointUploadError as error:
+            return UpdateThiesDataControllerOutput(
+                message="An error oucrred while uploading files to RCER Cloud",
+                status=HTTPStatus.BAD_REQUEST.value,
+                metadata={"error": error.__str__()},
+            )
+
         except ThiesFetchingError as error:
             return UpdateThiesDataControllerOutput(
                 message="An error ocurred while retrieving file names from THIES FTP Server.",

rcer_iot_client_pkg/services/epii/use_cases/update_thies_data.py

@@ -3,6 +3,7 @@ from dotenv import load_dotenv
 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 (
     SharePointFetchingError,
+    SharePointUploadError,
     ThiesConnectionError,
     ThiesFetchingError,
 )
@@ -21,11 +22,12 @@ from rcer_iot_client_pkg.libs.sharepoint_client import (
     SharepointClient,
     SharepointClientInitArgs,
     SpListFilesArgs,
+    SpUploadFileArgs,
 )
 from rcer_iot_client_pkg.services.epii.use_cases.types import (
-    UpdateThiesDataUseCaseInput,
     FtpClientConfig,
     SharepointConfig,
+    UpdateThiesDataUseCaseInput,
 )
 from rcer_iot_client_pkg.services.epii.utils import (
     parse_execute_response,
@@ -109,13 +111,48 @@ class UpdateThiesDataUseCase:
                 content = await self.thies_ftp_client.read_file(
                     FtpReadFileArgs(file_path)
                 )
-                content_files[filename] = content
+                content_files[file] = content  # Save the file with its prefix
             return content_files
         except ConnectionRefusedError as error:
             raise ThiesConnectionError(reason=error)
         except ConnectionAbortedError as error:
             raise ThiesFetchingError(reason=error)
 
+    async def upload_thies_files_to_sharepoint(
+        self, files: dict
+    ) -> dict[str, list[str]]:
+        """Upload files to SharePoint and categorize the results."""
+        upload_results = {"failed_files": [], "overwritten_files": [], "new_files": []}
+
+        async with self.sharepoint_client:
+            for file, file_content in files.items():
+                try:
+                    folder, file_name = file.split("_", 1)
+                    args = SpUploadFileArgs(
+                        folder_relative_url=f"{c.SHAREPOINT_BASE_URL}/{folder}",
+                        file_content=file_content,
+                        file_name=file_name,
+                    )
+                    response = await self.sharepoint_client.upload_file(args)
+
+                    if response.get("Exists", False):
+                        upload_results["overwritten_files"].append(file)
+                    else:
+                        upload_results["new_files"].append(file)
+
+                except ConnectionError as error:
+                    upload_results["failed_files"].append(
+                        f"{file} (Error: {str(error)})"
+                    )
+
+        if upload_results["failed_files"]:
+            raise SharePointUploadError(
+                reason="Files failed to upload: "
+                + ", ".join(upload_results["failed_files"])
+            )
+
+        return upload_results
+
     async def execute(self) -> dict:
         """Synchronize data from the THIES Center to the cloud."""
         try:
@@ -126,10 +163,17 @@ class UpdateThiesDataUseCase:
             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(reason="No files to upload.")
 
-        thies_file_contents = await self.fetch_thies_file_content()
-        data = parse_execute_response(thies_file_contents)
-        return data
+        # Fetch the content of the files to be uploaded from THIES FTP Server
+        thies_fetched_files = await self.fetch_thies_file_content()
+
+        # Upload the fetched files to SharePoint and gather statistics
+        upload_statistics = await self.upload_thies_files_to_sharepoint(
+            thies_fetched_files
+        )
+
+        return parse_execute_response(thies_fetched_files, upload_statistics)

rcer_iot_client_pkg/services/epii/utils/update_thies_data_utils.py

@@ -7,12 +7,15 @@ from rcer_iot_client_pkg.libs.zero_dependency.utils.datetime_utils import (
 
 
 def parse_execute_response(
-    file_contents: dict[str, Any],
+    thies_fetched_files: dict[str, Any], upload_statistics: dict[str, Any]
 ) -> dict[str, dict[str, int | str]]:
     return {
-        filename: {
-            "size": len(data),
-            "date": datetime_to_str(today()),
-        }
-        for filename, data in file_contents.items()
+        **upload_statistics,
+        "processed_files": {
+            filename: {
+                "file_size": len(data),
+                "processed_date": datetime_to_str(today()),
+            }
+            for filename, data in thies_fetched_files.items()
+        },
     }

{rcer_iot_client_pkg-0.5.2.dist-info → rcer_iot_client_pkg-0.6.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rcer_iot_client_pkg
-Version: 0.5.2
+Version: 0.6.1
 Summary: A client library for IoT projects in the RCER initiative
 License: MIT
 Author: pedropablozavalat
@@ -19,8 +19,7 @@ Requires-Dist: pydantic (==2.11.3)
 Requires-Dist: pytest-cov (==6.1.1)
 Description-Content-Type: text/markdown
 
-# RCER IoT Client Library | `rcer_iot_client_pkg`
-
+# RCER IoT Client Package 
 
 ## Installation
 You can find the package on [PyPI](https://pypi.org/project/rcer-iot-client-pkg/). 
@@ -45,11 +44,11 @@ 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
+from rcer_iot_client_pkg import EpiiUpdateThiesConfig
 import asyncio
 
 async def update_thies_data():
-    config = EpiiAPIConfig(
+    config = EpiiUpdateThiesConfig(
         ftp_port=FTP_PORT,
         ftp_host=FTP_HOST,
         ftp_user=FTP_USER,

{rcer_iot_client_pkg-0.5.2.dist-info → rcer_iot_client_pkg-0.6.1.dist-info}/RECORD

@@ -1,10 +1,10 @@
-rcer_iot_client_pkg/__init__.py,sha256=ynL8ADM5u2SQTdGfqVLDWEu9bYQnp6znMCEXnhu5zRA,272
+rcer_iot_client_pkg/__init__.py,sha256=oQxns1FtAq7ubv9zqRt9yFWk-ksAQ5qp6DxEiGyWA7U,288
 rcer_iot_client_pkg/general_types/__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/api/__init__.py,sha256=Dmy5H7Mm4n-ewj3dC1wzM5o-379Ebeb9hnBOqq8M4IE,96
+rcer_iot_client_pkg/general_types/api/update_thies_data_types.py,sha256=1ZTjHSSfmhOp9wAHOMHfQxoibiNKN05PdpRrXUcd2JQ,1077
 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=Wl9zd7qM2KeZF-h28dqSd6L9N8azOEagD837zoBgpAc,1269
+rcer_iot_client_pkg/general_types/error_types/api/update_thies_data_error_types.py,sha256=YkbMXzg3B2fD-L-sh6f__6uZQ9nkvN6rUacchcPpJn8,1690
 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/ftp_client/__init__.py,sha256=dW2Yutgc7mJJJzgKLhWKXMgQ6KIWJYfFa1sGpjHH5xU,191
@@ -15,24 +15,24 @@ 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=Jxa8ZODVHVMdIwTCcE1tNS7z2JJDPMbgSshLvQ7H0Uk,5430
-rcer_iot_client_pkg/libs/sharepoint_client/sharepoint_client.py,sha256=UYfAhckzmal5-Jjvbz0P4gt64w5gOYJYksVSHXdJPiQ,1234
+rcer_iot_client_pkg/libs/sharepoint_client/clients/sharepoint_rest_api.py,sha256=4QvTvB6FDp9SdNmXLPvNAU4YkSaqU5TiSnK9LMUwk_c,5272
+rcer_iot_client_pkg/libs/sharepoint_client/sharepoint_client.py,sha256=lzzRk-5YzScNL15TzHp8dAcdhiAtRVCfY7L2GEqoccM,1246
 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
+rcer_iot_client_pkg/libs/sharepoint_client/types/sharepoint_client_types.py,sha256=OmPlCJ9rLrAFBeG6aDp5cxMiQ5BZlDyGVx5S4GN4aqg,414
 rcer_iot_client_pkg/libs/zero_dependency/utils/datetime_utils.py,sha256=kD38wC087H3jwTIgrntBajE55cR2ioo_ftPUHiyGs_M,751
 rcer_iot_client_pkg/services/epii/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rcer_iot_client_pkg/services/epii/api.py,sha256=imw7crOMCuGLztEf5MpfpdzWC9IBnvDZJ4N957wRcIE,1038
-rcer_iot_client_pkg/services/epii/constants/update_thies_data_constants.py,sha256=XeBNsQaTsc0mylQegB4Wf9ECIo0i1Fk-BurWm84WDqE,273
+rcer_iot_client_pkg/services/epii/api.py,sha256=bSZmn-jgAfPoE7dSy6Upp9-EKNndhGVSx_aSNEDSVJs,1071
+rcer_iot_client_pkg/services/epii/constants/update_thies_data_constants.py,sha256=38f2WKV-zBO9O-CV8mh3tW3MFMiaJrrv4_FfQiyHApc,275
 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=YWoXXNVaddCt8D_rTb8cU7gYR6l1VNwrjtldbqLIQ3A,4060
+rcer_iot_client_pkg/services/epii/controllers/types/update_thies_data_types.py,sha256=A9w_R4sQKiJOycFl15uucZsHoDjBNtegIuwZSbX775U,399
+rcer_iot_client_pkg/services/epii/controllers/update_thies_data.py,sha256=NOaVcB-GynY1bkz2o04iDtSK7kKX-hxvZSM4mfYocDs,4393
 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/use_cases/update_thies_data.py,sha256=su_aprLs7i4nvU_ItkDbn9Jl_VnfmwRDYws2kreG3No,6804
 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.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/services/epii/utils/update_thies_data_utils.py,sha256=_OWoSBmuKJTlUbGxrOkjVK3AKxh90OaTprzywj3sPhI,565
+rcer_iot_client_pkg-0.6.1.dist-info/LICENSE,sha256=NWpf6b38xgBWPBo5HZsCbdfp9hZSliEbRqWQgm0fkOo,1076
+rcer_iot_client_pkg-0.6.1.dist-info/METADATA,sha256=Y7jdN73UjXR2g5yN9w_C8JA1tFHG6r0on4omXL5pG1o,3852
+rcer_iot_client_pkg-0.6.1.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+rcer_iot_client_pkg-0.6.1.dist-info/RECORD,,