maleo-foundation 0.2.20__tar.gz → 0.2.21__tar.gz

{maleo_foundation-0.2.20 → maleo_foundation-0.2.21}/PKG-INFO

@@ -1,13 +1,16 @@
 Metadata-Version: 2.4
 Name: maleo_foundation
-Version: 0.2.20
+Version: 0.2.21
 Summary: Foundation package for Maleo
 Author-email: Agra Bima Yuda <agra@nexmedis.com>
 License: MIT
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+Requires-Dist: aiocache>=0.12.3
+Requires-Dist: aioredis>=2.0.1
 Requires-Dist: annotated-types>=0.7.0
 Requires-Dist: anyio>=4.9.0
+Requires-Dist: async-timeout>=5.0.1
 Requires-Dist: bcrypt>=4.3.0
 Requires-Dist: build>=1.2.2.post1
 Requires-Dist: cachetools>=5.5.2
@@ -25,6 +28,7 @@ Requires-Dist: google-cloud-appengine-logging>=1.6.1
 Requires-Dist: google-cloud-audit-log>=0.3.2
 Requires-Dist: google-cloud-core>=2.4.3
 Requires-Dist: google-cloud-logging>=3.12.0
+Requires-Dist: google-cloud-parametermanager>=0.1.3
 Requires-Dist: google-cloud-secret-manager>=2.23.3
 Requires-Dist: google-cloud-storage>=2.19.0
 Requires-Dist: google-crc32c>=1.7.1
@@ -66,6 +70,7 @@ Requires-Dist: pyproject_hooks>=1.2.0
 Requires-Dist: python-dotenv>=1.1.0
 Requires-Dist: PyYAML>=6.0.2
 Requires-Dist: readme_renderer>=44.0
+Requires-Dist: redis>=6.1.0
 Requires-Dist: requests>=2.32.3
 Requires-Dist: requests-toolbelt>=1.0.0
 Requires-Dist: rfc3986>=2.0.0

{maleo_foundation-0.2.20 → maleo_foundation-0.2.21}/maleo_foundation/enums.py

@@ -100,4 +100,23 @@ class BaseEnums:
         WARN = logging.WARN
         INFO = logging.INFO
         DEBUG = logging.DEBUG
-        NOTSET = logging.NOTSET
+        NOTSET = logging.NOTSET
+
+    class CacheType(StrEnum):
+        SERVICE = "service"
+        CLIENT = "client"
+
+    class CacheTTL(IntEnum):
+        TTL_15SC = int(15)
+        TTL_30SC = int(30)
+        TTL_1MN = int(1*60)
+        TTL_5MN = int(5*60)
+        TTL_10MN = int(10*60)
+        TTL_30MN = int(30*60)
+        TTL_1HR = int(1*60*60)
+        TTL_6HR = int(6*60*60)
+        TTL_12HR = int(12*60*60)
+        TTL_1DY = int(1*24*60*60)
+        TTL_7DY = int(7*24*60*60)
+        TTL_1WK = int(1*24*60*60)
+        TTL_7WK = int(7*24*60*60)

maleo_foundation-0.2.21/maleo_foundation/managers/cache/__init__.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+from pydantic import BaseModel, Field
+from redis.asyncio.client import Redis
+from .redis import RedisCacheConfigurations
+
+SKIP_CACHE_FUNC = lambda x: x is None
+
+class CacheConfigurations(BaseModel):
+    redis:RedisCacheConfigurations = Field(..., description="Redis cache's configurations")
+
+class CacheManagers(BaseModel):
+    redis:Redis = Field(..., description="Redis client")
+
+    class Config:
+        arbitrary_types_allowed=True

maleo_foundation-0.2.21/maleo_foundation/managers/cache/redis.py

