submissions bulk grading api

test plan:
* see the API documentation for the new action
 "Grade multiple submissions"

closes #CNVS-17674

Change-Id: I3912d78ad64108a5a819585cfdfcc35dd27448b3
Reviewed-on: https://gerrit.instructure.com/46429
Reviewed-by: Jeremy Stanley <jeremy@instructure.com>
Product-Review: Jeremy Stanley <jeremy@instructure.com>
Tested-by: Jenkins <jenkins@instructure.com>
QA-Review: Clare Strong <clare@instructure.com>

Author: maneframe

app/controllers/submissions_api_controller.rb

@@ -138,8 +138,9 @@
 #
 class SubmissionsApiController < ApplicationController
   before_filter :get_course_from_section, :require_context
-  batch_jobs_in_actions :only => :update, :batch => { :priority => Delayed::LOW_PRIORITY }
+  batch_jobs_in_actions :only => [:update], :batch => { :priority => Delayed::LOW_PRIORITY }
 
+  include Api::V1::Progress
   include Api::V1::Submission
 
   # @API List assignment submissions
@@ -654,6 +655,47 @@ def update
     end
   end
 
+  # @API Grade multiple submissions for an assignment
+  #
+  # Update the grading for multiple student's assignment submissions in
+  # an asynchronous job.
+  #
+  # The user must have permission to manage grades in the appropriate context
+  # (course or section).
+  #
+  # @argument grade_data[<student_id>][posted_grade] [String]
+  #   See documentation for the posted_grade argument in the
+  #   {api:SubmissionsApiController#update Submissions Update} documentation
+  #
+  # @argument grade_data[<student_id>][rubric_assessment] [RubricAssessment]
+  #   See documentation for the rubric_assessment argument in the
+  #   {api:SubmissionsApiController#update Submissions Update} documentation
+  #
+  # @example_request
+  #
+  #   curl 'https://<canvas>/api/v1/courses/1/assignments/2/submissions/update_grades' \
+  #        -X POST \
+  #        -F 'grade_data[3][posted_grade]=88' \
+  #        -F 'grade_data[4][posted_grade]=95' \
+  #        -H "Authorization: Bearer <token>"
+  #
+  # @returns Progress
+  def bulk_update
+    @assignment = @context.assignments.active.find(params[:assignment_id])
+
+    unless @assignment.published? && @context.grants_right?(@current_user, session, :manage_grades)
+      return render_unauthorized_action
+    end
+
+    grade_data = params[:grade_data]
+    unless grade_data.is_a?(Hash) && grade_data.present?
+      return render :json => "'grade_data' parameter required", :status => :bad_request
+    end
+
+    progress = Submission.queue_bulk_update(@context, @section, @assignment, @current_user, grade_data)
+    render :json => progress_json(progress, @current_user, session)
+  end
+
   # @API Mark submission as read
   #
   # No request fields are necessary.

app/models/progress.rb

@@ -22,7 +22,7 @@ class Progress < ActiveRecord::Base
 
   belongs_to :context, :polymorphic => true
   validates_inclusion_of :context_type, :allow_nil => true, :in => ['ContentMigration', 'Course', 'User',
-    'Quizzes::QuizStatistics', 'Account', 'GroupCategory', 'ContentExport']
+    'Quizzes::QuizStatistics', 'Account', 'GroupCategory', 'ContentExport', 'Assignment']
   belongs_to :user
   attr_accessible :context, :tag, :completion, :message
 
@@ -97,6 +97,9 @@ def perform
     end
 
     def on_permanent_failure(error)
+      error_report = ErrorReport.log_exception("Progress::Work", error)
+      @progress.message = "Unexpected error, ID: #{error_report.id rescue "unknown"}"
+      @progress.save
       @progress.fail
     end
   end

app/models/submission.rb

@@ -1200,4 +1200,60 @@ def muted_assignment?
   def without_graded_submission?
     !self.has_submission? && !self.graded?
   end
