refactor: teacher and student use same view

rockstarr-programmerr · rockstarr-programmerr · commit 0bf381ef3373 · 2021-10-05T20:37:15.000+07:00
diff --git a/classroom/business/teacher/classroom.py b/classroom/business/teacher/classroom.py
@@ -3,7 +3,6 @@
 from django.contrib.auth import get_user_model
 
 from classroom.tasks import send_temp_password_for_new_students_task
-from classroom.models import ReadingExercise
 
 User = get_user_model()
 
diff --git a/classroom/filters/__init__.py b/classroom/filters/__init__.py
@@ -0,0 +1,3 @@
+from .classroom import ClassroomFilter
+from .exercise import ReadingExerciseFilter
+from .question import ReadingQuestionFilter
diff --git a/classroom/filters/classroom.py b/classroom/filters/classroom.py
@@ -3,7 +3,7 @@
 from classroom.models import Classroom
 
 
-class ClassroomTeacherFilter(filters.FilterSet):
+class ClassroomFilter(filters.FilterSet):
     class Meta:
         model = Classroom
         fields = {
diff --git a/classroom/filters/exercise.py b/classroom/filters/exercise.py
@@ -3,7 +3,7 @@
 from classroom.models import ReadingExercise
 
 
-class ReadingExerciseTeacherFilter(filters.FilterSet):
+class ReadingExerciseFilter(filters.FilterSet):
     class Meta:
         model = ReadingExercise
         fields = {
diff --git a/classroom/filters/question.py b/classroom/filters/question.py
@@ -3,7 +3,7 @@
 from classroom.models import ReadingQuestion
 
 
-class ReadingQuestionTeacherFilter(filters.FilterSet):
+class ReadingQuestionFilter(filters.FilterSet):
     class Meta:
         model = ReadingQuestion
         fields = {
diff --git a/classroom/filters/teacher/__init__.py b/classroom/filters/teacher/__init__.py
diff --git a/classroom/serializers/__init__.py b/classroom/serializers/__init__.py
@@ -1,5 +1,5 @@
 from .classroom import (AddReadingExerciseSerializer, AddStudentSerializer,
-                        ClassroomTeacherSerializer,
+                        ClassroomSerializer,
                         RemoveReadingExerciseSerializer,
                         RemoveStudentSerializer)
 from .exercise import ReadingExerciseSerializer
diff --git a/classroom/serializers/classroom.py b/classroom/serializers/classroom.py
@@ -6,7 +6,7 @@
 from classroom.utils.serializer import ValidateUniqueTogetherMixin
 
 
-class ClassroomTeacherSerializer(ValidateUniqueTogetherMixin, serializers.HyperlinkedModelSerializer):
+class ClassroomSerializer(ValidateUniqueTogetherMixin, serializers.HyperlinkedModelSerializer):
     teacher = UserSerializer(read_only=True)
     students = UserSerializer(many=True, read_only=True)
 
@@ -17,8 +17,8 @@ class Meta:
             'teacher', 'students', 'reading_exercises',
         ]
         extra_kwargs = {
-            'url': {'view_name': 'classroom-teacher-detail'},
-            'reading_exercises': {'view_name': 'reading-exercise-teacher-detail'},
+            'url': {'view_name': 'classroom-detail'},
+            'reading_exercises': {'view_name': 'reading-exercise-detail'},
             'create_datetime': {'read_only': True},
         }
 
diff --git a/classroom/serializers/exercise.py b/classroom/serializers/exercise.py
@@ -10,7 +10,7 @@ class Meta:
         model = ReadingExercise
         fields = ['pk', 'url', 'identifier', 'content']
         extra_kwargs = {
-            'url': {'view_name': 'reading-exercise-teacher-detail'},
+            'url': {'view_name': 'reading-exercise-detail'},
         }
 
     def validate_identifier(self, identifier):
diff --git a/classroom/serializers/question.py b/classroom/serializers/question.py
@@ -12,8 +12,8 @@ class Meta:
             'from_number', 'to_number', 'question_type', 'correct_answer',
         ]
         extra_kwargs = {
-            'url': {'view_name': 'reading-question-teacher-detail'},
-            'exercise': {'view_name': 'reading-exercise-teacher-detail'},
+            'url': {'view_name': 'reading-question-detail'},
+            'exercise': {'view_name': 'reading-exercise-detail'},
             'from_number': {'min_value': 1},
             'to_number': {'min_value': 1},
         }
diff --git a/classroom/urls.py b/classroom/urls.py
@@ -0,0 +1,17 @@
+from rest_framework.routers import DefaultRouter
+
+from classroom import views
+
+
+# NOTE: DRF has bug involve app's namespace and viewset's extra_actions,
+# so we can't use app namespace for now
+# Ref: https://github.com/encode/django-rest-framework/discussions/7816
+
+urlpatterns = []
+
+router = DefaultRouter()
+router.register('classrooms', views.ClassroomViewSet, basename='classroom')
+router.register('reading-exercises', views.ReadingExerciseViewSet, basename='reading-exercise')
+router.register('reading-questions', views.ReadingQuestionViewSet, basename='reading-question')
+
+urlpatterns.extend(router.urls)
diff --git a/classroom/urls/teacher.py b/classroom/urls/teacher.py
diff --git a/classroom/views/__init__.py b/classroom/views/__init__.py
@@ -0,0 +1,3 @@
+from .classroom import ClassroomViewSet
+from .exercise import ReadingExerciseViewSet
+from .question import ReadingQuestionViewSet
diff --git a/classroom/views/classroom.py b/classroom/views/classroom.py
@@ -3,21 +3,20 @@
 from rest_framework.response import Response
 from rest_framework.viewsets import ModelViewSet
 
-from classroom.business.teacher import classroom as business
-from classroom.filters.teacher import ClassroomTeacherFilter
+from classroom.business.teacher import classroom as teacher_business
+from classroom.filters import ClassroomFilter
 from classroom.models import Classroom
 from classroom.permissions import IsClassroomTeacher
-from classroom.serializers.teacher import (AddReadingExerciseSerializer,
-                                           AddStudentSerializer,
-                                           ClassroomTeacherSerializer,
-                                           RemoveReadingExerciseSerializer,
-                                           RemoveStudentSerializer)
+from classroom.serializers import (AddReadingExerciseSerializer,
+                                   AddStudentSerializer, ClassroomSerializer,
+                                   RemoveReadingExerciseSerializer,
+                                   RemoveStudentSerializer)
 
 
-class ClassroomTeacherViewSet(ModelViewSet):
+class ClassroomViewSet(ModelViewSet):
     queryset = Classroom.objects.all()
-    serializer_class = ClassroomTeacherSerializer
-    filterset_class = ClassroomTeacherFilter
+    serializer_class = ClassroomSerializer
+    filterset_class = ClassroomFilter
     permission_classes = [IsClassroomTeacher]
     ordering_fields = ['create_datetime', 'name']
     ordering = ['-create_datetime']
@@ -39,7 +38,7 @@ def add_students(self, request, pk):
         serializer = self.get_serializer(data=request.data, many=True)
         serializer.is_valid(raise_exception=True)
         classroom = self.get_object()
-        business.add_students_to_classroom(classroom, serializer.validated_data)
+        teacher_business.add_students_to_classroom(classroom, serializer.validated_data)
         return Response({
             'message': _(
                 "Your students will receive an email with a temporary password. "
@@ -60,7 +59,7 @@ def remove_students(self, request, pk):
         serializer.is_valid(raise_exception=True)
         emails = [data['email'] for data in serializer.validated_data]
         classroom = self.get_object()
-        business.remove_students_from_classroom(classroom, emails)
+        teacher_business.remove_students_from_classroom(classroom, emails)
         return Response()
 
     @action(
@@ -72,7 +71,7 @@ def add_reading_exercises(self, request, pk):
         serializer.is_valid(raise_exception=True)
         exercise_pks = [data['pk'] for data in serializer.validated_data]
         classroom = self.get_object()
-        business.add_reading_exercises_to_classroom(classroom, exercise_pks, request.user)
+        teacher_business.add_reading_exercises_to_classroom(classroom, exercise_pks, request.user)
         return Response()
 
     @action(
@@ -84,5 +83,5 @@ def remove_reading_exercises(self, request, pk):
         serializer.is_valid(raise_exception=True)
         exercise_pks = [data['pk'] for data in serializer.validated_data]
         classroom = self.get_object()
-        business.remove_reading_exercises_to_classroom(classroom, exercise_pks)
+        teacher_business.remove_reading_exercises_to_classroom(classroom, exercise_pks)
         return Response()
diff --git a/classroom/views/exercise.py b/classroom/views/exercise.py
@@ -1,15 +1,15 @@
 from rest_framework.viewsets import ModelViewSet
 
-from classroom.filters.teacher import ReadingExerciseTeacherFilter
+from classroom.filters import ReadingExerciseFilter
 from classroom.models import ReadingExercise
 from classroom.permissions import IsTeacherOwnsExercise
-from classroom.serializers.teacher import ReadingExerciseSerializer
+from classroom.serializers import ReadingExerciseSerializer
 
 
-class ReadingExerciseTeacherViewSet(ModelViewSet):
+class ReadingExerciseViewSet(ModelViewSet):
     queryset = ReadingExercise.objects.all()
     serializer_class = ReadingExerciseSerializer
-    filterset_class = ReadingExerciseTeacherFilter
+    filterset_class = ReadingExerciseFilter
     permission_classes = [IsTeacherOwnsExercise]
     ordering_fields = ['identifier']
     ordering = ['identifier']
diff --git a/classroom/views/question.py b/classroom/views/question.py
@@ -1,15 +1,15 @@
 from rest_framework.viewsets import ModelViewSet
 
-from classroom.filters.teacher import ReadingQuestionTeacherFilter
+from classroom.filters import ReadingQuestionFilter
 from classroom.models import ReadingQuestion
 from classroom.permissions import IsTeacherOwnsQuestion
-from classroom.serializers.teacher import ReadingQuestionSerializer
+from classroom.serializers import ReadingQuestionSerializer
 
 
-class ReadingQuestionTeacherViewSet(ModelViewSet):
+class ReadingQuestionViewSet(ModelViewSet):
     queryset = ReadingQuestion.objects.all()
     serializer_class = ReadingQuestionSerializer
-    filterset_class = ReadingQuestionTeacherFilter
+    filterset_class = ReadingQuestionFilter
     permission_classes = [IsTeacherOwnsQuestion]
     ordering_fields = ['from_number']
     ordering = ['from_number']
diff --git a/classroom/views/teacher/__init__.py b/classroom/views/teacher/__init__.py
diff --git a/keep_learning/urls.py b/keep_learning/urls.py
@@ -25,7 +25,7 @@
     path('admin/', admin.site.urls),
     path('api-auth/', include('rest_framework.urls')),
     path('account/', include('account.urls')),
-    path('teacher/class/', include('classroom.urls.teacher')),
+    path('classroom/', include('classroom.urls')),
 ]
 
 if settings.DEBUG:
diff --git a/keep_learning/views.py b/keep_learning/views.py
@@ -12,7 +12,7 @@ def get(self, request):
             data = {
                 'account': request.build_absolute_uri('/account/'),
                 'teacher': {
-                    'class': request.build_absolute_uri('/teacher/class/'),
+                    'class': request.build_absolute_uri('/classroom/'),
                 }
             }
         else:

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from .classroom import ClassroomFilter`
	`2`	`+from .exercise import ReadingExerciseFilter`
	`3`	`+from .question import ReadingQuestionFilter`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ class Meta:`
`10`	`10`	`model = ReadingExercise`
`11`	`11`	`fields = ['pk', 'url', 'identifier', 'content']`
`12`	`12`	`extra_kwargs = {`
`13`		`- 'url': {'view_name': 'reading-exercise-teacher-detail'},`
	`13`	`+ 'url': {'view_name': 'reading-exercise-detail'},`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`def validate_identifier(self, identifier):`
Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,8 @@ class Meta:`
`12`	`12`	`'from_number', 'to_number', 'question_type', 'correct_answer',`
`13`	`13`	`]`
`14`	`14`	`extra_kwargs = {`
`15`		`- 'url': {'view_name': 'reading-question-teacher-detail'},`
`16`		`- 'exercise': {'view_name': 'reading-exercise-teacher-detail'},`
	`15`	`+ 'url': {'view_name': 'reading-question-detail'},`
	`16`	`+ 'exercise': {'view_name': 'reading-exercise-detail'},`
`17`	`17`	`'from_number': {'min_value': 1},`
`18`	`18`	`'to_number': {'min_value': 1},`
`19`	`19`	`}`