feat(home): add viewsets, serializers and routers for pages and keyword models, remove views, update mixins

Author: tyronejosee

apps/blogs/serializers.py

@@ -3,6 +3,7 @@
 from rest_framework.serializers import ModelSerializer, CharField, StringRelatedField
 
 from apps.utilities.mixins import ReadOnlyFieldsMixin
+from apps.users.serializers import UserMinimalSerializer
 from .models import Post, Tag, PostReport
 
 
@@ -58,9 +59,22 @@ class Meta:
         ]
 
 
+class PostMinimalSerializer(ReadOnlyFieldsMixin, ModelSerializer):
+    """Serializer for Post model (Minimal)."""
+
+    class Meta:
+        model = Post
+        fields = [
+            "id",
+            "title",
+        ]
+
+
 class PostReportReadSerializer(ReadOnlyFieldsMixin, ModelSerializer):
     """Serializer for PostReport model (List)."""
 
+    user_id = UserMinimalSerializer()
+    post_id = PostMinimalSerializer()
     priority = CharField(source="get_priority_display")
     status = CharField(source="get_status_display")
 

apps/home/admin.py

@@ -20,7 +20,7 @@ class PageAdmin(BaseAdmin):
 
     search_fields = ["name"]
     list_display = ["name", "is_available", "created_at"]
-    readonly_fields = ["pk", "created_at", "updated_at"]
+    readonly_fields = ["pk", "slug", "created_at", "updated_at"]
 
 
 @admin.register(Keyword)

apps/home/routers.py

@@ -0,0 +1,15 @@
+"""Routers for Home App."""
+
+from django.urls import include
+from django.urls import path
+from rest_framework.routers import DefaultRouter
+
+from .viewsets import PageViewSet, KeywordViewSet
+
+router = DefaultRouter()
+router.register(r"pages", PageViewSet, basename="page")
+router.register(r"keywords", KeywordViewSet, basename="keyword")
+
+urlpatterns = [
+    path("api/v1/", include(router.urls)),
+]

apps/home/serializers.py

@@ -3,12 +3,65 @@
 from rest_framework.serializers import ModelSerializer
 
 from apps.utilities.mixins import ReadOnlyFieldsMixin
-from .models import Keyword
+from .models import Page, Keyword
 
 
-class KeywordMinimalSerializer(ReadOnlyFieldsMixin, ModelSerializer):
-    """Serializer for Keyword model (Minimal)."""
+class PageReadSerializer(ReadOnlyFieldsMixin, ModelSerializer):
+    """Serializer for Page model (List/retrieve)."""
+
+    class Meta:
+        model = Page
+        fields = [
+            "id",
+            "name",
+            "slug",
+            "content",
+            "created_at",
+            "updated_at",
+        ]
+
+
+class PageWriteSerializer(ModelSerializer):
+    """Serializer for Page model (Create/update)."""
+
+    class Meta:
+        model = Page
+        fields = [
+            "name",
+            "content",
+        ]
+
+
+class PageMinimalSerializer(ReadOnlyFieldsMixin, ModelSerializer):
+    """Serializer for Page model (Minimal)."""
+
+    class Meta:
+        model = Page
+        fields = [
+            "id",
+            "name",
+        ]
+
+
+class KeywordReadSerializer(ReadOnlyFieldsMixin, ModelSerializer):
+    """Serializer for Keyword model (List/retrieve)."""
+
+    class Meta:
+        model = Keyword
+        fields = [
+            "id",
+            "word",
+            "slug",
+            "created_at",
+            "updated_at",
+        ]
+
+
+class KeywordWriteSerializer(ModelSerializer):
+    """Serializer for Keyword model (Create/update)."""
 
     class Meta:
         model = Keyword
-        fields = ["word", "slug"]
+        fields = [
+            "word",
+        ]

apps/home/urls.py

