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

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/database/system/SAFRSBaseX.py

@@ -0,0 +1,73 @@
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy import Column, DECIMAL, Date, ForeignKey, Integer, String
+from safrs import SAFRSBase
+from flask_login import UserMixin
+import safrs, flask_sqlalchemy
+from safrs import jsonapi_attr
+from flask_sqlalchemy import SQLAlchemy
+from datetime import datetime
+
+Base = declarative_base()  # type: flask_sqlalchemy.model.DefaultMeta
+#vh new x
+@classmethod
+def jsonapi_filter(cls):
+    """
+    Use this to override SAFRS JSON:API filtering
+
+    Returns:
+        _type_: SQLAlchemy query filter
+    """
+    from sqlalchemy import text, or_, and_
+    from flask import request
+    expressions = []
+    sqlWhere = ""
+    query = cls._s_query
+    if args := request.args:
+        from api.system.expression_parser import advancedFilter
+        expressions, sqlWhere = advancedFilter(cls, args)
+    if sqlWhere != "":    
+        return query.filter(text(sqlWhere))
+    else:
+        return query.filter(or_(*expressions))   
+
+class SAFRSBaseX(SAFRSBase, safrs.DB.Model):
+    __abstract__ = True
+    if do_enable_ont_advanced_filters := False:
+        jsonapi_filter = jsonapi_filter
+        
+    def _s_parse_attr_value(self, attr_name: str, attr_val: any):
+        """
+        Parse the given jsonapi attribute value so it can be stored in the db
+        :param attr_name: attribute name
+        :param attr_val: attribute value
+        :return: parsed value
+        """
+        attr = self.__class__._s_jsonapi_attrs.get(attr_name, None)
+        if hasattr(attr, "type"):  # pragma: no cover
+            
+            if str(attr.type) in ["DATE", "DATETIME"] and attr_val:
+                try:
+                    attr_val = attr_val.replace("T", " ")
+                    datetime.strptime(attr_val, '%Y-%m-%d %H:%M')
+                    attr_val += ":00"
+                except ValueError:
+                    pass
+                except Exception as exc:
+                    safrs.log.warning(exc)
+        
+        
+        return super()._s_parse_attr_value(attr_name, attr_val)
+
+class TestBase(Base):
+    __abstract__ = True
+    def __init__(self, *args, **kwargs):
+        for name, val in kwargs.items():
+            col = getattr(self.__class__, name)
+            if 'amount_total' == name:
+                debug_stop = 'stop'
+            if val is not None:
+                if str(col.type) in ["DATE", "DATETIME"]:
+                    pass
+                else:
+                    kwargs[name] = col.type.python_type(val)
+        return super().__init__(*args, **kwargs)

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/database/test_data/alp_init.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python
+import os, logging, logging.config, sys
+from config import server_setup
+import api.system.api_utils as api_utils
+from flask import Flask
+import logging
+import config.config as config
+
+os.environ["PROJECT_DIR"] = os.environ.get("PROJECT_DIR", os.path.abspath(os.path.dirname(__file__)))
+
+app_logger = server_setup.logging_setup()
+app_logger.setLevel(logging.INFO) 
+
+current_path = os.path.abspath(os.path.dirname(__file__))
+sys.path.extend([current_path, '.'])
+
+flask_app = Flask("API Logic Server", template_folder='ui/templates')
+flask_app.config.from_object(config.Config)
+flask_app.config.from_prefixed_env(prefix="APILOGICPROJECT")
+
+args = server_setup.get_args(flask_app)
+
+server_setup.api_logic_server_setup(flask_app, args)
+
+from database.models import *
+import safrs
+from datetime import date
+import os
+os.environ['AGGREGATE_DEFAULTS'] = 'True'
+
+with flask_app.app_context():
+    safrs.DB.create_all()
+    # try:
+    #     alice = Customer(id=1, name="Alice", credit_limit=1000, balance=0, total_orders=0)
+    #     safrs.DB.session.add(alice)
+    #     safrs.DB.session.commit()
+    # except Exception as e:
+    #     print(f"Error adding variable to session: {e}")
+
+    

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/database/test_data/readme.md

