#31 API basic implementation

* adds new app to project
* adds relation between User model and new APIUserToken model
* adds first implementation for GET of intervention
* adds basic code layout for future extension by having new versions

api/admin.py

@@ -0,0 +1,16 @@
+from django.contrib import admin
+
+from api.models.token import APIUserToken
+
+
+class APITokenAdmin(admin.ModelAdmin):
+    list_display = [
+        "token",
+        "valid_until",
+        "is_active",
+    ]
+    readonly_fields = [
+        "token"
+    ]
+
+admin.site.register(APIUserToken, APITokenAdmin)

api/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    name = 'api'

api/models/__init__.py

@@ -0,0 +1,8 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 21.01.22
+
+"""
+from .token import *

api/models/token.py

@@ -0,0 +1,23 @@
+from django.db import models
+
+from konova.utils.generators import generate_token
+
+
+class APIUserToken(models.Model):
+    token = models.CharField(
+        primary_key=True,
+        max_length=1000,
+        default=generate_token,
+    )
+    valid_until = models.DateField(
+        blank=True,
+        null=True,
+        help_text="Token is only valid until this date",
+    )
+    is_active = models.BooleanField(
+        default=False,
+        help_text="Must be activated by an admin"
+    )
+
+    def __str__(self):
+        return self.token

api/tests/__init__.py

@@ -0,0 +1,7 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 21.01.22
+
+"""

api/tests/test_api.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

api/urls/__init__.py

@@ -0,0 +1,8 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 21.01.22
+
+"""
+from .urls import *

api/urls/urls.py

@@ -0,0 +1,14 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 21.01.22
+
+"""
+from django.urls import path, include
+
+app_name = "api"
+
+urlpatterns = [
+    path("v1/", include("api.urls.v1.urls")),
+]

api/urls/v1/__init__.py

@@ -0,0 +1,7 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 21.01.22
+
+"""

api/urls/v1/urls.py

@@ -0,0 +1,14 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 21.01.22
+
+"""
+from django.urls import path
+
+from api.views.v1.intervention import APIInterventionView
+
+urlpatterns = [
+    path("intervention/<identifier>", APIInterventionView.as_view(), name="api-intervention"),
+]

api/views/__init__.py

@@ -0,0 +1,8 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 21.01.22
+
+"""
+from .v1 import *

api/views/v1/__init__.py

@@ -0,0 +1,7 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 21.01.22
+
+"""

api/views/v1/general.py

@@ -0,0 +1,77 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 21.01.22
+
+"""
+from django.db.models import QuerySet
+
+from api.views.views import AbstractModelAPIView
+from codelist.models import KonovaCode
+from intervention.models import Responsibility, Legal
+
+
+class AbstractModelAPIViewV1(AbstractModelAPIView):
+    """ Holds general serialization functions for API v1
+
+    """
+
+    def konova_code_to_json(self, konova_code: KonovaCode):
+        return {
+            "atom_id": konova_code.atom_id,
+            "long_name": konova_code.long_name,
+            "short_name": konova_code.short_name,
+        }
+
+    def responsible_to_json(self, responsible: Responsibility):
+        return {
+            "registration_office": self.konova_code_to_json(responsible.registration_office),
+            "registration_file_number": responsible.registration_file_number,
+            "conservation_office": self.konova_code_to_json(responsible.conservation_office),
+            "conservation_file_number": responsible.conservation_file_number,
+            "handler": responsible.handler,
+        }
+
+    def legal_to_json(self, legal: Legal):
+        return {
+            "registration_date": legal.registration_date,
+            "binding_date": legal.binding_date,
+            "process_type": self.konova_code_to_json(legal.process_type),
+            "laws": [self.konova_code_to_json(law) for law in legal.laws.all()],
+        }
+
+    def payments_to_json(self, qs: QuerySet):
+        """ Serializes payments into json
+
+        Args:
+            qs (QuerySet): A queryset of Payment entries
+
+        Returns:
+
+        """
+        return [
+            {
+                "amount": entry.amount,
+                "due_on": entry.due_on,
+                "comment": entry.comment,
+            }
+            for entry in qs
+        ]
+
+    def deductions_to_json(self, qs: QuerySet):
+        """ Serializes eco account deductions into json
+
+        Args:
+            qs (QuerySet): A queryset of EcoAccountDeduction entries
+
+        Returns:
+
+        """
+        return [
+            {
+                "eco_account": entry.account.pk,
+                "surface": entry.surface,
+            }
+            for entry in qs
+        ]

api/views/v1/intervention.py

@@ -0,0 +1,40 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 21.01.22
+
+"""
+import json
+
+from django.http import HttpRequest, JsonResponse
+
+from api.views.v1.general import AbstractModelAPIViewV1
+from intervention.models import Intervention
+
+
+class APIInterventionView(AbstractModelAPIViewV1):
+    model = Intervention
+    fields_to_serialize = {
+        "identifier",
+        "title",
+    }
+
+    def get(self, request: HttpRequest, identifier):
+        data = self.fetch_and_serialize("identifier", identifier)
+        return JsonResponse(data)
+
+    def model_to_json(self, entry: Intervention):
+        entry_json = {
+            "identifier": entry.identifier,
+            "title": entry.title,
+            "responsible": self.responsible_to_json(entry.responsible),
+            "legal": self.legal_to_json(entry.legal),
+            "compensations": list(entry.compensations.all().values_list("pk", flat=True)),
+            "payments": self.payments_to_json(entry.payments.all()),
+            "deductions": self.deductions_to_json(entry.deductions.all()),
+        }
+        geom = entry.geometry.geom.geojson
+        geo_json = json.loads(geom)
+        geo_json["properties"] = entry_json
+        return geo_json

