ipulse-shared-core-ftredge 5.1.1__tar.gz → 6.1.1__tar.gz

{ipulse_shared_core_ftredge-5.1.1/src/ipulse_shared_core_ftredge.egg-info → ipulse_shared_core_ftredge-6.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ipulse_shared_core_ftredge
-Version: 5.1.1
+Version: 6.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-6.1.1/README.md

@@ -0,0 +1,2 @@
+# ipulse_shared_core
+Shared Models like User, Organization etc. Also includes shared enum_sets

{ipulse_shared_core_ftredge-5.1.1 → ipulse_shared_core_ftredge-6.1.1}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='ipulse_shared_core_ftredge',
-    version='5.1.1',
+    version='6.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-5.1.1 → ipulse_shared_core_ftredge-6.1.1}/src/ipulse_shared_core_ftredge/__init__.py

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

{ipulse_shared_core_ftredge-5.1.1 → ipulse_shared_core_ftredge-6.1.1}/src/ipulse_shared_core_ftredge/dependencies/authorization_api.py

@@ -182,9 +182,9 @@ async def authorizeAPIRequest(
                 "usertypes": request.state.user.get("usertypes"),
                 "email_verified": request.state.user.get("email_verified"),
                 "iam_groups": user_status.get("iam_groups"),
-                "active_sbscrptn_plan": user_status.get("active_sbscrptn_plan"),
-                "active_sbscrptn_status": user_status.get("sbscrptn_status"),
-                "sbscrptn_insight_credits": user_status.get("sbscrptn_insight_credits"),
+                "subscriptions": user_status.get("subscriptions"),
+                "sbscrptn_based_insight_credits": user_status.get("sbscrptn_based_insight_credits"),
+                "extra_insight_credits": user_status.get("extra_insight_credits")
             },
             "method": request.method.lower(),
             "request_resource_fields": request_resource_fields

{ipulse_shared_core_ftredge-5.1.1 → ipulse_shared_core_ftredge-6.1.1}/src/ipulse_shared_core_ftredge/models/__init__.py

@@ -3,8 +3,8 @@ from .subscription import Subscription
 from .user_status import UserStatus
 from .user_profile_update import UserProfileUpdate
 from .user_auth import UserAuth
-from .organisation import Organisation
-from .api_response import StandardResponse
+from .organization_profile import OrganizationProfile
+from .base_api_response import BaseAPIResponse, CustomJSONResponse
 
 
 

ipulse_shared_core_ftredge-5.1.1/src/ipulse_shared_core_ftredge/models/api_response.py → ipulse_shared_core_ftredge-6.1.1/src/ipulse_shared_core_ftredge/models/base_api_response.py

@@ -8,7 +8,7 @@ import json
 
 T = TypeVar('T')
 
-class StandardResponse(BaseModel, Generic[T]):
+class BaseAPIResponse(BaseModel, Generic[T]):
     model_config = ConfigDict(arbitrary_types_allowed=True)
     success: bool
     data: Optional[T] = None
@@ -19,7 +19,7 @@ class StandardResponse(BaseModel, Generic[T]):
         "timestamp": dt.datetime.now(dt.timezone.utc).isoformat()
     }
 
-class PaginatedResponse(StandardResponse, Generic[T]):
+class PaginatedAPIResponse(BaseAPIResponse, Generic[T]):
     total_count: int
     page: int
     page_size: int

ipulse_shared_core_ftredge-6.1.1/src/ipulse_shared_core_ftredge/models/base_data_model.py

@@ -0,0 +1,41 @@
+from datetime import datetime
+from typing import ClassVar, Optional
+from pydantic import BaseModel, Field, ConfigDict, field_validator
+import dateutil.parser
+
+class BaseDataModel(BaseModel):
+    """Base model with common fields and configuration"""
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    # Required class variables that must be defined in subclasses
+    VERSION: ClassVar[float]
+    DOMAIN: ClassVar[str]
+    OBJ_REF: ClassVar[str]
+
+    # Schema versioning
+    schema_version: float = Field(
+        ...,  # Make this required
+        description="Version of this Class == version of DB Schema",
+        frozen=True
+    )
+
+    # 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(...)
+
+    @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')
+    @classmethod
+    def parse_datetime(cls, v: any) -> datetime:
+        if isinstance(v, datetime):
+            return v
+        try:
+            return dateutil.parser.isoparse(v)
+        except (TypeError, ValueError) as e:
+            raise ValueError(f"Invalid datetime format: {e}")

