ms-salesforce-api 3.1.1__tar.gz → 3.3.0__tar.gz

{ms_salesforce_api-3.1.1 → ms_salesforce_api-3.3.0}/PKG-INFO

@@ -1,7 +1,8 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: ms-salesforce-api
-Version: 3.1.1
+Version: 3.3.0
 Summary: Python library used to extract data from Salesforce API and migrate it to Bigquery and Postgres.
+License-File: LICENSE
 Author: Making Science
 Requires-Python: >=3.8.1,<4.0.0
 Classifier: Programming Language :: Python :: 3
@@ -10,6 +11,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: flake8 (>=6.0.0,<7.0.0)
 Requires-Dist: gc-google-services-api (>=1.2.7,<2.0.0)
 Requires-Dist: isort (>=5.12.0,<6.0.0)

ms_salesforce_api-3.3.0/ms_salesforce_api/salesforce/api/addtech_onboarding/__init__.py

@@ -0,0 +1,55 @@
+import logging
+
+from ms_salesforce_api.salesforce.api.addtech_onboarding.constants import (
+    DEFAULT_ADDTECH_ONBOARDING_QUERY,
+)
+from ms_salesforce_api.salesforce.api.addtech_onboarding.dto.AddTechOnboarding import (  # noqa: E501
+    AddTechOnboardingDTO,
+)
+from ms_salesforce_api.salesforce.SalesforceQueryExecutor import (
+    SalesforceQueryExecutor,
+)
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s - %(levelname)s - %(message)s",
+)
+
+
+class AddTechOboarding(SalesforceQueryExecutor):
+    def get_batches(self, lst, n):
+        """Yield successive n-sized chunks from lst."""
+        for i in range(0, len(lst), n):
+            yield lst[i : i + n]  # noqa: E203
+
+    def get_all(
+        self,
+        query: str = DEFAULT_ADDTECH_ONBOARDING_QUERY,
+        format: str = "json",
+    ):
+        data = self.fetch_data(query)
+        if data is None:
+            logging.error(
+                "[ERROR - SalesforceAPI]: No addtech onboarding data return from Salesforce API"  # noqa: E501
+            )
+            return []
+
+        addtech_onboarding = [
+            AddTechOnboardingDTO.from_salesforce_record(record)
+            for record in data
+        ]
+        addtech_onboarding_list = list(addtech_onboarding)
+
+        if format == "json":
+            addtech_onboarding_list = [
+                addtech.to_dict() for addtech in addtech_onboarding_list
+            ]
+
+        return addtech_onboarding_list
+        try:
+            pass
+        except Exception as e:
+            logging.error(
+                f"[ERROR - get_all]: Failed to get all addtech_onboarding: {e}"
+            )
+            return []

ms_salesforce_api-3.3.0/ms_salesforce_api/salesforce/api/addtech_onboarding/constants.py

@@ -0,0 +1,25 @@
+DEFAULT_ADDTECH_ONBOARDING_QUERY = """
+SELECT
+  Id,
+  Account_Id__c,
+  Advertiser_Id__c,
+  Name,
+  FRM_ProductName__c,
+  FRM_Name__c,
+  Opportunity__c,
+  Opportunity__r.AccountId,
+  Opportunity__r.FRM_ProjectCode__c,
+  Opportunity__r.FRM_ProjectName__c,
+  Opportunity_Product__r.FRM_ProductName__c,
+  Opportunity_Product__r.ProductCode,
+  Opportunity_Product__r.CurrencyIsoCode,
+  Opportunity_Product__r.Quantity,
+  Opportunity_Product__r.FRM_ProfitCenterName__c,
+  Partner_Id__c,
+  Status__c,
+  TXT_EntityID__c,
+  TXT_GMPOrgID__c,
+  TXT_ManagerId__c,
+  TXT_PlatformAccName__c
+FROM Yangtse__c
+"""

ms_salesforce_api-3.3.0/ms_salesforce_api/salesforce/api/addtech_onboarding/dto/AddTechOnboarding.py

