ipulse-shared-core-ftredge 24.2.1__tar.gz → 26.1.1__tar.gz

{ipulse_shared_core_ftredge-24.2.1/src/ipulse_shared_core_ftredge.egg-info → ipulse_shared_core_ftredge-26.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipulse_shared_core_ftredge
-Version: 24.2.1
+Version: 26.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

{ipulse_shared_core_ftredge-24.2.1 → ipulse_shared_core_ftredge-26.1.1}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='ipulse_shared_core_ftredge',
-    version='24.2.1',
+    version='26.1.1',
     package_dir={'': 'src'},  # Specify the source directory
     packages=find_packages(where='src'),  # Look for packages in 'src'
     install_requires=[

ipulse_shared_core_ftredge-26.1.1/src/ipulse_shared_core_ftredge/dependencies/__init__.py

@@ -0,0 +1,3 @@
+from .auth_firebase_token_validation import verify_firebase_token, AuthUser
+from .authz_credit_extraction import extract_credits_from_authz_response
+from .auth_protected_router import create_protected_router

{ipulse_shared_core_ftredge-24.2.1 → ipulse_shared_core_ftredge-26.1.1}/src/ipulse_shared_core_ftredge/dependencies/auth_firebase_token_validation.py

@@ -67,7 +67,6 @@ async def verify_firebase_token(
         email = decoded_token.get('email')
         if not email:
             raise ValueError("Token must contain user email")
-
         user_auth = UserAuth(
             email=email,
             password=None,  # No password for token-based auth
@@ -93,4 +92,3 @@ async def verify_firebase_token(
 
 # Type alias for dependency injection
 AuthUser = Annotated[UserAuth, Depends(verify_firebase_token)]
-

ipulse_shared_core_ftredge-26.1.1/src/ipulse_shared_core_ftredge/dependencies/authz_credit_extraction.py

@@ -0,0 +1,67 @@
+"""
+Utility functions for extracting credit information from authorization responses.
+
+This module provides helper functions to extract credit information from OPA
+authorization decisions, avoiding the need for complex dependency injection.
+"""
+from typing import Optional, Dict, Any
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def extract_credits_from_authz_response(authz_info: Any) -> Optional[Dict[str, float]]:
+    """
+    Extract credit information from OPA authorization decision.
+
+    This function replaces the complex PreFetchedCredits dependency by directly
+    extracting credit information from the authorization response.
+
+    Args:
+        authz_info: Authorization information from OPA decision (typically AuthorizedRequest)
+
+    Returns:
+        Dictionary with credit information or None if not available:
+        {
+            "sbscrptn_based_insight_credits": float,
+            "extra_insight_credits": float
+        }
+    """
+    if not authz_info:
+        logger.debug("No authorization info provided for credit extraction")
+        return None
+
+    try:
+        # Handle dict-like authorization info (AuthorizedRequest typically converts to dict)
+        if isinstance(authz_info, dict) and 'opa_decision' in authz_info:
+            requestor_info = authz_info['opa_decision'].get("requestor_post_authz", {})
+            if requestor_info:
+                extracted_credits = {
+                    "sbscrptn_based_insight_credits": float(requestor_info.get("sbscrptn_based_insight_credits", 0.0)),
+                    "extra_insight_credits": float(requestor_info.get("extra_insight_credits", 0.0))
+                }
+                logger.debug("Successfully extracted credits from authz response: %s", extracted_credits)
+                return extracted_credits
+            else:
+                logger.debug("No requestor_post_authz found in OPA decision")
+                return None
+
+        # Handle object-like authorization info with attributes
+        elif hasattr(authz_info, 'opa_decision'):
+            opa_decision = getattr(authz_info, 'opa_decision', {})
+            if isinstance(opa_decision, dict):
+                requestor_info = opa_decision.get("requestor_post_authz", {})
+                if requestor_info:
+                    extracted_credits = {
+                        "sbscrptn_based_insight_credits": float(requestor_info.get("sbscrptn_based_insight_credits", 0.0)),
+                        "extra_insight_credits": float(requestor_info.get("extra_insight_credits", 0.0))
+                    }
+                    logger.debug("Successfully extracted credits from authz response (object): %s", extracted_credits)
+                    return extracted_credits
+
+        logger.debug("No valid OPA decision structure found in authz_info for credit extraction")
+        return None
+
+    except (AttributeError, KeyError, TypeError, ValueError) as e:
+        logger.warning("Failed to extract credits from authz response: %s", e)
+        return None

{ipulse_shared_core_ftredge-24.2.1 → ipulse_shared_core_ftredge-26.1.1}/src/ipulse_shared_core_ftredge/dependencies/authz_for_apis.py

@@ -194,6 +194,7 @@ async def authorizeAPIRequest(
 
         # Extract request context and Firebase user claims
         firebase_user = request.state.user
+        logger.debug(f"Firebase user: {firebase_user}")
         user_uid = firebase_user.get('uid')
         if not user_uid:
             logger.debug(f"Authorization denied for {request.method} {request.url.path}: No user UID found")
@@ -203,10 +204,9 @@ async def authorizeAPIRequest(
             )
 
         # Get usertype information from Firebase custom claims (primary source)
-        custom_claims = firebase_user.get('custom_claims', {}) or firebase_user.get('claims', {})
-        primary_usertype = custom_claims.get('primary_usertype')
-        secondary_usertypes = custom_claims.get('secondary_usertypes', [])
-        user_approval_status = custom_claims.get('user_approval_status', str(ApprovalStatus.UNKNOWN))
+        primary_usertype = firebase_user.get('primary_usertype')
+        secondary_usertypes = firebase_user.get('secondary_usertypes', [])
+        user_approval_status = firebase_user.get('user_approval_status', str(ApprovalStatus.UNKNOWN))
 
         # Determine if we need fresh status for permissions and credits
         force_fresh = _should_force_fresh_status(request)
@@ -217,6 +217,7 @@ async def authorizeAPIRequest(
         )
 
         # Perform comprehensive review and cleanup synchronously to ensure accurate auth data
+        logger.debug(f"Comprehensive review for userstatus : {user_status_obj} during authz")
         if user_core_service:
             try:
                 review_result = await user_core_service.review_and_clean_active_subscription_credits_and_permissions(
@@ -227,7 +228,7 @@ async def authorizeAPIRequest(
                     clean_expired_permissions=True,
                     review_credits=True
                 )
-
+                logger.debug(f"Review result for userstatus : {review_result} during authz")
                 # Refresh user status after comprehensive review if any actions were taken
                 if review_result.get('actions_taken'):
                     logger.info(f"Auth middleware performed comprehensive review for user {user_uid}: {review_result['actions_taken']}")
@@ -268,7 +269,6 @@ async def authorizeAPIRequest(
                 "uid": user_uid,
                 "primary_usertype": primary_usertype,
                 "secondary_usertypes": secondary_usertypes,
-                "usertypes": [primary_usertype] + secondary_usertypes if primary_usertype else secondary_usertypes,
                 "email_verified": firebase_user.get("email_verified", False),
                 "user_approval_status": user_approval_status,
                 "iam_permissions": valid_permissions,

{ipulse_shared_core_ftredge-24.2.1 → ipulse_shared_core_ftredge-26.1.1}/src/ipulse_shared_core_ftredge/models/__init__.py

@@ -1,4 +1,6 @@
 from .base_data_model import BaseDataModel
-from .base_api_response import BaseAPIResponse , CustomJSONResponse, CreditChargeableAPIResponse, UserCreditBalance, UpdatedUserCreditInfo
+from .base_api_response import BaseAPIResponse, PaginatedAPIResponse
+from .credit_api_response import CreditChargeableAPIResponse, UserCreditBalance, UpdatedUserCreditInfo
+from .custom_json_response import CustomJSONResponse
 from .user import UserProfile, UserSubscription, UserStatus, UserAuth, UserAuthCreateNew, UserPermission
 from .catalog import SubscriptionPlan, ProrationMethod, PlanUpgradePath, UserType

ipulse_shared_core_ftredge-26.1.1/src/ipulse_shared_core_ftredge/models/base_api_response.py

@@ -0,0 +1,29 @@
+"""Core API response models."""
+from typing import Generic, TypeVar, Optional, Any, Dict, List
+import datetime as dt
+from pydantic import BaseModel, ConfigDict
+
+
+T = TypeVar('T')
+
+
+class BaseAPIResponse(BaseModel, Generic[T]):
+    """Base API response model for all endpoints."""
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+    success: bool
+    chargeable: bool = False  # Added chargeable attribute
+    data: Optional[T] = None
+    message: Optional[str] = None
+    error: Optional[str] = None
+
+    metadata: Dict[str, Any] = {
+        "timestamp": dt.datetime.now(dt.timezone.utc).isoformat()
+    }
+
+
+class PaginatedAPIResponse(BaseAPIResponse, Generic[T]):
+    """API response for paginated data."""
+    total_count: int
+    page: int
+    page_size: int
+    items: List[T]

ipulse_shared_core_ftredge-26.1.1/src/ipulse_shared_core_ftredge/models/credit_api_response.py

@@ -0,0 +1,26 @@
+"""Credit-related API response models."""
+from typing import Generic, TypeVar, Optional
+from pydantic import BaseModel
+from .base_api_response import BaseAPIResponse
+
+T = TypeVar('T')
+
+
+class UserCreditBalance(BaseModel):
+    """User's current credit balance."""
+    sbscrptn_based_insight_credits: float
+    extra_insight_credits: float
+
+
+class UpdatedUserCreditInfo(BaseModel):
+    """Information about credit charging attempt and results."""
+    charge_attempted: bool
+    charge_successful: bool
+    cost_incurred: float
+    items_processed_for_charge: int
+    user_balance: UserCreditBalance
+
+
+class CreditChargeableAPIResponse(BaseAPIResponse[T], Generic[T]):
+    """API response for endpoints that may charge credits."""
+    updated_user_credit_info: Optional[UpdatedUserCreditInfo] = None

ipulse_shared_core_ftredge-24.2.1/src/ipulse_shared_core_ftredge/models/base_api_response.py → ipulse_shared_core_ftredge-26.1.1/src/ipulse_shared_core_ftredge/models/custom_json_response.py

@@ -1,46 +1,12 @@
-from typing import Generic, TypeVar, Optional, Any, Dict, List
-import datetime as dt
+"""Custom JSON response handlers for FastAPI."""
 import json
-from pydantic import BaseModel, ConfigDict
 from fastapi.responses import JSONResponse
 from ipulse_shared_core_ftredge.utils.json_encoder import EnsureJSONEncoderCompatibility, convert_to_json_serializable
 
 
-T = TypeVar('T')
-
-class BaseAPIResponse(BaseModel, Generic[T]):
-    model_config = ConfigDict(arbitrary_types_allowed=True)
-    success: bool
-    chargeable: bool = False # Added chargeable attribute
-    data: Optional[T] = None
-    message: Optional[str] = None
-    error: Optional[str] = None
-
-    metadata: Dict[str, Any] = {
-        "timestamp": dt.datetime.now(dt.timezone.utc).isoformat()
-    }
-
-class UserCreditBalance(BaseModel):
-    sbscrptn_based_insight_credits: float
-    extra_insight_credits: float
-
-class UpdatedUserCreditInfo(BaseModel):
-    charge_attempted: bool
-    charge_successful: bool
-    cost_incurred: float
-    items_processed_for_charge: int
-    user_balance: UserCreditBalance
-
-class CreditChargeableAPIResponse(BaseAPIResponse[T], Generic[T]):
-    updated_user_credit_info: Optional[UpdatedUserCreditInfo] = None
-
-class PaginatedAPIResponse(BaseAPIResponse, Generic[T]):
-    total_count: int
-    page: int
-    page_size: int
-    items: List[T]
-
 class CustomJSONResponse(JSONResponse):
+    """Custom JSON response with enhanced serialization support."""
+
     def render(self, content) -> bytes:
         # First preprocess content with our utility function
         if isinstance(content, dict) and "data" in content and hasattr(content["data"], "model_dump"):
@@ -63,4 +29,4 @@ class CustomJSONResponse(JSONResponse):
             indent=None,
             separators=(",", ":"),
             cls=EnsureJSONEncoderCompatibility
-        ).encode("utf-8")
+        ).encode("utf-8")

{ipulse_shared_core_ftredge-24.2.1 → ipulse_shared_core_ftredge-26.1.1}/src/ipulse_shared_core_ftredge/models/user/user_subscription.py

@@ -56,7 +56,7 @@ class UserSubscription(BaseDataModel):
     )
 
     # Cycle duration fields
-    cycle_start_date: datetime = Field(
+    cycle_start_datetime: datetime = Field(
         ...,  # Required field, no default
         description="Subscription Cycle Start Date"
     )
@@ -163,7 +163,7 @@ class UserSubscription(BaseDataModel):
     @classmethod
     def auto_calculate_cycle_end_date(cls, data: Dict[str, Any]) -> Dict[str, Any]:
         """
-        Auto-calculate cycle_end_datetime if not provided, based on cycle_start_date,
+        Auto-calculate cycle_end_datetime if not provided, based on cycle_start_datetime,
         validity_time_length, and validity_time_unit.
         """
         if not isinstance(data, dict):
@@ -176,19 +176,19 @@ class UserSubscription(BaseDataModel):
             (isinstance(data.get('cycle_end_datetime'), datetime) and
              abs((data['cycle_end_datetime'] - datetime.now(timezone.utc)).total_seconds()) < 5)):
 
-            cycle_start_date = data.get('cycle_start_date')
+            cycle_start_datetime = data.get('cycle_start_datetime')
             validity_time_length = data.get('validity_time_length')
             validity_time_unit = data.get('validity_time_unit')
 
-            if cycle_start_date and validity_time_length and validity_time_unit:
+            if cycle_start_datetime and validity_time_length and validity_time_unit:
                 data['cycle_end_datetime'] = cls.calculate_cycle_end_date(
-                    cycle_start_date, validity_time_length, validity_time_unit
+                    cycle_start_datetime, validity_time_length, validity_time_unit
                 )
             else:
                 raise ValueError(
                     "Cannot create subscription without cycle_end_datetime. "
                     "Either provide cycle_end_datetime directly or provide "
-                    "cycle_start_date, validity_time_length, and validity_time_unit for auto-calculation."
+                    "cycle_start_datetime, validity_time_length, and validity_time_unit for auto-calculation."
                 )
 
         return data
@@ -242,7 +242,7 @@ class UserSubscription(BaseDataModel):
         now = datetime.now(timezone.utc)
         return (
             self.status == SubscriptionStatus.ACTIVE and
-            self.cycle_start_date <= now <= self.cycle_end_datetime_safe
+            self.cycle_start_datetime <= now <= self.cycle_end_datetime_safe
         )
 
     def is_expired(self) -> bool:

{ipulse_shared_core_ftredge-24.2.1 → ipulse_shared_core_ftredge-26.1.1}/src/ipulse_shared_core_ftredge/models/user/userstatus.py

@@ -442,7 +442,7 @@ class UserStatus(BaseDataModel):
             return False
 
         now = datetime.now(timezone.utc)
-        cycle_start = self.active_subscription.cycle_start_date
+        cycle_start = self.active_subscription.cycle_start_datetime
         update_frequency_hours = self.active_subscription.subscription_based_insight_credits_update_freq_h
 
         # Calculate when the next credit update should happen based on cycle start

{ipulse_shared_core_ftredge-24.2.1 → ipulse_shared_core_ftredge-26.1.1}/src/ipulse_shared_core_ftredge/services/charging_processors.py

@@ -56,7 +56,7 @@ class ChargingProcessor:
                     updated_user_credits = pre_fetched_credits
                 elif self.user_charging_service: # Attempt to get current credits if not pre-fetched
                     try:
-                        _, current_user_credits_from_verify = await self.user_charging_service.verify_credits(user_uid, 0, None)
+                        _, current_user_credits_from_verify = await self.user_charging_service.verify_enough_credits(user_uid, 0, None)
                         updated_user_credits = current_user_credits_from_verify
                     except Exception: # pylint: disable=broad-except
                         self.logger.warning(f"Could not fetch current credits for user {user_uid} for free item.")
@@ -77,7 +77,7 @@ class ChargingProcessor:
                     updated_user_credits = pre_fetched_credits
                 elif self.user_charging_service:
                     try:
-                        _, current_user_credits_from_verify = await self.user_charging_service.verify_credits(user_uid, 0, None)
+                        _, current_user_credits_from_verify = await self.user_charging_service.verify_enough_credits(user_uid, 0, None)
                         updated_user_credits = current_user_credits_from_verify
                     except Exception: # pylint: disable=broad-except
                         self.logger.warning(f"Could not fetch current credits for user {user_uid} during debug bypass.")
@@ -91,7 +91,7 @@ class ChargingProcessor:
 
             # Verify credit service is available
             if not self.user_charging_service:
-                self.logger.error("ChargingService not initialized.")
+                self.logger.error("UserChargingService not initialized.")
                 return {
                     'access_granted': False,
                     'charge_successful': False,
@@ -101,7 +101,7 @@ class ChargingProcessor:
                 }
 
             # Verify user has enough credits
-            has_credits, current_user_credits_from_verify = await self.user_charging_service.verify_credits(
+            has_credits, current_user_credits_from_verify = await self.user_charging_service.verify_enough_credits(
                 user_uid,
                 credit_cost,
                 pre_fetched_user_credits=pre_fetched_credits
@@ -121,7 +121,7 @@ class ChargingProcessor:
                 }
 
             # Charge the user - this now returns (bool, Optional[Dict])
-            charged, calculated_updated_credits = await self.user_charging_service.charge_credits_transaction(
+            charged, calculated_updated_credits = await self.user_charging_service.debit_credits_transaction(
                 user_uid,
                 credit_cost,
                 operation_description
@@ -133,7 +133,7 @@ class ChargingProcessor:
 
 
             return {
-                'access_granted': True, # Access granted because verify_credits passed
+                'access_granted': True, # Access granted because verify_enough_credits passed
                 'charge_successful': charged,
                 'cost': credit_cost,
                 'reason': 'charged' if charged else 'charge_failed',
@@ -145,7 +145,7 @@ class ChargingProcessor:
             # Try to get current credits to return
             if self.user_charging_service:
                 try:
-                    _, updated_user_credits = await self.user_charging_service.verify_credits(user_uid, 0, pre_fetched_credits)
+                    _, updated_user_credits = await self.user_charging_service.verify_enough_credits(user_uid, 0, pre_fetched_credits)
                 except Exception: # pylint: disable=broad-except
                     pass # Keep updated_user_credits as None
             ve.additional_info = ve.additional_info or {}
@@ -157,7 +157,7 @@ class ChargingProcessor:
             current_user_credits_on_error = None
             if self.user_charging_service:
                 try:
-                    _, current_user_credits_on_error = await self.user_charging_service.verify_credits(user_uid, 0, pre_fetched_credits)
+                    _, current_user_credits_on_error = await self.user_charging_service.verify_enough_credits(user_uid, 0, pre_fetched_credits)
                 except Exception: # pylint: disable=broad-except
                     pass
             return {
@@ -230,7 +230,7 @@ class ChargingProcessor:
                 updated_user_credits = pre_fetched_credits
             elif self.user_charging_service:
                 try:
-                    _, current_user_credits_from_verify = await self.user_charging_service.verify_credits(user_uid, 0, None)
+                    _, current_user_credits_from_verify = await self.user_charging_service.verify_enough_credits(user_uid, 0, None)
                     updated_user_credits = current_user_credits_from_verify
 
                 except Exception: # pylint: disable=broad-except
@@ -252,7 +252,7 @@ class ChargingProcessor:
                 updated_user_credits = pre_fetched_credits
             elif self.user_charging_service:
                 try:
-                    _, current_user_credits_from_verify = await self.user_charging_service.verify_credits(user_uid, 0, None)
+                    _, current_user_credits_from_verify = await self.user_charging_service.verify_enough_credits(user_uid, 0, None)
                     updated_user_credits = current_user_credits_from_verify
                 except Exception: # pylint: disable=broad-except
                     self.logger.warning(f"Could not fetch current credits for user {user_uid} during debug bypass for batch.")
@@ -268,7 +268,7 @@ class ChargingProcessor:
 
         # Verify credit service is available
         if not self.user_charging_service:
-            self.logger.error("ChargingService not initialized for batch processing.")
+            self.logger.error("UserChargingService not initialized for batch processing.")
             return {
                 'accessible_items': free_items,
                 'charge_successful': False,
@@ -280,7 +280,7 @@ class ChargingProcessor:
 
         try:
             # Verify user has enough credits for total cost
-            has_credits, current_user_credits_from_verify = await self.user_charging_service.verify_credits(
+            has_credits, current_user_credits_from_verify = await self.user_charging_service.verify_enough_credits(
                 user_uid,
                 total_cost,
                 pre_fetched_user_credits=pre_fetched_credits
@@ -300,7 +300,7 @@ class ChargingProcessor:
                 }
 
             # Charge the user for all paid items
-            charged, calculated_updated_credits = await self.user_charging_service.charge_credits_transaction(
+            charged, calculated_updated_credits = await self.user_charging_service.debit_credits_transaction(
                 user_uid,
                 total_cost,
                 f"{operation_description} ({len(paid_items)} items, total cost: {total_cost})"
@@ -324,7 +324,7 @@ class ChargingProcessor:
             self.logger.error(f"Validation error during batch credit check for user {user_uid}: {str(ve)}")
             if self.user_charging_service:
                 try:
-                    _, current_user_credits_from_verify = await self.user_charging_service.verify_credits(user_uid, 0, pre_fetched_credits)
+                    _, current_user_credits_from_verify = await self.user_charging_service.verify_enough_credits(user_uid, 0, pre_fetched_credits)
                     updated_user_credits = current_user_credits_from_verify
                 except Exception: # pylint: disable=broad-except
                     pass
@@ -336,7 +336,7 @@ class ChargingProcessor:
             current_credits_on_error = None
             if self.user_charging_service:
                 try:
-                    _, current_credits_on_error = await self.user_charging_service.verify_credits(user_uid, 0, pre_fetched_credits)
+                    _, current_credits_on_error = await self.user_charging_service.verify_enough_credits(user_uid, 0, pre_fetched_credits)
                     updated_user_credits = current_credits_on_error
                 except Exception: # pylint: disable=broad-except
                     pass

{ipulse_shared_core_ftredge-24.2.1 → ipulse_shared_core_ftredge-26.1.1}/src/ipulse_shared_core_ftredge/services/user/__init__.py

@@ -14,4 +14,5 @@ from .user_subscription_operations import  UsersubscriptionOperations
 from .user_permissions_operations import UserpermissionsOperations
 from .userauth_operations import UserauthOperations
 from .user_multistep_operations import UsermultistepOperations
+from .user_charging_operations import UserChargingOperations
 from .user_core_service import UserCoreService