ApiLogicServer 14.2.20__py3-none-any.whl → 14.3.0__py3-none-any.whl

api_logic_server_cli/model_migrator/system/custom_endpoint.py

@@ -1,545 +0,0 @@
-from functools import wraps
-import logging
-from flask_jwt_extended import get_jwt, jwt_required, verify_jwt_in_request
-from config import Config
-from security.system.authorization import Security
-import util
-from typing import List
-import safrs
-import sqlalchemy
-from flask import request, jsonify
-from safrs import jsonapi_rpc, SAFRSAPI
-from sqlalchemy.ext.hybrid import hybrid_property
-from sqlalchemy.orm import object_mapper
-from database import models
-from api.system.integration_endpoint import IntegrationEndpoint
-from config import Args
-from flask_cors import cross_origin
-from logic_bank.rule_bank.rule_bank import RuleBank
-from api.custom_resources.Customer import Customer
-from api.custom_resources.OrderById import OrderById
-from api.custom_resources.OrderB2B import OrderB2B
-from api.custom_resources.OrderShipping import OrderShipping
-
-# Customize this file to add endpoints/services, using SQLAlchemy as required
-#     Separate from expose_api_models.py, to simplify merge if project rebuilt
-# Called by api_logic_server_run.py
-
-app_logger = logging.getLogger("api_logic_server_app")  # only for create-and-run, no?
-
-def expose_services(app, api, project_dir, swagger_host: str, PORT: str):
-    """ 
-    Illustrates Customized APIs, Data Access.
-
-    * Observe that APIs not limited to database objects, but are extensible.
-    * See: https://apilogicserver.github.io/Docs/API-Customize/
-    * See: https://github.com/thomaxxl/safrs/wiki/Customization
-
-    Examples
-
-    * order_nested_objects() - 
-            * Uses util.format_nested_objects() (-> jsonify(row).json)
-
-    * CustomAPICustomer() - 
-            * SQLAlchemy related row retrieval, reformat as multi-table dict => json
-
-    * join_order() - 
-            * Illustrates: SQLAlchemy parent join fields
-
-    * CategoriesEndPoint get_cats() - swagger, row security
-            * Uses util.rows_to_dict            (-> row.to_dict())
-
-    * filters_cats() - model query with filters
-            * Uses manual result creation (not util)
-
-    * raw_sql_cats() - raw sql (non-modeled objects)
-            * Uses util.rows_to_dict            (-> iterate attributes)
-    
-    """
-
-    app_logger.info("..api/expose_service.py, exposing custom services: hello_world, add_order")
-
-    api.expose_object(ServicesEndPoint)  # Swagger-visible services
-    api.expose_object(CategoriesEndPoint)
-
-    @app.route('/hello_world')
-    def hello_world():
-        """        
-        Illustrates:
-        * Use standard Flask, here for non-database endpoints.
-
-        Test it with:
-        
-                http://localhost:5656/hello_world?user=ApiLogicServer
-        """
-        user = request.args.get('user')
-        # app_logger.info(f'hello_world returning:  hello, {user}')
-        app_logger.info(f'{user}')
-        return jsonify({"result": f'hello, {user}'})
-
-
-    @app.route('/stop')
-    def stop():
-        """
-        Use this to stop the server from the Browser.
-        * See: https://stackoverflow.com/questions/15562446/how-to-stop-flask-application-without-using-ctrl-c
-        * See: https://github.com/thomaxxl/safrs/wiki/Customization
-
-        Usage:
-
-                http://localhost:5656/stop?msg=API stop - Stop API Logic Server
-        """
-
-        import os, signal
-
-        msg = request.args.get('msg')
-        app_logger.info(f'\nStopped server: {msg}\n')
-
-        os.kill(os.getpid(), signal.SIGINT)
-        return jsonify({ "success": True, "message": "Server is shutting down..." })
-
-
-    def bypass_security():
-        """
-        Support option to bypass security (see cats, below).
-        """
-        def wrapper(fn):
-            @wraps(fn)
-            def decorator(*args, **kwargs):
-                if Config.SECURITY_ENABLED == False:
-                    return fn(*args, **kwargs)
-                verify_jwt_in_request(True)  # must be issued if security enabled
-                return fn(*args, **kwargs)
-            return decorator
-        return wrapper
-
-  
-    def admin_required():
-        """
-        Support option to bypass security (see cats, below).
-
-        See: https://flask-jwt-extended.readthedocs.io/en/stable/custom_decorators/
-        """
-        def wrapper(fn):
-            @wraps(fn)
-            def decorator(*args, **kwargs):
-                if Args.security_enabled == False:
-                    return fn(*args, **kwargs)
-                verify_jwt_in_request(True)  # must be issued if security enabled
-                return fn(*args, **kwargs)
-            return decorator
-        return wrapper
-
-
-    @app.route('/CustomAPI/Customer', methods=['GET','OPTIONS'])
-    @admin_required()
-    @jwt_required()
-    @cross_origin(supports_credentials=True)
-    def CustomAPICustomer():
-        """ 
-        SQLAlchemy row retrieval, reformat as multi-table dict => json
-
-        start the server (f5) and in the terminal window:
-        $(venv) ApiLogicServer login --user=admin --password=p
-        $(venv) ApiLogicServer curl "http://localhost:5656/CustomAPI/Customer?Id=ALFKI"
-        """
-        request_id = request.args.get('Id')
-        if request_id is None:
-            request_id = 'ALFKI'
-
-        db = safrs.DB           # Use the safrs.DB, not db!
-        session = db.session    # sqlalchemy.orm.scoping.scoped_session
-        # Security.set_user_sa()  # an endpoint that requires no auth header (see also @bypass_security)
-        the_customer : models.Customer = session.query(models.Customer) \
-                .filter(models.Customer.Id == request_id).one()
-        
-        customer_def = Customer()
-        dict_row = customer_def.to_dict(row = the_customer)
-        return jsonify({"Customer with related data":  dict_row})
-
-
-    @app.route('/join_order')
-    @bypass_security()
-    def join_order():
-        """
-        Illustrates: SQLAlchemy join fields
-
-        $(venv) ApiLogicServer curl "http://localhost:5656/join_order?id=11077"
-
-        Returns:
-            _type_: _description_
-        """
-
-        request_id = request.args.get('id')
-        if request_id is None:
-            request_id = 11078
-        db = safrs.DB           # Use the safrs.DB, not db!
-        session = db.session    # sqlalchemy.orm.scoping.scoped_session
-        Security.set_user_sa()  # an endpoint that requires no auth header (see also @bypass_security)
-        the_order : models.Order = session.query(models.Order) \
-                .filter(models.Order.Id == request_id).one()
-        
-        dict_row = {}
-        dict_row["id"] = the_order.Id
-        dict_row["AmountTotal"] = the_order.AmountTotal
-        dict_row["SalesRepLastName"] = the_order.Employee.LastName
-        return jsonify({"order_with_join_attr":  dict_row})
-
-
-    @app.route('/join_order_custom', methods=['GET','OPTIONS'])
-    @admin_required()
-    @jwt_required()
-    @cross_origin(supports_credentials=True)
-    def join_order_custom():
-        """ 
-        SQLAlchemy row retrieval, reformat as multi-table dict => json
-
-        $(venv) ApiLogicServer login --user=admin --password=p
-        $(venv) ApiLogicServer curl "http://localhost:5656/join_order_custom?id=11077"
-
-        """
-        request_id = request.args.get('id')
-        if request_id is None:
-            request_id = 11078
-        db = safrs.DB           # Use the safrs.DB, not db!
-        session = db.session    # sqlalchemy.orm.scoping.scoped_session
-        Security.set_user_sa()  # an endpoint that requires no auth header (see also @bypass_security)
-        the_order : models.Order = session.query(models.Order) \
-                .filter(models.Order.Id == request_id).one()
-        
-        order_def = OrderShipping()
-        dict_row = order_def.to_dict(row = the_order)
-        return jsonify({"Order with related data":  dict_row})
-
-
-    @app.route('/join_order_b2b', methods=['GET','OPTIONS'])
-    @admin_required()
-    @jwt_required()
-    @cross_origin(supports_credentials=True)
-    def join_order_b2b():
-        """ 
-        SQLAlchemy row retrieval, reformat as multi-table dict => json
-
-        $(venv) ApiLogicServer login --user=admin --password=p
-        $(venv) ApiLogicServer curl "http://localhost:5656/join_order_b2b?id=11077"
-
-        """
-        request_id = request.args.get('id')
-        if request_id is None:
-            request_id = 11078
-        db = safrs.DB           # Use the safrs.DB, not db!
-        session = db.session    # sqlalchemy.orm.scoping.scoped_session
-        Security.set_user_sa()  # an endpoint that requires no auth header (see also @bypass_security)
-        the_order : models.Order = session.query(models.Order) \
-                .filter(models.Order.Id == request_id).one()
-        
-        order_def = OrderB2B()
-        dict_row = order_def.to_dict(row = the_order)
-        return jsonify({"Order with related data":  dict_row})
-
-
-    @app.route('/filters_cats')
-    @bypass_security()
-    def filters_cats():
-        """
-        Illustrates:
-        * Explore SQLAlchemy and/or filters.
-        
-        Test (returns rows 2-5) (no auth):
-            curl -X GET "http://localhost:5656/filters_cats" [no-filter | simple-filter]"
-        """
-
-        from sqlalchemy import and_, or_
-        filter_type = request.args.get('filter')
-        if filter_type is None:
-            filter_type = "multiple filters"
-        db = safrs.DB           # Use the safrs.DB, not db!
-        session = db.session    # sqlalchemy.orm.scoping.scoped_session
-        Security.set_user_sa()  # an endpoint that requires no auth header (see also @bypass_security)
-
-        if filter_type.startswith("n"):
-            results = session.query(models.Category)    # .filter(models.Category.Id > 1)
-        elif filter_type.startswith("s"):               # normally coded like this
-            results = session.query(models.Category) \
-                .filter(models.Category.Id > 1) \
-                .filter(or_((models.Category.Client_id == 2), (models.Category.Id == 5)))
-        else:                                           # simulate grant logic (multiple filters)
-            client_grant = models.Category.Client_id == 2
-            id_grant = models.Category.Id == 5
-            grant_filter = or_( client_grant, id_grant)
-            results = session.query(models.Category) \
-                .filter(models.Category.Id > 1)  \
-                .filter(grant_filter)
-        return_result = []
-        for each_result in results:
-            row = { 'id': each_result.Id, 'name': each_result.CategoryName}
-            return_result.append(row)
-        return jsonify({ "success": True, "result":  return_result})
-
-
-    @app.route('/raw_sql_cats')
-    @bypass_security()
-    def raw_sql_cats():
-        """
-        Illustrates:
-        * "Raw" SQLAlchemy table queries (non-mapped objects)
-        * Observe phyical column name: CategoryName_ColumnName
-              * Contrast to models.py, get_cats()
-        
-        Test (auth optional):
-            curl -X GET "http://localhost:5656/raw_sql_cats"
-
-        """
-        DB = safrs.DB 
-        sql_query = DB.text("SELECT * FROM CategoryTableNameTest")
-        with DB.engine.begin() as connection:
-            query_result = connection.execute(sql_query).all()
-            rows_to_dict_rows = util.rows_to_dict(query_result)
-        response = {"result": rows_to_dict_rows} 
-        return response
-
-
-    @app.route('/order_nested_objects')
-    def order_nested_objects():
-        """
-        Illustrates:
-        * Returning a nested result set response
-        * Using SQLAlchemy to obtain data, and related data
-        * Restructuring row results to desired json (e.g., for tool such as Sencha)
-
-        Test (auth optional):
-            http://localhost:5656/order_nested_objects?Id=10643
-            curl -X GET "http://localhost:5656/order_nested_objects?Id=10643"
-
-        """
-        order_id = request.args.get('Id')
-        db = safrs.DB         # Use the safrs.DB, not db!
-        session = db.session  # sqlalchemy.orm.scoping.scoped_session
-        order = session.query(models.Order).filter(models.Order.Id == order_id).one()
-
-        result_std_dict = util.format_nested_object(order
-                                        , replace_attribute_tag='data'
-                                        , remove_links_relationships=True)
-        result_std_dict['data']['Customer_Name'] = order.Customer.CompanyName # eager fetch
-        result_std_dict['data']['OrderDetailListAsDicts'] = []
-        for each_order_detail in order.OrderDetailList:       # lazy fetch
-            each_order_detail_dict = util.format_nested_object(row=each_order_detail
-                                                    , replace_attribute_tag='data'
-                                                    , remove_links_relationships=True)
-            each_order_detail_dict['data']['ProductName'] = each_order_detail.Product.ProductName
-            result_std_dict['data']['OrderDetailListAsDicts'].append(each_order_detail_dict)
-        return result_std_dict
-
-
-    @app.route('/server_log')
-    def server_log():
-        """
-        Used by test/*.py - enables client app to log msg into server
-        """
-        return util.server_log(request, jsonify)
-
-    
-    @app.route('/metadata')
-    def metadata():
-        """
-        Swagger provides typical API discovery.  This is for tool providers
-        requiring programmatic access to api definition, e.g., 
-        to drive artifact code generation.
-
-        Returns json for list of 1 / all resources, with optional attribute name/type, eg
-
-        curl -X GET "http://localhost:5656/metadata?resource=Category&include=attributes"
-
-        curl -X GET "http://localhost:5656/metadata?include=attributes"
-        """
-        import inspect
-        import sys
-        from sqlalchemy.ext.declarative import declarative_base
-
-        resource_name = request.args.get('resource')
-        include_attributes = False
-        include = request.args.get('include')
-        if include:
-            include_attributes = "attributes" in include
-        resource_list = []  # array of attributes[], name (so, the name is last...)
-        resource_objs = {}  # objects, named = resource_name
-
-        models_name = "database.models"
-        cls_members = inspect.getmembers(sys.modules["database.models"], inspect.isclass)
-        for each_cls_member in cls_members:
-            each_class_def_str = str(each_cls_member)
-            if (f"'{models_name}." in str(each_class_def_str) and
-                            "Ab" not in str(each_class_def_str)):
-                each_resource_name = each_cls_member[0]
-                each_resource_class = each_cls_member[1]
-                each_resource_mapper = each_resource_class.__mapper__
-                if resource_name is None or resource_name == each_resource_name:
-                    resource_object = {"name": each_resource_name}
-                    resource_list.append(resource_object)
-                    resource_objs[each_resource_name] = {}
-                    if include_attributes:
-                        attr_list = []
-                        for each_attr in each_resource_mapper.attrs:
-                            if not each_attr._is_relationship:
-                                try:
-                                    attribute_object = {"name": each_attr.key,
-                                                        "type": str(each_attr.expression.type)}
-                                except:
-                                    attribute_object = {"name": each_attr.key,
-                                                        "type": "unkown"}
-                                attr_list.append(attribute_object)
-                        resource_object["attributes"] = attr_list
-                        resource_objs[each_resource_name] = {"attributes": attr_list}
-        # pick the format you like
-        return_result = {"resources": resource_list}
-        return_result = {"resources": resource_objs}
-        return jsonify(return_result)
-
-class ServicesEndPoint(safrs.JABase):
-    """
-    Illustrates
-    * Custom service - visible in swagger
-    * Quite small, since leverages logic/declare_logic rules
-    """
-
-    @classmethod
-    @jsonapi_rpc(http_methods=["POST"])
-    def add_order(self, *args, **kwargs):  # yaml comment => swagger description
-        """ # yaml creates Swagger description
-            args :
-                CustomerId: ALFKI
-                EmployeeId: 1
-                Freight: 10
-                OrderDetailList :
-                  - ProductId: 1
-                    Quantity: 1
-                    Discount: 0
-                  - ProductId: 2
-                    Quantity: 2
-                    Discount: 0
-        """
-
-        # test using swagger -> try it out (includes sample data, above)
-
-        db = safrs.DB         # Use the safrs.DB, not db!
-        session = db.session  # sqlalchemy.orm.scoping.scoped_session
-        new_order = models.Order()
-        session.add(new_order)
-
-        util.json_to_entities(kwargs, new_order)  # generic function - any db object
-        return {"Thankyou For Your Order"}  # automatic commit, which executes transaction logic
-        """
-        curl -X 'POST' \
-            'http://localhost:5656/api/ServicesEndPoint/add_order' \
-            -H 'accept: application/vnd.api+json' \
-            -H 'Content-Type: application/json' \
-            -d '{
-            "meta": {
-                "method": "add_order",
-                "args": {
-                "CustomerId": "ALFKI",
-                "EmployeeId": 1,
-                "Freight": 10,
-                "OrderDetailList": [
-                    {
-                    "ProductId": 1,
-                    "Quantity": 1,
-                    "Discount": 0
-                    },
-                    {
-                    "ProductId": 2,
-                    "Quantity": 2,
-                    "Discount": 0
-                    }
-                ]
-                }
-            }
-            }'
-        """
-
-
-    @classmethod
-    @jsonapi_rpc(http_methods=["POST"])
-    def add_b2b_order(self, *args, **kwargs):  # yaml comment => swagger description
-        """ # yaml creates Swagger description
-            args :
-                AccountId: "ALFKI"
-                Given: "xx"
-                Surname: "yy"
-                Items :
-                  - ProductName: "Chai"
-                    QuantityOrdered: 1
-                  - ProductName: "Chang"
-                    QuantityOrdered: 2
-        """
-
-        db = safrs.DB         # Use the safrs.DB, not db!
-        session = db.session  # sqlalchemy.orm.scoping.scoped_session
-
-        order_id_def = OrderB2B()
-        request_dict_str = request.data.decode('utf-8')
-        request_dict = eval(request_dict_str)
-        request_dict_data = request_dict["order"]
-        sql_alchemy_row = order_id_def.to_row(row_dict = request_dict_data, session = session)
-
-        session.add(sql_alchemy_row)
-        return {"Thankyou For Your OrderB2B"}  # automatic commit, which executes transaction logic
-    
-    @classmethod
-    # @jwt_required()
-    @jsonapi_rpc(http_methods=["POST"])
-    def add_order_by_id(self, *args, **kwargs):  # yaml comment => swagger description
-        """ # yaml creates Swagger description
-            order :
-                AccountId: ALFKI
-                SalesRepId: 1
-                Items :
-                  - ProductId: 1
-                    QuantityOrdered: 1
-                  - ProductId: 2
-                    QuantityOrdered: 2
-        """
-
-        # test using swagger -> try it out (includes sample data, above)
-
-        db = safrs.DB         # Use the safrs.DB, not db!
-        session = db.session  # sqlalchemy.orm.scoping.scoped_session
-
-        order_id_def = OrderById()
-        request_dict_str = request.data.decode('utf-8')
-        request_dict = eval(request_dict_str)
-        request_dict_data = request_dict["order"] 
-        sql_alchemy_row = order_id_def.to_row(row_dict = request_dict_data, session = session)
-
-        session.add(sql_alchemy_row)
-        return {"Thankyou For Your OrderById"}  # automatic commit, which executes transaction logic
-
-
-class CategoriesEndPoint(safrs.JABase):
-    """
-    Illustrates
-    * Swagger-visible RPC that requires authentication (@jwt_required()).
-    * Row Security
-
-    Test in swagger (auth required)
-    * Post to endpoint auth to obtain <access_token> value - copy to clipboard
-            * Row Security - Users determines results
-            * u1 - 1 row, u2 - 4 rows, admin - 9 rows
-    * Authorize (top of swagger), using Bearer <access_token>
-    * Post to CategoriesEndPoint/get_cats, observe results depend on login
-
-    """
-
-    @staticmethod
-    @jwt_required()
-    @jsonapi_rpc(http_methods=['POST'], valid_jsonapi=False)
-    def get_cats():
-        db = safrs.DB
-        session = db.session
-
-        result = session.query(models.Category)
-        for each_row in result:
-            app_logger.debug(f'each_row: {each_row}')
-        rows = util.rows_to_dict(result)
-        response = {"result": rows}
-        return response