@@ -0,0 +1,161 @@
+from ms_salesforce_api.salesforce.helpers.string import normalize_value
+
+
+class AddTechOnboardingDTO(object):
+    def __init__(
+        self,
+        id,
+        account_id,
+        advertiser_id,
+        name,
+        opportunity,
+        opportunity_account_id,
+        opportunity_project_code,
+        opportunity_project_name,
+        opportunity_product_name,
+        opportunity_product_code,
+        opportunity_product_currency_iso_code,
+        opportunity__product_quantity,
+        opportunity__product_profit_center_name,
+        partner_id,
+        status,
+        txt_entity_id,
+        txt_gmp_org_id,
+        txt_manager_id,
+        txt_platform_acc_name,
+        adtech_propduct_name,
+        yangtse_name,
+    ):
+        self.id = id
+        self.account_id = account_id
+        self.advertiser_id = advertiser_id
+        self.name = name
+        self.opportunity = opportunity
+        self.opportunity_account_id = opportunity_account_id
+        self.opportunity_project_code = opportunity_project_code
+        self.opportunity_project_name = opportunity_project_name
+        self.opportunity_product_name = opportunity_product_name
+        self.opportunity_product_code = opportunity_product_code
+        self.opportunity_product_currency_iso_code = (
+            opportunity_product_currency_iso_code
+        )
+        self.opportunity__product_quantity = opportunity__product_quantity
+        self.opportunity__product_profit_center_name = (
+            opportunity__product_profit_center_name
+        )
+        self.partner_id = partner_id
+        self.status = status
+        self.txt_entity_id = txt_entity_id
+        self.txt_gmp_org_id = txt_gmp_org_id
+        self.txt_manager_id = txt_manager_id
+        self.txt_platform_acc_name = txt_platform_acc_name
+        self.adtech_propduct_name = adtech_propduct_name
+        self.yangtse_name = yangtse_name
+
+    @staticmethod
+    def from_salesforce_record(record: dict):
+
+        def _get_opportunity_account_id():
+            try:
+                return record["Opportunity__r"]["AccountId"]
+            except (KeyError, TypeError):
+                return None
+
+        def _get_opportunity_project_code():
+            try:
+                return record["Opportunity__r"]["FRM_ProjectCode__c"]
+            except (KeyError, TypeError):
+                return None
+
+        def _get_opportunity_project_name():
+            try:
+                return normalize_value(
+                    record["Opportunity__r"]["FRM_ProjectName__c"]
+                )
+            except (KeyError, TypeError):
+                return None
+
+        def _get_opportunity_product_name():
+            try:
+                return normalize_value(
+                    record["Opportunity_Product__r"]["FRM_ProductName__c"]
+                )
+            except (KeyError, TypeError):
+                return None
+
+        def _get_opportunity_product_code():
+            try:
+                return record["Opportunity_Product__r"]["ProductCode"]
+            except (KeyError, TypeError):
+                return None
+
+        def _get_opportunity_product_currency_iso_code():
+            try:
+                return record["Opportunity_Product__r"]["CurrencyIsoCode"]
+            except (KeyError, TypeError):
+                return None
+
+        def _get_opportunity_product_quantity():
+            try:
+                return record["Opportunity_Product__r"]["Quantity"]
+            except (KeyError, TypeError):
+                return None
+
+        def _get_opportunity_product_profit_center_name():
+            try:
+                return record["Opportunity_Product__r"][
+                    "FRM_ProfitCenterName__c"
+                ]
+            except (KeyError, TypeError):
+                return None
+
+        return AddTechOnboardingDTO(
+            id=record["Id"],
+            account_id=record["Account_Id__c"],
+            advertiser_id=record["Advertiser_Id__c"],
+            name=normalize_value(record["Name"]),
+            opportunity=record["Opportunity__c"],
+            adtech_propduct_name=record["FRM_ProductName__c"],
+            yangtse_name=record["FRM_Name__c"],
+            opportunity_account_id=_get_opportunity_account_id(),
+            opportunity_project_code=_get_opportunity_project_code(),
+            opportunity_project_name=_get_opportunity_project_name(),
+            opportunity_product_name=_get_opportunity_product_name(),
+            opportunity_product_code=_get_opportunity_product_code(),
+            opportunity_product_currency_iso_code=_get_opportunity_product_currency_iso_code(),  # noqa: E501
+            opportunity__product_quantity=_get_opportunity_product_quantity(),
+            opportunity__product_profit_center_name=_get_opportunity_product_profit_center_name(),  # noqa: E501
+            partner_id=record["Partner_Id__c"],
+            status=normalize_value(record["Status__c"]),
+            txt_entity_id=record["TXT_EntityID__c"],
+            txt_gmp_org_id=record["TXT_GMPOrgID__c"],
+            txt_manager_id=record["TXT_ManagerId__c"],
+            txt_platform_acc_name=normalize_value(
+                record["TXT_PlatformAccName__c"]
+            ),
+        )
+
+    def to_dict(self):
+        return {
+            "id": self.id,
+            "account_id": self.account_id,
+            "advertiser_id": self.advertiser_id,
+            "name": self.name,
+            "opportunity": self.opportunity,
+            "opportunity_account_id": self.opportunity_account_id,
+            "opportunity_project_code": self.opportunity_project_code,
+            "opportunity_project_name": self.opportunity_project_name,
+            "opportunity_product_name": self.opportunity_product_name,
+            "opportunity_product_code": self.opportunity_product_code,
+            "opportunity_product_currency_iso_code": self.opportunity_product_currency_iso_code,  # noqa: E501
+            "opportunity__product_quantity": self.opportunity__product_quantity,  # noqa: E501
+            "opportunity__product_profit_center_name": self.opportunity__product_profit_center_name,  # noqa: E501
+            "partner_id": self.partner_id,
+            "status": self.status,
+            "txt_entity_id": self.txt_entity_id,
+            "txt_gmp_org_id": self.txt_gmp_org_id,
+            "txt_manager_id": self.txt_manager_id,
+            "txt_platform_acc_name": self.txt_platform_acc_name,
+            "adtech_propduct_name": self.adtech_propduct_name,
+            "yangtse_name": self.yangtse_name,
+        }

