dnsmadeeasy 0.4.0 → 1.0.3

data/lib/dnsmadeeasy/zone/remote_records.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'dry/struct'
+require 'dnsmadeeasy/types'
+require 'dnsmadeeasy/zone/provider_record'
+require 'dnsmadeeasy/zone/record_set'
+
+module DnsMadeEasy
+  module Zone
+    # Provider records plus non-fatal warnings from remote conversion.
+    class RemoteRecords < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :provider_records, Types::Array.of(ProviderRecord).default([].freeze)
+      attribute :warnings, Types::Array.of(Types::StrictString).default([].freeze)
+
+      def records
+        provider_records.map(&:record)
+      end
+
+      def record_set
+        RecordSet.new(records: records)
+      end
+    end
+  end
+end

data/lib/dnsmadeeasy/zone/serializer.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'dnsmadeeasy/zone/file'
+
+module DnsMadeEasy
+  module Zone
+    # Emits deterministic, normalized zone-file text.
+    class Serializer
+      # Fixed columns: owner (30), TTL (5, blank when it matches $TTL),
+      # "IN " (3), record type (7), then the payload.
+      RECORD_FORMAT = '%-30s %5s %-3s%-7s %s'
+
+      def initialize(zone_file, omit_apex_ns: true)
+        @zone_file = zone_file
+        @omit_apex_ns = omit_apex_ns
+      end
+
+      def to_s
+        lines = [
+          "$ORIGIN #{zone_file.origin}",
+          "$TTL #{zone_file.ttl}",
+          ''
+        ]
+        lines.concat(serialized_records)
+        "#{lines.join("\n")}\n"
+      end
+
+      private
+
+      attr_reader :zone_file,
+                  :omit_apex_ns
+
+      def serialized_records
+        grouped_records.flat_map.with_index do |records, index|
+          lines = records.map { |record| serialize_record(record) }
+          index.zero? ? lines : [''] + lines
+        end
+      end
+
+      def grouped_records
+        serializable_records.chunk { |record| record_group(record) }.map(&:last)
+      end
+
+      def serializable_records
+        zone_file.records
+                 .reject { |record| omit_apex_ns && record.owner == '@' && record.type == 'NS' }
+                 .sort_by { |record| serializer_sort_key(record) }
+      end
+
+      def record_group(record)
+        case record.type
+        when 'MX'
+          :mail
+        when 'TXT', 'SPF'
+          :text
+        else
+          :address
+        end
+      end
+
+      def serializer_sort_key(record)
+        [
+          serializer_type_group(record),
+          normalized_owner(record.owner),
+          record.type,
+          record.priority || -1,
+          record.value,
+          record.ttl
+        ]
+      end
+
+      def serializer_type_group(record)
+        case record.type
+        when 'A', 'AAAA', 'CNAME', 'ANAME', 'NS', 'PTR'
+          0
+        when 'MX', 'SRV'
+          1
+        when 'TXT', 'SPF'
+          2
+        else
+          3
+        end
+      end
+
+      def normalized_owner(owner)
+        owner == '@' ? '' : owner
+      end
+
+      def serialize_record(record)
+        format(RECORD_FORMAT, record.owner, ttl_token(record), 'IN', record.type, record_payload(record))
+      end
+
+      # A single $TTL cannot represent a real zone, so records that deviate
+      # from the zone default carry an explicit right-aligned TTL.
+      def ttl_token(record)
+        record.ttl == zone_file.ttl ? '' : record.ttl.to_s
+      end
+
+      def record_payload(record)
+        case record.type
+        when 'MX'
+          "#{record.priority} #{record.value}"
+        when 'SRV'
+          "#{record.priority} #{record.weight} #{record.port} #{record.value}"
+        when 'TXT', 'SPF'
+          quote_text(record.value)
+        else
+          record.value
+        end
+      end
+
+      def quote_text(value)
+        return value if value.start_with?('"') && value.end_with?('"')
+
+        %("#{value}")
+      end
+    end
+  end
+end

data/lib/dnsmadeeasy.rb

@@ -6,25 +6,49 @@ module DnsMadeEasy
 end
 
 require 'dnsmadeeasy/version'
+require 'dnsmadeeasy/types'
 require 'dnsmadeeasy/credentials'
 require 'dnsmadeeasy/api/client'
