changing route structure to be one route per status

Author: loiswells97

app/controllers/api/school_projects_controller.rb

@@ -10,9 +10,42 @@ def show_status
       render :show_status, formats: [:json], status: :ok
     end
 
-    def set_status
-      authorize! :set_status, school_project
-      result = SchoolProject::SetStatus.call(school_project:, status: params[:status], user_id: current_user.id)
+    def unsubmit
+      authorize! :unsubmit, school_project
+      result = SchoolProject::SetStatus.call(school_project:, status: 'unsubmitted', user_id: current_user.id)
+      if result.success?
+        @school_project = result[:school_project]
+        render :show_status, formats: [:json], status: :ok
+      else
+        render json: { error: result[:error] }, status: :unprocessable_entity
+      end
+    end
+
+    def submit
+      authorize! :submit, school_project
+      result = SchoolProject::SetStatus.call(school_project:, status: 'submitted', user_id: current_user.id)
+      if result.success?
+        @school_project = result[:school_project]
+        render :show_status, formats: [:json], status: :ok
+      else
+        render json: { error: result[:error] }, status: :unprocessable_entity
+      end
+    end
+
+    def return
+      authorize! :return, school_project
+      result = SchoolProject::SetStatus.call(school_project:, status: 'returned', user_id: current_user.id)
+      if result.success?
+        @school_project = result[:school_project]
+        render :show_status, formats: [:json], status: :ok
+      else
+        render json: { error: result[:error] }, status: :unprocessable_entity
+      end
+    end
+
+    def complete
+      authorize! :complete, school_project
+      result = SchoolProject::SetStatus.call(school_project:, status: 'complete', user_id: current_user.id)
       if result.success?
         @school_project = result[:school_project]
         render :show_status, formats: [:json], status: :ok

app/models/ability.rb

@@ -96,7 +96,7 @@ def define_school_teacher_abilities(user:, school:)
       )
     ).pluck(:id)
     can(%i[read], Project, remixed_from_id: teacher_project_ids)
-    can(%i[show_status set_status], SchoolProject, project: { remixed_from_id: teacher_project_ids })
+    can(%i[show_status unsubmit return complete], SchoolProject, project: { remixed_from_id: teacher_project_ids })
     can(%i[read create], Feedback, school_project: { project: { remixed_from_id: teacher_project_ids } })
   end
 
@@ -114,7 +114,7 @@ def define_school_student_abilities(user:, school:)
     can(%i[read create update], Project, school_id: school.id, user_id: user.id, lesson_id: nil, remixed_from_id: visible_lesson_project_ids)
     can(%i[read show_context], Project, lesson: { school_id: school.id, visibility: 'students', school_class: { students: { student_id: user.id } } })
     can(%i[read], Feedback, school_project: { project: { school_id: school.id, user_id: user.id, lesson_id: nil, remixed_from_id: visible_lesson_project_ids } })
-    can(%i[show_finished set_finished show_status set_status], SchoolProject, project: { user_id: user.id, lesson_id: nil }, school_id: school.id)
+    can(%i[show_finished set_finished show_status unsubmit submit], SchoolProject, project: { user_id: user.id, lesson_id: nil }, school_id: school.id)
   end
 
   def define_experience_cs_admin_abilities(user)

config/routes.rb

@@ -39,7 +39,10 @@
       get :context, on: :member, to: 'projects#show_context'
       put :finished, on: :member, to: 'school_projects#set_finished'
       get :status, on: :member, to: 'school_projects#show_status'
-      put :status, on: :member, to: 'school_projects#set_status'
+      post :unsubmit, on: :member, to: 'school_projects#unsubmit'
+      post :submit, on: :member, to: 'school_projects#submit'
+      post :return, on: :member, to: 'school_projects#return'
+      post :complete, on: :member, to: 'school_projects#complete'
       resource :remix, only: %i[show create], controller: 'projects/remixes'
       resources :remixes, only: %i[index], controller: 'projects/remixes'
       resource :images, only: %i[show create], controller: 'projects/images'