ipulse_shared_core_ftredge-5.1.1/src/ipulse_shared_core_ftredge/models/organisation.py → ipulse_shared_core_ftredge-6.1.1/src/ipulse_shared_core_ftredge/models/organization_profile.py

@@ -13,10 +13,15 @@ import uuid
 import dateutil.parser
 from ipulse_shared_base_ftredge import (
     OrganizationRelation,
-    OrganizationIndustry
+    OrganizationIndustry,
+    Layer,
+    Module,
+    list_as_lower_strings,
+    Subject
 )
+from .base_data_model import BaseDataModel
 
-class Organisation(BaseModel):
+class OrganizationProfile(BaseDataModel):
     """
     Organisation model representing business entities in the system.
     Supports both retail and non-retail customer types with different validation rules.
@@ -24,30 +29,44 @@ class Organisation(BaseModel):
     model_config = ConfigDict(frozen=True, extra="forbid")
     
     # Class constants
-    VERSION: ClassVar[float] = 1.0
-    MODULE: ClassVar[str] = "core"
-    CLASS_REF: ClassVar[str] = "orgn"
+    VERSION: ClassVar[float] = 4.1
+    DOMAIN: ClassVar[str] = "_".join(list_as_lower_strings(Layer.PULSE_APP, Module.CORE.name, Subject.ORGANIZATION.name))
+    OBJ_REF: ClassVar[str] = "orgprofile"
 
-    # Required fields
-    puid: str = Field(
-        default_factory=lambda: f"{datetime.utcnow().strftime('%Y%m%d%H%M%S')}_{uuid.uuid4().hex[:8]}_{Organisation.MODULE}{Organisation.CLASS_REF}".lower(),
-        description="Unique identifier for the organisation"
+    schema_version: float = Field(
+        default=VERSION,
+        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",
+        frozen=True
+    )
+
+    id: str = Field(
+        default=None,
+        description="Organisation ID, format: {OBJ_REF}_{org_uid}"
+    )
+
     name: str = Field(..., min_length=1, max_length=100)
     relations: Set[OrganizationRelation] = Field(..., description="Organisation relations/types")
 
-    # Timestamps
-    creat_date: datetime = Field(default_factory=datetime.utcnow)
-    updt_date: datetime = Field(default_factory=datetime.utcnow)
-    
-    # Optional fields
-    creat_by_user: Optional[str] = Field(None, max_length=100)
-    updt_by_user: Optional[str] = Field(None, max_length=100)
     description: Optional[str] = Field(None, max_length=1000)
     industries: Optional[Set[OrganizationIndustry]] = None
     website: Optional[str] = Field(None, max_length=200)
     org_admin_user_uids: Optional[Set[str]] = None
 
+    @field_validator('id', mode='before')
+    @classmethod
+    def generate_id(cls, v: Optional[str], info) -> str:
+        values = info.data
+        org_uid = values.get('org_uid')
+        if not org_uid:
+            raise ValueError("org_uid must be set before generating id")
+        return f"{cls.OBJ_REF}_{org_uid}"
+
     @field_validator('relations')
     @classmethod
     def validate_relations(cls, v: Set[OrganizationRelation]) -> Set[OrganizationRelation]:
@@ -74,14 +93,4 @@ class Organisation(BaseModel):
             raise ValueError(f"{field} should not be set for retail customers")
         elif not is_retail and not v:
             raise ValueError(f"{field} required for non-retail customers")
-        return v
-
-    @field_validator('creat_date', 'updt_date', mode='before')
-    @classmethod
-    def parse_datetime(cls, v: any) -> datetime:
-        if isinstance(v, datetime):
-            return v
-        try:
-            return dateutil.parser.isoparse(v)
-        except (TypeError, ValueError) as e:
-            raise ValueError(f"Invalid datetime format: {e}")
+        return v

{ipulse_shared_core_ftredge-5.1.1 → ipulse_shared_core_ftredge-6.1.1}/src/ipulse_shared_core_ftredge/models/resource_catalog_item.py

@@ -20,7 +20,7 @@
 #     resr_contents:Set[str]
 #     resr_original_or_processed: str
 #     resr_origin: str
-#     resr_origin_organisations_uids: Set[str]
+#     resr_origin_organizations_uids: Set[str]
 #     resr_origin_description: str
 #     resr_licences_types: Set[str]
 #     resr_description_details: str 

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

@@ -0,0 +1,60 @@
+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
+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 = "active"
+
+############################################ !!!!! ALWAYS UPDATE SCHEMA VERSION , IF SCHEMA IS BEING MODIFIED !!! ############################################
+class Subscription(BaseDataModel):
+    """
+    Represents a single subscription cycle.
+    """
+
+    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))
+    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
+    )
+
+    plan_name: SubscriptionPlan = Field(
+        default=DEFAULT_SUBSCRIPTION_PLAN,
+        description="Subscription Plan Name"
+    )
+
+    plan_version: float = Field(
+        default=1.0,
+        description="Version of the subscription plan"
+    )
+
+    cycle_start_date: datetime = Field(
+        default=datetime.now(timezone.utc),
+        description="Subscription Cycle Start Date"
+    )
+    cycle_end_date: datetime = Field(
+        default=lambda: datetime.now(timezone.utc) + relativedelta(years=1),
+        description="Subscription Cycle End Date"
+    )
+    auto_renew: bool = Field(
+        default=True,
+        description="Auto-renewal status"
+    )
+    status: str = Field(
+        default=DEFAULT_SUBSCRIPTION_STATUS,
+        description="Subscription Status (active, trial, inactive, etc.)"
+    )
+
+    # Remove audit fields as they're inherited from BaseDataModel

{ipulse_shared_core_ftredge-5.1.1 → ipulse_shared_core_ftredge-6.1.1}/src/ipulse_shared_core_ftredge/models/user_profile.py

@@ -1,12 +1,14 @@
 from datetime import datetime, date
+import dateutil.parser
 from typing import Set, Optional, ClassVar
-from pydantic import BaseModel, EmailStr, Field, ConfigDict
-from ipulse_shared_base_ftredge import Layer, Module, list_as_lower_strings
+from pydantic import BaseModel, EmailStr, Field, ConfigDict, field_validator
+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)
-class UserProfile(BaseModel):
+class UserProfile(BaseDataModel):
     """
     User Profile model representing user information and metadata.
     Contains both system-managed and user-editable fields.