@@ -0,0 +1,20 @@
+from pydantic import BaseModel, Field
+from typing import Union
+from maleo_foundation.types import BaseTypes
+from maleo_foundation.enums import BaseEnums
+
+class RedisCacheNamespaces(BaseModel):
+    base:str = Field(..., description="Base's redis namespace")
+
+    def create(self, type:BaseEnums.CacheType, *ext:str) -> str:
+        return "::".join([self.base, type, *ext])
+
+class RedisCacheConfigurations(BaseModel):
+    ttl:Union[int, float] = Field(BaseEnums.CacheTTL.TTL_5MN, description="Default TTL")
+    namespaces:RedisCacheNamespaces = Field(..., description="Redis cache's namepsaces")
+    host:str = Field(..., description="Redis instance's host")
+    port:int = Field(6379, description="Redis instance's port")
+    db:int = Field(0, description="Redis instance's db")
+    password:BaseTypes.OptionalString = Field(None, description="AUTH password")
+    decode_responses:bool = Field(False, description="Whether to decode responses")
+    health_check_interval:int = Field(30, description="Health check interval")

maleo_foundation-0.2.21/maleo_foundation/managers/client/google/parameter.py

@@ -0,0 +1,33 @@
+from google.api_core import retry
+from google.api_core.exceptions import NotFound
+from google.cloud import parametermanager
+from google.oauth2.service_account import Credentials
+from pathlib import Path
+from typing import Optional, Union
+from maleo_foundation.types import BaseTypes
+from maleo_foundation.utils.logging import SimpleConfig
+from .base import GoogleClientManager
+
+class GoogleParameterManager(GoogleClientManager):
+    def __init__(
+        self,
+        log_config:SimpleConfig,
+        service_key:BaseTypes.OptionalString=None,
+        credentials:Optional[Credentials]=None,
+        credentials_path:Optional[Union[Path, str]]=None
+    ) -> None:
+        key = "google-parameter-manager"
+        name = "GoogleParameterManager"
+        super().__init__(key, name, log_config, service_key, credentials, credentials_path)
+        self._client = parametermanager.ParameterManagerClient(credentials=self._credentials)
+        self._logger.info("Client manager initialized successfully")
+
+    @property
+    def client(self) -> parametermanager.ParameterManagerClient:
+        return self._client
+
+    def dispose(self) -> None:
+        if self._client is not None:
+            self._logger.info("Disposing client manager")
+            self._client = None
+            self._logger.info("Client manager disposed successfully")

{maleo_foundation-0.2.20 → maleo_foundation-0.2.21}/maleo_foundation/managers/service.py

@@ -4,6 +4,7 @@ from google.oauth2.service_account import Credentials
 from pathlib import Path
 from pydantic_settings import BaseSettings
 from pydantic import BaseModel, Field
+from redis.asyncio.client import Redis
 from starlette.exceptions import HTTPException
 from starlette.types import Lifespan, AppType
 from sqlalchemy import MetaData
@@ -15,6 +16,11 @@ from maleo_foundation.models.transfers.general.token \
     import MaleoFoundationTokenGeneralTransfers
 from maleo_foundation.models.transfers.parameters.token \
     import MaleoFoundationTokenParametersTransfers
+from maleo_foundation.managers.cache import CacheConfigurations, CacheManagers
+from maleo_foundation.managers.cache.redis import (
+    RedisCacheNamespaces,
+    RedisCacheConfigurations
+)
 from maleo_foundation.managers.db import DatabaseConfigurations, DatabaseManager
 from maleo_foundation.managers.client.google.secret import GoogleSecretManager
 from maleo_foundation.managers.client.google.storage import GoogleCloudStorage
@@ -114,6 +120,7 @@ class StaticConfigurations(BaseModel):
 class Configurations(BaseModel):
     service:ServiceConfigurations = Field(..., description="Service's configurations")
     middleware:MiddlewareConfigurations = Field(..., description="Middleware's configurations")
+    cache:CacheConfigurations = Field(..., description="Cache's configurations")
     database:DatabaseConfigurations = Field(..., description="Database's configurations")
     client:ClientConfigurations = Field(..., description="Client's configurations")
 
@@ -148,6 +155,7 @@ class ServiceManager:
         self._load_configs()
         self._load_keys()
         self._initialize_loggers()
+        self._initialize_cache()
         self._initialize_db()
         self._initialize_foundation()
 
@@ -234,6 +242,13 @@ class ServiceManager:
             runtime_configurations = YAMLLoader.load_from_string(data)
         runtime_configs = RuntimeConfigurations.model_validate(runtime_configurations)
 
