feat(apps): add missing filters

Author: tyronejosee

README.md

@@ -60,13 +60,13 @@ pip install -r requirements/local.txt
 Create an environment variable file .env or use `.env.template` file.
 
 ```bash
-SECRET_KEY=""
-EMAIL_BACKEND=""
-EMAIL_HOST=""
-EMAIL_HOST_USER=""
-EMAIL_HOST_PASSWORD=""
-EMAIL_PORT=""
-EMAIL_USE_TLS=""
+SECRET_KEY=
+EMAIL_BACKEND=
+EMAIL_HOST=
+EMAIL_HOST_USER=
+EMAIL_HOST_PASSWORD=
+EMAIL_PORT=
+EMAIL_USE_TLS=
 ```
 
 Docker run.

apps/drivers/filters.py

@@ -0,0 +1,38 @@
+"""Filters for Drivers App."""
+
+from django_filters import rest_framework as filters
+
+from .models import Driver
+from .choices import VehicleChoices, StatusChoices
+
+
+class DriverFilter(filters.FilterSet):
+    """Filter for Driver model."""
+
+    vehicle_type = filters.ChoiceFilter(
+        field_name="vehicle_type",
+        choices=VehicleChoices.choices,
+        label="Filter by vehicle type, ex `/?vehicle_type=automobile`",
+    )
+    status = filters.ChoiceFilter(
+        field_name="status",
+        choices=StatusChoices.choices,
+        label="Filter by driver status, ex `/?status=silver`",
+    )
+    is_verified = filters.BooleanFilter(
+        field_name="is_verified",
+        label="Filter by verified availability, ex `/?is_verified=true`",
+    )
+    is_active = filters.BooleanFilter(
+        field_name="is_active",
+        label="Filter by active availability, ex `/?is_active=true`",
+    )
+
+    class Meta:
+        model = Driver
+        fields = [
+            "vehicle_type",
+            "status",
+            "is_verified",
+            "is_active",
+        ]

apps/drivers/viewsets.py

@@ -23,6 +23,7 @@
     ResourceReadSerializer,
     ResourceWriteSerializer,
 )
+from .filters import DriverFilter
 from .schemas import driver_schemas
 
 
@@ -43,7 +44,7 @@ class DriverViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
     permission_classes = [IsSupport, IsOwner]
     serializer_class = DriverWriteSerializer
     search_fields = ["user_id"]
-    # filterset_class = DriverFilter
+    filterset_class = DriverFilter
 
     def get_queryset(self):
         if self.action == "list":

apps/orders/filters.py

@@ -0,0 +1,81 @@
+"""Filters for Orders App."""
+
+from django_filters import rest_framework as filters
+
+from .models import Order
+from .choices import OrderStatusChoices, PaymentMethodChoices
+
+
+class OrderFilter(filters.FilterSet):
+    """Filter for Order model."""
+
+    status = filters.ChoiceFilter(
+        field_name="status",
+        choices=OrderStatusChoices.choices,
+        label="Filter by order status, ex `/?status=not_processed`",
+    )
+    payment_method = filters.ChoiceFilter(
+        field_name="payment_method",
+        choices=PaymentMethodChoices.choices,
+        label="Filter by payment method, ex `/?payment_method=credit_card`",
+    )
+    is_payment = filters.BooleanFilter(
+        field_name="is_payment",
+        label="Filter by payment status, ex `/?is_payment=true`",
+    )
+    is_valid = filters.BooleanFilter(
+        field_name="is_valid",
+        label="Filter by validation status, ex `/?is_valid=true`",
+    )
+    ordering = filters.OrderingFilter(
+        fields=(
+            ("created_at", "newest"),
+            ("created_at", "oldest"),
+            ("amount", "highest_amount"),
+            ("amount", "lowest_amount"),
+        ),
+        field_labels={
+            "created_at": "Newest",
+            "-created_at": "Oldest",
+            "amount": "Highest Amount",
+            "-amount": "Lowest Amount",
+        },
+        label="Order by Newest Oldest, Highest Amount, Lowest Amount, ex `/?ordering=newest`",
+    )
+
+    class Meta:
+        model = Order
+        fields = [
+            "status",
+            "payment_method",
+            "is_payment",
+            "is_valid",
+            "ordering",
+        ]
+
+
+class UserOrderFilter(filters.FilterSet):
+    """Filter for Order model (For Users)."""
+
+    is_payment = filters.BooleanFilter(
+        field_name="is_payment",
+        label="Filter by payment status, ex `/?is_payment=true`",
+    )
+    ordering = filters.OrderingFilter(
+        fields=(
+            ("created_at", "newest"),
+            ("created_at", "oldest"),
+        ),
+        field_labels={
+            "created_at": "Newest",
+            "-created_at": "Oldest",
+        },
+        label="Order by Newest or Oldest, ex `/?ordering=newest`",
+    )
+
+    class Meta:
+        model = Order
+        fields = [
+            "is_payment",
+            "ordering",
+        ]

apps/orders/viewsets.py

@@ -27,6 +27,7 @@
     OrderReportWriteSerializer,
     OrderRatingWriteSerializer,
 )
+from .filters import OrderFilter
 from .schemas import order_schemas, order_item_schemas
 
 
@@ -47,7 +48,7 @@ class OrderViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
     permission_classes = [IsClient, IsOwner]
     serializer_class = OrderWriteSerializer
     search_fields = ["transaction", "shipping_name"]
-    # filterset_class = OrderFilter
+    filterset_class = OrderFilter
 
     def get_queryset(self):
         if getattr(self, "swagger_fake_view", False):
