maleo-foundation 0.3.9__py3-none-any.whl → 0.3.10__py3-none-any.whl

maleo_foundation/managers/configuration.py

@@ -26,7 +26,7 @@ class ConfigurationManager:
         self.settings = settings
         self.credential_manager = credential_manager
 
-        self._load_configs()
+        self._load_configurations()
 
     def _load_static_configurations(self) -> StaticConfigurations:
         config_path = Path(self.settings.STATIC_CONFIGURATIONS_PATH)
@@ -35,7 +35,7 @@ class ConfigurationManager:
             data = YAMLLoader.load_from_path(str(config_path))
         else:
             secret_data = self.credential_manager.secret_manager.get(
-                f"maleo-static-config-{self.settings.ENVIRONMENT}"
+                f"maleo-static-configurations-{self.settings.ENVIRONMENT}"
             )
             data = YAMLLoader.load_from_string(secret_data)
         
@@ -48,7 +48,7 @@ class ConfigurationManager:
             data = YAMLLoader.load_from_path(str(config_path))
         else:
             secret_data = self.credential_manager.secret_manager.get(
-                f"{self.settings.SERVICE_KEY}-runtime-config-{self.settings.ENVIRONMENT}"
+                f"{self.settings.SERVICE_KEY}-runtime-configurations-{self.settings.ENVIRONMENT}"
             )
             data = YAMLLoader.load_from_string(secret_data)
         
@@ -68,35 +68,20 @@ class ConfigurationManager:
             password=password
         )
         return CacheConfigurations(redis=redis)
-    
-    def _load_database_configurations(self, database_name: str) -> DatabaseConfigurations:
-        password = self.credential_manager.secret_manager.get(
-            f"maleo-db-password-{self.settings.ENVIRONMENT}"
-        )
-        host = self.credential_manager.secret_manager.get(
-            f"maleo-db-host-{self.settings.ENVIRONMENT}"
-        )
-        return DatabaseConfigurations(
-            password=password,
-            host=host,
-            database=database_name
-        )
 
