feat(promotions): add fixed and percentage coupon viewsets, update managers and serializers

Author: tyronejosee

apps/promotions/managers.py

@@ -8,6 +8,9 @@
 class PromotionManager(BaseManager):
     """Manager for Promotion model."""
 
+    def get_active(self):
+        return self.get_available().filter(is_active=True)
+
     def get_search(self, search_term):
         return self.get_available().filter(
             Q(name__icontains=search_term) | Q(conditions__icontains=search_term)
@@ -17,10 +20,8 @@ def get_search(self, search_term):
 class FixedCouponManager(BaseManager):
     """Manager for FixedCoupon model."""
 
-    # TODO: fix manager, add new manager
-
-    def get_available(self):
-        return self.filter(available=True, is_active=True)
+    def get_active(self):
+        return self.get_available().filter(is_active=True)
 
     def get_by_code(self, code):
         return self.get_available().filter(code=code).first()
@@ -29,10 +30,8 @@ def get_by_code(self, code):
 class PercentageCouponManager(BaseManager):
     """Manager for PercentageCoupon model."""
 
-    # TODO: fix manager, add new manager
-
-    def get_available(self):
-        return self.filter(available=True, is_active=True)
+    def get_active(self):
+        return self.get_available().filter(is_active=True)
 
     def get_by_code(self, code):
         return self.get_available().filter(code=code).first()

apps/promotions/serializers.py

@@ -15,6 +15,7 @@ class PromotionReadSerializer(ModelSerializer):
     class Meta:
         model = Promotion
         fields = "__all__"
+        read_only_fields = fields
 
     def to_representation(self, instance):
         data = super().to_representation(instance)
@@ -64,6 +65,7 @@ class FixedCouponReadSerializer(ModelSerializer):
     class Meta:
         model = FixedCoupon
         fields = "__all__"
+        read_only_fields = fields
 
 
 class FixedCouponWriteSerializer(ModelSerializer):
@@ -91,6 +93,7 @@ class PercentageCouponReadSerializer(ModelSerializer):
     class Meta:
         model = PercentageCoupon
         fields = "__all__"
+        read_only_fields = fields
 
 
 class PercentageCouponWriteSerializer(ModelSerializer):

apps/promotions/viewsets.py

@@ -4,8 +4,15 @@
 
 from apps.users.permissions import IsMarketing
 from apps.utilities.mixins import ListCacheMixin, LogicalDeleteMixin
-from .models import Promotion
-from .serializers import PromotionReadSerializer, PromotionWriteSerializer
+from .models import Promotion, FixedCoupon, PercentageCoupon
+from .serializers import (
+    PromotionReadSerializer,
+    PromotionWriteSerializer,
+    FixedCouponReadSerializer,
+    FixedCouponWriteSerializer,
+    PercentageCouponReadSerializer,
+    PercentageCouponWriteSerializer,
+)
 
 
 class PromotionViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
@@ -27,9 +34,72 @@ class PromotionViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
     # filterset_class = PromotionFilter
 
     def get_queryset(self):
-        return Promotion.objects.get_available()
+        return Promotion.objects.get_active()
 
     def get_serializer_class(self):
         if self.action in ["list", "retrieve"]:
             return PromotionReadSerializer
         return super().get_serializer_class()
+
+    def perform_create(self, serializer):
+        serializer.save(creator=self.request.user)
+
+
+class FixedCoponViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
+    """
+    ViewSet for managing FixedCoupon instances.
+
+    Endpoints:
+    - GET /api/v1/fixed-coupon/
+    - POST /api/v1/fixed-coupon/
+    - GET /api/v1/fixed-coupon/{id}/
+    - PUT /api/v1/fixed-coupon/{id}/
+    - PATCH /api/v1/fixed-coupon/{id}/
+    - DELETE /api/v1/fixed-coupon/{id}/
+    """
+
+    permission_classes = [IsMarketing]
+    serializer_class = FixedCouponWriteSerializer
+    search_fields = ["name"]
+    # filterset_class = FixedCouponFilter
+
+    def get_queryset(self):
+        return FixedCoupon.objects.get_active()
+
+    def get_serializer_class(self):
+        if self.action in ["list", "retrieve"]:
+            return FixedCouponReadSerializer
+        return super().get_serializer_class()
+
+    def perform_create(self, serializer):
+        serializer.save(creator=self.request.user)
+
+
+class PercentageCoponViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
+    """
+    ViewSet for managing FixedCoupon instances.
+
+    Endpoints:
+    - GET /api/v1/percentage-coupons/
+    - POST /api/v1/percentage-coupons/
+    - GET /api/v1/percentage-coupons/{id}/
+    - PUT /api/v1/percentage-coupons/{id}/
+    - PATCH /api/v1/percentage-coupons/{id}/
+    - DELETE /api/v1/percentage-coupons/{id}/
+    """
+
+    permission_classes = [IsMarketing]
+    serializer_class = PercentageCouponWriteSerializer
+    search_fields = ["name"]
+    # filterset_class = FixedCouponFilter
+
+    def get_queryset(self):
+        return PercentageCoupon.objects.get_active()
+
+    def get_serializer_class(self):
+        if self.action in ["list", "retrieve"]:
+            return PercentageCouponReadSerializer
+        return super().get_serializer_class()
+
+    def perform_create(self, serializer):
+        serializer.save(creator=self.request.user)

roadmap.md

@@ -38,16 +38,30 @@ Pending implementation
 
 ## Promotions [OK]
 
-- [ ] `GET /promotions/` Obtener una lista de todas las promociones disponibles (IsMarketing).
-- [ ] `POST /promotions/` Crear una nueva promoción (IsMarketing).
-- [ ] `GET /promotions/{id}/` Obtener los detalles de una promoción específica (IsMarketing).
-- [ ] `PUT /promotions/{id}/` Actualizar todos los detalles de una promoción específica (IsMarketing).
-- [ ] `PATCH /promotions/{id}/` Actualizar parcialmente una promoción específica (IsMarketing).
-- [ ] `DELETE /promotions/{id}/` Eliminar una promoción específica (IsMarketing).
+- [x] `GET /promotions/` Obtener una lista de todas las promociones disponibles (IsMarketing).
+- [x] `POST /promotions/` Crear una nueva promoción (IsMarketing).
+- [x] `GET /promotions/{id}/` Obtener los detalles de una promoción específica (IsMarketing).
+- [x] `PUT /promotions/{id}/` Actualizar todos los detalles de una promoción específica (IsMarketing).
+- [x] `PATCH /promotions/{id}/` Actualizar parcialmente una promoción específica (IsMarketing).
+- [x] `DELETE /promotions/{id}/` Eliminar una promoción específica (IsMarketing).
+
+- [x] `GET /fixed-coupons/`
+- [x] `POST /fixed-coupons/`
+- [x] `GET /fixed-coupons/{id}/`
+- [x] `PUT /fixed-coupons/{id}/`
+- [x] `PATCH /fixed-coupons/{id}/`
+- [x] `DELETE /fixed-coupons/{id}/`
+
+- [x] `GET /percentage-coupons/`
+- [x] `POST /percentage-coupons/`
+- [x] `GET /percentage-coupons/{id}/`
+- [x] `PUT /percentage-coupons/{id}/`
+- [x] `PATCH /percentage-coupons/{id}/`
+- [x] `DELETE /percentage-coupons/{id}/`
 
 ## Deliveries
 
-- [ ] `GET /deliveries/`
+<!-- - [ ] `GET /deliveries/`
 - [ ] `POST /deliveries/`
 - [ ] `GET /deliveries/{id}/`
 - [ ] `PUT /deliveries/{id}/`
@@ -56,16 +70,7 @@ Pending implementation
 - [ ] `POST /orders/{order_id}/deliveries/`
 - [ ] `GET /orders/{order_id}/deliveries/{delivery_id}/`
 - [ ] `PUT /orders/{order_id}/deliveries/{delivery_id}/`
-- [ ] `DELETE /orders/{order_id}/deliveries/{delivery_id}/`
-
-## Coupons
-
-- [ ] `GET /coupons/`
-- [ ] `POST /coupons/`
-- [ ] `GET /coupons/{id}/`
-- [ ] `PUT /coupons/{id}/`
-- [ ] `DELETE /coupons/{id}/`
-- [ ] `GET /coupons/{coupon_id}/orders/`
+- [ ] `DELETE /orders/{order_id}/deliveries/{delivery_id}/` -->
 
 ## Restaurants [OK]