feat(blogs): add post viewset, actions for reports, update managers, routers, etc

Author: tyronejosee

apps/blogs/managers.py

@@ -30,3 +30,7 @@ def get_search(self, search_term):
             | Q(content__icontains=search_term)
             | Q(tags__name__icontains=search_term)
         )
+
+
+class PostReportManager(BaseManager):
+    """Manager for Post Model."""

apps/blogs/models.py

@@ -5,7 +5,7 @@
 
 from apps.utilities.models import BaseModel
 from apps.utilities.mixins import SlugMixin
-from .managers import TagManager, PostManager
+from .managers import TagManager, PostManager, PostReportManager
 from .choices import PriorityChoices, StatusChoices
 
 User = settings.AUTH_USER_MODEL
@@ -73,6 +73,8 @@ class PostReport(BaseModel):
         default=StatusChoices.PENDING,
     )
 
+    objects = PostReportManager()
+
     class Meta:
         ordering = ["pk"]
         verbose_name = "post report"

apps/blogs/routers.py

@@ -0,0 +1,14 @@
+"""Routers for Blogs App."""
+
+from django.urls import include
+from django.urls import path
+from rest_framework.routers import DefaultRouter
+
+from .viewsets import PostViewSet
+
+router = DefaultRouter()
+router.register(r"posts", PostViewSet, basename="post")
+
+urlpatterns = [
+    path("api/v1/", include(router.urls)),
+]

apps/blogs/serializers.py

@@ -1,11 +1,12 @@
 """Serializers for Blogs App."""
 
-from rest_framework.serializers import ModelSerializer, CharField
+from rest_framework.serializers import ModelSerializer, CharField, StringRelatedField
 
+from apps.utilities.mixins import ReadOnlyFieldsMixin
 from .models import Post, Tag, PostReport
 
 
-class TagReadSerializer(ModelSerializer):
+class TagReadSerializer(ReadOnlyFieldsMixin, ModelSerializer):
     """Serializer for Category model (List/retrieve)."""
 
     class Meta:
@@ -15,10 +16,6 @@ class Meta:
             "name",
             "slug",
         ]
-        read_only_fields = [
-            "id",
-            "slug",
-        ]
 
 
 class TagWriteSerializer(ModelSerializer):
@@ -29,10 +26,11 @@ class Meta:
         fields = ["name"]
 
 
-class PostReadSerializer(ModelSerializer):
+class PostReadSerializer(ReadOnlyFieldsMixin, ModelSerializer):
     """Serializer for Post model (List/retrieve)."""
 
     tags = TagReadSerializer(many=True)
+    author_id = StringRelatedField()
 
     class Meta:
         model = Post
@@ -46,11 +44,6 @@ class Meta:
             "created_at",
             "updated_at",
         ]
-        read_only_fields = [
-            "slug",
-            "created_at",
-            "updated_at",
-        ]
 
 
 class PostWriteSerializer(ModelSerializer):
@@ -65,7 +58,7 @@ class Meta:
         ]
 
 
-class PostReportReadSerializer(ModelSerializer):
+class PostReportReadSerializer(ReadOnlyFieldsMixin, ModelSerializer):
     """Serializer for PostReport model (List)."""
 
     priority = CharField(source="get_priority_display")

apps/blogs/viewsets.py