+        #* Load redis cache configurations
+        namespaces = RedisCacheNamespaces(base=self._settings.SERVICE_KEY)
+        host = self._secret_manager.get(name=f"maleo-redis-host-{self._settings.ENVIRONMENT}")
+        password = self._secret_manager.get(name=f"maleo-redis-password-{self._settings.ENVIRONMENT}")
+        redis = RedisCacheConfigurations(namespaces=namespaces, host=host, password=password)
+        cache = CacheConfigurations(redis=redis)
+
         #* Load database configurations
         password = self._secret_manager.get(name=f"maleo-db-password-{self._settings.ENVIRONMENT}")
         host = self._secret_manager.get(name=f"maleo-db-host-{self._settings.ENVIRONMENT}")
@@ -247,6 +262,7 @@ class ServiceManager:
         merged_configs = BaseMergers.deep_merge(
             static_configs.model_dump(),
             runtime_configs.model_dump(exclude={"database"}),
+            {"cache": cache.model_dump()},
             {"database": database.model_dump()}
         )
         self._configs = Configurations.model_validate(merged_configs)
@@ -303,6 +319,25 @@ class ServiceManager:
     def loggers(self) -> Loggers:
         return self._loggers
 
+    def _initialize_cache(self) -> None:
+        self._redis = Redis(
+            host=self._configs.cache.redis.host,
+            port=self._configs.cache.redis.port,
+            db=self._configs.cache.redis.db,
+            password=self._configs.cache.redis.password,
+            decode_responses=self._configs.cache.redis.decode_responses,
+            health_check_interval=self._configs.cache.redis.health_check_interval
+        )
+        self._cache = CacheManagers(redis=self._redis)
+
+    @property
+    def redis(self) -> Redis:
+        return self._redis
+
+    @property
+    def cache(self) -> CacheManagers:
+        return self._cache
+
     def _initialize_db(self) -> None:
         self._database = DatabaseManager(
             metadata=self._db_metadata,

{maleo_foundation-0.2.20 → maleo_foundation-0.2.21}/maleo_foundation/models/transfers/results/service/__init__.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
 from .general import BaseServiceGeneralResultsTransfers
 from .query import BaseServiceQueryResultsTransfers
+from .repository import BaseServiceRepositoryResultsTransfers
 from .controllers import BaseServiceControllerResultsTransfers
 
 class BaseServiceResultsTransfers:
     General = BaseServiceGeneralResultsTransfers
     Query = BaseServiceQueryResultsTransfers
+    Repository = BaseServiceRepositoryResultsTransfers
     Controller = BaseServiceControllerResultsTransfers

maleo_foundation-0.2.21/maleo_foundation/models/transfers/results/service/repository.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+from pydantic import model_validator
+from maleo_foundation.models.schemas.general import BaseGeneralSchemas
+from maleo_foundation.models.schemas.result import BaseResultSchemas
+
+class BaseServiceRepositoryResultsTransfers:
+    class Row(
+        BaseGeneralSchemas.Status,
+        BaseGeneralSchemas.Timestamps,
+        BaseGeneralSchemas.Identifiers,
+        BaseResultSchemas.BaseRow
+    ): pass
+
+    class Fail(BaseResultSchemas.Fail): pass
+
+    class NotFound(BaseResultSchemas.NotFound): pass
+
+    class NoData(BaseResultSchemas.NoData): pass
+
+    class SingleData(BaseResultSchemas.SingleData):
+        data:BaseServiceRepositoryResultsTransfers.Row
+
+    class UnpaginatedMultipleData(BaseResultSchemas.UnpaginatedMultipleData):
+        data:list[BaseServiceRepositoryResultsTransfers.Row]
+
+    class PaginatedMultipleData(BaseResultSchemas.PaginatedMultipleData):
+        data:list[BaseServiceRepositoryResultsTransfers.Row]
+
+        @model_validator(mode="before")
+        @classmethod
+        def calculate_pagination(cls, values: dict) -> dict:
+            """Calculates pagination metadata before validation."""
+            total_data = values.get("total_data", 0)
+            data = values.get("data", [])
+
+            #* Get pagination values from inherited SimplePagination
+            page = values.get("page", 1)
+            limit = values.get("limit", 10)
+
+            #* Calculate total pages
+            total_pages = (total_data // limit) + (1 if total_data % limit > 0 else 0)
+
+            #* Assign computed pagination object before validation
+            values["pagination"] = BaseGeneralSchemas.ExtendedPagination(
+                page=page,
+                limit=limit,
+                data_count=len(data),
+                total_data=total_data,
+                total_pages=total_pages
+            )
+            return values

{maleo_foundation-0.2.20 → maleo_foundation-0.2.21}/maleo_foundation/utils/exceptions.py

@@ -1,7 +1,9 @@
+import asyncio
 from fastapi import Request, status
 from fastapi.exceptions import RequestValidationError
 from fastapi.responses import JSONResponse
 from functools import wraps
+from pydantic import ValidationError
 from starlette.exceptions import HTTPException as StarletteHTTPException
 from sqlalchemy.exc import SQLAlchemyError
 from typing import Optional
@@ -10,6 +12,8 @@ from maleo_foundation.models.transfers.results.service.general \
     import BaseServiceGeneralResultsTransfers
 from maleo_foundation.models.transfers.results.service.query \
     import BaseServiceQueryResultsTransfers
+from maleo_foundation.models.transfers.results.service.repository \
+    import BaseServiceRepositoryResultsTransfers
 from maleo_foundation.utils.logging import BaseLogger
 
 class BaseExceptions:
@@ -69,6 +73,75 @@ class BaseExceptions:
             return wrapper
         return decorator
 
+    @staticmethod
+    def repository_exception_handler(
+        operation:str,
+        logger:Optional[BaseLogger] = None,
+        fail_result_class:type[BaseServiceRepositoryResultsTransfers.Fail] = BaseServiceRepositoryResultsTransfers.Fail
+    ):
+        """Decorator to handle repository-related exceptions consistently for sync and async functions."""
+        def decorator(func):
+            def _handler(e:Exception, category:str, description:str):
+                if logger:
+                    logger.error(
+                        f"{category} occurred while {operation}: '{str(e)}'",
+                        exc_info=True
+                    )
+                return fail_result_class(
+                    message=f"Failed {operation}",
+                    description=description,
+                    other=category
+                )
+            if asyncio.iscoroutinefunction(func):
+                @wraps(func)
+                async def async_wrapper(*args, **kwargs):
+                    try:
+                        return await func(*args, **kwargs)
+                    except ValidationError as e:
+                        return _handler(
+                            e,
+                            category="Validation error",
+                            description=f"A validation error occurred while {operation}. Please try again later or contact administrator."
+                        )
+                    except SQLAlchemyError as e:
+                        return _handler(
+                            e,
+                            category="Database operation failed",
+                            description=f"A database error occurred while {operation}. Please try again later or contact administrator."
+                        )
+                    except Exception as e:
+                        return _handler(
+                            e,
+                            category="Internal processing error",
+                            description=f"An unexpected error occurred while {operation}. Please try again later or contact administrator."
+                        )
+                return async_wrapper
+            else:
+                @wraps(func)
+                def sync_wrapper(*args, **kwargs):
+                    try:
+                        return func(*args, **kwargs)
+                    except ValidationError as e:
+                        return _handler(
+                            e,
+                            category="Validation error",
+                            description=f"A validation error occurred while {operation}. Please try again later or contact administrator."
+                        )
+                    except SQLAlchemyError as e:
+                        return _handler(
+                            e,
+                            category="Database operation failed",
+                            description=f"A database error occurred while {operation}. Please try again later or contact administrator."
+                        )
+                    except Exception as e:
+                        return _handler(
+                            e,
+                            category="Internal processing error",
+                            description=f"An unexpected error occurred while {operation}. Please try again later or contact administrator."
+                        )
+                return sync_wrapper
+        return decorator
+
     @staticmethod
     def service_exception_handler(
         operation:str,

maleo_foundation-0.2.21/maleo_foundation/utils/repository.py

@@ -0,0 +1,61 @@
+import asyncio
+from functools import wraps
+from pydantic import ValidationError
+from typing import Optional, Type, Union
+from maleo_foundation.types import BaseTypes
+from maleo_foundation.models.transfers.results.service.repository import \
+    BaseServiceRepositoryResultsTransfers
+
+class BaseRepositoryUtils:
+    @staticmethod
+    def result_processor(
+        fail_class:Type[BaseServiceRepositoryResultsTransfers.Fail],
+        data_found_class:Union[
+            Type[BaseServiceRepositoryResultsTransfers.SingleData],
+            Type[BaseServiceRepositoryResultsTransfers.UnpaginatedMultipleData],
+            Type[BaseServiceRepositoryResultsTransfers.PaginatedMultipleData]
+        ],
+        no_data_class:Optional[Type[BaseServiceRepositoryResultsTransfers.NoData]] = None,
+    ):
+        """Decorator to handle repository-related exceptions consistently."""
+        def decorator(func):
+            def _processor(result:BaseTypes.StringToAnyDict):
+                if "success" not in result or "data" not in result:
+                    raise ValueError("Result did not have both 'success' and 'data' field")
+                success = result.get("success")
+                data = result.get("data")
+                if success is False:
+                    validated_result = fail_class.model_validate(result)
+                    return validated_result
+                if success is True:
+                    if data is None:
+                        if no_data_class is None:
+                            raise ValueError("'no_data_class' must be given to validate No Data")
+                        validated_result = no_data_class.model_validate(result)
+                        return validated_result
+                    else:
+                        validated_result = data_found_class.model_validate(result)
+                        return validated_result
+            if asyncio.iscoroutinefunction(func):
+                @wraps(func)
+                async def async_wrapper(*args, **kwargs):
+                    try:
+                        result:BaseTypes.StringToAnyDict = await func(*args, **kwargs)
+                        return _processor(result=result)
+                    except ValidationError as e:
+                        raise
+                    except Exception as e:
+                        raise
+                return async_wrapper
+            else:
+                @wraps(func)
+                def sync_wrapper(*args, **kwargs):
+                    try:
+                        result:BaseTypes.StringToAnyDict = func(*args, **kwargs)
+                        return _processor(result=result)
+                    except ValidationError as e:
+                        raise
+                    except Exception as e:
+                        raise
+                return sync_wrapper
+        return decorator

{maleo_foundation-0.2.20 → maleo_foundation-0.2.21}/maleo_foundation.egg-info/PKG-INFO

@@ -1,13 +1,16 @@
 Metadata-Version: 2.4
 Name: maleo_foundation
-Version: 0.2.20
+Version: 0.2.21
 Summary: Foundation package for Maleo
 Author-email: Agra Bima Yuda <agra@nexmedis.com>
 License: MIT
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+Requires-Dist: aiocache>=0.12.3
+Requires-Dist: aioredis>=2.0.1
 Requires-Dist: annotated-types>=0.7.0
 Requires-Dist: anyio>=4.9.0
+Requires-Dist: async-timeout>=5.0.1
 Requires-Dist: bcrypt>=4.3.0
 Requires-Dist: build>=1.2.2.post1
 Requires-Dist: cachetools>=5.5.2
@@ -25,6 +28,7 @@ Requires-Dist: google-cloud-appengine-logging>=1.6.1
 Requires-Dist: google-cloud-audit-log>=0.3.2
 Requires-Dist: google-cloud-core>=2.4.3
 Requires-Dist: google-cloud-logging>=3.12.0
+Requires-Dist: google-cloud-parametermanager>=0.1.3
 Requires-Dist: google-cloud-secret-manager>=2.23.3
 Requires-Dist: google-cloud-storage>=2.19.0
 Requires-Dist: google-crc32c>=1.7.1
@@ -66,6 +70,7 @@ Requires-Dist: pyproject_hooks>=1.2.0
 Requires-Dist: python-dotenv>=1.1.0
 Requires-Dist: PyYAML>=6.0.2
 Requires-Dist: readme_renderer>=44.0
+Requires-Dist: redis>=6.1.0
 Requires-Dist: requests>=2.32.3
 Requires-Dist: requests-toolbelt>=1.0.0
 Requires-Dist: rfc3986>=2.0.0

{maleo_foundation-0.2.20 → maleo_foundation-0.2.21}/maleo_foundation.egg-info/SOURCES.txt

@@ -41,11 +41,14 @@ maleo_foundation/managers/__init__.py
 maleo_foundation/managers/db.py
 maleo_foundation/managers/middleware.py
 maleo_foundation/managers/service.py
+maleo_foundation/managers/cache/__init__.py
+maleo_foundation/managers/cache/redis.py
 maleo_foundation/managers/client/__init__.py
 maleo_foundation/managers/client/base.py
 maleo_foundation/managers/client/maleo.py
 maleo_foundation/managers/client/google/__init__.py
 maleo_foundation/managers/client/google/base.py
+maleo_foundation/managers/client/google/parameter.py
 maleo_foundation/managers/client/google/secret.py
 maleo_foundation/managers/client/google/storage.py
 maleo_foundation/middlewares/authentication.py
@@ -97,6 +100,7 @@ maleo_foundation/models/transfers/results/encryption/rsa.py
 maleo_foundation/models/transfers/results/service/__init__.py
 maleo_foundation/models/transfers/results/service/general.py
 maleo_foundation/models/transfers/results/service/query.py
+maleo_foundation/models/transfers/results/service/repository.py
 maleo_foundation/models/transfers/results/service/controllers/__init__.py
 maleo_foundation/models/transfers/results/service/controllers/rest.py
 maleo_foundation/utils/__init__.py
@@ -106,6 +110,7 @@ maleo_foundation/utils/extractor.py
 maleo_foundation/utils/logging.py
 maleo_foundation/utils/mergers.py
 maleo_foundation/utils/query.py
+maleo_foundation/utils/repository.py
 maleo_foundation/utils/dependencies/__init__.py
 maleo_foundation/utils/dependencies/auth.py
 maleo_foundation/utils/formatter/__init__.py

{maleo_foundation-0.2.20 → maleo_foundation-0.2.21}/maleo_foundation.egg-info/requires.txt

@@ -1,5 +1,8 @@
+aiocache>=0.12.3
+aioredis>=2.0.1
 annotated-types>=0.7.0
 anyio>=4.9.0
+async-timeout>=5.0.1
 bcrypt>=4.3.0
 build>=1.2.2.post1
 cachetools>=5.5.2
@@ -17,6 +20,7 @@ google-cloud-appengine-logging>=1.6.1
 google-cloud-audit-log>=0.3.2
 google-cloud-core>=2.4.3
 google-cloud-logging>=3.12.0
+google-cloud-parametermanager>=0.1.3
 google-cloud-secret-manager>=2.23.3
 google-cloud-storage>=2.19.0
 google-crc32c>=1.7.1
@@ -58,6 +62,7 @@ pyproject_hooks>=1.2.0
 python-dotenv>=1.1.0
 PyYAML>=6.0.2
 readme_renderer>=44.0
+redis>=6.1.0
 requests>=2.32.3
 requests-toolbelt>=1.0.0
 rfc3986>=2.0.0

{maleo_foundation-0.2.20 → maleo_foundation-0.2.21}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maleo_foundation"
-version = "0.2.20"
+version = "0.2.21"
 description = "Foundation package for Maleo"
 authors = [
     { name = "Agra Bima Yuda", email = "agra@nexmedis.com" }
@@ -13,8 +13,11 @@ license = { text = "MIT" }
 readme = "README.md"
 requires-python = ">=3.7"
 dependencies = [
+    "aiocache>=0.12.3",
+    "aioredis>=2.0.1",
     "annotated-types>=0.7.0",
     "anyio>=4.9.0",
+    "async-timeout>=5.0.1",
     "bcrypt>=4.3.0",
     "build>=1.2.2.post1",
     "cachetools>=5.5.2",
@@ -32,6 +35,7 @@ dependencies = [
     "google-cloud-audit-log>=0.3.2",
     "google-cloud-core>=2.4.3",
     "google-cloud-logging>=3.12.0",
+    "google-cloud-parametermanager>=0.1.3",
     "google-cloud-secret-manager>=2.23.3",
     "google-cloud-storage>=2.19.0",
     "google-crc32c>=1.7.1",
@@ -73,6 +77,7 @@ dependencies = [
     "python-dotenv>=1.1.0",
     "PyYAML>=6.0.2",
     "readme_renderer>=44.0",
+    "redis>=6.1.0",
     "requests>=2.32.3",
     "requests-toolbelt>=1.0.0",
     "rfc3986>=2.0.0",