Merge pull request #21 from jtdub/rest-api

Rest-API Implementation

Author: jtdub

.pylintrc

@@ -1,2 +1,2 @@
 [MESSAGES CONTROL]
-disable=no-member
+disable=no-member,too-few-public-methods,too-many-ancestors

netopsio/home/serializers.py

@@ -0,0 +1,26 @@
+"""Home App and Worker Serializers."""
+from rest_framework import serializers
+from django_celery_results.models import TaskResult
+
+
+class TaskResultSerializer(serializers.HyperlinkedModelSerializer):
+    """TaskResult Serializer."""
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="taskresult-detail", lookup_field="task_id"
+    )
+
+    class Meta:
+        """Task Result Serializer Meta."""
+
+        model = TaskResult
+        fields = [
+            "task_id",
+            "task_name",
+            "task_kwargs",
+            "status",
+            "result",
+            "date_created",
+            "date_done",
+            "url",
+        ]

netopsio/home/templates/home/result_details.html renamed to netopsio/home/templates/home/task_details.html

@@ -2,7 +2,7 @@
 {% block content %}
 <div class="container">
     <div class="mb-3">
-        <label for="statusArea" class="form-label"><h3>Job Status</h3></label>
+        <label for="statusArea" class="form-label"><h3>Status</h3></label>
         <input type="input" class="form-control" id="statusArea" placeholder="{{ job.status }}">
     </div>
     <div class="mb-3">

netopsio/home/templates/home/results.html renamed to netopsio/home/templates/home/tasks.html

@@ -4,14 +4,14 @@
     <table class="table">
         <thead>
             <th scope="col">ID</th>
-            <th scope="col">Task Name</th>
-            <th scope="col">Task Status</th>
+            <th scope="col">Name</th>
+            <th scope="col">Status</th>
             <th scope="col">Keyword Arguments</th>
         </thead>
         <tbody>
         {% for task in results %}
             <tr>
-                <th scope="row"><a href="/results/{{ task.task_id }}">{{ task.task_id }}</a></th>
+                <th scope="row"><a href="/tasks/{{ task.task_id }}">{{ task.task_id }}</a></th>
                 <td>{{ task.task_name }}</td>
                 <td>{{ task.status }}</td>
                 <td>{{ task.task_kwargs }}</td>

netopsio/home/urls.py

@@ -4,7 +4,7 @@
 
 app_name = ""  # pylint: disable=invalid-name
 urlpatterns = [
-    path("", views.index, name="home_index"),
-    path("results/", views.results, name="home_results"),
-    path("results/<str:task_id>/", views.result_details, name="results_details"),
+    path("", views.index, name="home-index"),
+    path("tasks/", views.tasks, name="tasks"),
+    path("tasks/<str:task_id>/", views.task_details, name="task-details"),
 ]

netopsio/home/views.py

@@ -3,6 +3,8 @@
 from django.template import loader
 from django.shortcuts import get_object_or_404
 from django_celery_results.models import TaskResult
+from rest_framework import viewsets
+from home.serializers import TaskResultSerializer
 
 
 def index(request):
@@ -12,17 +14,25 @@ def index(request):
     return HttpResponse(template.render(context, request))
 
 
-def results(request):
+def tasks(request):
     """Render Task Results."""
     task_results = TaskResult.objects.all()
-    template = loader.get_template("home/results.html")
+    template = loader.get_template("home/tasks.html")
     context = {"title": "Task Results", "results": task_results}
     return HttpResponse(template.render(context, request))
 
 
-def result_details(request, task_id):
+def task_details(request, task_id):
     """Render Task Detail Results."""
     job = get_object_or_404(TaskResult, task_id=task_id)
-    template = loader.get_template("home/result_details.html")
-    context = {"title": "Task Result Details", "job": job}
+    template = loader.get_template("home/task_details.html")
+    context = {"title": "Task Details", "job": job}
     return HttpResponse(template.render(context, request))
+
+
+class TaskResultViewSet(viewsets.ModelViewSet):
+    """Rest API View for 'list' and 'retrieving' TaskResult actions."""
+
+    queryset = TaskResult.objects.all()
+    serializer_class = TaskResultSerializer
+    lookup_field = "task_id"

netopsio/netopsio/settings.py

@@ -38,6 +38,7 @@
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
+    "rest_framework",
     "django_celery_results",
     "home",
     "ping",
@@ -141,3 +142,9 @@
 CELERY_TASK_TIME_LIMIT = 30 * 60
 
 CELERY_RESULT_BACKEND = "django-db"
+
+# Rest Framework Settings
+REST_FRAMEWORK = {
+    "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
+    "PAGE_SIZE": 10,
+}

netopsio/netopsio/urls.py

@@ -16,8 +16,20 @@
 from django.contrib import admin
 from django.urls import include, path
 
+from rest_framework.routers import DefaultRouter
+from home.views import TaskResultViewSet
+from ping.views import PingRequestViewSet, PingViewSet
+
+
+router = DefaultRouter()
+router.register(r"tasks", TaskResultViewSet)
+router.register(r"ping-logs", PingRequestViewSet)
+router.register(r"ping", PingViewSet, basename="ping")
+
+
 urlpatterns = [
     path("", include("home.urls"), name="home"),
     path("ping/", include("ping.urls"), name="ping"),
-    path("admin/", admin.site.urls),
+    path("admin/", admin.site.urls, name="admin"),
+    path("api/v1/", include(router.urls), name="admin-v1"),
 ]

netopsio/ping/models.py

@@ -10,3 +10,11 @@ class PingRequest(models.Model):
     task_id = models.UUIDField(unique=True, null=True)
     ip = models.CharField(max_length=255)
     result = models.TextField()
+
+
+class Ping:
+    """Ping Model."""
+
+    def __init__(self, task_id: str):
+        """Initialize the model."""
+        self.task_id = task_id

netopsio/ping/serializers.py

@@ -0,0 +1,20 @@
+"""Ping App serializers."""
+
+from rest_framework import serializers
+from ping.models import PingRequest
+
+
+class PingRequestSerializer(serializers.ModelSerializer):
+    """PingRequest Serializer."""
+
+    class Meta:
+        """PingRequest Serializer Meta."""
+
+        model = PingRequest
+        fields = ["id", "date", "task_id", "ip", "result", "url"]
+
+
+class PingSerializer(serializers.Serializer):  # pylint: disable=abstract-method
+    """Ping Serializer."""
+
+    task_id = serializers.CharField(max_length=512)