Refactor

Author: nichtich

app.py

@@ -1,4 +1,3 @@
-import sys
 from flask import Flask, jsonify, render_template, request
 from waitress import serve
 from lib import ValidationService
@@ -52,9 +51,7 @@ def get_profiles():
 
 @app.route('/<profile>/validate', methods=['GET', 'POST'])
 def validate(profile):
-    try:
-        service.profile(profile)
-    except Exception:
+    if not service.has(profile):
         raise NotFound(f"Profile not found: {profile}")
 
     if request.method == 'GET':

lib/service.py

@@ -26,11 +26,11 @@ def __init__(self, **config):
 
         self.validator = Validator(**config)
 
-    def profiles(self):
-        return self.validator.profiles_metadata()
+    def profiles(self) -> list:
+        return list(self.validator.profiles.values())
 
-    def profile(self, id):
-        return self.validator.profile(id)
+    def has(self, profile) -> bool:
+        return profile in self.validator.profiles
 
     def validate(self, profile, data=None, url=None, file=None):
 

lib/validate/validator.py

@@ -8,33 +8,58 @@
 schema = json.load((Path(__file__).parent / 'profiles-schema.json').open())
 
 
+class Check(object):
+    def __init__(self, config):
+        if type(config) == str:
+            match config:
+                case "json":
+                    self.method = parseJSON
+                case "xml":
+                    self.method = parseXML
+                case _:
+                    # TODO: allow to reference another profile
+                    raise Exception(f"Unknown check: {config}")
+        elif "schema" in config and "language" in config:
+            match config["language"]:
+                case "xsd":
+                    pass  # TODO: load as local file or from URL with cache
+                case "jsonschema":
+                    pass  # TODO
+                case _:
+                    raise Exception(f"Unsupported schema language: {config['language']}")
+
+        else:
+            raise Exception(f"Unkown check: {json.dumps(config)}")
+
+    def execute(self, data):
+        self.method(data)
+
+
 class Validator(object):
     def __init__(self, profiles, **config):
         validateJSON(profiles, schema)
 
-        # TODO: check if id is unique
-        self.profiles = dict([(p["id"], p) for p in profiles])
-        # TODO: compile checks of profiles
+        checks = {p["id"]: p.get("checks", []) for p in profiles}
+        if len(checks) != len(profiles):
+            raise ValueError("Profiles must have unique ids")
 
-        # self.reports = config.get('reports', None)
+        self.profiles = {}
+        for p in profiles:
+            id = p["id"]
 
-    def profile(self, id):
-        "Returns public metadata of a profile or None."
-        p = self.profiles[id]
-        fields = ['id', 'title', 'description', 'url']
-        return {key: p[key] for key in fields if key in p}
+            # TODO: support reference to profile as check
+            checks[id] = [Check(c) for c in checks[id]]
 
-    def profiles_metadata(self):
-        "List of profiles reduced to their their public metadata"
-        return [self.profile(id) for id in self.profiles]
+            about = ['id', 'title', 'description', 'url']
+            self.profiles[id] = {key: p[key] for key in about if p.get(key, False)}
+
+        self.checks = checks
+
+    def profile(self, id) -> dict:
+        return self.profiles[id]
 
     def execute(self, profile, data=None, file=None):
         if file:
             data = Path(file).read_bytes()
-
-        checks = self.profiles[profile]['checks']
-        for check in checks:
-            if check == "json":
-                parseJSON(data)
-            elif check == "xml":
-                parseXML(data)
+        for check in self.checks[profile]:
+            check.execute(data)

tests/test_api.py

@@ -2,7 +2,6 @@
 import tempfile
 from pathlib import Path
 import io
-import json
 from app import app, init