ipulse-shared-core-ftredge 7.1.1__py3-none-any.whl → 8.1.1__py3-none-any.whl

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/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/dependencies/firestore_client.py

@@ -10,8 +10,8 @@ logger = logging.getLogger(__name__)
 @lru_cache()
 def get_db() -> firestore.Client:
     """
-    Dependency function to inject the Firestore client.
     !!! THIS IS JUST AN EXAMPLE !!!
+    Dependency function to inject the Firestore client.
     !!! Each service implementing this should override this function with their own Firebase initialization. !!!
     """
     logger.info("Base get_db dependency called - this should be overridden by the implementing service")

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/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/models/organization_profile.py

@@ -26,8 +26,8 @@ class OrganizationProfile(BaseDataModel):
     Organisation model representing business entities in the system.
     Supports both retail and non-retail customer types with different validation rules.
     """
-    model_config = ConfigDict(frozen=True, extra="forbid")
-    
+    model_config = ConfigDict(frozen=False, extra="forbid")  # Changed frozen to False to allow id assignment
+
     # Class constants
     VERSION: ClassVar[float] = 4.1
     DOMAIN: ClassVar[str] = "_".join(list_as_lower_strings(Layer.PULSE_APP, Module.CORE.name, Subject.ORGANIZATION.name))
@@ -38,7 +38,7 @@ class OrganizationProfile(BaseDataModel):
         description="Version of this Class == version of DB Schema",
         frozen=True
     )
-    
+
     org_uid: str = Field(
         default_factory=lambda: uuid.uuid4().hex,
         description="Unique identifier for the organisation",
@@ -46,7 +46,7 @@ class OrganizationProfile(BaseDataModel):
     )
 
     id: str = Field(
-        default=None,
+        ...,  # Make it required
         description="Organisation ID, format: {OBJ_REF}_{org_uid}"
     )
 

ipulse_shared_core_ftredge/models/subscription.py

@@ -1,28 +1,30 @@
 from datetime import datetime, timezone
 from dateutil.relativedelta import relativedelta
-from typing import Set, Optional, ClassVar
-from pydantic import Field, ConfigDict
-from ipulse_shared_base_ftredge import Layer, Module, list_as_lower_strings, Subject, SubscriptionPlan
+import uuid
+from typing import Set, Optional, ClassVar, Dict, Any, List, Union
+from pydantic import Field, ConfigDict, computed_field
+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"
+# ORIGINAL AUTHOR ="russlan.ramdowar;russlan@ftredge.com"
 # CLASS_ORGIN_DATE=datetime(2024, 2, 12, 20, 5)
 
 
 DEFAULT_SUBSCRIPTION_PLAN = SubscriptionPlan.FREE
-DEFAULT_SUBSCRIPTION_STATUS = "active"
+DEFAULT_SUBSCRIPTION_STATUS = SubscriptionStatus.ACTIVE
 
 ############################################ !!!!! ALWAYS UPDATE SCHEMA VERSION , IF SCHEMA IS BEING MODIFIED !!! ############################################
 class Subscription(BaseDataModel):
     """
