(feature) Submissions can be completed

This adds a new `POST /v1/submissions/:submission_id/complete` endpoint
that changes a submission's status to `completed`.

It does some basic checks that the submission is valid before allowing
this to happen.

Author: leeky

app/controllers/v1/submissions_controller.rb

@@ -45,8 +45,23 @@ def calculate
     head :no_content
   end
 
+  def complete
+    submission = Submission.find(params[:id])
+    complete_submission!(submission)
+
+    if submission.save
+      head :no_content
+    else
+      render jsonapi_errors: submission.errors, status: :bad_request
+    end
+  end
+
   private
 
+  def complete_submission!(submission)
+    SubmissionCompletion.new(submission).perform!
+  end
+
   def create_submission_params
     params.require(:submission).permit(:task_id)
   end

app/models/submission.rb

@@ -18,5 +18,9 @@ class Submission < ApplicationRecord
     event :ready_for_review do
       transitions from: %i[pending processing], to: :in_review
     end
+
+    event :reviewed_and_accepted do
+      transitions from: :in_review, to: :completed
+    end
   end
 end

app/models/submission_completion.rb

@@ -0,0 +1,24 @@
+class SubmissionCompletion
+  attr_reader :submission
+
+  def initialize(submission)
+    @submission = submission
+  end
+
+  def perform!
+    return unless all_entries_valid?
+
+    Task.transaction do
+      Submission.transaction do
+        submission.reviewed_and_accepted!
+        submission.task.completed!
+      end
+    end
+  end
+
+  private
+
+  def all_entries_valid?
+    submission.entries.validated.count == submission.entries.count
+  end
+end

config/routes.rb

@@ -10,6 +10,7 @@
     resources :submissions, only: %i[show create update] do
       member do
         post 'calculate', to: 'submissions#calculate'
+        post 'complete', to: 'submissions#complete'
       end
 
       resources :files, only: %i[create update show], controller: 'submission_files'

spec/factories/submission.rb

@@ -24,5 +24,14 @@
         create_list(:errored_submission_entry, 1, submission: submission)
       end
     end
+
+    factory :submission_with_unprocessed_entries do
+      aasm_state :processing
+
+      after(:create) do |submission, _evaluator|
+        create_list(:validated_submission_entry, 2, submission: submission)
+        create_list(:submission_entry, 1, submission: submission)
+      end
+    end
   end
 end

spec/models/submission_completion_spec.rb

@@ -0,0 +1,35 @@
+require 'rails_helper'
+
+RSpec.describe SubmissionCompletion do
+  describe '#perform' do
+    let(:complete_submission) { SubmissionCompletion.new(submission) }
+
+    context 'given an "in review" submission' do
+      context 'with validated entries' do
+        let(:submission) { FactoryBot.create(:submission_with_validated_entries, aasm_state: 'in_review') }
+
+        it 'transitions the submission to completed' do
+          complete_submission.perform!
+
+          expect(submission).to be_completed
+        end
+      end
+
+      context 'with some invalid entries' do
+        let(:submission) { FactoryBot.create(:submission_with_invalid_entries) }
+
+        it 'leaves the submission in the "in_review" state' do
+          expect { complete_submission.perform! }.not_to change { submission.aasm_state }
+        end
+      end
+    end
+
+    context 'given a "processing" submission' do
+      let(:submission) { FactoryBot.create(:submission_with_unprocessed_entries, aasm_state: :processing) }
+
+      it 'leaves the submission in its current state' do
+        expect { complete_submission.perform! }.not_to change { submission.aasm_state }
+      end
+    end
+  end
+end

spec/requests/v1/submissions_spec.rb

@@ -241,4 +241,21 @@
       expect(response).to have_http_status(:no_content)
     end
   end
+
+  describe 'POST /submissions/:submission_id/complete' do
+    it 'marks the submission as complete' do
+      submission = FactoryBot.create(
+        :submission_with_validated_entries,
+        aasm_state: :in_review
+      )
+
+      post "/v1/submissions/#{submission.id}/complete"
+
+      expect(response).to be_successful
+
+      submission.reload
+
+      expect(submission).to be_completed
+    end
+  end
 end