dnsmadeeasy 0.3.5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 071e02ddbb88d13234c3a135672e186062472b44f6a0b3227fd4f9b5c5097205
-  data.tar.gz: '04249c110d948a410e2235716b2e05c70fa76667a7dd338d409883f8f03dfa6d'
+  metadata.gz: d0f9aeef63a3d355105f72a76fd1a6e95253e9b775add1d12d25577ac9ef46db
+  data.tar.gz: e0db6a9ef9998115f6bf024afdb3abd29edebf38e8fa5dee4999665c6deee10d
 SHA512:
-  metadata.gz: df525957ac6b092b428fbd236e85b19ea0d5fda02b7c3a91d813e06ac22376ff7c94e5434fb4b39aa90969c03f926c73efb73b9704686f44c7b84ca10121a8e5
-  data.tar.gz: 356ea81dffbf405a73ffce3e0c8278e6b329746769c983b9397793c50773ec3ec853b430f6f31781f5e9f3a1ca424e3a173a7c54d5727ac79a9be94a081de7ea
+  metadata.gz: 250b4a573fce114618674cc3ec4312f988e55871171fb084b639ea8e2499cecd3dfda1770fdaa2d7248a814e6bf97b3cf99612bdbb4daea79880e32f5651a496
+  data.tar.gz: c8d96e17308ae83bd082be46609c06353bb3f5a4d308c6015eaa8978c0657c7715697bc6b1f4b8d3dd5004b1e7da297ae35e4b94537fc76798e383a42bf843fd

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v7
+
+    - name: Set up Ruby 4.0
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '4.0'
+        bundler-cache: true
+
+    - name: Run all specs
+      run: |
+        bundle exec rspec --format=documentation
+
+    - name: Run Rubocop
+      run: |
+        bundle exec rubocop
+

data/.gitignore

@@ -12,3 +12,5 @@
 .ruby-version
 .rspec_status
 .rake_tasks~
+/zonefile_*
+/*.zone

data/.rubocop.yml

@@ -1,2 +1,8 @@
 inherit_from: .rubocop_todo.yml
 
+AllCops:
+  NewCops: enable
+  SuggestExtensions: true
+
+plugins:
+  - rubocop-rspec

data/.rubocop_todo.yml

@@ -1,94 +1,288 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2019-12-03 14:53:41 -0800 using RuboCop version 0.77.0.
+# `rubocop --auto-gen-config --exclude-limit 999 --no-offense-counts`
+# on 2026-07-16 20:18:02 UTC using RuboCop version 1.88.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: space, no_space
-Layout/HeredocIndentation:
-  Exclude: 
-    - dnsmadeeasy.gemspec
+# Configuration parameters: EnforcedStyle, AllowedGems.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'dnsmadeeasy.gemspec'
 
-Layout/SpaceInsideParens:
+Lint/BinaryOperatorWithIdenticalOperands:
   Exclude:
-    - 'Rakefile'
-    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'lib/dnsmadeeasy/runner.rb'
 
-# Offense count: 3
-Lint/AmbiguousRegexpLiteral:
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
   Exclude:
-    - 'spec/lib/dnsmadeeasy/credentials/api_keys_spec.rb'
-    - 'spec/lib/dnsmadeeasy/runner_spec.rb'
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
 
-# Offense count: 3
-# Configuration parameters: MaximumRangeSize.
-Lint/MissingCopEnableDirective:
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
+Lint/DuplicateBranch:
   Exclude:
-    - 'dnsmadeeasy.gemspec'
     - 'lib/dnsmadeeasy/runner.rb'
 
-# Offense count: 5
-# Cop supports --auto-correct.
-Lint/RedundantCopDisableDirective:
+Lint/DuplicateMethods:
   Exclude:
-    - 'lib/dnsmadeeasy/runner.rb'
+    - 'spec/lib/dnsmadeeasy/runner_spec.rb'
 
-# Offense count: 1
-Lint/UselessAssignment:
+# Configuration parameters: MaxRangeSize.
+Lint/MissingCopEnableDirective:
   Exclude:
-    - 'lib/dnsmadeeasy/runner.rb'
+    - 'dnsmadeeasy.gemspec'
 
-# Offense count: 7
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 37
+  Max: 38
 
-# Offense count: 2
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 250
+  Max: 260
 
-# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 12
+  Max: 8
 
-# Offense count: 11
-# Configuration parameters: CountComments, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 29
+  Max: 32
 
-# Offense count: 3
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
+  MaxOptionalParameters: 5
   Max: 8
 
-# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Max: 14
+  Max: 9
 
-# Offense count: 1
-# Configuration parameters: AllowedChars.
-Style/AsciiComments:
+# Configuration parameters: ForbiddenDelimiters.
+# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+Naming/HeredocDelimiterNaming:
   Exclude:
-    - 'lib/dnsmadeeasy/credentials.rb'
+    - 'dnsmadeeasy.gemspec'
+    - 'lib/dnsmadeeasy/runner.rb'
 
-# Offense count: 4
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods, AllowBracesOnProceduralOneLiners.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# IgnoredMethods: lambda, proc, it
-Style/BlockDelimiters:
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/dnsmadeeasy/api/client.rb'
+    - 'lib/dnsmadeeasy/runner.rb'
+
+# Configuration parameters: EnforcedStyle, AllowedIdentifiers, AllowedPatterns, ForbiddenIdentifiers, ForbiddenPatterns.
+# SupportedStyles: snake_case, camelCase
+Naming/VariableName:
+  Exclude:
+    - 'lib/dnsmadeeasy/api/client.rb'
+
+# This cop supports unsafe autocorrection (--autocorrect-all).
+RSpec/BeEq:
   Exclude:
     - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: be_a, be_kind_of
+RSpec/ClassCheck:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/credentials_spec.rb'
+    - 'spec/lib/dnsmadeeasy_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+RSpec/ContextMethod:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials_spec.rb'
+
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials/api_keys_spec.rb'
     - 'spec/lib/dnsmadeeasy/credentials/yaml_file_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials_spec.rb'
+    - 'spec/lib/dnsmadeeasy_spec.rb'
 
-# Offense count: 6
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: SkipBlocks, EnforcedStyle, OnlyStaticConstants.
+# SupportedStyles: described_class, explicit
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/runner_spec.rb'
+    - 'spec/lib/dnsmadeeasy_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowConsecutiveOneLiners.
+RSpec/EmptyLineAfterExample:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials/api_keys_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+RSpec/EmptyLineAfterExampleGroup:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/credentials/api_keys_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+RSpec/EmptyLineAfterFinalLet:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/credentials/api_keys_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials/yaml_file_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials_spec.rb'
+    - 'spec/lib/dnsmadeeasy/runner_spec.rb'
+    - 'spec/lib/dnsmadeeasy_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowConsecutiveOneLiners.
+RSpec/EmptyLineAfterHook:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+RSpec/EmptyLineAfterSubject:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 23
+
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: CustomTransform, IgnoredWords, DisallowedExamples.
+# DisallowedExamples: works
+RSpec/ExampleWording:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials/api_keys_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials/yaml_file_spec.rb'
+    - 'spec/lib/dnsmadeeasy_spec.rb'
+
+RSpec/ExpectInHook:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+RSpec/HooksBeforeExamples:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: is_expected, should
+RSpec/ImplicitExpect:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'spec/lib/dnsmadeeasy/cli/commands/version_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials/api_keys_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials/yaml_file_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials_spec.rb'
+    - 'spec/lib/dnsmadeeasy/runner_spec.rb'
+    - 'spec/lib/dnsmadeeasy_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+RSpec/LeadingSubject:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'spec/lib/dnsmadeeasy/runner_spec.rb'
+
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+RSpec/LeakyLocalVariable:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+RSpec/LetBeforeExamples:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/credentials/yaml_file_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+RSpec/MatchWithSimpleRegex:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/runner_spec.rb'
+
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 9
+
+# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
+# SupportedStyles: always, named_only
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials/api_keys_spec.rb'
+
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 4
+
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: not_to, to_not
+RSpec/NotToNot:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/credentials/yaml_file_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials_spec.rb'
+    - 'spec/lib/dnsmadeeasy/runner_spec.rb'
+
+RSpec/RepeatedExampleGroupDescription:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+RSpec/ScatteredLet:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials/yaml_file_spec.rb'
+    - 'spec/lib/dnsmadeeasy_spec.rb'
+
+# This cop supports safe autocorrection (--autocorrect).
+RSpec/ScatteredSetup:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# Configuration parameters: CustomTransform, IgnoreMethods, IgnoreMetadata, InflectorPath, EnforcedInflector.
+# SupportedInflectors: default, active_support
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - '**/spec/routing/**/*'
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'spec/lib/dnsmadeeasy/cli/commands/account_spec.rb'
+    - 'spec/lib/dnsmadeeasy/cli/commands/version_spec.rb'
+    - 'spec/lib/dnsmadeeasy/cli/launcher_spec.rb'
+    - 'spec/lib/dnsmadeeasy/runner_spec.rb'
+
+RSpec/StubbedMock:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/ArrayIntersect:
+  Exclude:
+    - 'lib/dnsmadeeasy/runner.rb'
+
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -100,75 +294,46 @@ Style/Documentation:
     - 'lib/dnsmadeeasy/credentials/yaml_file.rb'
     - 'lib/dnsmadeeasy/runner.rb'
 
-# Offense count: 5
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/FileNull:
   Exclude:
-    - 'lib/dnsmadeeasy.rb'
-    - 'lib/dnsmadeeasy/api/client.rb'
     - 'lib/dnsmadeeasy/credentials/api_keys.rb'
-    - 'lib/dnsmadeeasy/runner.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/IfUnlessModifier:
+Style/FileOpen:
   Exclude:
+    - 'lib/dnsmadeeasy/credentials/api_keys.rb'
     - 'lib/dnsmadeeasy/runner.rb'
 
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'Rakefile'
-    - 'dnsmadeeasy.gemspec'
-    - 'lib/dnsmadeeasy/runner.rb'
-
-# Offense count: 8
-# Cop supports --auto-correct.
-# Configuration parameters: AllowAsExpressionSeparator.
-Style/Semicolon:
+# Configuration parameters: AllowedClasses.
+Style/OneClassPerFile:
   Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
     - 'lib/dnsmadeeasy.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: only_raise, only_fail, semantic
-Style/SignalException:
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
   Exclude:
+    - 'lib/dnsmadeeasy.rb'
     - 'lib/dnsmadeeasy/api/client.rb'
 
-# Offense count: 5
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/SelectByRegexp:
   Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'lib/dnsmadeeasy/credentials/api_keys.rb'
-    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArrayLiteral:
-  Exclude:
-    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'lib/dnsmadeeasy/api/client.rb'
+    - 'lib/dnsmadeeasy/runner.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInHashLiteral:
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
   Exclude:
+    - 'lib/dnsmadeeasy/credentials.rb'
+    - 'lib/dnsmadeeasy/runner.rb'
     - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
 
-# Offense count: 97
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
-Metrics/LineLength:
-  Max: 305
+Layout/LineLength:
+  Max: 300

data/.travis.yml

@@ -9,8 +9,9 @@ rvm:
 - 2.4.3
 - 2.5.0
 - 2.6.5
+- 2.7.1
 - jruby-9.1.15.0
-before_install: gem install bundler -v 2.0.2
+before_install: gem install bundler
 before_script:
 - gem update --system
 - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64

data/CLAUDE.md

