ApiLogicServer 15.0.10__py3-none-any.whl → 15.0.14__py3-none-any.whl

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/docs/logic/constraint_tests_rules.response

@@ -1,25 +0,0 @@
-{
-    "rules": [
-        {
-            "name": "Customer Name Constraint",
-            "description": "Ensures customer names cannot be 'x'.",
-            "use_case": "Validation to prevent invalid customer names.",
-            "entity": "Customer",
-            "code": "Rule.constraint(validate=Customer,\n                as_condition=lambda row: row.name != 'x',\n                error_msg=\"Customer names cannot be 'x'.\")"
-        },
-        {
-            "name": "Product Name Constraint",
-            "description": "Ensures product names cannot be 'xx'.",
-            "use_case": "Validation to prevent invalid product names.",
-            "entity": "Product",
-            "code": "Rule.constraint(validate=Product,\n                as_condition=lambda row: row.name != 'xx',\n                error_msg=\"Product names cannot be 'xx'.\")"
-        },
-        {
-            "name": "Product Carbon Neutral",
-            "description": "Ensures products with names containing 'green' are carbon neutral.",
-            "use_case": "Validation for environmentally friendly products.",
-            "entity": "Product",
-            "code": "Rule.constraint(validate=Product,\n                as_condition=lambda row: 'green' not in row.name.lower() or row.carbon_neutral is True,\n                error_msg=\"Products containing 'green' in their name must be carbon neutral.\")"
-        }
-    ]
-}

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/docs/logic/readme.md

