ApiLogicServer 15.0.65__py3-none-any.whl → 15.1.2__py3-none-any.whl

api_logic_server_cli/prototypes/manager/samples/basic_demo/readme_vibe.md

@@ -0,0 +1,353 @@
+---
+title: Vibe MCP / Microservice
+do_process_code_block_titles: True
+version: 0.23 from docsite, for readme 7/11/2025
+---
+<style>
+  -typeset h1,
+  -content__button {
+    display: none;
+  }
+</style>
+
+# Vibe an MCP Microservice
+
+This illustrates [GenAI-Logic](https://apilogicserver.github.io/Docs/Sample-Basic-Demo-Vibe) automation to create an MCP system using **Vibe:** 
+> **1) Natural Language**, **2) Declarative** (*what not now*), **3) Trusted error correction** with the coding assistant
+
+<br>
+
+**🤖 Bootstrap Copilot by pasting the following into the chat:**
+``` bash title='🤖 Bootstrap Copilot by pasting the following into the chat'
+Please find and read `.github/.copilot-instructions.md`.
+```
+
+<br>
+
+<details markdown>
+
+<summary>Demo Overview: Vibe an MCP API, Custom Client and Business Logic; pre-reqs </summary>
+
+<br>Here we will use Vibe to:
+
+1. Create a project from an existing database, providing a MCP-enabled API and an Admin App
+2. Create a custom (React) client
+3. Create an MCP Client, and
+4. Add declarative logic and security<br><br>
+
+Pre-reqs:
+
+1. Install
+2. OpenAI API Key is useful but not required; [click here](WebGenAI-CLI#configuration).
+
+  * The React App has pre-built apps (`ui/my-react-app`) you can use; they require `npm install; npm start`
+  * The `integration/mcp/mcp_client_executor.py` has `create_tool_context_from_llm` set to bypass LLM calls and use saved context; alter as required.
+3. NodeJS to run the react app
+
+The entire process takes 20 minutes; usage notes:
+
+* Most find it **more convenient** to view this in your Browser; [click here](https://apilogicserver.github.io/Docs/Sample-Basic-Tour)
+* A slide show summary is available [on our Web Site](https://www.genai-logic.com/product/tour)
+* Important: look for **readme files** in created projects
+
+![product-tour](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/basic_demo/product-tour.png?raw=true)
+
+</details>
+
+<br>
+
+## 1. Create From Existing DB
+
+**Create a project from an existing database (open the disclure box for details):**
+```bash title="Create a project from an existing database (open the disclure box for details)"
+Create a database project from samples/dbs/basic_demo.sqlite
+```
+
+<details markdown>
+
+<summary> The database is Customer, Orders, Items and Product; you can also create the dataase</summary>
+
+![existing datbase](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/vscode/vibe/create-project.png?raw=true)
+
+**Or, create a *new* database** with this prompt:
+```bash
+Create a system with customers, orders, items and products.
+
+Include a notes field for orders.
+
+Use case: Check Credit    
+    1. The Customer's balance is less than the credit limit
+    2. The Customer's balance is the sum of the Order amount_total where date_shipped is null
+    3. The Order's amount_total is the sum of the Item amount
+    4. The Item amount is the quantity * unit_price
+    5. The Item unit_price is copied from the Product unit_price
+
+Use case: App Integration
+    1. Send the Order to Kafka topic 'order_shipping' if the date_shipped is not None.
+```
+
+<br>
+
+In either case, the database model is customer, orders and items:
+
+![basic_demo_data_model](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/basic_demo/basic_demo_data_model.jpeg?raw=true)
+
+</details>
+
+&nbsp;
+
+### 1a. Project Opens: Run
+
+The project should automatically open a new window in VSCode. <br>
+
+**🤖 Again, bootstrap Copilot by pasting the following into the chat:**
+``` bash title='🤖 Again, bootstrap Copilot by pasting the following into the chat'
+Please find and read `.github/.copilot-instructions.md`.
+```
+
+Run it as follows:
+
+1. **Start the Server:** F5 
+2. **Start the Admin App:** browse to [http://localhost:5656/](http://localhost:5656/).  The Admin App screen shown below should appear in your Browser.
+3. **Verify as shown below**
+
+<details markdown>
+
+<summary>API: filtering, sorting, pagination, optimistic locking and related data access - see the Swagger </summary>
+
+Your API is MCP enabled, and ready for custom app dev.  For more information, [click here](https://apilogicserver.github.io/Docs/API-Self-Serve/).
+
+![swagger](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/basic_demo/api-swagger.jpeg?raw=true)
+</details>
+
+<br>
+
+<details markdown>
+
+<summary>Admin App: multi-page, multi-table, automatic joins, lookups, cascade add - collaboration-ready</summary>
+
+For more information, [click here](https://apilogicserver.github.io/Docs/Admin-Tour).
+
+The Admin App is ready for **[business user agile collaboration](https://apilogicserver.github.io/Docs/Tech-AI/),** and back office data maintenance.  This complements custom UIs created with the API.
+
+Explore the app - click Customer Alice, and see their Orders, and Items.  
+
+![admin-app-initial](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/basic_demo/admin-app-initial.jpeg?raw=true)
+</details>
+
+<br>
+
+## 2. Custom UI: GenAI, Vibe
+
+The app above is suitable for collaborative iteration to nail down the requirements, and back office data maintenance.  It's also easy to make simple customizations, using the yaml file.  For more custom apps, use Vibe:
+
+**Create a custom react app - customize in your IDE directly or with Vibe:**
+```bash title="Create a custom react app - customize in your IDE directly or with Vibe"
+Create a new react app using genai-add-app, 
+wait for it to complete, 
+then update the Product list to provide users an option to see results in a list or in cards.
+
+```
+
+<details markdown>
+
+<summary>Vibe Automation provides a running start (and can make errors)</summary>
+
+* Instead of creating data mockups, you have a **running API server with real data**
+* Instead of starting from scratch, you have a **running multi-page app** 
+* And, you'll have projects that are **architecturally correct:** shared logic, enforced in the server, available for both User Interfaces and services.
+* Then, use you favorite Vibe tools with your running API:
+
+> Note: AI makes errors.  Part of Vibe is to accept that, and insist that AI find and fix them.  CoPilot is generally exceptionally good at this.
+
+</details>
+
+<br>
+
+> Below is an example from Northwind: [click here](https://apilogicserver.github.io/Docs/Admin-Vibe-Sample)
+
+![vibe-cards](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/ui-vibe/nw/vibe-gallery.png?raw=true)
+
+
+<br>
+
+## 3. Declare Business Logic
+
+Logic (multi-table derivations and constraints) is a significant portion of a system, typically nearly half.  GenAI-Logic provides **spreadsheet-like rules** that dramatically simplify and accelerate logic development.
+
+Rules are declared in Python, simplified with IDE code completion.  The screen below shows the 5 rules for **Check Credit Logic.**
+
+**1. Stop the Server** (Red Stop button, or Shift-F5 -- see Appendix)
+
+**2. Add Business Logic**
+
+**Check Credit Logic (instead of 220 lines of code):**
+```bash title="Check Credit Logic (instead of 220 lines of code)"
+Use case: Check Credit    
+    1. The Customer's balance is less than the credit limit
+    2. The Customer's balance is the sum of the Order amount_total where date_shipped is null
+    3. The Order's amount_total is the sum of the Item amount
+    4. The Item amount is the quantity * unit_price
+    5. The Item unit_price is copied from the Product unit_price
+
+Use case: App Integration
+    1. Send the Order to Kafka topic 'order_shipping' if the date_shipped is not None.
+```
+
+![Nat Lang Logic](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/sample-ai/copilot/copilot-logic-vibe.png?raw=true)
+
+To test the logic:
+
+**1. Use the Admin App to access the first order for `Customer Alice`**
+
+**2. Edit its first item to a very high quantity**
+
+The update is properly rejected because it exceeds the credit limit.  Observe the rules firing in the console log - see Logic In Action, below.
+
+<br>
+
+<details markdown>
+
+<summary>Logic is critical - half the effort; Declarative is 40X More Concise, Maintainable </summary>
+
+<br>Logic is critical to your system - it represents nearly *half the effort.*  Instead of procedural code, [***declare logic***](Logic#declaring-rules) with WebGenAI, or in your IDE using code completion or Natural Language as shown above.
+
+
+**a. 40X More Concise**
+
+The 5 spreadsheet-like rules represent the same logic as 200 lines of code, [shown here](https://apilogicserver.github.io/Docs/Logic-Why).  That's a remarkable 40X decrease in the backend half of the system.
+
+> 💡 No FrankenCode<br>Note the rules look like syntactically correct requirements.  They are not turned into piles of unmanageable "frankencode" - see [models not frankencode](https://www.genai-logic.com/faqs#h.3fe4qv21qtbs).
+
+**b. Maintainable: Debugging, Logging**
+
+The screenshot below shows our logic declarations, and the logging for inserting an `Item`.  Each line represents a rule firing, and shows the complete state of the row.
+
+Note that it's a `Multi-Table Transaction`, as indicated by the indentation.  This is because - like a spreadsheet - **rules automatically chain, *including across tables.***
+
+![logic-chaining](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/basic_demo/logic-debugging.jpeg?raw=true)
+
+
+</details>
+
+<br>
+
+## 4. Enterprise Connectivity - B2B
+
+To fit our system into the Value Chain,
+we need a custom API to accept orders from B2B partners, and forward paid orders to shipping via Kafka.
+
+**Create the Custom B2B API Endpoint:**
+``` bash title="Create the Custom B2B API Endpoint"
+Create a B2B order API called 'OrderB2B' that accepts orders from external partners. 
+
+The external format should map:
+- 'Account' field to find customers by name
+- 'Notes' field to order notes
+- 'Items' array where each item maps 'Name' to find products and 'QuantityOrdered' to item quantity
+
+The API should create complete orders with automatic lookups and inherit all business logic rules.
+```
+
+The Kafka logic was created earlier, so we are ready to test.
+
+You can use Swagger (note the test data is provided), or use CLI:
+
+**Test the B2B Endpoint:**
+``` bash title="Test the B2B Endpoint"
+curl -X POST http://localhost:5656/api/OrderB2BEndPoint/OrderB2B -H "Content-Type: application/json" -d '{"meta":{"args":{"data":{"Account":"Alice","Notes":"RUSH order for Q4 promotion","date_shipped":"2025-08-04","Items":[{"Name":"Widget","QuantityOrdered":5},{"Name":"Gadget","QuantityOrdered":3}]}}}}'
+```
+
+Observe the logic execution in the VSCode debug window.
+
+<br>
+
+## 5. MCP: Logic, User Interface
+
+The server is automatically mcp-enabled, but we also require a user-interface to enable business users to send email, subject to business logic for customer email opt-outs.  Build it as follows:<br><br>
+
+
+**1. Stop the Server:**  click the red stop icon 🟥 or press <kbd>Shift</kbd>+<kbd>F5</kbd>.
+
+**2. Create the SysEmail Table to Track Sent Emails**
+
+**Add a Table to Track Sent Emails:**
+``` bash title="Add a Table to Track Sent Emails"
+Create a table SysEmail in `database/db.sqlite` as a child of customer, 
+with columns id, message, subject, customer_id and CreatedOn.
+```
+Follow the suggestions to update the admin app.
+
+<br>
+
+**3. Create an MCP Client Executor to process MCP Requests:**
+
+**Create an MCP Client Executor (dont run yet):**
+``` bash title="Create an MCP Client Executor (don't run yet)"
+genai-logic genai-add-mcp-client
+```
+This enables the user interface for MCP.  MCP Clients accept MCP Requests, invoke the LLM to obtain a series of API calls to run, and runs them.  For more on MCP, [click here](https://apilogicserver.github.io/Docs/Integration-MCP).
+
+<br>
+
+**4. Create the email service using a Request Table**
+
+**Create the email service using SysEmail as a Request Table:**
+``` bash title="Create the email service using SysEmail as a Request Table"
+Add an after_flush event on SysEmail to produce a log message "email sent",
+unless the customer has opted out.
+```
+
+Inserts into SysEmail will now send mails (stubbed here with a log message).  Request objects are a common rule pattern - for more information, [click here](Integration-MCP#3b-logic-request-pattern).
+
+<br>
+
+<details markdown>
+
+<summary>Creates logic like this </summary>
+
+<br>When sending email, we require ***business rules*** to ensure it respects the opt-out policy:
+
+![email request](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/mcp/3a-email-logic.png?raw=true)
+
+</details>
+
+<br>
+
+**5. Restart the Server** - F5
+
+<br>
+
+**6. Start the Admin App**
+
+<br>
+
+**7. Click SysMCP >> Create New, and enter:**
+
+**Test the MCP using the Admin App:**
+```text title="Test the MCP using the Admin App"
+List the orders date_shipped is null and CreatedOn before 2023-07-14, 
+and send a discount email (subject: 'Discount Offer') 
+to the customer for each one.
+```
+
+<br>
+
+![mcp-ui](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/basic_demo/mcp-ui.png?raw=true)
+
+
+<details markdown>
+
+<summary>More on MCP; Observe the log </summary>
+
+<br>For more on MCP, [click here](https://apilogicserver.github.io/Docs/Integration-MCP).
+
+![mcp-retrieval](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/basic_demo/mcp-retrieval.png?raw=true)
+
+</details>
+
+<br>
+
+## 6. Iterate with Rules and Python
+
+This is addressed in the related CLI-based demo - to continue, [click here](Sample-Basic-Demo#5-iterate-with-rules-and-python).

api_logic_server_cli/prototypes/manager/samples/basic_demo/requirements.txt

@@ -0,0 +1,3 @@
+# this includes the key libraries (Flask, SQLAlchemy, SAFRS), and the API Logic Server CLI
+
+ApiLogicServer

api_logic_server_cli/prototypes/manager/samples/basic_demo/run.ps1

@@ -0,0 +1,30 @@
+Set-PSDebug -Trace 0  # Use 1 for LOTS of output
+
+if ($args[0] -contains "help") {
+    Write-Output "`r`nRuns API Logic Project, using venv in:"
+    Write-Output "   - project folder (no args)"
+    Write-Output "   - calling folder (arg 1)`r`n"
+    exit 0
+}
+
+# Write-Output "`r`nRunning at caller path: $PWD, with $($args.Count) args"
+
+if ($args.count -gt 0) { 
+    # Write-Output "Using calling venv"
+    .\venv\Scripts\activate
+}
+
+# change path to project
+$prevPwd = $PWD; Set-Location -ErrorAction Stop -LiteralPath $PSScriptRoot
+# Write-Output "PWD to project: $PWD"
+
+try {
+    if ($args.count -eq 0) { 
+        # Write-Output "Using project venv: $PWD"
+        .\venv\Scripts\activate
+    }
+    python api_logic_server_run.py
+}
+finally {
+  $prevPwd | Set-Location
+}

api_logic_server_cli/prototypes/manager/samples/basic_demo/run.sh

@@ -0,0 +1,55 @@
+#!/bin/bash
+
+contains()
+  # echo contains check $1 in $2
+  case "$1" in
+    (*"$2"*) true;;
+    (*) false;;
+  esac
+
+
+debug() {
+  echo "$1"
+}
+
+debug "\nAPI Logic Project Runner 1.0 Here ($# arg(s): $1 $2)"
+if [ $# -ge 1 ]
+  then
+    if contains "help" $1; then
+      echo "\nRuns API Logic Project"
+      echo "  sh run.sh [ calling | $ | help ] [ gunicorn ]"
+      echo "    arg1: specifies how to find venv; values:"
+      echo "       no args - use project venv"
+      echo "       calling - use venv from calling script (for internal tests)"
+      echo "       $ - use the current venv"
+      echo "    arg2: use gunicorn (Note: no commas)\n"
+      exit 0
+    elif [ "$1" == "$" ]; then
+      debug ".. Using existing venv -- $VIRTUAL_ENV"
+    else
+      debug ".. Calling directory - venv from pwd: $PWD"
+      cd $PWD
+      . venv/bin/activate
+    fi
+  else
+    debug " "
+    if [ "${APILOGICSERVER_RUNNING}" = "DOCKER" ]; then
+      debug ".. Docker - no venv required"
+    else
+      debug ".. APILOGICSERVER_RUNNING=${APILOGICSERVER_RUNNING} - not Docker/Codespaces - activate venv"
+      . venv/bin/activate
+    fi
+  fi
+
+export PYTHONHASHSEED=0
+cd "$(dirname "$0")"
+
+if [ $# -eq 2 ]; then
+    debug "Running with gunicorn"
+    shift
+    PORT=${APILOGICPROJECT_PORT:-5656}
+    gunicorn --log-level=info -b 0.0.0.0:${PORT} -w2 --reload api_logic_server_run:flask_app $*
+else
+    debug "run flask"
+    python api_logic_server_run.py
+fi

api_logic_server_cli/prototypes/manager/samples/basic_demo/security/authentication_provider/abstract_authentication_provider.py

@@ -0,0 +1,34 @@
+from abc import ABC, abstractmethod
+
+# **************************************
+# authentication provider abstract class
+# **************************************
+
+class Abstract_Authentication_Provider():
+        
+    @staticmethod
+    @abstractmethod
+    def get_user(id: str, password: str) -> object:
+        """
+        Must return a row object with attributes name and role_list
+        role_list is a list of row objects with attribute name
+
+        row object is a DotMap or a SQLAlchemy row
+        
+        print("subclass responsibility")
+        return None
+        """
+
+    @staticmethod
+    @abstractmethod
+    def check_password(user: object, password: str) -> bool:
+        """_summary_
+
+        Args:
+            user (object): DotMap or SQLAlchemy row containing id and maybe password
+
+        Returns:
+            bool: whether password matches
+        """
+        return False
+