ApiLogicServer 14.3.14__py3-none-any.whl → 14.3.25__py3-none-any.whl

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/integration/kafka/kafka_producer.py

@@ -0,0 +1,120 @@
+"""
+
+Version 2.1
+
+Invoked at server start (api_logic_server_run.py -> config/setup.py)
+
+Connect to Kafka, if KAFKA_CONNECT specified in Config.py
+
+You do not normally need to alter this file
+
+"""
+from config.config import Args
+from confluent_kafka import Producer
+import socket
+import logging
+from logic_bank.exec_row_logic.logic_row import LogicRow
+from integration.system.RowDictMapper import RowDictMapper
+from flask import jsonify
+from confluent_kafka import Producer, KafkaException
+import api.system.api_utils as api_utils
+
+producer = None
+""" connected producer (or null if Kafka not enabled in Config.py) """
+
+conf = None
+""" filled from config (KAFKA_CONNECT) """
+
+logger = logging.getLogger('integration.n8n')
+logger.debug("kafka_connect imported")
+
+def kafka_producer():
+    """
+    Called by api_logic_server_run>server_setup to listen on kafka using confluent_kafka
+
+    Enabled by config.KAFKA_CONNECT (dict, of bootstrap.servers, client.id)
+
+    Args:
+        none
+    """
+
+    global producer, conf
+    if Args.instance.kafka_producer:
+        conf = Args.instance.kafka_producer
+        if "client.id" not in conf:
+            conf["client.id"] = socket.gethostname()
+        # conf = {'bootstrap.servers': 'localhost:9092', 'client.id': socket.gethostname()}
+        producer = Producer(conf)
+        logger.debug(f'\nKafka producer connected')
+
+from sqlalchemy.inspection import inspect
+
+def get_primary_key(logic_row: LogicRow):
+    """ Return primary key for row, if it exists
+
+    Args:
+        logic_row (LogicRow): The SQLAlchemy row object
+
+    Returns:
+        dict: A dictionary with primary key column names and their values
+    """
+    primary_key_columns = inspect(logic_row.row).mapper.primary_key
+    primary_key = {column.name: getattr(logic_row.row, column.name) for column in primary_key_columns}
+    return primary_key
+
+
+def send_kafka_message(kafka_topic: str, kafka_key: str = None, msg: str="", json_root_name: str = "", 
+                       logic_row: LogicRow = None, row_dict_mapper: RowDictMapper = None, payload: dict = None):
+    """ Send Kafka message regarding logic_row, mapped by row_dict_mapper
+
+    * Typically called from declare_logic event
+
+    Args:
+        logic_row (LogicRow): root data to be sent
+        row_dict_mapper (RowDictMapper): typically subclass of RowDictMapper, transforms row to dict
+        kafka_topic (str): the kafka topic
+        kafka_key (str): the kafka key
+        msg (str, optional): string to log
+        json_root_name (str, optional): json name for json payload root; default is logic_row.name
+    """
+
+
+    if isinstance(payload, dict):
+        row_obj_dict = payload
+    elif row_dict_mapper is not None:
+        row_obj_dict = row_dict_mapper().row_to_dict(row = logic_row.row)
+    elif row_dict_mapper is None:
+        row_obj_dict = RowDictMapper(model_class=logic_row.row.__class__).row_to_dict(row = logic_row.row)
+    else:
+        raise ValueError(f"send_kafka_message payload type not supported: {type(payload)}") 
+
+    root_name = json_root_name
+    if root_name == "":
+        if logic_row is None:
+            root_name = 'Payload'
+        else:
+            root_name = logic_row.name
+
+    if kafka_key is None:
+        kafka_key = get_primary_key(logic_row) 
+
+    log_msg = msg if msg != "" else f"Sending {root_name} to Kafka topic '{kafka_topic}'" 
+
+    json_string = jsonify({f'{root_name}': row_obj_dict}).data.decode('utf-8')
+    log_msg = log_msg
+    if producer:  # enabled in config/config.py?
+        try:
+            producer.produce(value=json_string, topic="order_shipping", key=kafka_key)
+            if logic_row:
+                logic_row.log(log_msg)
+        except KafkaException as ke:
+            logger.error("kafka_producer#send_kafka_message error: {ke}") 
+    else:
+        log_msg += " [Note: **Kafka not enabled** ]"
+    if logic_row is not None:
+        logic_row.log(f'{log_msg}')
+    logger.debug(f'\n\n{log_msg}\n{json_string}')
+
+
+def send_row_to_kafka(row: object, old_row: object, logic_row: LogicRow, with_args: dict):
+    send_kafka_message(logic_row=logic_row, kafka_topic=with_args["topic"])

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/integration/kafka/kafka_readme.md

