allow teachers to resubmit to turnitin; closes #7981

add more structure to the turnitin_data hash on a submission to keep track of
what state things are in, so that we can present errors to the user as they
happen and provide a way to resubmit. there are three states: 'pending',
'error', and 'scored'.

submissions start out as 'pending', and can move to 'error' if anything goes
wrong in the submission process (either in creating the assignment, enrolling
the user, or actually submitting the paper). there are built in retrys, and the
error state only gets set if there is still an error after the retry limit. if
this succeeds, we stay pending until the score is successfully retrieved from
turnitin, at which point it is marked 'scored'.

this change is primarily in speed grader, although icons have been updated in
the gradebooks and submission pages as well. in the 'scored' state, (or without
a state) things should work exactly as they have previously - display a score,
which can be clicked to see the full report. in the 'error' state (indicated
with an exclaimation point icon), clicking the icon gives you more details
about the error and the option to resubmit. in the 'pending' state (indicated
by a clock icon), clicking the icon just explains that the submission is
pending.

test-plan:
- locate some submissions that were scored with turnitin before this change was
  applied and verify that they still work as expected
- submit something new that will get sent to turnitin. verify that it initially
  gets marked as pending, and then after 5-10 minutes has a score.
- submit something that will result in a turnitin error (eg: < 20 words,
  password protected pdf). verify that it initially gets marked as pending,
  then after ~30 minutes (to account for retries) is marked as an error.
- click the icon, and click the resubmit button. verify that it goes back to
  pending.
- verify that the new turnitin icons for these submission in gradebooks 1 and
  2 look correct and don't mess up the layout.

Change-Id: Ia5e1b04842de16aaa44d498eefe59ddb716dc014
Reviewed-on: https://gerrit.instructure.com/10125
Reviewed-by: Simon Williams <simon@instructure.com>
Tested-by: Hudson <hudson@instructure.com>

Author: simonista

app/coffeescripts/SubmissionDetailsDialog.coffee

@@ -1,14 +1,16 @@
 define [
+  'i18n!submission_details_dialog'
   'jquery'
   'jst/SubmissionDetailsDialog'
   'jst/_submission_detail' # a partial needed by the SubmissionDetailsDialog template
+  'jst/_turnitinScore' # a partial needed by the submission_detail partial
   'jquery.ajaxJSON'
   'jquery.disableWhileLoading'
   'jquery.instructure_forms'
   'jqueryui/dialog'
   'jquery.instructure_misc_plugins'
   'vendor/jquery.scrollTo'
-], ($, submissionDetailsDialog) ->
+], (I18n, $, submissionDetailsDialog) ->
 
   class SubmissionDetailsDialog
     constructor: (@assignment, @student, @options) ->
