ipulse-shared-core-ftredge 7.2.1__tar.gz → 9.1.1__tar.gz

{ipulse_shared_core_ftredge-7.2.1/src/ipulse_shared_core_ftredge.egg-info → ipulse_shared_core_ftredge-9.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ipulse_shared_core_ftredge
-Version: 7.2.1
+Version: 9.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
@@ -13,10 +13,11 @@ 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>=5.7.1
+Requires-Dist: ipulse_shared_base_ftredge>=6.4.1
 Dynamic: author
 Dynamic: classifier
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary

{ipulse_shared_core_ftredge-7.2.1 → ipulse_shared_core_ftredge-9.1.1}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='ipulse_shared_core_ftredge',
-    version='7.2.1',
+    version='9.1.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>=5.7.1',
+        'ipulse_shared_base_ftredge>=6.4.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-7.2.1 → ipulse_shared_core_ftredge-9.1.1}/src/ipulse_shared_core_ftredge/__init__.py

@@ -1,6 +1,6 @@
 # pylint: disable=missing-module-docstring
 from .models import ( UserAuth, UserProfile,Subscription,
-                     UserStatus, UserProfileUpdate,
+                     UserStatus, IAMUnitRefAssignment, UserProfileUpdate,
                      OrganizationProfile, BaseAPIResponse,
                       CustomJSONResponse )
 

{ipulse_shared_core_ftredge-7.2.1 → ipulse_shared_core_ftredge-9.1.1}/src/ipulse_shared_core_ftredge/dependencies/authz_for_apis.py

@@ -160,7 +160,7 @@ async def authorizeAPIRequest(
 ) -> Dict[str, Any]:
     """
     Authorize API request based on user status and OPA policies.
-    Note: This expects an actual Firestore client instance, not a dependency.
+    Enhanced with credit check information.
     """
     try:
         # Extract fields for both PATCH and POST if not provided
@@ -196,6 +196,7 @@ async def authorizeAPIRequest(
             "request_resource_fields": request_resource_fields
         }
 
+        ####!!!!!!!!!! OPA call
         # 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}")
@@ -237,11 +238,17 @@ async def authorizeAPIRequest(
                     }
                 )
 
+            # 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()
+            "status_retrieved_at": datetime.now(timezone.utc).isoformat(),
+            "credit_check": credit_check
         }
 
     except (AuthorizationError, ResourceNotFoundError):
@@ -268,6 +275,7 @@ def _should_force_fresh_status(request: Request) -> bool:
     credit_sensitive_patterns = [
         'prediction',
         'user-statuses',
+        'historic'
     ]
     # Methods that require fresh status
     sensitive_methods = {'post', 'patch', 'put', 'delete'}

{ipulse_shared_core_ftredge-7.2.1 → ipulse_shared_core_ftredge-9.1.1}/src/ipulse_shared_core_ftredge/models/__init__.py

@@ -1,6 +1,6 @@
 from .user_profile import UserProfile
 from .subscription import Subscription
-from .user_status import UserStatus
+from .user_status import UserStatus, IAMUnitRefAssignment
 from .user_profile_update import UserProfileUpdate
 from .user_auth import UserAuth
 from .organization_profile import OrganizationProfile

{ipulse_shared_core_ftredge-7.2.1 → ipulse_shared_core_ftredge-9.1.1}/src/ipulse_shared_core_ftredge/models/base_api_response.py

@@ -3,10 +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 import CustomJSONEncoder
 
 
 T = TypeVar('T')
@@ -30,6 +27,17 @@ class PaginatedAPIResponse(BaseAPIResponse, Generic[T]):
 
 class CustomJSONResponse(JSONResponse):
     def render(self, content) -> bytes:
+        # Handle Pydantic models to exclude computed fields
+        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
+            content = dict(content)  # Create a copy to avoid modifying the original
+            content["data"] = content["data"].model_dump(
+                exclude_unset=True,
+                exclude_computed=True
+            )
+
+        # Use the CustomJSONEncoder for serialization
         return json.dumps(
             content,
             ensure_ascii=False,

{ipulse_shared_core_ftredge-7.2.1 → ipulse_shared_core_ftredge-9.1.1}/src/ipulse_shared_core_ftredge/models/base_data_model.py

@@ -1,4 +1,4 @@
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import ClassVar
 from pydantic import BaseModel, Field, ConfigDict, field_validator
 import dateutil.parser
@@ -20,17 +20,17 @@ class BaseDataModel(BaseModel):
     )
 
     # Audit fields
-    creat_date: datetime = Field(default_factory=datetime.utcnow, frozen=True)
-    creat_by_user: str = Field(..., frozen=True)
-    updt_date: datetime = Field(default_factory=datetime.utcnow)
-    updt_by_user: str = Field(...)
+    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('creat_date', 'updt_date', mode='before')
+    @field_validator('created_at', 'updated_at', mode='before')
     @classmethod
     def parse_datetime(cls, v: any) -> datetime:
         if isinstance(v, datetime):

