feat(promotions): add promotion search view and managers

Author: tyronejosee

.pre-commit-config.yaml

@@ -30,7 +30,7 @@ repos:
     rev: "7.0.0"
     hooks:
       - id: flake8
-        args: ["--max-line-length=79", "--ignore=E501"]
+        args: ["--max-line-length=79", "--ignore=E501,W503"]
 
 ci:
   autoupdate_schedule: weekly

apps/promotions/managers.py

@@ -1,6 +1,6 @@
 """Managers for Promotions App."""
 
-from django.db.models import Manager
+from django.db.models import Manager, Q
 
 
 class PromotionManager(Manager):
@@ -17,3 +17,10 @@ def get_available(self):
     def get_unavailable(self):
         """Return a queryset of unavailable promotions."""
         return self.get_queryset().filter(available=False)
+
+    def get_search(self, search_query):
+        """Filter promotions based on a search query."""
+        return self.get_available().filter(
+            Q(name__icontains=search_query)
+            | Q(conditions__icontains=search_query)
+        )

apps/promotions/urls.py

@@ -2,7 +2,7 @@
 
 from django.urls import path
 
-from .views import PromotionListView, PromotionDetailView
+from .views import PromotionListView, PromotionDetailView, PromotionSearchView
 
 
 urlpatterns = [
@@ -13,5 +13,9 @@
     path(
         "api/v1/promotions/<uuid:promotion_id>/",
         PromotionDetailView.as_view()
+    ),
+    path(
+        "api/v1/promotions/search/",
+        PromotionSearchView.as_view()
     )
 ]

apps/promotions/views.py

@@ -92,3 +92,33 @@ def delete(self, request, promotion_id):
         promotion.available = False  # Logical deletion
         promotion.save()
         return Response(status=status.HTTP_204_NO_CONTENT)
+
+
+class PromotionSearchView(APIView):
+    """
+    View to search promotions.
+
+    Endpoints:
+    - GET api/v1/promotions/?query=<search_query>
+    """
+
+    def get(self, request):
+        # Search for promotions for name and conditions fields
+        search_query = request.query_params.get("query", "")
+
+        if not search_query:
+            return Response(
+                {"details": "No search query provided"},
+                status=status.HTTP_400_BAD_REQUEST
+            )
+
+        promotions = Promotion.objects.get_search(search_query)
+
+        if not promotions.exists():
+            return Response(
+                {"details": "No results found."},
+                status=status.HTTP_404_NOT_FOUND
+            )
+
+        serializer = PromotionReadSerializer(promotions, many=True)
+        return Response(serializer.data)

apps/restaurants/schemas.py

@@ -56,7 +56,7 @@
         summary="Get category",
         description="pending",
     ),
-    "put": extend_schema(
+    "patch": extend_schema(
         operation_id="category_detail_update",
         summary="Update category",
         description="pending",