AA-203: created API framework for Progress tab, sending user information

lms/djangoapps/course_home_api/progress/v1/serializers.py

+"""
+Progress Tab Serializers
+"""
+
+from rest_framework import serializers
+from lms.djangoapps.course_home_api.outline.v1.serializers import CourseBlockSerializer
+
+
+class ProgressTabSerializer(serializers.Serializer):
+    """
+    Serializer for progress tab
+    """
+    course_blocks = CourseBlockSerializer()
+    enrollment_mode = serializers.CharField()

lms/djangoapps/course_home_api/progress/v1/views.py

+"""
+Progress Tab Views
+"""
+
+from rest_framework.generics import RetrieveAPIView
+from rest_framework.permissions import IsAuthenticated
+from rest_framework.response import Response
+
+from edx_django_utils import monitoring as monitoring_utils
+from opaque_keys.edx.keys import CourseKey
+
+from lms.djangoapps.course_home_api.progress.v1.serializers import ProgressTabSerializer
+
+from student.models import CourseEnrollment, UserTestGroup
+from lms.djangoapps.course_api.blocks.transformers.blocks_api import BlocksAPITransformer
+from lms.djangoapps.courseware.courses import get_course_with_access
+from lms.djangoapps.courseware.masquerade import setup_masquerade
+from lms.djangoapps.courseware.access import has_access
+from xmodule.modulestore.django import modulestore
+
+from lms.djangoapps.course_blocks.api import get_course_blocks
+import lms.djangoapps.course_blocks.api as course_blocks_api
+from openedx.core.djangoapps.content.block_structure.transformers import BlockStructureTransformers
+
+
+class ProgressTabView(RetrieveAPIView):
+    """
+    **Use Cases**
+
+        Request details for the Progress Tab
+
+    **Example Requests**
+
+        GET api/course_home/v1/progress/{course_key}
+
+    **Response Values**
+
+        Body consists of the following fields:
+
+        user: Serialized User object. The serialization has the following fields:
+            username: (str) The username of the user
+            email: (str) the email of the user
+            is_staff: (bool) boolean indicating whether the user has staff permisions or not
+        course_blocks:
+            blocks: List of serialized Course Block objects. Each serialization has the following fields:
+                id: (str) The usage ID of the block.
+                type: (str) The type of block. Possible values the names of any
+                    XBlock type in the system, including custom blocks. Examples are
+                    course, chapter, sequential, vertical, html, problem, video, and
+                    discussion.
+                display_name: (str) The display name of the block.
+                lms_web_url: (str) The URL to the navigational container of the
+                    xBlock on the web LMS.
+                children: (list) If the block has child blocks, a list of IDs of
+                    the child blocks.
+        enrollment_mode: (str) a str representing the enrollment the user has ('audit', 'verified', ...)
+
+    **Returns**
+
+        * 200 on success with above fields.
+        * 403 if the user is not authenticated.
+        * 404 if the course is not available or cannot be seen.
+    """
+
+    permission_classes = (IsAuthenticated,)
+    serializer_class = ProgressTabSerializer
+
+    def get(self, request, *args, **kwargs):
+        course_key_string = kwargs.get('course_key_string')
+        course_key = CourseKey.from_string(course_key_string)
+        course_usage_key = modulestore().make_course_usage_key(course_key)
+
+        # Enable NR tracing for this view based on course
+        monitoring_utils.set_custom_metric('course_id', course_key_string)
+        monitoring_utils.set_custom_metric('user_id', request.user.id)
+        monitoring_utils.set_custom_metric('is_staff', request.user.is_staff)
+
+        _, request.user = setup_masquerade(
+            request,
+            course_key,
+            staff_access=has_access(request.user, 'staff', course_key),
+            reset_masquerade_data=True
+        )
+
+        transformers = BlockStructureTransformers()
+        transformers += course_blocks_api.get_course_block_access_transformers(request.user)
+        transformers += [
+            BlocksAPITransformer(None, None, depth=3),
+        ]
+        get_course_with_access(request.user, 'load', course_key, check_if_enrolled=True)
+        course_blocks = get_course_blocks(request.user, course_usage_key, transformers, include_completion=True)
+
+        enrollment_mode, _ = CourseEnrollment.enrollment_mode_for_user(request.user, course_key)
+
+        data = {
+            'course_blocks': course_blocks,
+            'enrollment_mode': enrollment_mode,
+        }
+
+        serializer = self.get_serializer(data)
+
+        return Response(serializer.data)

lms/djangoapps/course_home_api/urls.py

@@ -9,6 +9,7 @@ from django.urls import re_path
 from lms.djangoapps.course_home_api.dates.v1.views import DatesTabView
 from lms.djangoapps.course_home_api.course_metadata.v1.views import CourseHomeMetadataView
 from lms.djangoapps.course_home_api.outline.v1.views import OutlineTabView
+from lms.djangoapps.course_home_api.progress.v1.views import ProgressTabView
 
 urlpatterns = []
 
@@ -38,3 +39,12 @@ urlpatterns += [
         name='course-home-outline-tab'
     ),
 ]
+
+# Progress Tab URLs
+urlpatterns += [
+    re_path(
+        r'v1/progress/{}'.format(settings.COURSE_KEY_PATTERN),
+        ProgressTabView.as_view(),
+        name='course-home-progress-tab'
+    ),
+]