flowtask 5.8.4__cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

flowtask/components/NetworkNinja/models/forms.py

@@ -0,0 +1,499 @@
+from typing import List, Optional, Union, Any
+import logging
+from datetime import datetime, timezone
+from asyncpg.exceptions import UniqueViolationError
+from asyncdb import AsyncDB
+from datamodel import BaseModel, Field
+from querysource.conf import default_dsn, async_default_dsn
+from querysource.outputs.tables import PgOutput
+from .abstract import AbstractPayload
+from .organization import Organization
+from .client import Client
+from .store import CustomStoreField, Store, StoreType
+from .user import User, StaffingUser
+from .region import Region
+from .account import Account
+
+
+class Condition(BaseModel):
+    """
+    Defines a Condition, a condition for a Logic Group.
+    Example:
+        {
+            "condition_id": 1835,
+            "condition_logic": "EQUALS",
+            "condition_comparison_value": "Regular",
+            "condition_question_reference_id": 48,
+            "condition_option_id": 4308
+        }
+    """
+    condition_id: int = Field(primary_key=True, required=True)
+    condition_logic: str = Field(required=True)
+    condition_comparison_value: str = Field(required=True)
+    condition_question_reference_id: str
+    condition_option_id: str
+
+
+class Validation(BaseModel):
+    """
+    Defines a Validation, a validation rule for a question.
+    Example:
+        {
+            "validation_id": 43,
+            "validation_type": "responseRequired",
+            "validation_logic": null,
+            "validation_comparison_value": null,
+            "validation_question_reference_id": null
+        }
+    """
+    validation_id: int = Field(primary_key=True, required=True)
+    validation_type: str = Field(required=True)
+    validation_logic: str
+    validation_comparison_value: str
+    validation_question_reference_id: str
+    condition_option_id: str
+
+
+class LogicGroup(BaseModel):
+    """
+    Defines a Logic Group, a group of questions in a Form.
+    Example:
+        {
+            "logic_group_id": 1706,
+            "conditions": [
+                {
+                    "condition_id": 1835,
+                    "condition_logic": "EQUALS",
+                    "condition_comparison_value": "Regular",
+                    "condition_question_reference_id": 48,
+                    "condition_option_id": 4308
+                }
+            ]
+        }
+    """
+    logic_group_id: int = Field(primary_key=True, required=True)
+    conditions: List[Condition]
+
+
+class Question(BaseModel):
+    """
+    Defines a Question, a single question in a Form.
+    Example:
+        {
+            "question_id": 48,
+            "question_column_name": "8501",
+            "question_description": "Purpose of Visit",
+            "question_logic_groups": [],
+            "validations": [
+                {
+                    "validation_id": 43,
+                    "validation_type": "responseRequired",
+                    "validation_logic": null,
+                    "validation_comparison_value": null,
+                    "validation_question_reference_id": null
+                }
+            ]
+        }
+    """
+    question_id: int = Field(primary_key=True, required=True)
+    question_column_name: Union[str, int] = Field(required=True)
+    question_description: str = Field(required=True)
+    question_logic_groups: List[LogicGroup]
+    validations: List[Validation]
+
+class QuestionBlock(BaseModel):
+    """
+    Defines a Question Block, a collection of questions in a Form.
+
+    Example:
+        {
+            "question_block_id": 9,
+            "question_block_type": "simple",
+            "question_block_logic_groups": [],
+            "questions": []
+        }
+    """
+    block_id: int = Field(primary_key=True, required=True, alias="question_block_id")
+    block_type: str = Field(alias="question_block_type")
+    block_logic_groups: List[dict] = Field(alias="question_block_logic_groups")
+    questions: List[dict]
+
+class FormDefinition(AbstractPayload):
+    """
+    Defines a Form (recap) definition.
+    """
+    formid: int = Field(primary_key=True, required=True)
+    client_id: Client = Field(required=True, primary_key=True)
+    client_name: str
+    form_name: str
+    description: str = Field(alias='form_description')
+    active: bool = Field(default=True)
+    is_store_stamp: bool = Field(default=True)
+    created_on: datetime
+    updated_on: datetime
+    orgid: Organization
+    question_blocks: Optional[List[QuestionBlock]] = Field(default_factory=list)
+
+    class Meta:
+        strict = True
+        as_objects = True
+        name = 'forms'
+        schema: str = 'networkninja'
+
+    def __post_init__(self):
+        super().__post_init__()
+        if not self.description:
+            self.description = self.form_name
+        if self.client_id:
+            self.client_id.client_name = self.client_name
+            self.client_id.orgid = self.orgid
+
+class Form(AbstractPayload):
+    """
+    Reference to a Form:
+    """
+    formid: int = Field(primary_key=True, required=True)
+    form_name: Optional[str]
+    active: bool = Field(default=True)
+    client_id: Client
+    client_name: str
+    orgid: Organization
+
+    class Meta:
+        strict = True
+        as_objects = True
+        name = 'forms'
+        schema: str = 'networkninja'
+
+    def __post_init__(self):
+        super().__post_init__()
+        if self.client_id:
+            self.client_id.client_name = self.client_name
+            self.client_id.orgid = self.orgid
+
+    async def on_sync(self):
+        """
+        Sync the form with the database.
+        """
+class FormMetadata(AbstractPayload):
+    """
+    Defines a Form Metadata, a single question from a Form.
+
+    Example:
+        {
+            "column_name": "8452",
+            "description": "Please provide a photo of the starting odometer reading",
+            "is_active": true,
+            "data_type": "FIELD_IMAGE_UPLOAD",
+            "formid": 1,
+            "form_name": "Territory Manager Visit Form TEST",
+            "client_id": 59,
+            "client_name": "TRENDMICRO",
+            "orgid": 77
+        }
+    """
+    # Column ID is not returned by Form Metadata payload but Form Data.
+    column_id: int
+    formid: Form = Field(primary_key=True, required=True)
+    client_id: Client = Field(primary_key=True, required=True)
+    column_name: Union[str, int] = Field(primary_key=True, required=True)
+    description: str
+    data_type: str = Field(required=True, alias='data_type')
+    form_name: str
+    is_active: bool = Field(required=True, default=True)
+    client_name: str
+    orgid: Organization = Field(required=True)
+
+    class Meta:
+        strict = True
+        as_objects = True
+        name = 'form_metadata'
+        schema: str = 'networkninja'
+
+    def __post_init__(self):
+        super().__post_init__()
+        self.formid.form_name = self.form_name
+        if self.column_id is None:
+            try:
+                self.column_id = int(self.column_name)
+            except ValueError:
+                self.column_id = 0
+        if self.client_id:
+            self.client_id.client_name = self.client_name
+            self.client_id.orgid = self.orgid
+        if self.formid:
+            self.formid.client_id = self.client_id
+            self.formid.client_name = self.client_name
+            self.formid.orgid = self.orgid
+            self.formid.form_name = self.form_name
+            self.formid.active = self.is_active
+
+    async def insert_record(self, conn: Any, **kwargs):
+        """Insert Record to Database.
+        """
+        # Convert all objects in dataclass into a INSERT statement
+        columns = self.get_fields()
+        # remove from column list the "_pgoutput" field
+        columns = [col for col in columns if col != '_pgoutput']
+        cols = ",".join(columns)
+        data = self.to_dict(as_values=True)
+        # print('DATA > ', data)
+        data.pop('_pgoutput', None)
+        _values = ', '.join([f"${i+1}" for i, _ in enumerate(columns)])
+        insert = f"INSERT INTO {self.Meta.schema}.{self.Meta.name}({cols}) VALUES({_values})"
+        try:
+            # Convert data dictionary into a list, ordered by column list:
+            source = [data.get(col) for col in columns]
+            stmt = await conn.engine().prepare(insert)
+            result = await stmt.fetchrow(*source, timeout=2)
+            # logging.debug(f"Result: {result}, Status: {stmt.get_statusmsg()}")
+            return True
+        except UniqueViolationError as e:
+            logging.warning(
+                f"Error Inserting Record, doing Upsert: {e}"
+            )
+            return await self.upsert_record(
+                pk=['column_name', 'client_id', 'formid'],
+                **kwargs
+            )
+        except Exception as e:
+            print(type(e))
+            logging.error(
+                f"Error Inserting Record: {e}"
+            )
+            return False
+
+class FormResponse(BaseModel):
+    """
+    Defines a Form Response, a response to a Form.
+
+    Example:
+        {
+            "event_id": 10516,
+            "column_name": 8550,
+            "data": "Arturo",
+            "question_shown_to_user": true,
+            "column_id": "150698"
+        }
+    """
+    formid: int = Field(required=False)
+    form_id: int = Field(required=False)
+    column_name: str = Field(primary_key=True)
+    column_id: str
+    event_id: int
+    data: Union[str, None]
+    question_shown_to_user: bool = Field(default=True)
+    client_id: int
+    orgid: int
+
+    class Meta:
+        name: str = 'form_responses'
+        schema: str = 'networkninja'
+
+class FormData(AbstractPayload):
+    """
+    Defines a Form Data, a collection of responses to a Form.
+
+    Example:
+        {
+            "form_data_id": 1,
+            "formid": 1,
+            "client_id": 59,
+            "orgid": 77,
+            "store_id": 1,
+            "store_name": "Best Buy 4350",
+            "user_id": 1,
+            "user_name": "Arturo",
+            "created_at": "2025-02-01T00:00:00-06:00",
+            "updated_at": "2025-02-01T00:00:00-06:00",
+            "form_responses": [
+                {
+                    "column_name": "8550",
+                    "data": "Arturo",
+                    "question_shown_to_user": true,
+                    "column_id": "150698"
+                }
+            ]
+        }
+    """
+    form_id: int = Field(primary_key=True, required=True)
+    formid: int = Field(primary_key=True, required=True)
+    previous_form_id: int
+    current_form_id: int
+    event_id: int = Field(required=False)
+    version: str
+    creation_timestamp: Optional[datetime]
+    start_lat: Optional[float]
+    start_lon: Optional[float]
+    end_lat: Optional[float]
+    end_lon: Optional[float]
+    visit_timestamp: Optional[datetime]
+    updated_timestamp: Optional[datetime]
+    project_id: int = Field(alias='program_id')
+    time_in_local: str
+    time_in: datetime
+    visit_start_local: Optional[datetime]
+    visit_end_local: Optional[datetime]
+    time_out_local: str
+    time_out: datetime
+    device_model: str
+    visitor_id: int
+    visitor_username: str
+    visitor_name: str
+    visitor_email: str
+    visitor_mobile_number: str
+    visitor_geography_timezone: str
+    user_id: StaffingUser
+    position_id: str  # TODO: validate position ID
+    store_visits_category: int
+    store_visits_category_name: str
+    visit_status: str
+    ad_hoc: bool = Field(required=True, default=False)
+    visitor_role: str
+    account_id: int
+    account_name: str
+    retailer: str
+    store_number: int = Field(alias="store_id")
+    store: Store
+    store_name: str
+    store_type_id: int
+    store_type_name: str
+    store_timezone: str
+    store_is_active: bool = Field(default=True)
+    # hierarchy:
+    store_market_id: int
+    store_market_name: str
+    store_city: str
+    store_zipcode: str
+    region_id: int
+    region_name: str
+    district_id: int
+    district_name: str
+    market_id: int
+    market_name: str
+    client_id: int = Field(required=True)
+    client_name: str
+    orgid: int = Field(required=True)
+    field_responses: List[FormResponse]
+    store_custom_fields: List[CustomStoreField]
+    manager_role: str
+    is_archived: bool = Field(default=False)
+    is_deleted: bool = Field(default=False)
+
+    class Meta:
+        strict = False
+        as_objects = True
+        name = 'form_data'
+        schema: str = 'networkninja'
+
+    def __post_init__(self):
+        super().__post_init__()
+        responses = []
+        for f in self.field_responses:
+            if isinstance(f, dict):
+                try:
+                    responses.append(
+                        FormResponse(**f)
+                    )
+                except Exception as e:
+                    print('Error in creating FormResponse instance:', e)
+            else:
+                responses.append(f)
+        self.field_responses = responses
+        # Definition of Store Custom Fields
+        if self.store_custom_fields:
+            for st in self.store_custom_fields:
+                st.orgid = self.orgid
+        # Definition of Store associated
+        if self.store_number:
+            self.store = Store(store_number=self.store_number)
+            self.store.store_name = self.store_name
+            self.store.city = self.store_city
+            self.store.zipcode = self.store_zipcode
+            self.store.account_id = self.account_id
+            self.store.account_name = self.account_name
+            if self.store_type_id:
+                self.store.store_type_id = StoreType(
+                    store_type_id=self.store_type_id,
+                    store_type=self.store_type_name,
+                    description=self.store_type_name,
+                    client_id=self.client_id,
+                    client_name=self.client_name
+                )
+            self.store.store_timezone = self.store_timezone
+            self.store.store_is_active = self.store_is_active
+            # Client info:
+            self.store.client_id = self.client_id
+            self.store.client_name = self.client_name
+            self.store.orgid = self.orgid
+            self.store.custom_fields = self.store_custom_fields
+        # Definition of User associated
+        if self.visitor_id:
+            args = {
+                'user_id': self.visitor_id,
+                'username': self.visitor_username,
+                'display_name': self.visitor_name,
+                'email_address': self.visitor_email,
+                'mobile_number': self.visitor_mobile_number,
+                'position_id': self.position_id,
+                'role_name': self.visitor_role,
+                'orgid': self.orgid,
+                'client_id': self.client_id,
+            }
+            try:
+                self.user_id = StaffingUser(**args)
+            except Exception as e:
+                logging.warning(
+                    f'Error in creating StaffingUser instance: {e}'
+                )
+
+    async def update_form(self):
+        new_form = self.form_id
+        previous_form = self.previous_form_id
+        qry = "UPDATE networkninja.form_data SET form_id = $1 WHERE form_id = $2"
+        db = AsyncDB('pg', dsn=default_dsn)
+        async with await db.connection() as conn:
+            try:
+                await conn.execute(qry, new_form, previous_form)
+                # But also, delete all the form_responses:
+                qry = "DELETE FROM networkninja.form_responses WHERE form_id = $1"
+                await conn.execute(qry, previous_form)
+            except Exception as e:
+                logging.error(f"Error Updating Form: {e}")
+
+    async def save(self, conn: Any, pk: Union[str, list] = None, **kwargs):
+        """
+        Always do an UPSERT on Form Data:
+        """
+        try:
+            async with self._pgoutput as conn:
+                result = await conn.do_upsert(
+                    self,
+                    table_name=self.Meta.name,
+                    schema=self.Meta.schema,
+                    primary_keys=['form_id', 'formid'],
+                    use_conn=conn.get_connection()
+                )
+            return result
+            # # If conn is provided, use it, otherwise use our output connection
+            # if conn:
+            #     result = await self._pgoutput.do_upsert(
+            #         self,
+            #         table_name=self.Meta.name,
+            #         schema=self.Meta.schema,
+            #         primary_keys=['form_id', 'formid'],
+            #         use_conn=conn
+            #     )
+            # else:
+            #     # Use the connection pool for better management
+            #     async with self._pgoutput as output:
+            #         result = await output.do_upsert(
+            #             self,
+            #             table_name=self.Meta.name,
+            #             schema=self.Meta.schema,
+            #             primary_keys=['form_id', 'formid']
+            #         )
+            # return result
+        except Exception as e:
+            logging.error(f"Error saving form data: {e}")
+            raise