-    def _load_configs(self) -> None:
-        static_configs = self._load_static_configurations()
-        runtime_configs = self._load_runtime_configurations()
-        cache_configs = self._load_cache_configurations()
-        database_configs = self._load_database_configurations(runtime_configs.database)
-        
-        merged_configs = deep_merge(
-            static_configs.model_dump(),
-            runtime_configs.model_dump(exclude={"database"}),
-            {"cache": cache_configs.model_dump()},
-            {"database": database_configs.model_dump()}
+    def _load_configurations(self) -> None:
+        static_configurations = self._load_static_configurations()
+        runtime_configurations = self._load_runtime_configurations()
+        cache_configurations = self._load_cache_configurations()
+
+        merged_configurations = deep_merge(
+            static_configurations.model_dump(),
+            runtime_configurations.model_dump(),
+            {"cache": cache_configurations.model_dump()}
         )
         
-        self._configs = Configurations.model_validate(merged_configs)
+        self._configurations = Configurations.model_validate(merged_configurations)
 
     @property
-    def configs(self) -> Configurations:
-        return self._configs
+    def configurations(self) -> Configurations:
+        return self._configurations

maleo_foundation/managers/service.py

@@ -50,12 +50,13 @@ class ServiceManager:
         if self._settings.ENVIRONMENT == "local":
             self._log_config.google_cloud_logging = None
 
-        #* Initialize Managers
+        #* Initialize Credential Manager
         self._credential_manager = CredentialManager(
             settings=self._settings,
             log_config=self._log_config
         )
 
+        #* Initialize Configuration Manager
         self._configuration_manager = ConfigurationManager(
             settings=self._settings,
             credential_manager=self._credential_manager
@@ -65,7 +66,7 @@ class ServiceManager:
         self._initialize_loggers()
         self._initialize_cache()
         self._initialize_cloud_storage()
-        self._initialize_db()
+        self._initialize_database()
         self._initialize_foundation()
 
     @property
@@ -89,8 +90,8 @@ class ServiceManager:
         return self._credential_manager.maleo_credentials
     
     @property
-    def configs(self) -> Configurations:
-        return self._configuration_manager.configs
+    def configurations(self) -> Configurations:
+        return self._configuration_manager.configurations
 
     def _load_keys(self) -> None:
         password = self.secret_manager.get(name="maleo-key-password")
@@ -110,22 +111,22 @@ class ServiceManager:
         #* Service's loggers
         application = ServiceLogger(
             type=BaseEnums.LoggerType.APPLICATION,
-            service_key=self.configs.service.key,
+            service_key=self.configurations.service.key,
             **self._log_config.model_dump()
         )
         database = ServiceLogger(
             type=BaseEnums.LoggerType.DATABASE,
-            service_key=self.configs.service.key,
+            service_key=self.configurations.service.key,
             **self._log_config.model_dump()
         )
         repository = ServiceLogger(
             type=BaseEnums.LoggerType.REPOSITORY,
-            service_key=self.configs.service.key,
+            service_key=self.configurations.service.key,
             **self._log_config.model_dump()
         )
         #* Middleware's logger
         middleware = MiddlewareLogger(
-            service_key=self.configs.service.key,
+            service_key=self.configurations.service.key,
             **self._log_config.model_dump()
         )
         self._loggers = Loggers(
@@ -141,12 +142,12 @@ class ServiceManager:
 
     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
+            host=self.configurations.cache.redis.host,
+            port=self.configurations.cache.redis.port,
+            db=self.configurations.cache.redis.db,
+            password=self.configurations.cache.redis.password,
+            decode_responses=self.configurations.cache.redis.decode_responses,
+            health_check_interval=self.configurations.cache.redis.health_check_interval
         )
         self._cache = CacheManagers(redis=self._redis)
 
@@ -185,11 +186,11 @@ class ServiceManager:
     def cloud_storage(self) -> GoogleCloudStorage:
         return self._cloud_storage
 
-    def _initialize_db(self) -> None:
+    def _initialize_database(self) -> None:
         self._database = DatabaseManager(
             metadata=self._db_metadata,
             logger=self._loggers.database,
-            url=self.configs.database.url
+            url=self.configurations.database.url
         )
 
     @property
@@ -233,9 +234,9 @@ class ServiceManager:
         lifespan: Optional[Lifespan[AppType]] = None
     ) -> FastAPI:
         self._loggers.application.info("Creating FastAPI application")
-        root_path = "" if self._settings.ENVIRONMENT == "local" else f"/{self.configs.service.key.removeprefix("maleo-")}"
+        root_path = "" if self._settings.ENVIRONMENT == "local" else f"/{self.configurations.service.key.removeprefix("maleo-")}"
         self._app = FastAPI(
-            title=self.configs.service.name,
+            title=self.configurations.service.name,
             lifespan=lifespan,
             root_path=root_path
         )
@@ -245,7 +246,7 @@ class ServiceManager:
         self._loggers.application.info("Configuring middlewares")
         self._middleware = MiddlewareManager(
             app=self._app,
-            configurations=self.configs.middleware,
+            configurations=self.configurations.middleware,
             keys=self._keys,
             logger=self._loggers.middleware,
             maleo_foundation=self._foundation

maleo_foundation/models/transfers/general/configurations/__init__.py

@@ -13,7 +13,7 @@ from .service import ServiceConfigurations
 class RuntimeConfigurations(BaseModel):
     service: ServiceConfigurations = Field(..., description="Service's configurations")
     middleware: MiddlewareRuntimeConfigurations = Field(..., description="Middleware's runtime configurations")
-    database: str = Field(..., description="Database's name")
+    database: DatabaseConfigurations = Field(..., description="Database's configurations")
 
     class Config:
         arbitrary_types_allowed=True

maleo_foundation/models/transfers/general/configurations/database.py

@@ -1,11 +1,13 @@
 from pydantic import BaseModel, Field
+from maleo_foundation.enums import BaseEnums
 
 class DatabaseConfigurations(BaseModel):
+    environment: BaseEnums.EnvironmentType = Field(..., description="Database's environment")
     username: str = Field("postgres", description="Database user's username")
     password: str = Field(..., description="Database user's password")
     host: str = Field(..., description="Database's host")
     port: int = Field(5432, description="Database's port")
-    database: str = Field(..., description="Database")
+    database: str = Field(..., description="Database's name")
 
     @property
     def url(self) -> str:

maleo_foundation/models/transfers/general/settings.py

@@ -1,6 +1,8 @@
 from pydantic_settings import BaseSettings
-from pydantic import Field
+from pydantic import Field, model_validator
+from typing import Self
 from maleo_foundation.enums import BaseEnums
+from maleo_foundation.types import BaseTypes
 
 class Settings(BaseSettings):
     ENVIRONMENT: BaseEnums.EnvironmentType = Field(..., description="Environment")
@@ -9,11 +11,67 @@ class Settings(BaseSettings):
         "/credentials/maleo-google-service-account.json",
         description="Internal credential's file path"
     )
-    STATIC_CONFIGURATIONS_PATH: str = Field(
-        "configs/static.yaml",
+    USE_LOCAL_STATIC_CONFIGURATIONS: bool = Field(
+        False,
+        description="Whether to use local static configurations"
+    )
+    STATIC_CONFIGURATIONS_PATH: BaseTypes.OptionalString = Field(
+        None,
         description="Maleo's static configurations path"
     )
-    RUNTIME_CONFIGURATIONS_PATH: str = Field(
-        "configs/runtime.yaml",
+    USE_LOCAL_RUNTIME_CONFIGURATIONS: bool = Field(
+        False,
+        description="Whether to use local runtime configurations"
+    )
+    RUNTIME_CONFIGURATIONS_PATH: BaseTypes.OptionalString = Field(
+        None,
         description="Service's runtime configurations path"
-    )
+    )
+
+    @classmethod
+    @model_validator(mode="before")
+    def define_configurations_path(
+        cls,
+        values: BaseTypes.StringToAnyDict
+    ) -> BaseTypes.StringToAnyDict:
+        # Define and check environment
+        environment: BaseTypes.OptionalString = values.get("ENVIRONMENT", None)
+        if environment is None:
+            raise ValueError("'ENVIRONMENT' variable not defined/found")
+
+        # Define and check service key
+        service_key: BaseTypes.OptionalString = values.get("SERVICE_KEY", None)
+        if service_key is None:
+            raise ValueError("'SERVICE_KEY' variable not defined/found")
+
+        # Define and check use local static configurations
+        use_local_static_configurations: BaseTypes.OptionalBoolean = values.get("USE_LOCAL_STATIC_CONFIGURATIONS", None)
+        if use_local_static_configurations is None:
+            raise ValueError("'USE_LOCAL_STATIC_CONFIGURATIONS' variable not defined/found")
+
+        # Define static configurations path if necessary
+        static_configurations_path: BaseTypes.OptionalString = values.get("STATIC_CONFIGURATIONS_PATH", None)
+        if use_local_static_configurations and static_configurations_path is None:
+            values["STATIC_CONFIGURATIONS_PATH"] = f"/configurations/maleo-static-configurations-{environment}"
+
+        # Define and check use local runtime configurations
+        use_local_runtime_configurations: BaseTypes.OptionalBoolean = values.get("USE_LOCAL_RUNTIME_CONFIGURATIONS", None)
+        if use_local_runtime_configurations is None:
+            raise ValueError("'USE_LOCAL_RUNTIME_CONFIGURATIONS' variable not defined/found")
+
+        # Define runtime configurations path if necessary
+        runtime_configurations_path: BaseTypes.OptionalString = values.get("RUNTIME_CONFIGURATIONS_PATH", None)
+        if use_local_runtime_configurations and runtime_configurations_path is None:
+            values["RUNTIME_CONFIGURATIONS_PATH"] = f"/configurations/{service_key}-runtime-configurations-{environment}"
+
+        return values
+
+    @model_validator(mode="after")
+    def validate_configurations_path(self) -> Self:
+        if self.USE_LOCAL_STATIC_CONFIGURATIONS and self.STATIC_CONFIGURATIONS_PATH is None:
+            raise ValueError("Static configurations path must exist if use local static configurations is set to true")
+        
+        if self.USE_LOCAL_RUNTIME_CONFIGURATIONS and self.RUNTIME_CONFIGURATIONS_PATH is None:
+            raise ValueError("Runtime configurations path must exist if use local runtime configurations is set to true")
+
+        return self

{maleo_foundation-0.3.9.dist-info → maleo_foundation-0.3.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maleo_foundation
-Version: 0.3.9
+Version: 0.3.10
 Summary: Foundation package for Maleo
 Author-email: Agra Bima Yuda <agra@nexmedis.com>
 License: MIT

{maleo_foundation-0.3.9.dist-info → maleo_foundation-0.3.10.dist-info}/RECORD

@@ -33,11 +33,11 @@ maleo_foundation/expanded_types/encryption/aes.py,sha256=1rj43qjIO0TePpr1mErT_NJ
 maleo_foundation/expanded_types/encryption/rsa.py,sha256=Esf_H8nMz2kOLAWa3M7dlD-sFdFIZylNjB_qB20Yaww,488
 maleo_foundation/managers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maleo_foundation/managers/cache.py,sha256=91IvQGCXC3QkhB61m6qLDMaRykmMYOwzMgrSOodfY1A,257
-maleo_foundation/managers/configuration.py,sha256=hffeNqAuqRTPVv7ZBT7jOC95blfgn5fNCxFPZnl-WSQ,3980
+maleo_foundation/managers/configuration.py,sha256=JPXgxNVBO_i7Znqwa36uMMXLU9LBDldvak-jKoP75W0,3420
 maleo_foundation/managers/credential.py,sha256=pTsd1sPFw64cOfSffqsdJFkVfsciqxjAvvt6RZJCkDY,3116
 maleo_foundation/managers/db.py,sha256=y5oP3bTXKeXYKqng-E_HZ-3wC0ZPtl5bls0AEEej6zM,6050
 maleo_foundation/managers/middleware.py,sha256=ecTNloglV67xoC_hqIEMIxhfQwzXRKHLI3ThJdd-lbY,2480
-maleo_foundation/managers/service.py,sha256=1YrVqYGdC1bY8mZxHraa4uq43PB2LzHem8dYAzkKTWg,10681
+maleo_foundation/managers/service.py,sha256=1rqxXMJ9E-pla0LuhKZ83JS4boTnUhiXxn1EbzYQlWA,10859
 maleo_foundation/managers/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maleo_foundation/managers/client/base.py,sha256=j5_CsToA_7nn_2mP9TWWz7qKalXSWqxfKY_9gTNGJJA,4282
 maleo_foundation/managers/client/maleo.py,sha256=JCbuIWu5gW--o7H8xvWtSNb_Of3d05FKLRTcvDciLfE,2662
@@ -68,11 +68,11 @@ maleo_foundation/models/transfers/general/credentials.py,sha256=kLS0ymFipQmL3QaA
 maleo_foundation/models/transfers/general/database.py,sha256=E3bWaMlvxIRrEGUT29AN5k42FNI5MnrmLq9rnEh0igE,2033
 maleo_foundation/models/transfers/general/key.py,sha256=S37SqD3qwTbgMk7785hW7Kl9d4Kouh4uPZcGoyMQ_-Q,755
 maleo_foundation/models/transfers/general/request.py,sha256=NTYFOmucc4bMfoocBeHGNLs6mbRdqXyVtp1_yDiv_Gg,4849
-maleo_foundation/models/transfers/general/settings.py,sha256=gR-IB-j137h2LkbHjjU43TWMtDt54VkvE75UPk9o590,734
+maleo_foundation/models/transfers/general/settings.py,sha256=bEvsbhlFi5DO2tS3OmxL2LAG3q1cesW3ceYsT5iGNsE,3702
 maleo_foundation/models/transfers/general/signature.py,sha256=J9xQy2HjpCQOnES7RJqsUnDgjFPuakQ1mxyfdTdstSE,297
 maleo_foundation/models/transfers/general/token.py,sha256=PU-_wLFaY2i8pwRi9-jlk4nh7XzoTKOk0BEsUCGbD80,4979
-maleo_foundation/models/transfers/general/configurations/__init__.py,sha256=-23Mm8_i_NRMagdNvGaL25pcscnmrXO-R7kAEgACkEI,1981
-maleo_foundation/models/transfers/general/configurations/database.py,sha256=7osPd5NTf8wYEevcPT_60yEAcC0W9-MrW4lSwLi8nqQ,544
+maleo_foundation/models/transfers/general/configurations/__init__.py,sha256=ZYXbqNkj-PHNuS8PsPtMB291s88K3wGi_PK2zJSeiX4,2010
+maleo_foundation/models/transfers/general/configurations/database.py,sha256=v-IzSm8kZa1TQByCc8dpIU-8csJN_G2irWeN4EClNlo,690
 maleo_foundation/models/transfers/general/configurations/middleware.py,sha256=1BulO00lb7Xe537--rD_11GFrUKS8YxWHx2RkWfHqtg,2292
 maleo_foundation/models/transfers/general/configurations/service.py,sha256=8lag1KXkS43IwsMGWka7L-peQ9YT1-dmWeEhQ1hnnLU,304
 maleo_foundation/models/transfers/general/configurations/cache/__init__.py,sha256=a7p5LWkQJlgcfKpdJrKnCfe1LUAnwltXwTOThANlR6s,286
@@ -134,7 +134,7 @@ maleo_foundation/utils/loaders/credential/__init__.py,sha256=qopTKvcMVoTFwyRijeg
 maleo_foundation/utils/loaders/credential/google.py,sha256=vmVObdAyXehb3L6ASOuUJ63mNvGPb9fiXSpdRndN-4A,6528
 maleo_foundation/utils/loaders/key/__init__.py,sha256=hVygcC2ImHc_aVrSrOmyedR8tMUZokWUKCKOSh5ctbo,106
 maleo_foundation/utils/loaders/key/rsa.py,sha256=gDhyX6iTFtHiluuhFCozaZ3pOLKU2Y9TlrNMK_GVyGU,3796
-maleo_foundation-0.3.9.dist-info/METADATA,sha256=_IEwOxUJRRKiWlKtJ45I4-5WOIJVeaskuX6kh3buuq4,3739
-maleo_foundation-0.3.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-maleo_foundation-0.3.9.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
-maleo_foundation-0.3.9.dist-info/RECORD,,
+maleo_foundation-0.3.10.dist-info/METADATA,sha256=WC7PtWk0jsVpJqU8rnErqEcam_3nsXaSmWG1YMcZf_0,3740
+maleo_foundation-0.3.10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+maleo_foundation-0.3.10.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
+maleo_foundation-0.3.10.dist-info/RECORD,,