netbox-plugin-dns 0.22.9__tar.gz → 1.0b1__tar.gz

{netbox_plugin_dns-0.22.9 → netbox_plugin_dns-1.0b1}/PKG-INFO

@@ -1,18 +1,16 @@
 Metadata-Version: 2.1
 Name: netbox-plugin-dns
-Version: 0.22.9
+Version: 1.0b1
 Summary: NetBox DNS is a NetBox plugin for managing DNS data.
 Home-page: https://github.com/peteeckel/netbox-plugin-dns
 License: MIT
 Keywords: netbox,netbox-plugin,dns
 Author: Peter Eckel
 Author-email: pete@netbox-dns.org
-Requires-Python: >=3.8,<4.0
-Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -49,8 +47,8 @@ NetBox DNS is using the standardized NetBox plugin interface, so it also takes a
 
 ## Requirements
 
-* NetBox 3.5.0 or higher
-* Python 3.8 or higher
+* NetBox 4.0.0 or higher
+* Python 3.10 or higher
 
 ## Installation & Configuration
 

{netbox_plugin_dns-0.22.9 → netbox_plugin_dns-1.0b1}/README.md

@@ -27,8 +27,8 @@ NetBox DNS is using the standardized NetBox plugin interface, so it also takes a
 
 ## Requirements
 
-* NetBox 3.5.0 or higher
-* Python 3.8 or higher
+* NetBox 4.0.0 or higher
+* Python 3.10 or higher
 
 ## Installation & Configuration
 

{netbox_plugin_dns-0.22.9 → netbox_plugin_dns-1.0b1}/netbox_dns/__init__.py

@@ -1,24 +1,13 @@
-import sys
+from netbox.plugins import PluginConfig
 
-from extras.plugins import PluginConfig
-from django.db.utils import OperationalError
-
-try:
-    # NetBox 3.5.0 - 3.5.7, 3.5.9+
-    from extras.plugins import get_plugin_config
-except ImportError:
-    # NetBox 3.5.8
-    from extras.plugins.utils import get_plugin_config
-
-__version__ = "0.22.9"
+__version__ = "1.0-beta1"
 
 
 class DNSConfig(PluginConfig):
     name = "netbox_dns"
     verbose_name = "NetBox DNS"
     description = "NetBox plugin for DNS data"
-    min_version = "3.5.0"
-    max_version = "3.99.0"
+    min_version = "4.0-beta1"
     version = __version__
     author = "Peter Eckel"
     author_email = "pete@netbox-dns.org"

{netbox_plugin_dns-0.22.9 → netbox_plugin_dns-1.0b1}/netbox_dns/api/nested_serializers.py

@@ -2,25 +2,10 @@ from rest_framework import serializers
 
 from netbox.api.serializers import WritableNestedSerializer
 
-from netbox_dns.models import View, Zone, NameServer, Record, Registrar, Contact
+from netbox_dns.models import Zone, Record
+from netbox_dns.api.serializers_.view import ViewSerializer
 
 
-#
-# Views
-#
-class NestedViewSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:view-detail"
-    )
-
-    class Meta:
-        model = View
-        fields = ["id", "url", "display", "name"]
-
-
-#
-# Zones
-#
 class NestedZoneSerializer(WritableNestedSerializer):
     def to_representation(self, instance):
         # +
@@ -39,7 +24,8 @@ class NestedZoneSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:zone-detail"
     )
-    view = NestedViewSerializer(
+    view = ViewSerializer(
+        nested=True,
         many=False,
         required=False,
         read_only=True,
@@ -65,22 +51,6 @@ class NestedZoneSerializer(WritableNestedSerializer):
         ]
 
 
-#
-# Nameservers
-#
-class NestedNameServerSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:nameserver-detail"
-    )
-
-    class Meta:
-        model = NameServer
-        fields = ["id", "url", "display", "name"]
-
-
-#
-# Records
-#
 class NestedRecordSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:record-detail"
@@ -110,29 +80,3 @@ class NestedRecordSerializer(WritableNestedSerializer):
             "zone",
             "active",
         ]