api_logic_server_cli/prototypes/base/database/test_data/z_test_data_rows.py

@@ -1,98 +0,0 @@
-# experiment - under construction.  Not working, not used.
-# created from response, to create create_db_models.sqlite, with test data
-#    that is used to create project
-# should run without error in manager 
-#    if not, check for decimal, indent, or import issues
-
-import decimal
-import logging
-import sqlalchemy
-from sqlalchemy.sql import func 
-from logic_bank.logic_bank import Rule
-from sqlalchemy import create_engine, Column, Integer, String, Float, ForeignKey, Date, DateTime, Numeric, Boolean, Text, DECIMAL
-from sqlalchemy.types import *
-from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.orm import sessionmaker
-from sqlalchemy.orm import relationship
-from sqlalchemy.orm import Mapped
-from datetime import date   
-from datetime import datetime
-from typing import List
-import os, logging, logging.config, sys, yaml
-from pathlib import Path
-from logic_bank.logic_bank import LogicBank
-from database.models import *
-
-
-
-def load_data(session):
-        # Create test data
-    session.commit()
-    customer1 = Customer(id=1, name="John Doe", balance=130.00, credit_limit=500.00)
-    session.add(customer1)
-    session.commit()
-
-    customer2 = Customer(id=2, name="Jane Smith", balance=200.00, credit_limit=600.00)
-    session.add(customer2)
-    session.commit()
-
-    customer3 = Customer(id=3, name="George White", balance=300.00, credit_limit=700.00)
-    session.add(customer3)
-    session.commit()
-
-    customer4 = Customer(id=4, name="Lisa Brown", balance=400.00, credit_limit=800.00)
-    session.add(customer4)
-    session.commit()
-
-    product1 = Product(id=1, unit_price=10.00)
-    session.add(product1)
-    session.commit()
-
-    product2 = Product(id=2, unit_price=15.00)
-    session.add(product2)
-    session.commit()
-
-    product3 = Product(id=3, unit_price=20.00)
-    session.add(product3)
-    session.commit()
-
-    product4 = Product(id=4, unit_price=30.00)
-    session.add(product4)
-    session.commit()
-
-    order1 = Order(id=1, customer_id=1, date_shipped=None, amount_total=30.00, notes="First order")
-    session.add(order1)
-    session.commit()
-
-    order2 = Order(id=2, customer_id=2, date_shipped=None, amount_total=45.00, notes="Second order")
-    session.add(order2)
-    session.commit()
-
-    order3 = Order(id=3, customer_id=3, date_shipped=None, amount_total=60.00, notes="Third order")
-    session.add(order3)
-    session.commit()
-
-    order4 = Order(id=4, customer_id=4, date_shipped=None, amount_total=50.00, notes="Fourth order")
-    session.add(order4)
-    session.commit()
-
-    item1 = Item(id=1, order_id=1, product_id=1, quantity=3, amount=30.00, unit_price=10.00)
-    session.add(item1)
-    session.commit()
-
-    item2 = Item(id=2, order_id=2, product_id=2, quantity=3, amount=45.00, unit_price=15.00)
-    session.add(item2)
-    session.commit()
-
-    item3 = Item(id=3, order_id=3, product_id=3, quantity=3, amount=60.00, unit_price=20.00)
-    session.add(item3)
-    session.commit()
-
-    item4 = Item(id=4, order_id=4, product_id=4, quantity=2, amount=50.00, unit_price=25.00)
-    session.add(item4)
-    session.commit()
-
-    # session.add_all([customer1, customer2, customer3, customer4, product1, product2, product3, product4, order1, order2, order3, order4, item1, item2, item3, item4])
-    session.commit()
-    # end of test data
-