Refactor: put _try_to_send_lti_grade in rs_grading.

Author: bjones1

controllers/assignments.py

@@ -18,11 +18,14 @@
 # Third-party imports
 # -------------------
 from psycopg2 import IntegrityError
-from rs_grading import do_autograde, do_calculate_totals, do_check_answer, send_lti_grade
-from db_dashboard import DashboardDataAnalyzer
 import six
 import bleach
 
+# Local application imports
+# -------------------------
+from rs_grading import do_autograde, do_calculate_totals, do_check_answer, send_lti_grade, _get_lti_record, _try_to_send_lti_grade
+from db_dashboard import DashboardDataAnalyzer
+
 logger = logging.getLogger(settings.logger)
 logger.setLevel(settings.log_level)
 
@@ -362,39 +365,6 @@ def _autograde(sid=None, student_rownum=None, question_name=None, enforce_deadli
         return {'success': False, 'message': "Select an assignment before trying to autograde."}
 
 
-def _get_assignment(assignment_id):
-    return db(db.assignments.id == assignment_id).select().first()
-
-def _try_to_send_lti_grade(student_row_num, assignment_id):
-    # try to send lti grades
-    assignment = _get_assignment(assignment_id)
-    if not assignment:
-        session.flash = "Failed to find assignment object for assignment {}".format(assignment_id)
-        return False
-    else:
-        grade = db(
-            (db.grades.auth_user == student_row_num) &
-            (db.grades.assignment == assignment_id)).select().first()
-        if not grade:
-            session.flash = "Failed to find grade object for user {} and assignment {}".format(auth.user.id,
-                                                                                               assignment_id)
-            return False
-        else:
-            lti_record = _get_lti_record(session.oauth_consumer_key)
-            if (not lti_record) or (not grade.lis_result_sourcedid) or (not grade.lis_outcome_url):
-                session.flash = "Failed to send grade back to LMS (Coursera, Canvas, Blackboard...), probably because the student accessed this assignment directly rather than using a link from the LMS, or because there is an error in the assignment link in the LMS. Please report this error."
-                return False
-            else:
-                # really sending
-                # print("send_lti_grade({}, {}, {}, {}, {}, {}".format(assignment.points, grade.score, lti_record.consumer, lti_record.secret, grade.lis_outcome_url, grade.lis_result_sourcedid))
-                send_lti_grade(assignment.points,
-                               score=grade.score,
-                               consumer=lti_record.consumer,
-                               secret=lti_record.secret,
-                               outcome_url=grade.lis_outcome_url,
-                               result_sourcedid=grade.lis_result_sourcedid)
-                return True
-
 @auth.requires_login()
 def student_autograde():
     """
@@ -728,9 +698,6 @@ def chooseAssignment():
 
 # The rest of the file is about the the spaced practice:
 
-def _get_lti_record(oauth_consumer_key):
-    return db(db.lti_keys.consumer == oauth_consumer_key).select().first()
-
 def _get_course_practice_record(course_name):
     return db(db.course_practice.course_name == course_name).select().first()
 
@@ -893,7 +860,7 @@ def practice():
                                              flashcard.sub_chapter_label)
     # If the student has any flashcards to practice and has not practiced enough to get their points for today or they
     # have intrinsic motivation to practice beyond what they are expected to do.
-    if (available_flashcards_num > 0 and 
+    if (available_flashcards_num > 0 and
         len(questions) > 0 and
         (practiced_today_count != questions_to_complete_day or
             request.vars.willing_to_continue or

modules/rs_grading.py

@@ -1,10 +1,22 @@
+# Imports
+# =======
+# These are listed in the order prescribed by `PEP 8
+# <http://www.python.org/dev/peps/pep-0008/#imports>`_.
+#
+# Standard library
+# ----------------
 import datetime
 import logging
 from math import ceil
-from psycopg2 import IntegrityError
 from decimal import Decimal, ROUND_HALF_UP
 
+# Third-party imports
+# -------------------
+from psycopg2 import IntegrityError
 from gluon import current
+
+# Local imports
+# -------------
 from outcome_request import OutcomeRequest
 
 logger = logging.getLogger(current.settings.logger)
@@ -461,6 +473,46 @@ def _get_students(course_id=None, sid = None, student_rownum=None, db=None):
 
     return student_rows
 
+
+def _get_assignment(assignment_id):
+    return current.db(current.db.assignments.id == assignment_id).select().first()
+
+
+def _get_lti_record(oauth_consumer_key):
+    return current.db(current.db.lti_keys.consumer == oauth_consumer_key).select().first()
+
+
+def _try_to_send_lti_grade(student_row_num, assignment_id):
+    # try to send lti grades
+    assignment = _get_assignment(assignment_id)
+    if not assignment:
+        current.session.flash = "Failed to find assignment object for assignment {}".format(assignment_id)
+        return False
+    else:
+        grade = current.db(
+            (current.db.grades.auth_user == student_row_num) &
+            (current.db.grades.assignment == assignment_id)).select().first()
+        if not grade:
+            current.session.flash = "Failed to find grade object for user {} and assignment {}".format(auth.user.id,
+                                                                                               assignment_id)
+            return False
+        else:
+            lti_record = _get_lti_record(current.session.oauth_consumer_key)
+            if (not lti_record) or (not grade.lis_result_sourcedid) or (not grade.lis_outcome_url):
+                current.session.flash = "Failed to send grade back to LMS (Coursera, Canvas, Blackboard...), probably because the student accessed this assignment directly rather than using a link from the LMS, or because there is an error in the assignment link in the LMS. Please report this error."
+                return False
+            else:
+                # really sending
+                # print("send_lti_grade({}, {}, {}, {}, {}, {}".format(assignment.points, grade.score, lti_record.consumer, lti_record.secret, grade.lis_outcome_url, grade.lis_result_sourcedid))
+                send_lti_grade(assignment.points,
+                               score=grade.score,
+                               consumer=lti_record.consumer,
+                               secret=lti_record.secret,
+                               outcome_url=grade.lis_outcome_url,
+                               result_sourcedid=grade.lis_result_sourcedid)
+                return True
+
+
 def send_lti_grade(assignment_points, score, consumer, secret, outcome_url, result_sourcedid):
 
     pct = score / float(assignment_points) if score and assignment_points else 0.0