-
-
-#
-# Registrars
-#
-class NestedRegistrarSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:registrar-detail"
-    )
-
-    class Meta:
-        model = Registrar
-        fields = ["display", "id", "url", "name", "iana_id"]
-
-
-#
-# Contacts
-#
-class NestedContactSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:contact-detail"
-    )
-
-    class Meta:
-        model = Contact
-        fields = ["display", "id", "url", "name", "contact_id"]

netbox_plugin_dns-1.0b1/netbox_dns/api/serializers.py

@@ -0,0 +1,8 @@
+from .serializers_.contact import *
+from .serializers_.nameserver import *
+from .serializers_.record import *
+from .serializers_.registrar import *
+from .serializers_.view import *
+from .serializers_.zone import *
+
+from .nested_serializers import *

netbox_plugin_dns-1.0b1/netbox_dns/api/serializers_/contact.py

@@ -0,0 +1,37 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+
+from netbox_dns.models import Contact
+
+
+class ContactSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:contact-detail"
+    )
+
+    class Meta:
+        model = Contact
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "contact_id",
+            "organization",
+            "street",
+            "city",
+            "state_province",
+            "postal_code",
+            "country",
+            "phone",
+            "phone_ext",
+            "fax",
+            "fax_ext",
+            "email",
+            "created",
+            "last_updated",
+            "custom_fields",
+        )
+        brief_fields = ("id", "url", "display", "name", "description", "contact_id")

netbox_plugin_dns-1.0b1/netbox_dns/api/serializers_/nameserver.py

@@ -0,0 +1,39 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_dns.models import NameServer
+
+from netbox_dns.api.nested_serializers import NestedZoneSerializer
+
+
+class NameServerSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:nameserver-detail"
+    )
+    zones = NestedZoneSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        default=None,
+        help_text="Zones served by the authoritative nameserver",
+    )
+    tenant = TenantSerializer(required=False, allow_null=True)
+
+    class Meta:
+        model = NameServer
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "tags",
+            "zones",
+            "created",
+            "last_updated",
+            "custom_fields",
+            "tenant",
+        )
+        brief_fields = ("id", "url", "display", "name", "description")

netbox_plugin_dns-1.0b1/netbox_dns/api/serializers_/record.py

@@ -0,0 +1,90 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from ipam.api.serializers import IPAddressSerializer
+from tenancy.api.serializers import TenantSerializer
+
+from netbox_dns.models import Record
+from netbox_dns.api.nested_serializers import (
+    NestedZoneSerializer,
+    NestedRecordSerializer,
+)
+
+
+class RecordSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:record-detail"
+    )
+    ptr_record = NestedRecordSerializer(
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text="PTR record generated from an address",
+    )
+    address_record = NestedRecordSerializer(
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text="Address record defining the PTR",
+    )
+    zone = NestedZoneSerializer(
+        many=False,
+        required=False,
+        help_text="Zone the record belongs to",
+    )
+    active = serializers.BooleanField(
+        required=False,
+        read_only=True,
+    )
+    ipam_ip_address = IPAddressSerializer(
+        nested=True,
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text="IPAddress linked to the record",
+    )
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = Record
+        fields = (
+            "id",
+            "url",
+            "zone",
+            "display",
+            "type",
+            "name",
+            "fqdn",
+            "value",
+            "status",
+            "ttl",
+            "description",
+            "tags",
+            "created",
+            "last_updated",
+            "managed",
+            "disable_ptr",
+            "ptr_record",
+            "address_record",
+            "active",
+            "custom_fields",
+            "tenant",
+            "ipam_ip_address",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "zone",
+            "display",
+            "type",
+            "name",
+            "fqdn",
+            "value",
+            "status",
+            "ttl",
+            "description",
+            "active",
+        )

netbox_plugin_dns-1.0b1/netbox_dns/api/serializers_/registrar.py

@@ -0,0 +1,31 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+
+from netbox_dns.models import Registrar
+
+
+class RegistrarSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:registrar-detail"
+    )
+
+    class Meta:
+        model = Registrar
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "iana_id",
+            "address",
+            "referral_url",
+            "whois_server",
+            "abuse_email",
+            "abuse_phone",
+            "created",
+            "last_updated",
+            "custom_fields",
+        )
+        brief_fields = ("id", "url", "display", "name", "description", "iana_id")

netbox_plugin_dns-1.0b1/netbox_dns/api/serializers_/view.py

@@ -0,0 +1,29 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_dns.models import View
+
+
+class ViewSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:view-detail"
+    )
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = View
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "tags",
+            "description",
+            "created",
+            "last_updated",
+            "custom_fields",
+            "tenant",
+        )
+        brief_fields = ("id", "url", "display", "name", "description")

netbox_plugin_dns-1.0b1/netbox_dns/api/serializers_/zone.py

@@ -0,0 +1,170 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_dns.api.serializers_.view import ViewSerializer
+from netbox_dns.api.serializers_.nameserver import NameServerSerializer
+from netbox_dns.api.serializers_.registrar import RegistrarSerializer
+from netbox_dns.api.serializers_.contact import ContactSerializer
+from netbox_dns.api.nested_serializers import NestedZoneSerializer
+
+from netbox_dns.models import Zone
+
+
+class ZoneSerializer(NetBoxModelSerializer):
+    # +
+    # This is a hack to avoid the exception raised by the UniqueTogetherValidator
+    # after NetBox commit https://github.com/netbox-community/netbox/commit/78e284c
+    #
+    # See https://github.com/netbox-community/netbox/issues/15351 for details.
+    # -
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.nested:
+            self.validators = []
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:zone-detail"
+    )
+    view = ViewSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        default=None,
+        help_text="View the zone belongs to",
+    )
+    nameservers = NameServerSerializer(
+        nested=True,
+        many=True,
+        read_only=False,
+        required=False,
+        help_text="Nameservers for the zone",
+    )
+    soa_mname = NameServerSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="Primary nameserver for the zone",
+    )
+    rfc2317_parent_zone = NestedZoneSerializer(
+        many=False,
+        read_only=True,
+        required=False,
+        help_text="RFC2317 arent zone for the zone",
+    )
+    rfc2317_child_zones = NestedZoneSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        help_text="RFC2317 child zones of the zone",
+    )
+    registrar = RegistrarSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="The registrar the domain is registered with",
+    )
+    registrant = ContactSerializer(
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="The owner of the domain",
+    )
+    admin_c = ContactSerializer(
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="The administrative contact for the domain",
+    )
+    tech_c = ContactSerializer(
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="The technical contact for the domain",
+    )
+    billing_c = ContactSerializer(
+        many=False,
+        read_only=False,
+        required=False,
+        help_text="The billing contact for the domain",
+    )
+    active = serializers.BooleanField(
+        required=False,
+        read_only=True,
+        allow_null=True,
+    )
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    def create(self, validated_data):
+        nameservers = validated_data.pop("nameservers", None)
+
+        zone = super().create(validated_data)
+
+        if nameservers is not None:
+            zone.nameservers.set(nameservers)
+
+        return zone
+
+    def update(self, instance, validated_data):
+        nameservers = validated_data.pop("nameservers", None)
+
+        zone = super().update(instance, validated_data)
+
+        if nameservers is not None:
+            zone.nameservers.set(nameservers)
+
+        return zone
+
+    class Meta:
+        model = Zone
+        fields = (
+            "id",
+            "url",
+            "name",
+            "view",
+            "display",
+            "nameservers",
+            "status",
+            "description",
+            "tags",
+            "created",
+            "last_updated",
+            "default_ttl",
+            "soa_ttl",
+            "soa_mname",
+            "soa_rname",
+            "soa_serial",
+            "soa_serial_auto",
+            "soa_refresh",
+            "soa_retry",
+            "soa_expire",
+            "soa_minimum",
+            "rfc2317_prefix",
+            "rfc2317_parent_managed",
+            "rfc2317_parent_zone",
+            "rfc2317_child_zones",
+            "registrar",
+            "registry_domain_id",
+            "registrant",
+            "tech_c",
+            "admin_c",
+            "billing_c",
+            "active",
+            "custom_fields",
+            "tenant",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "name",
+            "view",
+            "display",
+            "status",
+            "description",
+            "rfc2317_prefix",
+            "active",
+        )

{netbox_plugin_dns-0.22.9 → netbox_plugin_dns-1.0b1}/netbox_dns/api/views.py

@@ -13,13 +13,13 @@ from netbox_dns.api.serializers import (
     RegistrarSerializer,
     ContactSerializer,
 )
-from netbox_dns.filters import (
-    ViewFilter,
-    ZoneFilter,
-    NameServerFilter,
-    RecordFilter,
-    RegistrarFilter,
-    ContactFilter,
+from netbox_dns.filtersets import (
+    ViewFilterSet,
+    ZoneFilterSet,
+    NameServerFilterSet,
+    RecordFilterSet,
+    RegistrarFilterSet,
+    ContactFilterSet,
 )
 from netbox_dns.models import View, Zone, NameServer, Record, Registrar, Contact
 
@@ -32,7 +32,7 @@ class NetBoxDNSRootView(APIRootView):
 class ViewViewSet(NetBoxModelViewSet):
     queryset = View.objects.all()
     serializer_class = ViewSerializer
-    filterset_class = ViewFilter
+    filterset_class = ViewFilterSet
 
     @action(detail=True, methods=["get"])
     def views(self, request, pk=None):
@@ -51,7 +51,7 @@ class ZoneViewSet(NetBoxModelViewSet):
         "tenant",
     )
     serializer_class = ZoneSerializer
-    filterset_class = ZoneFilter
+    filterset_class = ZoneFilterSet
 
     @action(detail=True, methods=["get"])
     def records(self, request, pk=None):
@@ -71,7 +71,7 @@ class ZoneViewSet(NetBoxModelViewSet):
 class NameServerViewSet(NetBoxModelViewSet):
     queryset = NameServer.objects.prefetch_related("zones", "tenant")
     serializer_class = NameServerSerializer
-    filterset_class = NameServerFilter
+    filterset_class = NameServerFilterSet
 
     @action(detail=True, methods=["get"])
     def zones(self, request, pk=None):
@@ -83,7 +83,7 @@ class NameServerViewSet(NetBoxModelViewSet):
 class RecordViewSet(NetBoxModelViewSet):
     queryset = Record.objects.all().prefetch_related("zone", "zone__view", "tenant")
     serializer_class = RecordSerializer
-    filterset_class = RecordFilter
+    filterset_class = RecordFilterSet
 
     def destroy(self, request, *args, **kwargs):
         v_object = self.get_object()
@@ -105,10 +105,10 @@ class RecordViewSet(NetBoxModelViewSet):
 class RegistrarViewSet(NetBoxModelViewSet):
     queryset = Registrar.objects.all()
     serializer_class = RegistrarSerializer
-    filterset_class = RegistrarFilter
+    filterset_class = RegistrarFilterSet
 
 
 class ContactViewSet(NetBoxModelViewSet):
     queryset = Contact.objects.all()
     serializer_class = ContactSerializer
-    filterset_class = ContactFilter
+    filterset_class = ContactFilterSet

{netbox_plugin_dns-0.22.9 → netbox_plugin_dns-1.0b1}/netbox_dns/fields/network.py

@@ -1,6 +1,6 @@
 from django import forms
 from django.db import models
-from django.db.models import Lookup, Transform
+from django.db.models import Lookup, Transform, IntegerField
 from django.core.exceptions import ValidationError
 
 from netaddr import AddrFormatError, IPNetwork

{netbox_plugin_dns-0.22.9 → netbox_plugin_dns-1.0b1}/netbox_dns/fields/rfc2317.py

@@ -51,7 +51,7 @@ class RFC2317NetworkField(models.Field):
 
         try:
             ip_network = IPNetwork(value)
-        except (AddressFormatError, TypeError, ValueError) as exc:
+        except (AddrFormatError, TypeError, ValueError) as exc:
             raise ValidationError(exc)
 
         if ip_network.version != 4:

{netbox_plugin_dns-0.22.9/netbox_dns/filters → netbox_plugin_dns-1.0b1/netbox_dns/filtersets}/contact.py

@@ -5,12 +5,13 @@ from netbox.filtersets import NetBoxModelFilterSet
 from netbox_dns.models import Contact
 
 
-class ContactFilter(NetBoxModelFilterSet):
+class ContactFilterSet(NetBoxModelFilterSet):
     class Meta:
         model = Contact
         fields = (
             "id",
             "name",
+            "description",
             "contact_id",
             "organization",
             "street",