refactor(coupons): update views, fix cache issue

Author: tyronejosee

apps/coupons/managers.py

@@ -6,12 +6,14 @@
 class FixedCouponManager(models.Manager):
     """Manager for FixedCoupon model."""
 
-    def get_queryset(self):
-        return super().get_queryset().filter(is_active=True, available=True)
+    def get_all(self):
+        """Return default queryset."""
+        return self.filter(available=True, is_active=True)
 
 
 class PercentageCouponManager(models.Manager):
     """Manager for PercentageCoupon model."""
 
-    def get_queryset(self):
-        return super().get_queryset().filter(is_active=True, available=True)
+    def get_all(self):
+        """Return default queryset."""
+        return self.filter(available=True, is_active=True)

apps/coupons/migrations/0005_alter_fixedcoupon_end_date_and_more.py

@@ -0,0 +1,24 @@
+# Generated by Django 5.0.4 on 2024-04-22 16:34
+
+import datetime
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('coupons', '0004_alter_fixedcoupon_discount_price_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='fixedcoupon',
+            name='end_date',
+            field=models.DateField(default=datetime.datetime(2024, 5, 22, 16, 34, 16, 788467, tzinfo=datetime.timezone.utc)),
+        ),
+        migrations.AlterField(
+            model_name='percentagecoupon',
+            name='end_date',
+            field=models.DateField(default=datetime.datetime(2024, 5, 22, 16, 34, 16, 789227, tzinfo=datetime.timezone.utc)),
+        ),
+    ]

apps/coupons/migrations/0006_alter_fixedcoupon_end_date_and_more.py

@@ -0,0 +1,24 @@
+# Generated by Django 5.0.4 on 2024-04-22 17:54
+
+import datetime
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('coupons', '0005_alter_fixedcoupon_end_date_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='fixedcoupon',
+            name='end_date',
+            field=models.DateField(default=datetime.datetime(2024, 5, 22, 17, 54, 21, 904424, tzinfo=datetime.timezone.utc)),
+        ),
+        migrations.AlterField(
+            model_name='percentagecoupon',
+            name='end_date',
+            field=models.DateField(default=datetime.datetime(2024, 5, 22, 17, 54, 21, 905234, tzinfo=datetime.timezone.utc)),
+        ),
+    ]

apps/coupons/migrations/0007_alter_fixedcoupon_options_and_more.py

@@ -0,0 +1,41 @@
+# Generated by Django 5.0.4 on 2024-04-22 17:56
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('coupons', '0006_alter_fixedcoupon_end_date_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='fixedcoupon',
+            options={'ordering': ['pk'], 'verbose_name': 'fixed coupon', 'verbose_name_plural': 'fixed coupons'},
+        ),
+        migrations.AlterModelOptions(
+            name='percentagecoupon',
+            options={'ordering': ['pk'], 'verbose_name': 'percentage coupon', 'verbose_name_plural': 'percentage coupons'},
+        ),
+        migrations.AlterField(
+            model_name='fixedcoupon',
+            name='end_date',
+            field=models.DateField(),
+        ),
+        migrations.AlterField(
+            model_name='fixedcoupon',
+            name='start_date',
+            field=models.DateField(),
+        ),
+        migrations.AlterField(
+            model_name='percentagecoupon',
+            name='end_date',
+            field=models.DateField(),
+        ),
+        migrations.AlterField(
+            model_name='percentagecoupon',
+            name='start_date',
+            field=models.DateField(),
+        ),
+    ]

apps/coupons/models.py

@@ -1,9 +1,7 @@
 """Models for Coupons App."""
 
-from datetime import timedelta
 from django.db import models
 from django.core.validators import MinValueValidator, MaxValueValidator
-from django.utils import timezone
 
 from apps.utilities.models import BaseModel
 from .managers import FixedCouponManager, PercentageCouponManager
@@ -16,15 +14,16 @@ class FixedCoupon(BaseModel):
     code = models.CharField(max_length=36, unique=True, blank=True)
     discount_price = models.DecimalField(
         max_digits=7, decimal_places=2, validators=[validate_discount_price])
