"assignment_info" => "assignment"

Author: jlumbroso

codePost_api/helpers.py

@@ -171,7 +171,7 @@ def get_course_roster_by_name(course_name, course_period, api_key=None):
     return course_info
 
 @_util.api_key_decorator()
-def get_assignment_info_by_id(assignment_id, api_key=None):
+def get_assignment_by_id(assignment_id, api_key=None):
     """
     Returns the assignment information dictionary, given the assignment's ID.
     """
@@ -192,14 +192,14 @@ def get_assignment_info_by_id(assignment_id, api_key=None):
     except Exception as exc:
         raise RuntimeError(
             """
-            get_assignment_info_by_id: Unexpected exception while retrieving the
+            get_assignment_by_id: Unexpected exception while retrieving the
             assignment info from the provided id ({: d}):
                {}
             """.format(assignment_id, exc)
         )
 
 @_util.api_key_decorator()
-def get_assignment_info_by_name(course_name, course_period, assignment_name, api_key=None):
+def get_assignment_by_name(course_name, course_period, assignment_name, api_key=None):
     """
     Returns the assignment information dictionary, given a(course name, course period,
     assignment name) tuple. This contains, in particular, the ID of the assignment that
@@ -218,7 +218,7 @@ def get_assignment_info_by_name(course_name, course_period, assignment_name, api
     if len(courses) == 0:
         raise RuntimeError(
             """
-            get_assignment_info_by_name: Either no course with the
+            get_assignment_by_name: Either no course with the
             specified course({}) and period({}) exists, or the provided
             API key({:.5}...) does not have access to it.
             """.format(course_name, course_period,
@@ -228,7 +228,7 @@ def get_assignment_info_by_name(course_name, course_period, assignment_name, api
     elif len(courses) > 1:
         raise RuntimeError(
             """
-            get_assignment_info_by_name: Request the provided course
+            get_assignment_by_name: Request the provided course
             name({}) and period({}) resulted in more than one result({}).
             """.format(course_name, course_period, len(courses))
         )
@@ -245,7 +245,7 @@ def get_assignment_info_by_name(course_name, course_period, assignment_name, api
     try:
         for aid in assignments:
 
-            ret = get_assignment_info_by_id(assignment_id=aid, api_key=api_key)
+            ret = get_assignment_by_id(assignment_id=aid, api_key=api_key)
 
             if ret.get("name") == assignment_name:
                 selected_assignment = ret
@@ -255,7 +255,7 @@ def get_assignment_info_by_name(course_name, course_period, assignment_name, api
 
         raise RuntimeError(
             """
-            get_assignment_info_by_name: Unexpected exception while listing the
+            get_assignment_by_name: Unexpected exception while listing the
             available assignments and searching for '{}' in course '{}', period
             '{}':
                {}
@@ -832,11 +832,11 @@ def get_course_grades(course_name, course_period, only_finalized=True, api_key=N
         #  u'points': 20,
         #  u'rubricCategories': [519, 640, 641, 642, 643, 644, 645],
         #  u'sortKey': 1}
-        assignment_info = get_assignment_info_by_id(
+        assignment = get_assignment_by_id(
             api_key=api_key,
             assignment_id=aid)
 
-        assignment_name = assignment_info["name"]
+        assignment_name = assignment["name"]
 
         # Submission object:
         # {u'assignment': 92,

tests/test_helpers.py

@@ -161,12 +161,12 @@ def test_get_course_roster_by_name_course_conflict(mock_get_available_courses):
                 course_period="S2019")
     )
 #############################################################################
-# Function tested: helpers.get_assignment_info_by_id
+# Function tested: helpers.get_assignment_by_id
 # Notes:
 #
 #############################################################################
 @patch('codePost_api.helpers._requests.get')
-def test_get_assignment_info_by_id(mock_get):
+def test_get_assignment_by_id(mock_get):
     assignment = {'id': 1}
 
     mock_get.return_value.status_code = 200
