Banner filtering (#687)

* feat: banner search

* chore: update changelog

* chore: refactor based on comments and callums PR 🙂

* chore: format

* chore: refactor comments

* Added migration

* Format

---------

Co-authored-by: Thomas <[email protected]>

CHANGELOG.md

@@ -13,7 +13,7 @@
 ---
 
 ## Neste versjon
-
+- ✨ **Bannere** Filtrering på bannere
 - ✨ **Spørreskjemaer** NOK medlemmer kan lage spørreskjema.
 - ⚡ **Bruker** Nå kan ikke HS lenger endre eller slette brukere.
 - ⚡ **Mails** Nå logger vi på eposttjeneren kun en gang per batch med epost som sendes.

app/communication/migrations/0008_alter_banner_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.5 on 2023-10-04 08:01
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("communication", "0007_remove_sent_mails"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="banner",
+            options={"ordering": ("-visible_from",)},
+        ),
+    ]

app/communication/models/banner.py

@@ -44,7 +44,7 @@ def save(self, *args, **kwargs):
         super().save(*args, **kwargs)
 
     class Meta:
-        ordering = ("-updated_at",)
+        ordering = ("-visible_from",)
 
     @property
     def exists_overlapping_banners(self):
@@ -57,6 +57,14 @@ def exists_overlapping_banners(self):
             .exists()
         )
 
+    @property
+    def is_expired(self):
+        return self.visible_until < now()
+
+    @property
+    def is_visible(self):
+        return self.visible_from <= now() <= self.visible_until
+
     @classmethod
     def has_visible_permission(cls, request):
         return True

app/communication/views/banner.py

@@ -1,3 +1,6 @@
+from django_filters import BooleanFilter
+from django_filters.rest_framework import DjangoFilterBackend
+from django_filters.rest_framework.filterset import FilterSet
 from rest_framework import status
 from rest_framework.decorators import action
 from rest_framework.response import Response
@@ -10,12 +13,34 @@
 from app.util.utils import now
 
 
+class BannerFilter(FilterSet):
+    is_visible = BooleanFilter(method="filter_is_visible")
+    is_expired = BooleanFilter(method="filter_is_expired")
+
+    class Meta:
+        model = Banner
+        fields = ["is_visible", "is_expired"]
+
+    def filter_is_visible(self, queryset, name, value):
+        if value:
+            return queryset.filter(is_visible=True)
+        return queryset
+
+    def filter_is_expired(self, queryset, name, value):
+        if value:
+            return queryset.filter(is_expired=True)
+        return queryset
+
+
 class BannerViewSet(BaseViewSet):
     serializer_class = BannerSerializer
     pagination_class = BasePagination
     queryset = Banner.objects.all()
     permission_classes = [BasicViewPermission]
 
+    filter_backends = [DjangoFilterBackend]
+    filterset_class = BannerFilter
+
     @action(
         detail=False,
         methods=["get"],

app/group/admin.py

@@ -24,10 +24,7 @@ class MembershipAdmin(admin.ModelAdmin):
         "user",
     )
 
-    search_fields = [
-        "user__first_name",
-        "user__last_name"
-    ]
+    search_fields = ["user__first_name", "user__last_name"]
 
 
 @admin.register(models.MembershipHistory)