Replace DRF wirth Ninja

.github/workflows/benchmark.yml

@@ -76,4 +76,4 @@ jobs:
 
     - name: Failure logs
       if: failure()
-      run: docker-compose logs
+      run: docker compose logs

.github/workflows/conformance.yml

@@ -105,4 +105,4 @@ jobs:
 
       - name: Failure logs
         if: failure()
-        run: docker-compose logs
+        run: docker compose logs

.github/workflows/deploy.yml

@@ -24,14 +24,14 @@ jobs:
           key: ${{ secrets.KEY }}
           script: |
             cd /home/ubuntu/django-ogcapif
-            docker-compose down -v --remove-orphans
+            docker compose down -v --remove-orphans
             git checkout main && git pull -f
-            docker-compose up -d --build --force-recreate
-            docker-compose exec django python manage.py migrate --no-input
-            docker-compose exec django python manage.py collectstatic --no-input
-            docker-compose exec django python manage.py populate_users
-            docker-compose exec django python manage.py populate_data
+            docker compose up -d --build --force-recreate
+            docker compose exec django python manage.py migrate --no-input
+            docker compose exec django python manage.py collectstatic --no-input
+            docker compose exec django python manage.py populate_users
+            docker compose exec django python manage.py populate_data
 
       - name: Failure logs
         if: failure()
-        run: docker-compose logs django_oapif_tests
+        run: docker compose logs django_oapif_tests

.github/workflows/test.yml

@@ -45,4 +45,4 @@ jobs:
 
     - name: Failure logs
       if: failure()
-      run: docker-compose logs
+      run: docker compose logs

README.md

@@ -1,6 +1,6 @@
 # Django-OAPIF
 
 *Django-OAPIF* allows to easily expose your Django models through an OGC API Features endpoint.
-It is based on Django REST Framework.
+It is based on Django Ninja.
 
 https://opengisch.github.io/django-oapif

django_oapif/README.md

@@ -1,4 +1,4 @@
 # Django-OAPIF
 
 *Django-OAPIF* allows to easily expose your Django models through an OGC API Features endpoint.
-It is based on Django REST Framework.
+It is based on Django Ninja.

django_oapif/__init__.py

@@ -1,5 +1,15 @@
+from . import permissions
+from .api import OAPIF
+
 try:
     from .__version__ import __version__, __version_tuple__
 except ImportError:
     __version__ = "0.0.0.dev"
     __version_tuple__ = (0, 0, 0, "dev")
+
+__all__ = [
+    "permissions",
+    "OAPIF",
+    "__version__",
+    "__version_tuple__",
+]

django_oapif/api.py

@@ -0,0 +1,83 @@
+from typing import Any, Optional
+
+from django.conf import settings
+from django.contrib.auth import authenticate
+from django.db import models
+from django.http import HttpRequest
+from ninja import NinjaAPI
+from ninja.security import APIKeyCookie, HttpBasicAuth
+
+from django_oapif.collections import (
+    OAPIFCollectionEntry,
+    create_collection_router,
+    create_collections_router,
+)
+from django_oapif.conformance import create_conformance_router
+from django_oapif.permissions import (
+    BasePermission,
+    DjangoModelPermissionsOrAnonReadOnly,
+)
+from django_oapif.root import create_root_router
+
+
+class BasicAuth(HttpBasicAuth):
+    def authenticate(self, request, username, password):
+        if user := authenticate(request, username=username, password=password):
+            request.user = user
+        return request.user
+
+
+class DjangoAuth(APIKeyCookie):
+    param_name: str = settings.SESSION_COOKIE_NAME
+
+    def authenticate(self, request: HttpRequest, key: Optional[str]) -> Optional[Any]:
+        return request.user
+
+
+class OAPIF:
+    """Ninja API."""
+
+    def __init__(self):
+        self.api = NinjaAPI(auth=[BasicAuth(), DjangoAuth()])
+        self.collections: dict[str, OAPIFCollectionEntry] = {}
+        self.api.add_router("/", create_root_router())
+        self.api.add_router("/conformance", create_conformance_router())
+        self.api.add_router("/collections", create_collections_router(self.collections))
+
+    def register(
+        self,
+        /,
+        id: str | None = None,
+        title: str | None = None,
+        description: str | None = None,
+        geometry_field: str | None = "geom",
+        properties_fields: list[str] | None = None,
+        auth: type[BasePermission] = DjangoModelPermissionsOrAnonReadOnly,
+    ):
+        """Register a Django model in the API."""
+
+        def decorator(model_class: models.Model):
+            collection_id = id or model_class._meta.label_lower
+            collection_title = id or model_class._meta.label
+            self.collections[collection_id] = OAPIFCollectionEntry(
+                model_class=model_class,
+                id=collection_id,
+                title=collection_title,
+                description=description,
+                geometry_field=geometry_field,
+                properties_fields=properties_fields,
+                auth=auth,
+            )
+
+            return model_class
+
+        return decorator
+
+    def _add_collections_routers(self):
+        for collection_id, collection_entry in self.collections.items():
+            self.api.add_router(f"/collections/{collection_id}", create_collection_router(collection_entry))
+
+    @property
+    def urls(self):
+        self._add_collections_routers()
+        return self.api.urls