feat(orders): add admin, report order and reject order actions

Author: tyronejosee

apps/deliveries/admin.py

@@ -0,0 +1,18 @@
+"""Admin for Deliveries App."""
+
+from django.contrib import admin
+
+from apps.utilities.admin import BaseAdmin
+from .models import Delivery
+
+
+@admin.register(Delivery)
+class DeliveryAdmin(BaseAdmin):
+    """Admin for Delivery model."""
+
+    search_fields = ["order_id", "driver_id"]
+    list_display = ["pk", "order_id", "is_completed", "is_available"]
+    list_filter = ["status"]
+    list_editable = ["is_completed", "is_available"]
+    readonly_fields = ["pk", "created_at", "updated_at"]
+    autocomplete_fields = ["order_id", "driver_id"]

apps/deliveries/migrations/0001_initial.py

@@ -0,0 +1,76 @@
+# Generated by Django 5.0.4 on 2024-07-29 17:15
+
+import apps.utilities.paths
+import django.db.models.deletion
+import simple_history.models
+import uuid
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('drivers', '0001_initial'),
+        ('orders', '0003_historicalorder_is_payment_order_is_payment_and_more'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='HistoricalDelivery',
+            fields=[
+                ('id', models.UUIDField(db_index=True, default=uuid.uuid4, editable=False)),
+                ('is_available', models.BooleanField(db_index=True, default=True)),
+                ('created_at', models.DateTimeField(blank=True, editable=False)),
+                ('updated_at', models.DateTimeField(blank=True, editable=False)),
+                ('signature', models.TextField(blank=True, max_length=100)),
+                ('status', models.CharField(choices=[('pending', 'Pending'), ('assigned', 'Assigned'), ('picked_up', 'Picked Up'), ('delivered', 'Delivered'), ('failed', 'Failed')], default='pending', max_length=20)),
+                ('picked_up_at', models.DateTimeField(blank=True)),
+                ('delivered_at', models.DateTimeField(blank=True)),
+                ('is_completed', models.BooleanField(default=False)),
+                ('history_id', models.AutoField(primary_key=True, serialize=False)),
+                ('history_date', models.DateTimeField(db_index=True)),
+                ('history_change_reason', models.CharField(max_length=100, null=True)),
+                ('history_type', models.CharField(choices=[('+', 'Created'), ('~', 'Changed'), ('-', 'Deleted')], max_length=1)),
+                ('driver_id', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='drivers.driver')),
+                ('history_user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)),
+                ('order_id', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='orders.order')),
+            ],
+            options={
+                'verbose_name': 'historical delivery',
+                'verbose_name_plural': 'historical deliveries',
+                'ordering': ('-history_date', '-history_id'),
+                'get_latest_by': ('history_date', 'history_id'),
+            },
+            bases=(simple_history.models.HistoricalChanges, models.Model),
+        ),
+        migrations.CreateModel(
+            name='Delivery',
+            fields=[
+                ('id', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)),
+                ('is_available', models.BooleanField(db_index=True, default=True)),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('signature', models.ImageField(blank=True, upload_to=apps.utilities.paths.signature_path)),
+                ('status', models.CharField(choices=[('pending', 'Pending'), ('assigned', 'Assigned'), ('picked_up', 'Picked Up'), ('delivered', 'Delivered'), ('failed', 'Failed')], default='pending', max_length=20)),
+                ('picked_up_at', models.DateTimeField(blank=True)),
+                ('delivered_at', models.DateTimeField(blank=True)),
+                ('is_completed', models.BooleanField(default=False)),
+                ('driver_id', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='deliveries', to='drivers.driver')),
+                ('order_id', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, to='orders.order')),
+            ],
+            options={
+                'verbose_name': 'delivery',
+                'verbose_name_plural': 'deliveries',
+                'ordering': ['pk'],
+                'indexes': [models.Index(fields=['order_id'], name='deliveries__order_i_8072ba_idx'), models.Index(fields=['driver_id'], name='deliveries__driver__493941_idx'), models.Index(fields=['status'], name='deliveries__status_bdfe1b_idx'), models.Index(fields=['order_id', 'status'], name='deliveries__order_i_e7aa5f_idx')],
+            },
+        ),
+        migrations.AddConstraint(
+            model_name='delivery',
+            constraint=models.UniqueConstraint(fields=('order_id',), name='unique_order_delivery'),
+        ),
+    ]

apps/deliveries/migrations/0002_alter_delivery_delivered_at_and_more.py

@@ -0,0 +1,33 @@
+# Generated by Django 5.0.4 on 2024-07-29 18:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('deliveries', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='delivery',
+            name='delivered_at',
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='delivery',
+            name='picked_up_at',
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='historicaldelivery',
+            name='delivered_at',
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='historicaldelivery',
+            name='picked_up_at',
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+    ]

apps/deliveries/migrations/__init__.py

@@ -34,8 +34,8 @@ class Delivery(BaseModel):
         choices=StatusChoices.choices,
         default=StatusChoices.PENDING,
     )
-    picked_up_at = models.DateTimeField(blank=True)
-    delivered_at = models.DateTimeField(blank=True)
+    picked_up_at = models.DateTimeField(blank=True, null=True)
+    delivered_at = models.DateTimeField(blank=True, null=True)
     is_completed = models.BooleanField(default=False)
 
     objects = DeliveryManager()
@@ -57,7 +57,7 @@ class Meta:
         ]
 
     def __str__(self):