@@ -0,0 +1,84 @@
+"""ViewSets for Home App."""
+
+from rest_framework.viewsets import ModelViewSet
+from rest_framework.permissions import AllowAny
+
+from apps.users.permissions import IsMarketing
+from apps.utilities.mixins import ListCacheMixin, LogicalDeleteMixin
+from .models import Page, Keyword
+from .serializers import (
+    PageReadSerializer,
+    PageWriteSerializer,
+    PageMinimalSerializer,
+    KeywordReadSerializer,
+    KeywordWriteSerializer,
+)
+
+
+class PageViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
+    """
+    ViewSet for managing Page instances.
+
+    Endpoints:
+    - GET /api/v1/pages/
+    - POST /api/v1/pages/
+    - GET /api/v1/pages/{id}/
+    - PUT /api/v1/pages/{id}/
+    - PATCH /api/v1/pages/{id}/
+    - DELETE /api/v1/pages/{id}/
+    """
+
+    permission_classes = [IsMarketing]
+    serializer_class = PageWriteSerializer
+    search_fields = ["name"]
+
+    def get_queryset(self):
+        if self.action == "list":
+            return Page.objects.get_available().only("id", "name")
+        elif self.action == "retrieve":
+            return Page.objects.get_available().defer("is_available")
+
+    # TODO: Add managers
+
+    def get_serializer_class(self):
+        if self.action == "list":
+            return PageMinimalSerializer
+        elif self.action == "retrieve":
+            return PageReadSerializer
+        return super().get_serializer_class()
+
+    def get_permissions(self):
+        if self.action in ["list", "retrieve"]:
+            return [AllowAny()]
+        return super().get_permissions()
+
+
+class KeywordViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
+    """
+    ViewSet for managing Keywords instances.
+
+    Endpoints:
+    - GET /api/v1/keywords/
+    - POST /api/v1/keywords/
+    - GET /api/v1/keywords/{id}/
+    - PUT /api/v1/keywords/{id}/
+    - PATCH /api/v1/keywords/{id}/
+    - DELETE /api/v1/keywords/{id}/
+    """
+
+    permission_classes = [IsMarketing]
+    serializer_class = KeywordWriteSerializer
+    search_fields = ["name"]
+
+    def get_queryset(self):
+        return Keyword.objects.get_available()
+
+    def get_serializer_class(self):
+        if self.action in ["list", "retrieve"]:
+            return KeywordReadSerializer
+        return super().get_serializer_class()
+
+    def get_permissions(self):
+        if self.action in ["list", "retrieve"]:
+            return [AllowAny()]
+        return super().get_permissions()

apps/home/views.py

@@ -4,10 +4,12 @@
 from django.urls import path
 from rest_framework.routers import DefaultRouter
 
-from .viewsets import PositionViewSet
+from .viewsets import PositionViewSet, WorkerViewSet, ApplicantViewSet
 
 router = DefaultRouter()
 router.register(r"positions", PositionViewSet, basename="position")
+router.register(r"workers", WorkerViewSet, basename="worker")
+router.register(r"applicants", ApplicantViewSet, basename="applicant")
 
 urlpatterns = [
     path("api/v1/", include(router.urls)),

apps/home/viewsets.py

@@ -40,6 +40,10 @@ class ListCacheMixin:
     @method_decorator(cache_page(60 * 60 * 2))
     @method_decorator(vary_on_headers("User-Agent"))
     def list(self, request, *args, **kwargs):
+        queryset = self.filter_queryset(self.get_queryset())
+        model_name = queryset.model._meta.verbose_name_plural.lower()
+        if not queryset.exists():
+            return Response({"message": f"No {model_name} available"})
         return super().list(request, *args, **kwargs)
 
 

apps/jobs/routers.py

@@ -34,9 +34,9 @@
     path("", include("apps.promotions.routers")),
     path("", include("apps.locations.routers")),
     path("", include("apps.blogs.routers")),
+    path("", include("apps.home.routers")),
     path("", include("apps.jobs.routers")),
     # Apps urls
-    path("", include("apps.home.urls")),
     path("", include("apps.drivers.urls")),
     path("", include("apps.orders.urls")),
     path("", include("apps.users.urls")),