dnsmadeeasy 0.4.0 → 1.0.5

data/lib/dnsmadeeasy/zone/diff.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require 'dnsmadeeasy/zone/plan'
+
+module DnsMadeEasy
+  module Zone
+    # Builds a conservative execution plan from desired and remote record sets.
+    # TTL-only differences are ignored unless compare_ttl is true.
+    class Diff
+      def initialize(desired_records:, remote_records:, compare_ttl: false)
+        @provider_managed_records, @desired_records = desired_records.partition { |record| provider_managed?(record) }
+        @remote_records = remote_records
+        @compare_ttl = compare_ttl
+      end
+
+      def call
+        Plan.new(
+          creates: create_actions,
+          updates: update_actions,
+          skipped_creates: skipped_create_actions,
+          skipped_deletes: skipped_delete_actions,
+          ambiguous: []
+        )
+      end
+
+      private
+
+      attr_reader :desired_records,
+                  :provider_managed_records,
+                  :remote_records,
+                  :compare_ttl
+
+      # Apex NS records are owned by DNS Made Easy: the API neither returns
+      # nor accepts them, so they are excluded from the diff and reported.
+      def provider_managed?(record)
+        record.owner == '@' && record.type == 'NS'
+      end
+
+      def skipped_create_actions
+        provider_managed_records.map do |record|
+          PlanAction.new(action: 'skipped_create', record: record,
+                         message: 'Apex NS records are managed by the DNS provider')
+        end
+      end
+
+      def create_actions
+        group_creates = group_deltas.flat_map { |delta| delta.fetch(:creates) }
+        (missing_desired_records + group_creates).map do |record|
+          PlanAction.new(action: 'create', record: record)
+        end
+      end
+
+      def update_actions
+        group_deltas.flat_map do |delta|
+          delta.fetch(:updates).map do |desired, remote|
+            PlanAction.new(
+              action: 'update',
+              desired_record: update_payload(desired, remote),
+              remote_record: remote
+            )
+          end
+        end
+      end
+
+      # When TTLs are not compared, an update must not modify the remote TTL
+      # as a side effect, so the desired record inherits it.
+      def update_payload(desired, remote)
+        return desired if compare_ttl
+
+        desired.new(ttl: remote.ttl)
+      end
+
+      def skipped_delete_actions
+        group_deletes = group_deltas.flat_map { |delta| delta.fetch(:deletes) }
+        (remote_only_records + group_deletes).map do |record|
+          PlanAction.new(action: 'skipped_delete', record: record, message: 'Delete skipped by default')
+        end
+      end
+
+      # Individual records within an RRset carry no identity — only the set of
+      # values is meaningful in DNS. Within a changed (owner, type) group,
+      # records whose values match on both sides are unchanged; the rest are
+      # paired in sorted-value order as updates. Excess desired records become
+      # creates; excess remote records become (skipped) deletes. The end state
+      # is exact regardless of how records are paired.
+      def group_deltas
+        @group_deltas ||= changed_identity_pairs.values.map do |pair|
+          desired_changed = multiset_subtract(pair.fetch(:desired), pair.fetch(:remote)).sort_by(&:value)
+          remote_changed  = multiset_subtract(pair.fetch(:remote), pair.fetch(:desired)).sort_by(&:value)
+          paired          = [desired_changed.length, remote_changed.length].min
+
+          {
+            updates: desired_changed.first(paired).zip(remote_changed.first(paired)),
+            creates: desired_changed.drop(paired),
+            deletes: remote_changed.drop(paired)
+          }
+        end
+      end
+
+      # Records from +records+ that have no value-level counterpart in
+      # +others+, honoring duplicates (a multiset difference).
+      def multiset_subtract(records, others)
+        remaining = comparison_keys(others).tally
+        records.reject do |record|
+          key = comparison_key(record)
+          next false unless remaining[key].to_i.positive?
+
+          remaining[key] -= 1
+          true
+        end
+      end
+
+      def missing_desired_records
+        desired_records.reject { |record| remote_keys.include?(comparison_key(record)) } - changed_desired_records
+      end
+
+      def remote_only_records
+        remote_records.reject { |record| desired_keys.include?(comparison_key(record)) } - changed_remote_records
+      end
+
+      def changed_desired_records
+        changed_identity_pairs.values.flat_map { |pair| pair.fetch(:desired) }
+      end
+
+      def changed_remote_records
+        changed_identity_pairs.values.flat_map { |pair| pair.fetch(:remote) }
+      end
+
+      def changed_identity_pairs
+        @changed_identity_pairs ||= desired_by_identity.each_with_object({}) do |(identity, desired_group), pairs|
+          remote_group = remote_by_identity.fetch(identity, [])
+          next if remote_group.empty? || same_record_multiset?(desired_group, remote_group)
+
+          pairs[identity] = { desired: desired_group, remote: remote_group }
+        end
+      end
+
+      # Groups match regardless of order: the API returns records in
+      # arbitrary order while zone files are sorted.
+      def same_record_multiset?(desired_group, remote_group)
+        comparison_keys(desired_group).tally == comparison_keys(remote_group).tally
+      end
+
+      def desired_by_identity
+        @desired_by_identity ||= desired_records.group_by { |record| identity(record) }
+      end
+
+      def remote_by_identity
+        @remote_by_identity ||= remote_records.group_by { |record| identity(record) }
+      end
+
+      def identity(record)
+        [record.owner, record.type]
+      end
+
+      def desired_keys
+        @desired_keys ||= comparison_keys(desired_records)
+      end
+
+      def remote_keys
+        @remote_keys ||= comparison_keys(remote_records)
+      end
+
+      def comparison_keys(records)
+        records.map { |record| comparison_key(record) }
+      end
+
+      def comparison_key(record)
+        key = [record.owner, record.type, record.value, record.priority, record.weight, record.port]
+        compare_ttl ? key << record.ttl : key
+      end
+    end
+  end
+end