@@ -0,0 +1,67 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Ruby gem (`dnsmadeeasy`) — a REST API client and CLI for the DnsMadeEasy DNS provider (API v2.0). Requires Ruby ~> 4.0. Version 1.0 is **not backwards compatible** with 0.x: the executable was renamed from `dme` to `dmez` (`exe/dme` is now a deprecation stub), and the headline feature is a Terraform-style `export → plan → apply` workflow over standard DNS zone files.
+
+## Commands
+
+```bash
+bin/setup                    # install dependencies (bundle install)
+bundle exec rspec            # run all tests (order is random; WebMock blocks real HTTP)
+bundle exec rspec spec/lib/dns_made_easy/zone/diff_spec.rb        # single spec file
+bundle exec rspec spec/lib/dns_made_easy/zone/diff_spec.rb:42     # single example by line
+bundle exec rubocop          # lint (inherits .rubocop_todo.yml; rubocop-rspec plugin)
+bundle exec rake spec        # rake alias for the test suite
+bundle exec rake build       # build gem (also runs the `permissions` task first)
+bundle exec rake install     # install gem locally
+bundle exec rake doc         # YARD docs
+bin/console                  # IRB with the gem loaded
+```
+
+CI (`.github/workflows/ruby.yml`) runs `rspec` and `rubocop` on Ruby 4.0 — both must pass.
+
+Running the tests writes a coverage badge to `docs/badges/coverage_badge.svg` via SimpleCov (see `spec/spec_helper.rb`).
+
+## Architecture
+
+The gem is built on the dry-rb stack: `dry-cli` (CLI), `dry-struct`/`dry-types` (value objects), `dry-monads` (`Success`/`Failure` results). Shared types live in `lib/dnsmadeeasy/types.rb` (`Types::RecordType`, `Types::Ttl`, `DNS_RECORD_TYPES`, etc.).
+
+### Three ways callers reach the API
+
+1. `DnsMadeEasy::Api::Client` — the actual REST client (`lib/dnsmadeeasy/api/client.rb`): HMAC-SHA1-signed requests against production or sandbox base URLs (constants in `lib/dnsmadeeasy.rb`), returning `Hashie::Mash` objects. All domain/record/secondary-domain/ip-set operations live here.
+1. `DnsMadeEasy` module — holds default credentials and a memoized client; `method_missing` forwards any client method (`DnsMadeEasy.domains`, etc.).
+1. `DME` — an optional shorthand module (`lib/dnsmadeeasy/dme.rb`, `lib/dme.rb`) that forwards to `DnsMadeEasy`. Only loaded via `require 'dme'` or `require 'dnsmadeeasy/dme'`, never by default.
+
+Error classes are defined in `lib/dnsmadeeasy.rb` (all inherit `DnsMadeEasy::Error`).
+
+### Credentials (`lib/dnsmadeeasy/credentials*.rb`)
+
+Resolution supports: explicit key/secret, `DNSMADEEASY_API_KEY`/`DNSMADEEASY_API_SECRET` env vars, `~/.dnsmadeeasy/credentials.yml` (single or multi-account YAML with a `default_account` flag), INI format, and values encrypted with the `sym` gem (`encryption_key` may be a file path, keychain name, or env var name). Fixtures for all formats are in `spec/fixtures/`.
+
+### CLI (`exe/dmez` → `lib/dnsmadeeasy/cli/`)
+
+`CLI::Launcher` wraps a `Dry::CLI` registry (`cli/commands.rb`) and takes injected stdin/stdout/stderr/kernel so specs can run it in-process. Commands:
+
+- `dmez account <operation>` — legacy pass-through to client methods, delegating to `DnsMadeEasy::Runner` (`lib/dnsmadeeasy/runner.rb`), which formats output as json/yaml/pp.
+- `dmez zone export|validate|fmt|plan|apply` — the zone-file workflow (`cli/commands/zone.rb`).
+
+### Zone subsystem (`lib/dnsmadeeasy/zone/`) — the plan/apply pipeline
+
+Provider-neutral value objects (`Record`, `RecordSet`, `File`, `ProviderRecord`) are dry-structs. Pipeline stages all return `Dry::Monads` `Success`/`Failure` (Failure carries an array of message strings):
+
+1. `Parser` — zone-file text → `Zone::File`, using the `dns-zonefile` gem. Injects a synthetic SOA when the file lacks one (SOA is otherwise ignored — supported types are in `Parser::SUPPORTED_RECORD_CLASSES`).
+1. `Serializer` — `Zone::File` → canonical formatted zone text (used by `export` and `fmt`).
+1. `RemoteAdapter` — DME API record hashes → `RemoteRecords` (`ProviderRecord`s + warnings). HTTPRED records are omitted with a warning; unknown types are a hard `Failure`.
+1. `Diff` — desired vs. remote record sets → `Plan` with `creates` / `updates` / `skipped_deletes` / `ambiguous` `PlanAction`s. Deliberately conservative: deletes are skipped by default, and identity collisions (multiple records sharing owner/type) become `ambiguous` rather than guessed at.
+1. `PlanRenderer` — human-readable plan output for the CLI.
+1. `ApplyExecutor` — executes plan actions against the client in modes `:merge` (default), `:add_only`, `:delete_only`, with a thread pool and injectable tty-spinner factory; returns an `ApplyResult`.
+
+## Testing conventions
+
+- RSpec with `rspec-its`; heavy use of `subject`, `let`, and one-line `its(:attr) { is_expected.to ... }` expectations.
+- WebMock is on for everything — API client specs stub HTTP; no real network calls.
+- CLI specs use Aruba in **in-process** mode (`Aruba.configure` in `spec_helper.rb` sets `main_class = DnsMadeEasy::CLI::Launcher`) — `*_aruba_spec.rb` files exercise full command runs without spawning processes.
+- Spec paths are split between two trees for historical reasons: newer zone/CLI specs under `spec/lib/dns_made_easy/`, older specs under `spec/lib/dnsmadeeasy/`. Follow the tree that already contains the spec for the code you touch.

data/Gemfile

@@ -1,6 +1,14 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in dnsmadeeasy.gemspec
 gemspec
+
+gem 'aruba'
+gem 'coverage-badge'
+gem 'rspec'
+gem 'rspec-its'
+gem 'rubocop'
+gem 'rubocop-rspec'
+gem 'simplecov'