refactor(orders): update viewsets, serializers, managers for order model

Author: tyronejosee

apps/orders/managers.py

@@ -6,14 +6,41 @@
 class OrderManager(BaseManager):
     """Manager for Order Model."""
 
+    def get_list_by_user(self, user):
+        return (
+            self.get_available()
+            .filter(user_id=user)
+            .select_related(
+                "restaurant_id",
+            )
+            .only(
+                "id",
+                "shipping_name",
+                "transaction",
+                "restaurant_id",
+                "amount",
+                "status",
+                "updated_at",
+                "created_at",
+            )
+        )
+
+    def get_detail_by_user(self, user):
+        return (
+            self.get_available()
+            .filter(user_id=user)
+            .select_related(
+                "user_id",
+                "city_id",
+                "state_id",
+                "country_id",
+                "restaurant_id",
+            )
+        )
+
     def get_by_status(self, status):
-        """Get orders by status"""
         return self.get_available().filter(status=status)
 
-    def get_by_user(self, user):
-        """Get orders by status"""
-        return self.get_available().filter(user_id=user)
-
 
 class OrderItemManager(BaseManager):
     """Manager for OrderItem Model."""

apps/orders/models.py

@@ -61,7 +61,6 @@ def __str__(self):
         return str(f"{self.shipping_name} - {self.transaction}")
 
     def save(self, *args, **kwargs):
-        # Apply methods on save
         self.set_transaction()
         super().save(*args, **kwargs)
 

apps/orders/serializers.py

@@ -3,14 +3,22 @@
 from rest_framework import serializers
 
 from apps.utilities.mixins import ReadOnlyFieldsMixin
+from apps.users.serializers import UserMinimalSerializer
+from apps.restaurants.serializers import RestaurantMinimalSerializer
 from .models import Order, OrderItem
 
-# ! TODO: Add extra serializers
-
 
 class OrderReadSerializer(ReadOnlyFieldsMixin, serializers.ModelSerializer):
     """Serializer for Order model (List/retrieve)."""
 
+    user_id = UserMinimalSerializer()
+    city_id = serializers.StringRelatedField()
+    state_id = serializers.StringRelatedField()
+    country_id = serializers.StringRelatedField()
+    restaurant_id = RestaurantMinimalSerializer()
+    status = serializers.CharField(source="get_status_display")
+    payment_method = serializers.CharField(source="get_payment_method_display")
+
     class Meta:
         model = Order
         fields = [
@@ -56,7 +64,7 @@ class Meta:
             "zip_code",
             "restaurant_id",
             # "amount",
-            "status",
+            # "status",
             "payment_method",
         ]
 
@@ -65,6 +73,7 @@ class OrderMinimalSerializer(ReadOnlyFieldsMixin, serializers.ModelSerializer):
     """Serializer for Order model (Minimal)."""
 
     restaurant_id = serializers.StringRelatedField()
+    status = serializers.CharField(source="get_status_display")
 
     class Meta:
         model = Order

apps/orders/viewsets.py

@@ -2,8 +2,7 @@
 
 from rest_framework.viewsets import ModelViewSet
 
-from apps.users.permissions import IsOperations, IsClient
-from apps.users.choices import RoleChoices
+from apps.users.permissions import IsOwner, IsClient
 from apps.utilities.mixins import ListCacheMixin, LogicalDeleteMixin
 from .models import Order
 from .serializers import (
@@ -26,81 +25,16 @@ class OrderViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
     - DELETE /api/v1/orders/{id}/
     """
 
-    permission_classes = [IsOperations]
+    permission_classes = [IsClient, IsOwner]
     serializer_class = OrderWriteSerializer
     search_fields = ["transaction", "shipping_name"]
     # filterset_class = OrderFilter
 
     def get_queryset(self):
         user = self.request.user
-
         if self.action == "list":
-            if user.role in [RoleChoices.OPERATIONS, RoleChoices.ADMINISTRATOR]:
-                return (
-                    Order.objects.get_available()
-                    .select_related(
-                        "user_id",
-                        "city_id",
-                        "state_id",
-                        "country_id",
-                        "restaurant_id",
-                    )
-                    .only(
-                        "id",
-                        "shipping_name",
-                        "transaction",
-                        "restaurant_id",
-                        "amount",
-                        "status",
-                        "updated_at",
-                        "created_at",
-                    )
-                )
-            elif user.role == RoleChoices.CLIENT:
-                return (
-                    Order.objects.get_available()
-                    .filter(user_id=user)
-                    .select_related(
-                        "user_id",
-                        "city_id",
-                        "state_id",
-                        "country_id",
-                        "restaurant_id",
-                    )
-                    .only(
-                        "id",
-                        "shipping_name",
-                        "transaction",
-                        "restaurant_id",
-                        "amount",
-                        "status",
-                        "updated_at",
-                        "created_at",
-                    )
-                )
-        else:
-            if user.role in [RoleChoices.OPERATIONS, RoleChoices.ADMINISTRATOR]:
-                return Order.objects.get_available().select_related(
-                    "user_id",
-                    "city_id",
-                    "state_id",
-                    "country_id",
-                    "restaurant_id",
-                )
-            elif user.role == RoleChoices.CLIENT:
-                return (
-                    Order.objects.get_available()
-                    .filter(user_id=user)
-                    .select_related(
-                        "user_id",
-                        "city_id",
-                        "state_id",
-                        "country_id",
-                        "restaurant_id",
-                    )
-                )
-
-    # ! TODO: Add managers
+            return Order.objects.get_list_by_user(user)
+        return Order.objects.get_detail_by_user(user)
 
     def get_serializer_class(self):
         if self.action == "list":
@@ -109,10 +43,5 @@ def get_serializer_class(self):
             return OrderReadSerializer
         return super().get_serializer_class()
 
-    def get_permissions(self):
-        if self.action in ["create", "update", "partial_update", "destroy"]:
-            return [IsClient()]  # ! TODO: Add IsOwner and refactor
-        return super().get_permissions()
-
     def perform_create(self, serializer):
         serializer.save(user_id=self.request.user)

apps/users/permissions.py

@@ -5,6 +5,13 @@
 from .choices import RoleChoices
 
 
+class IsOwner(BasePermission):
+    """Allows access only allow owners of an object to access it."""
+
+    def has_object_permission(self, request, view, obj):
+        return bool(obj.user_id == request.user)
+
+
 class BaseRolePermission(BasePermission):
     """
     Base permission class that checks if a user has a specific role.

apps/users/serializers.py

@@ -12,6 +12,8 @@
 class UserReadSerializer:
     """Serializer for User model."""
 
+    role = serializers.CharField(source="get_role_display")
+
     class Meta(UserCreateSerializer.Meta):
         model = User
         fields = [
@@ -46,6 +48,8 @@ class Meta(UserCreateSerializer.Meta):
 class UserMinimalSerializer(ReadOnlyFieldsMixin, UserCreateSerializer):
     """Serializer for User model (Minimal)."""
 
+    role = serializers.CharField(source="get_role_display")
+
     class Meta(UserCreateSerializer.Meta):
         model = User
         fields = [