+require 'dnsmadeeasy/cli/launcher'
+require 'dnsmadeeasy/zone/record'
+require 'dnsmadeeasy/zone/provider_record'
+require 'dnsmadeeasy/zone/record_set'
+require 'dnsmadeeasy/zone/file'
+require 'dnsmadeeasy/zone/parser'
+require 'dnsmadeeasy/zone/aname_flattener'
+require 'dnsmadeeasy/zone/apply_executor'
+require 'dnsmadeeasy/zone/apply_result'
+require 'dnsmadeeasy/zone/diff'
+require 'dnsmadeeasy/zone/plan'
+require 'dnsmadeeasy/zone/plan_action'
+require 'dnsmadeeasy/zone/plan_renderer'
+require 'dnsmadeeasy/zone/remote_adapter'
+require 'dnsmadeeasy/zone/remote_records'
+require 'dnsmadeeasy/zone/serializer'
 
 module DnsMadeEasy
-  class Error < StandardError;
+  class Error < StandardError
   end
-  class AuthenticationError < Error;
+
+  class AuthenticationError < Error
   end
-  class APIKeyAndSecretMissingError < Error;
+
+  class APIKeyAndSecretMissingError < Error
   end
-  class InvalidCredentialKeys < Error;
+
+  class InvalidCredentialKeys < Error
   end
-  class AbstractMethodError < Error;
+
+  class AbstractMethodError < Error
   end
-  class InvalidCredentialsFormatError < Error;
+
+  class InvalidCredentialsFormatError < Error
   end
-  class NoSuchAccountError < Error;
+
+  class NoSuchAccountError < Error
   end
-  class NoDomainError < Error;
+
+  class NoDomainError < Error
   end
 
   class << self
@@ -38,26 +62,22 @@ module DnsMadeEasy
     def configure_from_file(file = nil,
                             account = nil,
                             encryption_key = nil)
-
       credentials = ::DnsMadeEasy::Credentials.keys_from_file(
-        file: file || ::DnsMadeEasy::Credentials.default_credentials_path(user: ENV['USER']),
+        file: file || ::DnsMadeEasy::Credentials.default_credentials_path(user: ENV.fetch('USER', nil)),
         account: account,
         encryption_key: encryption_key
       )
-      if credentials
-        configure do |config|
-          config.api_key    = credentials.api_key
-          config.api_secret = credentials.api_secret
-        end
-      else
-        raise APIKeyAndSecretMissingError, "Unable to load valid api keys from #{file}!"
+      raise APIKeyAndSecretMissingError, "Unable to load valid api keys from #{file}!" unless credentials
+
+      configure do |config|
+        config.api_key    = credentials.api_key
+        config.api_secret = credentials.api_secret
       end
     end
 
     def credentials_from_file(file: DnsMadeEasy::Credentials.default_credentials_path,
                               account: nil,
                               encryption_key: nil)
-
       DnsMadeEasy::Credentials.keys_from_file file: file,
                                               account: account,
                                               encryption_key: encryption_key
@@ -67,37 +87,51 @@ module DnsMadeEasy
       self.default_api_key = value
     end
 
+    def api_key
+      default_api_key
+    end
+
     def api_secret=(value)
       self.default_api_secret = value
     end
 
-    def client(**options)
-      @client ||= create_client(false, **options)
+    def api_secret
+      default_api_secret
     end
 
-    def sandbox_client(**options)
-      @sandbox_client ||= create_client(true, **options)
+    def client(**)
+      @client ||= create_client(false, **)
+    end
+
+    def sandbox_client(**)
+      @sandbox_client ||= create_client(true, **)
     end
 
     def create_client(sandbox = false,
                       api_key: default_api_key,
                       api_secret: default_api_secret,
 
-                      **options)
+                      **)
       raise APIKeyAndSecretMissingError, 'Please set #api_key and #api_secret' unless api_key && api_secret
 
-      ::DnsMadeEasy::Api::Client.new(api_key, api_secret, sandbox, **options)
+      ::DnsMadeEasy::Api::Client.new(api_key, api_secret, sandbox, **)
     end
 
     # Basically delegate it all to the Client instance
     # if the method call is supported.
     #
-    def method_missing(method, *args, &block)
+    def method_missing(method, ...)
       if client.respond_to?(method)
-        client.send(method, *args, &block)
+        client.send(method, ...)
       else
-        super(method, *args, &block)
+        super
       end
     end
+
+    def respond_to_missing?(method, include_private = false)
+      client.respond_to?(method, include_private) || super
+    rescue APIKeyAndSecretMissingError
+      super
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dnsmadeeasy
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Konstantin Gredeskoul
@@ -10,10 +10,9 @@ authors:
 - James Hart
 - Phil Cohen
 - Praneeth Are
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -43,6 +42,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dns-zonefile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -72,13 +141,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: tsort
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-box
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -197,16 +294,39 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
-  This is an authoratative and fully-featured API client for the DNS Provider "DnsMadeEasy.com".
+  This gem ships "dmez" — a Terraform-style command line tool for the
+  DNS provider DnsMadeEasy.com — together with an authoritative,
+  fully-featured Ruby client for their REST API v2.0.
 
