sharedkernel 2.1.2__tar.gz → 2.2.0__tar.gz

{sharedkernel-2.1.2 → sharedkernel-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sharedkernel
-Version: 2.1.2
+Version: 2.2.0
 Summary: sharekernel is a shared package between all python projects
 Author: Smilinno
 Description-Content-Type: text/markdown
@@ -17,7 +17,7 @@ Requires-Dist: boto3==1.35.90
 Requires-Dist: python-docx
 Requires-Dist: mammoth
 Requires-Dist: markdown
-Requires-Dist: beautifulsoup4
+Requires-Dist: beautifulsoup4deepdiff
 Dynamic: author
 Dynamic: description
 Dynamic: description-content-type
@@ -28,6 +28,8 @@ Dynamic: summary
 this is a shared kernel package
 
 # Change Log
+### Version 2.2.0
+- implement Audit logging
 ### Version 2.1.2
 - Update pydantic parse_object with model_validate
 ### Version 2.1.0

{sharedkernel-2.1.2 → sharedkernel-2.2.0}/README.md

@@ -2,6 +2,8 @@
 this is a shared kernel package
 
 # Change Log
+### Version 2.2.0
+- implement Audit logging
 ### Version 2.1.2
 - Update pydantic parse_object with model_validate
 ### Version 2.1.0

{sharedkernel-2.1.2 → sharedkernel-2.2.0}/setup.py

@@ -34,9 +34,10 @@ setup(
         "mammoth",
         "markdown",
         "beautifulsoup4"
+        "deepdiff"
     ],
     # *strongly* suggested for sharing
-    version="2.1.2",
+    version="2.2.0",
     description="sharekernel is a shared package between all python projects",
     long_description=long_description,
     long_description_content_type="text/markdown",

sharedkernel-2.2.0/sharedkernel/database/__init__.py

@@ -0,0 +1,3 @@
+from .mongo_generic_repository import MongoGenericRepository
+from .mongo_generic_audit_repository import MongoGenericAuditRepository
+from .audit_model import AuditLog, AuditOperation

sharedkernel-2.2.0/sharedkernel/database/audit_model.py

@@ -0,0 +1,17 @@
+from sharedkernel.objects.base_document import BaseDocument
+
+from enum import Enum
+
+class AuditOperation(str, Enum):
+    CREATE = "create"
+    UPDATE = "update"
+    DELETE = "delete"
+
+class AuditLog(BaseDocument):
+    user_id: str
+    collection_name: str
+    document_id: str
+    operation: AuditOperation
+    original: dict | None = None
+    modified: dict
+    

sharedkernel-2.2.0/sharedkernel/database/mongo_generic_audit_repository.py

@@ -0,0 +1,72 @@
+from typing import Generic, TypeVar, List, Type
+from bson import ObjectId
+from pymongo import MongoClient
+from pydantic.v1 import BaseModel
+
+from sharedkernel.database.audit_model import AuditLog
+
+T = TypeVar("T", bound=BaseModel)
+
+AUDIT_COLLECTION_NAME = "audit_log"
+
+class MongoGenericAuditRepository():
+    def __init__(
+            self,
+            database: MongoClient,
+            audit_collection_name: str | None = None
+        ):
+        self.database = database
+        self.__collection_name = audit_collection_name or AUDIT_COLLECTION_NAME
+
+        self.collection = self.database[self.__collection_name]
+
+    def _map_to_model(self, document: dict) -> AuditLog:
+        document["id"] = str(document.pop("_id"))
+        return AuditLog(**document)
+
+    def find_one(self, id: str) -> T:
+        query = {"_id": ObjectId(id), "is_deleted": False}
+        result = self.collection.find_one(query)
+        return self._map_to_model(result) if result else None   
+
+    def find(
+        self,
+        document_id: str | None = None,
+        operation: str | None = None,
+        collection_name: str | None  = None,
+        field_name: str | None  = None,
+    ) -> List[AuditLog]:
+
+        query = {}
+
+        if document_id:
+            query["document_id"] = document_id
+        if operation:
+            query["operation"] = operation
+        if collection_name:
+            query["collection_name"] = collection_name
+
+        if field_name:
+            query["$or"] = [
+                {f"original.{field_name}": {"$exists": True}},
+                {f"modified.{field_name}": {"$exists": True}},
+            ]
+
+        results = self.collection.find(query)
+        return [self._map_to_model(bot) for bot in results]
+    
+    def insert_one(self, data: AuditLog) -> str:
+        delattr(data, "id")
+        result = self.collection.insert_one(data.model_dump())
+        return str(result.inserted_id)
+
+    def insert_many(self, data: List[AuditLog]) -> List[str]:
+        data_list = [delattr(d.model_dump(), "id") for d in data]
+        result = self.collection.insert_many(data_list)
+        return [str(id_) for id_ in result.inserted_ids]
+
+    def delete_one(self, id: str) -> int:
+        query = {"_id": ObjectId(id)}
+        result = self.collection.delete_one(query)
+        return result.deleted_count
+

sharedkernel-2.2.0/sharedkernel/database/mongo_generic_repository.py

@@ -0,0 +1,122 @@
+from bson import ObjectId
+from typing import Generic, TypeVar, List, Type
+from pydantic.v1 import BaseModel
+from pymongo import MongoClient, ReturnDocument
+from contextlib import suppress
+
+from sharedkernel.objects.user_info import current_user_info
+from sharedkernel.string_extentions import camel_to_snake
+from sharedkernel.objects.base_document import BaseAuditDocument
+from sharedkernel.database.mongo_generic_audit_repository import MongoGenericAuditRepository
+from sharedkernel.database.audit_model import (
+    AuditLog,
+    AuditOperation
+)
+from sharedkernel.diff_utils import generate_clean_diff
+
+T = TypeVar("T", bound=BaseModel)
+
+class MongoGenericRepository(Generic[T]):
+    def __init__(self, database: MongoClient, model: Type[T], audit_collection_name: str | None = None):
+        self.database = database
+        self.__collection_name = camel_to_snake(model.__name__)
+        self.collection = self.database[self.__collection_name]
+        self.model = model
+        self.audit_collection = MongoGenericAuditRepository(
+            database=database,
+            audit_collection_name=audit_collection_name
+        )
+
+    def _map_to_model(self, document: dict) -> T:
+        document["id"] = str(document.pop("_id"))
+        return self.model.model_validate(document)
+
+    def find_one(self, id: str) -> T:
+        query = {"_id": ObjectId(id), "is_deleted": False}
+        result = self.collection.find_one(query)
+        return self._map_to_model(result) if result else None   
+
+    def insert_one(self, data: T) -> str:
+        delattr(data, "id")
+        result = self.collection.insert_one(data.model_dump())
+        
+        # For Audit log
+        with suppress(Exception):
+            if isinstance(data, BaseAuditDocument):
+                document = AuditLog(
+                    user_id=current_user_info.get().nameid,
+                    collection_name=self.__collection_name,
+                    document_id=str(result.inserted_id),
+                    operation=AuditOperation.CREATE,
+                    original=None,
+                    modified=data.model_dump(),
+                )
+                self.audit_collection.insert_one(document)
+
+        return str(result.inserted_id)
+
+    def insert_many(self, data: List[T]) -> List[str]:
+        data_list = [delattr(d.model_dump(), "id") for d in data]
+        result = self.collection.insert_many(data_list)
+
+        # For Audit log
+        with suppress(Exception):
+            if len(result.inserted_ids) > 0:
+                if isinstance(data[0], BaseAuditDocument):
+                    documents = []
+                    for i, d in enumerate(data):
+                        document = AuditLog(
+                            user_id=current_user_info.get().nameid,
+                            collection_name=self.__collection_name,
+                            document_id=str(result.inserted_ids[i]),
+                            operation=AuditOperation.CREATE,
+                            original=None,
+                            modified=d.model_dump(),
+                        )
+                        documents.append(document)
+                    
+                    self.audit_collection.insert_many(documents)
+
+        return [str(id_) for id_ in result.inserted_ids]
+
+    def update_one(self, id: str, data: T) -> int:
+        delattr(data, "id")
+
+        query = {"_id": ObjectId(id)}
+        before_dict = self.collection.find_one_and_update(
+            query,
+            {"$set": data.model_dump()},
+            return_document=ReturnDocument.BEFORE
+        )
+
+        before_model = self.model(**before_dict)
+
+        # For Audit log
+        with suppress(Exception):
+            diff_data = generate_clean_diff(before_model, data)
+            old_data, new_data = diff_data["original"], diff_data["modified"]
+
+            if isinstance(data, BaseAuditDocument) and new_data:
+                document = AuditLog(
+                    user_id=current_user_info.get().nameid,
+                    collection_name=self.__collection_name,
+                    document_id=id,
+                    operation=AuditOperation.UPDATE,
+                    original=old_data,
+                    modified=new_data,
+                )
+                
+                self.audit_collection.insert_one(document)
+
+        return 1
+
+    def delete_one(self, id: str) -> int:
+        query = {"_id": ObjectId(id)}
+        result = self.collection.delete_one(query)
+        return result.deleted_count
+
+    def get_all(self, page_number=1, page_size=10) -> List[T]:
+        skip_count = (page_number - 1) * page_size
+        query = {"is_deleted": False}
+        result = self.collection.find(query).skip(skip_count).limit(page_size)
+        return [self._map_to_model(doc) for doc in result]

sharedkernel-2.2.0/sharedkernel/diff_utils.py

@@ -0,0 +1,65 @@
+from deepdiff import DeepDiff
+from pydantic.v1 import BaseModel
+
+EXCLUDE_FIELDS = {"created_on", "updated_on"}
+
+def generate_clean_diff(before: BaseModel, after: BaseModel, exclude_fields: set = EXCLUDE_FIELDS):
+    before_dict = before.model_dump()
+    after_dict = after.model_dump()
+    try:
+        clean_before = {k: v for k, v in before_dict.items() if k not in exclude_fields}
+        clean_after = {k: v for k, v in after_dict.items() if k not in exclude_fields}
+
+        diff = DeepDiff(clean_before, clean_after, ignore_order=True)
+        original = {}
+        modified = {}
+
+        for change_type in ["values_changed", "type_changes"]:
+            changes = diff.get(change_type, {})
+            for path, change in changes.items():
+                keys = path.strip("root").strip("[").strip("]").replace("][", ".").replace("'", "").split(".")
+                _apply_nested_keys(original, keys, change["old_value"])
+                _apply_nested_keys(modified, keys, change["new_value"])
+
+        return {"original": original, "modified": modified}
+    
+    except Exception as e:
+        return {"original": {}, "modified": {}, "error": str(e)}
+
+def _apply_nested_keys(base: dict, keys: list, value):
+    current = base
+    for i, key in enumerate(keys):
+        is_last = i == len(keys) - 1
+        next_key = keys[i + 1] if not is_last else None
+
+        # Determine if current key is an index (for lists)
+        is_index = key.isdigit()
+        key = int(key) if is_index else key
+
+        # Ensure current is list if key is int
+        if is_index and not isinstance(current, list):
+            # Convert current to list if it isn't already
+            raise TypeError(f"Expected list at {keys[:i]}, got {type(current).__name__}")
+
+        # Handle last key
+        if is_last:
+            if isinstance(current, list):
+                # Ensure list is big enough
+                while len(current) <= key:
+                    current.append(None)
+                current[key] = value
+            else:
+                current[key] = value
+            return
+
+        # Prepare next container (dict or list)
+        if isinstance(current, list):
+            while len(current) <= key:
+                current.append(None)
+            if current[key] is None:
+                current[key] = {} if (next_key and not next_key.isdigit()) else []
+            current = current[key]
+        else:
+            if key not in current:
+                current[key] = {} if (next_key and not next_key.isdigit()) else []
+            current = current[key]

{sharedkernel-2.1.2 → sharedkernel-2.2.0}/sharedkernel/jwt_service.py

@@ -2,10 +2,9 @@ import jwt
 import time
 from fastapi import Request
 from fastapi.security import HTTPBearer, HTTPAuthorizationCredentials
-
 from sharedkernel.exception.exception import UnAuthorizedException
 from sharedkernel.objects import JwtModel
-
+from sharedkernel.objects.user_info import current_user_info, UserInfo
 
 class JWTBearer(HTTPBearer):
 
@@ -18,21 +17,28 @@ class JWTBearer(HTTPBearer):
             credentials: HTTPAuthorizationCredentials = await super(
                 JWTBearer, self
             ).__call__(request)
-
             decoded_token = self.verify(credentials.credentials)
             request.state.decoded_token = decoded_token
 
+            nameid = decoded_token.get("nameid") or decoded_token.get("id")
+
+            user_info = UserInfo(
+                nameid=nameid, email=decoded_token.get("email"), unique_name=decoded_token.get("unique_name")
+            )
+
+            current_user_info.set(user_info)
+
         except:
             raise UnAuthorizedException()       
 
 
     def verify(self, token: str) -> dict:
             decoded_token = jwt.decode(
-            jwt= token.replace("Bearer","").strip(),
-            key= self.jwt_config.secret_key,
-            algorithms= self.jwt_config.algorithms,
-            audience= self.jwt_config.audience,
-            issuer= self.jwt_config.issuer
+                jwt= token.replace("Bearer","").strip(),
+                key= self.jwt_config.secret_key,
+                algorithms= self.jwt_config.algorithms,
+                audience= self.jwt_config.audience,
+                issuer= self.jwt_config.issuer
             )
 
             if decoded_token["exp"] < time.time():

sharedkernel-2.2.0/sharedkernel/objects/__init__.py

@@ -0,0 +1,5 @@
+from .base_document import BaseDocument, BaseAuditDocument
+from .jwt_model import JwtModel
+from .result import Result
+from .json_string_model import JsonStringModel
+from .user_info import UserInfo

{sharedkernel-2.1.2 → sharedkernel-2.2.0}/sharedkernel/objects/base_document.py

@@ -6,4 +6,8 @@ class BaseDocument(BaseModel):
     id: str | None = None
     is_deleted: bool | None = False
     created_on: datetime = Field(default_factory=datetime.now)
-    updated_on: datetime = Field(default_factory=datetime.now)
+    updated_on: datetime = Field(default_factory=datetime.now)
+
+
+class BaseAuditDocument(BaseDocument):
+    pass

sharedkernel-2.2.0/sharedkernel/objects/user_info.py

@@ -0,0 +1,13 @@
+from pydantic import BaseModel   
+
+from contextvars import ContextVar
+
+class UserInfo(BaseModel):
+    nameid: str
+    unique_name: str | None = None
+    email: str | None = None
+    role: str | None = None
+
+
+current_user_info: ContextVar[UserInfo] = ContextVar("current_user_info")
+

{sharedkernel-2.1.2 → sharedkernel-2.2.0}/sharedkernel.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sharedkernel
-Version: 2.1.2
+Version: 2.2.0
 Summary: sharekernel is a shared package between all python projects
 Author: Smilinno
 Description-Content-Type: text/markdown
@@ -17,7 +17,7 @@ Requires-Dist: boto3==1.35.90
 Requires-Dist: python-docx
 Requires-Dist: mammoth
 Requires-Dist: markdown
-Requires-Dist: beautifulsoup4
+Requires-Dist: beautifulsoup4deepdiff
 Dynamic: author
 Dynamic: description
 Dynamic: description-content-type
@@ -28,6 +28,8 @@ Dynamic: summary
 this is a shared kernel package
 
 # Change Log
+### Version 2.2.0
+- implement Audit logging
 ### Version 2.1.2
 - Update pydantic parse_object with model_validate
 ### Version 2.1.0

{sharedkernel-2.1.2 → sharedkernel-2.2.0}/sharedkernel.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ setup.py
 sharedkernel/common.py
 sharedkernel/data_format_converter.py
 sharedkernel/date_converter.py
+sharedkernel/diff_utils.py
 sharedkernel/jwt_service.py
 sharedkernel/regex_masking.py
 sharedkernel/s3_uploader.py
@@ -13,6 +14,8 @@ sharedkernel.egg-info/dependency_links.txt
 sharedkernel.egg-info/requires.txt
 sharedkernel.egg-info/top_level.txt
 sharedkernel/database/__init__.py
+sharedkernel/database/audit_model.py
+sharedkernel/database/mongo_generic_audit_repository.py
 sharedkernel/database/mongo_generic_repository.py
 sharedkernel/enum/__init__.py
 sharedkernel/enum/error_code.py
@@ -27,4 +30,5 @@ sharedkernel/objects/__init__.py
 sharedkernel/objects/base_document.py
 sharedkernel/objects/json_string_model.py
 sharedkernel/objects/jwt_model.py
-sharedkernel/objects/result.py
+sharedkernel/objects/result.py
+sharedkernel/objects/user_info.py

{sharedkernel-2.1.2 → sharedkernel-2.2.0}/sharedkernel.egg-info/requires.txt

@@ -11,4 +11,4 @@ boto3==1.35.90
 python-docx
 mammoth
 markdown
-beautifulsoup4
+beautifulsoup4deepdiff

sharedkernel-2.1.2/sharedkernel/database/__init__.py

@@ -1 +0,0 @@
-# from .mongo_repository_base import MongoRepositoryBase

sharedkernel-2.1.2/sharedkernel/database/mongo_generic_repository.py

@@ -1,51 +0,0 @@
-from pymongo import MongoClient
-from bson import ObjectId
-from typing import Generic, TypeVar, List, Type
-from pydantic.v1 import BaseModel
-from sharedkernel.string_extentions import camel_to_snake
-
-T = TypeVar("T", bound=BaseModel)
-
-
-class MongoGenericRepository(Generic[T]):
-    def __init__(self, database: MongoClient, model: Type[T]):
-        self.database = database
-        self.__collection_name = camel_to_snake(model.__name__)
-        self.collection = self.database[self.__collection_name]
-        self.model = model
-
-    def _map_to_model(self, document: dict) -> T:
-        document["id"] = str(document.pop("_id"))
-        return self.model.model_validate(document)
-
-    def find_one(self, id: str) -> T:
-        query = {"_id": ObjectId(id), "is_deleted": False}
-        result = self.collection.find_one(query)
-        return self._map_to_model(result) if result else None   
-
-    def insert_one(self, data: T) -> str:
-        delattr(data, "id")
-        result = self.collection.insert_one(data.dict())
-        return str(result.inserted_id)
-
-    def insert_many(self, data: List[T]) -> List[str]:
-        data_list = [delattr(d.dict(), "id") for d in data]
-        result = self.collection.insert_many(data_list)
-        return [str(id_) for id_ in result.inserted_ids]
-
-    def update_one(self, id: str, data: T) -> int:
-        delattr(data, "id")
-        query = {"_id": ObjectId(id)}
-        result = self.collection.update_one(query, {"$set": data.dict()})
-        return result.modified_count
-
-    def delete_one(self, id: str) -> int:
-        query = {"_id": ObjectId(id)}
-        result = self.collection.delete_one(query)
-        return result.deleted_count
-
-    def get_all(self, page_number=1, page_size=10) -> List[T]:
-        skip_count = (page_number - 1) * page_size
-        query = {"is_deleted": False}
-        result = self.collection.find(query).skip(skip_count).limit(page_size)
-        return [self._map_to_model(doc) for doc in result]

sharedkernel-2.1.2/sharedkernel/objects/__init__.py

@@ -1,4 +0,0 @@
-from .base_document import BaseDocument
-from .jwt_model import JwtModel
-from .result import Result
-from .json_string_model import JsonStringModel