Merge pull request #1437 from ae-utbm/api-membership-club

ajout requette api nouveau et ancien membre de club

club/api.py

@@ -11,6 +11,7 @@ from club.models import Club, Membership
 from club.schemas import (
     ClubSchema,
     ClubSearchFilterSchema,
+    MembershipFilterSchema,
     SimpleClubSchema,
     UserMembershipSchema,
 )
@@ -62,3 +63,43 @@ class UserClubController(ControllerBase):
             .filter(user=user)
             .select_related("club", "user", "role")
         )
+
+
+@api_controller("/clubs/members/")
+class ClubMembershipController(ControllerBase):
+    @route.get(
+        "/new",
+        response=list[UserMembershipSchema],
+        auth=[ApiKeyAuth(), SessionAuth()],
+        permissions=[HasPerm("club.view_club")],
+        url_name="get_new_clubs_members_since_date",
+    )
+    def fetch_new_club_members(self, filters: Query[MembershipFilterSchema]):
+        """give all the members of all clubs that have joined since a given date"""
+        memberships = (
+            Membership.objects.ongoing()
+            .filter(start_date__gte=filters.since_date, end_date__isnull=True)
+            .select_related("user", "role", "club")
+        )
+        if filters.clubs_id:
+            memberships = memberships.filter(club_id__in=filters.clubs_id)
+
+        return memberships.order_by("start_date")
+
+    @route.get(
+        "/former",
+        response=list[UserMembershipSchema],
+        auth=[ApiKeyAuth(), SessionAuth()],
+        permissions=[HasPerm("club.view_club")],
+        url_name="get_former_clubs_members_since_date",
+    )
+    def fetch_former_club_members(self, filters: Query[MembershipFilterSchema]):
+        """give all the former members of all clubs that have left since a given date"""
+        memberships = Membership.objects.filter(
+            start_date__lt=filters.since_date,
+            end_date__gte=filters.since_date,
+        ).select_related("user", "role", "club")
+        if filters.clubs_id:
+            memberships = memberships.filter(club_id__in=filters.clubs_id)
+
+        return memberships.order_by("start_date")

club/schemas.py

@@ -1,3 +1,4 @@
+from datetime import date
 from typing import Annotated
 
 from django.db.models import Q
@@ -79,3 +80,9 @@ class UserMembershipSchema(ModelSchema):
 
     club: SimpleClubSchema
     role: ClubRoleSchema
+    user: SimpleUserSchema
+
+
+class MembershipFilterSchema(FilterSchema):
+    since_date: Annotated[date, FilterLookup("date__lte")]
+    clubs_id: set[int] | None = None

club/tests/test_club_membership_controller.py