data/lib/dnsmadeeasy/zone/file.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'dry/struct'
+require 'dnsmadeeasy/types'
+require 'dnsmadeeasy/zone/record_set'
+
+module DnsMadeEasy
+  module Zone
+    # Parsed zone-file document with metadata needed for canonical output.
+    class File < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :origin, Types::NonEmptyString
+      attribute :ttl, Types::Ttl.default(300)
+      attribute :record_set, RecordSet
+
+      def records
+        record_set.records
+      end
+
+      def sorted
+        record_set.sorted
+      end
+    end
+  end
+end

data/lib/dnsmadeeasy/zone/parser.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'dns/zonefile'
+require 'dry/monads'
+require 'dnsmadeeasy/zone/file'
+require 'dnsmadeeasy/zone/record'
+require 'dnsmadeeasy/zone/record_set'
+
+module DnsMadeEasy
+  module Zone
+    # Parses standard zone-file text into provider-neutral records.
+    class Parser
+      include Dry::Monads[:result]
+
+      # ANAME is absent from the dns-zonefile grammar; ANAME lines are
+      # rewritten to CNAME before parsing and converted back afterwards.
+      SUPPORTED_RECORD_CLASSES = {
+        'DNS::Zonefile::A' => 'A',
+        'DNS::Zonefile::AAAA' => 'AAAA',
+        'DNS::Zonefile::CNAME' => 'CNAME',
+        'DNS::Zonefile::MX' => 'MX',
+        'DNS::Zonefile::NS' => 'NS',
+        'DNS::Zonefile::PTR' => 'PTR',
+        'DNS::Zonefile::SPF' => 'SPF',
+        'DNS::Zonefile::SRV' => 'SRV',
+        'DNS::Zonefile::TXT' => 'TXT'
+      }.freeze
+
+      ANAME_LINE = /^(?<owner>[^\s;]\S*)\s+(?:\d+\s+)?(?:IN\s+)?ANAME\s+(?<target>\S+)/i
+
+      def initialize(zone_text)
+        @zone_text = zone_text
+        @aname_keys = []
+      end
+
+      def call
+        zone = DNS::Zonefile.load(parseable_zone_text)
+        records, errors = build_records(zone)
+        return Failure(errors) if errors.any?
+
+        Success(File.new(origin: zone_origin(zone), ttl: zone_ttl(zone), record_set: RecordSet.new(records: records)))
+      rescue DNS::Zonefile::ParsingError, DNS::Zonefile::UnknownRecordType, Dry::Struct::Error => e
+        Failure([e.message])
+      end
+
+      private
+
+      attr_reader :zone_text,
+                  :aname_keys
+
+      def parseable_zone_text
+        zone_lines = rewrite_aname_lines(zone_text.lines)
+        insert_synthetic_soa(zone_lines) unless zone_text.match?(/\bSOA\b/)
+        zone_lines.join
+      end
+
+      def rewrite_aname_lines(zone_lines)
+        zone_lines.map do |line|
+          match = ANAME_LINE.match(line)
+          next line unless match
+
+          aname_keys << [match[:owner], match[:target]]
+          line.sub(/\bANAME\b/i, 'CNAME')
+        end
+      end
+
+      def insert_synthetic_soa(zone_lines)
+        insertion_index = zone_lines.index { |line| !line.strip.start_with?('$') && !line.strip.empty? } || zone_lines.length
+        zone_lines.insert(insertion_index, synthetic_soa_line)
+      end
+
+      def synthetic_soa_line
+        "@ IN SOA ns.#{origin_from_text} hostmaster.#{origin_from_text} ( 1 1d 1d 4W #{ttl_from_text} )\n"
+      end
+
+      def origin_from_text
+        zone_text[/^\$ORIGIN\s+(\S+)/, 1] || 'example.invalid.'
+      end
+
+      def ttl_from_text
+        zone_text[/^\$TTL\s+(\d+)/, 1] || 300
+      end
+
+      def build_records(zone)
+        origin = zone_origin(zone)
+        zone.records.each_with_object([[], []]) do |provider_record, (records, errors)|
+          next if provider_record.is_a?(DNS::Zonefile::SOA)
+
+          record_type = SUPPORTED_RECORD_CLASSES[provider_record.class.name]
+          if record_type
+            records << build_record(provider_record, record_type, origin)
+          else
+            errors << "Unsupported DNS record type: #{provider_record.class.name.split('::').last}"
+          end
+        end
+      end
+
+      def zone_origin(zone)
+        zone.soa&.origin || '.'
+      end
+
+      def zone_ttl(zone)
+        zone.soa&.ttl || 300
+      end
+
+      def build_record(provider_record, record_type, origin)
+        record_type = 'ANAME' if record_type == 'CNAME' && aname?(provider_record, origin)
+        attributes = {
+          owner: normalize_owner(provider_record.host, origin),
+          type: record_type,
+          value: record_value(provider_record, record_type, origin),
+          ttl: provider_record.ttl
+        }.merge(record_metadata(provider_record, record_type))
+
+        Record.new(attributes)
+      end
+
+      def normalize_owner(host, origin)
+        return '@' if host == origin
+
+        host.delete_suffix(".#{origin}").delete_suffix('.')
+      end
+
+      def record_value(provider_record, record_type, origin)
+        case record_type
+        when 'A', 'AAAA'
+          provider_record.address
+        when 'ANAME', 'CNAME', 'MX', 'NS', 'PTR', 'SRV'
+          normalize_target(provider_record.domainname, origin)
+        when 'SPF', 'TXT'
+          normalize_text_value(provider_record.data)
+        end
+      end
+
+      def normalize_target(target, origin)
+        return '@' if target == origin
+
+        target
+      end
+
+      def aname?(provider_record, origin)
+        owner = normalize_owner(provider_record.host, origin)
+        target = absolute_name(provider_record.domainname, origin)
+        aname_keys.any? do |key_owner, key_target|
+          normalize_owner(absolute_name(key_owner, origin), origin) == owner &&
+            absolute_name(key_target, origin) == target
+        end
+      end
+
+      def absolute_name(name, origin)
+        return origin if name == '@'
+
+        name.end_with?('.') ? name : "#{name}.#{origin}"
+      end
+
+      def normalize_text_value(value)
+        value.delete_prefix('"').delete_suffix('"')
+      end
+
+      def record_metadata(provider_record, record_type)
+        case record_type
+        when 'MX'
+          { priority: provider_record.priority }
+        when 'SRV'
+          { priority: provider_record.priority, weight: provider_record.weight, port: provider_record.port }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/dnsmadeeasy/zone/plan.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'dry/struct'
+require 'dnsmadeeasy/types'
+require 'dnsmadeeasy/zone/plan_action'
+
+module DnsMadeEasy
+  module Zone
+    # Diff result describing intended changes without applying them.
+    class Plan < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :creates, Types::Array.of(PlanAction).default([].freeze)
+      attribute :updates, Types::Array.of(PlanAction).default([].freeze)
+      attribute :skipped_creates, Types::Array.of(PlanAction).default([].freeze)
+      attribute :skipped_deletes, Types::Array.of(PlanAction).default([].freeze)
+      attribute :ambiguous, Types::Array.of(PlanAction).default([].freeze)
+
+      def actions
+        [creates, updates, skipped_creates, skipped_deletes, ambiguous].flatten.sort_by(&:sort_key)
+      end
+
+      def empty?
+        actions.empty?
+      end
+    end
+  end
+end

data/lib/dnsmadeeasy/zone/plan_action.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'dry/struct'
+require 'dnsmadeeasy/types'
+require 'dnsmadeeasy/zone/record'
+
+module DnsMadeEasy
+  module Zone
+    # A single proposed zone-management action.
+    class PlanAction < Dry::Struct
+      transform_keys(&:to_sym)
+
+      ACTION_TYPES = %w[create update skipped_create skipped_delete ambiguous].freeze
+
+      attribute :action, Types::StrictString.enum(*ACTION_TYPES)
+      attribute :record, Record.optional.default(nil)
+      attribute :remote_record, Record.optional.default(nil)
+      attribute :desired_record, Record.optional.default(nil)
+      attribute :message, Types::OptionalString.default(nil)
+
+      def sort_key
+        [
+          ACTION_TYPES.index(action),
+          (record || desired_record || remote_record)&.sort_key || []
+        ]
+      end
+    end
+  end
+end

data/lib/dnsmadeeasy/zone/plan_renderer.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module DnsMadeEasy
+  module Zone
+    # Renders zone plans for humans and automation.
+    class PlanRenderer
+      def initialize(plan)
+        @plan = plan
+      end
+
+      def to_text
+        return "No changes.\n" if plan.empty?
+
+        [
+          section('Create', plan.creates),
+          section('Update', plan.updates),
+          section('Skipped Creates', plan.skipped_creates),
+          section('Skipped Deletes', plan.skipped_deletes),
+          section('Manual Review', plan.ambiguous)
+        ].reject(&:empty?).join("\n")
+      end
+
+      def to_json(*)
+        JSON.pretty_generate(plan_hash)
+      end
+
+      private
+
+      attr_reader :plan
+
+      def section(title, actions)
+        return '' if actions.empty?
+
+        ([title] + actions.sort_by(&:sort_key).map { |action| "  - #{action_line(action)}" }).join("\n")
+      end
+
+      def action_line(action)
+        case action.action
+        when 'create'
+          record_line(action.record)
+        when 'update'
+          "#{record_line(action.remote_record)} -> #{record_line(action.desired_record)}"
+        when 'skipped_create', 'skipped_delete'
+          "#{record_line(action.record)} (#{action.message})"
+        when 'ambiguous'
+          "#{record_line(action.remote_record)} -> #{record_line(action.desired_record)} (#{action.message})"
+        end
+      end
+
+      def record_line(record)
+        [record.owner, record.type, record.priority, record.value, "(ttl=#{record.ttl})"].compact.join(' ')
+      end
+
+      def plan_hash
+        {
+          creates: plan.creates.map { |action| action_hash(action) },
+          updates: plan.updates.map { |action| action_hash(action) },
+          skipped_creates: plan.skipped_creates.map { |action| action_hash(action) },
+          skipped_deletes: plan.skipped_deletes.map { |action| action_hash(action) },
+          ambiguous: plan.ambiguous.map { |action| action_hash(action) }
+        }
+      end
+
+      def action_hash(action)
+        {
+          action: action.action,
+          record: record_hash(action.record),
+          remote_record: record_hash(action.remote_record),
+          desired_record: record_hash(action.desired_record),
+          message: action.message
+        }.compact
+      end
+
+      def record_hash(record)
+        return unless record
+
+        {
+          owner: record.owner,
+          type: record.type,
+          value: record.value,
+          ttl: record.ttl,
+          priority: record.priority,
+          weight: record.weight,
+          port: record.port
+        }.compact
+      end
+    end
+  end
+end

