ipulse-shared-core-ftredge 27.1.1__tar.gz → 27.3.0__tar.gz

{ipulse_shared_core_ftredge-27.1.1/src/ipulse_shared_core_ftredge.egg-info → ipulse_shared_core_ftredge-27.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipulse_shared_core_ftredge
-Version: 27.1.1
+Version: 27.3.0
 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
@@ -12,7 +12,7 @@ License-File: LICENCE
 Requires-Dist: pydantic[email]~=2.5
 Requires-Dist: python-dateutil~=2.8
 Requires-Dist: fastapi~=0.115.8
-Requires-Dist: ipulse_shared_base_ftredge==11.1.1
+Requires-Dist: ipulse_shared_base_ftredge~=12.2.0
 Dynamic: author
 Dynamic: classifier
 Dynamic: home-page

{ipulse_shared_core_ftredge-27.1.1 → ipulse_shared_core_ftredge-27.3.0}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='ipulse_shared_core_ftredge',
-    version='27.1.1',
+    version='27.3.0',
     package_dir={'': 'src'},  # Specify the source directory
     packages=find_packages(where='src'),  # Look for packages in 'src'
     install_requires=[
@@ -11,7 +11,7 @@ setup(
         'pydantic[email]~=2.5',
         'python-dateutil~=2.8',
         'fastapi~=0.115.8',
-        'ipulse_shared_base_ftredge==11.1.1',
+        'ipulse_shared_base_ftredge~=12.2.0',
     ],
     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-27.1.1 → ipulse_shared_core_ftredge-27.3.0}/src/ipulse_shared_core_ftredge/models/catalog/subscriptionplan.py

@@ -10,7 +10,7 @@ from enum import StrEnum
 from datetime import datetime, timezone, timedelta
 from pydantic import Field, ConfigDict, field_validator,model_validator, BaseModel
 from ipulse_shared_base_ftredge import (Layer, Module, list_enums_as_lower_strings,
-                                        Subject, SubscriptionPlanName,ObjectOverallStatus,
+                                        SystemSubject, SubscriptionPlanName,ObjectOverallStatus,
                                         SubscriptionStatus, TimeUnit)
 from ..base_data_model import BaseDataModel
 from ..user.user_permissions import UserPermission
@@ -60,7 +60,7 @@ class SubscriptionPlan(BaseDataModel):
     model_config = ConfigDict(extra="forbid")
 
     VERSION: ClassVar[float] = 1.0
-    DOMAIN: ClassVar[str] = "_".join(list_enums_as_lower_strings(Layer.PULSE_APP, Module.CORE, Subject.CATALOG))
+    DOMAIN: ClassVar[str] = "_".join(list_enums_as_lower_strings(Layer.PULSE_APP, Module.CORE, SystemSubject.CATALOG))
     OBJ_REF: ClassVar[str] = "subscriptionplan"
 
     # System-managed fields

{ipulse_shared_core_ftredge-27.1.1 → ipulse_shared_core_ftredge-27.3.0}/src/ipulse_shared_core_ftredge/models/catalog/usertype.py

@@ -9,7 +9,7 @@ based on their user type (superadmin, admin, internal, authenticated, anonymous)
 from typing import Dict, Any, Optional, ClassVar, List
 from datetime import datetime
 from pydantic import Field, ConfigDict, field_validator, model_validator
-from ipulse_shared_base_ftredge import Layer, Module, list_enums_as_lower_strings, Subject, ObjectOverallStatus
+from ipulse_shared_base_ftredge import Layer, Module, list_enums_as_lower_strings, SystemSubject, ObjectOverallStatus
 from ipulse_shared_base_ftredge.enums.enums_iam import IAMUserType
 from ipulse_shared_core_ftredge.models.base_data_model import BaseDataModel
 from ipulse_shared_core_ftredge.models.user.user_permissions import UserPermission
@@ -28,7 +28,7 @@ class UserType(BaseDataModel):
     model_config = ConfigDict(extra="forbid")
 
     VERSION: ClassVar[float] = 1.0
-    DOMAIN: ClassVar[str] = "_".join(list_enums_as_lower_strings(Layer.PULSE_APP, Module.CORE.name, Subject.CATALOG.name))
+    DOMAIN: ClassVar[str] = "_".join(list_enums_as_lower_strings(Layer.PULSE_APP, Module.CORE.name, SystemSubject.CATALOG.name))
     OBJ_REF: ClassVar[str] = "usertype"
 
     # System-managed fields

ipulse_shared_core_ftredge-27.3.0/src/ipulse_shared_core_ftredge/models/time_series_packaged_dataset_model.py

@@ -0,0 +1,45 @@
+# pylint: disable=missing-module-docstring, missing-class-docstring
+from typing import List, Optional, TypeVar, Generic
+from datetime import datetime
+from pydantic import Field, BaseModel
+from ipulse_shared_core_ftredge.models.base_data_model import BaseDataModel
+
+# Generic type for the records within the dataset
+RecordsSamplingType = TypeVar('RecordsSamplingType', bound=BaseModel)
+
+class TimeSeriesPackagedDatasetModel(BaseDataModel, Generic[RecordsSamplingType]):
+    """
+    An intermediary model for time series datasets that holds aggregated records.
+    It provides a generic way to handle different types of time series records.
+    """
+    # Subject identification fields
+    subject_id: str = Field(default="", description="The unique identifier for the subject.")
+    pulse_sector_category: str = Field(default="", description="The sector category for the subject.")
+
+    # Schema identification fields
+    schema_id: str = Field(default="", description="The unique identifier for the schema.")
+    schema_name: str = Field(default="", description="The name of the schema.")
+    schema_version: int = Field(default=1, description="The version of the schema.")
+
+    # Generic lists for different temporal buckets of records
+    max_bulk_records: List[RecordsSamplingType] = Field(default_factory=list)
+    latest_bulk_records: Optional[List[RecordsSamplingType]] = Field(default_factory=list)
+    latest_intraday_records: Optional[List[RecordsSamplingType]] = Field(default_factory=list)
+
+    # Metadata fields
+    max_bulk_updated_at: Optional[datetime] = None
+    max_bulk_updated_by: Optional[str] = None
+    max_bulk_recent_date_id: Optional[datetime] = None
+    max_bulk_oldest_date_id: Optional[datetime] = None
+    latest_bulk_recent_date_id: Optional[datetime] = None
+    latest_bulk_oldest_date_id: Optional[datetime] = None
+    latest_record_updated_at: Optional[datetime] = None
+    latest_record_updated_by: Optional[str] = None
+    latest_record_change_id: Optional[str] = None
+    latest_intraday_bulk_updated_at: Optional[datetime] = None
+    latest_intraday_bulk_updated_by: Optional[str] = None
+
+    @property
+    def id(self) -> str:
+        """Return subject_id for backward compatibility and consistency."""
+        return self.subject_id

{ipulse_shared_core_ftredge-27.1.1 → ipulse_shared_core_ftredge-27.3.0}/src/ipulse_shared_core_ftredge/models/user/user_subscription.py

@@ -3,7 +3,7 @@ from dateutil.relativedelta import relativedelta
 import uuid
 from typing import Optional, ClassVar, Dict, Any, List
 from pydantic import Field, ConfigDict, model_validator
-from ipulse_shared_base_ftredge import Layer, Module, list_enums_as_lower_strings, Subject, SubscriptionPlanName, SubscriptionStatus, TimeUnit
+from ipulse_shared_base_ftredge import Layer, Module, list_enums_as_lower_strings, SystemSubject, SubscriptionPlanName, SubscriptionStatus, TimeUnit
 from ..base_data_model import BaseDataModel
 from .user_permissions import UserPermission
 # ORIGINAL AUTHOR ="russlan.ramdowar;russlan@ftredge.com"
@@ -22,7 +22,7 @@ class UserSubscription(BaseDataModel):
     model_config = ConfigDict(frozen=True, extra="forbid")
 
     VERSION: ClassVar[float] = 3.0  # Incremented version for direct fields instead of computed
-    DOMAIN: ClassVar[str] = "_".join(list_enums_as_lower_strings(Layer.PULSE_APP, Module.CORE, Subject.SUBSCRIPTION))
+    DOMAIN: ClassVar[str] = "_".join(list_enums_as_lower_strings(Layer.PULSE_APP, Module.CORE, SystemSubject.SUBSCRIPTION))
     OBJ_REF: ClassVar[str] = "subscription"
 
     # System-managed fields (read-only)

{ipulse_shared_core_ftredge-27.1.1 → ipulse_shared_core_ftredge-27.3.0}/src/ipulse_shared_core_ftredge/models/user/userprofile.py

@@ -3,7 +3,7 @@ from datetime import date, datetime
 import re  # Add re import
 from typing import Set, Optional, ClassVar, Dict, Any, List
 from pydantic import EmailStr, Field, ConfigDict, model_validator, field_validator
-from ipulse_shared_base_ftredge import Layer, Module, list_enums_as_lower_strings, Subject, IAMUserType
+from ipulse_shared_base_ftredge import Layer, Module, list_enums_as_lower_strings, SystemSubject, IAMUserType
 from ..base_data_model import BaseDataModel
 # ORIGINAL AUTHOR ="Russlan Ramdowar;russlan@ftredge.com"
 # CLASS_ORGIN_DATE=datetime(2024, 2, 12, 20, 5)
@@ -17,7 +17,7 @@ class UserProfile(BaseDataModel):
 
     # Class constants
     VERSION: ClassVar[float] = 5.0  # Incremented version for primary_usertype addition
-    DOMAIN: ClassVar[str] = "_".join(list_enums_as_lower_strings(Layer.PULSE_APP, Module.CORE, Subject.USER))
+    DOMAIN: ClassVar[str] = "_".join(list_enums_as_lower_strings(Layer.PULSE_APP, Module.CORE, SystemSubject.USER))
     OBJ_REF: ClassVar[str] = "userprofile"
 
     schema_version: float = Field(

{ipulse_shared_core_ftredge-27.1.1 → ipulse_shared_core_ftredge-27.3.0}/src/ipulse_shared_core_ftredge/models/user/userstatus.py

@@ -2,7 +2,7 @@
 from datetime import datetime, timezone, timedelta
 from typing import Set, Optional, Dict, List, ClassVar, Any
 from pydantic import Field, ConfigDict, model_validator, field_validator
-from ipulse_shared_base_ftredge import Layer, Module, list_enums_as_lower_strings, Subject, TimeUnit
+from ipulse_shared_base_ftredge import Layer, Module, list_enums_as_lower_strings, SystemSubject, TimeUnit
 from ipulse_shared_base_ftredge.enums.enums_iam import IAMUnit
 from .user_subscription import UserSubscription
 from ..base_data_model import BaseDataModel
@@ -20,7 +20,7 @@ class UserStatus(BaseDataModel):
 
     # Class constants
     VERSION: ClassVar[float] = 7.0  # Major version bump for flattened IAM permissions structure
-    DOMAIN: ClassVar[str] = "_".join(list_enums_as_lower_strings(Layer.PULSE_APP, Module.CORE, Subject.USER))
+    DOMAIN: ClassVar[str] = "_".join(list_enums_as_lower_strings(Layer.PULSE_APP, Module.CORE, SystemSubject.USER))
     OBJ_REF: ClassVar[str] = "userstatus"
 
     # Centralized collection name and document ID prefix

{ipulse_shared_core_ftredge-27.1.1 → ipulse_shared_core_ftredge-27.3.0}/src/ipulse_shared_core_ftredge/services/__init__.py

@@ -2,7 +2,7 @@
 
 
 # Import from base services
-from .base import BaseFirestoreService, CacheAwareFirestoreService
+from .base import BaseFirestoreService, CacheAwareFirestoreService, MultiCollectionCacheAwareFirestoreService
 
 from .charging_processors import ChargingProcessor
 from .user_charging_service import UserChargingService

{ipulse_shared_core_ftredge-27.1.1 → ipulse_shared_core_ftredge-27.3.0}/src/ipulse_shared_core_ftredge/services/base/__init__.py

@@ -7,6 +7,7 @@ preventing circular import dependencies.
 
 from .base_firestore_service import BaseFirestoreService
 from .cache_aware_firestore_service import CacheAwareFirestoreService
+from .multi_collection_cache_aware_firestore_service import MultiCollectionCacheAwareFirestoreService
 
 __all__ = [
     'BaseFirestoreService',

ipulse_shared_core_ftredge-27.3.0/src/ipulse_shared_core_ftredge/services/base/multi_collection_cache_aware_firestore_service.py

@@ -0,0 +1,244 @@
+"""
+Generic multi-collection cache-aware Firestore service.
+
+This service extends CacheAwareFirestoreService to support dynamic collection operations
+while maintaining all proven infrastructure patterns. It's designed to be generic and
+reusable across different model types.
+"""
+from typing import Dict, Any, List, Optional, Union, Type, TypeVar, Generic
+from google.cloud import firestore
+from .cache_aware_firestore_service import CacheAwareFirestoreService
+from ...exceptions import ServiceError, ValidationError, ResourceNotFoundError
+from ...cache.shared_cache import SharedCache
+from ...models import BaseDataModel
+import logging
+
+# Generic type for BaseDataModel subclasses
+T = TypeVar('T', bound=BaseDataModel)
+
+
+class MultiCollectionCacheAwareFirestoreService(CacheAwareFirestoreService[T], Generic[T]):
+    """
+    Generic multi-collection extension of CacheAwareFirestoreService.
+
+    This service extends the proven CacheAwareFirestoreService infrastructure to support
+    dynamic collection operations based on storage_location_path while maintaining
+    all caching, error handling, and CRUD capabilities.
+
+    This is a generic base class that can be extended for specific model types.
+    """
+
+    def __init__(self,
+                 db: firestore.Client,
+                 logger: logging.Logger,
+                 model_class: Type[T],
+                 resource_type: str,
+                 base_collection_name: str,
+                 timeout: float = 30.0):
+
+        # Initialize the parent CacheAwareFirestoreService with a base collection
+        # We'll override the collection_name dynamically per operation
+        super().__init__(
+            db=db,
+            collection_name=base_collection_name,  # Base collection name
+            resource_type=resource_type,
+            model_class=model_class,
+            logger=logger,
+            document_cache=None,  # We'll manage caches per collection
+            collection_cache=None,  # We'll manage caches per collection
+            timeout=timeout
+        )
+
+        # Cache for per-collection cache instances
+        self._collection_caches: Dict[str, Dict[str, SharedCache]] = {}
+
+        self.logger.info(f"MultiCollectionCacheAwareFirestoreService initialized for {resource_type}")
+
+    def _get_collection_caches(self, storage_location_path: str) -> Dict[str, SharedCache]:
+        """Get or create cache instances for a specific storage location."""
+        if storage_location_path not in self._collection_caches:
+            # Create collection-specific cache instances
+            # No need for safe_name transformation - dots are fine in strings
+
+            document_cache = SharedCache(
+                name=f"MultiColDoc_{storage_location_path}",
+                ttl=600.0,  # 10 minutes
+                enabled=True,
+                logger=self.logger
+            )
+
+            collection_cache = SharedCache(
+                name=f"MultiColCollection_{storage_location_path}",
+                ttl=600.0,  # 10 minutes
+                enabled=True,
+                logger=self.logger
+            )
+
+            self._collection_caches[storage_location_path] = {
+                'document': document_cache,
+                'collection': collection_cache
+            }
+
+            self.logger.info(f"Created cache instances for collection: {storage_location_path}")
+
+        return self._collection_caches[storage_location_path]
+
+    def _set_collection_context(self, storage_location_path: str):
+        """Set the collection context for the current operation."""
+        # Update the collection name for this operation
+        self.collection_name = storage_location_path
+
+        # Update the cache references for this collection
+        caches = self._get_collection_caches(storage_location_path)
+        self.document_cache = caches['document']
+        self.collection_cache = caches['collection']
+
+    async def get_document_from_collection(self,
+                                         storage_location_path: str,
+                                         doc_id: str,
+                                         convert_to_model: bool = True) -> Union[T, Dict[str, Any], None]:
+        """
+        Get a document from a specific collection using the cache-aware infrastructure.
+        """
+        try:
+            # Set collection context
+            self._set_collection_context(storage_location_path)
+
+            # Use the parent's cache-aware get_document method
+            return await super().get_document(doc_id, convert_to_model)
+
+        except ResourceNotFoundError:
+            self.logger.info(f"Document {doc_id} not found in {storage_location_path}")
+            return None
+        except Exception as e:
+            self.logger.error(f"Error getting document {doc_id} from {storage_location_path}: {str(e)}", exc_info=True)
+            raise ServiceError(
+                operation=f"getting document from {storage_location_path}",
+                error=e,
+                resource_type=self.resource_type,
+                resource_id=doc_id
+            ) from e
+
+    async def get_all_documents_from_collection(self,
+                                              storage_location_path: str,
+                                              cache_key: Optional[str] = None) -> List[T]:
+        """
+        Get all documents from a specific collection using cache-aware infrastructure.
+        """
+        try:
+            # Set collection context
+            self._set_collection_context(storage_location_path)
+
+            # Use cache key if not provided
+            if not cache_key:
+                cache_key = f"all_documents_{storage_location_path}"
+
+            # Use the parent's cache-aware get_all_documents method
+            results = await super().get_all_documents(cache_key=cache_key, as_models=True)
+
+            # Ensure we return model instances
+            model_results: List[T] = []
+            for item in results:
+                if isinstance(item, BaseDataModel) and self.model_class and isinstance(item, self.model_class):
+                    model_results.append(item)  # type: ignore
+                elif isinstance(item, dict) and self.model_class:
+                    try:
+                        model_results.append(self.model_class.model_validate(item))
+                    except Exception as e:
+                        self.logger.warning(f"Failed to convert dict to model: {e}")
+
+            return model_results
+
+        except Exception as e:
+            self.logger.error(f"Error getting all documents from {storage_location_path}: {str(e)}", exc_info=True)
+            raise ServiceError(
+                operation=f"getting all documents from {storage_location_path}",
+                error=e,
+                resource_type=self.resource_type
+            ) from e
+
+    async def create_document_in_collection(self,
+                                          storage_location_path: str,
+                                          doc_id: str,
+                                          data: Union[T, Dict[str, Any]],
+                                          creator_uid: str,
+                                          merge: bool = False) -> Dict[str, Any]:
+        """
+        Create a document in a specific collection using cache-aware infrastructure.
+        Automatically handles cache invalidation.
+        """
+        try:
+            # Set collection context
+            self._set_collection_context(storage_location_path)
+
+            # Use the parent's cache-aware create_document method
+            return await super().create_document(doc_id, data, creator_uid, merge)
+
+        except Exception as e:
+            self.logger.error(f"Error creating document {doc_id} in {storage_location_path}: {str(e)}", exc_info=True)
+            raise ServiceError(
+                operation=f"creating document in {storage_location_path}",
+                error=e,
+                resource_type=self.resource_type,
+                resource_id=doc_id
+            ) from e
+
+    async def update_document_in_collection(self,
+                                          storage_location_path: str,
+                                          doc_id: str,
+                                          update_data: Dict[str, Any],
+                                          updater_uid: str,
+                                          require_exists: bool = True) -> Dict[str, Any]:
+        """
+        Update a document in a specific collection using cache-aware infrastructure.
+        Automatically handles cache invalidation.
+        """
+        try:
+            # Set collection context
+            self._set_collection_context(storage_location_path)
+
+            # Use the parent's cache-aware update_document method
+            return await super().update_document(doc_id, update_data, updater_uid, require_exists)
+
+        except Exception as e:
+            self.logger.error(f"Error updating document {doc_id} in {storage_location_path}: {str(e)}", exc_info=True)
+            raise ServiceError(
+                operation=f"updating document in {storage_location_path}",
+                error=e,
+                resource_type=self.resource_type,
+                resource_id=doc_id
+            ) from e
+
+    async def delete_document_from_collection(self,
+                                            storage_location_path: str,
+                                            doc_id: str,
+                                            require_exists: bool = True) -> bool:
+        """
+        Delete a document from a specific collection using cache-aware infrastructure.
+        Automatically handles cache invalidation.
+        """
+        try:
+            # Set collection context
+            self._set_collection_context(storage_location_path)
+
+            # Use the parent's cache-aware delete_document method
+            return await super().delete_document(doc_id, require_exists)
+
+        except Exception as e:
+            self.logger.error(f"Error deleting document {doc_id} from {storage_location_path}: {str(e)}", exc_info=True)
+            raise ServiceError(
+                operation=f"deleting document from {storage_location_path}",
+                error=e,
+                resource_type=self.resource_type,
+                resource_id=doc_id
+            ) from e
+
+    def get_cache_stats(self) -> Dict[str, Any]:
+        """Get cache statistics for all collections managed by this service."""
+        stats = {}
+        for storage_path, caches in self._collection_caches.items():
+            stats[storage_path] = {
+                'document_cache': caches['document'].get_stats(),
+                'collection_cache': caches['collection'].get_stats()
+            }
+        return stats

{ipulse_shared_core_ftredge-27.1.1 → ipulse_shared_core_ftredge-27.3.0/src/ipulse_shared_core_ftredge.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipulse_shared_core_ftredge
-Version: 27.1.1
+Version: 27.3.0
 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
@@ -12,7 +12,7 @@ License-File: LICENCE
 Requires-Dist: pydantic[email]~=2.5
 Requires-Dist: python-dateutil~=2.8
 Requires-Dist: fastapi~=0.115.8
-Requires-Dist: ipulse_shared_base_ftredge==11.1.1
+Requires-Dist: ipulse_shared_base_ftredge~=12.2.0
 Dynamic: author
 Dynamic: classifier
 Dynamic: home-page

{ipulse_shared_core_ftredge-27.1.1 → ipulse_shared_core_ftredge-27.3.0}/src/ipulse_shared_core_ftredge.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ src/ipulse_shared_core_ftredge/models/base_api_response.py
 src/ipulse_shared_core_ftredge/models/base_data_model.py
 src/ipulse_shared_core_ftredge/models/credit_api_response.py
 src/ipulse_shared_core_ftredge/models/custom_json_response.py
+src/ipulse_shared_core_ftredge/models/time_series_packaged_dataset_model.py
 src/ipulse_shared_core_ftredge/models/catalog/__init__.py
 src/ipulse_shared_core_ftredge/models/catalog/subscriptionplan.py
 src/ipulse_shared_core_ftredge/models/catalog/usertype.py
@@ -41,6 +42,7 @@ src/ipulse_shared_core_ftredge/services/user_charging_service.py
 src/ipulse_shared_core_ftredge/services/base/__init__.py
 src/ipulse_shared_core_ftredge/services/base/base_firestore_service.py
 src/ipulse_shared_core_ftredge/services/base/cache_aware_firestore_service.py
+src/ipulse_shared_core_ftredge/services/base/multi_collection_cache_aware_firestore_service.py
 src/ipulse_shared_core_ftredge/services/catalog/__init__.py
 src/ipulse_shared_core_ftredge/services/catalog/catalog_subscriptionplan_service.py
 src/ipulse_shared_core_ftredge/services/catalog/catalog_usertype_service.py

{ipulse_shared_core_ftredge-27.1.1 → ipulse_shared_core_ftredge-27.3.0}/src/ipulse_shared_core_ftredge.egg-info/requires.txt

@@ -1,4 +1,4 @@
 pydantic[email]~=2.5
 python-dateutil~=2.8
 fastapi~=0.115.8
-ipulse_shared_base_ftredge==11.1.1
+ipulse_shared_base_ftredge~=12.2.0