ipulse-shared-core-ftredge 10.1.1__tar.gz → 12.0.1__tar.gz

{ipulse_shared_core_ftredge-10.1.1/src/ipulse_shared_core_ftredge.egg-info → ipulse_shared_core_ftredge-12.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipulse_shared_core_ftredge
-Version: 10.1.1
+Version: 12.0.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
@@ -13,7 +13,7 @@ Requires-Dist: pydantic[email]~=2.5
 Requires-Dist: python-dateutil~=2.8
 Requires-Dist: fastapi~=0.115.8
 Requires-Dist: pytest
-Requires-Dist: ipulse_shared_base_ftredge>=6.4.1
+Requires-Dist: ipulse_shared_base_ftredge==6.5.1
 Dynamic: author
 Dynamic: classifier
 Dynamic: home-page

{ipulse_shared_core_ftredge-10.1.1 → ipulse_shared_core_ftredge-12.0.1}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='ipulse_shared_core_ftredge',
-    version='10.1.1',
+    version='12.0.1',
     package_dir={'': 'src'},  # Specify the source directory
     packages=find_packages(where='src'),  # Look for packages in 'src'
     install_requires=[
@@ -12,7 +12,7 @@ setup(
         'python-dateutil~=2.8',
         'fastapi~=0.115.8',
         'pytest',
-        'ipulse_shared_base_ftredge>=6.4.1',
+        'ipulse_shared_base_ftredge==6.5.1',
     ],
     author='Russlan Ramdowar',
     description='Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.',

{ipulse_shared_core_ftredge-10.1.1 → ipulse_shared_core_ftredge-12.0.1}/src/ipulse_shared_core_ftredge/__init__.py

@@ -7,6 +7,6 @@ from .models import ( UserAuth, UserProfile,Subscription,
 
 
 from .services import (BaseFirestoreService,BaseServiceException, ResourceNotFoundError, AuthorizationError,
-                            ValidationError)
+                            ValidationError, ServiceError)
 
-from .utils import (CustomJSONEncoder)
+from .utils import (EnsureJSONEncoderCompatibility)

{ipulse_shared_core_ftredge-10.1.1 → ipulse_shared_core_ftredge-12.0.1}/src/ipulse_shared_core_ftredge/dependencies/authz_for_apis.py

@@ -1,17 +1,23 @@
 import os
 import logging
+import json
+import asyncio
+from concurrent.futures import ThreadPoolExecutor
 from typing import Optional, Iterable, Dict, Any, List
 from datetime import datetime, timedelta, timezone
+import json
 import httpx
 from fastapi import HTTPException, Request
 from google.cloud import firestore
 from ipulse_shared_core_ftredge.services import ServiceError, AuthorizationError, ResourceNotFoundError
 from ipulse_shared_core_ftredge.models import UserStatus
+from ipulse_shared_core_ftredge.utils.json_encoder import convert_to_json_serializable
+
+# Constants derived from UserStatus model
+USERS_STATUS_COLLECTION_NAME = UserStatus.COLLECTION_NAME
+USERS_STATUS_DOC_REF = f"{UserStatus.OBJ_REF}_" # Use OBJ_REF and append underscore
+USERSTATUS_CACHE_TTL = 60 # 60 seconds
 
-# Constants
-USERS_STATUS_COLLECTION_NAME = UserStatus.get_collection_name()
-USERS_STATUS_DOC_REF = "userstatus_"
-CACHE_TTL = 60 # 60 seconds
 class UserStatusCache:
     """Manages user status caching with dynamic invalidation"""
     def __init__(self):
@@ -30,7 +36,7 @@ class UserStatusCache:
             status_data = self._cache[user_uid]
             # Force refresh for credit-consuming or sensitive operations
             # Check TTL for normal operations
-            if datetime.now() - self._timestamps[user_uid] < timedelta(seconds=CACHE_TTL):
+            if datetime.now() - self._timestamps[user_uid] < timedelta(seconds=USERSTATUS_CACHE_TTL):
                 return status_data
             self.invalidate(user_uid)
         return None
@@ -62,13 +68,59 @@ userstatus_cache = UserStatusCache()
 # Replace the logger dependency with a standard logger
 logger = logging.getLogger(__name__)
 
+# Create a custom FirestoreTimeoutError class that can be identified in middlewares
+class FirestoreTimeoutError(TimeoutError):
+    """Custom exception for Firestore timeout errors to make them more identifiable."""
+    pass
+
+
+# Define a function to get a Firestore document with a strict timeout
+async def get_with_strict_timeout(doc_ref, timeout_seconds: float):
+    """
+    Get a Firestore document with a strictly enforced timeout.
+
+    Args:
+        doc_ref: Firestore document reference
+        timeout_seconds: Maximum time to wait in seconds
+
+    Returns:
+        Document snapshot
+
+    Raises:
+        FirestoreTimeoutError: If the operation takes longer than timeout_seconds
+    """
+    loop = asyncio.get_running_loop()
+    with ThreadPoolExecutor() as executor:
+        try:
+            # Run the blocking Firestore get() operation in a thread and apply a strict timeout
+            logger.debug(f"Starting Firestore get with strict timeout of {timeout_seconds}s")
+            return await asyncio.wait_for(
+                loop.run_in_executor(executor, doc_ref.get),
+                timeout=timeout_seconds
+            )
+        except asyncio.TimeoutError:
+            error_message = f"User Status fetching for Authz timed out after {timeout_seconds} seconds, perhaps issue with Firestore Connectivity"
+            logger.error(error_message)
+            raise FirestoreTimeoutError(error_message)
+
+# Update get_userstatus to use our new strict timeout function
 async def get_userstatus(
     user_uid: str,
-    db: firestore.Client,  # Note: This expects the actual client, not a Depends
-    force_fresh: bool = False
+    db: firestore.Client,
+    force_fresh: bool = False,
+    timeout: float = 12.0  # Default timeout but allow override
 ) -> tuple[Dict[str, Any], bool]:
     """
-    Fetch user status with intelligent caching
+    Fetch user status with intelligent caching and configurable timeout
+
+    Args:
+        user_uid: User ID to fetch status for
+        db: Firestore client
+        force_fresh: Whether to bypass cache
+        timeout: Timeout for Firestore operations in seconds
+
+    Returns:
+        Tuple of (user status data, whether cache was used)
     """
     cache_used = False
     if not force_fresh:
@@ -82,8 +134,11 @@ async def get_userstatus(
         userstatus_id = USERS_STATUS_DOC_REF + user_uid
         user_ref = db.collection(USERS_STATUS_COLLECTION_NAME).document(userstatus_id)
 
-        # Get the document
-        snapshot = user_ref.get()
+        logger.debug(f"Fetching user status for {user_uid} with strict timeout {timeout}s")
+
+        # Use our strict timeout wrapper instead of the native timeout parameter
+        snapshot = await get_with_strict_timeout(user_ref, timeout)
+
         if not snapshot.exists:
             raise ResourceNotFoundError(
                 resource_type="authorization userstatus",
@@ -98,9 +153,23 @@ async def get_userstatus(
             userstatus_cache.set(user_uid, status_data)
         return status_data, cache_used
 
+    except TimeoutError as e:
+        logger.error(f"Timeout while fetching user status for {user_uid}: {str(e)}")
+        raise ServiceError(
+            operation="fetching user status for authz",
+            error=e,
+            resource_type="userstatus",
+            resource_id=user_uid,
+            additional_info={
+                "force_fresh": force_fresh,
+                "collection": USERS_STATUS_COLLECTION_NAME,
+                "timeout_seconds": timeout
+            }
+        )
     except ResourceNotFoundError:
         raise
     except Exception as e:
+        logger.error(f"Error fetching user status for {user_uid}: {str(e)}")
         raise ServiceError(
             operation=f"fetching user status",
             error=e,
@@ -153,15 +222,27 @@ async def extract_request_fields(request: Request) -> Optional[List[str]]:
         logger.warning(f"Could not extract fields from request body: {str(e)}")
         return None  # Return None instead of raising an error
 
+# Main authorization function with configurable timeout
 async def authorizeAPIRequest(
     request: Request,
-    db: firestore.Client,  # Changed: Now expects actual client instance
+    db: firestore.Client,
     request_resource_fields: Optional[Iterable[str]] = None,
+    firestore_timeout: float = 15.0  # Allow specifying timeout
 ) -> Dict[str, Any]:
     """
     Authorize API request based on user status and OPA policies.
     Enhanced with credit check information.
+
+    Args:
+        request: The incoming request
+        db: Firestore client
+        request_resource_fields: Fields being accessed/modified in the request
+        firestore_timeout: Timeout for Firestore operations in seconds
+
+    Returns:
+        Authorization result containing decision details
     """
+    opa_decision = None
     try:
         # Extract fields for both PATCH and POST if not provided
         if not request_resource_fields:
@@ -175,41 +256,104 @@ async def authorizeAPIRequest(
                 additional_info={"path": str(request.url)}
             )
 
-
         # Determine if we need fresh status
         force_fresh = _should_force_fresh_status(request)
-        userstatus, cache_used = await get_userstatus(user_uid, db, force_fresh=force_fresh)
-
-        # Prepare authorization input
-        auth_input = {
+        userstatus, cache_used = await get_userstatus(
+            user_uid,
+            db,
+            force_fresh=force_fresh,
+            timeout=firestore_timeout  # Pass the specified timeout
+        )
+
+        # Prepare authorization input that matches OPA expectations
+        # Extract required values from user status
+        primary_usertype = userstatus.get("primary_usertype")
+        secondary_usertypes = userstatus.get("secondary_usertypes", [])
+
+        # Extract IAM domain permissions
+        iam_domain_permissions = userstatus.get("iam_domain_permissions", {})
+
+        # Format the authz_input to match what the OPA policies expect
+        authz_input = {
             "api_url": request.url.path,
             "requestor": {
                 "uid": user_uid,
-                "usertypes": request.state.user.get("usertypes"),
-                "email_verified": request.state.user.get("email_verified"),
-                "iam_groups": userstatus.get("iam_groups"),
-                "subscriptions": userstatus.get("subscriptions"),
-                "sbscrptn_based_insight_credits": userstatus.get("sbscrptn_based_insight_credits"),
-                "extra_insight_credits": userstatus.get("extra_insight_credits")
+                "primary_usertype": primary_usertype,
+                "secondary_usertypes": secondary_usertypes,
+                "usertypes": [primary_usertype] + secondary_usertypes if primary_usertype else secondary_usertypes,
+                "email_verified": request.state.user.get("email_verified", False),
+                "iam_domain_permissions": iam_domain_permissions,
+                "sbscrptn_based_insight_credits": userstatus.get("sbscrptn_based_insight_credits", 0),
+                "extra_insight_credits": userstatus.get("extra_insight_credits", 0)
             },
             "method": request.method.lower(),
             "request_resource_fields": request_resource_fields
         }
 
-        ####!!!!!!!!!! OPA call
+        # Convert any non-serializable objects to JSON serializable format
+        # Using the unified utility from utils
+        json_safe_authz_input = convert_to_json_serializable(authz_input)
+
         # Query OPA
         opa_url = f"{os.getenv('OPA_SERVER_URL', 'http://localhost:8181')}{os.getenv('OPA_DECISION_PATH', '/v1/data/http/authz/ingress/decision')}"
         logger.debug(f"Attempting to connect to OPA at: {opa_url}")
-        logger.debug(f"Authorization input: {auth_input}")
+
+        # Debug: Print raw JSON payload to identify any potential issues
+        try:
+            payload_json = json.dumps({"input": json_safe_authz_input})
+            logger.debug(f"OPA Request JSON payload: {payload_json}")
+        except Exception as json_err:
+            logger.error(f"Error serializing OPA request payload: {json_err}")
+
         async with httpx.AsyncClient() as client:
             try:
                 response = await client.post(
                     opa_url,
-                    json={"input": auth_input},
+                    json={"input": json_safe_authz_input},
                     timeout=5.0  # 5 seconds timeout
                 )
                 logger.debug(f"OPA Response Status: {response.status_code}")
                 logger.debug(f"OPA Response Body: {response.text}")
+
+                if response.status_code != 200:
+                    logger.error(f"OPA authorization failed: {response.text}")
+                    raise HTTPException(
+                        status_code=500,
+                        detail="Authorization service error"
+                    )
+
+                result = response.json()
+                logger.debug(f"Parsed OPA response: {result}")
+
+                # Handle unusual OPA response formats
+                # Try to find "decision" field as an alternative
+                if "result" in result:
+                    opa_decision = result["result"]
+                else:
+                    # If we still don't have a result after all attempts, use default structure
+                    logger.warning(f"OPA response missing 'result' field, using default")
+                    raise HTTPException(
+                        status_code=500,
+                        detail="Authorization service error: OPA response format unexpected"
+                    )
+
+                # Extract key fields from result with better default handling
+                allow = opa_decision.get("allow", False)
+
+                # Handle authorization denial
+                if not allow:
+                    logger.error(f"Authorization denied: {result}")
+                    raise AuthorizationError(
+                        action=f"{request.method} {request.url.path}",
+                        additional_info={
+                            "user_uid": user_uid,
+                            "resource_fields": request_resource_fields,
+                            "opa_decision": opa_decision,  # Include the full OPA decision result
+                            # Include the raw result if it's different from the processed decision
+                            "raw_opa_response": result if result != {"result": opa_decision} else None
+                        }
+                    )
+
             except httpx.RequestError as e:
                 logger.error(f"Failed to connect to OPA: {str(e)}")
                 raise ServiceError(
@@ -221,39 +365,19 @@ async def authorizeAPIRequest(
                         "connection_error": str(e)
                     }
                 ) from e
-            if response.status_code != 200:
-                logger.error(f"OPA authorization failed: {response.text}")
-                raise HTTPException(
-                    status_code=500,
-                    detail="Authorization service error"
-                )
-
-            result = response.json()
-            if not result.get("result", {}).get("allow", False):
-                raise AuthorizationError(
-                    action=f"{request.method} {request.url.path}",
-                    additional_info={
-                        "user_uid": user_uid,
-                        "resource_fields": request_resource_fields
-                    }
-                )
-
-            # Extract credit check information from the OPA response
-            credit_check = {}
-            if "credit_check" in result.get("result", {}):
-                credit_check = result["result"]["credit_check"]
 
         # More descriptive metadata about the data freshness
         return {
             "used_cached_status": cache_used,
             "required_fresh_status": force_fresh,
             "status_retrieved_at": datetime.now(timezone.utc).isoformat(),
-            "credit_check": credit_check
+            "opa_decision": opa_decision
         }
 
     except (AuthorizationError, ResourceNotFoundError):
         raise
     except Exception as e:
+        logger.exception(f"Exception in authorizeAPIRequest: {e}")
         raise ServiceError(
             operation="API authorization",
             error=e,

{ipulse_shared_core_ftredge-10.1.1 → ipulse_shared_core_ftredge-12.0.1}/src/ipulse_shared_core_ftredge/models/base_api_response.py

@@ -3,7 +3,7 @@ import datetime as dt
 import json
 from pydantic import BaseModel, ConfigDict
 from fastapi.responses import JSONResponse
-from ipulse_shared_core_ftredge.utils import CustomJSONEncoder
+from ipulse_shared_core_ftredge.utils.json_encoder import EnsureJSONEncoderCompatibility, convert_to_json_serializable
 
 
 T = TypeVar('T')
@@ -27,7 +27,7 @@ class PaginatedAPIResponse(BaseAPIResponse, Generic[T]):
 
 class CustomJSONResponse(JSONResponse):
     def render(self, content) -> bytes:
-        # Handle Pydantic models to exclude computed fields
+        # First preprocess content with our utility function
         if isinstance(content, dict) and "data" in content and hasattr(content["data"], "model_dump"):
             # If content["data"] is a Pydantic model, use model_dump with exclude_unset=True
             # and exclude_computed=True to prevent serialization of computed fields
@@ -37,12 +37,15 @@ class CustomJSONResponse(JSONResponse):
                 exclude_computed=True
             )
 
-        # Use the CustomJSONEncoder for serialization
+        # Now convert all problematic types to JSON serializable values
+        json_safe_content = convert_to_json_serializable(content)
+
+        # Use the CustomJSONEncoder for additional safety
         return json.dumps(
-            content,
+            json_safe_content,
             ensure_ascii=False,
             allow_nan=False,
             indent=None,
             separators=(",", ":"),
-            default=CustomJSONEncoder().default
+            cls=EnsureJSONEncoderCompatibility
         ).encode("utf-8")

ipulse_shared_core_ftredge-12.0.1/src/ipulse_shared_core_ftredge/models/base_data_model.py

@@ -0,0 +1,55 @@
+from datetime import datetime, timezone
+from typing import Any
+from typing import ClassVar
+from pydantic import BaseModel, Field, ConfigDict, field_validator
+import dateutil.parser
+
+class BaseDataModel(BaseModel):
+    """Base model with common fields and configuration"""
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    # Required class variables that must be defined in subclasses
+    VERSION: ClassVar[float]
+    DOMAIN: ClassVar[str]
+    OBJ_REF: ClassVar[str]
+
+    # Schema versioning
+    schema_version: float = Field(
+        ...,  # Make this required
+        description="Version of this Class == version of DB Schema",
+        frozen=True
+    )
+
+    # Audit fields
+    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc), frozen=True)
+    created_by: str = Field(..., frozen=True)
+    updated_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc), frozen=True)
+    updated_by: str = Field(...)
+
+    @classmethod
+    def get_collection_name(cls) -> str:
+        """Generate standard collection name"""
+        return f"{cls.DOMAIN}_{cls.OBJ_REF}s"
+
+    @field_validator('created_at', 'updated_at', mode='before')
+    @classmethod
+    def parse_datetime(cls, v: Any) -> datetime:
+        if isinstance(v, datetime): # If Firestore already gave a datetime object
+            return v # Just use it, no parsing needed
+        if isinstance(v, str): # If it's a string (e.g. from an API request, not Firestore direct)
+            try:
+                return dateutil.parser.isoparse(v)
+            except (TypeError, ValueError) as e:
+                raise ValueError(f"Invalid datetime string format: {v} - {e}")
+        # Firestore might send google.api_core.datetime_helpers.DatetimeWithNanoseconds
+        # which is a subclass of datetime.datetime, so isinstance(v, datetime) should catch it.
+        # If for some reason it's a different type not caught by isinstance(v, datetime)
+        # but has isoformat(), perhaps try that, but it's unlikely with current Firestore client.
+        # For example, if v is some custom timestamp object from an older library:
+        if hasattr(v, 'isoformat'): # Fallback for unknown datetime-like objects
+             try:
+                 return dateutil.parser.isoparse(v.isoformat())
+             except Exception as e:
+                 raise ValueError(f"Could not parse datetime-like object: {v} - {e}")
+
+        raise ValueError(f"Unsupported type for datetime parsing: {type(v)} value: {v}")

{ipulse_shared_core_ftredge-10.1.1 → ipulse_shared_core_ftredge-12.0.1}/src/ipulse_shared_core_ftredge/models/user_status.py

@@ -51,6 +51,10 @@ class UserStatus(BaseDataModel):
     DOMAIN: ClassVar[str] = "_".join(list_as_lower_strings(Layer.PULSE_APP, Module.CORE.name, Subject.USER.name))
     OBJ_REF: ClassVar[str] = "userstatus"
 
+    # Centralized collection name and document ID prefix
+    COLLECTION_NAME: ClassVar[str] = "papp_core_user_userstatuss"
+
+
     # System-managed fields
     schema_version: float = Field(
         default=VERSION,

{ipulse_shared_core_ftredge-10.1.1 → ipulse_shared_core_ftredge-12.0.1}/src/ipulse_shared_core_ftredge/services/base_firestore_service.py

@@ -1,6 +1,7 @@
 """ Base class for Firestore services with common CRUD operations """
-from typing import Dict, Any, List, TypeVar, Generic
+from typing import Dict, Any, List, TypeVar, Generic, Optional
 import logging
+import time
 from datetime import datetime, timezone
 from pydantic import BaseModel
 from google.cloud import firestore
@@ -11,11 +12,20 @@ T = TypeVar('T', bound=BaseModel)
 class BaseFirestoreService(Generic[T]):
     """Base class for Firestore services with common CRUD operations"""
 
-    def __init__(self, db: firestore.Client, collection_name: str, resource_type: str, logger: logging.Logger):
+    def __init__(
+        self,
+        db: firestore.Client,
+        collection_name: str,
+        resource_type: str,
+        logger: logging.Logger,
+        timeout: float = 15.0  # Default to 15 seconds, but allow override
+    ):
         self.db = db
         self.collection_name = collection_name
         self.resource_type = resource_type
         self.logger = logger
+        self.timeout = timeout  # Store the timeout as an instance attribute
+        self.logger.info(f"Initialized {self.resource_type} service with timeout={timeout}s")
 
     async def create_document(self, doc_id: str, data: T, creator_uid: str) -> Dict[str, Any]:
         """Standard create method with audit fields"""
@@ -32,7 +42,8 @@ class BaseFirestoreService(Generic[T]):
             })
 
             doc_ref = self.db.collection(self.collection_name).document(doc_id)
-            doc_ref.set(doc_data)
+            # Apply timeout to the set operation
+            doc_ref.set(doc_data, timeout=self.timeout)
 
             self.logger.info(f"Created {self.resource_type}: {doc_id}")
             return doc_data
@@ -66,7 +77,8 @@ class BaseFirestoreService(Generic[T]):
                 batch.set(doc_ref, doc_data)
                 created_docs.append(doc_data)
 
-            batch.commit()
+            # Apply timeout to the commit operation
+            batch.commit(timeout=self.timeout)
             self.logger.info(f"Created {len(documents)} {self.resource_type}s in batch")
             return created_docs
 
@@ -81,24 +93,48 @@ class BaseFirestoreService(Generic[T]):
 
     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()
+        self.logger.debug(f"Getting {self.resource_type} document: {doc_id} with timeout={self.timeout}s")
+        start_time = time.time()
 
-        if not doc.exists:
-            raise ResourceNotFoundError(
+        try:
+            doc_ref = self.db.collection(self.collection_name).document(doc_id)
+
+            # Apply timeout to the get operation
+            doc = doc_ref.get(timeout=self.timeout)
+
+            elapsed = (time.time() - start_time) * 1000
+            self.logger.debug(f"Firestore get for {doc_id} completed in {elapsed:.2f}ms")
+
+            if not doc.exists:
+                self.logger.warning(f"Document {doc_id} not found in {self.collection_name}")
+                raise ResourceNotFoundError(
+                    resource_type=self.resource_type,
+                    resource_id=doc_id,
+                    additional_info={"collection": self.collection_name}
+                )
+
+            return doc.to_dict()
+
+        except ResourceNotFoundError:
+            raise
+        except Exception as e:
+            elapsed = (time.time() - start_time) * 1000
+            self.logger.error(f"Error getting document {doc_id} after {elapsed:.2f}ms: {str(e)}", exc_info=True)
+            raise ServiceError(
+                operation=f"retrieving {self.resource_type}",
+                error=e,
                 resource_type=self.resource_type,
                 resource_id=doc_id,
-                additional_info={"collection": self.collection_name}
-            )
-
-        return doc.to_dict()
+                additional_info={"collection": self.collection_name, "timeout": self.timeout}
+            ) from e
 
     async def update_document(self, doc_id: str, update_data: Dict[str, Any], updater_uid: str) -> 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:
+            # Apply timeout to the get operation
+            if not doc_ref.get(timeout=self.timeout).exists:
                 raise ResourceNotFoundError(
                     resource_type=self.resource_type,
                     resource_id=doc_id,
@@ -113,8 +149,10 @@ class BaseFirestoreService(Generic[T]):
                 'updated_by': updater_uid
             })
 
-            doc_ref.update(valid_fields)
-            return doc_ref.get().to_dict()
+            # Apply timeout to the update operation
+            doc_ref.update(valid_fields, timeout=self.timeout)
+            # Apply timeout to the get operation
+            return doc_ref.get(timeout=self.timeout).to_dict()
 
         except (ResourceNotFoundError, ValidationError):
             raise
@@ -131,13 +169,15 @@ class BaseFirestoreService(Generic[T]):
         """Standard delete method"""
         try:
             doc_ref = self.db.collection(self.collection_name).document(doc_id)
-            if not doc_ref.get().exists:
+            # Apply timeout to the get operation
+            if not doc_ref.get(timeout=self.timeout).exists:
                 raise ResourceNotFoundError(
                     resource_type=self.resource_type,
                     resource_id=doc_id
                 )
 
-            doc_ref.delete()
+            # Apply timeout to the delete operation
+            doc_ref.delete(timeout=self.timeout)
             self.logger.info(f"Deleted {self.resource_type}: {doc_id}")
 
         except ResourceNotFoundError:
@@ -151,6 +191,44 @@ class BaseFirestoreService(Generic[T]):
                 resource_id=doc_id
             ) from e
 
