Split general JSON schema formatting away from APIspec

Author: jtc42

src/labthings/apispec/__init__.py

@@ -0,0 +1,2 @@
+from .apispec import rule_to_apispec_path
+from .plugins import MarshmallowPlugin

src/labthings/spec/apispec.py renamed to src/labthings/apispec/apispec.py

@@ -1,5 +1,5 @@
 from apispec import APISpec
-from .paths import rule_to_path, rule_to_params
+from ..json.paths import rule_to_path, rule_to_params
 from .utilities import convert_to_schema_or_json
 
 from ..utilities import get_docstring, get_summary

src/labthings/spec/apispec_plugins.py renamed to src/labthings/apispec/converter.py

@@ -1,13 +1,9 @@
-from apispec.ext.marshmallow import (
-    MarshmallowPlugin as _MarshmallowPlugin,
-    OpenAPIConverter,
-)
+from apispec.ext.marshmallow import OpenAPIConverter
 from ..fields import Bytes as BytesField
 
 
 class ExtendedOpenAPIConverter(OpenAPIConverter):
     field_mapping = OpenAPIConverter.field_mapping
-    field_mapping.update({BytesField: ("string", None)})
 
     def init_attribute_functions(self, *args, **kwargs):
         OpenAPIConverter.init_attribute_functions(self, *args, **kwargs)
@@ -16,9 +12,5 @@ def init_attribute_functions(self, *args, **kwargs):
     def bytes2json(self, field, **kwargs):
         ret = {}
         if isinstance(field, BytesField):
-            ret.update({"contentEncoding": "base64"})
+            ret.update(BytesField()._jsonschema_type_mapping())
         return ret
-
-
-class MarshmallowPlugin(_MarshmallowPlugin):
-    Converter = ExtendedOpenAPIConverter

src/labthings/apispec/plugins.py

@@ -0,0 +1,6 @@
+from apispec.ext.marshmallow import MarshmallowPlugin as _MarshmallowPlugin
+from .converter import ExtendedOpenAPIConverter
+
+
+class MarshmallowPlugin(_MarshmallowPlugin):
+    Converter = ExtendedOpenAPIConverter

src/labthings/spec/utilities.py renamed to src/labthings/apispec/utilities.py

@@ -12,4 +12,3 @@
     snake_to_camel,
     path_relative_to,
 )
-

src/labthings/core/utilities.py

@@ -72,6 +72,9 @@
 
 
 class Bytes(Field):
+    def _jsonschema_type_mapping(self):
+        return {"type": "string", "contentEncoding": "base64"}
+
     def _validate(self, value):
         if not isinstance(value, bytes):
             raise ValidationError("Invalid input type.")

src/labthings/fields.py

@@ -0,0 +1,27 @@
+from flask import make_response, current_app
+
+# Flask JSON encoder so we get UUID, datetime etc support
+from flask.json import JSONEncoder
+from base64 import b64encode
+import json
+
+
+class LabThingsJSONEncoder(JSONEncoder):
+    """
+    A custom JSON encoder, with type conversions for PiCamera fractions, Numpy integers, and Numpy arrays
+    """
+
+    def default(self, o):
+        if isinstance(o, set):
+            return list(o)
+        if isinstance(o, bytes):
+            try:  # Try unicode
+                return o.decode()
+            except UnicodeDecodeError:  # Otherwise, base64
+                return b64encode(o).decode()
+        return JSONEncoder.default(self, o)
+
+
+def encode_json(data, encoder=LabThingsJSONEncoder, **settings):
+    """Makes JSON encoded data using the LabThings JSON encoder"""
+    return json.dumps(data, cls=encoder, **settings) + "\n"

src/labthings/json/__init__.py

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Stephen J. Fuhry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.