maleo-foundation 0.1.35__py3-none-any.whl → 0.1.37__py3-none-any.whl

maleo_foundation/clients/google/cloud/secret.py

@@ -1,149 +0,0 @@
-import os
-from google.api_core import retry
-from google.api_core.exceptions import NotFound
-from google.auth import default
-from google.cloud import secretmanager
-from google.oauth2 import service_account
-from typing import Optional
-from .base import GoogleCloudClientManager
-
-class GoogleSecretManager:
-    _project:Optional[str] = None
-    _client:Optional[secretmanager.SecretManagerServiceClient] = None
-
-    @classmethod
-    def initialize(cls, project_id:Optional[str] = None) -> None:
-        """Initialize the cloud storage if not already initialized."""
-        cls._project = project_id or os.getenv("GCP_PROJECT_ID")
-        if cls._project is None:
-            raise ValueError("GCP_PROJECT_ID environment variable must be set if no project_id is provided")
-        if cls._client is None:
-            #* Setup credentials with fallback chain
-            credentials = None
-            credentials_file = os.getenv("GOOGLE_CREDENTIALS_PATH")
-            try:
-                if credentials_file:
-                    credentials = service_account.Credentials.from_service_account_file(credentials_file)
-                else:
-                    credentials, _ = default()
-            except Exception as e:
-                raise ValueError(f"Failed to initialize credentials: {str(e)}")
-
-            cls._client = secretmanager.SecretManagerServiceClient(credentials=credentials)
-
-    @classmethod
-    def dispose(cls):
-        """Disposes of the Google Secret Manager client"""
-        if cls._client is not None:
-            cls._client = None
-        if cls._project is not None:
-            cls._project = None
-
-    @classmethod
-    @retry.Retry(
-        predicate=retry.if_exception_type(Exception),
-        timeout=5
-    )
-    def get(
-        cls,
-        name:str,
-        version:str = "latest",
-    ) -> Optional[str]:
-        try:
-            secret_path = f"projects/{cls._project}/secrets/{name}/versions/{version}"
-            request = secretmanager.AccessSecretVersionRequest(name=secret_path)
-            response = cls._client.access_secret_version(request=request)
-            return response.payload.data.decode()
-        except Exception as e:
-            return None
-
-    @classmethod
-    @retry.Retry(
-        predicate=retry.if_exception_type(Exception),
-        timeout=5
-    )
-    def create(
-        cls,
-        name:str,
-        data:str
-    ) -> Optional[str]:
-        parent = f"projects/{cls._project}"
-        secret_path = f"{parent}/secrets/{name}"
-        try:
-            #* Check if the secret already exists
-            request = secretmanager.GetSecretRequest(name=secret_path)
-            cls._client.get_secret(request=request)
-
-        except NotFound:
-            #* Secret does not exist, create it first
-            try:
-                secret = secretmanager.Secret(name=name, replication={"automatic": {}})
-                request = secretmanager.CreateSecretRequest(parent=parent, secret_id=name, secret=secret)
-                cls._client.create_secret(request=request)
-            except Exception as e:
-                return None
-
-        #* Add a new secret version
-        try:
-            payload = secretmanager.SecretPayload(data=data.encode())  # ✅ Fixed attribute name
-            request = secretmanager.AddSecretVersionRequest(parent=secret_path, payload=payload)
-            response = cls._client.add_secret_version(request=request)
-            return data
-        except Exception as e:
-            return None
-
-class GoogleSecretManagerV2(GoogleCloudClientManager):
-    def __init__(self, google_credentials_path = None) -> None:
-        super().__init__(google_credentials_path)
-        self._project_id = self.credentials.project_id
-        self._client = secretmanager.SecretManagerServiceClient(credentials=self.credentials)
-
-    @property
-    def project_id(self):
-        return self._project_id
-
-    @property
-    def client(self) -> secretmanager.SecretManagerServiceClient:
-        return self._client
-
-    def dispose(self):
-        if self._client is not None:
-            self._client = None
-        return super().dispose()
-
-    @retry.Retry(predicate=retry.if_exception_type(Exception), timeout=5)
-    def get(self, name:str, version:str = "latest") -> Optional[str]:
-        try:
-            secret_path = f"projects/{self._project_id}/secrets/{name}/versions/{version}"
-            request = secretmanager.AccessSecretVersionRequest(name=secret_path)
-            response = self._client.access_secret_version(request=request)
-            return response.payload.data.decode()
-        except Exception as e:
-            return None
-
-    @retry.Retry(predicate=retry.if_exception_type(Exception), timeout=5)
-    def create(self, name:str, data:str) -> Optional[str]:
-        parent = f"projects/{self._project_id}"
-        secret_path = f"{parent}/secrets/{name}"
-        try:
-            #* Check if the secret already exists
-            request = secretmanager.GetSecretRequest(name=secret_path)
-            self._client.get_secret(request=request)
-
-        except NotFound:
-            #* Secret does not exist, create it first
-            try:
-                secret = secretmanager.Secret(name=name, replication={"automatic": {}})
-                request = secretmanager.CreateSecretRequest(parent=parent, secret_id=name, secret=secret)
-                self._client.create_secret(request=request)
-            except Exception as e:
-                return None
-
-        #* Add a new secret version
-        try:
-            payload = secretmanager.SecretPayload(data=data.encode())  # ✅ Fixed attribute name
-            request = secretmanager.AddSecretVersionRequest(parent=secret_path, payload=payload)
-            response = self._client.add_secret_version(request=request)
-            return data
-        except Exception as e:
-            return None

