ipulse-shared-core-ftredge 20.0.1__py3-none-any.whl → 23.1.1__py3-none-any.whl

ipulse_shared_core_ftredge/services/{charging_service.py → user_charging_service.py}

@@ -4,12 +4,12 @@ from typing import Dict, Any, Optional, Tuple
 from datetime import datetime, timezone
 from google.cloud import firestore
 from ipulse_shared_core_ftredge.exceptions import ServiceError, ResourceNotFoundError, ValidationError
-from ipulse_shared_core_ftredge.models.user_status import UserStatus
+from ipulse_shared_core_ftredge.models import UserStatus
 
 # Default Firestore timeout if not provided by the consuming application
 DEFAULT_FIRESTORE_TIMEOUT = 15.0
 
-class ChargingService:
+class UserChargingService:
     """
     Service class for charging operations.
     Designed to be project-agnostic and directly uses UserStatus model constants.
@@ -32,13 +32,13 @@ class ChargingService:
         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.userstatus_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"ChargingService initialized using UserStatus constants. Collection: {self.users_status_collection_name}, "
-            f"Doc Prefix: {self.user_status_doc_prefix}, Timeout: {self.timeout}s"
+            f"Doc Prefix: {self.userstatus_doc_prefix}, Timeout: {self.timeout}s"
         )
 
     async def verify_credits(
@@ -57,7 +57,7 @@ class ChargingService:
                                       (keys: 'sbscrptn_based_insight_credits', 'extra_insight_credits')
 
         Returns:
-            Tuple of (has_enough_credits, user_status_data) where user_status_data
+            Tuple of (has_enough_credits, userstatus_data) where userstatus_data
             will be a dict with keys 'sbscrptn_based_insight_credits' and 'extra_insight_credits'.
 
         Raises:
@@ -174,7 +174,7 @@ class ChargingService:
 
 
         try:
-            userstatus_id = f"{self.user_status_doc_prefix}{user_uid}"
+            userstatus_id = f"{self.userstatus_doc_prefix}{user_uid}"
             user_ref = self.db.collection(self.users_status_collection_name).document(userstatus_id)
 
             transaction = self.db.transaction()
@@ -277,7 +277,7 @@ class ChargingService:
     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}"
+            userstatus_id = f"{self.userstatus_doc_prefix}{user_uid}"
             doc_ref = self.db.collection(self.users_status_collection_name).document(userstatus_id)
 
             # Using the timeout value set during initialization
@@ -285,7 +285,7 @@ class ChargingService:
 
             if not doc.exists:
                 raise ResourceNotFoundError(
-                    resource_type="user_status", # Generic resource type
+                    resource_type="userstatus", # Generic resource type
                     resource_id=userstatus_id,
                     additional_info={"collection": self.users_status_collection_name}
                 )
@@ -299,7 +299,7 @@ class ChargingService:
             raise ServiceError(
                 operation="getting user status",
                 error=e,
-                resource_type="user_status",
+                resource_type="userstatus",
                 resource_id=user_uid,
                 additional_info={"collection": self.users_status_collection_name}
             ) from e

{ipulse_shared_core_ftredge-20.0.1.dist-info → ipulse_shared_core_ftredge-23.1.1.dist-info}/METADATA

@@ -1,19 +1,18 @@
 Metadata-Version: 2.4
 Name: ipulse_shared_core_ftredge
-Version: 20.0.1
+Version: 23.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
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.11
+Requires-Python: >=3.12
 License-File: LICENCE
 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==7.2.0
+Requires-Dist: ipulse_shared_base_ftredge==10.2.1
 Dynamic: author
 Dynamic: classifier
 Dynamic: home-page

ipulse_shared_core_ftredge-23.1.1.dist-info/RECORD

@@ -0,0 +1,50 @@
+ipulse_shared_core_ftredge/__init__.py,sha256=-KbdF_YW8pgf7pVv9qh_cA1xrNm_B9zigHYDo7ZA4eU,42
+ipulse_shared_core_ftredge/cache/__init__.py,sha256=i2fPojmZiBwAoY5ovnnnME9USl4bi8MRPYkAgEfACfI,136
+ipulse_shared_core_ftredge/cache/shared_cache.py,sha256=BDJtkTsdfmVjKaUkbBXOhJ2Oib7Li0UCsPjWX7FLIPU,12940
+ipulse_shared_core_ftredge/dependencies/__init__.py,sha256=HGsR8HUguKTfjz_BorCILS4izX8CAjG-apE0kIPE0Yo,68
+ipulse_shared_core_ftredge/dependencies/auth_firebase_token_validation.py,sha256=iwNqOEFHEF0qK7vfRPRXpAexTwF5UOLsfdir1wEo9_E,3646
+ipulse_shared_core_ftredge/dependencies/auth_protected_router.py,sha256=em5D5tE7OkgZmuCtYCKuUAnIZCgRJhCF8Ye5QmtGWlk,1807
+ipulse_shared_core_ftredge/dependencies/authz_for_apis.py,sha256=t2hz1wAVxCT0lCDVf6gmcYeLuUCR7mIXYsThKg0cIlM,14992
+ipulse_shared_core_ftredge/dependencies/firestore_client.py,sha256=VbTb121nsc9EZPd1RDEsHBLW5pIiVw6Wdo2JFL4afMg,714
+ipulse_shared_core_ftredge/exceptions/__init__.py,sha256=Cb_RsIie4DbT_NLwFVwjw4riDKsNNRQEuAvHvYa-Zco,1038
+ipulse_shared_core_ftredge/exceptions/base_exceptions.py,sha256=117YsiCbYLLBu_D0IffYFVSX2yh-pisALMtoSMwj6xI,5338
+ipulse_shared_core_ftredge/exceptions/user_exceptions.py,sha256=I-nm21MKrUYEoybpRODeYNzc184HfgHvRZQm_xux4VY,6824
+ipulse_shared_core_ftredge/models/__init__.py,sha256=oaBL_BZWd7hIDu2K7yxtVKxtkOD9UF9r9_V2ZIPQ8Yk,350
+ipulse_shared_core_ftredge/models/base_api_response.py,sha256=OwuWI2PsMSLDkFt643u35ZhW5AHFEMMAGnGprmUO0fA,2380
+ipulse_shared_core_ftredge/models/base_data_model.py,sha256=GZ7KTT5FanHTgvmaHHTxawzAJtuixkbyb-SuL-mjWys,2193
+ipulse_shared_core_ftredge/models/catalog/__init__.py,sha256=9oKJ74_mTtmj-0iDnRBiPI8m8QJ2J9wvx4ZWaZw3zRk,208
+ipulse_shared_core_ftredge/models/catalog/subscriptionplan.py,sha256=WxKWzTmHJlvFQj6Kq69iWMoFkx_veiPhonFo8dUGzZw,9148
+ipulse_shared_core_ftredge/models/catalog/usertype.py,sha256=E_qQCq7ytiFca6umaX_-_a6TuDh83YwSKtFKdeU4ErM,6584
+ipulse_shared_core_ftredge/models/user/__init__.py,sha256=TheOLldY6v-OK9i-A5mQNIxjHhBFpuOJ43mi-swcN_o,196
+ipulse_shared_core_ftredge/models/user/user_permissions.py,sha256=CUWDBPLPmKN3o43BTZAt0zJvm_ekjJA46iV6rVNp-oc,2411
+ipulse_shared_core_ftredge/models/user/user_subscription.py,sha256=83ncQUHUYF6S19KdZM7-nLEVjD4VPIO88ZRVkXeNnE8,13514
+ipulse_shared_core_ftredge/models/user/userauth.py,sha256=PbS-XSLxDl1feskI0iCziGvmMiLuF8o_ZTspAx1B0j0,3679
+ipulse_shared_core_ftredge/models/user/userprofile.py,sha256=7VbE4qiKpDxZsNTk-IJKA32QxW0JOo8KWPkj8h9J2-Y,6945
+ipulse_shared_core_ftredge/models/user/userstatus.py,sha256=9BGaKiKL3JeSNQ8ZRRc0taLgSu0uxtBu5NRVsCbVXW4,18776
+ipulse_shared_core_ftredge/monitoring/__init__.py,sha256=gUoJjT0wj-cQYnMWheWbh1mmRHmaeojmnBZTj7KPNus,61
+ipulse_shared_core_ftredge/monitoring/tracemon.py,sha256=Trku0qrwWvEcvKsBWiYokd_G3fcH-5uP2wRVgcgIz_k,11596
+ipulse_shared_core_ftredge/services/__init__.py,sha256=9AkMLCHNswhuNbQuJZaEVz4zt4F84PxfJLyU_bYk4Js,565
+ipulse_shared_core_ftredge/services/charging_processors.py,sha256=9Re24dyXdjKYbqwx6uNLu3JBzIaw87TAV7Oe__M1QnA,16308
+ipulse_shared_core_ftredge/services/user_charging_service.py,sha256=C3wMfgBXOz4RM1RLc7up2_pIPAnZv8ZYu-lLrkofTmc,14625
+ipulse_shared_core_ftredge/services/base/__init__.py,sha256=zhyrHQMM0cLJr4spk2b6VsgJXuWBy7hUBzhrq_Seg9k,389
+ipulse_shared_core_ftredge/services/base/base_firestore_service.py,sha256=leZFwxb1ruheypqudpKnuNtRQXtO4KNeoJk6ZACozHc,19512
+ipulse_shared_core_ftredge/services/base/cache_aware_firestore_service.py,sha256=ya5Asff9BQodYnJVAw6M_Pm8WtVRPpEK7izFlZ2MyjA,10016
+ipulse_shared_core_ftredge/services/catalog/__init__.py,sha256=ctc2nDGwsW_Ji4lk9pys3oyNwR_V-gHSbSHawym5fKQ,385
+ipulse_shared_core_ftredge/services/catalog/catalog_subscriptionplan_service.py,sha256=X5xAi9sOk_F1ky0ECwPVlwIPPsN2PrZC6bN_pASGDjQ,9702
+ipulse_shared_core_ftredge/services/catalog/catalog_usertype_service.py,sha256=C_VWxZ5iPcybjsSXdmZHyqS--rI3KY8pp7JDIy_L7S8,12833
+ipulse_shared_core_ftredge/services/user/__init__.py,sha256=jmkD5XzAmaD8QV2UsgB5xynGcfsXliWtRtN2pt6kzbA,884
+ipulse_shared_core_ftredge/services/user/user_core_service.py,sha256=o0trN4yTbyh-BJbXnin9XmS8hW5jOQW6RdegdQ2sRNo,28269
+ipulse_shared_core_ftredge/services/user/user_multistep_operations.py,sha256=0MfMaKLGpVsgfD-Vgaa4s2dKk9nNoH6snWx_skkPy_o,39705
+ipulse_shared_core_ftredge/services/user/user_permissions_operations.py,sha256=FByszIWo-qooLVXFTw0tGLWksIJEqHUPc_ZGwue0_pM,15753
+ipulse_shared_core_ftredge/services/user/user_subscription_operations.py,sha256=z98EO67wHlnDj1V7JK14yq6yaIoTVcX5X5v4-taZFHw,21651
+ipulse_shared_core_ftredge/services/user/userauth_operations.py,sha256=9l2uBAcAxbUnilK8MZ7IlHzaGiaPuqx7nIC51mAyR9w,36120
+ipulse_shared_core_ftredge/services/user/userprofile_operations.py,sha256=_qyIEAQYCTV-subgP-5naMs_26apCpauomE6qmCCVWs,7333
+ipulse_shared_core_ftredge/services/user/userstatus_operations.py,sha256=sW4Q-aMG1mjKvqVKK5AA93-G57FPBCkxO7rPfCkhBd8,22726
+ipulse_shared_core_ftredge/utils/__init__.py,sha256=JnxUb8I2MRjJC7rBPXSrpwBIQDEOku5O9JsiTi3oun8,56
+ipulse_shared_core_ftredge/utils/custom_json_encoder.py,sha256=DblQLD0KOSNDyQ58wQRogBrShIXzPIZUw_oGOBATnJY,1366
+ipulse_shared_core_ftredge/utils/json_encoder.py,sha256=QkcaFneVv3-q-s__Dz4OiUWYnM6jgHDJrDMdPv09RCA,2093
+ipulse_shared_core_ftredge-23.1.1.dist-info/licenses/LICENCE,sha256=YBtYAXNqCCOo9Mr2hfkbSPAM9CeAr2j1VZBSwQTrNwE,1060
+ipulse_shared_core_ftredge-23.1.1.dist-info/METADATA,sha256=keIkjScj_B7Wix1MqoCIY8aR5JRAVkbdJwFd3HWnslg,782
+ipulse_shared_core_ftredge-23.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ipulse_shared_core_ftredge-23.1.1.dist-info/top_level.txt,sha256=8sgYrptpexkA_6_HyGvho26cVFH9kmtGvaK8tHbsGHk,27
+ipulse_shared_core_ftredge-23.1.1.dist-info/RECORD,,

ipulse_shared_core_ftredge/models/subscription.py

@@ -1,190 +0,0 @@
-from datetime import datetime, timezone
-from dateutil.relativedelta import relativedelta
-import uuid
-from typing import Set, Optional, ClassVar, Dict, Any, List, Union
-from pydantic import Field, ConfigDict
-from ipulse_shared_base_ftredge import Layer, Module, list_as_lower_strings, Subject, SubscriptionPlan, SubscriptionStatus
-from ipulse_shared_base_ftredge.enums.enums_iam import IAMUnitType
-from .base_data_model import BaseDataModel
-# ORIGINAL AUTHOR ="russlan.ramdowar;russlan@ftredge.com"
-# CLASS_ORGIN_DATE=datetime(2024, 2, 12, 20, 5)
-
-
-DEFAULT_SUBSCRIPTION_PLAN = SubscriptionPlan.FREE
-DEFAULT_SUBSCRIPTION_STATUS = SubscriptionStatus.ACTIVE
-
-############################################ !!!!! ALWAYS UPDATE SCHEMA VERSION , IF SCHEMA IS BEING MODIFIED !!! ############################################
-class Subscription(BaseDataModel):
-    """
-    Represents a single subscription cycle with enhanced flexibility and tracking.
-    """
-
-    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_as_lower_strings(Layer.PULSE_APP, Module.CORE.name, Subject.SUBSCRIPTION.name))
-    OBJ_REF: ClassVar[str] = "subscription"
-
-    # System-managed fields (read-only)
-    schema_version: float = Field(
-        default=VERSION,
-        description="Version of this Class == version of DB Schema",
-        frozen=True
-    )
-
-    # Unique identifier for this specific subscription instance - now auto-generated
-    uuid: str = Field(
-        default_factory=lambda: str(uuid.uuid4()),
-        description="Unique identifier for this subscription instance"
-    )
-
-    # Plan identification
-    plan_name: SubscriptionPlan = Field(
-        ...,  # Required field, no default
-        description="Subscription Plan Name"
-    )
-
-    plan_version: int = Field(
-        ...,  # Required field, no default
-        description="Version of the subscription plan"
-    )
-
-    # Direct field instead of computed
-    plan_id: str = Field(
-        ...,  # Required field, no default
-        description="Combined plan identifier (plan_name_plan_version)"
-    )
-
-    # Cycle duration fields
-    cycle_start_date: datetime = Field(
-        ...,  # Required field, no default
-        description="Subscription Cycle Start Date"
-    )
-
-    # Direct field instead of computed
-    cycle_end_date: datetime = Field(
-        ...,  # Required field, no default
-        description="Subscription Cycle End Date"
-    )
-
-    # Fields for cycle calculation
-    validity_time_length: int = Field(
-        ...,  # Required field, no default
-        description="Length of subscription validity period (e.g., 1, 3, 12)"
-    )
-
-    validity_time_unit: str = Field(
-        ...,  # Required field, no default
-        description="Unit of subscription validity ('minute', 'hour', 'day', 'week', 'month', 'year')"
-    )
-
-    # Renewal and status fields
-    auto_renew: bool = Field(
-        ...,  # Required field, no default
-        description="Auto-renewal status"
-    )
-
-    status: SubscriptionStatus = Field(
-        ...,  # Required field, no default
-        description="Subscription Status (active, trial, pending_confirmation, etc.)"
-    )
-
-    # IAM permissions structure
-    default_iam_domain_permissions: Dict[str, Dict[str, List[str]]] = Field(
-        ...,  # Required field, no default
-        description="IAM domain permissions granted by this subscription (domain -> IAM unit type -> list of unit references)"
-    )
-
-    fallback_plan_id: Optional[str] = Field(
-        ...,  # Required field (can be None), no default
-        description="ID of the plan to fall back to if this subscription expires"
-    )
-
-    price_paid_usd: float = Field(
-        ...,  # Required field, no default
-        description="Amount paid for this subscription in USD"
-    )
-
-    payment_ref: Optional[str] = Field(
-        default=None,
-        description="Reference to payment transaction"
-    )
-
-    # Credit management fields
-    subscription_based_insight_credits_per_update: int = Field(
-        default=0,
-        description="Number of insight credits to add on each update"
-    )
-
-    subscription_based_insight_credits_update_freq_h: int = Field(
-        default=24,
-        description="Frequency of insight credits update in hours"
-    )
-
-    extra_insight_credits_per_cycle: int = Field(
-        default=0,
-        description="Additional insight credits granted per subscription cycle"
-    )
-
-    voting_credits_per_update: int = Field(
-        default=0,
-        description="Number of voting credits to add on each update"
-    )
-
-    voting_credits_update_freq_h: int = Field(
-        default=62,
-        description="Frequency of voting credits update in hours"
-    )
-
-    # General metadata for extensibility
-    metadata: Dict[str, Any] = Field(
-        default_factory=dict,
-        description="Additional metadata for the subscription"
-    )
-
-    # Helper method to calculate cycle end date
-    @classmethod
-    def calculate_cycle_end_date(cls, start_date: datetime, validity_length: int, validity_unit: str) -> datetime:
-        """Calculate the end date based on start date and validity period."""
-        if validity_unit == "minute":
-            return start_date + relativedelta(minutes=validity_length)
-        elif validity_unit == "hour":
-            return start_date + relativedelta(hours=validity_length)
-        elif validity_unit == "day":
-            return start_date + relativedelta(days=validity_length)
-        elif validity_unit == "week":
-            return start_date + relativedelta(weeks=validity_length)
-        elif validity_unit == "year":
-            return start_date + relativedelta(years=validity_length)
-        else:  # Default to months
-            return start_date + relativedelta(months=validity_length)
-
-    # Methods for subscription management
-    def is_active(self) -> bool:
-        """Check if the subscription is currently active."""
-        now = datetime.now(timezone.utc)
-        return (
-            self.status == SubscriptionStatus.ACTIVE and
-            self.cycle_start_date <= now <= self.cycle_end_date
-        )
-
-    def is_expired(self) -> bool:
-        """Check if the subscription has expired."""
-        now = datetime.now(timezone.utc)
-        return now > self.cycle_end_date
-
-    def days_remaining(self) -> int:
-        """Calculate the number of days remaining in the subscription."""
-        now = datetime.now(timezone.utc)
-        if now > self.cycle_end_date:
-            return 0
-
-        # Get time difference
-        time_diff = self.cycle_end_date - now
-
-        # If there's any time remaining but less than a day, return 1
-        if time_diff.days == 0 and time_diff.seconds > 0:
-            return 1
-
-        # Otherwise return the number of complete days
-        return time_diff.days