@@ -14,8 +16,9 @@ class UserProfile(BaseModel):
     model_config = ConfigDict(frozen=True, extra="forbid")
 
     # Metadata as class variables
-    VERSION: ClassVar[float] = 3.01
-    DOMAIN: ClassVar[str] = "_".join(list_as_lower_strings(Layer.PULSE_APP, Module.CORE.name))
+    VERSION: ClassVar[float] = 4.1
+    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(
@@ -23,6 +26,18 @@ class UserProfile(BaseModel):
         description="Version of this Class == version of DB Schema",
         frozen=True
     )
+    
+    id : str = Field(
+        ...,
+        description="User ID, propagated from Firebase Auth"
+    )
+
+    user_uid: str = Field(
+        ...,
+        description="User UID, propagated from Firebase Auth"
+    )
+
+
     email: EmailStr = Field(
         ...,
         description="Propagated from Firebase Auth",
@@ -30,21 +45,13 @@ class UserProfile(BaseModel):
     )
     organizations_uids: Set[str] = Field(
         default_factory=set,
-        description="Depends on Subscription Plan, Regularly Updated",
-        frozen=True
+        description="Depends on Subscription Plan, Regularly Updated"
     )
     
-    # Timestamps and audit fields (read-only)
-    creat_date: datetime = Field(frozen=True)
-    creat_by_user: str = Field(frozen=True)
-    updt_date: datetime = Field(frozen=True)
-    updt_by_user: str = Field(frozen=True)
-    
     # System identification (read-only)
     provider_id: str = Field(frozen=True)
     aliases: Optional[Set[str]] = Field(
-        default=None,
-        frozen=True
+        default=None
     )
     
     # User-editable fields
