refactor: refactor Django view to DRF

Refactor enable_certificate_generation to class based EnableCertificateGenerationAPIView

Author: mubbsharanwar

lms/djangoapps/instructor/views/api.py

@@ -101,6 +101,7 @@
 from lms.djangoapps.instructor.views.serializer import (
     AccessSerializer,
     BlockDueDateSerializer,
+    CertificateGenerationSerializer,
     CertificateSerializer,
     CertificateStatusesSerializer,
     ForumRoleNameSerializer,
@@ -3402,22 +3403,35 @@ def _instructor_dash_url(course_key, section=None):
     return url
 
 
-@require_course_permission(permissions.ENABLE_CERTIFICATE_GENERATION)
-@require_POST
-def enable_certificate_generation(request, course_id=None):
-    """Enable/disable self-generated certificates for a course.
+class EnableCertificateGenerationAPIView(APIView):
+    """Enable/disable self-generated certificates for a course."""
+    permission_classes = (IsAuthenticated, permissions.InstructorPermission)
+    permission_name = permissions.ENABLE_CERTIFICATE_GENERATION
+    serializer_class = CertificateGenerationSerializer
 
-    Once self-generated certificates have been enabled, students
-    who have passed the course will be able to generate certificates.
+    @method_decorator(ensure_csrf_cookie)
+    def post(self, request, course_id=None):
+        """
+        Once self-generated certificates have been enabled, students
+        who have passed the course will be able to generate certificates.
 
-    Redirects back to the instructor dashboard once the
-    setting has been updated.
+        Parameters:
+        - `certificates-enabled`: The true/false value based on user action.
+        - `course_id`: The ID of the course for which the extensions are being queried.
 
-    """
-    course_key = CourseKey.from_string(course_id)
-    is_enabled = (request.POST.get('certificates-enabled', 'false') == 'true')
-    certs_api.set_cert_generation_enabled(course_key, is_enabled)
-    return redirect(_instructor_dash_url(course_key, section='certificates'))
+        Redirects back to the instructor dashboard once the
+        setting has been updated.
+        """
+
+        serializer = self.serializer_class(data=request.data)
+        serializer.is_valid(raise_exception=True)
+
+        course_key = CourseKey.from_string(course_id)
+        is_enabled = serializer.validated_data["certificates-enabled"]
+
+        certs_api.set_cert_generation_enabled(course_key, is_enabled)
+
+        return redirect(_instructor_dash_url(course_key, section='certificates'))
 
 
 @method_decorator(cache_control(no_cache=True, no_store=True, must_revalidate=True), name='dispatch')

lms/djangoapps/instructor/views/api_urls.py

@@ -83,7 +83,11 @@
     path('add_users_to_cohorts', api.AddUsersToCohorts.as_view(), name='add_users_to_cohorts'),
 
     # Certificates
-    path('enable_certificate_generation', api.enable_certificate_generation, name='enable_certificate_generation'),
+    path(
+        'enable_certificate_generation',
+        api.EnableCertificateGenerationAPIView.as_view(),
+        name='enable_certificate_generation',
+     ),
     path('start_certificate_generation', api.StartCertificateGeneration.as_view(), name='start_certificate_generation'),
     path('start_certificate_regeneration', api.StartCertificateRegeneration.as_view(),
          name='start_certificate_regeneration'),

lms/djangoapps/instructor/views/serializer.py

@@ -478,6 +478,23 @@ def validate_user(self, value):
         return user
 
 
+class CertificateGenerationSerializer(serializers.Serializer):
+    """Serializer for enabling or disabling self-generated certificates for a course."""
+    certificates_enabled = serializers.BooleanField(
+        source="certificates-enabled",
+        required=True,
+        help_text="Enable or disable self-generated certificates for this course."
+    )
+
+    def to_internal_value(self, data):
+        """Convert "true"/"false" strings to boolean before validation"""
+
+        if data.get("certificates-enabled") in ["true", "false"]:
+            data = data.copy()
+            data["certificates_enabled"] = data["certificates-enabled"] == "true"
+        return super().to_internal_value(data)
+
+
 class RescoreEntranceExamSerializer(serializers.Serializer):
     """Serializer for entrance exam rescoring"""
     unique_student_identifier = serializers.CharField(required=False, allow_null=True)