Add filtering and upcoming events

Author: ahmedxgouda

backend/apps/api/rest/v0/chapter.py

@@ -5,12 +5,13 @@
 from typing import Literal
 
 from django.http import HttpRequest
-from ninja import Field, FilterSchema, Path, Query, Schema
+from ninja import Field, Path, Query, Schema
 from ninja.decorators import decorate_view
 from ninja.pagination import RouterPaginated
 from ninja.responses import Response
 
 from apps.api.decorators.cache import cache_response
+from apps.api.rest.v0.common import LocationFilter
 from apps.owasp.models.chapter import Chapter as ChapterModel
 
 router = RouterPaginated(tags=["Chapters"])
@@ -23,6 +24,8 @@ class ChapterBase(Schema):
     key: str
     name: str
     updated_at: datetime
+    longitude: float | None = None
+    latitude: float | None = None
 
     @staticmethod
     def resolve_key(obj):
@@ -49,7 +52,7 @@ class ChapterError(Schema):
     message: str
 
 
-class ChapterFilter(FilterSchema):
+class ChapterFilter(LocationFilter):
     """Filter for Chapter."""
 
     country: str | None = Field(None, description="Country of the chapter")
@@ -66,7 +69,17 @@ class ChapterFilter(FilterSchema):
 def list_chapters(
     request: HttpRequest,
     filters: ChapterFilter = Query(...),
-    ordering: Literal["created_at", "-created_at", "updated_at", "-updated_at"] | None = Query(
+    ordering: Literal[
+        "created_at",
+        "-created_at",
+        "updated_at",
+        "-updated_at",
+        "longitude",
+        "-longitude",
+        "latitude",
+        "-latitude",
+    ]
+    | None = Query(
         None,
         description="Ordering field",
     ),

backend/apps/api/rest/v0/common.py

@@ -0,0 +1,20 @@
+"""Common schemas and filters for the API."""
+
+from ninja import Field, FilterSchema
+
+
+class LocationFilter(FilterSchema):
+    """Filter for Location."""
+
+    longitude_gte: float | None = Field(
+        None, description="Longitude greater than or equal to", q="longitude__gte"
+    )
+    longitude_lte: float | None = Field(
+        None, description="Longitude less than or equal to", q="longitude__lte"
+    )
+    latitude_gte: float | None = Field(
+        None, description="Latitude greater than or equal to", q="latitude__gte"
+    )
+    latitude_lte: float | None = Field(
+        None, description="Latitude less than or equal to", q="latitude__lte"
+    )

backend/apps/api/rest/v0/event.py

@@ -11,6 +11,7 @@
 from ninja.responses import Response
 
 from apps.api.decorators.cache import cache_response
+from apps.api.rest.v0.common import LocationFilter
 from apps.owasp.models.event import Event as EventModel
 
 router = RouterPaginated(tags=["Events"])
@@ -24,6 +25,8 @@ class EventBase(Schema):
     name: str
     start_date: datetime
     url: str | None = None
+    longitude: float | None = None
+    latitude: float | None = None
 
 
 class Event(EventBase):
@@ -34,8 +37,6 @@ class EventDetail(EventBase):
     """Detail schema for Event (used in single item endpoints)."""
 
     description: str | None = None
-    longitude: float
-    latitude: float
 
 
 class EventError(Schema):
@@ -54,13 +55,33 @@ class EventError(Schema):
 @decorate_view(cache_response())
 def list_events(
     request: HttpRequest,
-    ordering: Literal["start_date", "-start_date", "end_date", "-end_date"] | None = Query(
+    filters: LocationFilter = Query(...),
+    ordering: Literal[
+        "start_date", "-start_date", "end_date", "-end_date", "longitude", "-longitude"
+    ]
+    | None = Query(
         None,
         description="Ordering field",
     ),
 ) -> list[Event]:
     """Get all events."""
-    return EventModel.objects.order_by(ordering or "-start_date", "-end_date")
+    return filters.filter(EventModel.objects.order_by(ordering or "-start_date", "-end_date"))
+
+
+@router.get(
+    "/upcoming",
+    description="Retrieve a paginated list of upcoming OWASP events.",
+    operation_id="list_upcoming_events",
+    summary="List upcoming events",
+    response=list[Event],
+)
+@decorate_view(cache_response())
+def list_upcoming_events(
+    request: HttpRequest,
+    filters: LocationFilter = Query(...),
+) -> list[Event]:
+    """Get upcoming events."""
+    return filters.filter(EventModel.upcoming_events())
 
 
 @router.get(