learning-paths-plugin 0.3.4rc4__tar.gz → 0.3.4rc6__tar.gz

{learning_paths_plugin-0.3.4rc4 → learning_paths_plugin-0.3.4rc6}/CHANGELOG.rst

@@ -25,6 +25,11 @@ Added
 * Bulk unenrollment API.
 * Enrollment audit model that tracks the enrollment state transitions.
 
+Changed
+=======
+
+* The Learning Paths API includes start and end dates for its steps.
+
 0.3.3 - 2025-05-23
 ******************
 

{learning_paths_plugin-0.3.4rc4/learning_paths_plugin.egg-info → learning_paths_plugin-0.3.4rc6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.4rc4
+Version: 0.3.4rc6
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -129,6 +129,11 @@ Added
 * Bulk unenrollment API.
 * Enrollment audit model that tracks the enrollment state transitions.
 
+Changed
+=======
+
+* The Learning Paths API includes start and end dates for its steps.
+
 0.3.3 - 2025-05-23
 ******************
 

{learning_paths_plugin-0.3.4rc4 → learning_paths_plugin-0.3.4rc6}/learning_paths/__init__.py

@@ -2,4 +2,4 @@
 Learning Paths plugin.
 """
 
-__version__ = "0.3.4-rc4"
+__version__ = "0.3.4-rc6"

{learning_paths_plugin-0.3.4rc4 → learning_paths_plugin-0.3.4rc6}/learning_paths/api/v1/serializers.py

@@ -97,7 +97,7 @@ class LearningPathGradeSerializer(serializers.Serializer):
 class LearningPathStepSerializer(serializers.ModelSerializer):
     class Meta:
         model = LearningPathStep
-        fields = ["order", "course_key", "due_date", "weight"]
+        fields = ["order", "course_key", "course_dates", "weight"]
 
 
 class LearningPathListSerializer(serializers.ModelSerializer):

{learning_paths_plugin-0.3.4rc4 → learning_paths_plugin-0.3.4rc6}/learning_paths/api/v1/views.py

@@ -452,12 +452,13 @@ class BulkEnrollView(APIView):
         `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).
+        * For emails with active LearningPathEnrollmentAllowed records, it deactivates those records.
 
         """
-        learning_paths, existing_users, _ = self._setup_bulk_operation(request)
+        learning_paths, existing_users, emails = self._setup_bulk_operation(request)
 
         enrollments_unenrolled = []
+        enrollment_allowed_deactivated = []
 
         for learning_path in learning_paths:
             for user in existing_users:
@@ -474,9 +475,33 @@ class BulkEnrollView(APIView):
                     enrollment._audit = audit_data  # pylint: disable=protected-access
                     enrollment.save()
 
+            for email in emails:
+                try:
+                    validate_email(email)
+                except ValidationError:
+                    logger.warning("BulkEnrollView: Invalid email: %s", email)
+                    continue
+
+                enrollment_allowed = LearningPathEnrollmentAllowed.objects.filter(
+                    email=email,
+                    learning_path=learning_path,
+                ).first()
+
+                if enrollment_allowed:
+                    if enrollment_allowed.is_active:
+                        state_transition = LearningPathEnrollmentAudit.ALLOWEDTOENROLL_TO_UNENROLLED
+                        enrollment_allowed.is_active = False
+                        enrollment_allowed_deactivated.append(enrollment_allowed)
+                    else:
+                        state_transition = LearningPathEnrollmentAudit.UNENROLLED_TO_UNENROLLED
+                    audit_data = self._create_audit_data(request, state_transition)
+                    enrollment_allowed._audit = audit_data  # pylint: disable=protected-access
+                    enrollment_allowed.save()
+
         return Response(
             {
                 "enrollments_unenrolled": len(enrollments_unenrolled),
+                "enrollment_allowed_deactivated": len(enrollment_allowed_deactivated),
             },
             status=status.HTTP_204_NO_CONTENT,
         )

{learning_paths_plugin-0.3.4rc4 → learning_paths_plugin-0.3.4rc6}/learning_paths/compat.py

@@ -46,18 +46,16 @@ def get_course_keys_with_outlines() -> list[CourseKey]:
     return course_keys_with_outlines()
 
 
-def get_course_due_date(course_key: CourseKey) -> datetime | None:
-    """
-    Retrieve course end date.
-    """
+def get_course_dates(course_key: CourseKey) -> tuple[datetime | None, datetime | None]:
+    """Retrieve course start and end dates."""
     # pylint: disable=import-outside-toplevel, import-error
     from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
 
     try:
         overview = CourseOverview.objects.get(id=course_key)
-        return overview.end
+        return overview.start, overview.end
     except CourseOverview.DoesNotExist:
-        return None
+        return None, None
 
 
 def enroll_user_in_course(user: AbstractBaseUser, course_key: CourseKey) -> bool:

learning_paths_plugin-0.3.4rc6/learning_paths/migrations/0014_learningpathenrollmentallowed_is_active.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.20 on 2025-05-30 19:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("learning_paths", "0013_enrollment_audit"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="learningpathenrollmentallowed",
+            name="is_active",
+            field=models.BooleanField(
+                db_index=True, default=True, help_text="Indicates if the enrollment allowance is active"
+            ),
+        ),
+    ]

