Merge pull request #248 from AvaCodeSolutions/feat/244/admin-enroll

Feat/244/admin enroll

Author: payamnj

django_email_learning/platform/api/serializers.py

@@ -66,6 +66,10 @@ def validate_email(cls, email: str) -> str:
         return email
 
 
+class CreateEnrollmentRequest(BaseModel):
+    learner_email: str = Field(min_length=1, examples=["user@example.com"])
+
+
 class UserResponse(BaseModel):
     id: int
     email: str

django_email_learning/platform/api/urls.py

@@ -5,6 +5,7 @@
     GetOrCreateUserByEmail,
     SingleApiKeyView,
     CourseView,
+    EnrollmentsView,
     EnrollmentView,
     EnrollmentsStatisticsView,
     FileView,
@@ -81,6 +82,11 @@
         EnrollmentView.as_view(),
         name="enrollment_view",
     ),
+    path(
+        "organizations/<int:organization_id>/courses/<int:course_id>/enrollments/",
+        EnrollmentsView.as_view(),
+        name="enrollments_view",
+    ),
     path(
         "organizations/<int:organization_id>/courses/<int:course_id>/enrollments/statistics/",
         EnrollmentsStatisticsView.as_view(),

django_email_learning/platform/api/views.py

@@ -17,6 +17,16 @@
 from urllib.parse import urlparse
 from pydantic import ValidationError
 from enum import StrEnum
+from django_email_learning.services.command_models.enroll_command import EnrollCommand
+from django_email_learning.services.command_models.verify_enrollment_command import (
+    VerifyEnrollmentCommand,
+)
+from django_email_learning.services.command_models.exceptions.blocked_email_error import (
+    BlockedEmailError,
+)
+from django_email_learning.services.command_models.exceptions.enrollment_already_exists_error import (
+    EnrollmentAlreadyExistsError,
+)
 from django_email_learning.platform.api import serializers
 from django_email_learning.platform.api.pagniated_api_mixin import PaginatedApiMixin
 from django_email_learning.models import (
@@ -763,6 +773,50 @@ def get(self, request, *args, **kwargs) -> JsonResponse:  # type: ignore[no-unty
             return JsonResponse({"error": "An internal error occurred."}, status=500)
 
 
+@method_decorator(accessible_for(roles={"admin"}), name="post")
+class EnrollmentsView(PaginatedApiMixin, View):
+    def post(self, request, *args, **kwargs) -> JsonResponse:  # type: ignore[no-untyped-def]
+        payload = json.loads(request.body)
+        try:
+            serializer = serializers.CreateEnrollmentRequest.model_validate(payload)
+            try:
+                course = Course.objects.get(
+                    id=kwargs["course_id"], organization_id=kwargs["organization_id"]
+                )
+            except Course.DoesNotExist:
+                return JsonResponse({"error": "Course not found"}, status=404)
+            command = EnrollCommand(
+                email=serializer.learner_email,
+                course_slug=course.slug,
+                organization_id=kwargs["organization_id"],
+                no_verification=True,  # skip verification email for manual enrollments through the API
+            )
+            try:
+                command.execute()
+            except BlockedEmailError as e:
+                return JsonResponse({"error": str(e)}, status=403)
+            except EnrollmentAlreadyExistsError as e:
+                return JsonResponse({"error": str(e)}, status=409)
+
+            enrollment = Enrollment.objects.get(
+                learner__email=serializer.learner_email, course_id=kwargs["course_id"]
+            )
+            verify_command = VerifyEnrollmentCommand(
+                enrollment_id=enrollment.id,
+                verification_code=enrollment.activation_code,  # type: ignore[arg-type]
+            )
+            verify_command.execute()
+            enrollment.refresh_from_db()
+            return JsonResponse(
+                serializers.EnrollmentResponse.from_django_model(
+                    enrollment
+                ).model_dump(),
+                status=201,
+            )
+        except ValidationError as e:
+            return JsonResponse({"error": e.json()}, status=400)
+
+
 @method_decorator(accessible_for(roles={"admin", "editor", "viewer"}), name="get")
 class EnrollmentView(View):
     def get(self, request, *args, **kwargs) -> JsonResponse:  # type: ignore[no-untyped-def]

django_email_learning/platform/views.py

@@ -220,6 +220,8 @@ def get_context_data(self, **kwargs) -> dict:  # type: ignore[no-untyped-def]
     def get_locale_messages(self) -> Dict[str, str]:
         return {
             "actions": _("Actions"),
+            "enroll_learner": _("Enroll Learner"),
+            "manual_email": _("Manual Email"),
             "published": _("Published"),
             "type": _("Type"),
             "waiting_time": _("Waiting Time"),

django_email_learning/public/api/views.py

@@ -6,6 +6,12 @@
 from django_email_learning.services.command_models.exceptions.invalid_course_slug_error import (
     InvalidCourseSlugError,
 )
+from django_email_learning.services.command_models.exceptions.blocked_email_error import (
+    BlockedEmailError,
+)
+from django_email_learning.services.command_models.exceptions.enrollment_already_exists_error import (
+    EnrollmentAlreadyExistsError,
+)
 import json
 import logging
 
@@ -27,6 +33,12 @@ def post(self, request, *args, **kwargs) -> JsonResponse:  # type: ignore[no-unt
             try:
                 command.execute()
                 return JsonResponse({"status": "enrolled"}, status=200)
+            except EnrollmentAlreadyExistsError as e:
+                logger.info(f"Enrollment already exists: {e}")
+                return JsonResponse({"status": "already_enrolled"}, status=200)
+            except BlockedEmailError as e:
+                logger.error(f"Blocked email error: {e}")
+                return JsonResponse({"error": str(e)}, status=403)
             except InvalidCourseSlugError as e:
                 logger.error(f"Invalid course slug error: {e}")
                 return JsonResponse({"error": str(e)}, status=400)

django_email_learning/services/command_models/enroll_command.py

@@ -4,6 +4,12 @@
 from django_email_learning.services.command_models.exceptions.invalid_course_slug_error import (
     InvalidCourseSlugError,
 )
+from django_email_learning.services.command_models.exceptions.enrollment_already_exists_error import (
+    EnrollmentAlreadyExistsError,
+)
+from django_email_learning.services.command_models.exceptions.blocked_email_error import (
+    BlockedEmailError,
+)
 from django_email_learning.models import (
     BlockedEmail,
     Learner,
@@ -27,14 +33,15 @@ class EnrollCommand(AbstractCommand):
     email: str
     course_slug: str
     organization_id: int
+    no_verification: bool = False
 
     def execute(self) -> None:
         # Check if the email is blocked
         if BlockedEmail.objects.filter(email=self.email).exists():
             self.logger.info(
                 f"Enrollment Rejected: {mask_email(self.email)} is blocked"
             )
-            return
+            raise BlockedEmailError(f"The email {mask_email(self.email)} is blocked.")
 
         # Check if Learner with the email exists, if not create one
         learner, created = Learner.objects.get_or_create(
@@ -68,7 +75,9 @@ def execute(self) -> None:
             self.logger.info(
                 f"Enrollment Skipped: Learner ID {learner.id} is already enrolled in course '{self.course_slug}'"
             )
-            return
+            raise EnrollmentAlreadyExistsError(
+                f"Learner with email {mask_email(self.email)} is already enrolled in course '{self.course_slug}'"
+            )
 
         # Create the enrollment
         enrollment = Enrollment.objects.create(
@@ -79,6 +88,12 @@ def execute(self) -> None:
             f"Enrollment Successful: Learner ID {learner.id} enrolled in course '{self.course_slug}'. Enrollment ID: {enrollment.id}"
         )
 
+        if self.no_verification:
+            self.logger.info(
+                f"Verification email skipped for Enrollment ID: {enrollment.id} as per command parameter"
+            )
+            return
+
         # Send verification email
 
         token = jwt_service.generate_jwt(

django_email_learning/services/command_models/exceptions/blocked_email_error.py

@@ -0,0 +1,4 @@
+class BlockedEmailError(Exception):
+    """Exception raised when an email is blocked."""
+
+    pass

django_email_learning/services/command_models/exceptions/enrollment_already_exists_error.py

@@ -0,0 +1,4 @@
+class EnrollmentAlreadyExistsError(Exception):
+    """Exception raised when an enrollment already exists for a learner in a course."""
+
+    pass

frontend/platform/course/Course.jsx

@@ -3,10 +3,11 @@ import './styles.scss'
 import 'vite/modulepreload-polyfill'
 import render, { useAppContext } from '../../src/render.jsx';
 import Base from '../../src/components/Base.jsx'
+import EnrollMenu from './components/EnrollMenu.jsx';
 import DescriptionIcon from '@mui/icons-material/Description';
 import BallotIcon from '@mui/icons-material/Ballot';
 import { useState, useEffect } from 'react';
-import { Box, Grid, Button, Dialog, LinearProgress, Typography } from '@mui/material'
+import { Box, Grid, Button, Dialog, LinearProgress, Typography, Alert } from '@mui/material'
 import { useTheme } from '@mui/material/styles';
 import ContentTable from './components/ContentTable.jsx';
 import { PieChart } from '@mui/x-charts/PieChart'
@@ -27,6 +28,9 @@ function Course() {
     const [dialogMaxWidth, setDialogMaxWidth] = useState('lg');
     const [enrollmentsCount, setEnrollmentsCount] = useState(null);
     const [weeklyStats, setWeeklyStats] = useState(null);
+
+    const [pageSuccessMessage, setPageSuccessMessage] = useState('');
+
     const organizationId = localStorage.getItem('activeOrganizationId');
 
     const theme = useTheme();
@@ -75,6 +79,7 @@ function Course() {
             setDialogOpen(false);
         }
     }
+
     const getContent = async (contentId, ) => {
         console.log("Fetching content with ID:", contentId);
         const response = await fetch(`${apiBaseUrl}/organizations/${organizationId}/courses/${courseId}/contents/${contentId}/`, {
@@ -200,6 +205,13 @@ function Course() {
             ]}
             showOrganizationSwitcher={false}
         >
+            {pageSuccessMessage && (
+                <Grid size={{ xs: 12 }} px={2} pt={2}>
+                    <Alert severity="success" onClose={() => setPageSuccessMessage('')}>
+                        {pageSuccessMessage}
+                    </Alert>
+                </Grid>
+            )}
             <Grid size={{xs: 12}} py={2} pl={2}>
                 <Box p={2} sx={{ border: '1px solid', borderColor: 'border.main', backgroundColor: 'background.box', borderRadius: 2, minHeight: 300 }}>
                     {userRole !== 'viewer' && <><Button variant="contained" startIcon={<DescriptionIcon sx={{ marginLeft: direction == 'rtl' ? 1 : 0 }} />} sx={{ marginBottom: 2 }} onClick={() => {
@@ -214,7 +226,9 @@ function Course() {
                             cancelCallback={() => setDialogOpen(false)}
                             successCallback={resetDialog}
                             courseId={courseId} /></Suspense>);
-                        setDialogOpen(true);}}>{localeMessages["add_quiz"]}</Button></> }
+                        setDialogOpen(true);}}>{localeMessages["add_quiz"]}</Button>
+                    {userRole === 'admin' && <EnrollMenu successCallback={() => {setPageSuccessMessage(localeMessages['enrollment_success'] || 'Learner enrolled successfully.'); setTimeout(() => setPageSuccessMessage(''), 3000);}} />}
+                    </> }
                     <ContentTable courseId={courseId} loaded={contentLoaded} eventHandler={(event) => tableEventHandler(event)} />
                 </Box>
                 <Grid container spacing={2}>