PyPI - ApiLogicServer - Versions diffs - 15.0.37__py3-none-any.whl → 15.0.40__py3-none-any.whl - Mend

ApiLogicServer 15.0.37py3-none-any.whl → 15.0.40py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (55) hide show

api_logic_server_cli/prototypes/nw/api/api_discovery/authentication_expose_api_models.py ADDED Viewed

@@ -0,0 +1,53 @@
+import inspect
+import safrs
+import importlib
+import pathlib
+import logging as logging
+import flask_sqlalchemy
+# use absolute path import for easier multi-{app,model,db} support
+force_import = __import__("database.database_discovery.authentication_models")
+database = __import__('database')
+app_logger = logging.getLogger(__name__)
+app_logger.debug("api/expose_api_models.py - endpoint for each table")
+def add_check_sum(cls):
+    """
+    Checksum decorator for each model
+    """
+    @safrs.jsonapi_attr
+    def _check_sum_(self):
+        if isinstance(self, flask_sqlalchemy.model.DefaultMeta) or not hasattr(self, "_check_sum_property"):   # property does not exist during initialization
+            return None
+        return self._check_sum_property
+    @_check_sum_.setter
+    def _check_sum_(self, value):
+        self._check_sum_property = value
+    cls.S_CheckSum = _check_sum_
+    return cls
+def add_service(app, api, project_dir, swagger_host: str, PORT: str, method_decorators ):
+    """ Called by api_discovery to
+    * expose API for each model (using introspection)
+    Args:
+        app (_type_): _description_
+        api (_type_): _description_
+        project_dir (_type_): _description_
+        swagger_host (str): _description_
+        PORT (str): _description_
+        method_decorators (_type_): _description_
+    Returns:
+        _type_: _description_
+    """
+    # Get all the subclasses of the Base class and expose them in the api
+    for name, obj in inspect.getmembers(database.database_discovery.authentication_models):
+        if inspect.isclass(obj) and issubclass(obj, database.models.SAFRSBaseX) and obj is not database.models.SAFRSBaseX:
+            app_logger.info(f"Exposing /{name}")
+            api.expose_object(add_check_sum(obj), method_decorators= method_decorators)
+    return api

api_logic_server_cli/prototypes/nw/api/api_discovery/auto_discovery.py ADDED Viewed

@@ -0,0 +1,27 @@
+import importlib
+from pathlib import Path
+import logging
+app_logger = logging.getLogger(__name__)
+def discover_services(app, api, project_dir, swagger_host: str, PORT: str):
+    """
+    Discover services in the services directory
+    """
+    import os
+    method_decorators : list = []
+    services = []
+    services_path = Path(__file__).parent
+    for root, dirs, files in os.walk(services_path):
+        for file in files:
+            if file.endswith(".py"):
+                spec = importlib.util.spec_from_file_location("module.name", services_path.joinpath(file))
+                if file.endswith("auto_discovery.py"):
+                    pass
+                else:
+                    services.append(file)
+                    each_service = importlib.util.module_from_spec(spec)
+                    spec.loader.exec_module(each_service)  # runs "bare" module code (e.g., initialization)
+                    each_service.add_service(app, api, project_dir, swagger_host, PORT, method_decorators)  # invoke create function
+    app.logger.info(f"..discovered services: {services}")
+    return

api_logic_server_cli/prototypes/nw/api/api_discovery/count_orders_by_month.html ADDED Viewed