@@ -59,8 +61,11 @@ define [
         for attachment in submission.attachments || []
           if turnitinDataForThisAttachment = submission.turnitin_data?["attachment_#{attachment.id}"]
             if turnitinDataForThisAttachment["similarity_score"]
-              attachment.turnitinUrl = "#{@options.context_url}/assignments/#{@assignment.id}/submissions/#{@student.id}/turnitin/attachment_#{attachment.id}"
               attachment.turnitin_data = turnitinDataForThisAttachment
+              attachment.turnitin_data.state = "#{turnitinDataForThisAttachment.state || 'no'}_score"
+              attachment.turnitin_data.score = "#{turnitinDataForThisAttachment.similarity_score}%"
+              attachment.turnitin_data.reportUrl = "#{@options.context_url}/assignments/#{@assignment.id}/submissions/#{@student.id}/turnitin/attachment_#{attachment.id}"
+              attachment.turnitin_data.tooltip = I18n.t('turnitin.tooltip.score', 'Turnitin Similarity Score - See detailed report')
       @dialog.html(submissionDetailsDialog(@submission))
       @dialog.find('select').trigger('change')
       @scrollCommentsToBottom()

app/controllers/submissions_controller.rb

@@ -334,6 +334,21 @@ def turnitin_report
       end
     end
   end
+
+  def resubmit_to_turnitin
+    if authorized_action(@context, @current_user, [:manage_grades, :view_all_grades])
+      @assignment = @context.assignments.active.find(params[:assignment_id])
+      @submission = @assignment.submissions.find_by_user_id(params[:submission_id])
+      @submission.resubmit_to_turnitin
+      respond_to do |format|
+        format.html { 
+          flash[:notice] = t('resubmitted_to_turnitin', "Successfully resubmitted to turnitin.")
+          redirect_to named_context_url(@context, :context_assignment_submission_url, @assignment.id, @submission.user_id)
+        }
+        format.json { render :nothing => true, :status => :no_content }
+      end
+    end
+  end
 
   def update
     @assignment = @context.assignments.active.find(params[:assignment_id])

app/models/submission.rb

@@ -205,24 +205,29 @@ def check_turnitin_status(asset_string, attempt=1)
     self.turnitin_data ||= {}
     data = self.turnitin_data[asset_string]
     return unless data && data[:object_id]
-    if !data[:similarity_score] && attempt < 10
-      turnitin = Turnitin::Client.new(*self.context.turnitin_settings)
-      res = turnitin.generateReport(self, asset_string)
-      if res[:similarity_score]
-        data[:similarity_score] = res[:similarity_score].to_f
-        data[:web_overlap] = res[:web_overlap].to_f
-        data[:publication_overlap] = res[:publication_overlap].to_f
-        data[:student_overlap] = res[:student_overlap].to_f
-        data[:state] = 'failure'
-        data[:state] = 'problem' if data[:similarity_score] < 75
-        data[:state] = 'warning' if data[:similarity_score] < 50
-        data[:state] = 'acceptable' if data[:similarity_score] < 25
-        data[:state] = 'none' if data[:similarity_score] == 0
+    if data[:similarity_score].blank?
+      if attempt < TURNITIN_RETRY
+        turnitin = Turnitin::Client.new(*self.context.turnitin_settings)
+        res = turnitin.generateReport(self, asset_string)
+        if res[:similarity_score]
+          data[:similarity_score] = res[:similarity_score].to_f
+          data[:web_overlap] = res[:web_overlap].to_f
+          data[:publication_overlap] = res[:publication_overlap].to_f
+          data[:student_overlap] = res[:student_overlap].to_f
+          data[:state] = 'failure'
+          data[:state] = 'problem' if data[:similarity_score] < 75
+          data[:state] = 'warning' if data[:similarity_score] < 50
+          data[:state] = 'acceptable' if data[:similarity_score] < 25
+          data[:state] = 'none' if data[:similarity_score] == 0
+          data[:status] = 'scored'
+        else
+          send_at((5 * attempt).minutes.from_now, :check_turnitin_status, asset_string, attempt + 1)
+        end
       else
-        send_at((5 * attempt).minutes.from_now, :check_turnitin_status, asset_string, attempt + 1)
+        data[:status] = 'error'
       end
     else
-      data[:error] = true
+      data[:status] = 'scored'
     end
     self.turnitin_data[asset_string] = data
     self.turnitin_data_changed!
@@ -263,44 +268,79 @@ def submit_to_turnitin_later
     end
   end
 
+  TURNITIN_RETRY = 5
   def submit_to_turnitin(attempt=0)
     return unless self.context.turnitin_settings
     turnitin = Turnitin::Client.new(*self.context.turnitin_settings)
-    self.turnitin_data ||= {}
+    reset_turnitin_assets
 
-    # 1. Make sure the assignment exists
+    # 1. Make sure the assignment exists and user is enrolled
     assign_status = self.assignment.create_in_turnitin
-    unless assign_status
-      send_at(5.minutes.from_now, :submit_to_turnitin, attempt + 1) if attempt < 5
-      return false
-    end
-
-    # 2. Make sure the user is enrolled
-    # TODO: track this elsewhere so we don't have to do the API call on every submission
     enroll_status = turnitin.enrollStudent(self.context, self.user)
-    unless enroll_status
-      send_at(5.minutes.from_now, :submit_to_turnitin, attempt + 1) if attempt < 5
+    unless assign_status && enroll_status
+      if attempt < TURNITIN_RETRY
+        send_at(5.minutes.from_now, :submit_to_turnitin, attempt + 1)
+      else
+        assign_error = self.assignment.turnitin_settings[:error]
+        turnitin_assets.each do |a| 
+          self.turnitin_data[a.asset_string][:status] = 'error'
+          self.turnitin_data[a.asset_string].merge!(assign_error) if assign_error.present?
+        end
+        self.turnitin_data_changed!
+        self.save
+      end
       return false
     end
 
-    # 3. Submit the file(s)
+    # 2. Submit the file(s)
     submission_response = turnitin.submitPaper(self)
-    submission_response.each do |asset_string, response|
-      if self.turnitin_data[asset_string] != response
-        self.turnitin_data[asset_string] = response
-        self.turnitin_data_changed!
-        self.send_at(5.minutes.from_now, :check_turnitin_status, asset_string) if response[:object_id]
+    submission_response.each do |res_asset_string, response|
+      self.turnitin_data[res_asset_string].merge!(response)
+      self.turnitin_data_changed!
+      if response[:object_id]
+        self.send_at(5.minutes.from_now, :check_turnitin_status, res_asset_string)
+      elsif !(attempt < TURNITIN_RETRY)
+        self.turnitin_data[res_asset_string][:status] = 'error'
       end
     end
     self.save
     submit_status = submission_response.present? && submission_response.values.all?{ |v| v[:object_id] }
     unless submit_status
-      send_at(5.minutes.from_now, :submit_to_turnitin, attempt + 1) if attempt < 5
+      send_at(5.minutes.from_now, :submit_to_turnitin, attempt + 1) if attempt < TURNITIN_RETRY
       return false
     end
 
     true
   end
+
+  def turnitin_assets
+    if self.submission_type == 'online_upload'
+      self.attachments.select{ |a| a.turnitinable? }
+    elsif self.submission_type == 'online_text_entry'
+      [self]
+    end
+  end
+
+  def reset_turnitin_assets
+    self.turnitin_data ||= {}
+    turnitin_assets.each do |a|
+      asset_data = self.turnitin_data[a.asset_string] || {}
+      asset_data[:status] = 'pending'
+      [:error_code, :error_message, :public_error_message].each do |key|
+        asset_data.delete(key)
+      end
+      self.turnitin_data[a.asset_string] = asset_data
+      self.turnitin_data_changed!
+    end
+  end
+
+  def resubmit_to_turnitin
+    reset_turnitin_assets
+    self.save
+
+    @submit_to_turnitin = true
+    submit_to_turnitin_later
+  end
 
   def turnitinable?
     if self.submission_type == 'online_upload' || self.submission_type == 'online_text_entry'

app/stylesheets/g_instructure.sass

@@ -1,4 +1,5 @@
 @import environment.sass
+@import turnitin.sass
 
 #instructure_ajax_error_box
   :display none
@@ -1379,23 +1380,6 @@ fieldset
   legend
     font-weight: bold
     margin-left: 20px
-
-.turnitin_similarity_score
-  white-space: nowrap
-  border: 1px solid #bbb
-  border-top: 5px solid #bbb
-  padding: 1px 2px 2px
-  font-size: 0.8em
-  &.none_score
-    border-color: #4987EC
-  &.acceptable_score
-    border-color: #52E252
-  &.warning_score
-    border-color: #ECEC49
-  &.problem_score
-    border-color: #FFB420
-  &.failure_score
-    border-color: #FF3F3F
 h2.h-margin-top,h3.h-margin-top
   margin-top: 20px
 

app/stylesheets/speed_grader.sass

@@ -428,20 +428,14 @@ body .ui-selectmenu-dropdown:hover .ui-selectmenu-icon, body .ui-state-active .u
     background-position: 0 -12px
   .resubmitted &
     background-position: 0 -175px
-#grade_container
-  .turnitin_similarity_score
-    background-color: #fff
-    font-size: 0.8em
-    padding-bottom: 0
-    color: #444
-    text-decoration: none
-    margin-top: -2px
-    margin-left: 10px
-    &:hover
-      text-decoration: none
+.turnitin_info
+  margin-top: 3px
+  border-top: 1px solid #999999
+  padding: 3px 0
 #submission_details
   border-bottom: 1px solid #999999
-  padding-bottom: 3px
+  &.content_box
+    padding-top: 0
   a
     font-size: 12px
   .on_time
@@ -453,33 +447,28 @@ body .ui-selectmenu-dropdown:hover .ui-selectmenu-icon, body .ui-state-active .u
   #submission_late_notice
     color: #d12f19
     font-weight: bold
-    margin-left: 3px
   #submission_not_newest_notice
     color: #EB9A00
     font-weight: bold
-    margin-left: 3px
   select
     width: 99%
   label
     font-weight: bold
-    margin-left: 3px
   #submission_files_list
     overflow: auto
     .submission-file
       padding: 1px 16px 1px 19px
       position: relative
-      .turnitin_similarity_score
+      .turnitin_score_container
         position: absolute
         top: 0
         right: 20px
-        background-color: #fff
-        font-size: 0.7em
-        padding-bottom: 0
-        color: #444
-        text-decoration: none
-        margin-top: -2px
+      .turnitin_similarity_score
+        font-size: 9px
+        &.submission_error, &.submission_pending
+          padding: 1px
         &:hover
-          text-decoration: none
+          font-size: 0.7em
       .submission-file-download
         display: block
         +opacity(0.5)
@@ -492,8 +481,6 @@ body .ui-selectmenu-dropdown:hover .ui-selectmenu-icon, body .ui-state-active .u
         text-indent: -9999px
       &:hover
         background-color: #DCECFB
-        .turnitin_similarity_score
-          display: block
         .submission-file-download
           display: block
           +opacity(1.0)

app/stylesheets/submissionDetailsDialog.sass

@@ -23,6 +23,8 @@
     padding: 3px 0
     a
       font-size: 11px
+    a.turnitin_similarity_score
+      font-size: 10px
   .submission_details_comments
     overflow: auto
     max-height: 200px
@@ -75,4 +77,4 @@
       font-weight: normal
   .button
     float: right
-    
+    

app/stylesheets/turnitin.sass

@@ -0,0 +1,70 @@
+@import environment.sass
+
+// #4985f5
+$turnitin_blue: rgba(73, 133, 245, 0.5)
+// #4ff057
+$turnitin_green: rgba(79, 240, 87, 0.5)
+// #f5f549
+$turnitin_yellow: rgba(245, 245, 73, 0.5)
+// #ffb433
+$turnitin_orange: rgba(255, 180, 51, 0.5)
+// #ff383f
+$turnitin_red: rgba(255, 56, 63, 0.5)
+// #b8b8b8
+$turnitin_gray: rgba(184, 184, 184, 0.5)
+
+.turnitin_score_container_caret
+  position: absolute
+  width: 0
+  height: 0
+  top: 50%
+  content: ""
+  border-width: 4px
+  border-color: transparent
+  border-style: solid
+  left: -8px
+  margin-top: -4px
+  &.none_score
+    border-right-color: $turnitin_blue
+  &.acceptable_score
+    border-right-color: $turnitin_green
+  &.warning_score
+    border-right-color: $turnitin_yellow
+  &.problem_score
+    border-right-color: $turnitin_orange
+  &.failure_score
+    border-right-color: $turnitin_red
+  &.submission_error, &.submission_pending
+    border-right-color: $turnitin_gray
+.turnitin_score_container
+  position: relative
+  margin-left: 10px
+.turnitin_similarity_score,
+.turnitin_similarity_score:link,
+.turnitin_similarity_score:visited,
+.turnitin_similarity_score:active,
+.turnitin_similarity_score:hover,
+.turnitin_similarity_score:focus
+  display: inline-block
+  white-space: nowrap
+  +border-radius(3px)
+  padding: 2px 4px
+  font-weight: bold
+  text-shadow: rgba(255, 255, 255, 0.5) 1px 0 1px
+  color: #444
+  font-size: 10px
+  text-decoration: none
+  &.none_score
+    background-color: $turnitin_blue
+  &.acceptable_score
+    background-color: $turnitin_green
+  &.warning_score
+    background-color: $turnitin_yellow
+  &.problem_score
+    background-color: $turnitin_orange
+  &.failure_score
+    background-color: $turnitin_red
+  &.submission_error, &.submission_pending
+    background-color: $turnitin_gray
+.turnitin_resubmit_container
+  text-align: right