data/lib/dnsmadeeasy/zone/provider_record.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'dry/struct'
+require 'dnsmadeeasy/types'
+require 'dnsmadeeasy/zone/record'
+
+module DnsMadeEasy
+  module Zone
+    # Associates provider metadata with a provider-neutral DNS record.
+    class ProviderRecord < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :record, Record
+      attribute :provider_id, Types::Coercible::Integer.optional.default(nil)
+      attribute :source_id, Types::OptionalString.default(nil)
+    end
+  end
+end

data/lib/dnsmadeeasy/zone/record.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'dry/struct'
+require 'dnsmadeeasy/types'
+
+module DnsMadeEasy
+  module Zone
+    # Provider-neutral DNS record value object.
+    class Record < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :owner, Types::NonEmptyString
+      attribute :type, Types::RecordType
+      attribute :value, Types::NonEmptyString
+      attribute :ttl, Types::Ttl.default(300)
+      attribute :priority, Types::OptionalInteger.default(nil)
+      attribute :weight, Types::OptionalInteger.default(nil)
+      attribute :port, Types::OptionalInteger.default(nil)
+
+      def sort_key
+        [
+          normalized_owner,
+          type_order,
+          type,
+          priority || -1,
+          weight || -1,
+          port || -1,
+          value,
+          ttl
+        ]
+      end
+
+      private
+
+      def normalized_owner
+        owner == '@' ? '' : owner
+      end
+
+      def type_order
+        Types::DNS_RECORD_TYPES.index(type) || Types::DNS_RECORD_TYPES.length
+      end
+    end
+  end
+end

data/lib/dnsmadeeasy/zone/record_set.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'dry/struct'
+require 'dnsmadeeasy/zone/record'
+
+module DnsMadeEasy
+  module Zone
+    # Deterministically ordered collection of zone records.
+    class RecordSet < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :records, Types::Array.of(Record).default([].freeze)
+
+      def sorted
+        records.sort_by(&:sort_key)
+      end
+
+      def include?(record)
+        records.include?(record)
+      end
+    end
+  end
+end