maleo_foundation/clients/google/cloud/storage.py

@@ -1,110 +0,0 @@
-import os
-from datetime import timedelta
-from google.auth import default
-from google.cloud.storage import Bucket, Client
-from google.oauth2 import service_account
-from typing import Optional
-from maleo_foundation.types import BaseTypes
-from .base import GoogleCloudClientManager
-
-class GoogleCloudStorage:
-    _client:Optional[Client] = None
-    _bucket:Optional[Bucket] = None
-
-    @classmethod
-    def initialize(cls) -> None:
-        """Initialize the cloud storage if not already initialized."""
-        if cls._client is None:
-            #* Setup credentials with fallback chain
-            credentials = None
-            credentials_file = os.getenv("GOOGLE_CREDENTIALS_PATH")
-            try:
-                if credentials_file:
-                    credentials = service_account.Credentials.from_service_account_file(credentials_file)
-                else:
-                    credentials, _ = default()
-            except Exception as e:
-                raise ValueError(f"Failed to initialize credentials: {str(e)}")
-
-            cls._client = Client(credentials=credentials)
-
-            #* Preload bucket
-            bucket_name = os.getenv("GCS_BUCKET_NAME")
-            if not bucket_name:
-                cls._client.close()
-                raise ValueError("GCS_BUCKET_NAME environment variable must be set")
-
-            #* Validate bucket existence
-            bucket = cls._client.lookup_bucket(bucket_name)
-            if bucket is None:
-                raise ValueError(f"Bucket '{bucket_name}' does not exist.")
-
-            cls._bucket = bucket
-
-    @classmethod
-    def dispose(cls) -> None:
-        """Dispose of the cloud storage and release any resources."""
-        if cls._client is not None:
-            cls._client.close()
-            cls._client = None
-            cls._bucket = None
-
-    @classmethod
-    def _get_client(cls) -> Client:
-        """Retrieve the cloud storage client, initializing it if necessary."""
-        cls.initialize()
-        return cls._client
-
-    @classmethod
-    def generate_signed_url(cls, location:str) -> str:
-        """
-        generate signed URL of a file in the bucket based on its location.
-
-        Args:
-            location: str
-                Location of the file inside the bucket
-
-        Returns:
-            str: File's pre-signed download url
-
-        Raises:
-            ValueError: If the file does not exist
-        """
-        cls.initialize()
-        blob = cls._bucket.blob(blob_name=location)
-        if not blob.exists():
-            raise ValueError(f"File '{location}' did not exists.")
-
-        url = blob.generate_signed_url(version="v4", expiration=timedelta(minutes=15), method="GET")
-        return url
-
-class GoogleCloudStorageV2(GoogleCloudClientManager):
-    def __init__(self, google_credentials_path = None, bucket_name:BaseTypes.OptionalString = None) -> None:
-        super().__init__(google_credentials_path)
-        self._client = Client(credentials=self._credentials)
-        self._bucket_name = bucket_name or os.getenv("GCS_BUCKET_NAME")
-        if self._bucket_name is None:
-            self._client.close()
-            raise ValueError("GCS_BUCKET_NAME environment variable must be set if 'bucket_name' is set to None")
-        self._bucket = self._client.lookup_bucket(bucket_name=self._bucket_name)
-        if self._bucket is None:
-            raise ValueError(f"Bucket '{self._bucket_name}' does not exist.")
-
-    @property
-    def client(self) -> Client:
-        return self._client
-
-    @property
-    def bucket_name(self) -> str:
-        return self._bucket_name
-
-    @property
-    def bucket(self) -> Bucket:
-        return self._bucket
-
-    def dispose(self):
-        if self._bucket is not None:
-            self._bucket = None
-        if self._client is not None:
-            self._client = None
-        return super().dispose()

