learning-paths-plugin 0.3.4rc2__tar.gz → 0.3.4rc3__tar.gz

{learning_paths_plugin-0.3.4rc2 → learning_paths_plugin-0.3.4rc3}/CHANGELOG.rst

@@ -22,6 +22,7 @@ Unreleased
 Added
 =====
 
+* Bulk unenrollment API.
 * Enrollment audit model that tracks the enrollment state transitions.
 
 0.3.3 - 2025-05-23

{learning_paths_plugin-0.3.4rc2/learning_paths_plugin.egg-info → learning_paths_plugin-0.3.4rc3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.4rc2
+Version: 0.3.4rc3
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -126,6 +126,7 @@ Unreleased
 Added
 =====
 
+* Bulk unenrollment API.
 * Enrollment audit model that tracks the enrollment state transitions.
 
 0.3.3 - 2025-05-23

{learning_paths_plugin-0.3.4rc2 → learning_paths_plugin-0.3.4rc3}/learning_paths/__init__.py

@@ -2,4 +2,4 @@
 Learning Paths plugin.
 """
 
-__version__ = "0.3.4-rc2"
+__version__ = "0.3.4-rc3"

{learning_paths_plugin-0.3.4rc2 → learning_paths_plugin-0.3.4rc3}/learning_paths/api/v1/views.py

@@ -9,6 +9,7 @@ from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.core.exceptions import ObjectDoesNotExist, PermissionDenied, ValidationError
 from django.core.validators import validate_email
+from django.db.models import QuerySet
 from django.shortcuts import get_object_or_404
 from opaque_keys import InvalidKeyError
 from opaque_keys.edx.keys import CourseKey
@@ -16,6 +17,7 @@ from rest_framework import generics, status, viewsets
 from rest_framework.exceptions import NotFound, ParseError
 from rest_framework.pagination import PageNumberPagination
 from rest_framework.permissions import IsAdminUser, IsAuthenticated
+from rest_framework.request import Request
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
@@ -296,13 +298,53 @@ class ListEnrollmentsView(generics.ListAPIView):
 
 class BulkEnrollView(APIView):
     """
-    Bulk enrollment API for LearningPathEnrollment.
-
+    Bulk enrollment/unenrollment API for LearningPathEnrollment.
     """
 
     permission_classes = [IsAdminUser]
 
-    def post(self, request, *args, **kwargs):
+    @staticmethod
+    def _process_input_data(request: Request) -> tuple[list[str], list[str]]:
+        """Extract and validate input data from request."""
+        data = request.data
+        learning_paths_keys = data.get("learning_paths", "").split(",")
+        emails = data.get("emails", "").split(",")
+
+        return learning_paths_keys, emails
+
+    @staticmethod
+    def _validate_learning_paths(learning_paths_keys: list[str]) -> QuerySet[LearningPath]:
+        """Validate learning path keys and return valid ones."""
+        valid_learning_paths_keys = []
+        for key in learning_paths_keys:
+            try:
+                LearningPathKey.from_string(key)
+                valid_learning_paths_keys.append(key)
+            except InvalidKeyError:
+                logger.warning("BulkEnrollView: Invalid learning path key: %s", key)
+
+        return LearningPath.objects.filter(key__in=valid_learning_paths_keys)
+
+    @staticmethod
+    def _create_audit_data(request: Request, state_transition: str) -> dict[str, str]:
+        """Create audit data dictionary."""
+        return {
+            "enrolled_by": request.user,
+            "reason": request.data.get("reason", ""),
+            "org": request.data.get("org", ""),
+            "role": request.data.get("role", ""),
+            "state_transition": state_transition,
+        }
+
+    def _setup_bulk_operation(self, request: Request) -> tuple[QuerySet[LearningPath], QuerySet[User], list[str]]:
+        """Common setup for bulk operations."""
+        learning_paths_keys, emails = self._process_input_data(request)
+        learning_paths = self._validate_learning_paths(learning_paths_keys)
+        existing_users = User.objects.filter(email__in=emails)
+
+        return learning_paths, existing_users, emails
+
+    def post(self, request: Request, *args, **kwargs) -> Response:
         """
         Bulk Enroll learners in Learning Paths.
 
@@ -313,11 +355,17 @@ class BulkEnrollView(APIView):
 
             {
                 "learning_paths": "learning_path_1,learning_path_2",
-                "emails": "user_1@example.com,user_2@example.com"
+                "emails": "user_1@example.com,user_2@example.com",
+                "reason": "Bulk enrollment for new cohort",
+                "org": "organization_name",
+                "role": "student"
             }
 
         `learning_paths` (str): A comma separated list of learning path IDs.
         `emails` (str): A comma separated list of email addresses.
+        `reason` (str, optional): Reason for enrollment, used for audit.
+        `org` (str, optional): Organization identifier, used for audit.
+        `role` (str, optional): User role, used for audit.
 
         * For existing users, it creates a new LearningPathEnrollment record, automatically
           enrolling them in the learning path. It also creates a LearningPathAllowed record
@@ -326,41 +374,18 @@ class BulkEnrollView(APIView):
           with just the email address, allowing them to get enrolled when they register.
 
         """
-        data = request.data
-        learning_paths_keys = data.get("learning_paths", "").split(",")
-        emails = data.get("emails", "").split(",")
-
-        audit_data = {
-            "enrolled_by": request.user,
-            "reason": data.get("reason", ""),
-            "org": data.get("org", ""),
-            "role": data.get("role", ""),
-            "state_transition": LearningPathEnrollmentAudit.DEFAULT_TRANSITION_STATE,
-        }
-
-        valid_learning_paths_keys = []
-        for key in learning_paths_keys:
-            try:
-                LearningPathKey.from_string(key)
-                valid_learning_paths_keys.append(key)
-            except InvalidKeyError:
-                logger.warning("BulkEnrollView: Invalid learning path key: %s", key)
-
-        learning_paths = LearningPath.objects.filter(key__in=valid_learning_paths_keys)
-
-        existing_users = User.objects.filter(email__in=emails)
+        learning_paths, existing_users, emails = self._setup_bulk_operation(request)
         non_existing_emails = set(emails) - set(u.email for u in existing_users)
 
         enrollments_created = []
         enrollment_allowed_created = []
 
         for learning_path in learning_paths:
-
             # Create LearningPathEnrollment for existing users
             for user in existing_users:
                 enrollment = LearningPathEnrollment.objects.filter(user=user, learning_path=learning_path).first()
                 enrolled_now = False
-                audit_data["state_transition"] = LearningPathEnrollmentAudit.UNENROLLED_TO_ENROLLED
+                audit_data = self._create_audit_data(request, LearningPathEnrollmentAudit.UNENROLLED_TO_ENROLLED)
                 if enrollment:
                     if not enrollment.is_active:
                         enrollment.is_active = True
@@ -391,7 +416,7 @@ class BulkEnrollView(APIView):
                 if created:
                     enrollment_allowed_created.append(allowed)
 
-                audit_data["state_transition"] = LearningPathEnrollmentAudit.UNENROLLED_TO_ALLOWEDTOENROLL
+                audit_data = self._create_audit_data(request, LearningPathEnrollmentAudit.UNENROLLED_TO_ALLOWEDTOENROLL)
                 allowed._audit = audit_data  # pylint: disable=protected-access
                 allowed.save()
 
@@ -403,6 +428,59 @@ class BulkEnrollView(APIView):
             status=status.HTTP_201_CREATED,
         )
 
+    def delete(self, request, *args, **kwargs) -> Response:
+        """
+        Bulk Unenroll learners from Learning Paths.
+
+        The "bulk unenroll" API provides a way for the staff to unenroll multiple learners
+        from multiple learning paths at once.
+
+        Example payload::
+
+            {
+                "learning_paths": "learning_path_1,learning_path_2",
+                "emails": "user_1@example.com,user_2@example.com",
+                "reason": "End of semester cleanup",
+                "org": "organization_name",
+                "role": "student"
+            }
+
+        `learning_paths` (str): A comma separated list of learning path IDs.
+        `emails` (str): A comma separated list of email addresses.
+        `reason` (str, optional): Reason for unenrollment, used for audit.
+        `org` (str, optional): Organization identifier, used for audit.
+        `role` (str, optional): User role, used for audit.
+
+        * For existing users, it deactivates their LearningPathEnrollment records.
+        * Does not affect LearningPathEnrollmentAllowed records (allowed to enroll records).
+
+        """
+        learning_paths, existing_users, _ = self._setup_bulk_operation(request)
+
+        enrollments_unenrolled = []
+
+        for learning_path in learning_paths:
+            for user in existing_users:
+                enrollment = LearningPathEnrollment.objects.filter(user=user, learning_path=learning_path).first()
+
+                if enrollment:
+                    if enrollment.is_active:
+                        state_transition = LearningPathEnrollmentAudit.ENROLLED_TO_UNENROLLED
+                        enrollment.is_active = False
+                        enrollments_unenrolled.append(enrollment)
+                    else:
+                        state_transition = LearningPathEnrollmentAudit.UNENROLLED_TO_UNENROLLED
+                    audit_data = self._create_audit_data(request, state_transition)
+                    enrollment._audit = audit_data  # pylint: disable=protected-access
+                    enrollment.save()
+
+        return Response(
+            {
+                "enrollments_unenrolled": len(enrollments_unenrolled),
+            },
+            status=status.HTTP_204_NO_CONTENT,
+        )
+
 
 class LearningPathCourseEnrollmentView(APIView):
     """API View to enroll a user in a course that's part of a learning path."""

{learning_paths_plugin-0.3.4rc2 → learning_paths_plugin-0.3.4rc3/learning_paths_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.4rc2
+Version: 0.3.4rc3
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -126,6 +126,7 @@ Unreleased
 Added
 =====
 
+* Bulk unenrollment API.
 * Enrollment audit model that tracks the enrollment state transitions.
 
 0.3.3 - 2025-05-23