@@ -0,0 +1,3 @@
+Alter kafka.consumer as required to define topic handlers.
+
+To see a Sample Integration, [click here](https://apilogicserver.github.io/Docs/Sample-Integration/).

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/integration/n8n/N8N_WebHook_from_ApiLogicServer.json

@@ -0,0 +1,394 @@
+{
+  "name": "WebHook from ApiLogicServer",
+  "nodes": [
+    {
+      "parameters": {
+        "respondWith": "allIncomingItems",
+        "options": {
+          "responseCode": 200
+        }
+      },
+      "type": "n8n-nodes-base.respondToWebhook",
+      "typeVersion": 1.1,
+      "position": [
+        920,
+        0
+      ],
+      "id": "37d950b1-e8bb-4c43-8d5c-2c4ef238e632",
+      "name": "Respond to Webhook"
+    },
+    {
+      "parameters": {
+        "content": "ApiLogicServer calls the Webhook using a logic rule on Insert - send different emails using SendGrid based on type"
+      },
+      "type": "n8n-nodes-base.stickyNote",
+      "typeVersion": 1,
+      "position": [
+        -420,
+        -20
+      ],
+      "id": "2617783e-ae85-4e56-816b-eb871146ce2c",
+      "name": "Sticky Note"
+    },
+    {
+      "parameters": {
+        "rules": {
+          "values": [
+            {
+              "conditions": {
+                "options": {
+                  "caseSensitive": true,
+                  "leftValue": "",
+                  "typeValidation": "strict",
+                  "version": 2
+                },
+                "conditions": [
+                  {
+                    "leftValue": "={{ $json.headers.wh_entity }}",
+                    "rightValue": "Employee",
+                    "operator": {
+                      "type": "string",
+                      "operation": "equals"
+                    }
+                  }
+                ],
+                "combinator": "and"
+              },
+              "renameOutput": true,
+              "outputKey": "Employee"
+            },
+            {
+              "conditions": {
+                "options": {
+                  "caseSensitive": true,
+                  "leftValue": "",
+                  "typeValidation": "strict",
+                  "version": 2
+                },
+                "conditions": [
+                  {
+                    "id": "32eaf447-bd76-48b3-b684-db8fff587e75",
+                    "leftValue": "={{ $json.headers.wh_entity }}",
+                    "rightValue": "Customer",
+                    "operator": {
+                      "type": "string",
+                      "operation": "equals",
+                      "name": "filter.operator.equals"
+                    }
+                  }
+                ],
+                "combinator": "and"
+              },
+              "renameOutput": true,
+              "outputKey": "Customer"
+            },
+            {
+              "conditions": {
+                "options": {
+                  "caseSensitive": true,
+                  "leftValue": "",
+                  "typeValidation": "strict",
+                  "version": 2
+                },
+                "conditions": [
+                  {
+                    "id": "b3cae18a-ee33-413d-b342-fd39bc6bcb0d",
+                    "leftValue": "={{ $json.headers.wh_entity }}",
+                    "rightValue": "Order",
+                    "operator": {
+                      "type": "string",
+                      "operation": "equals",
+                      "name": "filter.operator.equals"
+                    }
+                  }
+                ],
+                "combinator": "and"
+              },
+              "renameOutput": true,
+              "outputKey": "Order"
+            }
+          ]
+        },
+        "options": {}
+      },
+      "type": "n8n-nodes-base.switch",
+      "typeVersion": 3.2,
+      "position": [
+        260,
+        0
+      ],
+      "id": "450d7beb-cd8c-48b3-86d5-33d919863d80",
+      "name": "Switch"
+    },
+    {
+      "parameters": {
+        "resource": "mail",
+        "fromEmail": "info@genai-logic.com",
+        "fromName": "Tyler Band",
+        "toEmail": "={{ $json.data.email }}",
+        "subject": "Test",
+        "contentValue": "=Welcome EMAIL to {{ $json.data.Email }} for Entity {{ $json.headers.wh_entity }}\n{{ $json.data.LastName }} {{ $json.data.FirstName }}\n{{ $json.data.Title }}\n{{ $json.data.Address }}\n{{ $json.data.City }} {{ $json.data.PostalCode }}",
+        "additionalFields": {}
+      },
+      "type": "n8n-nodes-base.sendGrid",
+      "typeVersion": 1,
+      "position": [
+        720,
+        -180
+      ],
+      "id": "ccc1e5ae-523c-4687-9bee-08bbf1dd12cd",
+      "name": "SendGrid Employee",
+      "credentials": {
+        "sendGridApi": {
+          "id": "Jo176FB10nmOOVHa",
+          "name": "SendGrid account"
+        }
+      }
+    },
+    {
+      "parameters": {
+        "resource": "mail",
+        "fromEmail": "info@genai-logic.com",
+        "fromName": "Tyler Band",
+        "toEmail": "={{ $json.data.email }}",
+        "subject": "Test",
+        "contentValue": "=EMAIL for Entity {{ $json.headers.wh_entity }} from ApiLogicServer\nName: {{ $json.data.CompanyName }}\nAddress: \n{{ $json.data.Address }}\n{{ $json.data.City }} {{ $json.data.PostalCode }} {{ $json.data.Country }}\nPhone: {{ $json.data.Phone }}\nCustomer ID: {{ $json.data.Id }}",
+        "additionalFields": {}
+      },
+      "type": "n8n-nodes-base.sendGrid",
+      "typeVersion": 1,
+      "position": [
+        580,
+        0
+      ],
+      "id": "8ee21216-861d-4161-900f-476fd4f6146d",
+      "name": "SendGrid Customer",
+      "credentials": {
+        "sendGridApi": {
+          "id": "Jo176FB10nmOOVHa",
+          "name": "SendGrid account"
+        }
+      }
+    },
+    {
+      "parameters": {
+        "resource": "mail",
+        "fromEmail": "info@genai-logic.com",
+        "fromName": "Tyler Band",
+        "toEmail": "={{ $json.data.email }}",
+        "subject": "Test",
+        "contentValue": "=Test EMAIL for Entity {{ $json.headers.wh_entity }} from ApiLogicServer\nOrder Date: {{ $json.data[\"Order Date\"] }}\nOrder Id {{ $json.data[\"Order Id\"] }} Total ${{ $json.data[\"Order Total\"] }}\nName on Order: {{ $json.data[\"Customer Name\"] }}",
+        "additionalFields": {}
+      },
+      "type": "n8n-nodes-base.sendGrid",
+      "typeVersion": 1,
+      "position": [
+        580,
+        220
+      ],
+      "id": "017c78ad-360c-4a92-b668-261278d32398",
+      "name": "SendGrid Order",
+      "credentials": {
+        "sendGridApi": {
+          "id": "Jo176FB10nmOOVHa",
+          "name": "SendGrid account"
+        }
+      }
+    },
+    {
+      "parameters": {
+        "conditions": {
+          "options": {
+            "caseSensitive": true,
+            "leftValue": "",
+            "typeValidation": "strict",
+            "version": 2
+          },
+          "conditions": [
+            {
+              "id": "7c3eaac8-c469-4f96-923b-4f9c77946453",
+              "leftValue": "={{ $json.headers.wh_state }}",
+              "rightValue": "ins",
+              "operator": {
+                "type": "string",
+                "operation": "equals",
+                "name": "filter.operator.equals"
+              }
+            }
+          ],
+          "combinator": "and"
+        },
+        "options": {}
+      },
+      "type": "n8n-nodes-base.if",
+      "typeVersion": 2.2,
+      "position": [
+        460,
+        -140
+      ],
+      "id": "dca6455f-a439-443c-8391-d8a85f664821",
+      "name": "If Inserted"
+    },
+    {
+      "parameters": {
+        "jsCode": "// Loop over input items and add a new field called 'myNewField' to the JSON of each one\nfor (const item of $input.all()) {\n\n  item.json.data = JSON.parse(item.json.body)\n  item.json.data.email = \"tyler.band@aimicroservice.org\";\n}\n\nreturn $input.all();"
+      },
+      "type": "n8n-nodes-base.code",
+      "typeVersion": 2,
+      "position": [
+        80,
+        0
+      ],
+      "id": "13a89d57-4248-4f1d-8bfc-38381ef62f46",
+      "name": "Convert Body to JSON"
+    },
+    {
+      "parameters": {
+        "httpMethod": "POST",
+        "path": "002fa0e8-f7aa-4e04-b4e3-e81aa29c6e69",
+        "authentication": "basicAuth",
+        "responseMode": "responseNode",
+        "options": {}
+      },
+      "type": "n8n-nodes-base.webhook",
+      "typeVersion": 2,
+      "position": [
+        -140,
+        0
+      ],
+      "id": "019b4be0-7043-4ca6-84e1-e6364d482bde",
+      "name": "Webhook from ApiLogicServer",
+      "webhookId": "002fa0e8-f7aa-4e04-b4e3-e81aa29c6e69",
+      "credentials": {
+        "httpBasicAuth": {
+          "id": "h9GtMBSAuNe0F2wW",
+          "name": "Basic Auth credential"
+        }
+      }
+    }
+  ],
+  "pinData": {},
+  "connections": {
+    "Respond to Webhook": {
+      "main": [
+        []
+      ]
+    },
+    "Switch": {
+      "main": [
+        [
+          {
+            "node": "If Inserted",
+            "type": "main",
+            "index": 0
+          }
+        ],
+        [
+          {
+            "node": "SendGrid Customer",
+            "type": "main",
+            "index": 0
+          }
+        ],
+        [
+          {
+            "node": "SendGrid Order",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "SendGrid Employee": {
+      "main": [
+        [
+          {
+            "node": "Respond to Webhook",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "SendGrid Customer": {
+      "main": [
+        [
+          {
+            "node": "Respond to Webhook",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "SendGrid Order": {
+      "main": [
+        [
+          {
+            "node": "Respond to Webhook",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "If Inserted": {
+      "main": [
+        [
+          {
+            "node": "SendGrid Employee",
+            "type": "main",
+            "index": 0
+          }
+        ],
+        [
+          {
+            "node": "Respond to Webhook",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "Convert Body to JSON": {
+      "main": [
+        [
+          {
+            "node": "Switch",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "Webhook from ApiLogicServer": {
+      "main": [
+        [
+          {
+            "node": "Convert Body to JSON",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    }
+  },
+  "active": true,
+  "settings": {
+    "executionOrder": "v1",
+    "callerPolicy": "workflowsFromSameOwner"
+  },
+  "versionId": "2c9c2ee8-4d7b-4d4c-87c8-bc5229a460af",
+  "meta": {
+    "instanceId": "0b4446ffa01d8d457453f727df1e129603cc16296fab60e155d7bf4ea4ba2a50"
+  },
+  "id": "2jaWeJIoLn8K7IRs",
+  "tags": [
+    {
+      "createdAt": "2024-12-17T19:42:11.359Z",
+      "updatedAt": "2024-12-17T19:42:11.359Z",
+      "id": "lQ0qDvs9q1zBv9Vn",
+      "name": "webhook sendgrid"
+    }
+  ]
+}

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/integration/n8n/n8n_producer.py

@@ -0,0 +1,125 @@
+"""
+
+Version 1.1
+
+Invoked at server start (api_logic_server_run.py -> config/setup.py)
+
+Connect to n8n, if N8N_CONNECT specified in Config.py
+
+You do not normally need to alter this file
+
+"""
+import traceback
+import requests
+from config.config import Args
+import json
+import logging
+from logic_bank.exec_row_logic.logic_row import LogicRow
+from integration.system.RowDictMapper import RowDictMapper
+from flask import jsonify
+import api.system.api_utils as api_utils
+from config.config import Args
+
+producer = None
+""" connected producer (or null if N8N not enabled in Config.py) """
+
+conf = None
+""" filled from config (N8N_CONNECT) """
+
+logger = logging.getLogger('integration.n8n')
+logger.debug("n8n_connect imported")
+
+def n8n_producer():
+    """
+    Called by api_logic_server_run>server_setup to listen on kafka using confluent_kafka
+
+    Enabled by config.KAFKA_CONNECT (dict, of bootstrap.servers, client.id)
+
+    Args:
+        none
+    """
+
+    global conf
+    if Args.instance.n8n_producer:
+        conf = Args.instance.n8n_producer
+        producer = conf
+        # good place to do defaults, get api keys, etc
+        logger.debug('N8N producer initialized')
+
+
+def send_n8n_message(http_method: str = "POST", ins_upd_dlt: str = "ins", msg: str = "",
+        wh_entity: str = "unknown",
+        logic_row: LogicRow = None, 
+        row_dict_mapper: RowDictMapper = None, 
+        payload: dict = None) -> any:
+    """ Send N8N webhook message regarding [logic_row, mapped by row_dict_mapper or by  payload]
+
+    * Typically called from declare_logic event
+
+    Args:
+        http_method (str):  [GET, POST,PUT,PATCH, DELETE] default is POST
+        ins_upd_dlt (str): "ins, upd, dlt" (logic row state) logic_row.ins_upd_dlt or manual (wh_state pass in header)
+        logic_row (LogicRow):(Optional) logic row contains row, old_row, ins_upd_dlt and more
+        msg: this is used for debugging
+        row_dict_mapper (RowDictMapper): (Optional) typically subclass of RowDictMapper, transforms row to dict
+        payload (str): (Optional) JSON data to be sent as string (json.dumps(row.to_dict()))    
+        wh_entity (str): the webhook entity name pass in header
+    """
+
+    global conf
+    if conf is None:
+        conf = Args.instance.n8n_producer #FIXME not sure why this fails - conf is None
+        #return "N8N not enabled in Config.py"
+        
+    if row_dict_mapper is None and payload is None and logic_row is None:
+        return "send_n8n_message: payload, logic_row, row_dict_mapper are all None - must provide one"
+    row_obj_dict = None
+    if isinstance(payload, dict):
+        row_obj_dict = json.dumps(payload)
+    elif logic_row is not None:
+        row_obj_dict = json.dumps(logic_row.row.to_dict())
+    elif row_dict_mapper is not None:
+        row_obj_dict = row_dict_mapper().row_to_dict(row = logic_row.row)
+    elif row_dict_mapper is None:
+        row_obj_dict = RowDictMapper(model_class=logic_row.row.__class__).row_to_dict(row = logic_row.row)
+    elif payload is None and http_method.lower() == "post":
+        raise ValueError(f"send_n8n_message payload type not supported: {type(payload)}") 
+
+    wh_state =  ins_upd_dlt if logic_row is None else logic_row.ins_upd_dlt
+    wh_entity = logic_row.row.__class__.__name__ if logic_row else wh_entity
+    try:
+        if row_obj_dict is not None:
+            json_payload = jsonify(f'{row_obj_dict}').data.decode('utf-8')
+            msg = f"Webhook send_n8n_message: http_method: {http_method} wh_state: {wh_state} wh_entity: {wh_entity}"
+            logger.debug(f'\n\n{msg}\n{json_payload}')
+        
+        status = {"status_code": 500}
+
+        if conf is None:
+            logger.debug(f"n8n_producer: not configured in config/Config.py")
+        else:
+            headers = {
+                "Authorization": conf['authorization'],
+                "Content-Type": "application/json",
+                "wh_state": wh_state,
+                "wh_entity": wh_entity
+            }
+            endpoint = f'{conf["n8n_url"]}'
+            status = {"status_code": 500}
+            if http_method in {"post", "POST"}:
+                #Only passing payload in this example
+                status = requests.post(endpoint, json=row_obj_dict, headers=headers)
+            elif http_method.lower() == "get":
+                status = requests.get(endpoint, headers=headers)
+            elif http_method.lower() in {"put", "patch", "delete"}:
+                logger.error(f"n8n_producer: http_method: {http_method} not implemented")
+
+            if status and status.status_code != 200:
+                logger.error(f"n8n_producer: status_code: {status.status_code}")
+        return status
+    except Exception as e:
+        logger.error(f"\nn8n_producer fails with: {e}")
+        long_message = traceback.format_exc()
+        logger.error(long_message)
+        return long_message
+

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/integration/n8n/n8n_readme.md

@@ -0,0 +1,48 @@
+# Workflow Integration using n8n.io
+The n8n.io has over 400 integrations predefined. There are over 1,000 prebuilt templates including AI chatbot creation that can be used to integrate with ApiLogicServer. In the integration/n8n folder, the N8N_WebHook_from_ApiLogicServer,json which can be imported into your n8n.io running project and use the Northwind sample to test. [Note - the SendGrid APIKey is not provided] 
+
+## Download and install n8n.io locally
+The cloud version is available - but for development we will use the local install
+```
+https://docs.n8n.io/hosting/installation/npm/
+```
+
+## Create a new workflow and create webhook instance
+Use the POST method and add basic authentication (user: admin, password: p) 
+
+## Populate config.py values
+Copy the path UUID (wh_path)
+```
+    # N8N Webhook Args (for testing)
+	# see https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.webhook/?utm_source=n8n_app&utm_medium=node_settings_modal-credential_link&utm_campaign=n8n-nodes-base.webhook#path
+
+    wh_scheme = "http"
+    wh_server = "localhost" # or cloud.n8n.io...
+    wh_port = 5678
+    wh_endpoint = "webhook-test"
+    wh_path = "002fa0e8-f7aa-4e04-b4e3-e81aa29c6e69"
+    token = "...."
+    # Basic Auth is (user: admin, password: p) base64 encoded
+
+    N8N_PRODUCER = {"authorization": "Basic {token}}", "n8n_url": f'"{wh_scheme}://{wh_server}:{wh_port}/{wh_endpoint}/{wh_path}"'} 
+    # OR enter the full URL
+    N8N_PRODUCER = {"authorization": "Basic {token}","n8n_url":"http://localhost:5678/webhook-test/002fa0e8-f7aa-4e04-b4e3-e81aa29c6e69"}  
+  	N8N_PRODUCER = None # comment out to enable N8N producer
+```
+
+## Start the n8n.io workflow webhook to listen
+In the logic/logic_discovery - see workflow_integration.py
+After Flush (all rules have fired and database has been updated)
+call the webhook interface - once you have the body - you can extract values and pass to other nodes
+in the workflow (e.g. SendGrid email)
+```
+    def call_n8n_workflow(row: models.Customer, old_row: models.Customer, logic_row: LogicRow):
+        """
+        Webhook Workflow:  When Customer is inserted/updated = post to external system
+        """
+        if logic_row.is_inserted():
+            status = send_n8n_message(logic_row=logic_row)
+            logic_row.debug(status)
+
+    Rule.after_flush_row_event(on_class=models.Customer, calling=call_n8n_workflow)
+```