maleo_foundation/clients/google/secret.py

@@ -1,61 +0,0 @@
-from google.api_core import retry
-from google.api_core.exceptions import NotFound
-from google.cloud import secretmanager
-from typing import Optional
-from .base import GoogleClientManager
-
-class GoogleSecretManager(GoogleClientManager):
-    def __init__(self, google_credentials_path = None) -> None:
-        super().__init__(google_credentials_path)
-        self._project_id = self.credentials.project_id
-        self._client = secretmanager.SecretManagerServiceClient(credentials=self.credentials)
-
-    @property
-    def project_id(self):
-        return self._project_id
-
-    @property
-    def client(self) -> secretmanager.SecretManagerServiceClient:
-        return self._client
-
-    def dispose(self):
-        if self._client is not None:
-            self._client = None
-        return super().dispose()
-
-    @retry.Retry(predicate=retry.if_exception_type(Exception), timeout=5)
-    def get(self, name:str, version:str = "latest") -> Optional[str]:
-        try:
-            secret_path = f"projects/{self._project_id}/secrets/{name}/versions/{version}"
-            request = secretmanager.AccessSecretVersionRequest(name=secret_path)
-            response = self._client.access_secret_version(request=request)
-            return response.payload.data.decode()
-        except Exception as e:
-            return None
-
-    @retry.Retry(predicate=retry.if_exception_type(Exception), timeout=5)
-    def create(self, name:str, data:str) -> Optional[str]:
-        parent = f"projects/{self._project_id}"
-        secret_path = f"{parent}/secrets/{name}"
-        try:
-            #* Check if the secret already exists
-            request = secretmanager.GetSecretRequest(name=secret_path)
-            self._client.get_secret(request=request)
-
-        except NotFound:
-            #* Secret does not exist, create it first
-            try:
-                secret = secretmanager.Secret(name=name, replication={"automatic": {}})
-                request = secretmanager.CreateSecretRequest(parent=parent, secret_id=name, secret=secret)
-                self._client.create_secret(request=request)
-            except Exception as e:
-                return None
-
-        #* Add a new secret version
-        try:
-            payload = secretmanager.SecretPayload(data=data.encode())
-            request = secretmanager.AddSecretVersionRequest(parent=secret_path, payload=payload)
-            response = self._client.add_secret_version(request=request)
-            return data
-        except Exception as e:
-            return None

maleo_foundation/clients/google/storage.py