@@ -0,0 +1,10 @@
+ChatGPT sometimes fails to build proper test data that matches the derivation rules.
+
+You can rebuild the test data, using Logic Bank rules for proper derivations, to rebuild your `database/db.sqlite` (make a copy first to preserve your existing data).
+
+
+```
+als genai-utils --rebuild-test-data 
+```
+
+You can explore the generated `database/test_data/test_data_code.py` to control test data generation.

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/database/test_data/response2code.py

@@ -0,0 +1,148 @@
+#!/usr/bin/env python
+#
+# Convert a GPT response (WGResult) to code
+# This script reads a GPT response JSON file and generates Python code that can be used to add the test data to the database.
+# 
+# # Generate test data code from a GPT response JSON file:
+# python database/test_data/response2code.py --test-data --response=docs/Customer_Order_System_003.response
+# # Run the generated test data code:
+# python database/test_data/test_data_code.py
+
+# soon: 
+# cd project_dir
+# export APILOGICPROJECT_NO_FLASK=1
+# als genai-utils --rebuild-test-data --response=docs/genai_demo_informal_003.response
+#
+import ast
+import json
+import sys
+import os
+import logging
+import logging.config
+import click
+from pathlib import Path
+
+logging.basicConfig(level=logging.DEBUG)
+log = logging.getLogger("response2code")
+
+source_code_preamble = open(Path(__file__).parent / 'test_data_preamble.py').read()
+
+add_instance_code_template = """
+    try:
+        if not {hash} in succeeded_hashes:  # avoid duplicate inserts
+            instance = {code}
+            session.add(instance)
+            session.commit()
+            succeeded_hashes.add({hash})
+    except Exception as e:
+        has_errors = True
+        if 'UNIQUE' in str(e) and restart_count > 1:
+            pass
+        else:
+            error_str = f"Error adding variable to session: {{e}}"
+            if not error_str in data_log:
+                data_log.append(error_str)
+        if not restart_count in [2,3]:
+            session.rollback()
+"""
+
+
+def fix_code(code):
+    """
+    Fix syntax errors in code
+    """
+    ori_code = code
+    try:
+        ast.parse(code)
+        return code
+    except SyntaxError:
+        log.warning(f"Syntax error in code (1): {code}")
+    
+    code = ori_code.replace("'s", "''s")
+    try:
+        ast.parse(code)
+        return code
+    except SyntaxError:
+        log.warning(f"Syntax error in code (2): {code}")
+    
+    code = ori_code.replace("'", "")
+    try:
+        ast.parse(code)
+        return code
+    except SyntaxError:
+        log.warning(f"Syntax error in code (3): {code}")
+
+    code = ori_code.replace('"', '')
+    try:
+        ast.parse(code)
+        return code
+    except SyntaxError:
+        log.warning(f"Syntax error in code (4): {code}")
+
+    return None
+
+def write_test_data(test_data):
+    test_data_code = source_code_preamble
+    
+    for row in test_data:
+        try:
+            fixed_code = fix_code(row.get("code",''))
+            if not fixed_code:
+                continue
+        except Exception as e:
+            log.warning(f"Error fixing code: {e}")
+            continue
+        test_data_code += add_instance_code_template.format(code=fixed_code, hash=hash(fixed_code))
+
+    test_data_code += f"print('\\n'.join(data_log))\n"
+    test_data_code += "with open(project_dir / 'database/test_data/test_data_code_log.txt', 'w') as log_file:\n"
+    test_data_code += "    log_file.write('\\n'.join(data_log))\n"
+    test_data_code += "print('\\n'.join(data_log))\n"
+
+
+    test_data_file = 'database/test_data/test_data_code.py'
+    
+    with open(test_data_file, 'w') as f:
+        f.write(test_data_code)
+    
+    log.info(f"Successfully wrote test data code to {test_data_file}")
+
+def models2code():
+    log.info("models2code function called")
+    # ...existing code...
+    pass
+
+def rules2code():
+    log.info("rules2code function called")
+    # ...existing code...
+    pass
+
+
+def get_test_data(response):
+    if not response:
+        response = '../docs/response.json'
+    
+    log.info(f"Loading GPT response from {response}")
+    
+    with open(response) as f:
+        test_data = json.load(f).get("test_data_rows", [])
+
+    return test_data
+
+@click.command()
+@click.option('--models', is_flag=True, help='Call models2code function')
+@click.option('--rules', is_flag=True, help='Call rules2code function')
+@click.option('--test-data', is_flag=True, help='Call test_data2code function')
+@click.option('--response', type=click.Path(exists=True), help='Path to GPT response JSON file')
+def main(models, rules, test_data, response):
+    
+    if models:
+        models2code()
+    if rules:
+        rules2code()
+    if test_data:
+        test_data = get_test_data(response)
+        write_test_data(test_data)
+
+if __name__ == "__main__":
+    main()

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/database/test_data/test_data_preamble.py

