ApiLogicServer 15.0.35__py3-none-any.whl → 15.0.38__py3-none-any.whl

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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -0,0 +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;