+    # Add query method with timeout
+    async def query_documents(
+        self,
+        filters: Optional[List[tuple]] = None,
+        limit: Optional[int] = None,
+        order_by: Optional[tuple] = None
+    ) -> List[Dict[str, Any]]:
+        """Query documents with filters, limit, and ordering"""
+        try:
+            # Start with the collection reference
+            query = self.db.collection(self.collection_name)
+
+            # Apply filters if provided
+            if filters:
+                for field, op, value in filters:
+                    query = query.where(field=field, op_string=op, value=value)
+
+            # Apply ordering if provided
+            if order_by:
+                field, direction = order_by
+                query = query.order_by(field, direction=direction)
+
+            # Apply limit if provided
+            if limit:
+                query = query.limit(limit)
+
+            # Execute query with timeout
+            docs = query.stream(timeout=self.timeout)
+            return [doc.to_dict() for doc in docs]
+
+        except Exception as e:
+            self.logger.error(f"Error querying {self.resource_type}: {e}", exc_info=True)
+            raise ServiceError(
+                operation=f"querying {self.resource_type}",
+                error=e,
+                resource_type=self.resource_type
+            ) from e
+
     def _validate_update_fields(self, update_data: Dict[str, Any]) -> Dict[str, Any]:
         """Centralized update fields validation"""
         if not isinstance(update_data, dict):