flowtask/components/NetworkNinja/models/market.py

@@ -0,0 +1,16 @@
+from datamodel import BaseModel, Field
+from .abstract import AbstractPayload
+
+class Market(AbstractPayload):
+    market_id: str = Field(required=False, alias='id')
+    market_name: str = Field(required=False, alias='name')
+    district_id: int
+    region_id: int
+    client_id: int
+    orgid: int
+    is_active: bool = Field(required=False, alias='active', default=True)
+
+    class Meta:
+        name: str = 'markets'
+        schema: str = 'networkninja'
+        strict: bool = True

flowtask/components/NetworkNinja/models/organization.py

@@ -0,0 +1,34 @@
+from typing import List, Optional, Union, Any
+from datetime import datetime
+from datamodel import BaseModel, Field
+from asyncdb import AsyncDB
+from querysource.conf import default_dsn
+from .abstract import AbstractPayload
+
+class Organization(AbstractPayload):
+    orgid: int = Field(required=False)
+    organization_name: str
+    program_slug: str
+    program_id: int
+    status: bool = Field(required=True, default=True)
+
+    class Meta:
+        name: str = 'organizations'
+        schema: str = 'networkninja'
+        strict: bool = True
+
+    async def _sync_object(self, conn):
+        """
+        Sync the organization with the Database.
+        """
+        query = f"""
+        select organization_name, company_slug as program_slug, p.program_id
+        from troc.organizations o
+        inner join auth.programs p on p.program_slug = o.company_slug
+        where orgid = {self.orgid}
+        """
+        result = await conn.fetch_one(query)
+        if result:
+            self.organization_name = result['organization_name']
+            self.program_id = result['program_id']
+            self.program_slug = result['program_slug']

