e2xauthoring 0.2.0.dev0__tar.gz → 0.2.0.dev2__tar.gz

{e2xauthoring-0.2.0.dev0 → e2xauthoring-0.2.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: e2xauthoring
-Version: 0.2.0.dev0
+Version: 0.2.0.dev2
 Summary: Authoring app for e2xgrader
 Project-URL: Source, https://github.com/Digiklausur/e2xauthoring
 Author-email: Tim Metzler <tim.metzler@h-brs.de>

e2xauthoring-0.2.0.dev2/e2xauthoring/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.2.0-dev2"

e2xauthoring-0.2.0.dev2/e2xauthoring/app/handlers/apihandlers.py

@@ -0,0 +1,129 @@
+import json
+
+from e2xcore.handlers import E2xApiHandler
+from e2xcore.utils import urljoin
+from jupyter_client.kernelspec import KernelSpecManager
+from nbgrader.server_extensions.formgrader.base import check_xsrf
+from tornado import web
+
+from ...managers import (
+    AssignmentManager,
+    PresetManager,
+    TaskManager,
+    TaskPoolManager,
+    TemplateManager,
+    WorksheetManager,
+)
+from ...utils.gitutils import get_author, set_author
+from .base import ApiManageHandler
+
+
+class KernelSpecHandler(E2xApiHandler):
+    @web.authenticated
+    @check_xsrf
+    def get(self):
+        self.write(json.dumps(KernelSpecManager().get_all_specs()))
+
+
+class GitAuthorHandler(E2xApiHandler):
+    @web.authenticated
+    @check_xsrf
+    def get(self):
+        self.write(json.dumps(get_author()))
+
+    @web.authenticated
+    @check_xsrf
+    def post(self):
+        data = self.get_json_body()
+        name = data.get("name")
+        email = data.get("email")
+        self.write(json.dumps(set_author(name=name, email=email)))
+
+
+api_url = urljoin("e2x", "authoring", "api")
+name_regex = r"(?P<name>[^/]+)"
+assignment_regex = r"(?P<assignment>[^/]+)"
+default_handlers = [
+    (
+        urljoin(api_url, "assignments", "?"),
+        ApiManageHandler,
+        dict(
+            manager_cls=AssignmentManager,
+            actions=dict(
+                get=dict(actions=["list"]),
+            ),
+        ),
+    ),
+    (
+        urljoin(api_url, "worksheets", "?"),
+        ApiManageHandler,
+        dict(
+            manager_cls=WorksheetManager,
+            actions=dict(
+                get=dict(actions=["get", "list"]),
+                delete=dict(default="remove", actions=["remove"]),
+                post=dict(default="create", actions=["create"]),
+            ),
+        ),
+    ),
+    (
+        urljoin(api_url, "tasks", "?"),
+        ApiManageHandler,
+        dict(
+            manager_cls=TaskManager,
+            actions=dict(
+                delete=dict(default="remove", actions=["remove"]),
+                get=dict(
+                    default="get", actions=["get", "list", "list_all", "git_diff"]
+                ),
+                post=dict(default="create", actions=["create"]),
+                put=dict(actions=["copy", "rename", "commit"]),
+            ),
+        ),
+    ),
+    (
+        urljoin(api_url, "templates", "?"),
+        ApiManageHandler,
+        dict(
+            manager_cls=TemplateManager,
+            actions=dict(
+                delete=dict(default="remove", actions=["remove"]),
+                get=dict(default="get", actions=["get", "list", "list_variables"]),
+                post=dict(default="create", actions=["create"]),
+                put=dict(actions=["copy", "rename"]),
+            ),
+        ),
+    ),
+    (
+        urljoin(api_url, "pools", "?"),
+        ApiManageHandler,
+        dict(
+            manager_cls=TaskPoolManager,
+            actions=dict(
+                delete=dict(default="remove", actions=["remove"]),
+                get=dict(default="get", actions=["get", "list"]),
+                post=dict(default="create", actions=["create"]),
+                put=dict(actions=["copy", "rename", "turn_into_repository"]),
+            ),
+        ),
+    ),
+    (
+        urljoin(api_url, "presets", "?"),
+        ApiManageHandler,
+        dict(
+            manager_cls=PresetManager,
+            actions=dict(
+                get=dict(
+                    actions=[
+                        "list_question_presets",
+                        "list_template_presets",
+                        "get_question_preset",
+                        "get_template_preset",
+                    ]
+                )
+            ),
+        ),
+    ),
+    (urljoin(api_url, "kernelspec"), KernelSpecHandler),
+    (urljoin(api_url, "git", "author"), GitAuthorHandler),
+]

e2xauthoring-0.2.0.dev2/e2xauthoring/app/handlers/base.py

@@ -0,0 +1,102 @@
+import inspect
+from typing import List
+
+from e2xcore.handlers import E2xApiHandler
+from nbgrader.server_extensions.formgrader.base import check_xsrf
+from tornado import web
+
+from e2xauthoring.managers.dataclasses import ErrorMessage, SuccessMessage
+
+
+def status_msg(method):
+    """Decorates a method of a BaseApiManager
+    Wraps the response in a status message (ErrorMessage or SuccessMessage)
+    and catches exceptions.
+
+    Args:
+        method: The method to decorate
+    """
+
+    def wrapper(*args, **kwargs):
+        try:
+            res = method(*args, **kwargs)
+            return SuccessMessage(data=res)
+        except Exception as e:
+            return ErrorMessage(error=getattr(e, "message", str(e)))
+
+    return wrapper
+
+
+class ApiManageHandler(E2xApiHandler):
+    def initialize(self, manager_cls, actions) -> None:
+        self.__manager = manager_cls(self.coursedir)
+        self.__allowed_actions = {
+            request_type: dict(default=None, actions=[])
+            for request_type in ["delete", "get", "post", "put"]
+        }
+        self.set_allowed_actions(actions)
+
+    def set_allowed_actions(self, allowed_actions):
+        for request_type, action_dict in self.__allowed_actions.items():
+            if request_type in allowed_actions:
+                actions = allowed_actions[request_type].get("actions", [])
+                for action in actions:
+                    assert hasattr(
+                        self.__manager, action
+                    ), f"The manager class does not provide an action called {action}."
+                action_dict["default"] = allowed_actions[request_type].get(
+                    "default", None
+                )
+                action_dict["actions"].extend(actions)
+
+    def extract_arguments(self, method: str):
+        params = dict()
+        json_body = self.get_json_body() or dict()
+        for arg in inspect.signature(method).parameters.keys():
+            argument = self.get_argument(name=arg, default=None)
+            if argument is None:
+                argument = json_body.get(arg, None)
+            params[arg] = argument
+        return params
+
+    def perform_action(self, action: str, allowed_actions: List[str]):
+        assert (
+            action is not None and action in allowed_actions
+        ), f"Action {action} is not a valid action."
+        method = getattr(self.__manager, action)
+        arguments = self.extract_arguments(method)
+        return method(**arguments)
+
+    @status_msg
+    def handle_request(self, request_type: str):
+        action = self.get_argument(
+            "action", default=None  # self.__allowed_actions[request_type]["default"]
+        )
+        if action is None:
+            action = (self.get_json_body() or dict()).get(
+                "action", self.__allowed_actions[request_type]["default"]
+            )
+
+        return self.perform_action(
+            action, self.__allowed_actions[request_type]["actions"]
+        )
+
+    @web.authenticated
+    @check_xsrf
+    def get(self):
+        self.finish(self.handle_request("get").json())
+
+    @web.authenticated
+    @check_xsrf
+    def delete(self):
+        self.finish(self.handle_request("delete").json())
+
+    @web.authenticated
+    @check_xsrf
+    def put(self):
+        self.finish(self.handle_request("put").json())
+
+    @web.authenticated
+    @check_xsrf
+    def post(self):
+        self.finish(self.handle_request("post").json())

e2xauthoring-0.2.0.dev2/e2xauthoring/app/templates/authoring/asset-manifest.json

@@ -0,0 +1,10 @@
+{
+  "files": {
+    "main.js": "/e2x/authoring/static/js/main.1e6f65c1.js",
+    "index.html": "/e2x/authoring/index.html",
+    "main.1e6f65c1.js.map": "/e2x/authoring/static/js/main.1e6f65c1.js.map"
+  },
+  "entrypoints": [
+    "static/js/main.1e6f65c1.js"
+  ]
+}

e2xauthoring-0.2.0.dev2/e2xauthoring/app/templates/authoring/index.html

@@ -0,0 +1 @@
+<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>e²xgrader - Authoring</title><script type="text/javascript">window.base_url="{{ base_url }}",window.url_prefix="{{ url_prefix }}",window.webpackstuff="/e2x/authoring/static/js/main.1e6f65c1.js"</script><script defer="defer" src="{{base_url}}/e2x/authoring/static/js/main.1e6f65c1.js"></script>{%- block head -%} {%- endblock -%}</head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>