ipulse_shared_core_ftredge-12.0.1/src/ipulse_shared_core_ftredge/services/credit_service.py

@@ -0,0 +1,270 @@
+"""Service for managing credit operations in a generic way."""
+import logging
+from typing import Dict, Any, Optional, Tuple
+from datetime import datetime, timezone
+from google.cloud import firestore
+from ipulse_shared_core_ftredge.services import ServiceError, ResourceNotFoundError, ValidationError
+from ipulse_shared_core_ftredge.models.user_status import UserStatus
+
+# Default Firestore timeout if not provided by the consuming application
+DEFAULT_FIRESTORE_TIMEOUT = 15.0
+
+class CreditService:
+    """
+    Service class for credit operations.
+    Designed to be project-agnostic and directly uses UserStatus model constants.
+    """
+
+    def __init__(
+        self,
+        db: firestore.Client,
+        logger: Optional[logging.Logger] = None,
+        firestore_timeout: float = DEFAULT_FIRESTORE_TIMEOUT
+    ):
+        """
+        Initialize the credit service.
+
+        Args:
+            db: Firestore client.
+            logger: Optional logger instance. Defaults to a new logger for this module.
+            firestore_timeout: Timeout for Firestore operations in seconds.
+        """
+        self.db = db
+        # Use UserStatus constants directly
+        self.users_status_collection_name = UserStatus.COLLECTION_NAME
+        self.user_status_doc_prefix = f"{UserStatus.OBJ_REF}_" # Append underscore to OBJ_REF
+        self.logger = logger or logging.getLogger(__name__)
+        self.timeout = firestore_timeout
+
+        self.logger.info(
+            f"CreditService initialized using UserStatus constants. Collection: {self.users_status_collection_name}, "
+            f"Doc Prefix: {self.user_status_doc_prefix}, Timeout: {self.timeout}s"
+        )
+
+    async def verify_credits(
+        self,
+        user_uid: str,
+        required_credits_for_resource: float,
+        pre_fetched_user_credits: Optional[Dict[str, float]] = None
+    ) -> Tuple[bool, Dict[str, Any]]:
+        """
+        Verify if a user has enough credits for an operation.
+
+        Args:
+            user_uid: The user's UID.
+            required_credits_for_resource: The number of credits required for the operation.
+            pre_fetched_user_credits: Optional dict with pre-fetched credit info.
+                                      (keys: 'sbscrptn_based_insight_credits', 'extra_insight_credits')
+
+        Returns:
+            Tuple of (has_enough_credits, user_status_data) where user_status_data
+            will be a dict with keys 'sbscrptn_based_insight_credits' and 'extra_insight_credits'.
+
+        Raises:
+            ValidationError: If required_credits_for_resource is None (pricing not properly configured).
+        """
+        self.logger.info(
+            f"verify_credits called for user {user_uid}, "
+            f"required_credits={required_credits_for_resource}, "
+            f"pre_fetched_credits={pre_fetched_user_credits}"
+        )
+
+        if required_credits_for_resource is None:
+            self.logger.error(f"Credit cost is None for user {user_uid}, pricing not properly configured")
+            raise ValidationError(
+                resource_type="credit_cost",
+                detail="Credit cost is not configured for this resource",
+                resource_id=None, # Resource ID might not be known here, or could be passed
+                additional_info={"user_uid": user_uid}
+            )
+
+        if required_credits_for_resource <= 0:
+            self.logger.info(f"No credits required for user {user_uid}, bypassing credit verification")
+            return True, {"sbscrptn_based_insight_credits": 0, "extra_insight_credits": 0}
+
+        if pre_fetched_user_credits is not None:
+            self.logger.info(f"Using pre-fetched credit info for user {user_uid}")
+            subscription_credits = pre_fetched_user_credits.get("sbscrptn_based_insight_credits", 0)
+            extra_credits = pre_fetched_user_credits.get("extra_insight_credits", 0)
+            total_credits = subscription_credits + extra_credits
+
+            self.logger.info(
+                f"User {user_uid} has {total_credits} total pre-fetched credits "
+                f"(subscription: {subscription_credits}, extra: {extra_credits})"
+            )
+
+            userstatus_data_to_return = {
+                "sbscrptn_based_insight_credits": subscription_credits,
+                "extra_insight_credits": extra_credits
+            }
+
+            has_enough_credits = total_credits >= required_credits_for_resource
+            return has_enough_credits, userstatus_data_to_return
+
+        try:
+            self.logger.info(
+                f"Fetching user status from Firestore for user {user_uid} (collection: {self.users_status_collection_name})"
+            )
+            full_userstatus_doc = await self._get_userstatus(user_uid)
+
+            subscription_credits = full_userstatus_doc.get("sbscrptn_based_insight_credits", 0)
+            extra_credits = full_userstatus_doc.get("extra_insight_credits", 0)
+            total_credits = subscription_credits + extra_credits
+
+            self.logger.info(
+                f"User {user_uid} has {total_credits} total credits from Firestore "
+                f"(subscription: {subscription_credits}, extra: {extra_credits})"
+            )
+
+            has_enough_credits = total_credits >= required_credits_for_resource
+
+            userstatus_data_to_return = {
+                "sbscrptn_based_insight_credits": subscription_credits,
+                "extra_insight_credits": extra_credits
+            }
+
+            return has_enough_credits, userstatus_data_to_return
+
+        except ResourceNotFoundError:
+            self.logger.warning(f"User status not found for {user_uid} in {self.users_status_collection_name}. Assuming no credits.")
+            return False, {"sbscrptn_based_insight_credits": 0, "extra_insight_credits": 0}
+        except Exception as e:
+            self.logger.error(f"Error verifying credits for user {user_uid}: {str(e)}")
+            raise ServiceError(
+                operation="verifying credits",
+                error=e,
+                resource_type="user_credits",
+                resource_id=user_uid,
+                additional_info={"credits_to_charge": credits_to_charge}
+            ) from e
+
+    async def charge_credits(self, user_uid: str, credits_to_charge: Optional[float], operation_details: str) -> bool:
+        """
+        Charge a user's credits for an operation.
+
+        Args:
+            user_uid: The user's UID.
+            credits_to_charge: The number of credits to charge.
+            operation_details: Details about the operation (for logging).
+
+        Returns:
+            Whether the charging was successful.
+
+        Raises:
+            ValidationError: If credits_to_charge is None (pricing not properly configured).
+        """
+        if credits_to_charge is None:
+            self.logger.error(f"Credit cost is None for user {user_uid} (charge_credits), pricing not properly configured")
+            raise ValidationError(
+                resource_type="credit_cost",
+                detail="Credit cost is not configured for this resource (charge_credits)",
+                resource_id=None,
+                additional_info={"user_uid": user_uid}
+            )
+
+        if credits_to_charge == 0:
+            self.logger.info(f"No credits to charge for user {user_uid}, operation: {operation_details}")
+            return True
+
+        try:
+            userstatus_id = f"{self.user_status_doc_prefix}{user_uid}"
+            user_ref = self.db.collection(self.users_status_collection_name).document(userstatus_id)
+
+            transaction = self.db.transaction()
+
+            @firestore.transactional
+            def update_credits_transaction(transaction_obj, current_user_ref):
+                user_doc = current_user_ref.get(transaction=transaction_obj)
+                if not user_doc.exists:
+                    self.logger.warning(
+                        f"Cannot charge credits - user status not found for {user_uid} in {self.users_status_collection_name}"
+                    )
+                    return False
+
+                userstatus = user_doc.to_dict()
+
+                subscription_credits = userstatus.get("sbscrptn_based_insight_credits", 0)
+                extra_credits = userstatus.get("extra_insight_credits", 0)
+                total_credits = subscription_credits + extra_credits
+
+                if total_credits < credits_to_charge:
+                    self.logger.warning(
+                        f"Insufficient credits for user {user_uid} during transaction: "
+                        f"has {total_credits}, needs {credits_to_charge}"
+                    )
+                    return False
+
+                subscription_credits_to_charge = min(subscription_credits, credits_to_charge)
+                extra_credits_to_charge = credits_to_charge - subscription_credits_to_charge
+
+                update_data = {
+                    "updated_at": datetime.now(timezone.utc).isoformat(),
+                    "updated_by": "credit_service" # Consider making this configurable or more generic
+                }
+
+                if subscription_credits_to_charge > 0:
+                    update_data["sbscrptn_based_insight_credits"] = firestore.Increment(-subscription_credits_to_charge)
+                    update_data["sbscrptn_based_insight_credits_updtd_on"] = datetime.now(timezone.utc).isoformat()
+
+                if extra_credits_to_charge > 0:
+                    update_data["extra_insight_credits"] = firestore.Increment(-extra_credits_to_charge)
+                    update_data["extra_insight_credits_updtd_on"] = datetime.now(timezone.utc).isoformat()
+
+                transaction_obj.update(current_user_ref, update_data)
+                return True
+
+            success = update_credits_transaction(transaction, user_ref)
+
+            if success:
+                self.logger.info(
+                    f"Successfully charged {credits_to_charge} credits for user {user_uid}. "
+                    f"Operation: {operation_details}"
+                )
+            else:
+                self.logger.warning(
+                    f"Failed to charge {credits_to_charge} credits for user {user_uid} (transaction outcome). "
+                    f"Operation: {operation_details}"
+                )
+
+            return success
+
+        except Exception as e:
+            self.logger.error(f"Error charging credits for user {user_uid}: {str(e)}")
+            raise ServiceError(
+                operation="charging credits",
+                error=e,
+                resource_type="user_credits",
+                resource_id=user_uid,
+                additional_info={"credits_to_charge": credits_to_charge}
+            ) from e
+
+    async def _get_userstatus(self, user_uid: str) -> Dict[str, Any]:
+        """Get a user's status document."""
+        try:
+            userstatus_id = f"{self.user_status_doc_prefix}{user_uid}"
+            doc_ref = self.db.collection(self.users_status_collection_name).document(userstatus_id)
+
+            # Using the timeout value set during initialization
+            doc = await doc_ref.get(timeout=self.timeout)
+
+            if not doc.exists:
+                raise ResourceNotFoundError(
+                    resource_type="user_status", # Generic resource type
+                    resource_id=userstatus_id,
+                    additional_info={"collection": self.users_status_collection_name}
+                )
+
+            return doc.to_dict()
+
+        except ResourceNotFoundError:
+            raise
+        except Exception as e: # Catch generic Exception to handle potential timeout errors from Firestore client
+            self.logger.error(f"Error getting user status for {user_uid} from {self.users_status_collection_name}: {str(e)}")
+            raise ServiceError(
+                operation="getting user status",
+                error=e,
+                resource_type="user_status",
+                resource_id=user_uid,
+                additional_info={"collection": self.users_status_collection_name}
+            ) from e
+

