Merge pull request #30 from jtdub/core-refactor

rename home app to core app

Author: jtdub

.pylintrc

@@ -1,5 +1,5 @@
 [MASTER]
-ignore=migrations
+ignore=migrations,tests
 
 [MESSAGES CONTROL]
 disable=no-member,too-few-public-methods,too-many-ancestors, duplicate-code

netopsio/core/__init__.py

@@ -0,0 +1 @@
+"""Netops.io core app."""

netopsio/core/admin.py

@@ -0,0 +1,14 @@
+"""Register core models in admin panel."""
+
+from django.contrib import admin
+
+from core.models import RequestLog
+
+
+class RequestLogAdmin(admin.ModelAdmin):
+    """Request Log Admin Site Fields."""
+
+    list_display = ("ip", "app", "date")
+
+
+admin.site.register(RequestLog, RequestLogAdmin)

netopsio/core/api/__init__.py

@@ -0,0 +1 @@
+"""Core application API."""

netopsio/home/serializers.py renamed to netopsio/core/api/serializers.py

@@ -1,6 +1,8 @@
-"""Home App and Worker Serializers."""
-from rest_framework import serializers
+"""Core App and Worker Serializers."""
 from django_celery_results.models import TaskResult
+from rest_framework import serializers
+
+from core import models
 
 
 class TaskResultSerializer(serializers.HyperlinkedModelSerializer):
@@ -24,3 +26,19 @@ class Meta:
             "date_done",
             "url",
         ]
+
+
+class TaskSerializer(serializers.Serializer):  # pylint: disable=abstract-method
+    """Ping Serializer."""
+
+    task_id = serializers.CharField(max_length=512)
+
+
+class RequestLogSerializer(serializers.ModelSerializer):
+    """RequestLog Serializer."""
+
+    class Meta:
+        """RequestLog Serializer Meta."""
+
+        model = models.RequestLog
+        fields = ["id", "date", "task_id", "ip", "app", "result", "url"]

netopsio/core/api/urls.py

@@ -0,0 +1,12 @@
+"""Netops.io core api urls."""
+
+from rest_framework.routers import DefaultRouter
+
+from core.api import views
+
+router = DefaultRouter()
+router.register(r"tasks", views.TaskResultViewSet)
+router.register(r"request-logs", views.RequestLogViewSet, basename="requestlog")
+router.register(r"ping", views.PingViewSet, basename="ping")
+router.register(r"traceroute", views.TraceRouteViewSet, basename="traceroute")
+router.register(r"nmap", views.NmapViewSet, basename="nmap")

netopsio/core/api/views.py

@@ -0,0 +1,92 @@
+"""Netops.io core api views."""
+
+from django_celery_results.models import TaskResult
+from drf_yasg import openapi
+from drf_yasg.utils import swagger_auto_schema
+from rest_framework import viewsets
+from rest_framework.response import Response
+
+from core import models, tasks
+from core.api import serializers
+from netopsio.utilities import get_ip_address
+
+
+class TaskResultViewSet(viewsets.ReadOnlyModelViewSet):
+    """Rest API View for 'list' and 'retrieving' TaskResult actions."""
+
+    queryset = TaskResult.objects.all()
+    serializer_class = serializers.TaskResultSerializer
+    lookup_field = "task_id"
+
+
+class RequestLogViewSet(viewsets.ReadOnlyModelViewSet):
+    """Rest API View for 'list' and 'retrieving' RequestLog actions."""
+
+    queryset = models.RequestLog.objects.all()
+    serializer_class = serializers.RequestLogSerializer
+
+
+class PingViewSet(viewsets.ViewSet):
+    """Ping Viewset."""
+
+    @swagger_auto_schema(
+        request_body=openapi.Schema(
+            type=openapi.TYPE_OBJECT,
+            properties={
+                "host": openapi.Schema(
+                    type=openapi.TYPE_STRING, description="Host to ping."
+                ),
+            },
+        )
+    )  # pylint: disable=no-self-use
+    def create(self, request, host=None):
+        """Ping a host."""
+        host = get_ip_address(request)
+        task = tasks.ping.delay(host=host)
+        data = models.TaskModel(task_id=task.task_id)
+        serializer = serializers.TaskSerializer(data, context={"request": request})
+        return Response(serializer.data)
+
+
+class TraceRouteViewSet(viewsets.ViewSet):
+    """TraceRoute Viewset."""
+
+    @swagger_auto_schema(
+        request_body=openapi.Schema(
+            type=openapi.TYPE_OBJECT,
+            properties={
+                "host": openapi.Schema(
+                    type=openapi.TYPE_STRING, description="Host to traceroute."
+                ),
+            },
+        )
+    )  # pylint: disable=no-self-use
+    def create(self, request, host=None):
+        """Traceroute a host."""
+        host = get_ip_address(request)
+        task = tasks.traceroute.delay(host=host)
+        data = models.TaskModel(task_id=task.task_id)
+        serializer = serializers.TaskSerializer(data, context={"request": request})
+        return Response(serializer.data)
+
+
+class NmapViewSet(viewsets.ViewSet):
+    """Nmap Viewset."""
+
+    @swagger_auto_schema(
+        request_body=openapi.Schema(
+            type=openapi.TYPE_OBJECT,
+            properties={
+                "host": openapi.Schema(
+                    type=openapi.TYPE_STRING, description="Host to ping."
+                ),
+            },
+        )
+    )  # pylint: disable=no-self-use
+    def create(self, request, host=None):
+        """Nmap a host."""
+        host = get_ip_address(request)
+        task = tasks.nmap.delay(host=host)
+        data = models.TaskModel(task_id=task.task_id)
+        serializer = serializers.TaskSerializer(data, context={"request": request})
+        return Response(serializer.data)

netopsio/home/apps.py renamed to netopsio/core/apps.py

@@ -3,7 +3,7 @@
 from django.apps import AppConfig
 
 
-class HomeConfig(AppConfig):
-    "Home app config."
+class CoreConfig(AppConfig):
+    "Core app config."
     default_auto_field = "django.db.models.BigAutoField"
-    name = "home"
+    name = "core"

netopsio/traceroute/migrations/0001_initial.py renamed to netopsio/core/migrations/0001_add_request_log.py

@@ -1,4 +1,4 @@
-# Generated by Django 3.2.10 on 2022-07-11 00:25
+# Generated by Django 3.2.10 on 2022-07-18 02:40
 
 from django.db import migrations, models
 
@@ -11,7 +11,7 @@ class Migration(migrations.Migration):
 
     operations = [
         migrations.CreateModel(
-            name="TraceRouteRequest",
+            name="RequestLog",
             fields=[
                 (
                     "id",
@@ -26,6 +26,7 @@ class Migration(migrations.Migration):
                 ("task_id", models.UUIDField(null=True, unique=True)),
                 ("ip", models.CharField(max_length=255)),
                 ("result", models.TextField()),
+                ("app", models.CharField(max_length=255)),
             ],
         ),
     ]