+
+  def self.queue_bulk_update(context, section, assignment, grader, grade_data)
+    progress = Progress.create!(:context => assignment, :tag => "submissions_update")
+    progress.process_job(self, :process_bulk_update, {}, context, section, assignment, grader, grade_data)
+    progress
+  end
+
+  def self.process_bulk_update(progress, context, section, assignment, grader, grade_data)
+    missing_ids = []
+
+    scope = assignment.students_with_visibility(context.students_visible_to(grader))
+    if section
+      scope = scope.where(:enrollments => { :course_section_id => section })
+    end
+
+    preloaded_users = scope.where(:id => grade_data.map{|id, data| id})
+
+    Delayed::Batch.serial_batch(:priority => Delayed::LOW_PRIORITY) do
+      grade_data.each do |user_id, user_data|
+
+        user = preloaded_users.detect{|u| u.global_id == Shard.global_id_for(user_id)}
+        if !user && (params = Api.sis_find_params_for_collection(scope, [user_id], context.root_account)) && params != :not_found
+          params[:limit] = 1
+          user = scope.all(params).first
+        end
+        unless user
+          missing_ids << user_id
+          next
+        end
+
+        if grade = user_data[:posted_grade]
+          submissions = assignment.grade_student(user, { :grader => grader, :grade => grade})
+          submission = submissions.first
+        else
+          submission = assignment.find_or_create_submission(user)
+        end
+
+        assessment = user_data[:rubric_assessment]
+        if assessment.is_a?(Hash) && assignment.rubric_association
+          # prepend each key with "criterion_", which is required by the current
+          # RubricAssociation#assess code.
+          assessment.keys.each do |crit_name|
+            assessment["criterion_#{crit_name}"] = assessment.delete(crit_name)
+          end
+          assignment.rubric_association.assess(
+            :assessor => grader, :user => user, :artifact => submission,
+            :assessment => assessment.merge(:assessment_type => 'grading'))
+        end
+      end
+    end
+    if missing_ids.any?
+      progress.message = "Couldn't find User(s) with API ids #{missing_ids.map{|id| "'#{id}'"}.join(", ")}"
+      progress.save
+      progress.fail
+    end
+  end
 end

config/routes.rb

@@ -886,6 +886,7 @@ def submissions_api(context, path_prefix = context)
         post "#{context.pluralize}/:#{context}_id/assignments/:assignment_id/submissions", action: :create, controller: :submissions
         post "#{context.pluralize}/:#{context}_id/assignments/:assignment_id/submissions/:user_id/files", action: :create_file
         put "#{context.pluralize}/:#{context}_id/assignments/:assignment_id/submissions/:user_id", action: :update
+        post "#{context.pluralize}/:#{context}_id/assignments/:assignment_id/submissions/update_grades", action: :bulk_update
       end
       submissions_api("course")
       submissions_api("section", "course_section")

spec/apis/v1/submissions_api_spec.rb

@@ -2621,4 +2621,221 @@ def course_with_student_and_submitted_homework
                action: 'mark_submission_unread', controller: 'submissions_api', format: 'json'})
     expect(@submission.reload.read?(@teacher)).to be_falsey
   end
