maleo-identity 0.0.43__py3-none-any.whl → 0.0.44__py3-none-any.whl

maleo_identity/client/controllers/http/organization.py

@@ -50,6 +50,36 @@ class MaleoIdentityOrganizationHTTPController(MaleoClientHTTPController):
             response = await client.get(url=url, params=params, auth=auth)
             return BaseClientHTTPControllerResults(response=response)
 
+    async def get_structured_organizations(
+        self,
+        parameters:MaleoIdentityOrganizationClientParametersTransfers.GetMultipleStructured
+    ) -> BaseClientHTTPControllerResults:
+        """Fetch structured organizations from MaleoIdentity"""
+        async with self._manager.get_client() as client:
+            #* Define URL
+            url = f"{self._manager.url.api}/v1/organizations/structured"
+
+            #* Parse parameters to query params
+            params = (
+                MaleoIdentityOrganizationClientParametersTransfers
+                .GetMultipleStructuredQuery
+                .model_validate(
+                    parameters.model_dump()
+                )
+                .model_dump(
+                    exclude={"sort_columns", "date_filters"},
+                    exclude_none=True
+                )
+            )
+
+            #* Create auth
+            token = self._service_manager.token
+            auth = BearerAuth(token=token) if token is not None else None
+
+            #* Send request and wait for response
+            response = await client.get(url=url, params=params, auth=auth)
+            return BaseClientHTTPControllerResults(response=response)
+
     async def get_organization(
         self,
         parameters:MaleoIdentityOrganizationGeneralParametersTransfers.GetSingle
@@ -77,6 +107,63 @@ class MaleoIdentityOrganizationHTTPController(MaleoClientHTTPController):
             response = await client.get(url=url, params=params, auth=auth)
             return BaseClientHTTPControllerResults(response=response)
 
+    async def get_structured_organization(
+        self,
+        parameters:MaleoIdentityOrganizationGeneralParametersTransfers.GetSingle
+    ) -> BaseClientHTTPControllerResults:
+        """Fetch structured organization from MaleoIdentity"""
+        async with self._manager.get_client() as client:
+            #* Define URL
+            url = f"{self._manager.url.api}/v1/organizations/{parameters.identifier}/{parameters.value}/structured"
+
+            #* Parse parameters to query params
+            params = (
+                MaleoIdentityOrganizationGeneralParametersTransfers
+                .GetSingleQuery
+                .model_validate(
+                    parameters.model_dump()
+                )
+                .model_dump(exclude_none=True)
+            )
+
+            #* Create auth
+            token = self._service_manager.token
+            auth = BearerAuth(token=token) if token is not None else None
+
+            #* Send request and wait for response
+            response = await client.get(url=url, params=params, auth=auth)
+            return BaseClientHTTPControllerResults(response=response)
+
+    async def get_organization_children(
+        self,
+        parameters:MaleoIdentityOrganizationClientParametersTransfers.GetMultipleChildren
+    ) -> BaseClientHTTPControllerResults:
+        """Fetch organization's children from MaleoIdentity"""
+        async with self._manager.get_client() as client:
+            #* Define URL
+            url = f"{self._manager.url.api}/v1/organizations/{parameters.organization_id}/children"
+
+            #* Parse parameters to query params
+            params = (
+                MaleoIdentityOrganizationClientParametersTransfers
+                .GetMultipleChildrenQuery
+                .model_validate(
+                    parameters.model_dump()
+                )
+                .model_dump(
+                    exclude={"sort_columns", "date_filters"},
+                    exclude_none=True
+                )
+            )
+
+            #* Create auth
+            token = self._service_manager.token
+            auth = BearerAuth(token=token) if token is not None else None
+
+            #* Send request and wait for response
+            response = await client.get(url=url, params=params, auth=auth)
+            return BaseClientHTTPControllerResults(response=response)
+
     async def create(
         self,
         parameters:MaleoIdentityOrganizationGeneralParametersTransfers.Create

maleo_identity/client/services/organization.py

@@ -72,13 +72,24 @@ class MaleoIdentityOrganizationClientService(MaleoClientService):
             no_data_class=MaleoIdentityOrganizationClientResultsTransfers.NoData
         )
         @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_1DY),
+            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
             namespace=self.service_manager.configs.cache.redis.namespaces.create(
                 "organization",
                 type=BaseEnums.CacheType.CLIENT,
                 base_override=self.key
             ),
             key_builder=BaseCacheConfigurations.key_builder,