@@ -0,0 +1,128 @@
+"""ViewSets for Blogs App."""
+
+from django.db import transaction
+from django.utils.decorators import method_decorator
+from django.views.decorators.cache import cache_page
+from django.views.decorators.vary import vary_on_headers
+from rest_framework.viewsets import ModelViewSet
+from rest_framework.permissions import AllowAny
+from rest_framework.decorators import action
+from rest_framework.response import Response
+from rest_framework import status
+
+from apps.users.permissions import IsMarketing, IsClient
+from apps.utilities.mixins import ListCacheMixin, LogicalDeleteMixin
+from .models import Post, PostReport
+from .serializers import (
+    PostReadSerializer,
+    PostWriteSerializer,
+    PostReportReadSerializer,
+    PostReportWriteSerializer,
+)
+from .choices import PriorityChoices
+
+
+class PostViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
+    """
+    ViewSet for managing Country instances.
+
+    Endpoints:
+    - GET /api/v1/posts/
+    - POST /api/v1/posts/
+    - GET /api/v1/posts/{id}/
+    - PUT /api/v1/posts/{id}/
+    - PATCH /api/v1/posts/{id}/
+    - DELETE /api/v1/posts/{id}/
+    """
+
+    permission_classes = [IsMarketing]
+    serializer_class = PostWriteSerializer
+    search_fields = ["title"]
+    # filterset_class = PostFilter
+
+    def get_queryset(self):
+        return (
+            Post.objects.get_available()
+            .select_related("author_id")
+            .prefetch_related("tags")
+        )
+
+    def get_serializer_class(self):
+        if self.action in ["list", "retrieve"]:
+            return PostReadSerializer
+        return super().get_serializer_class()
+
+    def get_permissions(self):
+        if self.action in ["list", "retrieve"]:
+            return [AllowAny()]
+        return super().get_permissions()
+
+    @action(
+        detail=True,
+        methods=["post"],
+        permission_classes=[IsClient],
+        url_path="report",
+    )
+    def create_report(self, request, *args, **kwargs):
+        """
+        Action report a specific post by ID.
+
+        Endpoints:
+        - GET api/v1/posts/{id}/report/
+        """
+        post = self.get_object()
+        serializer = PostReportWriteSerializer(data=request.data)
+        if serializer.is_valid():
+            if PostReport.objects.filter(post_id=post, user_id=request.user).exists():
+                return Response(
+                    {"detail": "You have already reported this post."},
+                    status=status.HTTP_400_BAD_REQUEST,
+                )
+
+            with transaction.atomic():
+                # Update points of the post
+                post.points = post.points - 1
+                if post.points <= 5:
+                    post.is_available = False
+                post.save()
+
+                # Determine priority for the new report
+                if post.points <= 25:
+                    priority = PriorityChoices.URGENT
+                elif post.points <= 50:
+                    priority = PriorityChoices.HIGH
+                elif post.points <= 75:
+                    priority = PriorityChoices.MEDIUM
+                else:
+                    priority = PriorityChoices.LOW
+
+                serializer.save(user_id=request.user, post_id=post, priority=priority)
+            return Response(
+                {"detail": "Your report has been submitted successfully."},
+                status=status.HTTP_201_CREATED,
+            )
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+    @action(
+        detail=False,
+        methods=["get"],
+        permission_classes=[IsMarketing],
+        url_path="reports",
+    )
+    @method_decorator(cache_page(60 * 60 * 2))
+    @method_decorator(vary_on_headers("User-Agent"))
+    def get_reports(self, request, *args, **kwargs):
+        """
+        Action retrieve a list of all post reports.
+
+        Endpoints:
+        - GET api/v1/posts/reports/
+        """
+        reports = PostReport.objects.get_available()
+        if reports.exists():
+            serializer = PostReportReadSerializer(reports, many=True)
+            return Response(serializer.data)
+        return Response(
+            {"detail": "No reports found."},
+            status=status.HTTP_404_NOT_FOUND,
+        )

config/urls.py

@@ -32,14 +32,15 @@
     # ! TODO: Remove urls
     # path("", include("apps.restaurants.urls")),
     # path("", include("apps.promotions.urls")),
+    # path("", include("apps.blogs.urls")),
     # Apps urls
     path("", include("apps.restaurants.routers")),
     path("", include("apps.promotions.routers")),
     path("", include("apps.locations.routers")),
+    path("", include("apps.blogs.routers")),
     path("", include("apps.home.urls")),
     path("", include("apps.drivers.urls")),
     path("", include("apps.orders.urls")),
-    path("", include("apps.blogs.urls")),
     path("", include("apps.users.urls")),
 ]
 

roadmap.md

@@ -98,15 +98,15 @@ Pending implementation
 
 ## Blogs [OK]
 
-- [ ] `GET /posts` Obtener una lista de todos los posts (AllowAny).
-- [ ] `POST /posts` Crear un nuevo post (IsMarketing).
-- [ ] `GET /posts/{id}` Obtener los detalles de un post específico por su ID (AllowAny).
-- [ ] `PATCH /posts/{id}` Actualizar un post específico por su ID (IsMarketing).
-- [ ] `DELETE /posts/{id}` Eliminar un post específico por su ID (IsMarketing).
+- [x] `GET /posts` Obtener una lista de todos los posts (AllowAny).
+- [x] `POST /posts` Crear un nuevo post (IsMarketing).
+- [x] `GET /posts/{id}` Obtener los detalles de un post específico por su ID (AllowAny).
+- [x] `PATCH /posts/{id}` Actualizar un post específico por su ID (IsMarketing).
+- [x] `DELETE /posts/{id}` Eliminar un post específico por su ID (IsMarketing).
+
 - [ ] `POST /posts/{id}/report` Reportar un post específico por su ID (IsClient).
 - [ ] `GET /posts/tags` Obtener una lista de todas las etiquetas (IsMarketing).
-- [ ] `GET /posts/tags` Crear una nueva etiqueta (IsMarketing).
-- [ ] `GET /posts/search/` Buscar posts basados en una consulta de búsqueda (AllowAny).
+- [ ] `POST /posts/tags` Crear una nueva etiqueta (IsMarketing).
 
 TODO: recents and featured endpoint unificarlos con /posts agregando un filtro