ipulse_shared_core_ftredge-12.0.1/src/ipulse_shared_core_ftredge/utils/__init__.py

@@ -0,0 +1 @@
+from .json_encoder import EnsureJSONEncoderCompatibility

ipulse_shared_core_ftredge-12.0.1/src/ipulse_shared_core_ftredge/utils/json_encoder.py

@@ -0,0 +1,62 @@
+import json
+from datetime import datetime
+from enum import Enum
+from google.cloud.firestore_v1._helpers import DatetimeWithNanoseconds
+from google.api_core import datetime_helpers
+
+class EnsureJSONEncoderCompatibility(json.JSONEncoder):
+    """Custom JSON encoder that handles Firestore datetime types and other non-serializable objects."""
+    def default(self, obj):
+        # Handle datetime types
+        if isinstance(obj, (datetime, DatetimeWithNanoseconds, datetime_helpers.DatetimeWithNanoseconds)):
+            return obj.isoformat()
+        # Handle enum types
+        elif isinstance(obj, Enum):
+            return obj.value
+        # Handle pydantic models
+        elif hasattr(obj, 'model_dump'):
+            return obj.model_dump()
+        # Default behavior for other types
+        return super().default(obj)
+
+def convert_to_json_serializable(obj):
+    """
+    Recursively convert objects to JSON serializable format.
+    Handles datetime objects, Enums, and nested structures.
+
+    Args:
+        obj: Any Python object that might contain non-serializable types
+
+    Returns:
+        The object with all non-serializable types converted to serializable ones
+    """
+    # Handle None
+    if obj is None:
+        return None
+
+    # Handle datetime objects (including Firestore's DatetimeWithNanoseconds)
+    if hasattr(obj, 'isoformat'):
+        return obj.isoformat()
+
+    # Handle Enum values
+    elif isinstance(obj, Enum):
+        return obj.value
+
+    # Handle dictionaries
+    elif isinstance(obj, dict):
+        return {key: convert_to_json_serializable(value) for key, value in obj.items()}
+
+    # Handle lists and tuples
+    elif isinstance(obj, (list, tuple)):
+        return [convert_to_json_serializable(item) for item in obj]
+
+    # Handle sets
+    elif isinstance(obj, set):
+        return [convert_to_json_serializable(item) for item in obj]
+
+    # Handle Pydantic models and other objects with model_dump method
+    elif hasattr(obj, 'model_dump'):
+        return convert_to_json_serializable(obj.model_dump())
+
+    # Return primitive types as-is
+    return obj