@@ -0,0 +1,83 @@
+import logging
+import logging.config
+import json
+import os
+import sys
+
+os.environ["APILOGICPROJECT_NO_FLASK"] = "1"  # must be present before importing models
+
+import traceback
+import yaml
+from datetime import date, datetime
+from pathlib import Path
+from decimal import Decimal
+from sqlalchemy import (Boolean, Column, Date, DateTime, DECIMAL, Float, ForeignKey, Integer, Numeric, String, Text, create_engine)
+from sqlalchemy.dialects.sqlite import *
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+from sqlalchemy.sql import func
+
+current_path = Path(__file__)
+project_path = (current_path.parent.parent.parent).resolve()
+sys.path.append(str(project_path))
+
+from logic_bank.logic_bank import LogicBank, Rule
+from logic import declare_logic
+from database.models import *
+from database.models import Base
+
+project_dir = Path(os.getenv("PROJECT_DIR",'./')).resolve()
+
+assert str(os.getcwd()) == str(project_dir), f"Current directory must be {project_dir}"
+
+data_log : list[str] = []
+
+logging_config = project_dir / 'config/logging.yml'
+if logging_config.is_file():
+    with open(logging_config,'rt') as f:  
+        config=yaml.safe_load(f.read())
+    logging.config.dictConfig(config)
+logic_logger = logging.getLogger('logic_logger')
+logic_logger.setLevel(logging.DEBUG)
+logic_logger.info(f'..  logic_logger: {logic_logger}')
+
+db_url_path = project_dir.joinpath('database/test_data/db.sqlite')
+db_url = f'sqlite:///{db_url_path.resolve()}'
+logging.info(f'..  db_url: {db_url}')
+logging.info(f'..  cwd: {os.getcwd()}')
+logging.info(f'..  python_loc: {sys.executable}')
+logging.info(f'..  test_data_loader version: 1.1')
+data_log.append(f'..  db_url: {db_url}')
+data_log.append(f'..  cwd: {os.getcwd()}')
+data_log.append(f'..  python_loc: {sys.executable}')
+data_log.append(f'..  test_data_loader version: 1.1')
+
+if db_url_path.is_file():
+    db_url_path.unlink()
+
+try:
+    engine = create_engine(db_url)
+    Base.metadata.create_all(engine)
+    Session = sessionmaker(bind=engine)  # note: LogicBank activated for this session only
+    session = Session()
+    LogicBank.activate(session=session, activator=declare_logic.declare_logic)
+except Exception as e: 
+    logging.error(f'Error creating engine: {e}')
+    data_log.append(f'Error creating engine: {e}')
+    print('\n'.join(data_log))
+    with open(project_dir / 'database/test_data/test_data_code_log.txt', 'w') as log_file:
+        log_file.write('\n'.join(data_log))
+    print('\n'.join(data_log))
+    raise
+
+logging.info(f'..  LogicBank activated')
+data_log.append(f'..  LogicBank activated')
+
+restart_count = 0
+has_errors = True
+succeeded_hashes = set()
+
+while restart_count < 5 and has_errors:
+    has_errors = False
+    restart_count += 1
+    data_log.append("print(Pass: " + str(restart_count) + ")" )

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/devops/auth-db/authdb_mysql.Dockerfile

