ipulse-shared-core-ftredge 3.2.3__tar.gz → 4.1.1__tar.gz

{ipulse_shared_core_ftredge-3.2.3/src/ipulse_shared_core_ftredge.egg-info → ipulse_shared_core_ftredge-4.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ipulse_shared_core_ftredge
-Version: 3.2.3
+Version: 4.1.1
 Summary: Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.
 Home-page: https://github.com/TheFutureEdge/ipulse_shared_core
 Author: Russlan Ramdowar

{ipulse_shared_core_ftredge-3.2.3 → ipulse_shared_core_ftredge-4.1.1}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='ipulse_shared_core_ftredge',
-    version='3.2.3',
+    version='4.1.1',
     package_dir={'': 'src'},  # Specify the source directory
     packages=find_packages(where='src'),  # Look for packages in 'src'
     install_requires=[

ipulse_shared_core_ftredge-4.1.1/src/ipulse_shared_core_ftredge/__init__.py

@@ -0,0 +1,9 @@
+# pylint: disable=missing-module-docstring
+from .models import ( UserAuth, UserProfile,
+                     UserStatus, UserProfileUpdate,
+                     Organisation)
+
+from .exceptions import (BaseServiceException, ResourceNotFoundError, AuthorizationError,
+                            ValidationError )
+
+from .services import (BaseFirestoreService)

ipulse_shared_core_ftredge-4.1.1/src/ipulse_shared_core_ftredge/exceptions.py

@@ -0,0 +1,71 @@
+from fastapi import HTTPException
+from typing import Optional, Any, Dict
+
+class BaseServiceException(HTTPException):
+    def __init__(
+        self,
+        status_code: int,
+        detail: str,
+        resource_type: str,
+        resource_id: Optional[str] = None,
+        additional_info: Optional[Dict[str, Any]] = None
+    ):
+        self.resource_type = resource_type
+        self.resource_id = resource_id
+        self.additional_info = additional_info or {}
+        
+        # Build detailed message
+        detail_msg = f"{detail}"
+        if resource_type:
+            detail_msg += f" [Resource Type: {resource_type}]"
+        if resource_id:
+            detail_msg += f" [ID: {resource_id}]"
+        
+        super().__init__(status_code=status_code, detail=detail_msg)
+
+class ResourceNotFoundError(BaseServiceException):
+    def __init__(
+        self,
+        resource_type: str,
+        resource_id: str,
+        additional_info: Optional[Dict[str, Any]] = None
+    ):
+        super().__init__(
+            status_code=404,
+            detail="Resource not found",
+            resource_type=resource_type,
+            resource_id=resource_id,
+            additional_info=additional_info
+        )
+
+class AuthorizationError(BaseServiceException):
+    def __init__(
+        self,
+        resource_type: str,
+        action: str,
+        resource_id: Optional[str] = None,
+        additional_info: Optional[Dict[str, Any]] = None
+    ):
+        super().__init__(
+            status_code=403,
+            detail=f"Not authorized to {action}",
+            resource_type=resource_type,
+            resource_id=resource_id,
+            additional_info=additional_info
+        )
+
+class ValidationError(BaseServiceException):
+    def __init__(
+        self,
+        resource_type: str,
+        detail: str,
+        resource_id: Optional[str] = None,
+        additional_info: Optional[Dict[str, Any]] = None
+    ):
+        super().__init__(
+            status_code=422,
+            detail=detail,
+            resource_type=resource_type,
+            resource_id=resource_id,
+            additional_info=additional_info
+        )

ipulse_shared_core_ftredge-4.1.1/src/ipulse_shared_core_ftredge/models/api_response.py

@@ -0,0 +1,22 @@
+from typing import Generic, TypeVar, Optional, Any, Dict, List
+from pydantic import BaseModel, ConfigDict
+import datetime as dt
+
+T = TypeVar('T')
+
+class StandardResponse(BaseModel, Generic[T]):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+    success: bool
+    data: Optional[T] = None
+    message: Optional[str] = None
+    error: Optional[str] = None
+
+    metadata: Dict[str, Any] = {
+        "timestamp": dt.datetime.now(dt.timezone.utc).isoformat()
+    }
+
+class PaginatedResponse(StandardResponse, Generic[T]):
+    total_count: int
+    page: int
+    page_size: int
+    items: List[T]

ipulse_shared_core_ftredge-4.1.1/src/ipulse_shared_core_ftredge/services/__init__.py

@@ -0,0 +1 @@
+from .base_service  import BaseFirestoreService

ipulse_shared_core_ftredge-4.1.1/src/ipulse_shared_core_ftredge/services/base_service.py

@@ -0,0 +1,75 @@
+from typing import Dict, Any, Optional
+from datetime import datetime,timezone
+from fastapi import HTTPException
+from google.cloud import firestore
+from ..exceptions import ResourceNotFoundError, ValidationError
+
+class BaseFirestoreService:
+    def __init__(self, db: firestore.Client, collection_name: str, resource_type: str):
+        self.db = db
+        self.collection_name = collection_name
+        self.resource_type = resource_type
+
+    def _validate_update_fields(self, update_data: Dict[str, Any]) -> Dict[str, Any]:
+        """Centralized update fields validation"""
+        if not isinstance(update_data, dict):
+            update_data = update_data.model_dump(exclude_unset=True)
+            
+        valid_fields = {
+            k: v for k, v in update_data.items()
+            if v is not None and not (isinstance(v, (list, dict, set)) and len(v) == 0)
+        }
+        
+        if not valid_fields:
+            raise ValidationError(
+                resource_type=self.resource_type,
+                detail="No valid fields to update",
+                resource_id=None
+            )
+            
+        return valid_fields
+
+    async def get_document(self, doc_id: str) -> Dict[str, Any]:
+        """Get a document by ID with standardized error handling"""
+        doc_ref = self.db.collection(self.collection_name).document(doc_id)
+        doc = doc_ref.get()
+        
+        if not doc.exists:
+            raise ResourceNotFoundError(
+                resource_type=self.resource_type,
+                resource_id=doc_id,
+                additional_info={"collection": self.collection_name}
+            )
+            
+        return doc.to_dict()
+
+    async def update_document(self, doc_id: str, update_data: Dict[str, Any], user_uid: Optional[str] = None) -> Dict[str, Any]:
+        """Standard update method with validation and audit fields"""
+        try:
+            doc_ref = self.db.collection(self.collection_name).document(doc_id)
+            
+            if not doc_ref.get().exists:
+                raise ResourceNotFoundError(
+                    resource_type=self.resource_type,
+                    resource_id=doc_id,
+                    additional_info={"collection": self.collection_name}
+                )
+            
+            valid_fields = self._validate_update_fields(update_data)
+            
+            # Add audit fields
+            valid_fields.update({
+                'updt_date': datetime.now(timezone.utc).isoformat(),
+                'updt_by_user': user_uid if user_uid else None
+            })
+            
+            doc_ref.update(valid_fields)
+            return doc_ref.get().to_dict()
+            
+        except (ResourceNotFoundError, ValidationError):
+            raise
+        except Exception as e:
+            raise HTTPException(
+                status_code=500,
+                detail=f"Failed to update {self.resource_type}: {str(e)}"
+            )

{ipulse_shared_core_ftredge-3.2.3 → ipulse_shared_core_ftredge-4.1.1/src/ipulse_shared_core_ftredge.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ipulse_shared_core_ftredge
-Version: 3.2.3
+Version: 4.1.1
 Summary: Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.
 Home-page: https://github.com/TheFutureEdge/ipulse_shared_core
 Author: Russlan Ramdowar

{ipulse_shared_core_ftredge-3.2.3 → ipulse_shared_core_ftredge-4.1.1}/src/ipulse_shared_core_ftredge.egg-info/SOURCES.txt

@@ -3,16 +3,20 @@ README.md
 pyproject.toml
 setup.py
 src/ipulse_shared_core_ftredge/__init__.py
+src/ipulse_shared_core_ftredge/exceptions.py
 src/ipulse_shared_core_ftredge.egg-info/PKG-INFO
 src/ipulse_shared_core_ftredge.egg-info/SOURCES.txt
 src/ipulse_shared_core_ftredge.egg-info/dependency_links.txt
 src/ipulse_shared_core_ftredge.egg-info/requires.txt
 src/ipulse_shared_core_ftredge.egg-info/top_level.txt
 src/ipulse_shared_core_ftredge/models/__init__.py
+src/ipulse_shared_core_ftredge/models/api_response.py
 src/ipulse_shared_core_ftredge/models/organisation.py
 src/ipulse_shared_core_ftredge/models/resource_catalog_item.py
 src/ipulse_shared_core_ftredge/models/user_auth.py
 src/ipulse_shared_core_ftredge/models/user_profile.py
 src/ipulse_shared_core_ftredge/models/user_profile_update.py
 src/ipulse_shared_core_ftredge/models/user_status.py
+src/ipulse_shared_core_ftredge/services/__init__.py
+src/ipulse_shared_core_ftredge/services/base_service.py
 tests/test_utils_gcp.py

ipulse_shared_core_ftredge-3.2.3/src/ipulse_shared_core_ftredge/__init__.py

@@ -1,4 +0,0 @@
-# pylint: disable=missing-module-docstring
-from .models import ( UserAuth, UserProfile,
-                     UserStatus, UserProfileUpdate,
-                     Organisation)