spec/features/school_project/complete_spec.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'School project complete requests', type: :request do
+  let(:headers) { { Authorization: UserProfileMock::TOKEN } }
+  let(:school) { create(:school) }
+  let(:student) { create(:student, school:) }
+  let(:teacher) { create(:teacher, school:) }
+  let(:school_class) { create(:school_class, teacher_ids: [teacher.id], school:) }
+  let(:class_student) { create(:class_student, school_class:, student_id: student.id) }
+  let(:lesson) { create(:lesson, school:, school_class:, user_id: teacher.id) }
+  let(:teacher_project) { create(:project, user_id: teacher.id, school:, lesson:) }
+  let!(:student_project) { create(:project, school_id: school.id, lesson_id: nil, user_id: student.id, remixed_from_id: teacher_project.id, locale: nil, finished: false) }
+  let(:school_project_json) do
+    {
+      id: student_project.school_project.id,
+      school_id: student_project.school_project.school_id,
+      project_id: student_project.school_project.project_id,
+      status: student_project.school_project.status,
+      identifier: student_project.identifier
+    }.to_json
+  end
+
+  context 'when logged in as student' do
+    before do
+      authenticated_in_hydra_as(student)
+      post("/api/projects/#{student_project.identifier}/complete", headers:)
+    end
+
+    it 'completes forbidden response' do
+      expect(response).to have_http_status(:forbidden)
+    end
+
+    it 'does not change the status' do
+      expect(student_project.school_project).to be_unsubmitted
+    end
+  end
+
+  context 'when logged in as teacher' do
+    before do
+      authenticated_in_hydra_as(teacher)
+    end
+
+    context('when transition is valid') do
+      before do
+        student_project.school_project.transition_status_to!(:submitted, student.id)
+        post("/api/projects/#{student_project.identifier}/complete", headers:)
+      end
+
+      it 'completes success response' do
+        expect(response).to have_http_status(:ok)
+      end
+
+      it 'completes the school project json' do
+        expect(response.body).to eq(school_project_json)
+      end
+
+      it 'sets the status to complete' do
+        expect(student_project.school_project).to be_complete
+      end
+    end
+
+    context 'when attempting an invalid status transition' do
+      before do
+        student_project.school_project.transition_status_to!(:complete, student.id)
+        post("/api/projects/#{student_project.identifier}/complete", headers:)
+      end
+
+      it 'completes unauthorized response' do
+        expect(response).to have_http_status(:unprocessable_entity)
+      end
+
+      it 'completes error message' do
+        expect(JSON.parse(response.body)['error']).to eq("Cannot transition from 'complete' to 'complete'")
+      end
+    end
+  end
+
+  context 'when user does not own the project and is not the class teacher' do
+    let(:another_teacher) { create(:teacher, school:) }
+
+    before do
+      authenticated_in_hydra_as(another_teacher)
+      post("/api/projects/#{student_project.identifier}/complete", headers:)
+    end
+
+    it 'completes forbidden response' do
+      expect(response).to have_http_status(:forbidden)
+    end
+
+    it 'does not change the status' do
+      expect(student_project.school_project).to be_unsubmitted
+    end
+  end
+
+  context 'when project does not exist' do
+    before do
+      authenticated_in_hydra_as(student)
+      post('/api/projects/does-not-exist/complete', headers:)
+    end
+
+    it 'completes not found response' do
+      expect(response).to have_http_status(:not_found)
+    end
+  end
+end

spec/features/school_project/return_spec.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'School project return requests', type: :request do
+  let(:headers) { { Authorization: UserProfileMock::TOKEN } }
+  let(:school) { create(:school) }
+  let(:student) { create(:student, school:) }
+  let(:teacher) { create(:teacher, school:) }
+  let(:school_class) { create(:school_class, teacher_ids: [teacher.id], school:) }
+  let(:class_student) { create(:class_student, school_class:, student_id: student.id) }
+  let(:lesson) { create(:lesson, school:, school_class:, user_id: teacher.id) }
+  let(:teacher_project) { create(:project, user_id: teacher.id, school:, lesson:) }
+  let!(:student_project) { create(:project, school_id: school.id, lesson_id: nil, user_id: student.id, remixed_from_id: teacher_project.id, locale: nil, finished: false) }
+  let(:school_project_json) do
+    {
+      id: student_project.school_project.id,
+      school_id: student_project.school_project.school_id,
+      project_id: student_project.school_project.project_id,
+      status: student_project.school_project.status,
+      identifier: student_project.identifier
+    }.to_json
+  end
+
+  context 'when logged in as student' do
+    before do
+      authenticated_in_hydra_as(student)
+      post("/api/projects/#{student_project.identifier}/return", headers:)
+    end
+
+    it 'returns forbidden response' do
+      expect(response).to have_http_status(:forbidden)
+    end
+
+    it 'does not change the status' do
+      expect(student_project.school_project).to be_unsubmitted
+    end
+  end
+
+  context 'when logged in as teacher' do
+    before do
+      authenticated_in_hydra_as(teacher)
+    end
+
+    context('when transition is valid') do
+      before do
+        student_project.school_project.transition_status_to!(:submitted, student.id)
+        post("/api/projects/#{student_project.identifier}/return", headers:)
+      end
+
+      it 'returns success response' do
+        expect(response).to have_http_status(:ok)
+      end
+
+      it 'returns the school project json' do
+        expect(response.body).to eq(school_project_json)
+      end
+
+      it 'sets the status to returned' do
+        expect(student_project.school_project).to be_returned
+      end
+    end
+
+    context 'when attempting an invalid status transition' do
+      before do
+        post("/api/projects/#{student_project.identifier}/return", headers:)
+      end
+
+      it 'returns unauthorized response' do
+        expect(response).to have_http_status(:unprocessable_entity)
+      end
+
+      it 'returns error message' do
+        expect(JSON.parse(response.body)['error']).to eq("Cannot transition from 'unsubmitted' to 'returned'")
+      end
+
+      it 'does not change the status' do
+        expect(student_project.school_project).to be_unsubmitted
+      end
+    end
+  end
+
+  context 'when user does not own the project and is not the class teacher' do
+    let(:another_teacher) { create(:teacher, school:) }
+
+    before do
+      authenticated_in_hydra_as(another_teacher)
+      post("/api/projects/#{student_project.identifier}/return", headers:)
+    end
+
+    it 'returns forbidden response' do
+      expect(response).to have_http_status(:forbidden)
+    end
+
+    it 'does not change the status' do
+      expect(student_project.school_project).to be_unsubmitted
+    end
+  end
+
+  context 'when project does not exist' do
+    before do
+      authenticated_in_hydra_as(student)
+      post('/api/projects/does-not-exist/return', headers:)
+    end
+
+    it 'returns not found response' do
+      expect(response).to have_http_status(:not_found)
+    end
+  end
+end