-    start_date = models.DateField(default=timezone.now)
-    end_date = models.DateField(default=timezone.now() + timedelta(days=30))
+    start_date = models.DateField()
+    end_date = models.DateField()
     quantity = models.PositiveIntegerField(default=50)
     is_active = models.BooleanField(default=True)
 
     objects = FixedCouponManager()
 
     class Meta:
         """Meta definition for FixedCoupon."""
+        ordering = ["pk"]
         verbose_name = "fixed coupon"
         verbose_name_plural = "fixed coupons"
 
@@ -44,15 +43,16 @@ class PercentageCoupon(BaseModel):
     code = models.CharField(max_length=36, unique=True, blank=True)
     discount_percentage = models.IntegerField(
         validators=[MinValueValidator(5), MaxValueValidator(25)])
-    start_date = models.DateField(default=timezone.now)
-    end_date = models.DateField(default=timezone.now() + timedelta(days=30))
+    start_date = models.DateField()
+    end_date = models.DateField()
     quantity = models.PositiveIntegerField(default=50)
     is_active = models.BooleanField(default=True)
 
     objects = PercentageCouponManager()
 
     class Meta:
         """Meta definition for PercentageCoupon."""
+        ordering = ["pk"]
         verbose_name = "percentage coupon"
         verbose_name_plural = "percentage coupons"
 

apps/coupons/views.py

@@ -19,44 +19,47 @@ class FixedCouponListAPIView(APIView):
     """APIView for listing and creating fixed coupons."""
     permission_classes = [IsAuthenticated]
     serializer_class = FixedCouponSerializer
-    pagination_class = MediumSetPagination
-    CACHE_TIMEOUT = 7200  # Cache for 2 hours
+    cache_key = "fixed_coupon"
+    cache_timeout = 7200
 
     def get(self, request, format=None):
         # Get a list of available fixed coupons
-        cache_key = f"fixed_coupon_{request.user.id}"
-        cached_data = cache.get(cache_key)
+        paginator = MediumSetPagination()
+        cached_data = cache.get(self.cache_key)
 
         if cached_data is None:
-            coupons = FixedCoupon.objects.filter(available=True).order_by("id")
-            if coupons.exists():
-                serializer = self.serializer_class(coupons, many=True)
-                # Set cache
-                cache.set(cache_key, serializer.data, self.CACHE_TIMEOUT)
-                return Response(serializer.data, status=status.HTTP_200_OK)
-            return Response(
-                {"detail": "No fixed coupons available."},
-                status=status.HTTP_404_NOT_FOUND
-            )
-        return Response(cached_data, status=status.HTTP_200_OK)
+            coupons = FixedCoupon.objects.get_all()
+            if not coupons.exists():
+                return Response(
+                    {"detail": "No fixed coupons available."},
+                    status=status.HTTP_404_NOT_FOUND
+                )
+            # Fetches the data from the database and serializes it
+            paginated_data = paginator.paginate_queryset(coupons, request)
+            serializer = self.serializer_class(paginated_data, many=True)
+            # Set cache
+            cache.set(self.cache_key, serializer.data, self.cache_timeout)
+        else:
+            # Retrieve the cached data and serialize it
+            paginated_cached_data = paginator.paginate_queryset(
+                cached_data, request)
+            serializer = self.serializer_class(
+                paginated_cached_data, many=True)
+
+        return paginator.get_paginated_response(serializer.data)
 
     @transaction.atomic
     def post(self, request, format=None):
         # Create a new fixed coupon
         serializer = self.serializer_class(data=request.data)
+
         if serializer.is_valid():
             serializer.save()
             # Invalidate cache
-            cache_key = f"fixed_coupon_{request.user.id}"
-            cache.delete(cache_key)
-            return Response(
-                serializer.data,
-                status=status.HTTP_201_CREATED
-            )
+            cache.delete(self.cache_key)
+            return Response(serializer.data, status=status.HTTP_201_CREATED)
         return Response(
-            serializer.errors,
-            status=status.HTTP_400_BAD_REQUEST
-        )
+            serializer.errors, status=status.HTTP_400_BAD_REQUEST)
 
 
 class FixedCouponDetailAPIView(APIView):
@@ -91,35 +94,43 @@ def put(self, request, fixed_coupon_id):
     def delete(self, request, fixed_coupon_id):
         # Delete a fixed coupon
         fixed_coupon = self.get_object(fixed_coupon_id)