-        return f"Delivery for {self.order.id} - {self.status}"
+        return f"Delivery for {self.order_id} - {self.status}"
 
     def save(self, *args, **kwargs):
         if self.status == StatusChoices.DELIVERED:

apps/deliveries/models.py

@@ -3,7 +3,7 @@
 from django.contrib import admin
 
 from apps.utilities.admin import BaseAdmin
-from .models import Order, OrderItem
+from .models import Order, OrderItem, OrderRating, OrderReport
 
 
 @admin.register(Order)
@@ -27,3 +27,25 @@ class OrderItemAdmin(BaseAdmin):
     list_editable = ["is_available"]
     readonly_fields = ["pk", "price", "subtotal", "created_at", "updated_at"]
     ordering = ["created_at"]
+
+
+@admin.register(OrderRating)
+class OrderRatingAdmin(BaseAdmin):
+    """Admin for OrderRating model."""
+
+    search_fields = ["order_id", "user_id"]
+    list_display = ["pk", "order_id"]
+    list_filter = ["rating"]
+    readonly_fields = ["pk", "created_at", "updated_at"]
+    autocomplete_fields = ["order_id", "user_id"]
+
+
+@admin.register(OrderReport)
+class OrderReportAdmin(BaseAdmin):
+    """Admin for OrderReport model."""
+
+    search_fields = ["order_id", "user_id"]
+    list_display = ["pk", "order_id", "user_id"]
+    list_filter = ["status", "is_resolved"]
+    readonly_fields = ["pk", "created_at", "updated_at"]
+    autocomplete_fields = ["order_id", "user_id"]

apps/orders/admin.py

@@ -134,7 +134,7 @@ class Meta:
         ]
 
     def __str__(self):
-        return f"Rating for Order {self.order.id} by User {self.user.id}: {self.rating}"
+        return f"Rating {self.pk}"
 
 
 class OrderReport(BaseModel):
@@ -179,4 +179,4 @@ class Meta:
         ]
 
     def __str__(self):
-        return f"Report {self.order_id} by User {self.user_is}: {self.reason}"
+        return f"Report {self.pk}"

apps/orders/models.py

@@ -8,7 +8,7 @@
     RestaurantMinimalSerializer,
     FoodMinimalSerializer,
 )
-from .models import Order, OrderItem
+from .models import Order, OrderItem, OrderReport
 from .services import OrderItemService
 
 
@@ -123,3 +123,14 @@ class Meta:
 
     def validate_quantity(self, value):
         return OrderItemService.validate_quantity(value)
+
+
+class OrderReportWriteSerializer(serializers.ModelSerializer):
+    """Serializer for OrderReport model (Create/update)."""
+
+    class Meta:
+        model = OrderReport
+        fields = [
+            "reason",
+            "description",
+        ]

apps/orders/serializers.py

@@ -2,16 +2,22 @@
 
 from django.shortcuts import get_object_or_404
 from rest_framework.viewsets import ModelViewSet
+from rest_framework.decorators import action
+from rest_framework.response import Response
+from rest_framework import status
 
-from apps.users.permissions import IsOwner, IsClient
+from apps.users.permissions import IsOwner, IsClient, IsDriver
 from apps.utilities.mixins import ListCacheMixin, LogicalDeleteMixin
-from .models import Order, OrderItem
+from apps.deliveries.models import Delivery
+from apps.deliveries.choices import StatusChoices
+from .models import Order, OrderItem, OrderReport
 from .serializers import (
     OrderReadSerializer,
     OrderWriteSerializer,
     OrderMinimalSerializer,
     OrderItemReadSerializer,
     OrderItemWriteSerializer,
+    OrderReportWriteSerializer,
 )
 
 
@@ -49,6 +55,65 @@ def get_serializer_class(self):
     def perform_create(self, serializer):
         serializer.save(user_id=self.request.user)
 
+    @action(
+        detail=True,
+        methods=["post"],
+        permission_classes=[IsClient],
+        url_path="report",
+    )
+    def report_order(self, request, *args, **kwargs):
+        """
+        Action report a specific order by ID.
+
+        Endpoints:
+        - GET api/v1/orders/{id}/report/
+        """
+        order = self.get_object()
+        serializer = OrderReportWriteSerializer(data=request.data)
+        if serializer.is_valid():
+            if OrderReport.objects.filter(
+                order_id=order, user_id=request.user
+            ).exists():
+                return Response(
+                    {"detail": "You have already reported this order."},
+                    status=status.HTTP_409_CONFLICT,
+                )
+            serializer.save(order_id=order, user_id=request.user)
+            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=True,
+        methods=["patch"],
+        permission_classes=[IsDriver],
+        url_path="reject",
+    )
+    def reject_order(self, request, pk=None):
+        """
+        Action to mark a specific order report as rejected.
+        TODO: Concept tests, temporal
+
+        Endpoints:
+        - PATCH api/v1/orders/{id}/reject/
+        """
+        order = self.get_object()
+        delivery = Delivery.objects.get(order_id=order)
+
+        if delivery:
+            delivery.status = StatusChoices.FAILED
+            delivery.save()
+            return Response(
+                {"detail": f"The order {order} was rejected."},
+                status=status.HTTP_200_OK,
+            )
+        return Response(
+            {"detail": f"Order {order} not found."},
+            status=status.HTTP_404_NOT_FOUND,
+        )
+
 
 class OrderItemViewSet(ModelViewSet):
     """