Refactor 0.3.0

e2xauthoring/app/handlers/apihandlers.py

@@ -6,6 +6,7 @@
 from nbgrader.server_extensions.formgrader.base import check_xsrf
 from tornado import web
 
+from ...git import get_author, set_author
 from ...managers import (
     AssignmentManager,
     PresetManager,
@@ -14,7 +15,6 @@
     TemplateManager,
     WorksheetManager,
 )
-from ...utils.gitutils import get_author, set_author
 from .base import ApiManageHandler
 
 

e2xauthoring/app/handlers/base.py

@@ -6,7 +6,7 @@
 from nbgrader.server_extensions.formgrader.base import check_xsrf
 from tornado import web
 
-from e2xauthoring.managers.dataclasses import ErrorMessage, SuccessMessage
+from ...dataclasses import ErrorMessage, SuccessMessage
 
 
 def status_msg(method):
@@ -103,22 +103,22 @@ async def handle_request(self, request_type: str):
     @check_xsrf
     async def get(self):
         result = await self.handle_request("get")
-        self.finish(result.json())
+        self.finish(result.to_json())
 
     @web.authenticated
     @check_xsrf
     async def delete(self):
         result = await self.handle_request("delete")
-        self.finish(result.json())
+        self.finish(result.to_json())
 
     @web.authenticated
     @check_xsrf
     async def put(self):
         result = await self.handle_request("put")
-        self.finish(result.json())
+        self.finish(result.to_json())
 
     @web.authenticated
     @check_xsrf
     async def post(self):
         result = await self.handle_request("post")
-        self.finish(result.json())
+        self.finish(result.to_json())

e2xauthoring/dataclasses/__init__.py

@@ -0,0 +1,18 @@
+from .gitstatus import GitStatus
+from .jsondataclass import JSONDataClass
+from .messages import ErrorMessage, SuccessMessage
+from .pool import PoolCollectionRecord, PoolRecord
+from .task import TaskRecord
+from .template import TemplateCollectionRecord, TemplateRecord
+
+__all__ = [
+    "ErrorMessage",
+    "GitStatus",
+    "JSONDataClass",
+    "TaskRecord",
+    "PoolRecord",
+    "PoolCollectionRecord",
+    "SuccessMessage",
+    "TemplateRecord",
+    "TemplateCollectionRecord",
+]

e2xauthoring/dataclasses/gitstatus.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass, field
+from typing import List, Optional
+
+from .jsondataclass import JSONDataClass
+
+
+@dataclass
+class GitStatus(JSONDataClass):
+    untracked: Optional[List[str]] = field(default_factory=list)
+    unstaged: Optional[List[str]] = field(default_factory=list)
+    staged: Optional[List[str]] = field(default_factory=list)
+    status: Optional[str] = None

e2xauthoring/dataclasses/jsondataclass.py

@@ -0,0 +1,7 @@
+from dataclasses import asdict, dataclass
+
+
+@dataclass
+class JSONDataClass:
+    def to_json(self):
+        return asdict(self)

e2xauthoring/dataclasses/messages.py

@@ -0,0 +1,17 @@
+from dataclasses import dataclass
+from typing import Any
+
+from .jsondataclass import JSONDataClass
+
+
+@dataclass
+class SuccessMessage(JSONDataClass):
+    success: bool = True
+    message: str = ""
+    data: Any = None
+
+
+@dataclass
+class ErrorMessage(JSONDataClass):
+    success: bool = False
+    error: str = ""

e2xauthoring/dataclasses/pool.py

@@ -0,0 +1,19 @@
+from dataclasses import dataclass, field
+from typing import List
+
+from .jsondataclass import JSONDataClass
+from .task import TaskRecord
+
+
+@dataclass
+class PoolRecord(JSONDataClass):
+    name: str
+    base_path: str
+    n_tasks: int = 0
+    tasks: List[TaskRecord] = field(default_factory=list)
+    is_repo: bool = False
+
+
+@dataclass
+class PoolCollectionRecord(JSONDataClass):
+    pools: List[PoolRecord] = field(default_factory=list)

e2xauthoring/dataclasses/task.py

@@ -0,0 +1,13 @@
+from dataclasses import dataclass
+
+from .gitstatus import GitStatus
+from .jsondataclass import JSONDataClass
+
+
+@dataclass
+class TaskRecord(JSONDataClass):
+    name: str
+    pool: str
+    points: int
+    n_questions: int
+    git_status: GitStatus

e2xauthoring/dataclasses/template.py

@@ -0,0 +1,15 @@
+from dataclasses import dataclass, field
+from typing import List
+
+from .jsondataclass import JSONDataClass
+
+
+@dataclass
+class TemplateRecord(JSONDataClass):
+    name: str
+    variables: List[str]
+
+
+@dataclass
+class TemplateCollectionRecord(JSONDataClass):
+    templates: List[TemplateRecord] = field(default_factory=list)

e2xauthoring/git/__init__.py

@@ -0,0 +1,6 @@
+from .base import BaseRepo
+from .factory import GitRepoFactory
+from .gitrepo import GitRepo
+from .utils import get_author, set_author
+
+__all__ = ["BaseRepo", "GitRepo", "GitRepoFactory", "get_author", "set_author"]