@@ -1,57 +0,0 @@
-import os
-from datetime import timedelta
-from google.cloud.storage import Bucket, Client
-from maleo_foundation.types import BaseTypes
-from .base import GoogleClientManager
-
-class GoogleCloudStorage(GoogleClientManager):
-    def __init__(self, google_credentials_path = None, bucket_name:BaseTypes.OptionalString = None) -> None:
-        super().__init__(google_credentials_path)
-        self._client = Client(credentials=self._credentials)
-        self._bucket_name = bucket_name or os.getenv("GCS_BUCKET_NAME")
-        if self._bucket_name is None:
-            self._client.close()
-            raise ValueError("GCS_BUCKET_NAME environment variable must be set if 'bucket_name' is set to None")
-        self._bucket = self._client.lookup_bucket(bucket_name=self._bucket_name)
-        if self._bucket is None:
-            raise ValueError(f"Bucket '{self._bucket_name}' does not exist.")
-
-    @property
-    def client(self) -> Client:
-        return self._client
-
-    @property
-    def bucket_name(self) -> str:
-        return self._bucket_name
-
-    @property
-    def bucket(self) -> Bucket:
-        return self._bucket
-
-    def dispose(self):
-        if self._bucket is not None:
-            self._bucket = None
-        if self._client is not None:
-            self._client = None
-        return super().dispose()
-
-    def generate_signed_url(self, location:str) -> str:
-        """
-        generate signed URL of a file in the bucket based on its location.
-
-        Args:
-            location: str
-                Location of the file inside the bucket
-
-        Returns:
-            str: File's pre-signed download url
-
-        Raises:
-            ValueError: If the file does not exist
-        """
-        blob = self._bucket.blob(blob_name=location)
-        if not blob.exists():
-            raise ValueError(f"File '{location}' did not exists.")
-
-        url = blob.generate_signed_url(version="v4", expiration=timedelta(minutes=15), method="GET")
-        return url

maleo_foundation/clients/utils/__init__.py

@@ -1,5 +0,0 @@
-from __future__ import annotations
-from .logger import ClientLoggerManager
-
-class BaseClientUtils:
-    Logger = ClientLoggerManager

maleo_foundation/clients/utils/logger.py

@@ -1,54 +0,0 @@
-from typing import Dict
-from maleo_foundation.enums import BaseEnums
-from maleo_foundation.types import BaseTypes
-from maleo_foundation.utils.logger import BaseLogger
-
-class ClientLoggerManager:
-    _loggers:Dict[type, BaseLogger] = {}
-
-    @classmethod
-    def initialize(
-        cls,
-        base_dir:str,
-        client_name:str,
-        service_name:BaseTypes.OptionalString = None,
-        level:BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO
-    ) -> BaseLogger:
-        """Initialize client logger if not already initialized."""
-        if cls not in cls._loggers:
-            cls._loggers[cls] = BaseLogger(
-                base_dir=base_dir,
-                type=BaseEnums.LoggerType.CLIENT,
-                service_name=service_name,
-                client_name=client_name,
-                level=level
-            )
-        return cls._loggers[cls]
-
-    @classmethod
-    def get(cls) -> BaseLogger:
-        """Return client logger (if exist) or raise Runtime Error"""
-        if cls not in cls._loggers:
-            raise RuntimeError("Logger has not been initialized. Call 'initialize' first.")
-        return cls._loggers[cls]
-
-class MaleoFoundationLoggerManager(ClientLoggerManager):
-    @classmethod
-    def initialize(
-        cls,
-        base_dir:str,
-        service_name:BaseTypes.OptionalString = None,
-        level:BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO
-    ) -> BaseLogger:
-        """Initialize MaleoFoundation's client logger if not already initialized."""
-        return super().initialize(
-            base_dir=base_dir,
-            client_name="MaleoFoundation",
-            service_name=service_name,
-            level=level
-        )
-
-    @classmethod
-    def get(cls) -> BaseLogger:
-        """Return client logger (if exist) or raise Runtime Error"""
-        return super().get()

