Refactor API call to be for validation;

apiCall.py

@@ -23,37 +23,37 @@ def api_call(
     Examples:
 
     1. Simple GET request to a search API:
-       method: "GET"
-       base_url: "https://v2.xivapi.com/api"
-       endpoint: "search"
-       param_keys_values:
-         query: Name~"popoto"
-         sheets: Item
-         fields: Name,Description
-         language: en
-         limit: 1
+        method: "GET"
+        base_url: "https://v2.xivapi.com/api"
+        endpoint: "search"
+        param_keys_values:
+            query: Name~"popoto"
+            sheets: Item
+            fields: Name,Description
+            language: en
+            limit: 1
 
     2. GitHub API request with headers:
-       method: "GET"
-       base_url: "https://api.github.com"
-       endpoint: "repos/microsoft/TypeScript/issues"
-       param_keys_values:
-         state: open
-         per_page: 5
-       header_keys_values:
-         Accept: application/vnd.github.v3+json
+        method: "GET"
+        base_url: "https://api.github.com"
+        endpoint: "repos/microsoft/TypeScript/issues"
+        param_keys_values:
+            state: open
+            per_page: 5
+        header_keys_values:
+            Accept: application/vnd.github.v3+json
 
     3. POST request with JSON body. the "messages" parameter is complexly structured, so it requires special handling."
-       method: "POST"
-       base_url: "https://api.anthropic.com"
-       endpoint: "v1/messages"
-       param_keys_values:
-         model: claude-opus-4-20250514
-         max_tokens: 1024
-       header_keys_values:
-         x-api-key: your_api_key_here
-         content-type: application/json
-       additional_params: {"messages": [{"role": "user", "content": "Hello there!"}]}
+        method: "POST"
+        base_url: "https://api.anthropic.com"
+        endpoint: "v1/messages"
+        param_keys_values:
+            model: claude-opus-4-20250514
+            max_tokens: 1024
+        header_keys_values:
+            x-api-key: your_api_key_here
+            content-type: application/json
+        additional_params: {"messages": [{"role": "user", "content": "Hello there!"}]}
     """
     # Build params dictionary from key-value pairs
     params = {}
@@ -110,7 +110,7 @@ def api_call(
             params=params,
             headers=headers,
             method=method,
-        )
+        )        
         return result
     except Exception as e:
         return f"Error making API call: {str(e)}"

api_validator.py

@@ -0,0 +1,248 @@
+import apiCall
+import json
+import os
+from datetime import datetime, timedelta
+import hashlib
+
+
+def validate_api_call(
+    mcp_api_key,
+    name,
+    description,
+    method,
+    base_url,
+    endpoint,
+    param_keys_values,
+    header_keys_values,
+    additional_params,
+    schedule_interval_minutes,
+    stop_after_hours,
+    start_time,
+):
+    """
+    Validate API call parameters and store successful configuration.
+
+    Parameters:
+    - mcp_api_key: MCP API key serves as user identifier
+    - name: User-friendly name for the monitoring task
+    - description: Description of what is being monitored
+    - method: HTTP method (GET, POST, PUT, DELETE)
+    - base_url: The base URL of the API
+    - endpoint: The specific API endpoint
+    - param_keys_values: Parameter key-value pairs, one per line
+    - header_keys_values: Header key-value pairs, one per line
+    - additional_params: Optional JSON string for complex parameters
+    - schedule_interval_minutes: Minutes between calls
+    - stop_after_hours: Hours after which to stop (max 168 = 1 week)
+    - start_time: When to start the monitoring (datetime string or None for immediate)
+
+    Returns:
+    - Dictionary with success status, config_id, message, and sample_response
+
+    Example return:
+    {
+        "success": True,
+        "config_id": 123,
+        "message": "API call validated and stored successfully",
+        "sample_response": {...},
+        "stop_at": "2025-06-11T12:00:00Z",
+        "start_at": "2025-06-04T12:00:00Z"
+    }
+    """
+    try:
+        # Validate input parameters
+        if not mcp_api_key or not mcp_api_key.strip():
+            return {
+                "success": False,
+                "message": "MCP API key is required",
+                "config_id": None,
+            }
+
+        if not name or not name.strip():
+            return {
+                "success": False,
+                "message": "Monitoring name is required",
+                "config_id": None,
+            }
+
+        if not base_url or not base_url.strip():
+            return {
+                "success": False,
+                "message": "Base URL is required",
+                "config_id": None,
+            }
+
+        if not method or method not in ["GET", "POST", "PUT", "DELETE"]:
+            return {
+                "success": False,
+                "message": "Valid HTTP method is required (GET, POST, PUT, DELETE)",
+                "config_id": None,
+            }
+
+        if (
+            not isinstance(schedule_interval_minutes, (int, float))
+            or schedule_interval_minutes < 1
+            or schedule_interval_minutes > 1440
+        ):
+            return {
+                "success": False,
+                "message": "Schedule interval must be between 1 and 1440 minutes",
+                "config_id": None,
+            }
+
+        if (
+            not isinstance(stop_after_hours, (int, float))
+            or stop_after_hours < 1
+            or stop_after_hours > 168
+        ):
+            return {
+                "success": False,
+                "message": "Stop after hours must be between 1 and 168 hours (1 week max)",
+                "config_id": None,
+            }
+
+        # Validate start_time if provided
+        if start_time:
+            try:
+                start_datetime = datetime.fromisoformat(
+                    start_time.replace("Z", "+00:00")
+                )
+                if start_datetime < datetime.now():
+                    return {
+                        "success": False,
+                        "message": "Start time cannot be in the past",
+                        "config_id": None,
+                    }
+            except ValueError:
+                return {
+                    "success": False,
+                    "message": "Invalid start time format",
+                    "config_id": None,
+                }
+        else:
+            start_datetime = datetime.now()
+
+        # Test the API call
+        result = apiCall.api_call(
+            method=method,
+            base_url=base_url,
+            endpoint=endpoint,
+            param_keys_values=param_keys_values,
+            header_keys_values=header_keys_values,
+            additional_params=additional_params,
+        )
+
+        # Check if the API call failed
+        if isinstance(result, str) and result.startswith("Error"):
+            return {
+                "success": False,
+                "message": f"API call test failed: {result}",
+                "config_id": None,
+            }
+
+        # Generate config ID and calculate timestamps
+        config_data = {
+            "mcp_api_key": mcp_api_key,
+            "name": name,
+            "description": description,
+            "method": method,
+            "base_url": base_url,
+            "endpoint": endpoint,
+            "param_keys_values": param_keys_values,
+            "header_keys_values": header_keys_values,
+            "additional_params": additional_params,
+            "schedule_interval_minutes": schedule_interval_minutes,
+            "stop_after_hours": stop_after_hours,
+            "start_time": start_time,
+        }
+
+        # Generate unique config ID
+        config_str = json.dumps(config_data, sort_keys=True)
+        config_id = int(hashlib.md5(config_str.encode()).hexdigest()[:8], 16)
+
+        # Calculate timestamps
+        created_at = datetime.now()
+        stop_at = start_datetime + timedelta(hours=stop_after_hours)
+
+        # Add metadata to config
+        config_data.update(
+            {
+                "config_id": config_id,
+                "created_at": created_at.isoformat(),
+                "start_at": start_datetime.isoformat(),
+                "stop_at": stop_at.isoformat(),
+
+                # @JamezyKim This will be used to track the status of whether the api is confirmed or not
+                "is_validated": False,
+                "sample_response": result,
+            }
+        )
+
+        # Store configuration
+        # TODO: Implement database
+
+        # Return success response
+        return {
+            "success": True,
+            "config_id": config_id,
+            "message": f"API call validated and stored successfully for '{name}'",
+            "sample_response": result,
+            "start_at": start_datetime.isoformat(),
+            "stop_at": stop_at.isoformat(),
+            "schedule_interval_minutes": schedule_interval_minutes,
+        }
+
+    except Exception as e:
+        return {
+            "success": False,
+            "message": f"Validation failed with error: {str(e)}",
+            "config_id": None,
+        }
+
+
+def setup_scheduler(config_id, mcp_api_key):
+    """
+    Set up periodic calling for a validated API configuration.
+
+    Parameters:
+    - config_id: The ID from validated configuration
+    - mcp_api_key: User's MCP API key for verification
+
+    Returns:
+    - Dictionary with success status and scheduling details
+
+    Example return:
+    {
+        "success": True,
+        "message": "Scheduler activated for 'NVDA Stock Price'",
+        "config_id": 123,
+        "schedule_interval_minutes": 20,
+        "stop_at": "2025-06-11T12:00:00Z",
+        "next_call_at": "2025-06-04T12:20:00Z"
+    }
+    """
+
+    return {
+        "success": False,
+        "message": "Function not implemented yet",
+        "config_id": config_id,
+    }
+
+
+if __name__ == "__main__":
+    # Example usage
+    response = validate_api_call(
+        mcp_api_key="your_api_key",
+        name="NVDA Stock Price",
+        description="Monitor the stock price of NVIDIA",
+        method="GET",
+        base_url="https://api.example.com",
+        endpoint="stocks/NVDA",
+        param_keys_values="",
+        header_keys_values="",
+        additional_params="{}",
+        schedule_interval_minutes=20,
+        stop_after_hours=24,
+        start_time=None,
+    )
+    print(response)

main.py

@@ -1,67 +1,92 @@
 import gradio as gr
 from apiCall import api_call
+from api_validator import validate_api_call, setup_scheduler
 
 
-demo = gr.Interface(
-    fn=api_call,
+def format_validation_result(result):
+    """Format validation result for display"""
+    if result["success"]:
+        return f"✅ Success!\n\nConfig ID: {result['config_id']}\nMessage: {result['message']}\n\nSample Response:\n{result.get('sample_response', 'No sample response')}"
+    else:
+        return f"❌ Failed!\n\nMessage: {result['message']}"
+
+
+def format_scheduler_result(result):
+    """Format scheduler result for display"""
+    if result["success"]:
+        return f"✅ Scheduler Active!\n\nConfig ID: {result['config_id']}\nMessage: {result['message']}\n\nSchedule Details:\n{result.get('schedule_interval_minutes', 'N/A')} minutes interval\nStops at: {result.get('stop_at', 'N/A')}"
+    else:
+        return f"❌ Scheduler Failed!\n\nMessage: {result['message']}"
+
+
+# API Validation Tab
+validation_tab = gr.Interface(
+    fn=lambda *args: format_validation_result(validate_api_call(*args)),
     inputs=[
-        gr.Radio(choices=["GET", "POST", "PUT", "DELETE"], label="Method", value="GET"),
         gr.Textbox(
-            label="Base URL",
-            placeholder="Enter base URL",
-            value="https://v2.xivapi.com/api",
+            label="MCP API Key", placeholder="Enter your MCP API key", type="password"
+        ),
+        gr.Textbox(
+            label="Monitoring Name", placeholder="e.g., 'NVDA Stock Price'", value=""
+        ),
+        gr.Textbox(
+            label="Description",
+            placeholder="What are you monitoring?",
+            value="",
+            lines=2,
         ),
-        gr.Textbox(label="Endpoint", placeholder="Enter endpoint", value="search"),
+        gr.Radio(choices=["GET", "POST", "PUT", "DELETE"], label="Method", value="GET"),
+        gr.Textbox(label="Base URL", placeholder="https://api.example.com", value=""),
+        gr.Textbox(label="Endpoint", placeholder="endpoint/path", value=""),
         gr.Textbox(
             label="Parameter Key-Value Pairs",
             placeholder="Enter one parameter per line in format 'key: value'",
-            value='query: Name~"popoto"\nsheets: Item\nfields: Name,Description\nlanguage: en\nlimit: 1',
-            lines=5,
+            value="",
         ),
         gr.Textbox(
             label="Header Key-Value Pairs",
             placeholder="Enter one header per line in format 'key: value'",
             value="",
-            lines=3,
         ),
         gr.Textbox(
             label="Additional Parameters (JSON)",
             placeholder="Enter any additional parameters as JSON",
             value="{}",
-            lines=3,
+        ),
+        gr.Number(
+            label="Schedule Interval (minutes)", value=20, minimum=1, maximum=1440
+        ),
+        gr.Number(label="Stop After (hours)", value=24, minimum=1, maximum=168),
+        gr.Textbox(
+            label="Start Time (optional)",
+            placeholder="YYYY-MM-DD HH:MM:SS or leave empty for immediate start",
+            value="",
         ),
     ],
-    outputs=gr.Textbox(label="API Response", lines=10),
-    title="Universal API Client",
-    description="Make API calls to any endpoint with custom parameters and headers. \n\n- **Method**: Choose the appropriate HTTP method for your request \n- **Base URL**: Enter the full API base URL (e.g., 'https://api.example.com') \n- **Endpoint**: The specific endpoint to call (without leading slash) \n- **Parameter Key-Value Pairs**: Format as 'key: value' with each pair on a new line \n  Example: \n```\nquery: search term\nlimit: 10\nfilter: active\n``` \n- **Header Key-Value Pairs**: Format as 'key: value' with each pair on a new line \n  Example: \n```\nx-api-key: your_api_key\ncontent-type: application/json\n``` \n- **Additional Parameters**: Use valid JSON format for nested or complex parameters",
-    flagging_mode="manual",
-    flagging_options=["Invalid Request", "API Error", "Other"],
-    examples=[
-        [
-            "GET",
-            "https://v2.xivapi.com/api",
-            "search",
-            'query: Name~"popoto"\nsheets: Item\nfields: Name,Description\nlanguage: en\nlimit: 1',
-            "",
-            "{}",
-        ],
-        [
-            "GET",
-            "https://api.github.com",
-            "repos/microsoft/TypeScript/issues",
-            "state: open\nper_page: 5",
-            "Accept: application/vnd.github.v3+json",
-            "{}",
-        ],
-        [
-            "POST",
-            "https://api.anthropic.com",
-            "v1/messages",
-            "model: claude-opus-4-20250514\nmax_tokens: 1024",
-            "x-api-key: your_api_key_here\nanthropic-version: 2023-06-01\ncontent-type: application/json",
-            '{"messages": [{"role": "user", "content": "Hello there!"}]}',
-        ],
+    outputs=gr.Textbox(label="Validation Result", lines=10),
+    title="API Validation & Storage",
+    description="Validate your API configuration and store it for scheduled monitoring. Max monitoring period is 1 week (168 hours).",
+)
+
+# Scheduler Setup Tab
+scheduler_tab = gr.Interface(
+    fn=lambda *args: format_scheduler_result(setup_scheduler(*args)),
+    inputs=[
+        gr.Number(label="Config ID (from validation step)", value=None),
+        gr.Textbox(
+            label="MCP API Key", placeholder="Enter your MCP API key", type="password"
+        ),
     ],
+    outputs=gr.Textbox(label="Scheduler Result", lines=8),
+    title="Scheduler Setup",
+    description="Activate scheduled monitoring for a validated API configuration.",
+)
+
+# Create tabbed interface
+demo = gr.TabbedInterface(
+    [validation_tab, scheduler_tab],
+    ["Validate & Store", "Activate Scheduler"],
+    title="MCP API Monitoring System",
 )
 
 if __name__ == "__main__":