-    Represents a single subscription cycle.
+    Represents a single subscription cycle with enhanced flexibility and tracking.
     """
 
     model_config = ConfigDict(frozen=True, extra="forbid")
 
-    VERSION: ClassVar[float] = 1.1
-    DOMAIN: ClassVar[str] = "_".join(list_as_lower_strings(Layer.PULSE_APP, Module.CORE.name, Subject.SUBSCRIPTION_PLAN.name))
+    VERSION: ClassVar[float] = 2.9  # Incremented version for new fields
+    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,
@@ -30,31 +32,148 @@ class Subscription(BaseDataModel):
         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(
-        default=DEFAULT_SUBSCRIPTION_PLAN,
+        ...,  # Required field, no default
         description="Subscription Plan Name"
     )
 
-    plan_version: float = Field(
-        default=1.0,
+    plan_version: int = Field(
+        ...,  # Required field, no default
         description="Version of the subscription plan"
     )
 
+    @computed_field
+    def plan_id(self) -> str:
+        """
+        Generate a plan identifier combining plan name and version.
+        Format: {plan_name}_{plan_version}
+        Example: "free_subscription_1"
+        """
+        return f"{self.plan_name.value}_{self.plan_version}"
+
+    # Cycle duration fields
     cycle_start_date: datetime = Field(
-        default=datetime.now(timezone.utc),
+        ...,  # Required field, no default
         description="Subscription Cycle Start Date"
     )
-    cycle_end_date: datetime = Field(
-        default=lambda: datetime.now(timezone.utc) + relativedelta(years=1),
-        description="Subscription Cycle End Date"
+
+    # New fields for more flexible cycle management
+    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')"
     )
+
+    # Computed cycle_end_date based on start date and validity
+    @computed_field
+    def cycle_end_date(self) -> datetime:
+        """Calculate the end date based on start date and validity period."""
+        if self.validity_time_unit == "minute":
+            return self.cycle_start_date + relativedelta(minutes=self.validity_time_length)
+        elif self.validity_time_unit == "hour":
+            return self.cycle_start_date + relativedelta(hours=self.validity_time_length)
+        elif self.validity_time_unit == "day":
+            return self.cycle_start_date + relativedelta(days=self.validity_time_length)
+        elif self.validity_time_unit == "week":
+            return self.cycle_start_date + relativedelta(weeks=self.validity_time_length)
+        elif self.validity_time_unit == "year":
+            return self.cycle_start_date + relativedelta(years=self.validity_time_length)
+        else:  # Default to months
+            return self.cycle_start_date + relativedelta(months=self.validity_time_length)
+
+    # Renewal and status fields
     auto_renew: bool = Field(
-        default=True,
+        ...,  # Required field, no default
         description="Auto-renewal status"
     )
-    status: str = Field(
-        default=DEFAULT_SUBSCRIPTION_STATUS,
-        description="Subscription Status (active, trial, inactive, etc.)"
+
+    status: SubscriptionStatus = Field(
+        ...,  # Required field, no default
+        description="Subscription Status (active, trial, pending_confirmation, etc.)"
+    )
+
+    # New fields for enhanced subscription management
+    # Update the type definition to use string keys for IAMUnitType
+    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"
+    )
+
+    # New fields moved from metadata to direct attributes
+    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"
     )
 
-    # Remove audit fields as they're inherited from BaseDataModel
+    # 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
+        return (self.cycle_end_date - now).days

ipulse_shared_core_ftredge/models/user_profile.py

@@ -1,96 +1,125 @@
-""" User Profile model representing user information. """
-from datetime import date
-from typing import Set, Optional, ClassVar
-from pydantic import EmailStr, Field, ConfigDict, field_validator
+""" 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
 
-# # Revision history (as model metadata)
-# CLASS_ORIGIN_AUTHOR: ClassVar[str] = "Russlan Ramdowar;russlan@ftredge.com"
-# CLASS_ORGIN_DATE: ClassVar[datetime] = datetime(2024, 1, 16, 20, 5)
+# 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 representing user information and metadata.
-    Contains both system-managed and user-editable fields.
+    User Profile model for storing personal information and settings.
     """
-    model_config = ConfigDict(frozen=True, extra="forbid")
+    model_config = ConfigDict(frozen=False, extra="forbid")  # Allow field modification
 
-    # Metadata as class variables
-    VERSION: ClassVar[float] = 4.1
+    # 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"
-    
-    # System-managed fields (read-only)
+
     schema_version: float = Field(
         default=VERSION,
-        description="Version of this Class == version of DB Schema",
-        frozen=True
+        frozen=True,
+        description="Version of this Class == version of DB Schema"
     )
-    
-    id : str = Field(
-        ...,
-        description="User ID, propagated from Firebase Auth"
+
+    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, propagated from Firebase Auth"
+        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="Propagated from Firebase Auth",
+        description="Email address",
         frozen=True
     )
     organizations_uids: Set[str] = Field(
         default_factory=set,
-        description="Depends on Subscription Plan, Regularly Updated"
+        description="Organization UIDs the user belongs to"
     )
-    
+
     # System identification (read-only)
-    provider_id: str = Field(frozen=True)
-    aliases: Optional[Set[str]] = Field(
-        default=None
+    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_-]+$"
+        pattern="^[a-zA-Z0-9_-]+$",
+        description="Username (public display name)"
     )
     dob: Optional[date] = Field(
         default=None,
-        description="Date of Birth"
+        description="Date of birth"
     )
     first_name: Optional[str] = Field(
         default=None,
-        max_length=100
+        max_length=100,
+        description="First name"
     )
     last_name: Optional[str] = Field(
         default=None,
-        max_length=100
+        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="E.164 format phone number"
+        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
 
-    @field_validator('id', mode='before')
+    @model_validator(mode='before')
     @classmethod
-    def validate_or_generate_id(cls, v: Optional[str], info) -> str:
-        """Validate or generate user ID based on user_uid."""
-        # If id is already provided (Firebase Auth case), return it
-        if v:
-            return v
-            
-        # Fallback: generate from user_uid if needed
-        values = info.data
-        user_uid = values.get('user_uid')
-        if not user_uid:
-            raise ValueError("Either id or user_uid must be provided")
-        return f"{cls.OBJ_REF}_{user_uid}"
+    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