maleo_foundation/db/__init__.py

@@ -1,4 +0,0 @@
-from .table import BaseTable
-from .engine import EngineManager
-from .session import SessionManager
-from .manager import DatabaseManager

maleo_foundation/db/engine.py

@@ -1,76 +0,0 @@
-import os
-from sqlalchemy import create_engine, Engine
-from typing import Optional
-from maleo_foundation.types import BaseTypes
-from maleo_foundation.utils.logger import BaseLogger
-
-class EngineManager:
-    _logger:Optional[BaseLogger] = None
-    _engine:Optional[Engine] = None
-
-    @classmethod
-    def initialize(cls, logger:BaseLogger, url:Optional[str] = None) -> Engine:
-        """Initialize the engine if not already initialized."""
-        if cls._engine is None:
-            cls._logger = logger
-            url = url or os.getenv("DB_CONNECTION_STRING")
-            if url is None:
-                raise ValueError("DB_CONNECTION_STRING environment variable must be set if url is not provided")
-            cls._engine = create_engine(url=url, echo=False, pool_pre_ping=True, pool_recycle=3600)
-            cls._logger.info("EngineManager initialized successfully.")
-        return cls._engine
-
-    @classmethod
-    def get(cls) -> Engine:
-        """Retrieve the engine, initializing it if necessary."""
-        if cls._logger is None:
-            raise RuntimeError("Logger has not been initialized. Call initialize(db_connection_string, logger) first.")
-        if cls._engine is None:
-            raise RuntimeError("Engine has not been initialized. Call initialize(db_connection_string, logger) first.")
-
-        return cls._engine
-
-    @classmethod
-    def dispose(cls) -> None:
-        """Dispose of the engine and release any resources."""
-        if cls._engine is not None:
-            cls._engine.dispose()
-            cls._engine = None
-
-        cls._logger.info("Engine disposed successfully.")
-        cls._logger = None
-
-class EngineManagerV2:
-    _logger:Optional[BaseLogger] = None
-    _engine:Optional[Engine] = None
-
-    def __init__(self, logger:BaseLogger, url:BaseTypes.OptionalString = None):
-        """Initialize the engine manager."""
-        self._logger = logger
-        url = url or os.getenv("DB_CONNECTION_STRING")
-        if url is None:
-            raise ValueError("DB_CONNECTION_STRING environment variable must be set if url is not provided")
-        self._engine = create_engine(url=url, echo=False, pool_pre_ping=True, pool_recycle=3600)
-
-    @property
-    def logger(self) -> BaseLogger:
-        """Retrieve the logger."""
-        if self._logger is None:
-            raise RuntimeError("Logger has not been initialized. Call initialize(db_connection_string, logger) first.")
-        return self._logger
-
-    @property
-    def engine(self) -> Engine:
-        """Retrieve the engine."""
-        if self._engine is None:
-            raise RuntimeError("Engine has not been initialized. Call initialize(db_connection_string, logger) first.")
-        return self._engine
-
-    def dispose(self) -> None:
-        """Dispose of the engine and release any resources."""
-        if self._engine is not None:
-            self._engine.dispose()
-            self._engine = None
-
-        self._logger.info("Engine disposed successfully.")
-        self._logger = None

maleo_foundation/db/manager.py