@@ -0,0 +1,76 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Bar Chart Example</title>
+    <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
+</head>
+<body>
+    <canvas id="myChart" width="400" height="200"></canvas>
+    <script>
+        // Input data
+        fetch('http://localhost:5656/api/GraphicsServices/count_orders_by_month', {
+            method: 'POST',
+            headers: {
+            'accept': 'application/vnd.api+json',
+            'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({}) // Add any required payload here
+        })
+            .then(response => {
+                if (!response.ok) {
+                    throw new Error(`HTTP error! status: ${response.status}`);
+                }
+                return response.json();
+            })
+            .then(result => {
+                const labels = [];
+                const data = [];
+                const type = result.meta.result.chart_type;
+                const title = result.meta.result.title;
+                const columns = result.meta.result.columns;
+                console.log(JSON.stringify(result));
+                result.meta.result.results.forEach(item => {
+                    labels.push(item[columns[0]]);
+                    data.push(parseFloat(item[columns[1]]));
+                });
+                // Create the bar chart
+                const ctx = document.getElementById('myChart').getContext('2d');
+                const myChart = new Chart(ctx, {
+                    type: type,
+                    data: {
+                    labels: labels,
+                    datasets: [{
+                        label: title,
+                        data: data,
+                        backgroundColor: 'rgba(75, 192, 192, 0.2)',
+                        borderColor: 'rgba(75, 192, 192, 1)',
+                        borderWidth: 1
+                    }]
+                    },
+                    options: {
+                    responsive: true,
+                    plugins: {
+                        legend: {
+                        position: 'top',
+                        },
+                        title: {
+                        display: true,
+                        text: title
+                        }
+                    },
+                    scales: {
+                        y: {
+                        beginAtZero: true
+                        }
+                    }
+                    }
+                });
+                })
+                .catch(error => console.error('Error fetching data:', error));
+    </script>
+</body>
+</html>

api_logic_server_cli/prototypes/nw/api/api_discovery/count_orders_by_month.sql ADDED Viewed

	@@ -0,0 +1 @@
1	+ SELECT strftime('%Y-%m', date(`Order`.OrderDate)) AS OrderMonth, COUNT(`Order`.Id) AS OrderCount FROM `Order` WHERE `Order`.OrderDate IS NOT NULL GROUP BY OrderMonth ORDER BY OrderMonth;

api_logic_server_cli/prototypes/nw/api/api_discovery/dashboard_services.py ADDED Viewed

@@ -0,0 +1,143 @@
+from database import models
+import logging
+from safrs import jsonapi_attr
+from sqlalchemy.orm import relationship, remote, foreign
+from functools import wraps # This convenience func preserves name and docstring
+import decimal as decimal
+from sqlalchemy import extract, func
+from flask import request, jsonify
+from safrs import jsonapi_rpc, SAFRSAPI
+from database import models
+import safrs
+from pathlib import Path
+"""
+Called by iFrame in home.js when admin app is loaded
+Returns iFrame for ui/admin/home.js, with entries like this to populate the dashboard:
+<iframe src="http://localhost:5656/chart_graphics/sales_per_category" style="flex: 1; border: none; width: 90%; height: 200px;">
+curl -X GET "http://localhost:5656/dashboard"
+You typically do not alter this file - it is rebuilt on `als genai-graphics`
+"""
+app_logger = logging.getLogger(__name__)
+dashboard_result = {}
+def add_service(app, api, project_dir, swagger_host: str, PORT: str, method_decorators = []):
+    pass
+    @app.route('/dashboard', methods=['GET','OPTIONS'])
+    def dashboard():
+        if request.method == 'OPTIONS':
+            return jsonify({"result": "ok"})
+        server = request.host_url
+        iframe_template = '<div class="dashboard-iframe"><iframe src="{url}" style="flex: 1; border: none; width: 90%; height: 200px;"></iframe></div>'
+        iframe_1 = iframe_template.format(url=f"{server}chart_graphics/sales_by_category")
+        iframe_2 = iframe_template.format(url=f"{server}chart_graphics/number_of_sales_per_category")
+        iframe_3 = iframe_template.format(url=f"{server}chart_graphics/count_orders_by_month")
+        return f'<div style="display: flex; flex-direction: row; gap: 10px;  border: none; ">{iframe_1} {iframe_2} {iframe_3}</div>'
+    @app.route('/chart_graphics/<path:path>', methods=['GET','OPTIONS'])
+    def chart_graphics(path):
+        if request.method == 'OPTIONS':
+            return jsonify({"result": "ok"})
+        dashboards = get_dashboards()
+        if len(dashboards) == 0:
+            return jsonify({"result": "No dashboards Found"}), 404
+        if path in dashboards:
+            return dashboards[path]
+        return jsonify({"result": "not found"}), 404
+    ##############################
+    # generated queries follow
+    ##############################
+    def get_dashboards():
+        if len(dashboard_result) > 0:
+            return dashboard_result
+        from jinja2 import Environment, FileSystemLoader
+        env = Environment(loader = FileSystemLoader('ui/templates'))
+        template = env.get_template('bar_chart.jinja')
+        previously_failed = Path('docs/graphics/sales_by_category.err').exists()
+        if previously_failed:
+            pass  # query has previously failed, so skip it
+        else:
+            try:
+                results = models.Category.sales_by_category(None)
+                color = 'rgba(75, 192, 192, 0.2)'
+                dashboard1 = template.render(result=results, color=color)
+                dashboard_result['sales_by_category']= dashboard1
+            except Exception as e:
+                msg = f"GenAI query creation error on models.Category.sales_by_category: "  + str(e)
+                dashboard_result['sales_by_category'] = msg
+                app_logger.error(msg)
+                with open('docs/graphics//sales_by_category.err', 'w') as err_file:
+                    err_file.write(msg)  # this logs the error to prevent future calls
+        previously_failed = Path('docs/graphics/number_of_sales_per_category.err').exists()
+        if previously_failed:
+            pass  # query has previously failed, so skip it
+        else:
+            try:
+                results = models.Category.number_of_sales_per_category(None)
+                color = 'rgba(75, 192, 192, 0.2)'
+                dashboard2 = template.render(result=results, color=color)
+                dashboard_result['number_of_sales_per_category']= dashboard2
+            except Exception as e:
+                msg = f"GenAI query creation error on models.Category.number_of_sales_per_category: "  + str(e)
+                dashboard_result['number_of_sales_per_category'] = msg
+                app_logger.error(msg)
+                with open('docs/graphics//number_of_sales_per_category.err', 'w') as err_file:
+                    err_file.write(msg)  # this logs the error to prevent future calls
+        previously_failed = Path('docs/graphics/count_orders_by_month.err').exists()
+        if previously_failed:
+            pass  # query has previously failed, so skip it
+        else:
+            try:
+                results = models.Order.count_orders_by_month(None)
+                color = 'rgba(75, 192, 192, 0.2)'
+                dashboard3 = template.render(result=results, color=color)
+                dashboard_result['count_orders_by_month']= dashboard3
+            except Exception as e:
+                msg = f"GenAI query creation error on models.Order.count_orders_by_month: "  + str(e)
+                dashboard_result['count_orders_by_month'] = msg
+                app_logger.error(msg)
+                with open('docs/graphics//count_orders_by_month.err', 'w') as err_file:
+                    err_file.write(msg)  # this logs the error to prevent future calls
+        return dashboard_result

api_logic_server_cli/prototypes/nw/api/api_discovery/mcp_discovery.py ADDED Viewed

@@ -0,0 +1,97 @@
+from flask import request, jsonify
+import logging
+import os
+import json
+from pathlib import Path
+import requests
+from config.config import Args  # circular import error if at top
+app_logger = logging.getLogger("api_logic_server_app")
+def add_service(app, api, project_dir, swagger_host: str, PORT: str, method_decorators = []):
+    pass
+    def get_server_url():
+        """ return the server URL for the OpenAPI spec """
+        result = f'http://{Args.instance.swagger_host}:{Args.instance.swagger_port}'
+        # get env variable API_LOGIC_SERVER_TUNNEL (or None)
+        if tunnel_url := os.getenv("API_LOGIC_SERVER_TUNNEL", None):
+            app_logger.info(f".. tunnel URL: {tunnel_url}")
+            result = tunnel_url
+        return result  #  + '/api'
+    @app.before_request
+    def before_any_request():
+        # print(f"[DEBUG] Incoming request: {request.method} {request.url}")
+        if activate_openapi_logging := False:
+            if request.content_type == 'application/json' and request.method in ['POST', 'PUT', 'PATCH']:
+                # openapi: Incoming request: PATCH http://localhost:5656/api/Customer/1/ {'data': {'attributes': {'credit_limit': 5555}, 'type': 'Customer', 'id': '1'}}
+                # openapi: Incoming request: PATCH http://6f6f-2601-644-4900-d6f0-ecc9-6df3-8863-c5b2.ngrok-free.app/api/Customer/1 {'credit_limit': 5555}
+                app_logger.info(f"openapi: Incoming request: {request.method} {request.url} {str(request.json)}")
+            else:
+                app_logger.info(f"openapi: Incoming request: {request.method} {request.url}")
+            # app_logger.info(f"openapi: Incoming request headers: {request.headers}")
+            chatgpt_request_json = {
+                        "credit_limit": 25000,
+            }
+            standard_request_json = {
+                "data": {
+                    "type": "Customer",
+                    "id": "ALFKI",
+                    "attributes": {
+                        "name": "Alice",
+                        "credit_limit": 25000,
+                        "balance": 12345
+                    }
+                }
+            }
+            swagger_request_json = {
+                'data': {
+                    'attributes': {
+                        'credit_limit': 5555
+                        },
+                    'type': 'Customer',
+                    'id': '1'
+                }
+            }
+        pass
+    @app.route('/.well-known/mcp.json', methods=['GET'])
+    def mcp_discovery(path=None):
+        ''' called by mcp_client_executor for discovery; read docs/mcp_learning/ for:
+        1. learning, including fan-out & response format, and email requests.
+        2. schema
+        see: https://apilogicserver.github.io/Docs/Integration-MCP/#1-discovery
+            test: curl -X GET "http://localhost:5656/.well-known/mcp.json"
+        '''
+        # return docs/mcp_schema.json
+        mcp_learning_path = Path(project_dir + "/docs/mcp_learning")
+        try:
+            schema_path = mcp_learning_path.joinpath('mcp_schema.json')
+            if not schema_path.exists():
+                return jsonify({"error": "System Error - /docs/mcp_learning/mcp_schema.json not found"}), 404
+            with open(schema_path, "r") as schema_file:
+                schema = json.load(schema_file)
+        except Exception as e:
+            app_logger.error(f"Error loading MCP schema: {e}")
+            return jsonify({"error": "MCP schema not found"}), 404
+        try:
+            learnings_path = mcp_learning_path.joinpath('mcp.prompt')
+            if not learnings_path.exists():
+                return jsonify({"error": "System Error - /docs/mcp_learning/mcp,prompt not found"}), 404
+            with open(learnings_path, "r") as learnings_file:
+                learnings = learnings_file.read()
+        except Exception as e:
+            app_logger.error(f"Error loading MCP learnings: {e}")
+            return jsonify({"error": "MCP learnings not found"}), 404
+        schema['learning'] = learnings
+        return jsonify(schema), 200

api_logic_server_cli/prototypes/nw/api/api_discovery/new_service.py ADDED Viewed

@@ -0,0 +1,21 @@
+from flask import request, jsonify
+import logging
+app_logger = logging.getLogger("api_logic_server_app")
+def add_service(app, api, project_dir, swagger_host: str, PORT: str, method_decorators = []):
+    pass
+    @app.route('/hello_service')
+    def hello_service():
+        """
+        Illustrates:
+        * Use standard Flask, here for non-database endpoints.
+        Test it with:
+                http://localhost:5656/hello_service?user=ApiLogicServer
+        """
+        user = request.args.get('user')
+        app_logger.info(f'{user}')
+        return jsonify({"result": f'hello from new_service! from {user}'})

api_logic_server_cli/prototypes/nw/api/api_discovery/newer_service.py ADDED Viewed

@@ -0,0 +1,21 @@
+from flask import request, jsonify
+import logging
+app_logger = logging.getLogger("api_logic_server_app")
+def add_service(app, api, project_dir, swagger_host: str, PORT: str, method_decorators ):
+    pass
+    @app.route('/hello_newer_service')
+    def hello_newer_service():
+        """
+        Illustrates:
+        * Use standard Flask, here for non-database endpoints.
+        Test it with:
+                http://localhost:5656/hello_newer_service?user=ApiLogicServer
+        """
+        user = request.args.get('user')
+        app_logger.info(f'{user}')
+        return jsonify({"result": f'hello from even_newer_service! from {user}'})

api_logic_server_cli/prototypes/nw/api/api_discovery/number_of_sales_per_category.html ADDED Viewed

@@ -0,0 +1,76 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Bar Chart Example</title>
+    <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
+</head>
+<body>
+    <canvas id="myChart" width="400" height="200"></canvas>
+    <script>
+        // Input data
+        fetch('http://localhost:5656/api/GraphicsServices/number_of_sales_per_category', {
+            method: 'POST',
+            headers: {
+            'accept': 'application/vnd.api+json',
+            'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({}) // Add any required payload here
+        })
+            .then(response => {
+                if (!response.ok) {
+                    throw new Error(`HTTP error! status: ${response.status}`);
+                }
+                return response.json();
+            })
+            .then(result => {
+                const labels = [];
+                const data = [];
+                const type = result.meta.result.chart_type;
+                const title = result.meta.result.title;
+                const columns = result.meta.result.columns;
+                console.log(JSON.stringify(result));
+                result.meta.result.results.forEach(item => {
+                    labels.push(item[columns[0]]);
+                    data.push(parseFloat(item[columns[1]]));
+                });
+                // Create the bar chart
+                const ctx = document.getElementById('myChart').getContext('2d');
+                const myChart = new Chart(ctx, {
+                    type: type,
+                    data: {
+                    labels: labels,
+                    datasets: [{
+                        label: title,
+                        data: data,
+                        backgroundColor: 'rgba(75, 192, 192, 0.2)',
+                        borderColor: 'rgba(75, 192, 192, 1)',
+                        borderWidth: 1
+                    }]
+                    },
+                    options: {
+                    responsive: true,
+                    plugins: {
+                        legend: {
+                        position: 'top',
+                        },
+                        title: {
+                        display: true,
+                        text: title
+                        }
+                    },
+                    scales: {
+                        y: {
+                        beginAtZero: true
+                        }
+                    }
+                    }
+                });
+                })
+                .catch(error => console.error('Error fetching data:', error));
+    </script>
+</body>
+</html>

api_logic_server_cli/prototypes/nw/api/api_discovery/number_of_sales_per_category.sql ADDED Viewed

	@@ -0,0 +1 @@
1	+ SELECT Category.CategoryName, COUNT(`Order.Id`) AS NumberOfSales FROM Category JOIN Product ON Product.CategoryId = Category.Id JOIN OrderDetail ON OrderDetail.ProductId = Product.Id JOIN `Order` ON `Order`.Id = OrderDetail.OrderId WHERE `Order`.ShippedDate IS NOT NULL GROUP BY Category.CategoryName ORDER BY NumberOfSales DESC;

ApiLogicServer 15.0.37__py3-none-any.whl → 15.0.40__py3-none-any.whl

ApiLogicServer 15.0.37py3-none-any.whl → 15.0.40py3-none-any.whl