-  This library offers both a rich Ruby API that you can use to automate DNS record management, as well
-  as a rich CLI interface with the command line executable "dme" installed when you install the gem.
-  The gem additionally supports storing credentials in the ~/.dnsmadeeasy/credentials.yml
-  file, supports multiple accounts, encryption, and more.
+  The dmez CLI manages your zones as standard DNS zone files with the
+  familiar read -> plan -> apply loop: "dmez zone export" writes a
+  canonical, TTL-lossless zone file with fixed aligned columns;
+  "dmez zone plan" diffs it against the live records (conservatively:
+  deletes are skipped by default and ambiguous record groups are
+  flagged for manual review); "dmez zone apply" executes the plan in
+  merge, add-only, or delete-only mode. Zone files can also be
+  validated and formatted, ANAME records are preserved as first-class
+  citizens (with optional --strict-rfc flattening on export), and
+  every account API operation is available under "dmez account".
 
-  If you are using Chef consider using the "dnsmadeeasy" Chef Cookbook, while uses this gem behind
-  the scenes: https://supermarket.chef.io/cookbooks/dnsmadeeasy<br />
+  The Ruby API supports storing credentials in
+  ~/.dnsmadeeasy/credentials.yml, including multiple accounts and
+  sym-encrypted values.
 
   ACKNOWLEDGEMENTS:
 
@@ -216,82 +336,135 @@ description: |
   2. We also wish to thank the gem author Phil Cohen who
      kindly yielded the "dnsmadeeasy" RubyGems namespace to this gem.
 
-  3. We also thank Praneeth Are for contributing the support for secondary domains in 0.3.5.
+  3. We also thank Praneeth Are for contributing the support for
+     secondary domains in 0.3.5.
 email:
 - kigster@gmail.com
 - letuboy@gmail.com
 - hjhart@gmail.com
 executables:
 - dme
+- dmez
 extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
-- ".dme-help.png"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- CLAUDE.md
 - Gemfile
 - LICENSE.txt
-- README.adoc
+- README.md
 - Rakefile
 - bin/console
 - bin/setup
 - dnsmadeeasy.gemspec
+- docs/badges/coverage_badge.svg
+- docs/dry-cli-based-tools.webloc
+- docs/plan-zone-management.md
+- docs/plans/01-plan-ruby4-baseline.md
+- docs/plans/02-plan-dry-cli-launcher.md
+- docs/plans/03-plan-account-command.md
+- docs/plans/04-plan-zone-record-model.md
+- docs/plans/05-plan-zone-parser.md
+- docs/plans/06-plan-zone-formatter.md
+- docs/plans/07-plan-zone-export.md
+- docs/plans/08-plan-zone-diff.md
+- docs/plans/09-plan-zone-apply.md
+- docs/plans/10-plan-docs-cleanup.md
+- docs/plans/11-plan-zone-cli-arguments.md
+- docs/spec-zone-management.md
 - exe/dme
+- exe/dmez
 - lib/dme.rb
 - lib/dnsmadeeasy.rb
 - lib/dnsmadeeasy/api/client.rb
+- lib/dnsmadeeasy/cli/box_output.rb
+- lib/dnsmadeeasy/cli/commands.rb
+- lib/dnsmadeeasy/cli/commands/account.rb
+- lib/dnsmadeeasy/cli/commands/base.rb
+- lib/dnsmadeeasy/cli/commands/legacy_operation.rb
+- lib/dnsmadeeasy/cli/commands/version.rb
+- lib/dnsmadeeasy/cli/commands/zone.rb
+- lib/dnsmadeeasy/cli/input.rb
+- lib/dnsmadeeasy/cli/launcher.rb
+- lib/dnsmadeeasy/cli/message_helpers.rb
+- lib/dnsmadeeasy/cli/reported_error.rb
 - lib/dnsmadeeasy/credentials.rb
 - lib/dnsmadeeasy/credentials/api_keys.rb
 - lib/dnsmadeeasy/credentials/yaml_file.rb
 - lib/dnsmadeeasy/dme.rb
 - lib/dnsmadeeasy/runner.rb
+- lib/dnsmadeeasy/types.rb
 - lib/dnsmadeeasy/version.rb