@@ -69,4 +76,20 @@ class UserProfile(BaseModel):
         default=None,
         pattern=r"^\+?[1-9]\d{1,14}$",  # Added 'r' prefix for raw string
         description="E.164 format phone number"
-    )
+    )
+
+    # Remove audit fields as they're inherited from BaseDataModel
+
+    @field_validator('id', mode='before')
+    @classmethod
+    def validate_or_generate_id(cls, v: Optional[str], info) -> str:
+        # 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}"

{ipulse_shared_core_ftredge-5.1.1 → ipulse_shared_core_ftredge-6.1.1}/src/ipulse_shared_core_ftredge/models/user_profile_update.py

@@ -1,6 +1,6 @@
 from typing import Optional, Set, ClassVar
 from pydantic import BaseModel, Field, EmailStr, ConfigDict
-from datetime import date, datetime
+from datetime import date
 
 class UserProfileUpdate(BaseModel):
     """
@@ -12,20 +12,12 @@ class UserProfileUpdate(BaseModel):
     # Metadata as class variables
     VERSION: ClassVar[float] = 2.01
     CLASS_ORIGIN_AUTHOR: ClassVar[str] = "Russlan Ramdowar;russlan@ftredge.com"
-    CLASS_ORGIN_DATE: ClassVar[datetime] = datetime(2024, 3, 15, 20, 15)
-    CLASS_REVISION_DATE: ClassVar[datetime] = datetime(2024, 3, 15, 20, 15)
+ 
 
     # System fields
-    schema_version: Optional[float] = Field(None, description="Version of this Class == version of DB Schema")
     email: Optional[EmailStr] = Field(None, description="Propagated from Firebase Auth")
     organizations_uids: Optional[Set[str]] = Field(None, description="Organization memberships")
     
-    # Timestamps and audit
-    creat_date: Optional[datetime] = None
-    creat_by_user: Optional[str] = None
-    updt_date: Optional[datetime] = None
-    updt_by_user: Optional[str] = None
-    
     # System identification
     aliases: Optional[Set[str]] = None
     provider_id: Optional[str] = None
@@ -37,6 +29,8 @@ class UserProfileUpdate(BaseModel):
     last_name: Optional[str] = Field(None, max_length=100)
     mobile: Optional[str] = Field(None, pattern=r"^\+?[1-9]\d{1,14}$")
 
+    # Remove audit fields
+
     def model_dump(self, **kwargs):
         kwargs.setdefault('exclude_none', True)
         return super().model_dump(**kwargs)

{ipulse_shared_core_ftredge-5.1.1 → ipulse_shared_core_ftredge-6.1.1}/src/ipulse_shared_core_ftredge/models/user_status.py

@@ -1,41 +1,51 @@
-from datetime import datetime, timezone
-from dateutil.relativedelta import relativedelta
+from datetime import datetime
 from typing import Set, Optional, Dict, List, ClassVar
-from pydantic import BaseModel, Field, ConfigDict
+from pydantic import BaseModel, Field, ConfigDict, field_validator
 from .subscription import Subscription
-from ipulse_shared_base_ftredge import Layer, Module, list_as_lower_strings
+from ipulse_shared_base_ftredge import Layer, Module, list_as_lower_strings, Subject
+import dateutil.parser
+from .base_data_model import BaseDataModel
 # ORIGINAL AUTHOR ="Russlan Ramdowar;russlan@ftredge.com"
 # CLASS_ORGIN_DATE=datetime(2024, 2, 12, 20, 5)
 
-DEFAULT_IAM_GROUPS={"pulseroot":["full_open_read"]}
-DEFAULT_SUBSCRIPTION_INSIGHT_CREDITS=10
-DEFAULT_EXTRA_INSIGHT_CREDITS=0
-
 ############################################ !!!!! ALWAYS UPDATE SCHEMA VERSION , IF SCHEMA IS BEING MODIFIED !!! ############################################
-class UserStatus(BaseModel):
+class UserStatus(BaseDataModel):
     """
     User Status model for tracking user subscription and access rights.
     """
     model_config = ConfigDict(frozen=True, extra="forbid")
 
     # Class constants
-    VERSION: ClassVar[float] = 2.3
-    DOMAIN: ClassVar[str] = "_".join(list_as_lower_strings(Layer.PULSE_APP, Module.CORE.name))
-    OBJ_REF: ClassVar[str] = "usrsttus"
+    VERSION: ClassVar[float] = 4.1
+    DOMAIN: ClassVar[str] = "_".join(list_as_lower_strings(Layer.PULSE_APP, Module.CORE.name, Subject.USER.name))
+    OBJ_REF: ClassVar[str] = "userstatus"
     
     # Default values as class variables
     DEFAULT_IAM_GROUPS: ClassVar[Dict[str, List[str]]] = {"pulseroot": ["full_open_read"]}
     DEFAULT_SUBSCRIPTION_PLAN: ClassVar[str] = "subscription_free"
     DEFAULT_SUBSCRIPTION_STATUS: ClassVar[str] = "active"
     DEFAULT_SUBSCRIPTION_INSIGHT_CREDITS: ClassVar[int] = 10
+    DEFAULT_VOTING_CREDITS: ClassVar[int] = 0
     DEFAULT_EXTRA_INSIGHT_CREDITS: ClassVar[int] = 0
+    
 
     # System-managed fields
     schema_version: float = Field(
         default=VERSION,
+        frozen=True,
         description="Version of this Class == version of DB Schema"
     )
     
+    id : str = Field(
+        ...,
+        description="User ID, format: {OBJ_REF}_{user_uid}"
+    )
+
+    user_uid: str = Field(
+        ...,
+        description="User UID from Firebase Auth"
+    )
+
     # IAM and subscription fields
     iam_groups: Dict[str, List[str]] = Field(
         default_factory=lambda: UserStatus.DEFAULT_IAM_GROUPS,
@@ -49,11 +59,11 @@ class UserStatus(BaseModel):
     )
 
     # Credits management
-    sbscrptn_allowance_insight_credits: int = Field(
+    sbscrptn_based_insight_credits: int = Field(
         default_factory=lambda: UserStatus.DEFAULT_SUBSCRIPTION_INSIGHT_CREDITS,
         description="Subscription-based insight credits"
     )
-    sbscrptn_allowance_insight_credits_updtd_on: datetime = Field(
+    sbscrptn_based_insight_credits_updtd_on: datetime = Field(
         default_factory=datetime.now,
         description="Last update timestamp for subscription credits"
     )
@@ -61,12 +71,32 @@ class UserStatus(BaseModel):
         default_factory=lambda: UserStatus.DEFAULT_EXTRA_INSIGHT_CREDITS,
         description="Additional purchased insight credits (non-expiring)"
     )
+
+    extra_insight_credits_updtd_on: datetime = Field(
+        default_factory=datetime.now,
+        description="Last update timestamp for extra credits"
+    )
+
+    voting_credits: int = Field(
+        default=lambda : UserStatus.DEFAULT_VOTING_CREDITS,
+        description="Voting credits for user"
+    )
     
     # Optional fields
     payment_refs_uids: Optional[Set[str]] = None
     
-    # Audit fields
-    creat_date: datetime
-    creat_by_user: str
-    updt_date: datetime
-    updt_by_user: str
+    # Remove audit fields as they're inherited from BaseDataModel
+
+    @field_validator('id', mode='before')
+    @classmethod
+    def validate_or_generate_id(cls, v: Optional[str], info) -> str:
+        # 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}"

ipulse_shared_core_ftredge-6.1.1/src/ipulse_shared_core_ftredge/services/base_firestore_service.py

@@ -0,0 +1,170 @@
+from typing import Dict, Any, Optional, List, TypeVar, Generic
+import logging
+from datetime import datetime, timezone
+from pydantic import BaseModel
+from google.cloud import firestore
+from .exceptions import ResourceNotFoundError, ValidationError, ServiceError
+
+T = TypeVar('T', bound=BaseModel)
+
+class BaseFirestoreService(Generic[T]):
+    """Base class for Firestore services with common CRUD operations"""
+    
+    def __init__(self, db: firestore.Client, collection_name: str, resource_type: str, logger: logging.Logger):
+        self.db = db
+        self.collection_name = collection_name
+        self.resource_type = resource_type
+        self.logger = logger
+
+    async def create_document(self, doc_id: str, data: T, creator_uid: str) -> Dict[str, Any]:
+        """Standard create method with audit fields"""
+        try:
+            current_time = datetime.now(timezone.utc)
+            doc_data = data.model_dump(mode='json')
+            
+            # Add audit fields
+            doc_data.update({
+                'creat_date': current_time.isoformat(),
+                'creat_by_user': creator_uid,
+                'updt_date': current_time.isoformat(),
+                'updt_by_user': creator_uid
+            })
+
+            doc_ref = self.db.collection(self.collection_name).document(doc_id)
+            doc_ref.set(doc_data)
+            
+            self.logger.info(f"Created {self.resource_type}: {doc_id}")
+            return doc_data
+
+        except Exception as e:
+            self.logger.error(f"Error creating {self.resource_type}: {e}", exc_info=True)
+            raise ServiceError(
+                operation=f"creating {self.resource_type}",
+                error=e,
+                resource_type=self.resource_type,
+                resource_id=doc_id
+            ) from e
+
+    async def create_batch_documents(self, documents: List[T], creator_uid: str) -> List[Dict[str, Any]]:
+        """Standard batch create method"""
+        try:
+            batch = self.db.batch()
+            current_time = datetime.now(timezone.utc)
+            created_docs = []
+
+            for doc in documents:
+                doc_data = doc.model_dump(mode='json')
+                doc_data.update({
+                    'creat_date': current_time.isoformat(),
+                    'creat_by_user': creator_uid,
+                    'updt_date': current_time.isoformat(),
+                    'updt_by_user': creator_uid
+                })
+                
+                doc_ref = self.db.collection(self.collection_name).document(doc_data.get('id'))
+                batch.set(doc_ref, doc_data)
+                created_docs.append(doc_data)
+
+            batch.commit()
+            self.logger.info(f"Created {len(documents)} {self.resource_type}s in batch")
+            return created_docs
+
+        except Exception as e:
+            self.logger.error(f"Error batch creating {self.resource_type}s: {e}", exc_info=True)
+            raise ServiceError(
+                operation=f"batch creating {self.resource_type}s",
+                error=e,
+                resource_type=self.resource_type,
+                resource_id=doc_data.get('id')
+            ) from e
+
+    async def get_document(self, doc_id: str) -> Dict[str, Any]:
+        """Get a document by ID with standardized error handling"""
+        doc_ref = self.db.collection(self.collection_name).document(doc_id)
+        doc = doc_ref.get()
+        
+        if not doc.exists:
+            raise ResourceNotFoundError(
+                resource_type=self.resource_type,
+                resource_id=doc_id,
+                additional_info={"collection": self.collection_name}
+            )
+            
+        return doc.to_dict()
+
+    async def update_document(self, doc_id: str, update_data: Dict[str, Any], updater_uid: str) -> Dict[str, Any]:
+        """Standard update method with validation and audit fields"""
+        try:
+            doc_ref = self.db.collection(self.collection_name).document(doc_id)
+            
+            if not doc_ref.get().exists:
+                raise ResourceNotFoundError(
+                    resource_type=self.resource_type,
+                    resource_id=doc_id,
+                    additional_info={"collection": self.collection_name}
+                )
+            
+            valid_fields = self._validate_update_fields(update_data)
+            
+            # Add audit fields
+            valid_fields.update({
+                'updt_date': datetime.now(timezone.utc).isoformat(),
+                'updt_by_user': updater_uid
+            })
+            
+            doc_ref.update(valid_fields)
+            return doc_ref.get().to_dict()
+            
+        except (ResourceNotFoundError, ValidationError):
+            raise
+        except Exception as e:
+            self.logger.error(f"Error updating {self.resource_type}: {e}", exc_info=True)
+            raise ServiceError(
+                operation=f"updating {self.resource_type}",
+                error=e,
+                resource_type=self.resource_type,
+                resource_id=doc_id
+            ) from e
+
+    async def delete_document(self, doc_id: str) -> None:
+        """Standard delete method"""
+        try:
+            doc_ref = self.db.collection(self.collection_name).document(doc_id)
+            if not doc_ref.get().exists:
+                raise ResourceNotFoundError(
+                    resource_type=self.resource_type,
+                    resource_id=doc_id
+                )
+                
+            doc_ref.delete()
+            self.logger.info(f"Deleted {self.resource_type}: {doc_id}")
+
+        except ResourceNotFoundError:
+            raise
+        except Exception as e:
+            self.logger.error(f"Error deleting {self.resource_type}: {e}", exc_info=True)
+            raise ServiceError(
+                operation=f"deleting {self.resource_type}",
+                error=e,
+                resource_type=self.resource_type,
+                resource_id=doc_id
+            ) from e
+
+    def _validate_update_fields(self, update_data: Dict[str, Any]) -> Dict[str, Any]:
+        """Centralized update fields validation"""
+        if not isinstance(update_data, dict):
+            update_data = update_data.model_dump(exclude_unset=True)
+            
+        valid_fields = {
+            k: v for k, v in update_data.items()
+            if v is not None and not (isinstance(v, (list, dict, set)) and len(v) == 0)
+        }
+        
+        if not valid_fields:
+            raise ValidationError(
+                resource_type=self.resource_type,
+                detail="No valid fields to update",
+                resource_id=None
+            )
+            
+        return valid_fields

{ipulse_shared_core_ftredge-5.1.1 → ipulse_shared_core_ftredge-6.1.1/src/ipulse_shared_core_ftredge.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ipulse_shared_core_ftredge
-Version: 5.1.1
+Version: 6.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-5.1.1 → ipulse_shared_core_ftredge-6.1.1}/src/ipulse_shared_core_ftredge.egg-info/SOURCES.txt

@@ -14,8 +14,9 @@ src/ipulse_shared_core_ftredge/dependencies/authorization_api.py
 src/ipulse_shared_core_ftredge/dependencies/database.py
 src/ipulse_shared_core_ftredge/dependencies/token_validation.py
 src/ipulse_shared_core_ftredge/models/__init__.py
-src/ipulse_shared_core_ftredge/models/api_response.py
-src/ipulse_shared_core_ftredge/models/organisation.py
+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/organization_profile.py
 src/ipulse_shared_core_ftredge/models/resource_catalog_item.py
 src/ipulse_shared_core_ftredge/models/subscription.py
 src/ipulse_shared_core_ftredge/models/user_auth.py

ipulse_shared_core_ftredge-5.1.1/README.md

@@ -1,2 +0,0 @@
-# ipulse_shared_core
-Shared Models like User, Organisation etc. Also includes shared enum_sets

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

@@ -1,34 +0,0 @@
-from datetime import datetime, timezone
-from dateutil.relativedelta import relativedelta
-from typing import Set, Optional, Dict, List, ClassVar
-from pydantic import BaseModel, Field, ConfigDict
-from ipulse_shared_base_ftredge import Layer, Module, list_as_lower_strings
-# ORIGINAL AUTHOR ="Russlan Ramdowar;russlan@ftredge.com"
-# CLASS_ORGIN_DATE=datetime(2024, 2, 12, 20, 5)
-
-
-DEFAULT_SUBSCRIPTION_PLAN="subscription_free"
-DEFAULT_SUBSCRIPTION_STATUS="active"
-
-############################################ !!!!! ALWAYS UPDATE SCHEMA VERSION , IF SCHEMA IS BEING MODIFIED !!! ############################################
-class Subscription(BaseModel):
-    """
-    Represents a single subscription cycle.
-    """
-    plan_name: str = Field(
-        default=DEFAULT_SUBSCRIPTION_PLAN,
-        description="Subscription Plan Name"
-    )
-
-    cycle_start_date: datetime = Field(
-        default=datetime.now(timezone.utc),
-        description="Subscription Cycle Start Date"
-    )
-    cycle_end_date: datetime = Field(
-        default=lambda: datetime.now(timezone.utc) + relativedelta(years=1),
-        description="Subscription Cycle End Date"
-    )
-    status: str = Field(
-        default=DEFAULT_SUBSCRIPTION_STATUS,
-        description="Subscription Status (active, inactive, etc.)"
-    )

ipulse_shared_core_ftredge-5.1.1/src/ipulse_shared_core_ftredge/services/base_firestore_service.py

@@ -1,75 +0,0 @@
-from typing import Dict, Any, Optional
-from datetime import datetime,timezone
-from fastapi import HTTPException
-from google.cloud import firestore
-from .exceptions import ResourceNotFoundError, ValidationError
-
-class BaseFirestoreService:
-    def __init__(self, db: firestore.Client, collection_name: str, resource_type: str):
-        self.db = db
-        self.collection_name = collection_name
-        self.resource_type = resource_type
-
-    def _validate_update_fields(self, update_data: Dict[str, Any]) -> Dict[str, Any]:
-        """Centralized update fields validation"""
-        if not isinstance(update_data, dict):
-            update_data = update_data.model_dump(exclude_unset=True)
-            
-        valid_fields = {
-            k: v for k, v in update_data.items()
-            if v is not None and not (isinstance(v, (list, dict, set)) and len(v) == 0)
-        }
-        
-        if not valid_fields:
-            raise ValidationError(
-                resource_type=self.resource_type,
-                detail="No valid fields to update",
-                resource_id=None
-            )
-            
-        return valid_fields
-
-    async def get_document(self, doc_id: str) -> Dict[str, Any]:
-        """Get a document by ID with standardized error handling"""
-        doc_ref = self.db.collection(self.collection_name).document(doc_id)
-        doc = doc_ref.get()
-        
-        if not doc.exists:
-            raise ResourceNotFoundError(
-                resource_type=self.resource_type,
-                resource_id=doc_id,
-                additional_info={"collection": self.collection_name}
-            )
-            
-        return doc.to_dict()
-
-    async def update_document(self, doc_id: str, update_data: Dict[str, Any], user_uid: Optional[str] = None) -> Dict[str, Any]:
-        """Standard update method with validation and audit fields"""
-        try:
-            doc_ref = self.db.collection(self.collection_name).document(doc_id)
-            
-            if not doc_ref.get().exists:
-                raise ResourceNotFoundError(
-                    resource_type=self.resource_type,
-                    resource_id=doc_id,
-                    additional_info={"collection": self.collection_name}
-                )
-            
-            valid_fields = self._validate_update_fields(update_data)
-            
-            # Add audit fields
-            valid_fields.update({
-                'updt_date': datetime.now(timezone.utc).isoformat(),
-                'updt_by_user': user_uid if user_uid else None
-            })
-            
-            doc_ref.update(valid_fields)
-            return doc_ref.get().to_dict()
-            
-        except (ResourceNotFoundError, ValidationError):
-            raise
-        except Exception as e:
-            raise HTTPException(
-                status_code=500,
-                detail=f"Failed to update {self.resource_type}: {str(e)}"
-            )