@@ -0,0 +1,65 @@
+# add security to your project with commands like
+# ApiLogicServer add-auth --project_name=. --db_url=mysql+pymysql://root:p@localhost:3306/authdb
+
+# You can create your *own* security database, as a super set of those shown here
+# That enables you to use additional columns in Grant declarations.
+
+# For more information, see https://apilogicserver.github.io/Docs/Security-Activation/
+
+# the apilogicserver sample
+# create a mysql that stores data in the container, not a volume (simpler, for dev env)
+# create database for auth
+
+# you might first create a project for mysql like this:
+# ApiLogicServer create --project_name=my_project --db_url='mysql+pymysql://root:p@localhost:3306/my_project_db'
+# cd my_project  # create your venv as usual...
+
+# now, build MySQL image from this file
+# cd devops/docker
+# docker build -t my-org/my-project-mysql --file authdb_mysql.Dockerfile --rm .
+
+# run container from built image
+# docker run --name my-project-mysql-container --net dev-network -p 3306:3306 -d -e MYSQL_ROOT_PASSWORD=p my-org/my-project-mysql
+
+# Now set up your mysql database.
+# docker exec -it my-project-mysql-container /bin/bash
+# bash> cd home
+# bash> mkdir mysql_ddl
+
+# on your local machine, copy the ddl (create tables) dump file
+# cd devops/docker
+# docker cp authdb_mysql.sql my-project-mysql-container:/home/mysql_ddl
+
+# back to docker terminal...
+# cd /var/lib/mysql
+# mysql -p  # open mysql command line, then enter your super-secret password, `p`
+# mysql> DROP DATABASE IF EXISTS `authdb`;
+# mysql> CREATE DATABASE `authdb`;
+# mysql> USE `authdb`;
+# mysql> source /home/mysql_ddl/authdb_mysql.sql
+# mysql> show databases;
+# restore other database dumps as desired
+# mysql> exit
+
+# after adding users/roles (see below), you can dump authdb
+# mysqldump -p authdb > /home/mysql_ddl/authdb_dump.sql
+# bash> exit
+
+# optionally add security
+# create the Dockers' MySql authdb as above, using auth-db.sql
+# cd my_project
+# ApiLogicServer add-auth
+# you should now be able to start server, login and access data
+# add users via http://localhost:5656/admin/authentication_admin/
+
+# Now convert container to image, and push to docker hub (change lines below to your account)
+# docker commit my-project-mysql-container my-project-mysql-image
+# docker tag my-project-mysql-image my-org/my-project-mysql-image:version1.0.0
+# docker push my-org/my-project-mysql-image:version1.0.0
+
+# thanks - https://medium.com/@stevenlandow/persist-share-dev-mysql-data-in-a-docker-image-with-commit-f9aa9910be0a
+
+FROM mysql:8.0
+
+RUN mkdir /var/lib/mysql-no-volume
+CMD ["--datadir", "/var/lib/mysql-no-volume"]

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/devops/auth-db/authdb_mysql.sql

