saviialib 1.0.0__tar.gz → 1.0.1__tar.gz

{saviialib-1.0.0 → saviialib-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: saviialib
-Version: 1.0.0
+Version: 1.0.1
 Summary: A client library for IoT projects in the RCER initiative
 License: MIT
 Author: pedropablozavalat

{saviialib-1.0.0 → saviialib-1.0.1}/pyproject.toml

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

saviialib-1.0.1/src/saviialib/libs/ftp_client/clients/ftplib_client.py

@@ -0,0 +1,58 @@
+import ftplib
+import asyncio
+from io import BytesIO
+from saviialib.libs.ftp_client.ftp_client_contract import (
+    FTPClientContract,
+)
+from saviialib.libs.ftp_client.types.ftp_client_types import (
+    FtpClientInitArgs,
+    FtpListFilesArgs,
+    FtpReadFileArgs,
+)
+
+
+class FtplibClient(FTPClientContract):
+    def __init__(self, args: FtpClientInitArgs) -> None:
+        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 = ftplib.FTP(host=self.host, user=self.user, passwd=self.password)
+
+    async def _async_start(self) -> None:
+        try:
+            await asyncio.to_thread(self.client.login, self.user, self.password)
+        except OSError:
+            raise ConnectionRefusedError(
+                f"{self.host}:{self.port} isn't active. "
+                "Please ensure the server is running and accessible."
+            )
+        except Exception as error:
+            raise ConnectionError(
+                f"General connection for {self.host}:{self.port}.", error.__str__()
+            )
+
+    async def list_files(self, args: FtpListFilesArgs) -> list[str]:
+        try:
+            EXCLUDED_NAMES = [".", ".."]
+            await self._async_start()
+            await asyncio.to_thread(self.client.cwd, args.path)
+            filenames = await asyncio.to_thread(self.client.nlst, args.path)
+            return [
+                filename for filename in filenames if filename not in EXCLUDED_NAMES
+            ]
+        except Exception as error:
+            raise ConnectionAbortedError(error)
+
+    async def read_file(self, args: FtpReadFileArgs) -> bytes:
+        await self._async_start()
+        try:
+            file_content = BytesIO()
+            await asyncio.to_thread(
+                self.client.retrbinary, "RETR " + args.file_path, file_content.write
+            )
+            await asyncio.to_thread(file_content.seek, 0)
+            file_bytes = await asyncio.to_thread(file_content.read)
+            return file_bytes
+        except Exception as error:
+            raise FileNotFoundError(f"File not found: {args.file_path}") from error

{saviialib-1.0.0 → saviialib-1.0.1}/src/saviialib/libs/ftp_client/ftp_client.py

@@ -1,10 +1,11 @@
 from .clients.aioftp_client import AioFTPClient
+from .clients.ftplib_client import FtplibClient
 from .ftp_client_contract import FTPClientContract
 from .types.ftp_client_types import FtpClientInitArgs, FtpListFilesArgs, FtpReadFileArgs
 
 
 class FTPClient(FTPClientContract):
-    CLIENTS = {"aioftp_client"}
+    CLIENTS = {"aioftp_client", "ftplib_client"}
 
     def __init__(self, args: FtpClientInitArgs) -> None:
         if args.client_name not in FTPClient.CLIENTS:
@@ -13,6 +14,8 @@ class FTPClient(FTPClientContract):
 
         if args.client_name == "aioftp_client":
             self.client_obj = AioFTPClient(args)
+        elif args.client_name == "ftplib_client":
+            self.client_obj = FtplibClient(args)
         self.client_name = args.client_name
 
     async def list_files(self, args: FtpListFilesArgs) -> list[str]:

{saviialib-1.0.0 → saviialib-1.0.1}/src/saviialib/libs/sharepoint_client/__init__.py

@@ -4,6 +4,7 @@ from .types.sharepoint_client_types import (
     SpListFilesArgs,
     SpListFoldersArgs,
     SpUploadFileArgs,
+    SpCreateFolderArgs,
 )
 
 __all__ = [
@@ -12,4 +13,5 @@ __all__ = [
     "SpListFilesArgs",
     "SpListFoldersArgs",
     "SpUploadFileArgs",
+    "SpCreateFolderArgs",
 ]

{saviialib-1.0.0 → saviialib-1.0.1}/src/saviialib/libs/sharepoint_client/clients/sharepoint_rest_api.py

@@ -1,5 +1,5 @@
 from typing import Any
-
+import json
 from aiohttp import ClientError, ClientSession
 from dotenv import load_dotenv
 
@@ -10,6 +10,7 @@ from saviialib.libs.sharepoint_client.types.sharepoint_client_types import (
     SpListFilesArgs,
     SpListFoldersArgs,
     SpUploadFileArgs,
+    SpCreateFolderArgs,
     SharepointClientInitArgs,
 )
 
@@ -134,3 +135,22 @@ class SharepointRestAPI(SharepointClientContract):
             return await response.json()
         except ClientError as error:
             raise ConnectionError(error) from error
+
+    async def create_folder(self, args: SpCreateFolderArgs):
+        try:
+            # Load form digest value
+            form_digest_value = await self._load_form_digest_value()
+            headers = {
+                **self.base_headers,
+                "X-RequestDigest": form_digest_value,
+            }
+            body = {"ServerRelativeUrl": f"{args.folder_relative_url}"}
+            endpoint = "web/folders"
+            response = await self.session.post(
+                endpoint.lstrip("/"), data=json.dumps(body), headers=headers
+            )
+            response.raise_for_status()
+            response_json = await response.json()
+            return response_json
+        except ClientError as error:
+            raise ConnectionError(error) from error

{saviialib-1.0.0 → saviialib-1.0.1}/src/saviialib/libs/sharepoint_client/sharepoint_client.py

@@ -5,6 +5,7 @@ from .types.sharepoint_client_types import (
     SpListFilesArgs,
     SpListFoldersArgs,
     SpUploadFileArgs,
+    SpCreateFolderArgs,
 )
 
 
@@ -52,3 +53,6 @@ class SharepointClient(SharepointClientContract):
 
     async def upload_file(self, args: SpUploadFileArgs) -> dict:
         return await self.client_obj.upload_file(args)
+
+    async def create_folder(self, args: SpCreateFolderArgs) -> dict:
+        return await self.client_obj.create_folder(args)

{saviialib-1.0.0 → saviialib-1.0.1}/src/saviialib/libs/sharepoint_client/sharepoint_client_contract.py

@@ -4,6 +4,7 @@ from .types.sharepoint_client_types import (
     SpListFilesArgs,
     SpListFoldersArgs,
     SpUploadFileArgs,
+    SpCreateFolderArgs,
 )
 
 
@@ -19,3 +20,7 @@ class SharepointClientContract(ABC):
     @abstractmethod
     async def upload_file(self, args: SpUploadFileArgs) -> dict:
         pass
+
+    @abstractmethod
+    async def create_folder(self, args: SpCreateFolderArgs) -> dict:
+        pass

{saviialib-1.0.0 → saviialib-1.0.1}/src/saviialib/libs/sharepoint_client/types/sharepoint_client_types.py

@@ -23,3 +23,8 @@ class SpUploadFileArgs:
     folder_relative_url: str
     file_name: str
     file_content: bytes = bytes()
+
+
+@dataclass
+class SpCreateFolderArgs:
+    folder_relative_url: str

{saviialib-1.0.0 → saviialib-1.0.1}/src/saviialib/libs/zero_dependency/utils/datetime_utils.py

@@ -2,7 +2,7 @@ from datetime import datetime
 from zoneinfo import ZoneInfo
 
 
-def today(timezone: str = "America/Santiago") -> str:
+def today(timezone: str = "America/Santiago") -> datetime:
     """
     Return the current date.
 

{saviialib-1.0.0 → saviialib-1.0.1}/src/saviialib/services/epii/use_cases/update_thies_data.py

@@ -59,7 +59,7 @@ class UpdateThiesDataUseCase:
     def _initialize_thies_ftp_client(self, config: FtpClientConfig) -> FTPClient:
         """Initialize the FTP client."""
         try:
-            return FTPClient(FtpClientInitArgs(config, client_name="aioftp_client"))
+            return FTPClient(FtpClientInitArgs(config, client_name="ftplib_client"))
         except RuntimeError as error:
             raise FtpClientError(error)
 

{saviialib-1.0.0 → saviialib-1.0.1}/src/saviialib/services/epii/use_cases/upload_backup_to_sharepoint.py

@@ -1,5 +1,6 @@
 import asyncio
 from time import time
+from saviialib.libs.zero_dependency.utils.datetime_utils import today, datetime_to_str
 from logging import Logger
 from saviialib.general_types.error_types.api.epii_api_error_types import (
     BackupEmptyError,
@@ -20,7 +21,7 @@ from saviialib.libs.sharepoint_client import (
     SharepointClient,
     SharepointClientInitArgs,
     SpUploadFileArgs,
-    SpListFoldersArgs,
+    SpCreateFolderArgs,
 )
 from saviialib.services.epii.utils.upload_backup_to_sharepoint_utils import (
     calculate_percentage_uploaded,
@@ -40,6 +41,7 @@ class UploadBackupToSharepointUsecase:
         self.sharepoint_config = input.sharepoint_config
         self.local_backup_source_path = input.local_backup_source_path
         self.sharepoint_destination_path = input.sharepoint_destination_path
+
         self.files_client = self._initialize_files_client()
         self.dir_client = self._initialize_directory_client()
         self.log_history = []
@@ -61,7 +63,28 @@ class UploadBackupToSharepointUsecase:
     def _initialize_files_client(self):
         return FilesClient(FilesClientInitArgs(client_name="aiofiles_client"))
 
+    async def _initialize_backup_base_folder(self):
+        local_backup_name = (
+            f"/local-backup-{datetime_to_str(today(), date_format='%m-%d-%Y')}"
+        )
+        local_backup_destination_path = (
+            self.sharepoint_destination_path + local_backup_name
+        )
+        async with self.sharepoint_client:
+            await self.sharepoint_client.create_folder(
+                SpCreateFolderArgs(folder_relative_url=local_backup_destination_path)
+            )
+        self.sharepoint_destination_path = local_backup_destination_path
+        base_folder_message = (
+            "[local_backup_lib] Creating base folder" + local_backup_name
+        )
+        self.logger.info(base_folder_message)
+        self.log_history.append(base_folder_message)
+
     async def _validate_backup_structure(self):
+        # Initialize the backup folder
+        await self._initialize_backup_base_folder()
+
         # Check if the local path exists in the main directory
         if not await self.dir_client.path_exists(self.local_backup_source_path):
             raise BackupSourcePathError(
@@ -74,20 +97,21 @@ class UploadBackupToSharepointUsecase:
             else []
         )
         async with self.sharepoint_client:  # type: ignore
-            response = await self.sharepoint_client.list_folders(
-                SpListFoldersArgs(folder_relative_url=self.sharepoint_destination_path)
-            )
-            sharepoint_directories = [x["Name"] for x in response["value"]]  # type: ignore
+            for local_dir in local_directories:
+                create_message = (
+                    f"[local_backup_lib] Creating a new directory '{local_dir}'."
+                )
 
-        # Verify that all local directories exist in SharePoint
-        for local_dir in local_directories:
-            if local_dir not in sharepoint_directories:
-                error_message = f"Folder '{local_dir}' does not exist in SharePoint destination path '{self.sharepoint_destination_path}'."
-                self.log_history.append(error_message)
-                self.logger.error("[local_backup_lib] %s", error_message)
-                raise BackupSourcePathError(
-                    reason=f"Folder '{local_dir}' does not exist in SharePoint destination path '{self.sharepoint_destination_path}'."
+                self.log_history.append(create_message)
+                await self.sharepoint_client.create_folder(
+                    SpCreateFolderArgs(
+                        folder_relative_url=self.sharepoint_destination_path
+                        + "/"
+                        + local_dir
+                    )
                 )
+                self.logger.info("[local_backup_lib] %s", create_message)
+                self.log_history.append(f"[local_backup_lib] {create_message}")
 
         # Check if the current folder only have files and each folder exist in Microsoft Sharepoint.
         if self.total_files == 0: