Standardize Verizon plugin client boundary

external_plugins/verizon/__init__.py

@@ -16,8 +16,7 @@ from dns_sync.adapter_support import (
     require_endpoint_plugin,
 )
 from dns_sync.config import parse_endpoint_list
-from dns_sync.models import DesiredRecord
-from .provider import Plugin as VerizonProvider
+from .client import VerizonClient, VerizonRecord
 
 
 def configured_endpoints(config):
@@ -53,12 +52,11 @@ class Plugin:
     def __init__(self, config, endpoint):
         require_endpoint_plugin(endpoint, self.name)
 
-        self.config = config
         self.endpoint = endpoint
-        self.provider = VerizonProvider(config, endpoint)
+        self.client = VerizonClient(endpoint)
 
     def connect(self) -> None:
-        self.provider.connect()
+        self.client.connect()
 
     def discover(
         self,
@@ -72,7 +70,7 @@ class Plugin:
 
         discovered: list[DiscoveredObject] = []
         records = sorted(
-            self.provider.list_records().values(),
+            self.client.list_records().values(),
             key=lambda record: record.hostname.lower(),
         )
 
@@ -101,7 +99,7 @@ class Plugin:
     def _desired_record(
         self,
         object: NormalizedObject,
-    ) -> DesiredRecord:
+    ) -> VerizonRecord:
         if object.object_type != DNS_RECORDS:
             raise RuntimeError(
                 f"{self.endpoint.identity} cannot handle "
@@ -129,11 +127,10 @@ class Plugin:
                 "Verizon DNS does not support wildcard records"
             )
 
-        return DesiredRecord(
+        return VerizonRecord(
             hostname=hostname,
             ip=str(payload.get("ip") or ""),
             record_type=record_type,
-            wildcard=False,
         )
 
     def apply(self, action: PlanAction) -> ApplyResult | None:
@@ -156,16 +153,16 @@ class Plugin:
         record = self._desired_record(desired)
 
         if action.operation == PlanOperation.CREATE:
-            detail = self.provider.add_record(record)
+            detail = self.client.add_record(record)
         elif action.operation == PlanOperation.UPDATE:
-            detail = self.provider.update_record(record)
+            detail = self.client.update_record(record)
         else:
             raise RuntimeError(
                 f"Verizon adapter does not support "
                 f"{action.operation.value} actions"
             )
 
-        records = self.provider.list_records()
+        records = self.client.list_records()
         applied_record = records.get(record.hostname.lower())
         if applied_record is None:
             applied_record = records.get(record.hostname)
@@ -197,6 +194,6 @@ class Plugin:
         )
 
     def verify(self, object: NormalizedObject) -> bool:
-        return self.provider.verify_record(
+        return self.client.verify_record(
             self._desired_record(object)
         )

external_plugins/verizon/client.py

@@ -1,13 +1,14 @@
 import hashlib
+from dataclasses import dataclass, field
 import os
 import re
 import time
+from typing import Any
 
 import requests
 import urllib3
 
 from dns_sync.adapters import Endpoint
-from dns_sync.models import ProviderCapabilities, ProviderRecord
 from dns_sync.normalizer import normalize_hostname, normalize_ipv4
 
 LUCI_USERNAME = (
@@ -17,6 +18,15 @@ LUCI_USERNAME = (
 CFG_RE = re.compile(r'addCfg\("dns_(ip|name)(\d+)",\s*"([^"]*)",\s*"([^"]*)"\);')
 
 
+
+@dataclass(frozen=True)
+class VerizonRecord:
+    hostname: str
+    ip: str
+    record_type: str = "A"
+    metadata: dict[str, Any] = field(default_factory=dict)
+
+
 class _Slot:
     def __init__(self, slot):
         self.slot = slot
@@ -26,36 +36,19 @@ class _Slot:
         self.ip_token = ""
 
 
-class Plugin:
-    name = "verizon"
-    capabilities = ProviderCapabilities(
-        record_types=frozenset({"A"}),
-        wildcard_records=False,
-        supports_create=True,
-        supports_update=True,
-        supports_delete=True,
-        max_records=64,
-    )
-
+class VerizonClient:
     def __init__(
         self,
-        config,
-        endpoint: Endpoint | None = None,
+        endpoint: Endpoint,
     ):
-        self.config = config
         self.endpoint = endpoint
 
-        if endpoint is None:
-            self.router_url = os.getenv(
-                "ROUTER_URL",
-                "https://192.168.1.1",
-            ).rstrip("/")
-        else:
-            if endpoint.plugin != "verizon":
-                raise RuntimeError(
-                    "Verizon provider requires a verizon endpoint"
-                )
-            self.router_url = f"https://{endpoint.address}"
+        if endpoint.plugin != "verizon":
+            raise RuntimeError(
+                "VerizonClient requires a verizon endpoint"
+            )
+
+        self.router_url = f"https://{endpoint.address}"
 
         self.password = os.getenv("ROUTER_PASSWORD")
         if not self.password:
@@ -161,7 +154,7 @@ class Plugin:
                 # The firmware UI has no wildcard support, but normalize defensively.
                 pass
             ip = normalize_ipv4(slot.ip, hostname)
-            result[hostname.lower()] = ProviderRecord(
+            result[hostname.lower()] = VerizonRecord(
                 hostname=hostname,
                 ip=ip,
                 record_type="A",
@@ -176,7 +169,7 @@ class Plugin:
 
     def _write_slot(self, slot, hostname, ip):
         if not self.auth_token:
-            raise RuntimeError("Verizon provider is not authenticated")
+            raise RuntimeError("Verizon client is not authenticated")
         if not slot.ip_token or not slot.name_token:
             raise RuntimeError(f"Slot {slot.slot} is missing dynamic field tokens")