ipulse_shared_core_ftredge-9.1.1/src/ipulse_shared_core_ftredge/models/subscription.py

@@ -0,0 +1,190 @@
+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
+    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

ipulse_shared_core_ftredge-9.1.1/src/ipulse_shared_core_ftredge/models/user_profile.py

@@ -0,0 +1,125 @@
+""" User Profile model for storing personal information and settings. """
+from datetime import date, datetime, timezone
+from typing import Set, Optional, ClassVar, Dict, Any, List
+from pydantic import EmailStr, Field, ConfigDict, field_validator, model_validator, computed_field
+from ipulse_shared_base_ftredge import Layer, Module, list_as_lower_strings, Subject
+from .base_data_model import BaseDataModel
+
+# ORIGINAL AUTHOR ="Russlan Ramdowar;russlan@ftredge.com"
+# CLASS_ORGIN_DATE=datetime(2024, 2, 12, 20, 5)
+
+############################ !!!!! ALWAYS UPDATE SCHEMA VERSION , IF SCHEMA IS BEING MODIFIED !!! #################################
+class UserProfile(BaseDataModel):
+    """
+    User Profile model for storing personal information and settings.
+    """
+    model_config = ConfigDict(frozen=False, extra="forbid")  # Allow field modification
+
+    # Class constants
+    VERSION: ClassVar[float] = 5.0  # Incremented version for primary_user_type addition
+    DOMAIN: ClassVar[str] = "_".join(list_as_lower_strings(Layer.PULSE_APP, Module.CORE.name, Subject.USER.name))
+    OBJ_REF: ClassVar[str] = "userprofile"
+
+    schema_version: float = Field(
+        default=VERSION,
+        frozen=True,
+        description="Version of this Class == version of DB Schema"
+    )
+
+    id: str = Field(
+        ...,  # Required, but will be auto-generated if not provided
+        description=f"User Profile ID, format: {OBJ_REF}_user_uid"
+    )
+
+    user_uid: str = Field(
+        ...,
+        description="User UID from Firebase Auth"
+    )
+
+    # Added primary_user_type field for main role categorization
+    primary_user_type: str = Field(
+        ...,
+        description="Primary user type (e.g., customer, internal, admin, superadmin)"
+    )
+
+    # Renamed user_types to secondary_user_types
+    secondary_user_types: List[str] = Field(
+        default_factory=list,
+        description="List of secondary user types"
+    )
+
+    # Rest of the fields remain the same
+    email: EmailStr = Field(
+        ...,
+        description="Email address",
+        frozen=True
+    )
+    organizations_uids: Set[str] = Field(
+        default_factory=set,
+        description="Organization UIDs the user belongs to"
+    )
+
+    # System identification (read-only)
+    provider_id: str = Field(
+        ...,
+        description="User provider ID",
+        frozen=True
+    )
+    aliases: Optional[Dict[str, str]] = Field(
+        default=None,
+        description="User aliases. With alias as key and description as value."
+    )
+
+    # User-editable fields
+    username: Optional[str] = Field(
+        default=None,
+        max_length=50,
+        pattern="^[a-zA-Z0-9_-]+$",
+        description="Username (public display name)"
+    )
+    dob: Optional[date] = Field(
+        default=None,
+        description="Date of birth"
+    )
+    first_name: Optional[str] = Field(
+        default=None,
+        max_length=100,
+        description="First name"
+    )
+    last_name: Optional[str] = Field(
+        default=None,
+        max_length=100,
+        description="Last name"
+    )
+    mobile: Optional[str] = Field(
+        default=None,
+        pattern=r"^\+?[1-9]\d{1,14}$",  # Added 'r' prefix for raw string
+        description="Mobile phone number"
+    )
+
+    metadata: Dict[str, Any] = Field(
+        default_factory=dict,
+        description="Additional metadata for the user"
+    )
+
+    # Remove audit fields as they're inherited from BaseDataModel
+
+    @model_validator(mode='before')
+    @classmethod
+    def ensure_id_exists(cls, data: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Ensures the id field exists by generating it from user_uid if needed.
+        This runs BEFORE validation, guaranteeing id will be present for validators.
+        """
+        if not isinstance(data, dict):
+            return data
+
+        # If id is already in the data, leave it alone
+        if 'id' in data and data['id']:
+            return data
+
+        # If user_uid exists but id doesn't, generate id from user_uid
+        if 'user_uid' in data and data['user_uid']:
+            data['id'] = f"{cls.OBJ_REF}_{data['user_uid']}"
+
+        return data