@@ -1,15 +0,0 @@
-### Add Natural Languate Logic to Your Project
-
-You can add Natural Language logic files to this directory, e.g., `check_credit.prompt`.
-
-Then, use GenAI to create executable logic in your `logic/logic_discovery` directory, e.g.,
-
-```bash
-als genai-logic
-```
-
-Notes:
-
-1. Ensure derived attributes exist in the data model (see [Database Design Changes](https://apilogicserver.github.io/Docs/Database-Changes/))
-2. Be sure to initialize such attributes in your database
-3. For more information, [click here](https://apilogicserver.github.io/Docs/WebGenAI-CLI/#add-logic-to-existing-projects)

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/docs/logic/request.json

@@ -1,18 +0,0 @@
-[
-    {
-        "role": "user",
-        "content": "You are a data modelling expert and python software architect who expands on user input ideas. You create data models with at least 4 tables"
-    },
-    {
-        "role": "system",
-        "content": "[{\"classname\": \"Customer\", \"code\": \"class Customer(Base):\\n    \\\"\\\"\\\"description: Represents customers in the system.\\\"\\\"\\\"\\n    __tablename__ = 'customer'\\n\\n    id = Column(Integer, primary_key=True, autoincrement=True)\\n    name = Column(String)\\n    email = Column(String)\", \"sqlite_create\": \"CREATE TABLE customer (\\n    id INTEGER PRIMARY KEY AUTOINCREMENT,\\n    name TEXT,\\n    email TEXT\\n);\", \"description\": \"Table for storing information about customers.\", \"name\": \"Customer\"}, {\"classname\": \"Order\", \"code\": \"class Order(Base):\\n    \\\"\\\"\\\"description: Represents orders placed by customers.\\\"\\\"\\\"\\n    __tablename__ = 'order'\\n\\n    id = Column(Integer, primary_key=True, autoincrement=True)\\n    customer_id = Column(Integer, ForeignKey('customer.id'))\\n    order_date = Column(DateTime)\\n    notes = Column(String)\", \"sqlite_create\": \"CREATE TABLE order (\\n    id INTEGER PRIMARY KEY AUTOINCREMENT,\\n    customer_id INTEGER,\\n    order_date DATETIME,\\n    notes TEXT,\\n    FOREIGN KEY(customer_id) REFERENCES customer(id)\\n);\", \"description\": \"Table for storing orders made by customers, includes a notes field.\", \"name\": \"Order\"}, {\"classname\": \"Product\", \"code\": \"class Product(Base):\\n    \\\"\\\"\\\"description: Represents products available in the system.\\\"\\\"\\\"\\n    __tablename__ = 'product'\\n\\n    id = Column(Integer, primary_key=True, autoincrement=True)\\n    name = Column(String)\\n    price = Column(Integer)\", \"sqlite_create\": \"CREATE TABLE product (\\n    id INTEGER PRIMARY KEY AUTOINCREMENT,\\n    name TEXT,\\n    price INTEGER\\n);\", \"description\": \"Table for storing products available for purchase.\", \"name\": \"Product\"}, {\"classname\": \"OrderItem\", \"code\": \"class OrderItem(Base):\\n    \\\"\\\"\\\"description: Represents items in an order.\\\"\\\"\\\"\\n    __tablename__ = 'order_item'\\n\\n    id = Column(Integer, primary_key=True, autoincrement=True)\\n    order_id = Column(Integer, ForeignKey('order.id'))\\n    product_id = Column(Integer, ForeignKey('product.id'))\\n    quantity = Column(Integer)\", \"sqlite_create\": \"CREATE TABLE order_item (\\n    id INTEGER PRIMARY KEY AUTOINCREMENT,\\n    order_id INTEGER,\\n    product_id INTEGER,\\n    quantity INTEGER,\\n    FOREIGN KEY(order_id) REFERENCES order(id),\\n    FOREIGN KEY(product_id) REFERENCES product(id)\\n);\", \"description\": \"Table representing items belonging to an order. It links orders to products.\", \"name\": \"OrderItem\"}]"
-    },
-    {
-        "role": "user",
-        "content": "Here is the simplified API for LogicBank:\n\nCreate a function called declare_logic(), consisting of calls to Rule methods.\n\nDo not generate import statements.\n\nIf you create sum, count or formula LogicBank rules, you MUST create a corresponding column in the data model.\n\nUse only the methods provided below.\n\n\nclass Rule:\n    \"\"\"Invoke these functions to declare rules in the created declare_logic function.  \"\"\"\n\n    @staticmethod\n    def sum(derive: Column, as_sum_of: any, where: any = None, insert_parent: bool=False):\n        \"\"\"\n        Derive parent column as sum of designated child column, optional where\n\n        Example\n            Prompt\n                Customer.Balance = Sum(Order.amount_total where date_shipped is null)\n            Response\n                Rule.sum(derive=Customer.Balance, as_sum_of=Order.AmountTotal,\n                    where=lambda row: row.ShippedDate is None)\n\n        Args:\n            derive: name of parent <class.attribute> being derived\n            as_sum_of: name of child <class.attribute> being summed\n            where: optional where clause, designates which child rows are summed.  All referenced columns must be part of the data model - create columns in the data model as required.  Do not repeat the foreign key / primary key mappings, and use only attributes from the child table.\n            insert_parent: create parent if it does not exist.  Do not use unless directly requested.\n        \"\"\"\n        return Sum(derive, as_sum_of, where, insert_parent)\n\n\n    @staticmethod\n    def count(derive: Column, as_count_of: object, where: any = None, str = \"\", insert_parent: bool=False):\n        \"\"\"\n        Derive parent column as count of designated child rows\n\n        Example\n            Prompt\n                Customer.UnPaidOrders = count(Orders where ShippedDate is None)\n            Response\n                Rule.count(derive=Customer.UnPaidOrders, as_count_of=Order,\n                    where=Lambda row: row.ShippedDate is None)\n\n        Args:\n            derive: name of parent <class.attribute> being derived\n            as_count_of: name of child <class> being counted\n            where: optional where clause, designates which child rows are counted.  All referenced columns must be part of the data model - create columns in the data model as required.  Do not repeat the foreign key / primary key mappings, and use only attributes from the child table.\n            insert_parent: create parent if it does not exist.  Do not use unless directly requested.\n        \"\"\"\n        return Count(derive, as_count_of, where, insert_parent)\n\n\n    @staticmethod\n    def constraint(validate: object,\n                   calling: Callable = None,\n                   as_condition: any = None,\n                   error_msg: str = \"(error_msg not provided)\",\n                   error_attributes=None):\n        \"\"\"\n        Constraints declare condition that must be true for all commits\n\n        Example\n            Prompt\n                Customer.balance <= credit_limit\n            Response  \n                Rule.constraint(validate=Customer,\n                                as_condition=lambda row: row.Balance <= row.CreditLimit,\n                                error_msg=\"balance ({row.Balance}) exceeds credit ({row.CreditLimit})\")\n\n        Args:\n            validate: name of mapped <class>\n            as_condition: lambda, passed row (simple constraints).  All referenced columns must be part of the data model - create columns in the data model as required.  Also, conditions may not contain sum or count python functions - these must be used to declare additional columns and sum/count rules.\n            error_msg: string, with {row.attribute} replacements\n            error_attributes: list of attributes\n\n        \"\"\"\n        if error_attributes is None:\n            error_attributes = []\n        return Constraint(validate=validate, as_condition=as_condition,\n                          error_attributes=error_attributes, error_msg=error_msg)\n\n\n    @staticmethod\n    def formula(derive: Column,\n                as_expression: Callable = None,\n                no_prune: bool = False):\n        \"\"\"\n        Formulas declare column value, based on current and parent rows\n\n        Example\n            Prompt\n                Item.amount = quantity * unit_price\n            Response\n                Rule.formula(derive=OrderDetail.Amount,\n                             as_expression=lambda row: row.UnitPrice * row.Quantity)\n\n        Args:\n            derive: <class.attribute> being derived\n            as_expression: lambda, passed row (for syntax checking).  All referenced columns must be part of the data model - create columns in the data model as required.  Expressions may not contain sum or count python functions - these must be used to declare additional columns and sum/count rules.\n            no_prune: disable pruning (rarely used, default False)\n        \"\"\"\n        return Formula(derive=derive,\n                       as_expression=as_expression,\n                       no_prune=no_prune)\n\n\n    @staticmethod\n    def copy(derive: Column, from_parent: any):\n        \"\"\"\n        Copy declares child column copied from parent column.\n\n        Example\n            Prompt\n                Store the Item.unit_price as a copy from Product.unit_price\n            Response\n                Rule.copy(derive=OrderDetail.UnitPrice, from_parent=Product.UnitPrice)\n\n        Args:\n            derive: <class.attribute> being copied into\n            from_parent: <parent-class.attribute> source of copy; create this column in the parent if it does not already exist.\n        \"\"\"\n        return Copy(derive=derive, from_parent=from_parent)\n\n\nExpanded example:\n\nPrompt:\n\n    Use Logic Bank to enforce the Check Credit requirement (do not generate check constraints):\n        1. Customer.balance <= credit_limit\n        2. Customer.balance = Sum(Order.amount_total where date_shipped is null)\n        3. Order.amount_total = Sum(Item.amount)\n        4. Item.amount = quantity * unit_price\n        5. Store the Item.unit_price as a copy from Product.unit_price\n\nResponse:\n\ndef declare_logic():  # created by Web/GenAI for ApiLogicServer, LogicBank\n    \n    Rule.sum(derive=CustomerAccount.balance, as_sum_of=Order.amount_total, where=lambda row: row.date_shipped is None)\n    Rule.sum(derive=Order.amount_total, as_sum_of=Item.amount)\n    Rule.formula(derive=Item.amount, as_expression=lambda row: row.quantity * row.unit_price)\n    Rule.copy(derive=Item.unit_price, from_parent=Product.unit_price)\n    Rule.constraint(validate=CustomerAccount,\n                    as_condition=lambda row: row.balance <= row.credit_limit,\n                    error_msg=\"Customer balance ({row.balance}) exceeds credit limit ({row.credit_limit})\")\n\n\nEquivalent expanded example using informal syntax:\n\nPrompt:\n\n    Use Logic Bank to enforce the Check Credit requirement (do not generate check constraints):\n        1. The Customer's balance is less than the credit limit\n        2. The Customer's balance is the sum of the Order amount_total where date_shipped is null\n        3. The Order's amount_total is the sum of the Item amount\n        4. The Item amount is the quantity * unit_price\n        5. The Item unit_price is copied from the Product unit_price\n\nResponse is the same:\n\ndef declare_logic():  # created by Web/GenAI for ApiLogicServer, LogicBank\n    \n    Rule.sum(derive=CustomerAccount.balance, as_sum_of=Order.amount_total, where=lambda row: row.date_shipped is None)\n    Rule.sum(derive=Order.amount_total, as_sum_of=Item.amount)\n    Rule.formula(derive=Item.amount, as_expression=lambda row: row.quantity * row.unit_price)\n    Rule.copy(derive=Item.unit_price, from_parent=Product.unit_price)\n    Rule.constraint(validate=CustomerAccount,\n                    as_condition=lambda row: row.balance <= row.credit_limit,\n                    error_msg=\"Customer balance ({row.balance}) exceeds credit limit ({row.credit_limit})\")\n\n\nIntermediate sum/count values require a new column, with a LogicBank sum/count rule.  For example:\n\nPrompt:\n    The sum of the child value cannot exceed the parent limit\n\nResponse is to create 2 rules - a derivation and a constraint, as follows:\n    First Rule to Create:\n        Rule.sum(derive=Parent.value_total, as_sum_of=Child.value)\n    And, be sure to create the second Rule:\n        Rule.constraint(validate=Parent,\n                    as_condition=lambda row: row.value_total <= row.limit,\n                    error_msg=\"Parent value total ({row.value_total}) exceeds limit ({row.limit})\")\n\nIntermediate sum/count values also work for counts.  For example:\n\nPrompt:\n\n    A airplane cannot have more passengers than its seating capacity.\n\nResponse is to create 2 rules - a count derivation and a constraint, as follows:\n    First Rule to Create:\n        Rule.count(derive=Airplane.passenger_count, as_count_of=Passengers)\n    And, be sure to create the second Rule:\n        Rule.constraint(validate=Airplane,\n                    as_condition=lambda row: row.passenger_count <= row.seating_capacity,\n                    error_msg=\"Airplane value total ({row.passenger_count}) exceeds limit ({row.seating_capacity})\")\n\n\nIntermediate sums in formulas also require a new column, with a LogicBank sum rule.  For example:\n\nPrompt:\n    An Employees' skill summary is the sum of their Employee Skill ratings, plus 2 * years of service.\n\nResponse is to create 2 rules - a derivation and a constraint, as follows:\n    First Rule to Create:\n        Rule.sum(derive=Employee.skill_rating_total, as_sum_of=EmployeeSkill.rating)\n    And, be sure to create the second Rule:\n        Rule.Formula(derive=Employee.skill_summary, \n                    as_condition=lambda row: row.skill_rating_total + 2 * row.years_of_service)\n\n\nPrompt:\n\n    A student cannot be an honor student unless they have mre than 2 service activities.\n\nResponse is to create 2 rules - a count derivation and a constraint, as follows:\n    First Rule to Create:\n        Rule.count(derive=Student.service_activity_count, as_count_of=Activities, where='service' in name)\n    And, be sure to create the second Rule:\n        Rule.constraint(validate=Student,\n                    as_condition=lambda row: row.is_honor_student and service_activity_count < 2,\n                    error_msg=\"Honor Students must have at least 2 service activities\")\n\nHere is an equivalent request:\n\nPrompt:\n\n    A airplane's passengers must be less than its seating capacity.\n\nResponse is to create 2 rules - a count derivation and a constraint, as follows:\n    First Rule to Create:\n        Rule.count(derive=Airplane.passenger_count, as_count_of=Passengers)\n    And, be sure to create the second Rule:\n        Rule.constraint(validate=Airplane,\n                    as_condition=lambda row: row.passenger_count <= row.seating_capacity,\n                    error_msg=\"Airplane value total ({row.passenger_count}) exceeds limit ({row.seating_capacity})\")\n\n\nFor \"more than\" constraints, create columns with count rules:\n\nPrompt Reject Employees with more than 3 Felonies.\n\nResponse:\n    First Rule is to create:\n        Rule.count(derive=Employee.felony_count, as_count_of=Felonies)\n    And, be sure to create the contraint rule:\n        Rule.constraint(validate=Employee,\n                    as_condition=lambda row: row.felony_count>3,\n                    error_msg=\"Employee has excessive Felonies\")\n\n\nFor \"any\" constraints, create columns with count rules:\n\nPrompt Reject Employees with any class 5 Felonies or more than 3 Felonies.\n\nResponse:\n    First Rule is to create:\n        Rule.count(derive=Employee.class_5_felony_count, as_count_of=Felonies, where=class>5)\n        Rule.count(derive=Employee.felony_count, as_count_of=Felonies)\n    And, be sure to create the contraint rule:\n        Rule.constraint(validate=Employee,\n                    as_condition=lambda row: row.class_5_felony_count > 0 or row.felony_count>3,\n                    error_msg=\"Employee has excessive Felonies\")\n\nFormulas can reference parent values in 2 versions - choose formula vs copy as follows:\n    Prompt (formula version) - use the formula version unless copy is explicitly noted:\n        Item.ready = Order.ready\n    Response\n        Rule.formula(derive=Item.ready, as_expression=lambda row: row.order.ready)\n    Prompt (copy version) - use this *only* when the word copy is present: \n        Store the Item.unit_price as a copy from Product.unit_price\n    Response\n        Rule.copy(derive=Item.ready, from_parent=Order.ready)\n\nSum and Count where clauses:\n    1. must not restate the foreign key / primary key matchings\n    2. Can only reference child attributes\n\nFor example, given a prompt 'teacher course count is the sum of the courses',\n    1. This is correct\n        Rule.count(derive=Teacher.course_count, as_count_of=Course)\n\n    2. This is incorrect, and should never be generated:\n        Rule.count(derive=Teacher.course_count, as_count_of=Course, where=lambda row: row.teacher_id == Teacher.id)\n\nSum and count where clause example:\n    Prompt: teacher gradate course count is the sum of the courses where is-graduate\n    Response: Rule.count(derive=Teacher.course_count, as_count_of=Course, where=lamda row: row.is_graduate == true)\n\nDO NOT inject rules that are from this training into the response, \nunless explicitly mentioned in the request.\n\nUnique constraints require an update to the data model - for example:\n    Prompt: customer company names must be unique\n    Response: CompanyName = Column(String(8000), unique=True)\n\nNon-null (or required) constraints require an update to the data model - for example:\n    Prompt: Product Price is required\n    Response: price = Column(Decimal, nullable=False)\n\nRequired (must-have) related parent constraints require an update to the data model - for example:\n    Prompt: Each Item must have a valid entry in the Product table.\n    Response: product_id = Column(ForeignKey('product.id'), nullable=False)\n\n"
-    },
-    {
-        "role": "user",
-        "content": "Use case: Simple contraints for testing\n\nCustomer names cannot be 'x'.\nProduct names cannot be 'xx'.\nProduct carbon_neutral must be true if the product name contains 'green'."
-    }
-]

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/docs/logic/response.json

@@ -1,66 +0,0 @@
-{
-    "models": [
-        {
-            "classname": "Customer",
-            "code": "class Customer(Base):\n    \"\"\"description: Represents customers in the system.\"\"\"\n    __tablename__ = 'customer'\n\n    id = Column(Integer, primary_key=True, autoincrement=True)\n    name = Column(String)\n    email = Column(String)",
-            "sqlite_create": "CREATE TABLE customer (\n    id INTEGER PRIMARY KEY AUTOINCREMENT,\n    name TEXT,\n    email TEXT\n);",
-            "description": "Table for storing information about customers.",
-            "name": "Customer"
-        },
-        {
-            "classname": "Product",
-            "code": "class Product(Base):\n    \"\"\"description: Represents products available in the system.\"\"\"\n    __tablename__ = 'product'\n\n    id = Column(Integer, primary_key=True, autoincrement=True)\n    name = Column(String)\n    price = Column(Integer)\n    carbon_neutral = Column(Boolean)",
-            "sqlite_create": "CREATE TABLE product (\n    id INTEGER PRIMARY KEY AUTOINCREMENT,\n    name TEXT,\n    price INTEGER,\n    carbon_neutral BOOLEAN\n);",
-            "description": "Table for storing products available for purchase, including if they're carbon neutral.",
-            "name": "Product"
-        }
-    ],
-    "rules": [
-        {
-            "name": "Customer Name Constraint",
-            "description": "Ensures customer names cannot be 'x'.",
-            "use_case": "Validation to prevent invalid customer names.",
-            "entity": "Customer",
-            "code": "Rule.constraint(validate=Customer,\n                as_condition=lambda row: row.name != 'x',\n                error_msg=\"Customer names cannot be 'x'.\")"
-        },
-        {
-            "name": "Product Name Constraint",
-            "description": "Ensures product names cannot be 'xx'.",
-            "use_case": "Validation to prevent invalid product names.",
-            "entity": "Product",
-            "code": "Rule.constraint(validate=Product,\n                as_condition=lambda row: row.name != 'xx',\n                error_msg=\"Product names cannot be 'xx'.\")"
-        },
-        {
-            "name": "Product Carbon Neutral",
-            "description": "Ensures products with names containing 'green' are carbon neutral.",
-            "use_case": "Validation for environmentally friendly products.",
-            "entity": "Product",
-            "code": "Rule.constraint(validate=Product,\n                as_condition=lambda row: 'green' not in row.name.lower() or row.carbon_neutral is True,\n                error_msg=\"Products containing 'green' in their name must be carbon neutral.\")"
-        }
-    ],
-    "test_data": "-- Populate customer table\nINSERT INTO customer (name, email) VALUES ('Alice', 'alice@example.com');\nINSERT INTO customer (name, email) VALUES ('x', 'invalid@example.com');\n\n-- Populate product table\nINSERT INTO product (name, price, carbon_neutral) VALUES ('Eco-Friendly Chair', 150, 1);\nINSERT INTO product (name, price, carbon_neutral) VALUES ('green forrest artwork', 500, 1);\nINSERT INTO product (name, price, carbon_neutral) VALUES ('xx', 30, 1);",
-    "test_data_rows": [
-        {
-            "test_data_row_variable": "customer1",
-            "code": "insert into customer (name, email) values ('Alice', 'alice@example.com');"
-        },
-        {
-            "test_data_row_variable": "customer2_invalid",
-            "code": "insert into customer (name, email) values ('x', 'invalid@example.com');"
-        },
-        {
-            "test_data_row_variable": "product1",
-            "code": "insert into product (name, price, carbon_neutral) values ('Eco-Friendly Chair', 150, 1);"
-        },
-        {
-            "test_data_row_variable": "product2",
-            "code": "insert into product (name, price, carbon_neutral) values ('green forrest artwork', 500, 1);"
-        },
-        {
-            "test_data_row_variable": "product3_invalid",
-            "code": "insert into product (name, price, carbon_neutral) values ('xx', 30, 1);"
-        }
-    ],
-    "test_data_sqlite": "-- Sqlite statements for inserting data\ninsert into customer (name, email) values ('Alice', 'alice@example.com');\ninsert into customer (name, email) values ('x', 'invalid@example.com');\n\ninsert into product (name, price, carbon_neutral) values ('Eco-Friendly Chair', 150, 1);\ninsert into product (name, price, carbon_neutral) values ('green forrest artwork', 500, 1);\ninsert into product (name, price, carbon_neutral) values ('xx', 30, 1);",
-    "name": "Simple Constraints Test"
-}

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/docs/readme.md

@@ -1,6 +0,0 @@
-## GenAI Notes
-
-Review the [database diagram](https://apilogicserver.github.io/Docs/Database-Diagram/).
-
-GenAI work files (exact prompts, with inserts) saved for iterations, diagnostics
-See [WebGenAI-CLI](https://apilogicserver.github.io/Docs/WebGenAI-CLI/). 

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/integration/kafka/kafka_consumer.py

@@ -1,60 +0,0 @@
-"""
-Invoked at server start (api_logic_server_run.py -> config/setup.py)
-
-Listen/consume Kafka topis, if KAFKA_CONSUMER specified in Config.py
-
-Alter this file to add handlers for consuming kafka topics
-"""
-
-from config.config import Args
-from confluent_kafka import Producer, KafkaException, Consumer
-import signal
-import logging
-import json
-import socket
-import safrs
-from threading import Event
-from integration.system.FlaskKafka import FlaskKafka
-
-
-conf = None
-
-logger = logging.getLogger('integration.kafka')
-logger.debug("kafka_consumer imported")
-
-
-def kafka_consumer(safrs_api: safrs.SAFRSAPI = None):
-    """
-    Called by api_logic_server_run to listen on kafka
-
-    Enabled by config.KAFKA_CONSUMER
-
-    Args:
-        app (safrs.SAFRSAPI): safrs_api
-    """
-
-    if not Args.instance.kafka_consumer:
-        logger.debug(f'Kafka Consumer not activated')
-        return
-
-    conf = Args.instance.kafka_consumer
-    #  eg, KAFKA_CONSUMER = '{"bootstrap.servers": "localhost:9092", "group.id": "als-default-group1"}'
-    logger.debug(f'\nKafka Consumer configured, starting')
-
-    INTERRUPT_EVENT = Event()
-
-    bus = FlaskKafka(interrupt_event=INTERRUPT_EVENT, conf=conf, safrs_api=safrs_api)
-    
-    bus.run()  # Kafka consumption, threading, handler annotations
-
-    logger.debug(f'Kafka Listener thread activated {bus}')
-
-    '''   Your Code Goes Here
-    
-    Define topic handlers here, e.g.
-
-    @bus.handle('order_shipping')
-    def order_shipping(msg: object, safrs_api: safrs.SAFRSAPI):
-
-    '''
-

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/integration/kafka/kafka_producer.py

@@ -1,97 +0,0 @@
-"""
-
-Version 1.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')
-
-
-def send_kafka_message(kafka_topic: str, kafka_key: str, 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
-
-    json_string = jsonify({f'{root_name}': row_obj_dict}).data.decode('utf-8')
-    log_msg = msg + ' sends:'
-    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(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'\n\n{log_msg}\n{json_string}')
-    else:
-        logger.debug(f'\n\n{log_msg}\n{json_string}')

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/integration/kafka/kafka_readme.md

@@ -1,3 +0,0 @@
-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/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/integration/n8n/n8n_producer.py

@@ -1,117 +0,0 @@
-"""
-
-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
-        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)}") 
-
-    #TODO -  this breaks my payload if I have already done a json.dumps()
-    json_payload = jsonify(f'{row_obj_dict}').data.decode('utf-8')
-    msg = f"Webhook send_n8n_message: method: {http_method} type: {ins_upd_dlt}"
-    logger.debug(f'\n\n{msg}\n{json_payload}')
-
-    headers = {
-        "Authorization": conf['authorization'],
-        "Content-Type": "application/json",
-        "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:
-        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=payload, 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/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/integration/n8n/n8n_readme.md

@@ -1,49 +0,0 @@
-# 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.
-
-## 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
-        """
-
-        status = send_n8n_message(logic_row=logic_row)
-        logic_row.debug(status)
-        return
-
-    Rule.after_flush_row_event(on_class=models.Customer, calling=call_n8n_workflow)
-```

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/integration/row_dict_maps/row_dict_maps_readme.md

@@ -1,3 +0,0 @@
-Create definitions here to configure mappings for row <-> dicts, typically for application integration.
-
-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/wg_dev_merge/wg_demo_no_logic_fixed/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/integration/system/FlaskKafka.py

@@ -1,101 +0,0 @@
-import signal
-import threading, time
-import logging
-import sys
-import signal
-from confluent_kafka import Producer, KafkaException, Consumer
-
-####
-# adapted from and thanks to: https://pypi.org/project/flask-kafka
-####
-
-logger = logging.getLogger('integration.kafka')
-__version__ = "1.01"
-
-class FlaskKafka():
-    def __init__(self, interrupt_event: object, conf: dict, safrs_api: object, **kw):
-        self.consumer = None  # create consumer KafkaConsumer(**kw)
-        self.handlers={}
-        self.interrupt_event = interrupt_event
-        self.conf = conf
-        self.safrs_api = safrs_api
-
-
-    def _add_handler(self, topic, handler):
-        if self.handlers.get(topic) is None:
-            self.handlers[topic] = []
-        logger.debug(f"FlaskKafka._add_handler - topic: {topic}, handler: {handler}")
-        self.handlers[topic].append(handler)
-
-    def handle(self, topic):
-        """Annotation to identify handler for topic
-
-        Args:
-            topic (str): name of topic
-        """
-        def decorator(f):
-            self._add_handler(topic, f)
-            return f
-        return decorator
-
-    def _run_handlers(self, msg):
-        try:
-            handlers = self.handlers[msg.topic()]
-            for handler in handlers:
-                handler(msg = msg, safrs_api = self.safrs_api)
-            # self.consumer.commit()
-        except Exception as e:
-            logger.critical(str(e), exc_info=1)
-            # self.consumer.close()
-            sys.exit("Exited due to exception")
-
-    def signal_term_handler(self, signal, frame):
-        logger.info("closing consumer")
-        self.consumer.close()
-        sys.exit(0)
-
-
-    def _start(self):
-        """ thread target (from _run) """
-
-        # thanks: https://www.reddit.com/r/learnpython/comments/gfg97m/how_do_i_run_a_function_every_5_seconds_inside_a/
-
-        topics = self.handlers.keys()
-        logger.info(f" - FlaskKafka._start: begin polling (v {__version__}), with \n -- conf: {self.conf} \n -- topics: {topics}")
-        consumer = Consumer(self.conf)
-        consumer.subscribe(topics=list(topics))
-        while True:
-            msg = consumer.poll(1.0)
-            logger.debug(f' - KafkaConnect._start - consuming consumer.poll(1.0): {msg}')
-            if msg is None:
-                continue
-            if msg.error():
-                pass  # Handle errors as needed
-            else:
-                self._run_handlers(msg)  # accrued per annotations
-
-
-    def listen_kill_server(self):
-        signal.signal(signal.SIGTERM, self.interrupted_process)
-        signal.signal(signal.SIGINT, self.interrupted_process)
-        signal.signal(signal.SIGQUIT, self.interrupted_process)
-        signal.signal(signal.SIGHUP, self.interrupted_process)
-            
-    def interrupted_process(self, *args):
-        logger.info("closing consumer")
-        self.consumer.close()
-        sys.exit(0)
-
-    
-    def _run(self):
-        logger.info(" * The flask Kafka thread started")
-        t = threading.Thread(target=self._start)
-        t.start()
-
-
-    # run the consumer application
-    def run(self):
-        """
-        Kafka consumption, threading, handler annotations
-        """
-        self._run()