@@ -1,122 +0,0 @@
-import os
-from contextlib import contextmanager
-from sqlalchemy import MetaData
-from sqlalchemy.engine import Engine, create_engine
-from sqlalchemy.exc import SQLAlchemyError
-from sqlalchemy.ext.declarative import DeclarativeMeta
-from sqlalchemy.orm import sessionmaker, Session, declarative_base
-from typing import Generator, Optional, Type
-from maleo_foundation.types import BaseTypes
-from maleo_foundation.utils.logger import BaseLogger
-from .table import BaseTable
-
-class DatabaseManager:
-    Base:DeclarativeMeta = declarative_base()  #* Correct way to define a declarative base
-
-    #* Explicitly define the type of metadata
-    metadata:MetaData = Base.metadata
-
-    @classmethod
-    def initialize(cls, engine:Engine):
-        """Creates the database tables if they do not exist."""
-        cls.metadata.create_all(engine)
-
-class MetadataManager:
-    _Base:DeclarativeMeta = declarative_base()
-
-    @property
-    def Base(self) -> DeclarativeMeta:
-        return self._Base
-
-    @property
-    def metadata(self) -> MetaData:
-        return self._Base.metadata
-
-class SessionManager:
-    def __init__(self, logger:BaseLogger, engine:Engine):
-        self._logger = logger
-        self._sessionmaker:sessionmaker[Session] = sessionmaker(bind=engine, expire_on_commit=False)
-        self._logger.info("SessionManager initialized successfully.")
-
-    def _session_handler(self) -> Generator[Session, None, None]:
-        """Reusable function for managing database sessions."""
-        if self._logger is None:
-            raise RuntimeError("Logger has not been initialized. Call initialize() first.")
-        if self._sessionmaker is None:
-            raise RuntimeError("SessionLocal has not been initialized. Call initialize() first.")
-
-        session = self._sessionmaker()
-        self._logger.debug("New database session created.")
-        try:
-            yield session  #* Provide session
-            session.commit()  #* Auto-commit on success
-        except SQLAlchemyError as e:
-            session.rollback()  #* Rollback on error
-            self._logger.error(f"[SQLAlchemyError] Database transaction failed: {e}", exc_info=True)
-            raise
-        except Exception as e:
-            session.rollback()  #* Rollback on error
-            self._logger.error(f"[Exception] Database transaction failed: {e}", exc_info=True)
-            raise
-        finally:
-            session.close()  #* Ensure session closes
-            self._logger.debug("Database session closed.")
-
-    def inject(self) -> Generator[Session, None, None]:
-        """Returns a generator that yields a SQLAlchemy session for dependency injection."""
-        return self._session_handler()
-
-    @contextmanager
-    def get(self) -> Generator[Session, None, None]:
-        """Context manager for manual session handling. Supports `with SessionManager.get() as session:`"""
-        yield from self._session_handler()
-
-    def dispose(self) -> None:
-        """Dispose of the sessionmaker and release any resources."""
-        if self._sessionmaker is not None:
-            self._sessionmaker.close_all()
-            self._sessionmaker = None
-
-        self._logger.info("SessionManager disposed successfully.")
-        self._logger = None
-
-class DatabaseManagerV2:
-    # _metadata:Optional[MetaData] = None
-    # _logger:Optional[BaseLogger] = None
-    # _engine:Optional[Engine] = None
-    # _session:Optional[SessionManager] = None
-
-    def __init__(
-        self,
-        metadata:MetaData,
-        logger:BaseLogger,
-        url:BaseTypes.OptionalString = None
-    ):
-        self._metadata = metadata #* Define database metadata
-        self._logger = logger #* Define database logger
-
-        #* Create engine
-        url = url or os.getenv("DB_URL")
-        if url is None:
-            raise ValueError("DB_URL environment variable must be set if url is not provided")
-        self._engine = create_engine(url=url, echo=False, pool_pre_ping=True, pool_recycle=3600)
-
-        self._metadata.create_all(bind=self._engine) #* Create all tables
-        self._session = SessionManager(logger=self._logger, engine=self._engine) #* Define session
-
-    def dispose(self) -> None:
-        #* Dispose session
-        if self._session is not None:
-            self._session.dispose()
-            self._session = None
-        #* Dispose engine
-        if self._engine is not None:
-            self._engine.dispose()
-            self._engine = None
-        #* Dispose logger
-        if self._logger is not None:
-            self._logger.dispose()
-            self._logger = None
-        #* Dispose metadata
-        if self._metadata is not None:
-            self._metadata = None