[BB-9570] Implement Learning Path Enrollment API

.annotation_safe_list.yml

@@ -7,6 +7,11 @@
 # fake_app_2.FakeModel2:
 #    ".. choice_annotation:": foo, bar, baz
 
+learning_paths.HistoricalLearningPathEnrollment:
+  ".. pii": "The email field is not retired to allow future learners to enroll."
+  ".. pii_types": "email_address"
+  ".. pii_retirement": "retained"
+
 admin.LogEntry:
   ".. no_pii:": "This model has no PII"
 auth.Group:

.gitignore

@@ -63,3 +63,5 @@ docs/learning_paths.*.rst
 # Private requirements
 requirements/private.in
 requirements/private.txt
+.idea
+default.db

docs/decisions/0003-learning-path-enrollment-api.rst

@@ -90,6 +90,7 @@ necessary timestamps.
 
 .. _CourseEnrollmentAllowed: https://github.com/openedx/edx-platform/blob/925716415c7794d3447acf575be241d767f5e07c/common/djangoapps/student/models/course_enrollment.py#L1588
 
+.. _4-enroll-api:
 
 4. Enroll API
 =============
@@ -98,7 +99,7 @@ Implement an API exposing the LearningPathEnrollment model. This API will allow
 learners to be enrolled in the Learning Path.
 
 +---------------------+-------------------------------------------------------+
-| API Path            | /api/v1/learning-path-enrollment/<learning_path_id>   |
+| API Path            | /api/v1/learning-paths/<learning_path_id>/enrollment/ |
 +---------------------+-------------------------------------------------------+
 | Methods             | GET, POST, DELETE                                     |
 +---------------------+-------------------------------------------------------+
@@ -180,27 +181,27 @@ This API would list all the Learning Path enrollments
 * of the user making the request, for a non-staff user
 * of all users, for a staff user
 
-+---------------------+-------------------------------------------------------+
-| API Path            | /api/v1/enrollment/                                   |
-+---------------------+-------------------------------------------------------+
-| Methods             | GET                                                   |
-+---------------------+-------------------------------------------------------+
-| Permissions Required| LoggedIn                                              |
-+---------------------+-------------------------------------------------------+
++---------------------+----------------------------------------------+
+| API Path            | /api/v1/learning-paths/enrollments/          |
++---------------------+----------------------------------------------+
+| Methods             | GET                                          |
++---------------------+----------------------------------------------+
+| Permissions Required| LoggedIn                                     |
++---------------------+----------------------------------------------+
 
 6. Bulk enrollment API
 ======================
 
 In order for staff to bulk enroll users into learning paths, implement the
 following API.
 
-+---------------------+-------------------------------------------------------+
-| API Path            | /api/v1/enrollment/bulk_enroll/                       |
-+---------------------+-------------------------------------------------------+
-| Methods             | POST                                                  |
-+---------------------+-------------------------------------------------------+
-| Permissions Required| Staff or Admin                                        |
-+---------------------+-------------------------------------------------------+
++---------------------+-------------------------------------------------+
+| API Path            | /api/v1/learning-paths/enrollments/bulk-enroll/ |
++---------------------+-------------------------------------------------+
+| Methods             | POST                                            |
++---------------------+-------------------------------------------------+
+| Permissions Required| Staff or Admin                                  |
++---------------------+-------------------------------------------------+
 
 The API will accept the following JSON data.
 

learning_paths/api/urls.py

@@ -1,4 +1,4 @@
-""" API URLs. """
+"""API URLs."""
 
 from django.urls import include, path
 

learning_paths/api/v1/filters.py

@@ -0,0 +1,16 @@
+"""
+Django REST framework filters.
+"""
+
+from rest_framework.filters import BaseFilterBackend
+
+
+class AdminOrSelfFilterBackend(BaseFilterBackend):
+    """
+    A filter backend that limits the queryset to the current user for non-staff.
+    """
+
+    def filter_queryset(self, request, queryset, view):
+        if request.user.is_staff:
+            return queryset
+        return queryset.filter(user=request.user)

learning_paths/api/v1/permissions.py

@@ -0,0 +1,27 @@
+"""
+Django REST framework permissions.
+"""
+
+from rest_framework.permissions import BasePermission
+
+
+class IsAdminOrSelf(BasePermission):
+    """
+    Permission to allow only admins or the user themselves to access the API.
+
+    Non-staff users cannot pass "username" that is not their own.
+    """
+
+    def has_permission(self, request, view):
+        if request.user.is_staff:
+            return True
+
+        if request.method == "GET":
+            username = request.query_params.get("username")
+        else:
+            username = request.data.get("username")
+
+        # For learners, the username passed should match the logged in user
+        if username:
+            return request.user.username == username
+        return True

learning_paths/api/v1/serializers.py

@@ -4,7 +4,7 @@
 
 from rest_framework import serializers
 
-from learning_paths.models import LearningPath
+from learning_paths.models import LearningPath, LearningPathEnrollment
 
 DEFAULT_STATUS = "active"
 IMAGE_WIDTH = 1440
@@ -85,3 +85,9 @@ class LearningPathGradeSerializer(serializers.Serializer):
     learning_path_id = serializers.UUIDField()
     grade = serializers.FloatField()
     required_grade = serializers.FloatField()
+
+
+class LearningPathEnrollmentSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = LearningPathEnrollment
+        fields = ("user", "learning_path", "is_active", "enrolled_at")

learning_paths/api/v1/tests/factories.py

@@ -1,9 +1,15 @@
 # pylint: disable=missing-module-docstring,missing-class-docstring
+from datetime import datetime, timezone
+
 import factory
 from django.contrib import auth
 from factory.fuzzy import FuzzyText
 
-from learning_paths.models import LearningPath, LearningPathGradingCriteria
+from learning_paths.models import (
+    LearningPath,
+    LearningPathEnrollment,
+    LearningPathGradingCriteria,
+)
 
 User = auth.get_user_model()
 
@@ -31,7 +37,6 @@ class Meta:
     uuid = factory.Faker("uuid4")
     display_name = FuzzyText()
     slug = FuzzyText()
-    display_name = FuzzyText()
     description = FuzzyText()
     sequential = False
 
@@ -43,3 +48,17 @@ class Meta:
     learning_path = factory.SubFactory(LearnerPathwayFactory)
     required_completion = 0.80
     required_grade = 0.75
+
+
+class LearningPathEnrollmentFactory(factory.django.DjangoModelFactory):
+    """
+    Factory for LearningPathEnrollment model.
+    """
+
+    user = factory.SubFactory(UserFactory)
+    learning_path = factory.SubFactory(LearnerPathwayFactory)
+    is_active = True
+    enrolled_at = factory.LazyFunction(lambda: datetime.now(timezone.utc))
+
+    class Meta:
+        model = LearningPathEnrollment