flowtask/components/NetworkNinja/models/photos.py

@@ -0,0 +1,125 @@
+from typing import Dict, List, Optional, Any, Union
+from datetime import datetime
+from urllib.parse import urlparse, ParseResult
+from datamodel import Field
+from .abstract import AbstractPayload
+from .account import Account
+
+
+class PhotoCategory(AbstractPayload):
+    """
+    Photo Category Model.
+
+    Represents a photo category in the system.
+
+    Example:
+        {
+            "category_id": 53,
+            "name": "TEST Category",
+            "client_id": 61,
+            "enabled": false,
+            "orgid": 71,
+            "client_name": "TRO Walmart Assembly"
+        }
+    """
+    category_id: int = Field(primary_key=True, required=True)
+    name: str = Field(alias='category_name')
+    client_id: int = Field(alias="category_client_id")
+    enabled: bool = Field(default=True)
+    orgid: int = Field(alias="category_orgid")
+    client_name: str = Field(alias="category_client_name")
+
+    class Meta:
+        strict = True
+        as_objects = True
+        name = 'photo_categories'
+        schema: str = 'networkninja'
+
+class Document(AbstractPayload):
+    """
+    Document Model.
+
+    Represents a document in the system.
+
+    Example:
+        {
+            "document_id": 1,
+            "document_name": "Test Document",
+            "document_path": "https://www.example.com/test.pdf",
+            "description": "Test Document Description",
+            "created_on": "2025-02-01T00:00:00-06:00",
+            "store_number": "12345",
+            "account_id": 1,
+            "account_name": "Test Account",
+            "question_name": "Test Question",
+            "url_parts": "https://www.example.com/test.pdf"
+        }
+    """
+    document_id: int = Field(primary_key=True, required=True)
+    document_name: str
+    document_path: str
+    description: str
+    created_on: datetime
+    store_number: str
+    account_id: Optional[Account]
+    account_name: str
+    question_name: str
+    url_parts: str
+
+    class Meta:
+        strict = True
+        as_objects = True
+        name = 'documents'
+        schema: str = 'networkninja'
+
+    def __post_init__(self):
+        super().__post_init__()
+        # split the document_path into parts:
+        if self.document_path is not None:
+            self.url_parts = urlparse(self.document_path)
+
+
+class Photo(AbstractPayload):
+    photo_id: int = Field(primary_key=True, required=True)
+    form_id: int
+    formid: Optional[int]
+    event_id: int
+    description: str
+    filename: str
+    created_on: datetime
+    store_number: Optional[int] = Field(alias='store_id')
+    account_id: Account
+    account_name: Optional[str]
+    column_name: Union[str, int]
+    question_name: Optional[str]
+    url_parts: Optional[dict]
+    photo_path: str
+    client_id: int
+    client_name: str
+    categories: Optional[List[PhotoCategory]]
+    is_deleted: bool = Field(default=False)
+    is_archived: bool = Field(default=False)
+
+    class Meta:
+        strict = True
+        as_objects = True
+        name = 'stores_photos'
+        schema: str = 'networkninja'
+
+    def __post_init__(self):
+        super().__post_init__()
+        self.filename = self.description
+        # split the photo_path into parts:
+        if self.photo_path is not None:
+            # Iterate over all parts and convert into a dictionary of strings:
+            parts = urlparse(self.photo_path)
+            self.url_parts = {
+                'scheme': parts.scheme,
+                'netloc': parts.netloc,
+                'path': parts.path,
+                'params': parts.params,
+                'query': parts.query,
+                'fragment': parts.fragment,
+            }
+        if self.account_id:
+            self.account_id.account_name = self.account_name