@@ -176,32 +176,32 @@ def test_get_assignment_info_by_id(mock_get):
     _assert.assertEqual(assignment, response)
 
 #############################################################################
-# Function tested: helpers.get_assignment_info_by_name
+# Function tested: helpers.get_assignment_by_name
 # Notes:
 #
 #############################################################################
-@patch('codePost_api.helpers.get_assignment_info_by_id')
+@patch('codePost_api.helpers.get_assignment_by_id')
 @patch('codePost_api.helpers.get_available_courses')
-def test_get_assignment_info_by_name(mock_get_available_courses, mock_get_assignment_info_by_id):
+def test_get_assignment_by_name(mock_get_available_courses, mock_get_assignment_by_id):
 
     # mock get_available_courses
     course2 = {'id' : 2, 'name' : 'COS226', 'period' : 'S2019', 'assignments': [3,4,5]}
     mock_get_available_courses.return_value = [course2]
 
-    # mock get_assignment_info_by_id
+    # mock get_assignment_by_id
     def side_effect(api_key, assignment_id):
         return {
           'id': assignment_id,
           'name': 'assignment-%d' % assignment_id,
         }
 
-    mock_get_assignment_info_by_id.side_effect = side_effect
-    response = helpers.get_assignment_info_by_name('COS226', 'S2019', 'assignment-4', api_key=TEST_API_KEY)
+    mock_get_assignment_by_id.side_effect = side_effect
+    response = helpers.get_assignment_by_name('COS226', 'S2019', 'assignment-4', api_key=TEST_API_KEY)
 
     _assert.assertEqual({'id': 4, 'name' : 'assignment-4'}, response)
 
 @patch('codePost_api.helpers.get_available_courses')
-def test_get_assignment_info_by_name_course_conflict(mock_get_available_courses):
+def test_get_assignment_by_name_course_conflict(mock_get_available_courses):
 
     # mock get_available_courses
     course1 = {"id" : 1, "name" : "COS126", "period" : "S2019", "assignments": [1,2]}
@@ -211,23 +211,23 @@ def test_get_assignment_info_by_name_course_conflict(mock_get_available_courses)
     _assert.assertRaises(
         RuntimeError,
         lambda:
-            helpers.get_assignment_info_by_name(
+            helpers.get_assignment_by_name(
                 api_key=TEST_API_KEY,
                 course_name="COS226",
                 course_period="S2019",
                 assignment_name="test-assignment")
     )
 
 @patch('codePost_api.helpers.get_available_courses')
-def test_get_assignment_info_by_name_no_course(mock_get_available_courses):
+def test_get_assignment_by_name_no_course(mock_get_available_courses):
 
     # mock get_available_courses
     mock_get_available_courses.return_value = []
 
     _assert.assertRaises(
         RuntimeError,
         lambda:
-            helpers.get_assignment_info_by_name(
+            helpers.get_assignment_by_name(
                 api_key=TEST_API_KEY,
                 course_name='COS226',
                 course_period='S2019',
@@ -470,7 +470,7 @@ def test_submission_list_is_unclaimed():
 #
 #############################################################################
 @patch('codePost_api.helpers.get_assignment_submissions')
-@patch('codePost_api.helpers.get_assignment_info_by_id')
+@patch('codePost_api.helpers.get_assignment_by_id')
 @patch('codePost_api.helpers.get_course_roster_by_name')
 def test_get_course_grades(mock_roster, mock_assignment, mock_submissions):
     roster = {
@@ -483,7 +483,7 @@ def test_get_course_grades(mock_roster, mock_assignment, mock_submissions):
     mock_roster.return_value.status_code = 200
     mock_roster.return_value = roster
 
-    # mock get_assignment_info_by_id
+    # mock get_assignment_by_id
     def side_effect(api_key, assignment_id):
         return {
           'id': assignment_id,