{ipulse_shared_core_ftredge-10.1.1 → ipulse_shared_core_ftredge-12.0.1/src/ipulse_shared_core_ftredge.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipulse_shared_core_ftredge
-Version: 10.1.1
+Version: 12.0.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
@@ -13,7 +13,7 @@ Requires-Dist: pydantic[email]~=2.5
 Requires-Dist: python-dateutil~=2.8
 Requires-Dist: fastapi~=0.115.8
 Requires-Dist: pytest
-Requires-Dist: ipulse_shared_base_ftredge>=6.4.1
+Requires-Dist: ipulse_shared_base_ftredge==6.5.1
 Dynamic: author
 Dynamic: classifier
 Dynamic: home-page

{ipulse_shared_core_ftredge-10.1.1 → ipulse_shared_core_ftredge-12.0.1}/src/ipulse_shared_core_ftredge.egg-info/SOURCES.txt

@@ -25,6 +25,7 @@ src/ipulse_shared_core_ftredge/models/user_status.py
 src/ipulse_shared_core_ftredge/services/__init__.py
 src/ipulse_shared_core_ftredge/services/base_firestore_service.py
 src/ipulse_shared_core_ftredge/services/base_service_exceptions.py
+src/ipulse_shared_core_ftredge/services/credit_service.py
 src/ipulse_shared_core_ftredge/services/fastapiservicemon.py
 src/ipulse_shared_core_ftredge/services/servicemon.py
 src/ipulse_shared_core_ftredge/utils/__init__.py

{ipulse_shared_core_ftredge-10.1.1 → ipulse_shared_core_ftredge-12.0.1}/src/ipulse_shared_core_ftredge.egg-info/requires.txt

@@ -2,4 +2,4 @@ pydantic[email]~=2.5
 python-dateutil~=2.8
 fastapi~=0.115.8
 pytest
-ipulse_shared_base_ftredge>=6.4.1
+ipulse_shared_base_ftredge==6.5.1

ipulse_shared_core_ftredge-10.1.1/src/ipulse_shared_core_ftredge/models/base_data_model.py

@@ -1,41 +0,0 @@
-from datetime import datetime, timezone
-from typing import ClassVar
-from pydantic import BaseModel, Field, ConfigDict, field_validator
-import dateutil.parser
-
-class BaseDataModel(BaseModel):
-    """Base model with common fields and configuration"""
-    model_config = ConfigDict(frozen=True, extra="forbid")
-
-    # Required class variables that must be defined in subclasses
-    VERSION: ClassVar[float]
-    DOMAIN: ClassVar[str]
-    OBJ_REF: ClassVar[str]
-
-    # Schema versioning
-    schema_version: float = Field(
-        ...,  # Make this required
-        description="Version of this Class == version of DB Schema",
-        frozen=True
-    )
-
-    # Audit fields
-    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc), frozen=True)
-    created_by: str = Field(..., frozen=True)
-    updated_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc), frozen=True)
-    updated_by: str = Field(...)
-
-    @classmethod
-    def get_collection_name(cls) -> str:
-        """Generate standard collection name"""
-        return f"{cls.DOMAIN}_{cls.OBJ_REF}s"
-
-    @field_validator('created_at', 'updated_at', mode='before')
-    @classmethod
-    def parse_datetime(cls, v: any) -> datetime:
-        if isinstance(v, datetime):
-            return v
-        try:
-            return dateutil.parser.isoparse(v)
-        except (TypeError, ValueError) as e:
-            raise ValueError(f"Invalid datetime format: {e}")

ipulse_shared_core_ftredge-10.1.1/src/ipulse_shared_core_ftredge/utils/__init__.py

@@ -1 +0,0 @@
-from .json_encoder import CustomJSONEncoder

ipulse_shared_core_ftredge-10.1.1/src/ipulse_shared_core_ftredge/utils/json_encoder.py

@@ -1,13 +0,0 @@
-import json
-from datetime import datetime
-from google.cloud.firestore_v1._helpers import DatetimeWithNanoseconds
-from google.api_core import datetime_helpers
-
-class CustomJSONEncoder(json.JSONEncoder):
-    """Custom JSON encoder that handles Firestore datetime types."""
-    def default(self, obj):
-        if isinstance(obj, (datetime, DatetimeWithNanoseconds)):
-            return obj.isoformat()
-        if isinstance(obj, datetime_helpers.DatetimeWithNanoseconds):
-            return obj.isoformat()
-        return super().default(obj)