-        fixed_coupon.delete()
+        fixed_coupon.available = False  # Logical deletion
+        fixed_coupon.save()
         return Response(status=status.HTTP_204_NO_CONTENT)
 
 
 class PercentageCouponListAPIView(APIView):
     """APIView for listing and creating percentage coupons."""
     permission_classes = [IsAuthenticated]
     serializer_class = PercentageCouponSerializer
-    pagination_class = MediumSetPagination
-    CACHE_TIMEOUT = 7200  # Cache for 2 hours
+    cache_key = "percentage_coupon"
+    cache_timeout = 7200
 
     def get(self, request, format=None):
         # Get a list of available percentage coupons
-        cache_key = f"percentage_coupon_{request.user.id}"
-        cached_data = cache.get(cache_key)
+        paginator = MediumSetPagination()
+        cached_data = cache.get(self.cache_key)
 
         if cached_data is None:
-            coupons = PercentageCoupon.objects.filter(
-                available=True).order_by("id")
-            if coupons.exists():
-                serializer = self.serializer_class(coupons, many=True)
-                # Set cache
-                cache.set(cache_key, serializer.data, self.CACHE_TIMEOUT)
-                return Response(serializer.data, status=status.HTTP_200_OK)
-            return Response(
-                {"detail": "No percentage coupons available."},
-                status=status.HTTP_404_NOT_FOUND
-            )
-        return Response(cached_data, status=status.HTTP_200_OK)
+            coupons = PercentageCoupon.objects.get_all()
+            if not coupons.exists():
+                return Response(
+                    {"detail": "No percentage coupons available."},
+                    status=status.HTTP_404_NOT_FOUND
+                )
+
+            paginated_data = paginator.paginate_queryset(coupons, request)
+            serializer = self.serializer_class(paginated_data, many=True)
+            # Set cache
+            cache.set(self.cache_key, serializer.data, self.cache_timeout)
+        else:
+            # Retrieve the cached data and serialize it
+            paginated_cached_data = paginator.paginate_queryset(
+                cached_data, request)
+            serializer = self.serializer_class(
+                paginated_cached_data, many=True)
+
+        return paginator.get_paginated_response(serializer.data)
 
     @transaction.atomic
     def post(self, request, format=None):
@@ -128,16 +139,9 @@ def post(self, request, format=None):
         if serializer.is_valid():
             serializer.save()
             # Invalidate cache
-            cache_key = f"percentage_coupon_{request.user.id}"
-            cache.delete(cache_key)
-            return Response(
-                serializer.data,
-                status=status.HTTP_201_CREATED
-            )
-        return Response(
-            serializer.errors,
-            status=status.HTTP_400_BAD_REQUEST
-        )
+            cache.delete(self.cache_key)
+            return Response(serializer.data, status=status.HTTP_201_CREATED)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
 
 
 class PercentageCouponDetailAPIView(APIView):
@@ -174,7 +178,8 @@ def put(self, request, percentage_coupon_id):
     def delete(self, request, percentage_coupon_id):
         # Delete a percentage coupon
         percentage_coupon = self.get_object(percentage_coupon_id)
-        percentage_coupon.delete()
+        percentage_coupon.available = False  # Logical deletion
+        percentage_coupon.save()
         return Response(status=status.HTTP_204_NO_CONTENT)
 
 

apps/locations/serializers.py

@@ -21,9 +21,21 @@ class Meta:
         ]
 
 
+class RegionListSerializer(ModelSerializer):
+    """Serializer for Region model (List only)."""
+
+    class Meta:
+        """Meta definition for RegionListSerializer."""
+        model = Region
+        fields = [
+            "id",
+            "name",
+        ]
+
+
 class ComuneSerializer(ModelSerializer):
     """Serializer for Comune model."""
-    region = RegionSerializer(read_only=True)
+    region = RegionSerializer()
 
     class Meta:
         """Meta definition for ComuneSerializer."""
@@ -35,3 +47,15 @@ class Meta:
             "created_at",
             "updated_at"
         ]
+
+
+class ComuneListSerializer(ModelSerializer):
+    """Serializer for Comune model (List only)."""
+
+    class Meta:
+        """Meta definition for ComuneListSerializer."""
+        model = Comune
+        fields = [
+            "id",
+            "name"
+        ]