{learning_paths_plugin-0.3.4rc4 → learning_paths_plugin-0.3.4rc6}/learning_paths/models.py

@@ -19,7 +19,7 @@ from model_utils.models import TimeStampedModel
 from opaque_keys.edx.django.models import CourseKeyField
 from slugify import slugify
 
-from .compat import get_course_due_date, get_user_course_grade
+from .compat import get_course_dates, get_user_course_grade
 from .keys import LearningPathKeyField
 
 log = logging.getLogger(__name__)
@@ -203,9 +203,9 @@ class LearningPathStep(TimeStampedModel):
     )
 
     @property
-    def due_date(self) -> datetime | None:
+    def course_dates(self) -> tuple[datetime | None, datetime | None]:
         """Retrieve the due date for this course."""
-        return get_course_due_date(self.course_key)
+        return get_course_dates(self.course_key)
 
     def __str__(self):
         """User-friendly string representation of this model."""
@@ -372,6 +372,9 @@ class LearningPathEnrollmentAllowed(TimeStampedModel):
     email = models.EmailField(db_index=True)
     learning_path = models.ForeignKey(LearningPath, on_delete=models.CASCADE)
     user = models.ForeignKey(User, on_delete=models.CASCADE, blank=True, null=True)
+    is_active = models.BooleanField(
+        default=True, db_index=True, help_text=_("Indicates if the enrollment allowance is active")
+    )
 
     def __str__(self):
         """User-friendly string representation of this model."""

{learning_paths_plugin-0.3.4rc4 → learning_paths_plugin-0.3.4rc6}/learning_paths/receivers.py

@@ -39,7 +39,7 @@ def process_pending_enrollments(sender, instance, created, **kwargs):
         return
 
     logger.info("[LearningPaths] Processing pending enrollments for user %s", instance)
-    pending_enrollments = LearningPathEnrollmentAllowed.objects.filter(email=instance.email)
+    pending_enrollments = LearningPathEnrollmentAllowed.objects.filter(email=instance.email, is_active=True)
     enrollments_created = 0
 
     for entry in pending_enrollments:
@@ -67,6 +67,7 @@ def process_pending_enrollments(sender, instance, created, **kwargs):
                 entry.learning_path.key,
             )
         finally:
+            entry.is_active = False
             entry.user = instance
             entry.save()
 
@@ -129,6 +130,8 @@ def create_enrollment_allowed_audit(sender, instance, created, **kwargs):
     if not (audit_data := getattr(instance, "_audit", {})):
         return
 
+    audit_data.setdefault("state_transition", LearningPathEnrollmentAudit.UNENROLLED_TO_ALLOWEDTOENROLL)
+
     audit_data["state_transition"] = audit_data.get(
         "state_transition", LearningPathEnrollmentAudit.UNENROLLED_TO_ALLOWEDTOENROLL
     )

{learning_paths_plugin-0.3.4rc4 → learning_paths_plugin-0.3.4rc6/learning_paths_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.4rc4
+Version: 0.3.4rc6
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -129,6 +129,11 @@ Added
 * Bulk unenrollment API.
 * Enrollment audit model that tracks the enrollment state transitions.
 
+Changed
+=======
+
+* The Learning Paths API includes start and end dates for its steps.
+
 0.3.3 - 2025-05-23
 ******************
 

{learning_paths_plugin-0.3.4rc4 → learning_paths_plugin-0.3.4rc6}/learning_paths_plugin.egg-info/SOURCES.txt

@@ -37,6 +37,7 @@ learning_paths/migrations/0010_learningpath_invite_only.py
 learning_paths/migrations/0011_replace_learningpath_image_url_with_image.py
 learning_paths/migrations/0012_alter_learningpath_subtitle.py
 learning_paths/migrations/0013_enrollment_audit.py
+learning_paths/migrations/0014_learningpathenrollmentallowed_is_active.py
 learning_paths/migrations/__init__.py
 learning_paths/templates/learning_paths/base.html
 learning_paths_plugin.egg-info/PKG-INFO