Merge pull request #15 from DevOps-Cloud-Team5/SCRUM-88-enroll-api

enroll invididual students and allow admins to mass enroll

Author: Imafe

api/migrations/0004_alter_attendenceacknowledgement_lecture.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-03-14 11:00
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0003_courselecture_attendenceacknowledgement'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='attendenceacknowledgement',
+            name='lecture',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='lecture_ack', to='api.courselecture'),
+        ),
+    ]

api/migrations/0005_remove_course_schedule.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.2 on 2024-03-14 11:10
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0004_alter_attendenceacknowledgement_lecture'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='course',
+            name='schedule',
+        ),
+    ]

api/models.py

@@ -61,7 +61,6 @@ class LectureTypes(models.TextChoices):
 
 class Course(models.Model):
     course_name = models.CharField(max_length=50)
-    schedule = models.JSONField(default=list) 
 
     objects = models.Manager()
 
@@ -77,6 +76,9 @@ def get_teachers(self):
     def get_lectures(self):
         return [lecture for lecture in CourseLecture.objects.filter(course=self)]
 
+    def is_user_enrolled(self, user : User):
+        return bool(UserCourse.objects.filter(user=user, course=self))
+
     def add_user_to_course(self, user: User):
         UserCourse.objects.create(user=user, course=self).save()
 
@@ -118,7 +120,7 @@ class AttendenceAcknowledgement(models.Model):
     attended_student = models.BooleanField(default=False)
     attended_teacher = models.BooleanField(default=False)
     student = models.ForeignKey(User, null=False, related_name='user_ack', on_delete=models.CASCADE)
-    lecture = models.ForeignKey(CourseLecture, null=False, related_name='lecture', on_delete=models.CASCADE)
+    lecture = models.ForeignKey(CourseLecture, null=False, related_name='lecture_ack', on_delete=models.CASCADE)
 
 
 

api/serializers.py

@@ -6,7 +6,7 @@
 from rest_framework_simplejwt.serializers import TokenObtainPairSerializer
 from rest_framework.validators import UniqueValidator
 
-from .models import Course
+from .models import AccountRoles, Course
 
 User = get_user_model()
 
@@ -69,7 +69,23 @@ def validate(self, attrs):
         return attrs
 
     def create(self, validated_data):
-        course_id = validated_data.get("course_id", "") or "_".join(validated_data['course_name'].lower().split())
-        c = Course.objects.create(course_name=validated_data['course_name'], course_id=course_id)
+        c = Course.objects.create(course_name=validated_data['course_name'])
         c.save()
-        return c
+        return c
+
+
+ 
+class MassEnrollSerializer(serializers.Serializer):
+    usernames = serializers.ListField(required=True, allow_empty=False, child=serializers.CharField(max_length=150))
+
+    def validate_enroll(self, username):
+        user_query = User.objects.all().filter(username=username)
+        if not user_query: raise serializers.ValidationError({"error": f"user '{username}' does not exist"})
+        if user_query[0].role == AccountRoles.ADMIN: raise serializers.ValidationError({"error": f"cannot enroll an admin account into a course"})
+        
+        course : Course = self.context.get("course")
+        if course.is_user_enrolled(user_query[0]): raise serializers.ValidationError({"error": f"user '{username}' is already enrolled in '{course.course_name}'"})
+
+    def validate(self, attrs):
+        for username in attrs["usernames"]: self.validate_enroll(username)
+        return attrs

api/urls.py