api/views/views.py

@@ -0,0 +1,55 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: michel.peltriaux@sgdnord.rlp.de
+Created on: 21.01.22
+
+"""
+from abc import abstractmethod
+
+from django.views import View
+
+
+class AbstractModelAPIView(View):
+    """ Base class for API views
+
+    The API must follow the GeoJSON Specification RFC 7946
+    https://geojson.org/
+    https://datatracker.ietf.org/doc/html/rfc7946
+
+    """
+    model = None
+
+    class Meta:
+        abstract = True
+
+    @abstractmethod
+    def model_to_json(self, entry):
+        """ Defines the returned json values of the model
+
+        Args:
+            entry (): The found entry from the database
+
+        Returns:
+
+        """
+        raise NotImplementedError("Must be implemented in subclasses")
+
+    def fetch_and_serialize(self, lookup_field, lookup_val):
+        """ Serializes the model entry according to the given lookup data
+
+        Args:
+            lookup_field (): Which field used for lookup
+            lookup_val (): Value for lookup
+
+        Returns:
+            serialized_data (dict)
+        """
+        _filters = {
+            lookup_field: lookup_val
+        }
+        qs = self.model.objects.filter(**_filters)
+        serialized_data = {}
+        for entry in qs:
+            serialized_data[str(entry.pk)] = self.model_to_json(entry)
+        return serialized_data

konova/sub_settings/django_settings.py

@@ -70,6 +70,7 @@ INSTALLED_APPS = [
     'ema',
     'codelist',
     'analysis',
+    'api',
 ]
 if DEBUG:
     INSTALLED_APPS += [

konova/urls.py

@@ -38,6 +38,7 @@ urlpatterns = [
     path('news/', include("news.urls")),
     path('cl/', include("codelist.urls")),
     path('analysis/', include("analysis.urls")),
+    path('api/', include("api.urls")),
 
     # Generic deadline routes
     path('deadline/<id>/remove', remove_deadline_view, name="deadline-remove"),

konova/utils/generators.py

@@ -13,6 +13,19 @@ import qrcode.image.svg
 from io import BytesIO
 
 
+def generate_token() -> str:
+    """ Shortcut for default generating of e.g. API token
+
+    Returns:
+        token (str)
+    """
+    return generate_random_string(
+        length=64,
+        use_numbers=True,
+        use_letters_lc=True
+    )
+
+
 def generate_random_string(length: int, use_numbers: bool = False, use_letters_lc: bool = False, use_letters_uc: bool = False) -> str:
     """
     Generates a random string of variable length

user/models/user.py

@@ -15,6 +15,13 @@ from user.enums import UserNotificationEnum
 
 class User(AbstractUser):
     notifications = models.ManyToManyField("user.UserNotification", related_name="+", blank=True)
+    api_token = models.OneToOneField(
+        "api.APIUserToken",
+        blank=True,
+        null=True,
+        help_text="The user's API token",
+        on_delete=models.SET_NULL
+    )
 
     def is_notification_setting_set(self, notification_enum: UserNotificationEnum):
         return self.notifications.filter(