Merge pull request #688 from edx-solutions/ziafazal/YONK-295-c

Ziafazal/yonk 295: updated course metrics API to return additional data

lms/djangoapps/api_manager/courses/tests.py

@@ -2419,7 +2419,7 @@ class CoursesApiTests(ModuleStoreTestCase):
         self.assertEqual(response.status_code, 201)
         org_id = response.data['id']
 
-        for i in xrange(1, 5):
+        for i in xrange(1, users_to_add):
             local_content_name = 'Video_Sequence{}'.format(i)
             local_content = ItemFactory.create(
                 category="videosequence",
@@ -2438,6 +2438,9 @@ class CoursesApiTests(ModuleStoreTestCase):
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.data['users_enrolled'], users_to_add + USER_COUNT)
         self.assertGreaterEqual(response.data['users_started'], 1)
+        self.assertEqual(response.data['users_not_started'], users_to_add + USER_COUNT - 1)
+        self.assertEqual(response.data['modules_completed'], users_to_add - 1)
+        self.assertEqual(response.data['users_completed'], 0)
         self.assertIsNotNone(response.data['grade_cutoffs'])
         self.assertEqual(response.data['num_threads'], 5)
         self.assertEqual(response.data['num_active_threads'], 3)
@@ -2484,7 +2487,7 @@ class CoursesApiTests(ModuleStoreTestCase):
             CourseEnrollmentFactory.create(user=user, course_id=self.course.id)
 
         # create course completions
-        for user in users:
+        for i, user in enumerate(users):
             completions_uri = '{}/{}/completions/'.format(self.base_courses_uri, self.test_course_id)
             completions_data = {
                 'content_id': unicode(self.course_content.scope_ids.usage_id),
@@ -2494,6 +2497,15 @@ class CoursesApiTests(ModuleStoreTestCase):
             response = self.do_post(completions_uri, completions_data)
             self.assertEqual(response.status_code, 201)
 
+            # mark two users a complete
+            if i % 2 == 0:
+                StudentGradebook.objects.get_or_create(
+                    user=user,
+                    course_id=self.course.id,
+                    grade=0.9,
+                    proforma_grade=0.91,
+                )
+
         course_metrics_uri = '{}/{}/metrics/?groups={}'.format(
             self.base_courses_uri,
             self.test_course_id,
@@ -2503,6 +2515,9 @@ class CoursesApiTests(ModuleStoreTestCase):
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.data['users_enrolled'], 3)
         self.assertGreaterEqual(response.data['users_started'], 3)
+        self.assertEqual(response.data['users_not_started'], 0)
+        self.assertEqual(response.data['modules_completed'], 3)
+        self.assertEqual(response.data['users_completed'], 2)
 
     def test_course_data_metrics_user_group_filter_for_multiple_groups_having_members(self):
         groups = GroupFactory.create_batch(2)
@@ -2534,6 +2549,9 @@ class CoursesApiTests(ModuleStoreTestCase):
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.data['users_enrolled'], 5)
         self.assertGreaterEqual(response.data['users_started'], 5)
+        self.assertEqual(response.data['users_not_started'], 0)
+        self.assertEqual(response.data['modules_completed'], 5)
+        self.assertEqual(response.data['users_completed'], 0)
 
     def test_course_workgroups_list(self):
         projects_uri = self.base_projects_uri

lms/djangoapps/api_manager/courses/views.py

@@ -1564,9 +1564,20 @@ class CoursesMetrics(SecureAPIView):
                                                               exclude_users=exclude_users,
                                                               org_ids=org_ids,
                                                               group_ids=group_ids)
+        users_enrolled = users_enrolled_qs.distinct().count()
+        modules_completed = StudentProgress.get_total_completions(
+            course_key, exclude_users=exclude_users, org_ids=org_ids, group_ids=group_ids
+        )
+        users_completed = StudentGradebook.get_num_users_completed(
+            course_key, exclude_users=exclude_users, org_ids=org_ids, group_ids=group_ids
+        )
+
         data = {
-            'users_enrolled': users_enrolled_qs.distinct().count(),
+            'users_enrolled': users_enrolled,
             'users_started': users_started,
+            'users_not_started': users_enrolled - users_started,
+            'modules_completed': modules_completed,
+            'users_completed': users_completed,
             'grade_cutoffs': course_descriptor.grading_policy['GRADE_CUTOFFS']
         }
 

lms/djangoapps/gradebook/models.py

@@ -2,10 +2,10 @@
 Django database models supporting the gradebook app
 """
 from django.utils import timezone
-
+from django.conf import settings
 from django.contrib.auth.models import User
 from django.db import models
-from django.db.models import Avg, Max, Min, Count
+from django.db.models import Avg, Max, Min, Count, F
 from django.db.models.signals import post_save
 from django.dispatch import receiver
 from django.utils.translation import ugettext_lazy as _
@@ -161,6 +161,27 @@ class StudentGradebook(models.Model):
 
         return data
 
+    @classmethod
+    def get_num_users_completed(cls, course_key, exclude_users=None, org_ids=None, group_ids=None):
+        """
+        Returns count of users those who completed given course.
+        """
+        grade_complete_match_range = getattr(settings, 'GRADEBOOK_GRADE_COMPLETE_PROFORMA_MATCH_RANGE', 0.01)
+        queryset = cls.objects.filter(
+            course_id__exact=course_key,
+            user__is_active=True,
+            user__courseenrollment__is_active=True,
+            user__courseenrollment__course_id__exact=course_key,
+            proforma_grade__lte=F('grade') + grade_complete_match_range,
+            proforma_grade__gt=0
+        ).exclude(user__id__in=exclude_users)
+        if org_ids:
+            queryset = queryset.filter(user__organizations__in=org_ids)
+        if group_ids:
+            queryset = queryset.filter(user__groups__in=group_ids)
+
+        return queryset.distinct().count()
+
 
 class StudentGradebookHistory(TimeStampedModel):
     """