@@ -18,6 +18,7 @@
 from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView
 
 from .views import (
+                    MassEnrollCourseView,
                     test, 
                     genAdmin, 
 
@@ -55,10 +56,11 @@
 
     # All course paths
     path('course/create/', CreateCourseView.as_view(), name='course_create'),
-    path('course/update/<course_id>', UpdateCourseView.as_view(), name='course_update'),
-    path('course/delete/<course_id>', DestroyCourseView.as_view(), name='course_delete'),
-    path('course/enroll/<course_id>', EnrollCourseView.as_view(), name='course_enroll'),
-    path('course/get/', GetCourseByName.as_view(), name='course_get'),
+    path('course/update/<pk>', UpdateCourseView.as_view(), name='course_update'),
+    path('course/delete/<pk>', DestroyCourseView.as_view(), name='course_delete'),
+    path('course/enroll/<pk>', EnrollCourseView.as_view(), name='course_enroll'),
+    path('course/mass_enroll/<pk>', MassEnrollCourseView.as_view(), name='course_mass_enroll'),
+    path('course/get/<pk>', GetCourseByName.as_view(), name='course_get'),
     path('course/getall/', GetCoursesAll.as_view(), name='course_getall'),
 
     # Documentation

api/views.py

@@ -14,7 +14,7 @@
 
 from .permissions import IsTeacher, IsAdmin, IsStudent
 from .models import Course, AccountRoles
-from .serializers import CustomTokenSerializer, CreateUserSerializer, UserSerializer, CourseCreateSerializer, CourseSerializer
+from .serializers import CustomTokenSerializer, CreateUserSerializer, MassEnrollSerializer, UserSerializer, CourseCreateSerializer, CourseSerializer
 
 import pdb
 
@@ -162,51 +162,66 @@ class CreateCourseView(generics.CreateAPIView):
 class UpdateCourseView(generics.UpdateAPIView):
     authentication_classes = [JWTAuthentication]
     permission_classes = [IsTeacher]
-    lookup_field = 'course_id'
+    lookup_field = 'pk'
 
     queryset = Course.objects.all()
     serializer_class = CourseSerializer
 
 class DestroyCourseView(generics.DestroyAPIView):
     authentication_classes = [JWTAuthentication]
     permission_classes = [IsTeacher]
-    lookup_field = 'course_id'
+    lookup_field = 'pk'
 
     queryset = Course.objects.all()
     serializer_class = CourseSerializer
 
-# TODO: fix which username is enrolled
 class EnrollCourseView(generics.GenericAPIView):
     authentication_classes = [JWTAuthentication]
     permission_classes = [IsStudent]
-    lookup_field = 'course_id'
+    lookup_field = 'pk'
 
     queryset = Course.objects.all()
     serializer_class = CourseSerializer
 
     def post(self, request, *args, **kwargs):
-        req = request.data
-        username = request.user.username
-        if "username" not in req or req["username"] == "":
-            return Response({"error", "username is required"}, status=status.HTTP_400_BAD_REQUEST)
+        if request.user.role == AccountRoles.ADMIN: 
+            return Response({"error": f"cannot enroll an admin account into a course"}, status=status.HTTP_400_BAD_REQUEST)
 
-        if request.user.role != "admin" and username != req["username"]:
-            return Response({"error", "user does not have permissions for this action"}, status=status.HTTP_401_UNAUTHORIZED)
-            
-        obj = self.get_object()
-        key, target_list = ("enrolled_students", obj.enrolled_students) if request.user.role == "student" else ("teachers", obj.teachers)
-        
-        if req["username"] in target_list:
-            return Response({"error", f"user '{req.username}' is already part of '{obj.course_id}'"}, status=status.HTTP_400_BAD_REQUEST)
+        obj : Course = self.get_object()
+        user = request.user
+        username = user.username
 
-        data = {key: target_list + [req["username"]]}
-        serializer = self.get_serializer(obj, data=data, partial=True)
-        serializer.is_valid(raise_exception=True)
-        serializer.save()
+        if obj.is_user_enrolled(request.user):
+            return Response({"error": f"{username} is already enrolled in {obj.course_name}"}, status=status.HTTP_400_BAD_REQUEST)
+            
+        obj.add_user_to_course(user)
 
         if getattr(obj, '_prefetched_objects_cache', None):
             obj._prefetched_objects_cache = {}
-        return Response(serializer.data)
+            
+        return Response({"ok": f"succesfully enrolled {username} in {obj.course_name}"}, status=status.HTTP_200_OK)
+
+class MassEnrollCourseView(generics.GenericAPIView):
+    authentication_classes = [JWTAuthentication]
+    permission_classes = [IsAdmin]
+    lookup_field = 'pk'
+    
+    queryset = Course.objects.all()
+    serializer_class = CourseSerializer
+    
+    # Mass enroll students through admin accounts 
+    def post(self, request, *args, **kwargs):
+        course : Course = self.get_object()
+        result = MassEnrollSerializer(data=request.data, context={ "course": course })
+        result.is_valid(raise_exception=True)
+        
+        queryset = User.objects.all()
+        usernames = result.data["usernames"]
+        for username in usernames:
+            user = queryset.filter(username=username)[0]
+            course.add_user_to_course(user)
+        
+        return Response({"ok": f"succesfully enrolled {len(usernames)} students"}, status=status.HTTP_200_OK)
 
 class GetCourseByName(generics.RetrieveAPIView):
     authentication_classes = [JWTAuthentication]
@@ -215,11 +230,11 @@ class GetCourseByName(generics.RetrieveAPIView):
     queryset = Course.objects.all()
     serializer_class = CourseSerializer
 
-    def get(self, _, course_id):
-        queryset = self.get_queryset().filter(course_id=course_id)
+    def get(self, _, pk):
+        queryset = self.get_queryset().filter(pk=pk)
         serializer = self.serializer_class(queryset, many=True)
         if len(serializer.data) == 0:
-            return Response({"error": f"course '{course_id}' not found"}, status=status.HTTP_404_NOT_FOUND)
+            return Response({"error": f"course id '{pk}' not found"}, status=status.HTTP_404_NOT_FOUND)
         else:
             return Response(serializer.data, status=status.HTTP_200_OK)