+- lib/dnsmadeeasy/zone/aname_flattener.rb
+- lib/dnsmadeeasy/zone/apply_executor.rb
+- lib/dnsmadeeasy/zone/apply_result.rb
+- lib/dnsmadeeasy/zone/diff.rb
+- lib/dnsmadeeasy/zone/file.rb
+- lib/dnsmadeeasy/zone/parser.rb
+- lib/dnsmadeeasy/zone/plan.rb
+- lib/dnsmadeeasy/zone/plan_action.rb
+- lib/dnsmadeeasy/zone/plan_renderer.rb
+- lib/dnsmadeeasy/zone/provider_record.rb
+- lib/dnsmadeeasy/zone/record.rb
+- lib/dnsmadeeasy/zone/record_set.rb
+- lib/dnsmadeeasy/zone/remote_adapter.rb
+- lib/dnsmadeeasy/zone/remote_records.rb
+- lib/dnsmadeeasy/zone/serializer.rb
 homepage: https://github.com/kigster/dnsmadeeasy
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: |
-  Thank you for using the DnsMadeEasy ruby gem, the Ruby client
-  API for DnsMadeEasy.com's SDK v2. Please note that this gem
-  comes with a rich command line utility 'dme' which you can use
-  instead of the ruby API if you prefer. Run `dme` with no
-  arguments to see the help message.
+  Thank you for installing the DnsMadeEasy ruby gem, which ships
+  the 'dmez' CLI — manage your DNS zones as plain zone files with
+  a Terraform-style workflow:
 
-  You can also store (multi-account) credentials in a YAML file in
-  your home directory. For more information, please see README at:
+    dmez zone export yourdomain.com --output=yourdomain.com.zone
+    dmez zone plan   yourdomain.com yourdomain.com.zone
+    dmez zone apply  yourdomain.com yourdomain.com.zone
+
+  Run `dmez --help` to see all commands (the old 'dme' executable
+  is deprecated). A full Ruby API client is included as well, with
+  (multi-account) credentials support via a YAML file in your home
+  directory. For more information, please see the README at:
   https://github.com/kigster/dnsmadeeasy
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 4.0.16
 specification_version: 4
-summary: 'This is an authoratative and fully-featured API client for the DNS Provider
-  "DnsMadeEasy.com".  This library offers both a rich Ruby API that you can use to
-  automate DNS record management, as well as a rich CLI interface with the command
-  line executable "dme" installed when you install the gem. The gem additionally supports
-  storing credentials in the ~/.dnsmadeeasy/credentials.yml file, supports multiple
-  accounts, encryption, and more.  If you are using Chef consider using the "dnsmadeeasy"
-  Chef Cookbook, while uses this gem behind the scenes: https://supermarket.chef.io/cookbooks/dnsmadeeasy<br
-  />  ACKNOWLEDGEMENTS:  1. This gem is based on the original work contributed by
-  Wanelo.com to the now abandonded "dnsmadeeasy-rest-api" client.  2. We also wish
-  to thank the gem author Phil Cohen who kindly yielded the "dnsmadeeasy" RubyGems
-  namespace to this gem.  3. We also thank Praneeth Are for contributing the support
-  for secondary domains in 0.3.5.'
+summary: 'This gem ships "dmez" — a Terraform-style command line tool for the DNS
+  provider DnsMadeEasy.com — together with an authoritative, fully-featured Ruby client
+  for their REST API v2.0.  The dmez CLI manages your zones as standard DNS zone files
+  with the familiar read -> plan -> apply loop: "dmez zone export" writes a canonical,
+  TTL-lossless zone file with fixed aligned columns; "dmez zone plan" diffs it against
+  the live records (conservatively: deletes are skipped by default and ambiguous record
+  groups are flagged for manual review); "dmez zone apply" executes the plan in merge,
+  add-only, or delete-only mode. Zone files can also be validated and formatted, ANAME
+  records are preserved as first-class citizens (with optional --strict-rfc flattening
+  on export), and every account API operation is available under "dmez account".  The
+  Ruby API supports storing credentials in ~/.dnsmadeeasy/credentials.yml, including
+  multiple accounts and sym-encrypted values.  ACKNOWLEDGEMENTS:  1. This gem is based
+  on the original work contributed by Wanelo.com to the now abandonded "dnsmadeeasy-rest-api"
+  client.  2. We also wish to thank the gem author Phil Cohen who kindly yielded the
+  "dnsmadeeasy" RubyGems namespace to this gem.  3. We also thank Praneeth Are for
+  contributing the support for secondary domains in 0.3.5.'
 test_files: []