ms_salesforce_api-3.3.0/ms_salesforce_api/salesforce/api/addtech_onboarding/export_data/Bigquery.py

@@ -0,0 +1,85 @@
+import logging
+
+from gc_google_services_api.bigquery import BigQueryManager
+
+logging.basicConfig(
+    level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s"
+)
+
+
+class BigQueryExporter:
+    """
+    Initializes the Bigquery exporter with the given project ID and dataset ID.
+
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        dataset_id (str): The ID of the BigQuery dataset.
+    """
+
+    def __init__(self, project_id, dataset_id):
+        self.project_id = project_id
+        self.dataset_id = dataset_id
+        self.client = BigQueryManager(
+            project_id=project_id,
+            dataset_id=dataset_id,
+        )
+        self.batch_size = 200
+        self.schemas = {
+            "addtech_onboarding": {
+                "id": "STRING",
+                "account_id": "STRING",
+                "advertiser_id": "STRING",
+                "name": "STRING",
+                "opportunity": "STRING",
+                "opportunity_account_id": "STRING",
+                "opportunity_project_code": "STRING",
+                "opportunity_project_name": "STRING",
+                "opportunity_product_name": "STRING",
+                "opportunity_product_code": "STRING",
+                "opportunity_product_currency_iso_code": "STRING",
+                "opportunity__product_quantity": "STRING",
+                "opportunity__product_profit_center_name": "STRING",
+                "partner_id": "STRING",
+                "status": "STRING",
+                "txt_entity_id": "STRING",
+                "txt_gmp_org_id": "STRING",
+                "txt_manager_id": "STRING",
+                "txt_platform_acc_name": "STRING",
+                "adtech_propduct_name": "STRING",
+                "yangtse_name": "STRING",
+            },
+        }
+
+        for table_name, table_schema in self.schemas.items():
+            self.client.create_table_if_not_exists(table_name, table_schema)
+
+    def _execute_query(self, query, log_id, default_error_value=None):
+        custom_error_value = f"{log_id}_custom_error"
+
+        result = self.client.execute_query(
+            query,
+            custom_error_value,
+        )
+
+        if result == custom_error_value:
+            logging.error(
+                f"[ERROR - _execute_query]: Error executing query for {log_id} in BigQuery."  # noqa: E501
+            )
+            result = default_error_value
+
+        return result
+
+    def export_data(self, profit_centers):
+        self.client.load_massive_data(
+            rows_to_insert=profit_centers,
+            table_name="addtech_onboarding",
+        )
+
+    def delete_all_rows(self):
+        table_names = self.schemas.keys()
+        for table_name in table_names:
+            delete_query_table = f"DELETE FROM `{self.project_id}.{self.dataset_id}.{table_name}` WHERE true"  # noqa: E501
+            self._execute_query(
+                query=delete_query_table,
+                log_id=f"delete_table_{table_name}",
+            )

{ms_salesforce_api-3.1.1 → ms_salesforce_api-3.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ms-salesforce-api"
-version = "3.1.1"
+version = "3.3.0"
 description = "Python library used to extract data from Salesforce API and migrate it to Bigquery and Postgres."
 authors = ["Making Science"]
 readme = "README.md"