+            skip_cache_func=lambda x: (
+                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+                or x is None
+                or (
+                    isinstance(x, dict)
+                    and (
+                        x.get("success") in [False, None]
+                        or (x.get("success") is True and x.get("data") is None)
+                    )
+                )
+            ),
             cache=Cache.REDIS,
             serializer=JsonSerializer(),
             endpoint=self.service_manager.configs.cache.redis.host,
@@ -142,6 +153,104 @@ class MaleoIdentityOrganizationClientService(MaleoClientService):
             controller_type=controller_type
         )
 
+    async def get_structured_organizations(
+        self,
+        parameters:MaleoIdentityOrganizationClientParametersTransfers.GetMultipleStructured,
+        controller_type:MaleoIdentityGeneralEnums.ClientControllerType = MaleoIdentityGeneralEnums.ClientControllerType.HTTP
+    ) -> MaleoIdentityOrganizationClientResultsTypes.GetMultipleStructured:
+        """Retrieve structured organizations from MaleoIdentity"""
+        @BaseExceptions.service_exception_handler(
+            operation="retrieving structured organizations",
+            logger=self._logger,
+            fail_result_class=MaleoIdentityOrganizationClientResultsTransfers.Fail
+        )
+        @BaseClientUtils.result_processor(
+            fail_class=MaleoIdentityOrganizationClientResultsTransfers.Fail,
+            data_found_class=MaleoIdentityOrganizationClientResultsTransfers.MultipleStructured,
+            no_data_class=MaleoIdentityOrganizationClientResultsTransfers.NoData
+        )
+        @cached(
+            ttl=int(BaseEnums.CacheTTL.TTL_1WK),
+            namespace=self.service_manager.configs.cache.redis.namespaces.create(
+                "organization",
+                type=BaseEnums.CacheType.CLIENT,
+                base_override=self.key
+            ),
+            key_builder=BaseCacheConfigurations.key_builder,
+            skip_cache_func=lambda x: (
+                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+                or x is None
+                or (
+                    isinstance(x, dict)
+                    and (
+                        x.get("success") in [False, None]
+                        or (x.get("success") is True and x.get("data") is None)
+                    )
+                )
+            ),
+            cache=Cache.REDIS,
+            serializer=JsonSerializer(),
+            endpoint=self.service_manager.configs.cache.redis.host,
+            port=self.service_manager.configs.cache.redis.port,
+            password=self.service_manager.configs.cache.redis.password,
+            db=self.service_manager.configs.cache.redis.db
+        )
+        async def _impl(
+            parameters:MaleoIdentityOrganizationClientParametersTransfers.GetMultipleStructured,
+            controller_type:MaleoIdentityGeneralEnums.ClientControllerType = MaleoIdentityGeneralEnums.ClientControllerType.HTTP
+        ):
+            #* Validate chosen controller type
+            if not isinstance(
+                controller_type,
+                MaleoIdentityGeneralEnums.ClientControllerType
+            ):
+                message = "Invalid controller type"
+                description = "The provided controller type did not exists"
+                return MaleoIdentityOrganizationClientResultsTransfers.Fail(
+                    message=message,
+                    description=description
+                )
+            #* Retrieve structured organizations using chosen controller
+            if controller_type == MaleoIdentityGeneralEnums.ClientControllerType.HTTP:
+                controller_result = (
+                    await self._controllers.http
+                    .get_structured_organizations(parameters=parameters)
+                )
+            else:
+                message = "Invalid controller type"
+                description = "The provided controller type has not been implemented"
+                return MaleoIdentityOrganizationClientResultsTransfers.Fail(
+                    message=message,
+                    description=description
+                )
+            #* Return proper response
+            if not controller_result.success:
+                return (
+                    MaleoIdentityOrganizationClientResultsTransfers
+                    .Fail
+                    .model_validate(controller_result.content)
+                    .model_dump(mode="json")
+                )
+            else:
+                if controller_result.content["data"] is None:
+                    return (
+                        MaleoIdentityOrganizationClientResultsTransfers
+                        .NoData
+                        .model_validate(controller_result.content)
+                        .model_dump(mode="json")
+                    )
+                else:
+                    return (
+                        MaleoIdentityOrganizationClientResultsTransfers
+                        .MultipleStructured
+                        .model_validate(controller_result.content)
+                        .model_dump(mode="json")
+                    )
+        return await _impl(
+            parameters=parameters,
+            controller_type=controller_type
+        )
+
     async def get_organization(
         self,
         parameters:MaleoIdentityOrganizationGeneralParametersTransfers.GetSingle,
@@ -158,13 +267,24 @@ class MaleoIdentityOrganizationClientService(MaleoClientService):
             data_found_class=MaleoIdentityOrganizationClientResultsTransfers.SingleData
         )
         @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_1DY),
