ApiLogicServer 15.0.61__py3-none-any.whl → 15.1.0__py3-none-any.whl

api_logic_server_cli/prototypes/manager/samples/basic_demo/api/api_discovery/auto_discovery.py

@@ -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/manager/samples/basic_demo/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/manager/samples/basic_demo/api/api_discovery/mcp_expose_api_models.py

@@ -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.mcp_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.mcp_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/manager/samples/basic_demo/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/manager/samples/basic_demo/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}'})