sharedkernel 2.6.3__tar.gz → 2.7.0__tar.gz

{sharedkernel-2.6.3 → sharedkernel-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sharedkernel
-Version: 2.6.3
+Version: 2.7.0
 Summary: sharekernel is a shared package between all python projects
 Author: Smilinno
 Description-Content-Type: text/markdown
@@ -20,7 +20,7 @@ Requires-Dist: markdown
 Requires-Dist: beautifulsoup4
 Requires-Dist: deepdiff
 Requires-Dist: kombu
-Requires-Dist: redis
+Requires-Dist: redis==8.0.0
 Dynamic: author
 Dynamic: description
 Dynamic: description-content-type
@@ -31,6 +31,10 @@ Dynamic: summary
 this is a shared kernel package
 
 # Change Log
+### Version 2.7.0
+- Add Redis and cache repository
+### Version 2.6.4
+- Add Verbose to log
 ### Version 2.6.3
 - fix bug ip-header-name
 ### Version 2.6.2

{sharedkernel-2.6.3 → sharedkernel-2.7.0}/README.md

@@ -2,6 +2,10 @@
 this is a shared kernel package
 
 # Change Log
+### Version 2.7.0
+- Add Redis and cache repository
+### Version 2.6.4
+- Add Verbose to log
 ### Version 2.6.3
 - fix bug ip-header-name
 ### Version 2.6.2

{sharedkernel-2.6.3 → sharedkernel-2.7.0}/setup.py

@@ -13,6 +13,7 @@ setup(
     packages=[
         "sharedkernel",
         "sharedkernel.database",
+        "sharedkernel.database.cache",
         "sharedkernel.enum",
         "sharedkernel.exception",
         "sharedkernel.objects",
@@ -37,10 +38,10 @@ setup(
         "beautifulsoup4",
         "deepdiff",
         "kombu",
-        "redis",
+        "redis==8.0.0",
     ],
     # *strongly* suggested for sharing
-    version="2.6.3",
+    version="2.7.0",
     description="sharekernel is a shared package between all python projects",
     long_description=long_description,
     long_description_content_type="text/markdown",

{sharedkernel-2.6.3 → sharedkernel-2.7.0}/sharedkernel/config.py

@@ -1,6 +1,7 @@
 import os
 
-VERBOSE = True if os.getenv("VERBOSE", "False").lower() == "true" else False
+IP_SESSION_VERBOSE = True if os.getenv("IP_SESSION_VERBOSE", "False").lower() == "true" else False
+LOG_VERBOSE = True if os.getenv("LOG_VERBOSE", "False").lower() == "true" else False
 
 # Log *******************************************************************************
 LOG_ENABLE = True if os.getenv("LOG_ENABLE", "False").lower() == "true" else False

sharedkernel-2.7.0/sharedkernel/database/cache/cache_repository.py

@@ -0,0 +1,37 @@
+
+from abc import ABC, abstractmethod
+from typing import Generic, Optional, TypeVar
+from pydantic import BaseModel
+
+T = TypeVar("T", bound=BaseModel)
+
+
+class CacheRepository(ABC, Generic[T]):
+    @abstractmethod
+    async def set(
+        self,
+        key: str,
+        value: T,
+        ttl_seconds: int | None = None,
+    ) -> None:
+        pass
+
+    @abstractmethod
+    async def get(self, key: str) -> Optional[T]:
+        pass
+
+    @abstractmethod
+    async def exists(self, key: str) -> bool:
+        pass
+
+    @abstractmethod
+    async def delete(self, key: str) -> int:
+        pass
+
+    @abstractmethod
+    async def delete_group(self, key_prefix: str) -> int:
+        pass
+
+    @abstractmethod
+    async def clear(self) -> int:
+        pass

sharedkernel-2.7.0/sharedkernel/database/cache/redis_generic_cache.py

@@ -0,0 +1,88 @@
+from typing import Generic, Optional, Type, TypeVar
+from pydantic import BaseModel
+from redis.asyncio import Redis
+
+from cache.cache_repository import CacheRepository
+
+T = TypeVar("T", bound=BaseModel)
+
+
+class RedisGenericCache(CacheRepository[T], Generic[T]):
+    def __init__(
+        self,
+        client: Redis,
+        namespace: str,
+        model: Type[T],
+        default_ttl_seconds: int | None = None,
+    ):
+        self.client = client
+        self.namespace = namespace
+        self.model = model
+        self.default_ttl_seconds = default_ttl_seconds
+
+    def _pref(self, key: str) -> str:
+        return f"{self.namespace}:{key}"
+
+    def _unpref(self, key: str) -> str:
+        prefix = f"{self.namespace}:"
+        return key.removeprefix(prefix)
+
+    def _serialize(self, value: T) -> str:
+        return value.model_dump_json()
+
+    def _deserialize(self, raw: str | bytes) -> T:
+        return self.model.model_validate_json(raw.decode())
+
+    async def set(
+        self,
+        key: str,
+        value: T,
+        ttl_seconds: int | None = None,
+    ) -> None:
+        if value is None:
+            return
+
+        redis_key = self._pref(key)
+        ttl = ttl_seconds if ttl_seconds else self.default_ttl_seconds
+
+        if ttl:
+            await self.client.set(redis_key, self._serialize(value), ex=ttl)
+        else:
+            await self.client.set(redis_key, self._serialize(value))
+
+    async def get(self, key: str) -> Optional[T]:
+        raw = await self.client.get(self._pref(key))
+        if raw is None:
+            return None
+        return self._deserialize(raw)
+
+    async def exists(self, key: str) -> bool:
+        return bool(await self.client.exists(self._pref(key)))
+
+    async def delete(self, key: str) -> int:
+        return await self.client.delete(self._pref(key))
+
+    async def delete_group(self, key_prefix: str) -> int:
+        pattern = self._pref(f"{key_prefix}*")
+        deleted = 0
+
+        async for key in self.client.scan_iter(match=pattern):
+            deleted += await self.client.delete(key)
+
+        return deleted
+
+    async def clear(self) -> int:
+        deleted = 0
+
+        async for key in self.client.scan_iter(match=f"{self.namespace}:*"):
+            deleted += await self.client.delete(key)
+
+        return deleted
+
+    async def get_all_ids(self) -> list[str]:
+        result: list[str] = []
+
+        async for raw in self.client.scan_iter(match=f"{self.namespace}:*"):
+            result.append(self._unpref(raw.decode()))
+
+        return result

{sharedkernel-2.6.3 → sharedkernel-2.7.0}/sharedkernel/ip_session_service.py

@@ -78,88 +78,89 @@ class IPSessionAuth:
     def ip_session_auth(self, request: Request):
 
         if not config.IP_SESSION_AUTH_ENABLE:
-            if config.VERBOSE:
+            if config.IP_SESSION_VERBOSE:
                 print("IP_SESSION_AUTH | OK | IP Session Auth is disabled")
             return
 
-        if config.VERBOSE:
-            print("IP_SESSION_AUTH | INFO | Request Headers: ", request.headers)
+        if config.IP_SESSION_VERBOSE:
+            print("="*70)
+            print("IP_SESSION_AUTH | INFO | Request Headers:\n", request.headers)
 
         api_key = request.headers.get(config.APIKEY_HEADER_NAME)
 
         if api_key:
-            if config.VERBOSE:
+            if config.IP_SESSION_VERBOSE:
                 print("IP_SESSION_AUTH | OK | API Key is provided")
             return
 
         state = getattr(request.state, "decoded_token", None)
-        if config.VERBOSE:
+        if config.IP_SESSION_VERBOSE:
             print("IP_SESSION_AUTH | INFO | State: ", state)
 
         if not state:
-            if config.VERBOSE:
+            if config.IP_SESSION_VERBOSE:
                 print("IP_SESSION_AUTH | ERROR | No state found")
             raise UnAuthorizedException()
 
         nameid = state.get("nameid")
         sessionid = state.get("sessionId")
-        if config.VERBOSE:
+        if config.IP_SESSION_VERBOSE:
             print("IP_SESSION_AUTH | INFO | Nameid: ", nameid)
             print("IP_SESSION_AUTH | INFO | Sessionid: ", sessionid)
 
         if not nameid or not sessionid:
-            if config.VERBOSE:
+            if config.IP_SESSION_VERBOSE:
                 print("IP_SESSION_AUTH | ERROR | No nameid or sessionid found")
             raise UnAuthorizedException()
 
         request_ip = self._get_ip_from_request(request, config.IP_HEADER_NAME)
 
         if not request_ip:
-            if config.VERBOSE:
+            if config.IP_SESSION_VERBOSE:
                 print("IP_SESSION_AUTH | ERROR | No request ip found")
             raise UnAuthorizedException()
 
         request_ip = request_ip.strip()
-        if config.VERBOSE:
+        if config.IP_SESSION_VERBOSE:
             print("IP_SESSION_AUTH | INFO | Request ip: ", request_ip)
 
         if self._is_ip_allowed(request_ip):
-            if config.VERBOSE:
+            if config.IP_SESSION_VERBOSE:
                 print("IP_SESSION_AUTH | OK | IP is in whitelist")
             return
 
         redis_key = f"userId:{nameid}:session:{sessionid}"
         user_data = self.redis.get(redis_key)
-        if config.VERBOSE:
+        if config.IP_SESSION_VERBOSE:
             print("IP_SESSION_AUTH | INFO | User data: ", user_data)
 
         if not user_data:
-            if config.VERBOSE:
+            if config.IP_SESSION_VERBOSE:
                 print("IP_SESSION_AUTH | ERROR | No user data found")
             raise UnAuthorizedException()
 
         try:
             payload = json.loads(user_data.decode())
         except (ValueError, UnicodeDecodeError, TypeError):
-            if config.VERBOSE:
+            if config.IP_SESSION_VERBOSE:
                 print("IP_SESSION_AUTH | ERROR | Error decoding user data")
             raise UnAuthorizedException()
 
         stored_ip = payload.get("Ip")
-        if config.VERBOSE:
+        if config.IP_SESSION_VERBOSE:
             print("IP_SESSION_AUTH | INFO | Stored ip: ", stored_ip)
             
         if not stored_ip:
-            if config.VERBOSE:
+            if config.IP_SESSION_VERBOSE:
                 print("IP_SESSION_AUTH | ERROR | No stored ip found")
             raise UnAuthorizedException()
 
         if stored_ip.strip() != request_ip:
-            if config.VERBOSE:
+            if config.IP_SESSION_VERBOSE:
                 print("IP_SESSION_AUTH | ERROR | Stored ip does not match request ip")
             raise UnAuthorizedException()
 
         lifetime_minutes = self._get_lifetime()
         self.redis.expire(redis_key, lifetime_minutes * 60)
-        if config.VERBOSE:
+        if config.IP_SESSION_VERBOSE:
             print("IP_SESSION_AUTH | OK | IP session auth successful")

{sharedkernel-2.6.3 → sharedkernel-2.7.0}/sharedkernel/logger/logger_service.py

@@ -92,8 +92,9 @@ class LoggerService:
 
 
     def emit(self, log: LogDTO):
-        # if config.VERBOSE:
-        #     print("LOGGER | INFO | Emitting log:\n", log)
+        if config.LOG_VERBOSE:
+            print("="*70)
+            print("LOGGER | INFO | Emitting log:\n", log)
         self.publish(log)
 
 

{sharedkernel-2.6.3 → sharedkernel-2.7.0}/sharedkernel.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sharedkernel
-Version: 2.6.3
+Version: 2.7.0
 Summary: sharekernel is a shared package between all python projects
 Author: Smilinno
 Description-Content-Type: text/markdown
@@ -20,7 +20,7 @@ Requires-Dist: markdown
 Requires-Dist: beautifulsoup4
 Requires-Dist: deepdiff
 Requires-Dist: kombu
-Requires-Dist: redis
+Requires-Dist: redis==8.0.0
 Dynamic: author
 Dynamic: description
 Dynamic: description-content-type
@@ -31,6 +31,10 @@ Dynamic: summary
 this is a shared kernel package
 
 # Change Log
+### Version 2.7.0
+- Add Redis and cache repository
+### Version 2.6.4
+- Add Verbose to log
 ### Version 2.6.3
 - fix bug ip-header-name
 ### Version 2.6.2

{sharedkernel-2.6.3 → sharedkernel-2.7.0}/sharedkernel.egg-info/SOURCES.txt

@@ -24,6 +24,9 @@ sharedkernel/database/mongo_generic_audit_repository.py
 sharedkernel/database/mongo_generic_repository.py
 sharedkernel/database/mongo_health_checker.py
 sharedkernel/database/pagination_response_dto.py
+sharedkernel/database/cache/__init__.py
+sharedkernel/database/cache/cache_repository.py
+sharedkernel/database/cache/redis_generic_cache.py
 sharedkernel/enum/__init__.py
 sharedkernel/enum/error_code.py
 sharedkernel/enum/redis_mode_enum.py

{sharedkernel-2.6.3 → sharedkernel-2.7.0}/sharedkernel.egg-info/requires.txt

@@ -14,4 +14,4 @@ markdown
 beautifulsoup4
 deepdiff
 kombu
-redis
+redis==8.0.0