+            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
             namespace=self.service_manager.configs.cache.redis.namespaces.create(
                 "organization",
                 type=BaseEnums.CacheType.CLIENT,
                 base_override=self.key
             ),
             key_builder=BaseCacheConfigurations.key_builder,
+            skip_cache_func=lambda x: (
+                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+                or x is None
+                or (
+                    isinstance(x, dict)
+                    and (
+                        x.get("success") in [False, None]
+                        or (x.get("success") is True and x.get("data") is None)
+                    )
+                )
+            ),
             cache=Cache.REDIS,
             serializer=JsonSerializer(),
             endpoint=self.service_manager.configs.cache.redis.host,
@@ -220,6 +340,192 @@ class MaleoIdentityOrganizationClientService(MaleoClientService):
             controller_type=controller_type
         )
 
+    async def get_structured_organization(
+        self,
+        parameters:MaleoIdentityOrganizationGeneralParametersTransfers.GetSingle,
+        controller_type:MaleoIdentityGeneralEnums.ClientControllerType = MaleoIdentityGeneralEnums.ClientControllerType.HTTP
+    ) -> MaleoIdentityOrganizationClientResultsTypes.GetSingleStructured:
+        """Retrieve structured organization from MaleoIdentity"""
+        @BaseExceptions.service_exception_handler(
+            operation="retrieving structured organization",
+            logger=self._logger,
+            fail_result_class=MaleoIdentityOrganizationClientResultsTransfers.Fail
+        )
+        @BaseClientUtils.result_processor(
+            fail_class=MaleoIdentityOrganizationClientResultsTransfers.Fail,
+            data_found_class=MaleoIdentityOrganizationClientResultsTransfers.SingleStructured
+        )
+        @cached(
+            ttl=int(BaseEnums.CacheTTL.TTL_1WK),
+            namespace=self.service_manager.configs.cache.redis.namespaces.create(
+                "organization",
+                type=BaseEnums.CacheType.CLIENT,
+                base_override=self.key
+            ),
+            key_builder=BaseCacheConfigurations.key_builder,
+            skip_cache_func=lambda x: (
+                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+                or x is None
+                or (
+                    isinstance(x, dict)
+                    and (
+                        x.get("success") in [False, None]
+                        or (x.get("success") is True and x.get("data") is None)
+                    )
+                )
+            ),
+            cache=Cache.REDIS,
+            serializer=JsonSerializer(),
+            endpoint=self.service_manager.configs.cache.redis.host,
+            port=self.service_manager.configs.cache.redis.port,
+            password=self.service_manager.configs.cache.redis.password,
+            db=self.service_manager.configs.cache.redis.db
+        )
+        async def _impl(
+            parameters:MaleoIdentityOrganizationGeneralParametersTransfers.GetSingle,
+            controller_type:MaleoIdentityGeneralEnums.ClientControllerType = MaleoIdentityGeneralEnums.ClientControllerType.HTTP
+        ):
+            #* Validate chosen controller type
+            if not isinstance(
+                controller_type,
+                MaleoIdentityGeneralEnums.ClientControllerType
+            ):
+                message = "Invalid controller type"
+                description = "The provided controller type did not exists"
+                return MaleoIdentityOrganizationClientResultsTransfers.Fail(
+                    message=message,
+                    description=description
+                )
+            #* Retrieve structured organization using chosen controller
+            if controller_type == MaleoIdentityGeneralEnums.ClientControllerType.HTTP:
+                controller_result = (
+                    await self._controllers.http
+                    .get_structured_organization(parameters=parameters)
+                )
+            else:
+                message = "Invalid controller type"
+                description = "The provided controller type has not been implemented"
+                return MaleoIdentityOrganizationClientResultsTransfers.Fail(
+                    message=message,
+                    description=description
+                )
+            #* Return proper response
+            if not controller_result.success:
+                return (
+                    MaleoIdentityOrganizationClientResultsTransfers
+                    .Fail
+                    .model_validate(controller_result.content)
+                    .model_dump(mode="json")
+                )
+            else:
+                return (
+                    MaleoIdentityOrganizationClientResultsTransfers
+                    .SingleStructured
+                    .model_validate(controller_result.content)
+                    .model_dump(mode="json")
+                )
+        return await _impl(
+            parameters=parameters,
+            controller_type=controller_type
+        )
+
+    async def get_organization_children(
+        self,
+        parameters:MaleoIdentityOrganizationClientParametersTransfers.GetMultipleChildren,
+        controller_type:MaleoIdentityGeneralEnums.ClientControllerType = MaleoIdentityGeneralEnums.ClientControllerType.HTTP
+    ) -> MaleoIdentityOrganizationClientResultsTypes.GetMultiple:
+        """Retrieve organization's children from MaleoIdentity"""
+        @BaseExceptions.service_exception_handler(
+            operation="retrieving organization's children",
+            logger=self._logger,
+            fail_result_class=MaleoIdentityOrganizationClientResultsTransfers.Fail
+        )
+        @BaseClientUtils.result_processor(
+            fail_class=MaleoIdentityOrganizationClientResultsTransfers.Fail,
+            data_found_class=MaleoIdentityOrganizationClientResultsTransfers.MultipleData
+        )
+        @cached(
+            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
+            namespace=self.service_manager.configs.cache.redis.namespaces.create(
+                "organization",
+                type=BaseEnums.CacheType.CLIENT,
+                base_override=self.key
+            ),
+            key_builder=BaseCacheConfigurations.key_builder,
+            skip_cache_func=lambda x: (
+                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+                or x is None
+                or (
+                    isinstance(x, dict)
+                    and (
+                        x.get("success") in [False, None]
+                        or (x.get("success") is True and x.get("data") is None)
+                    )
+                )
+            ),
+            cache=Cache.REDIS,
+            serializer=JsonSerializer(),
+            endpoint=self.service_manager.configs.cache.redis.host,
+            port=self.service_manager.configs.cache.redis.port,
+            password=self.service_manager.configs.cache.redis.password,
+            db=self.service_manager.configs.cache.redis.db
+        )
+        async def _impl(
+            parameters:MaleoIdentityOrganizationClientParametersTransfers.GetMultipleChildren,
+            controller_type:MaleoIdentityGeneralEnums.ClientControllerType = MaleoIdentityGeneralEnums.ClientControllerType.HTTP
+        ):
+            #* Validate chosen controller type
+            if not isinstance(
+                controller_type,
+                MaleoIdentityGeneralEnums.ClientControllerType
+            ):
+                message = "Invalid controller type"
+                description = "The provided controller type did not exists"
+                return MaleoIdentityOrganizationClientResultsTransfers.Fail(
+                    message=message,
+                    description=description
+                )
+            #* Retrieve organization's children using chosen controller
+            if controller_type == MaleoIdentityGeneralEnums.ClientControllerType.HTTP:
+                controller_result = (
+                    await self._controllers.http
+                    .get_organization_children(parameters=parameters)
+                )
+            else:
+                message = "Invalid controller type"
+                description = "The provided controller type has not been implemented"
+                return MaleoIdentityOrganizationClientResultsTransfers.Fail(
+                    message=message,
+                    description=description
+                )
+            #* Return proper response
+            if not controller_result.success:
+                return (
+                    MaleoIdentityOrganizationClientResultsTransfers
+                    .Fail
+                    .model_validate(controller_result.content)
+                    .model_dump(mode="json")
+                )
+            else:
+                if controller_result.content["data"] is None:
+                    return (
+                        MaleoIdentityOrganizationClientResultsTransfers
+                        .NoData
+                        .model_validate(controller_result.content)
+                        .model_dump(mode="json")
+                    )
+                else:
+                    return (
+                        MaleoIdentityOrganizationClientResultsTransfers
+                        .MultipleData
+                        .model_validate(controller_result.content)
+                        .model_dump(mode="json")
+                    )
+        return await _impl(
+            parameters=parameters,
+            controller_type=controller_type
+        )
+
     async def create(
         self,
         parameters:MaleoIdentityOrganizationGeneralParametersTransfers.Create,
@@ -351,13 +657,24 @@ class MaleoIdentityOrganizationClientService(MaleoClientService):
             no_data_class=MaleoIdentityUserOrganizationClientResultsTransfers.NoData
         )
         @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_1DY),