@@ -0,0 +1,112 @@
+-- MySQL dump 10.13  Distrib 8.0.32, for Linux (aarch64)
+--
+-- Host: localhost    Database: authdb
+-- ------------------------------------------------------
+-- Server version	8.0.32
+
+-- mysql -u root -p
+-- use authdb
+-- 
+
+DROP DATABASE IF EXISTS `authdb`;
+CREATE DATABASE `authdb`;
+USE `authdb`;
+
+/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
+/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
+/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
+/*!50503 SET NAMES utf8mb4 */;
+/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
+/*!40103 SET TIME_ZONE='+00:00' */;
+/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
+/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
+/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
+/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
+
+--
+-- Table structure for table `Role`
+--
+
+DROP TABLE IF EXISTS `Role`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `Role` (
+  `name` varchar(64) NOT NULL,
+  PRIMARY KEY (`name`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `Role`
+--
+
+LOCK TABLES `Role` WRITE;
+/*!40000 ALTER TABLE `Role` DISABLE KEYS */;
+/*!40000 ALTER TABLE `Role` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `User`
+--
+
+DROP TABLE IF EXISTS `User`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `User` (
+  `name` varchar(128) DEFAULT NULL,
+  `notes` text,
+  `id` varchar(64) NOT NULL,
+  `username` varchar(128) DEFAULT NULL,
+  `email` varchar(128) DEFAULT NULL,
+  `password_hash` varchar(200) DEFAULT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `User`
+--
+
+LOCK TABLES `User` WRITE;
+/*!40000 ALTER TABLE `User` DISABLE KEYS */;
+INSERT INTO `User` VALUES ('Administrator',NULL,'admin','Admin User','admin@corp.com','p');
+/*!40000 ALTER TABLE `User` ENABLE KEYS */;
+UNLOCK TABLES;
+
+--
+-- Table structure for table `UserRole`
+--
+
+DROP TABLE IF EXISTS `UserRole`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `UserRole` (
+  `user_id` varchar(64) NOT NULL,
+  `notes` text,
+  `role_name` varchar(32) NOT NULL,
+  PRIMARY KEY (`user_id`,`role_name`),
+  KEY `in_role` (`role_name`),
+  CONSTRAINT `in_client` FOREIGN KEY (`user_id`) REFERENCES `User` (`id`) ON DELETE CASCADE ON UPDATE CASCADE,
+  CONSTRAINT `in_role` FOREIGN KEY (`role_name`) REFERENCES `Role` (`name`) ON DELETE CASCADE ON UPDATE CASCADE
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+
+--
+-- Dumping data for table `UserRole`
+--
+
+LOCK TABLES `UserRole` WRITE;
+/*!40000 ALTER TABLE `UserRole` DISABLE KEYS */;
+/*!40000 ALTER TABLE `UserRole` ENABLE KEYS */;
+UNLOCK TABLES;
+/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
+
+/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
+/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
+/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
+/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
+/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
+/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
+/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
+
+-- Dump completed on 2023-02-25  3:04:42

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/devops/auth-db/authdb_postgres.sql

@@ -0,0 +1,57 @@
+DROP DATABASE IF EXISTS authdb;
+CREATE DATABASE authdb;
+\c authdb;
+
+-- in docker container/terminal
+-- psql--username=postgres
+-- \l
+-- \dt
+
+
+--
+-- Table structure for table Role
+--
+
+DROP TABLE IF EXISTS "Role";
+CREATE TABLE "Role" (
+  name varchar(64) NOT NULL,
+  PRIMARY KEY (name)
+);
+
+
+--
+-- Table structure for table User
+--
+
+DROP TABLE IF EXISTS "User";
+CREATE TABLE "User" (
+  name varchar(128) DEFAULT NULL,
+  notes text,
+  id varchar(64) NOT NULL,
+  username varchar(128) DEFAULT NULL,
+  email varchar(128) DEFAULT NULL,
+  password_hash varchar(200) DEFAULT NULL,
+  PRIMARY KEY (id)
+);
+
+--
+-- Dumping data for table User
+--
+
+INSERT INTO "User" VALUES ('Administrator',NULL,'admin','Admin User','admin@corp.com','p');
+
+
+--
+-- Table structure for table UserRole
+--
+
+DROP TABLE IF EXISTS "UserRole";
+CREATE TABLE "UserRole" (
+  user_id varchar(64) NOT NULL,
+  notes text,
+  role_name varchar(32) NOT NULL,
+  PRIMARY KEY (user_id,role_name),
+  CONSTRAINT in_client FOREIGN KEY (user_id) REFERENCES "User" (id) ON DELETE CASCADE ON UPDATE CASCADE,
+  CONSTRAINT in_role FOREIGN KEY (role_name) REFERENCES "Role" (name) ON DELETE CASCADE ON UPDATE CASCADE
+);
+