feat: [AXIMST-26] API endpoint to return components in unit

cms/djangoapps/contentstore/rest_api/v1/mixins.py

@@ -4,6 +4,9 @@
 import json
 from unittest.mock import patch
 
+from django.http import Http404
+from opaque_keys import InvalidKeyError
+from opaque_keys.edx.keys import UsageKey
 from rest_framework import status
 
 
@@ -30,7 +33,7 @@ def test_permissions_unauthenticated(self):
         self.assertEqual(error, "Authentication credentials were not provided.")
         self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED)
 
-    @patch.dict('django.conf.settings.FEATURES', {'DISABLE_ADVANCED_SETTINGS': True})
+    @patch.dict("django.conf.settings.FEATURES", {"DISABLE_ADVANCED_SETTINGS": True})
     def test_permissions_unauthorized(self):
         """
         Test that an error is returned if the user is unauthorised.
@@ -40,3 +43,19 @@ def test_permissions_unauthorized(self):
         error = self.get_and_check_developer_response(response)
         self.assertEqual(error, "You do not have permission to perform this action.")
         self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
+
+
+class ContainerHandlerMixin:
+    """
+    A mixin providing common functionality for container handler views.
+    """
+
+    def get_object(self, usage_key_string):
+        """
+        Get an object by usage-id of the block
+        """
+        try:
+            usage_key = UsageKey.from_string(usage_key_string)
+        except InvalidKeyError:
+            raise Http404  # lint-amnesty, pylint: disable=raise-missing-from
+        return usage_key

cms/djangoapps/contentstore/rest_api/v1/serializers/__init__.py

@@ -5,7 +5,7 @@
 from .course_rerun import CourseRerunSerializer
 from .course_team import CourseTeamSerializer
 from .grading import CourseGradingModelSerializer, CourseGradingSerializer
-from .home import CourseHomeSerializer, CourseTabSerializer, LibraryTabSerializer
+from .home import CourseHomeSerializer, CourseHomeTabSerializer, LibraryTabSerializer
 from .proctoring import (
     LimitedProctoredExamSettingsSerializer,
     ProctoredExamConfigurationSerializer,
@@ -20,3 +20,4 @@
     VideoUsageSerializer,
     VideoDownloadSerializer
 )
+from .vertical_block import ContainerHandlerSerializer, VerticalContainerSerializer

cms/djangoapps/contentstore/rest_api/v1/serializers/home.py

@@ -31,7 +31,7 @@ class LibraryViewSerializer(serializers.Serializer):
     can_edit = serializers.BooleanField()
 
 
-class CourseTabSerializer(serializers.Serializer):
+class CourseHomeTabSerializer(serializers.Serializer):
     archived_courses = CourseCommonSerializer(required=False, many=True)
     courses = CourseCommonSerializer(required=False, many=True)
     in_process_course_actions = UnsucceededCourseSerializer(many=True, required=False, allow_null=True)

cms/djangoapps/contentstore/rest_api/v1/serializers/vertical_block.py

@@ -0,0 +1,110 @@
+"""
+API Serializers for unit page
+"""
+
+from django.urls import reverse
+from rest_framework import serializers
+
+from cms.djangoapps.contentstore.helpers import (
+    xblock_studio_url,
+    xblock_type_display_name,
+)
+
+
+class ChildAncestorSerializer(serializers.Serializer):
+    """
+    Serializer for representing child blocks in the ancestor XBlock.
+    """
+
+    url = serializers.SerializerMethodField()
+    display_name = serializers.CharField(source="display_name_with_default")
+
+    def get_url(self, obj):
+        """
+        Method to generate studio URL for the child block.
+        """
+        return xblock_studio_url(obj)
+
+
+class AncestorXBlockSerializer(serializers.Serializer):
+    """
+    Serializer for representing the ancestor XBlock and its children.
+    """
+
+    children = ChildAncestorSerializer(many=True)
+    title = serializers.CharField()
+    is_last = serializers.BooleanField()
+
+
+class ContainerXBlock(serializers.Serializer):
+    """
+    Serializer for representing XBlock data. Doesn't include all data about XBlock.
+    """
+
+    display_name = serializers.CharField(source="display_name_with_default")
+    display_type = serializers.SerializerMethodField()
+    category = serializers.CharField()
+
+    def get_display_type(self, obj):
+        """
+        Method to get the display type name for the container XBlock.
+        """
+        return xblock_type_display_name(obj)
+
+
+class ContainerHandlerSerializer(serializers.Serializer):
+    """
+    Serializer for container handler
+    """
+
+    language_code = serializers.CharField()
+    action = serializers.CharField()
+    xblock = ContainerXBlock()
+    is_unit_page = serializers.BooleanField()
+    is_collapsible = serializers.BooleanField()
+    position = serializers.IntegerField(min_value=1)
+    prev_url = serializers.CharField(allow_null=True)
+    next_url = serializers.CharField(allow_null=True)
+    new_unit_category = serializers.CharField()
+    outline_url = serializers.CharField()
+    ancestor_xblocks = AncestorXBlockSerializer(many=True)
+    component_templates = serializers.ListField(child=serializers.DictField())
+    xblock_info = serializers.DictField()
+    draft_preview_link = serializers.CharField()
+    published_preview_link = serializers.CharField()
+    show_unit_tags = serializers.BooleanField()
+    user_clipboard = serializers.DictField()
+    is_fullwidth_content = serializers.BooleanField()
+    assets_url = serializers.SerializerMethodField()
+    unit_block_id = serializers.CharField(source="unit.location.block_id")
+    subsection_location = serializers.CharField(source="subsection.location")
+
+    def get_assets_url(self, obj):
+        """
+        Method to get the assets URL based on the course id.
+        """
+
+        context_course = obj.get("context_course", None)
+        if context_course:
+            return reverse(
+                "assets_handler", kwargs={"course_key_string": context_course.id}
+            )
+        return None
+
+
+class ChildVerticalContainerSerializer(serializers.Serializer):
+    """
+    Serializer for representing a xblock child of vertical container.
+    """
+
+    name = serializers.CharField(source="display_name_with_default")
+    block_id = serializers.CharField(source="location")
+
+
+class VerticalContainerSerializer(serializers.Serializer):
+    """
+    Serializer for representing a vertical container with state and children.
+    """
+
+    children = ChildVerticalContainerSerializer(many=True)
+    is_published = serializers.BooleanField()

cms/djangoapps/contentstore/rest_api/v1/urls.py

@@ -1,10 +1,12 @@
 """ Contenstore API v1 URLs. """
 
+from django.conf import settings
 from django.urls import re_path, path
 
 from openedx.core.constants import COURSE_ID_PATTERN
 
 from .views import (
+    ContainerHandlerView,
     CourseDetailsView,
     CourseTeamView,
     CourseGradingView,
@@ -18,7 +20,8 @@
     ProctoringErrorsView,
     HelpUrlsView,
     VideoUsageView,
-    VideoDownloadView
+    VideoDownloadView,
+    VerticalContainerView,
 )
 
 app_name = 'v1'
@@ -94,6 +97,16 @@
         CourseRerunView.as_view(),
         name="course_rerun"
     ),
+    re_path(
+        fr'^container_handler/{settings.USAGE_KEY_PATTERN}$',
+        ContainerHandlerView.as_view(),
+        name="container_handler"
+    ),
+    re_path(
+        fr'^container/vertical/{settings.USAGE_KEY_PATTERN}/children$',
+        VerticalContainerView.as_view(),
+        name="container_vertical"
+    ),
 
     # Authoring API
     # Do not use under v1 yet (Nov. 23). The Authoring API is still experimental and the v0 versions should be used

cms/djangoapps/contentstore/rest_api/v1/views/__init__.py

@@ -14,3 +14,4 @@
     VideoDownloadView
 )
 from .help_urls import HelpUrlsView
+from .vertical_block import ContainerHandlerView, VerticalContainerView

cms/djangoapps/contentstore/rest_api/v1/views/home.py

@@ -8,7 +8,7 @@
 from openedx.core.lib.api.view_utils import view_auth_classes
 
 from ....utils import get_home_context, get_course_context, get_library_context
-from ..serializers import CourseHomeSerializer, CourseTabSerializer, LibraryTabSerializer
+from ..serializers import CourseHomeSerializer, CourseHomeTabSerializer, LibraryTabSerializer
 
 
 @view_auth_classes(is_authenticated=True)
@@ -102,7 +102,7 @@ class HomePageCoursesView(APIView):
                 description="Query param to filter by course org",
             )],
         responses={
-            200: CourseTabSerializer,
+            200: CourseHomeTabSerializer,
             401: "The requester is not authenticated.",
         },
     )
@@ -160,7 +160,7 @@ def get(self, request: Request):
             "archived_courses": archived_courses,
             "in_process_course_actions": in_process_course_actions,
         }
-        serializer = CourseTabSerializer(courses_context)
+        serializer = CourseHomeTabSerializer(courses_context)
         return Response(serializer.data)