@@ -0,0 +1,203 @@
+from datetime import timedelta
+
+from django.contrib.auth.models import Permission
+from django.test import TestCase
+from django.urls import reverse
+from django.utils.timezone import localdate
+from model_bakery import baker
+
+from club.models import Club, ClubRole, Membership
+from core.baker_recipes import subscriber_user
+from core.models import User
+
+
+class TestMembershipAPI(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.user = baker.make(User)
+        perm = Permission.objects.get(codename="view_club")
+        cls.user.user_permissions.add(perm)
+        cls.clubs = baker.make(Club, _quantity=3, is_active=True)
+        cls.roles = baker.make(ClubRole, _quantity=3, is_active=True)
+        cls.expectedNumQueries = 5
+
+        # Clean existing data to avoid side effects
+        Membership.objects.all().delete()
+
+        cls.memberships = [
+            # on going
+            Membership.objects.create(
+                club=cls.clubs[0],
+                user=subscriber_user.make(),
+                role=cls.roles[0],
+                start_date=localdate() - timedelta(weeks=1),
+            ),
+            # on going
+            Membership.objects.create(
+                club=cls.clubs[1],
+                user=subscriber_user.make(),
+                role=cls.roles[1],
+                start_date=localdate() - timedelta(days=1),
+            ),
+            # former
+            Membership.objects.create(
+                club=cls.clubs[1],
+                user=subscriber_user.make(),
+                role=cls.roles[2],
+                start_date=localdate() - timedelta(weeks=2),
+                end_date=localdate() - timedelta(days=6),
+            ),
+            # on going
+            Membership.objects.create(
+                club=cls.clubs[2],
+                user=subscriber_user.make(),
+                role=cls.roles[0],
+                start_date=localdate() - timedelta(weeks=3),
+            ),
+            # former
+            Membership.objects.create(
+                club=cls.clubs[1],
+                user=subscriber_user.make(),
+                role=cls.roles[2],
+                start_date=localdate() - timedelta(days=4),
+                end_date=localdate() - timedelta(days=3),
+            ),
+            # on going
+            Membership.objects.create(
+                club=cls.clubs[2],
+                user=subscriber_user.make(),
+                role=cls.roles[0],
+                start_date=localdate() - timedelta(days=1),
+            ),
+            # former
+            Membership.objects.create(
+                club=cls.clubs[0],
+                user=subscriber_user.make(),
+                role=cls.roles[0],
+                start_date=localdate() - timedelta(weeks=6),
+                end_date=localdate() - timedelta(days=3),
+            ),
+            # former
+            Membership.objects.create(
+                club=cls.clubs[2],
+                user=subscriber_user.make(),
+                role=cls.roles[0],
+                start_date=localdate() - timedelta(weeks=8),
+                end_date=localdate() - timedelta(days=6),
+            ),
+            # former
+            Membership.objects.create(
+                club=cls.clubs[1],
+                user=subscriber_user.make(),
+                role=cls.roles[0],
+                start_date=localdate() - timedelta(weeks=8),
+                end_date=localdate() - timedelta(weeks=7, days=5),
+            ),
+        ]
+
+
+class TestNewMembershipAPI(TestMembershipAPI):
+    @classmethod
+    def setUpTestData(cls):
+        super().setUpTestData()
+        cls.url = reverse("api:get_new_clubs_members_since_date")
+
+    def test_new_membership_one_club(self):
+        self.client.force_login(self.user)
+        since_date = localdate() - timedelta(weeks=1)
+        arg = {"since_date": since_date, "clubs_id": self.clubs[0].id}
+        with self.assertNumQueries(self.expectedNumQueries):
+            response = self.client.get(self.url, query_params=arg)
+        assert response.status_code == 200
+        data = response.json()
+
+        membership_ids = [e["id"] for e in data]
+        expected_ids = [self.memberships[0].id]
+        assert membership_ids == expected_ids
+
+    def test_new_membership_multiple_club(self):
+        self.client.force_login(self.user)
+        since_date = localdate() - timedelta(weeks=1)
+        arg = {
+            "since_date": since_date,
+            "clubs_id": [self.clubs[0].id, self.clubs[1].id],
+        }
+        with self.assertNumQueries(self.expectedNumQueries):
+            response = self.client.get(self.url, query_params=arg)
+        assert response.status_code == 200
+        data = response.json()
+
+        membership_ids = [e["id"] for e in data]
+        expected_ids = [self.memberships[0].id, self.memberships[1].id]
+        assert membership_ids == expected_ids
+
+    def test_new_membership_all_clubs(self):
+        self.client.force_login(self.user)
+        since_date = localdate() - timedelta(weeks=1)
+        arg = {"since_date": since_date}
+        with self.assertNumQueries(self.expectedNumQueries):
+            response = self.client.get(self.url, query_params=arg)
+        assert response.status_code == 200
+        data = response.json()
+
+        membership_ids = [e["id"] for e in data]
+        expected_ids = [
+            self.memberships[0].id,
+            self.memberships[1].id,
+            self.memberships[5].id,
+        ]
+        assert membership_ids == expected_ids
+
+
+class TestFormerMembershipAPI(TestMembershipAPI):
+    @classmethod
+    def setUpTestData(cls):
+        super().setUpTestData()
+        cls.url = reverse("api:get_former_clubs_members_since_date")
+
+    def test_former_membership_one_club(self):
+        self.client.force_login(self.user)
+        since_date = localdate() - timedelta(weeks=1)
+        arg = {"since_date": since_date, "clubs_id": self.clubs[1].id}
+        with self.assertNumQueries(self.expectedNumQueries):
+            response = self.client.get(self.url, query_params=arg)
+
+        assert response.status_code == 200
+        data = response.json()
+
+        membership_ids = [e["id"] for e in data]
+        expected_ids = [self.memberships[2].id]
+        assert membership_ids == expected_ids
+
+    def test_new_membership_multiple_club(self):
+        self.client.force_login(self.user)
+        since_date = localdate() - timedelta(weeks=1)
+        arg = {
+            "since_date": since_date,
+            "clubs_id": [self.clubs[1].id, self.clubs[0].id],
+        }
+        with self.assertNumQueries(self.expectedNumQueries):
+            response = self.client.get(self.url, query_params=arg)
+        assert response.status_code == 200
+        data = response.json()
+
+        membership_ids = [e["id"] for e in data]
+        expected_ids = [self.memberships[6].id, self.memberships[2].id]
+        assert membership_ids == expected_ids
+
+    def test_new_membership_all_clubs(self):
+        self.client.force_login(self.user)
+        since_date = localdate() - timedelta(weeks=1)
+        arg = {"since_date": since_date}
+        with self.assertNumQueries(self.expectedNumQueries):
+            response = self.client.get(self.url, query_params=arg)
+        assert response.status_code == 200
+        data = response.json()
+
+        membership_ids = [e["id"] for e in data]
+        expected_ids = [
+            self.memberships[7].id,
+            self.memberships[6].id,
+            self.memberships[2].id,
+        ]
+        assert membership_ids == expected_ids