Merge pull request #135 from AvaCodeSolutions/feat/128/single-learner-api-view

feat: #128 single learner API view

Author: payamnj

django_email_learning/platform/api/serializers.py

@@ -17,6 +17,7 @@
     CourseContent,
     Course,
     QuizSelectionStrategy,
+    EnrollmentStatus,
 )
 import enum
 
@@ -314,11 +315,25 @@ def from_seconds(cls, seconds: int) -> "WaitingPeriod":
             )
 
 
+class EnrollmentSummaryResponse(BaseModel):
+    id: int
+    course_title: str
+    status: EnrollmentStatus
+
+
 class LearnerResponse(BaseModel):
     id: int
     email: str
 
 
+class LearnerDetailResponse(BaseModel):
+    id: int
+    email: str
+    enrollments: list[EnrollmentSummaryResponse]
+
+    model_config = ConfigDict(from_attributes=True)
+
+
 class CreateCourseContentRequest(BaseModel):
     priority: int | None = Field(gt=0, examples=[1], default=None)
     waiting_period: WaitingPeriod

django_email_learning/platform/api/urls.py

@@ -10,6 +10,7 @@
     SingleCourseContentView,
     UpdateSessionView,
     LearnersView,
+    SingleLearnerView,
 )
 
 app_name = "django_email_learning"
@@ -50,6 +51,11 @@
         LearnersView.as_view(),
         name="learners_view",
     ),
+    path(
+        "organizations/<int:organization_id>/learners/<int:learner_id>/",
+        SingleLearnerView.as_view(),
+        name="single_learner_view",
+    ),
     path("organizations/", OrganizationsView.as_view(), name="organizations_view"),
     path("session", UpdateSessionView.as_view(), name="update_session_view"),
     path("", page_not_found, name="root"),

django_email_learning/platform/api/views.py

@@ -25,6 +25,10 @@
     is_platform_admin,
 )
 import json
+import logging
+
+
+logger = logging.getLogger(__name__)
 
 
 @method_decorator(ensure_csrf_cookie, name="get")
@@ -462,6 +466,34 @@ def get(self, request, *args, **kwargs) -> JsonResponse:  # type: ignore[no-unty
         )
 
 
+@method_decorator(accessible_for(roles={"admin", "editor", "viewer"}), name="get")
+class SingleLearnerView(View):
+    def get(self, request, *args, **kwargs) -> JsonResponse:  # type: ignore[no-untyped-def]
+        try:
+            learner = Learner.objects.get(id=kwargs["learner_id"])
+            enrollments = Enrollment.objects.filter(learner=learner)
+            enroolments_list = []
+            for enrollment in enrollments:
+                enroolments_list.append(
+                    serializers.EnrollmentSummaryResponse(
+                        id=enrollment.id,
+                        course_title=enrollment.course.title,
+                        status=EnrollmentStatus(enrollment.status),
+                    )
+                )
+            return JsonResponse(
+                serializers.LearnerDetailResponse(
+                    id=learner.id, email=learner.email, enrollments=enroolments_list
+                ).model_dump(),
+                status=200,
+            )
+        except Learner.DoesNotExist:
+            return JsonResponse({"error": "Learner not found"}, status=404)
+        except ValidationError as e:
+            logger.error(f"Error in SingleLearnerView: {e.json()}")
+            return JsonResponse({"error": "An internal error occurred."}, status=500)
+
+
 class RootView(View):
     def get(self, request, *args, **kwargs) -> JsonResponse:  # type: ignore[no-untyped-def]
         return JsonResponse({"message": "Email Learning API is running."}, status=200)

tests/platform/api/test_views/test_learner_single_view.py

@@ -0,0 +1,27 @@
+from django.urls import reverse
+
+
+def test_single_llearner_viewe(viewer_client, enrollment):
+    url = reverse(
+        "django_email_learning:api_platform:single_learner_view",
+        kwargs={"organization_id": 1, "learner_id": enrollment.learner.id},
+    )
+    response = viewer_client.get(url)
+    assert response.status_code == 200
+    data = response.json()
+    assert data["id"] == enrollment.learner.id
+    assert data["email"] == enrollment.learner.email
+    assert len(data["enrollments"]) == 1
+    enrollment_data = data["enrollments"][0]
+    assert enrollment_data["id"] == enrollment.id
+    assert enrollment_data["course_title"] == enrollment.course.title
+    assert enrollment_data["status"] == enrollment.status.value
+
+
+def test_single_learner_view_not_accessible_for_no_role(anonymous_client, enrollment):
+    url = reverse(
+        "django_email_learning:api_platform:single_learner_view",
+        kwargs={"organization_id": 1, "learner_id": enrollment.learner.id},
+    )
+    response = anonymous_client.get(url)
+    assert response.status_code == 401