add django-rest-framework to manage servers via api

Author: lilioid

Pipfile

@@ -10,6 +10,10 @@ psycopg2 = "*"
 django = "*"
 mercantile = "*"
 geojson = "*"
+djangorestframework = "*"
+pyyaml = "*"
+drf-yasg = "*"      # django-rest-framework yet-another-swagger-generator required for documentation generation
+dynamic-rest = "*"
 
 [requires]
 python_version = "3"

Pipfile.lock

@@ -2,18 +2,6 @@
 import mercantile
 
 
-class Mapping(models.Model):
-    z = models.IntegerField(null=False)
-    x = models.IntegerField(null=False)
-    y = models.IntegerField(null=False)
-    land = models.IntegerField(null=False) #TODO: remodel to Forigin key to a country -> server mapping
-
-    class Meta:
-        indexes = [
-            models.Index(fields=['z', 'x', 'y']),
-        ]
-
-
 class Server(models.Model):
     z = models.IntegerField(null=False)
     x = models.IntegerField(null=False)

tileservermapping/mapping/models.py

@@ -0,0 +1,10 @@
+from dynamic_rest import serializers
+
+from . import models
+
+
+class ServerSerializer(serializers.DynamicModelSerializer):
+    class Meta:
+        model = models.Server
+        fields = ["name", "x", "y", "z", "active", "scheme", "host", "url", "url_postfix"]
+

tileservermapping/mapping/serializers.py

@@ -1,8 +1,19 @@
 from django.conf.urls import url
+from django.urls import path, include
+from dynamic_rest import routers
 
 from .views import get_server, get_cur_tiles
+from . import views
 
 urlpatterns = [
     url(r'^vector/v1/512/all/(\d+)/(\d+)/(\d+)\.([a-zA-Z]+)$', get_server, name='mapping_server'),
     url(r'^cur_tiles.js$', get_cur_tiles , name='mapping_get_cur_tiles'),
 ]
+
+
+router = routers.DefaultRouter()
+router.register(r"servers", views.ServerViewSet)
+
+urlpatterns += [
+    path("", include(router.urls))
+]

tileservermapping/mapping/urls.py

@@ -1,10 +1,19 @@
 from django.http import HttpResponse
+from dynamic_rest import viewsets
 from django.shortcuts import render
 from geojson import Polygon, Feature
 import mercantile
 
-# Create your views here.
-from .models import Mapping, Server
+from .models import Server
+from . import serializers
+
+
+class ServerViewSet(viewsets.DynamicModelViewSet):
+    """
+    API endpoint that allows servers to be viewed or edited
+    """
+    queryset = Server.objects.all()
+    serializer_class = serializers.ServerSerializer
 
 
 def get_server(request, z, x, y, format):

tileservermapping/mapping/views.py

@@ -28,6 +28,9 @@
     'django.contrib.sessions',
     'django.contrib.messages',
     'django.contrib.staticfiles',
+    'rest_framework',
+    'drf_yasg',
+    'dynamic_rest',
     'tileservermapping.mapping',
 ]
 
@@ -65,6 +68,10 @@
     # override in settings.py
 }
 
+LOGIN_URL = "/admin/login/"
+LOGOUT_URL = "/admin/logout/"
+LOGOUT_REDIRECT_URL = "/"
+
 # Password validation
 # https://docs.djangoproject.com/en/2.0/ref/settings/#auth-password-validators
 
@@ -101,3 +108,17 @@
 # https://docs.djangoproject.com/en/2.0/howto/static-files/
 
 STATIC_URL = '/static/'
+
+
+# Django Rest Framework and extensions
+
+REST_FRAMEWORK = {
+    "DEFAULT_VERSION": "v1",
+    "ALLOWED_VERSIONS": ["v1"],
+    "DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.URLPathVersioning",
+    "DEFAULT_PERMISSION_CLASSES": ["rest_framework.permissions.IsAuthenticated"],
+}
+
+DYNAMIC_REST = {
+    "ENABLE_BULK_UPDATE": False
+}