+            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
             namespace=self.service_manager.configs.cache.redis.namespaces.create(
                 "organization_user",
                 type=BaseEnums.CacheType.CLIENT,
                 base_override=self.key
             ),
             key_builder=BaseCacheConfigurations.key_builder,
+            skip_cache_func=lambda x: (
+                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+                or x is None
+                or (
+                    isinstance(x, dict)
+                    and (
+                        x.get("success") in [False, None]
+                        or (x.get("success") is True and x.get("data") is None)
+                    )
+                )
+            ),
             cache=Cache.REDIS,
             serializer=JsonSerializer(),
             endpoint=self.service_manager.configs.cache.redis.host,
@@ -437,13 +754,24 @@ class MaleoIdentityOrganizationClientService(MaleoClientService):
             data_found_class=MaleoIdentityUserOrganizationClientResultsTransfers.SingleData
         )
         @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_1DY),
+            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
             namespace=self.service_manager.configs.cache.redis.namespaces.create(
                 "user_organization",
                 type=BaseEnums.CacheType.CLIENT,
                 base_override=self.key
             ),
             key_builder=BaseCacheConfigurations.key_builder,
+            skip_cache_func=lambda x: (
+                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+                or x is None
+                or (
+                    isinstance(x, dict)
+                    and (
+                        x.get("success") in [False, None]
+                        or (x.get("success") is True and x.get("data") is None)
+                    )
+                )
+            ),
             cache=Cache.REDIS,
             serializer=JsonSerializer(),
             endpoint=self.service_manager.configs.cache.redis.host,