+
+  context 'bulk update' do
+    before :each do
+      @student1 = user(:active_all => true)
+      @student2 = user(:active_all => true)
+      course_with_teacher(:active_all => true)
+      @default_section = @course.default_section
+      @section = @course.course_sections.create!(:name => "section2")
+      @course.enroll_user(@student1, 'StudentEnrollment', :section => @section).accept!
+      @course.enroll_user(@student2, 'StudentEnrollment').accept!
+      @a1 = @course.assignments.create!({:title => 'assignment1', :grading_type => 'percent', :points_possible => 10})
+    end
+
+    it "should queue bulk update through courses" do
+      grade_data = {
+        :grade_data => {
+          @student1.id => { :posted_grade => '75%'},
+          @student2.id => { :posted_grade => '95%'}
+        }
+      }
+
+      json = api_call(:post,
+        "/api/v1/courses/#{@course.id}/assignments/#{@a1.id}/submissions/update_grades",
+        { :controller => 'submissions_api', :action => 'bulk_update',
+          :format => 'json', :course_id => @course.id.to_s,
+          :assignment_id => @a1.id.to_s }, grade_data)
+
+      run_jobs
+      progress = Progress.find(json["id"])
+      expect(progress.completed?).to be_truthy
+
+      expect(Submission.count).to eq 2
+      s1 = @student1.submissions.first
+      expect(s1.grade).to eq "75%"
+      s2 = @student2.submissions.first
+      expect(s2.grade).to eq "95%"
+    end
+
+    it "should find users through sis api ids" do
+      student3 = user_with_pseudonym(:active_all => true)
+      student3.pseudonym.update_attribute(:sis_user_id, 'my-student-id')
+      @course.enroll_user(student3, 'StudentEnrollment').accept!
+
+      grade_data = {
+          :grade_data => {
+              'sis_user_id:my-student-id' => { :posted_grade => '75%'}
+          }
+      }
+
+      @user = @teacher
+      json = api_call(:post,
+                      "/api/v1/courses/#{@course.id}/assignments/#{@a1.id}/submissions/update_grades",
+                      { :controller => 'submissions_api', :action => 'bulk_update',
+                        :format => 'json', :course_id => @course.id.to_s,
+                        :assignment_id => @a1.id.to_s }, grade_data)
+
+      run_jobs
+      progress = Progress.find(json["id"])
+      expect(progress.completed?).to be_truthy
+
+      expect(Submission.count).to eq 1
+      s1 = student3.submissions.first
+      expect(s1.grade).to eq "75%"
+    end
+
+    it "should restrict with differentiated assignments" do
+      @a1.only_visible_to_overrides = true
+      @a1.save!
+      create_section_override_for_assignment(@a1, course_section: @section)
+      @course.enable_feature!(:differentiated_assignments)
+
+      student3 = user_with_pseudonym(:active_all => true)
+      student3.pseudonym.update_attribute(:sis_user_id, 'my-student-id')
+      @course.enroll_user(student3, 'StudentEnrollment').accept!
+
+      grade_data = {
+          :grade_data => {
+              @student1.id => { :posted_grade => '75%'},
+              @student2.id => { :posted_grade => '95%'},
+              'sis_user_id:my-student-id' => { :posted_grade => '85%'},
+          }
+      }
+
+      @user = @teacher
+      json = api_call(:post,
+                      "/api/v1/courses/#{@course.id}/assignments/#{@a1.id}/submissions/update_grades",
+                      { :controller => 'submissions_api', :action => 'bulk_update',
+                        :format => 'json', :course_id => @course.id.to_s,
+                        :assignment_id => @a1.id.to_s }, grade_data)
+
+      run_jobs
+      progress = Progress.find(json["id"])
+      expect(progress.failed?).to be_truthy
+      expect(progress.message).to eq "Couldn't find User(s) with API ids '#{@student2.id}', 'sis_user_id:my-student-id'"
+
+      @course.disable_feature!(:differentiated_assignments)
+      json = api_call(:post,
+                      "/api/v1/courses/#{@course.id}/assignments/#{@a1.id}/submissions/update_grades",
+                      { :controller => 'submissions_api', :action => 'bulk_update',
+                        :format => 'json', :course_id => @course.id.to_s,
+                        :assignment_id => @a1.id.to_s }, grade_data)
+
+      run_jobs
+      progress = Progress.find(json["id"])
+      expect(progress.completed?).to be_truthy
+
+      expect(Submission.count).to eq 3
+      s1 = @student1.submissions.first
+      expect(s1.grade).to eq "75%"
+      s2 = @student2.submissions.first
+      expect(s2.grade).to eq "95%"
+      s3 = student3.submissions.first
+      expect(s3.grade).to eq "85%"
+    end
+
+    it "should queue bulk update through sections" do
+      grade_data = {
+        :grade_data => {
+          @student1.id => { :posted_grade => '75%'}
+        }
+      }
+
+      json = api_call(:post,
+        "/api/v1/sections/#{@section.id}/assignments/#{@a1.id}/submissions/update_grades",
+        { :controller => 'submissions_api', :action => 'bulk_update',
+          :format => 'json', :section_id => @section.id.to_s,
+          :assignment_id => @a1.id.to_s }, grade_data)
+
+      run_jobs
+      progress = Progress.find(json["id"])
+      expect(progress.completed?).to be_truthy
+
+      expect(Submission.count).to eq 1
+      s1 = @student1.submissions.first
+      expect(s1.grade).to eq "75%"
+    end
+
+    it "should allow bulk grading with rubric assessments" do
+      rubric = rubric_model(:user => @user, :context => @course, :data => larger_rubric_data)
+      @a1.create_rubric_association(:rubric => rubric, :purpose => 'grading', :use_for_grading => true, :context => @course)
+
+      grade_data = {
+        :grade_data => {
+          @student1.id => { :posted_grade => '75%'},
+          @student2.id => {
+            :rubric_assessment => {
+              :crit1 => { :points => 7 },
+              :crit2 => { :points => 2, :comments => 'Rock on' }
+            }
+          }
+        }
+      }
+
+      json = api_call(:post,
+                      "/api/v1/courses/#{@course.id}/assignments/#{@a1.id}/submissions/update_grades",
+                      { :controller => 'submissions_api', :action => 'bulk_update',
+                        :format => 'json', :course_id => @course.id.to_s,
+                        :assignment_id => @a1.id.to_s }, grade_data)
+
+      run_jobs
+      progress = Progress.find(json["id"])
+      expect(progress.completed?).to be_truthy
+
+      expect(Submission.count).to eq 2
+      s1 = @student1.submissions.first
+      expect(s1.grade).to eq "75%"
+      s2 = @student2.submissions.first
+      expect(s2.rubric_assessment).not_to be_nil
+      expect(s2.rubric_assessment.data).to eq(
+          [{:description=>"B",
+            :criterion_id=>"crit1",
+            :comments_enabled=>true,
+            :points=>7,
+            :learning_outcome_id=>nil,
+            :id=>"rat2",
+            :comments=>nil},
+           {:description=>"Pass",
+            :criterion_id=>"crit2",
+            :comments_enabled=>true,
+            :points=>2,
+            :learning_outcome_id=>nil,
+            :id=>"rat1",
+            :comments=>"Rock on",
+            :comments_html=>"Rock on"}]
+      )
+    end
+
+    it "should require authorization" do
+      @user = @student1
+      raw_api_call(:post,
+        "/api/v1/courses/#{@course.id}/assignments/#{@a1.id}/submissions/update_grades",
+        { :controller => 'submissions_api', :action => 'bulk_update',
+          :format => 'json', :course_id => @course.id.to_s,
+          :assignment_id => @a1.id.to_s }, {})
+      assert_status(401)
+    end
+
+    it "should check user ids for sections" do
+      grade_data = {
+        :grade_data => {
+          @student1.id => { :posted_grade => '75%'},
+          @student2.id => { :posted_grade => '95%'}
+        }
+      }
+
+      json = api_call(:post,
+        "/api/v1/sections/#{@section.id}/assignments/#{@a1.id}/submissions/update_grades",
+        { :controller => 'submissions_api', :action => 'bulk_update',
+          :format => 'json', :section_id => @section.id.to_s,
+          :assignment_id => @a1.id.to_s }, grade_data)
+
+      run_jobs
+      progress = Progress.find(json["id"])
+      expect(progress.failed?).to be_truthy
+      expect(progress.message).to eq "Couldn't find User(s) with API ids '#{@student2.id}'"
+    end
+  end
 end