Added specific API schema example plugin

openflexure_microscope/plugins/testing/schema_example/__init__.py

@@ -0,0 +1,2 @@
+from .plugin import ExamplePlugin
+from . import api

openflexure_microscope/plugins/testing/schema_example/api.py

@@ -0,0 +1,40 @@
+from openflexure_microscope.api.utilities import JsonPayload
+from openflexure_microscope.api.v1.views import MicroscopeViewPlugin
+from openflexure_microscope.exceptions import TaskDeniedException
+
+from flask import request, Response, escape, jsonify
+
+class DoAPI(MicroscopeViewPlugin):
+    """
+    A simple example API plugin
+    """
+
+    def get(self):
+        return jsonify(self.plugin.get_values_dict())
+
+    def post(self):
+        # Get payload JSON
+        payload = JsonPayload(request)
+
+        # Extract a values from the JSON payload.
+        val_int = payload.param('val_int', default=None, convert=int)
+        val_str = payload.param('val_str', default=None, convert=str)
+        val_radio = payload.param('val_radio', default=None)
+        val_check = payload.param('val_check', default=None)
+        val_select = payload.param('val_select', default=None)
+        val_disposable = payload.param('val_disposable', default=None)
+
+        self.plugin.set_values(
+            val_int,
+            val_str,
+            val_radio,
+            val_check,
+            val_select,
+            val_disposable
+        )
+
+        print(self.plugin.get_values_dict())
+
+        return jsonify({
+            'response': 'completed'
+        })

openflexure_microscope/plugins/testing/schema_example/plugin.py

@@ -0,0 +1,60 @@
+import random
+import time
+import os
+import json
+from openflexure_microscope.plugins import MicroscopePlugin
+
+from .api import DoAPI
+
+HERE = os.path.dirname(os.path.realpath(__file__))
+SCHEMA_PATH = os.path.join(HERE, "schema.json")
+
+class ExamplePlugin(MicroscopePlugin):
+    """
+    An example plugin using a comprehensive schema
+    """
+    global SCHEMA_PATH
+
+    with open(SCHEMA_PATH, 'r') as sc:
+        api_schema = json.load(sc)
+
+    api_views = {
+        '/do': DoAPI,
+    }
+
+    def __init__(self):
+        self.val_int = 10
+        self.val_str = "Hello"
+        self.val_radio = "First"
+        self.val_check = ["Foo", "Bar"]
+        self.val_select = "Most"
+        self.val_unused = "I'm an unused string, here to confuse the form parsing"
+
+    def set_values(self, val_int, val_str, val_radio, val_check, val_select, val_disposable):
+        """
+        Demonstrate a plugin with schema
+        """
+        if val_int:
+            self.val_int = int(val_int)
+        if val_str:
+            self.val_str = str(val_str)
+        if val_radio:
+            self.val_radio = val_radio
+        if val_check is not None:
+            print(val_check)
+            self.val_check = val_check if (type(val_check) is list) else [val_check]
+        if val_select:
+            self.val_select = val_select
+
+        if val_disposable:
+            print("DISPOSABLE VALUE: {}".format(val_disposable))
+
+    def get_values_dict(self):
+        return {
+            'val_int': self.val_int,
+            'val_str': self.val_str,
+            'val_radio': self.val_radio,
+            'val_check': self.val_check,
+            'val_select': self.val_select,
+            'val_unused': self.val_unused
+        }

openflexure_microscope/plugins/testing/schema_example/schema.json

@@ -0,0 +1,61 @@
+{
+  "id": "test-plugin",
+  "forms": [
+    {
+      "route": "/do",
+      "submitLabel": "Do things",
+      "selfUpdate": true,
+      "schema": [
+        {
+          "fieldType": "htmlBlock",
+          "name": "heading",
+          "content": "<b>This is a plugin!</b>"
+        },
+        [
+          {
+            "fieldType": "numberInput",
+            "placeholder": "Some integer",
+            "name": "val_int",
+            "label": "Number value",
+            "minValue": 0
+          },
+          {
+            "fieldType": "textInput",
+            "placeholder": "Some string",
+            "label": "String value",
+            "name": "val_str"
+          }
+        ],
+        [
+          {
+            "fieldType": "radioList",
+            "name": "val_radio",
+            "label": "Radio value",
+            "options": ["First", "Second", "Third"]
+          },
+          {
+            "fieldType": "checkList",
+            "name": "val_check",
+            "label": "Checklist values",
+            "options": ["Foo", "Bar", "Baz"]
+          }
+        ],
+
+        {
+          "fieldType": "selectList",
+          "name": "val_select",
+          "multi": false,
+          "label": "Some selection",
+          "options": ["Most", "Average", "Least"]
+        },
+
+        {
+          "fieldType": "textInput",
+          "placeholder": "Some string",
+          "label": "Non-persistent string",
+          "name": "val_disposable"
+        }
+      ]
+    }
+  ] 
+}