@@ -516,13 +844,24 @@ class MaleoIdentityOrganizationClientService(MaleoClientService):
             no_data_class=MaleoIdentityOrganizationRoleClientResultsTransfers.NoData
         )
         @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_1DY),
+            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
             namespace=self.service_manager.configs.cache.redis.namespaces.create(
                 "organization_role",
                 type=BaseEnums.CacheType.CLIENT,
                 base_override=self.key
             ),
             key_builder=BaseCacheConfigurations.key_builder,
+            skip_cache_func=lambda x: (
+                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+                or x is None
+                or (
+                    isinstance(x, dict)
+                    and (
+                        x.get("success") in [False, None]
+                        or (x.get("success") is True and x.get("data") is None)
+                    )
+                )
+            ),
             cache=Cache.REDIS,
             serializer=JsonSerializer(),
             endpoint=self.service_manager.configs.cache.redis.host,
@@ -602,13 +941,24 @@ class MaleoIdentityOrganizationClientService(MaleoClientService):
             data_found_class=MaleoIdentityOrganizationRoleClientResultsTransfers.SingleData
         )
         @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_1DY),
+            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
             namespace=self.service_manager.configs.cache.redis.namespaces.create(
                 "organization_role",
                 type=BaseEnums.CacheType.CLIENT,
                 base_override=self.key
             ),
             key_builder=BaseCacheConfigurations.key_builder,
+            skip_cache_func=lambda x: (
+                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+                or x is None
+                or (
+                    isinstance(x, dict)
+                    and (
+                        x.get("success") in [False, None]
+                        or (x.get("success") is True and x.get("data") is None)
+                    )
+                )
+            ),
             cache=Cache.REDIS,
             serializer=JsonSerializer(),
             endpoint=self.service_manager.configs.cache.redis.host,
@@ -681,13 +1031,24 @@ class MaleoIdentityOrganizationClientService(MaleoClientService):
             no_data_class=MaleoIdentityUserOrganizationRoleClientResultsTransfers.NoData
         )
         @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_1DY),
+            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
             namespace=self.service_manager.configs.cache.redis.namespaces.create(
                 "user_organization_role",
                 type=BaseEnums.CacheType.CLIENT,
                 base_override=self.key
             ),
             key_builder=BaseCacheConfigurations.key_builder,
+            skip_cache_func=lambda x: (
+                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+                or x is None
+                or (
+                    isinstance(x, dict)
+                    and (
+                        x.get("success") in [False, None]
+                        or (x.get("success") is True and x.get("data") is None)
+                    )
+                )
+            ),
             cache=Cache.REDIS,
             serializer=JsonSerializer(),
             endpoint=self.service_manager.configs.cache.redis.host,
@@ -767,13 +1128,24 @@ class MaleoIdentityOrganizationClientService(MaleoClientService):
             data_found_class=MaleoIdentityUserOrganizationRoleClientResultsTransfers.SingleData
         )
         @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_1DY),
+            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
             namespace=self.service_manager.configs.cache.redis.namespaces.create(
                 "user_organization_role",
                 type=BaseEnums.CacheType.CLIENT,
                 base_override=self.key
             ),
             key_builder=BaseCacheConfigurations.key_builder,
+            skip_cache_func=lambda x: (
+                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+                or x is None
+                or (
+                    isinstance(x, dict)
+                    and (
+                        x.get("success") in [False, None]
+                        or (x.get("success") is True and x.get("data") is None)
+                    )
+                )
+            ),
             cache=Cache.REDIS,
             serializer=JsonSerializer(),
             endpoint=self.service_manager.configs.cache.redis.host,