@@ -274,7 +275,6 @@ class OrderItemViewSet(ModelViewSet):
     serializer_class = OrderItemWriteSerializer
     search_fields = ["food_id"]
     pagination_class = None
-    # filterset_class = OrderItemFilter
 
     def get_queryset(self):
         if getattr(self, "swagger_fake_view", False):

apps/restaurants/filters.py

@@ -3,7 +3,7 @@
 from django_filters import rest_framework as filters
 
 from apps.utilities.filters import BaseFilter
-from .models import Restaurant
+from .models import Restaurant, Category, Food
 from .choices import SpecialtyChoices
 
 
@@ -46,3 +46,36 @@ class Meta:
             "is_verified",
             "is_open",
         ]
+
+
+class FoodFilter(filters.FilterSet):
+    """Filter for Food model."""
+
+    min_price = filters.NumberFilter(
+        field_name="price",
+        lookup_expr="gte",
+        label="Filter by minimum price, ex `/?min_price=10.00`",
+    )
+    max_price = filters.NumberFilter(
+        field_name="price",
+        lookup_expr="lte",
+        label="Filter by maximum price, ex `/?max_price=50.00`",
+    )
+    is_featured = filters.BooleanFilter(
+        field_name="is_featured",
+        label="Filter by featured status, ex `/?is_featured=True`",
+    )
+    category = filters.ModelChoiceFilter(
+        queryset=Category.objects.get_available(),
+        field_name="category_id",
+        label="Filter by category, ex `/?category=1`",
+    )
+
+    class Meta:
+        model = Food
+        fields = [
+            "min_price",
+            "max_price",
+            "is_featured",
+            "category",
+        ]

apps/restaurants/models.py

@@ -87,7 +87,7 @@ def __str__(self):
 
 
 class Food(BaseModel):
-    """Model definition for Food (Entity)."""
+    """Model definition for Food."""
 
     name = models.CharField(max_length=255)
     description = models.TextField(blank=True)

apps/restaurants/viewsets.py

@@ -18,6 +18,7 @@
 from apps.orders.serializers import OrderReadSerializer
 from apps.reviews.models import Review
 from apps.reviews.serializers import ReviewReadSerializer, ReviewWriteSerializer
+from apps.reviews.filters import ReviewFilter
 from .models import Restaurant, Category, Food
 from .serializers import (
     RestaurantReadSerializer,
@@ -30,7 +31,7 @@
     FoodWriteSerializer,
     FoodMinimalSerializer,
 )
-from .filters import RestaurantFilter
+from .filters import RestaurantFilter, FoodFilter
 from .schemas import (
     restaurant_schemas,
     category_schemas,
@@ -227,7 +228,7 @@ class FoodViewSet(ModelViewSet):
     permission_classes = [IsPartner]
     serializer_class = FoodWriteSerializer
     search_fields = ["name"]
-    # Filterset_class = FoodFilter
+    filterset_class = FoodFilter
 
     def get_queryset(self):
         if getattr(self, "swagger_fake_view", False):
@@ -321,7 +322,7 @@ class RestaurantReviewViewSet(ModelViewSet):
     permission_classes = [IsClient]
     serializer_class = ReviewWriteSerializer
     search_fields = ["user_id"]
-    # Filterset_class = ReviewFilter
+    filterset_class = ReviewFilter
 
     def get_queryset(self):
         if getattr(self, "swagger_fake_view", False):

apps/reviews/filters.py

@@ -0,0 +1,36 @@
+"""Filters for Reviews App."""
+
+from django_filters import rest_framework as filters
+
+from .models import Review
+
+
+class ReviewFilter(filters.FilterSet):
+    """Filter for Review model."""
+
+    # ! TODO: Review and perform exhaustive testing
+
+    rating = filters.NumberFilter(
+        field_name="rating",
+        label="Filter by exact rating, ex `/?rating=4`",
+    )
+    ordering = filters.OrderingFilter(
+        fields=(
+            ("rating", "best"),
+            ("created_at", "newest"),
+            ("created_at", "oldest"),
+        ),
+        field_labels={
+            "rating": "Best",
+            "created_at": "Newest",
+            "-created_at": "Oldest",
+        },
+        label="Order by Best, Newest, Oldest, ex `/?ordering=best`",
+    )
+
+    class Meta:
+        model = Review
+        fields = [
+            "rating",
+            "ordering",
+        ]

apps/users/views.py

@@ -17,8 +17,10 @@
 from apps.users.serializers import UserHistorySerializer
 from apps.reviews.models import Review
 from apps.reviews.serializers import ReviewReadSerializer
+from apps.reviews.filters import ReviewFilter
 from apps.orders.models import Order, OrderReport
 from apps.orders.serializers import OrderReadSerializer, OrderReportReadSerializer
+from apps.orders.filters import UserOrderFilter
 from .schemas import (
     token_obtain_pair_schemas,
     token_refresh_schemas,
@@ -90,7 +92,7 @@ class UserReviewsView(ListAPIView):
 
     permission_class = [IsClient]
     serializer_class = ReviewReadSerializer
-    # filterset_class = ReviewFilter
+    filterset_class = ReviewFilter
 
     def get_queryset(self):
         if getattr(self, "swagger_fake_view", False):
@@ -109,7 +111,7 @@ class UserOrdersView(ListAPIView):
 
     permission_class = [IsClient]
     serializer_class = OrderReadSerializer
-    # filterset_class = OrderFilter
+    filterset_class = UserOrderFilter
 
     def get_queryset(self):
         if getattr(self, "swagger_fake_view", False):