Rework index according to new API spec

Author: indocomsoft

lib/cadet/assessments/assessments.ex

@@ -9,6 +9,7 @@ defmodule Cadet.Assessments do
 
   alias Timex.Duration
 
+  alias Cadet.Assessments.Answer
   alias Cadet.Assessments.Assessment
   alias Cadet.Assessments.Question
   alias Cadet.Assessments.Submission
@@ -116,10 +117,35 @@ defmodule Cadet.Assessments do
     Repo.delete(question)
   end
 
-  def all_submissions(grader_id: grader_id) do
-    Submission
-    |> where(grader_id: ^grader_id)
-    |> Repo.all()
+  @spec get_submission_xp(String.t() | integer()) :: number()
+  def get_submission_xp(id) when is_binary(id) or is_integer(id) do
+    Answer
+    |> where(submission_id: ^id)
+    |> Repo.aggregate(:sum, :marks)
+  end
+
+  def all_submissions_by_grader(grader, preload \\ true)
+
+  @spec all_submissions_by_grader(String.t() | integer(), boolean()) :: Submission.t()
+  def all_submissions_by_grader(grader_id, preload)
+      when is_binary(grader_id) or is_integer(grader_id) do
+    submissions =
+      Submission
+      |> where(grader_id: ^grader_id)
+      |> Repo.all()
+
+    if preload do
+      submissions
+      |> Repo.preload([:assessment, :student])
+      |> Enum.map(&Map.put(&1, :xp, get_submission_xp(&1.id)))
+    else
+      submissions
+    end
+  end
+
+  @spec all_submissions_by_grader(Cadet.Accounts.User.t(), boolean()) :: Submission.t()
+  def all_submissions_by_grader(%Cadet.Accounts.User{id: id, role: :staff}, preload) do
+    all_submissions_by_grader(id, preload)
   end
 
   # TODO: Decide what to do with these methods

lib/cadet_web/controllers/grading_controller.ex

@@ -10,7 +10,7 @@ defmodule CadetWeb.GradingController do
 
     case user.role do
       :staff ->
-        submissions = Assessments.all_submissions(grader_id: user.id)
+        submissions = Assessments.all_submissions_by_grader(user)
         render(conn, "index.json", submissions: submissions)
 
       _ ->
@@ -87,8 +87,30 @@ defmodule CadetWeb.GradingController do
         swagger_schema do
           properties do
             submissionId(:integer, "submission id", required: true)
-            assessmentId(:integer, "assessment id", required: true)
-            studentId(:integer, "student id", required: true)
+            xp(:integer, "xp given")
+            graded(:boolean, "whether this submission has been graded", required: true)
+            assessment(Schema.ref(:AssessmentInfo))
+            student(Schema.ref(:StudentInfo))
+          end
+        end,
+      AssessmentInfo:
+        swagger_schema do
+          properties do
+            id(:integer, "assessment id", required: true)
+            type(:string, "Either mission/sidequest/path/contest", required: true)
+
+            max_xp(
+              :integer,
+              "The max amount of XP to be earned from this assessment",
+              required: true
+            )
+          end
+        end,
+      StudentInfo:
+        swagger_schema do
+          properties do
+            id(:integer, "student id", required: true)
+            name(:string, "student name", required: true)
           end
         end,
       GradingInfo:

lib/cadet_web/views/grading_view.ex

@@ -7,9 +7,18 @@ defmodule CadetWeb.GradingView do
 
   def render("submission.json", %{submission: submission}) do
     %{
+      xp: submission.xp,
       submissionId: submission.id,
-      missionId: submission.assessment_id,
-      studentId: submission.student_id
+      student: %{
+        name: submission.student.name,
+        id: submission.student.id
+      },
+      graded: submission.status == :graded,
+      assessment: %{
+        type: submission.assessment.category,
+        max_xp: submission.assessment.max_xp,
+        id: submission.assessment.id
+      }
     }
   end
 end