dnsimple 10.0.0 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 717f1a8443a707774595d0f3f4fc0ebeeb1383bd91424e1fdca0e46ba9fd9043
-  data.tar.gz: 0f97c2fa6be76c363bb2a1f6ac793553c051a55f6e191597c0aaf2669c4d3b32
+  metadata.gz: 4181725aaf336953ed62dc82cb74fe1d4457880f9fccf3940c817e27ffa559b5
+  data.tar.gz: 11662d9a7780adbb47599e34a6e820c2b980c0be22ec79985557f4bd1801592c
 SHA512:
-  metadata.gz: 270a8d238b4e9bca275f407c2643152892288b8328fa0e1df43750b2a180f172e38597697cc2d936ca9eb0eb284bcaa0f80d534692d6ee8ca3cbde0d3f068dda
-  data.tar.gz: 8c0bcc9b2b79848ab07c440e0bda804284918e0cfe668c2d838a388609825ff5d200569d26198aed4d6a5545403f9a026c04b5a10d2fc88987b0988bf0b24608
+  metadata.gz: c4357613ee6e5c1b8d25a89a8ce6d61fa53c3369bf59ff9e33f5fce0fc800f31e5a0f0d4709726de2fb0f0c4bc7ec092a34c238d9b8fca28bdb722ad6cd2462b
+  data.tar.gz: fa7726f50d6794b34ce537292d50b8050379751942201dad2e61ae246aed2ba5079841140b87ac6bd4494b724aeebc155cc59438f9f9693f69b8dc0c4742357f

data/.github/dependabot.yml

@@ -4,18 +4,16 @@ updates:
   - package-ecosystem: bundler
     directory: /
     schedule:
-      interval: monthly
+      interval: weekly
     open-pull-requests-limit: 10
     labels:
       - task
       - dependencies
-  - package-ecosystem: "github-actions"
-    directory: "/"
+
+  - package-ecosystem: github-actions
+    directory: /
     schedule:
-      interval: monthly
-      time: '12:00'
-    open-pull-requests-limit: 10
+      interval: weekly
     labels:
       - task
       - dependencies
-      - automerge

data/.github/workflows/ci.yml

@@ -16,9 +16,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run markdownlint-cli
-        uses: nosborn/github-action-markdown-cli@v3.4.0
+        uses: nosborn/github-action-markdown-cli@v3.5.0
         with:
           files: .
           config_file: ".markdownlint.yaml"
@@ -36,7 +36,7 @@ jobs:
           - 'ruby-head'
           - 'truffleruby-head'
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
 
     steps:
       - name: Wait for tests to succeed
-        uses: lewagon/wait-on-check-action@v1.3.4
+        uses: lewagon/wait-on-check-action@v1.4.0
         with:
           ref: 'refs/heads/main'
           running-workflow-name: 'Release to RubyGems'
@@ -19,7 +19,7 @@ jobs:
           wait-interval: 10
           allowed-conclusions: success
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Release Gem
         uses: simplyqio/publish-rubygems-action@2.0.0

data/.github/workflows/sync-test-fixtures.yml

@@ -0,0 +1,55 @@
+name: Sync test fixtures
+
+on:
+  workflow_dispatch:
+
+jobs:
+  sync_fixtures:
+    name: Sync test fixtures
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+      - name: Sync fixtures
+        run: |
+          TMP_DIR=$(mktemp -d)
+          curl -fsSL "https://codeload.github.com/dnsimple/dnsimple-developer/tar.gz/refs/heads/main" \
+            | tar -xz -C "$TMP_DIR"
+          rsync -a --delete "$TMP_DIR/dnsimple-developer-main/fixtures/v2/api/" spec/fixtures.http/
+      - name: Create a PR to sync fixtures if there are changes
+        run: |
+          cat <<'MD' > pr_body.md
+          This PR replaces the fixtures in this repository with those from https://github.com/dnsimple/dnsimple-developer/
+
+          ## Checklist
+          - [ ] Close and re-open this PR to trigger the CI workflow (it does not run automatically)
+          - [ ] Ensure the CI workflow passes before merging
+          MD
+
+          # Configure Git identity for the workflow
+          git config --global user.name "github-actions"
+          git config --global user.email "github-actions@github.com"
+
+          # Create and switch to a new branch
+          BRANCH="chore/sync-fixtures-${GITHUB_RUN_ID}"
+          NOW="$(date +'%Y-%m-%d %H:%M:%S')"
+          git checkout -b "$BRANCH"
+
+          # Stage changes
+          git add spec/fixtures.http
+
+          # Commit if there are staged changes
+          if ! git diff --cached --quiet; then
+            git commit -m "chore: sync test fixtures as of $NOW"
+            git push -u origin "$BRANCH"
+
+            gh pr create \
+              --title "chore: Sync fixtures as of $NOW" \
+              --body-file pr_body.md \
+              --base main \
+              --head "$BRANCH"
+          else
+            echo "No fixture detected; nothing to do"
+          fi
+        env:
+          GITHUB_TOKEN: ${{ github.token }}

data/.markdownlint.yaml

@@ -1,3 +1,17 @@
 ---
 default: true
-line-length: false
+
+# no-hard-tabs
+MD010:
+  code_blocks: false
+
+# no-multiple-blanks
+MD012:
+  maximum: 2
+
+# line-length
+MD013: false
+
+# no-duplicate-heading
+MD024:
+  siblings_only: true

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_from:
   - .rubocop_todo.yml
   - .rubocop_dnsimple.yml
 
-require:
+plugins:
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec

data/.rubocop_dnsimple.yml

@@ -1,8 +1,13 @@
-# Defaults https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+# This file serves as a template for RuboCop configuration. The primary template is maintained in the engineering repository.
+# Please ensure that any changes made here are also reflected in the engineering file to maintain consistency.
 #
-# References:
-#  * https://github.com/bbatsov/ruby-style-guide
-#  * https://rubocop.readthedocs.io/
+# DNSimple Ruby engineering template: https://github.com/dnsimple/dnsimple-engineering/blob/main/templates/ruby/rubocop_dnsimple.yml
+#
+# For default configurations, refer to: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+#
+# Additional References:
+#  * Ruby Style Guide: https://github.com/bbatsov/ruby-style-guide
+#  * RuboCop Documentation: https://rubocop.readthedocs.io/
 
 AllCops:
   Exclude:
@@ -10,20 +15,6 @@ AllCops:
     - '*.gemspec'
   NewCops: enable
 
-# In most cases, Gems are sorted alphabetically.
-# However, in some few cases the order is relevant due to dependencies.
-Bundler/OrderedGems:
-  Enabled: false
-
-# This cop requires odd code indentations (as of rubocop 0.57.0)
-# https://github.com/rubocop-hq/rubocop/issues/5956
-Layout/AccessModifierIndentation:
-  Enabled: false
-
-# It causes weird aligments, especially for specs.
-Layout/BlockEndNewline:
-  Enabled: false
-
 # Generally, the keyword style uses a lot of space. This is particularly true when
 # you use case/if statements, in combination with a long-name variable.
 #
@@ -110,7 +101,7 @@ Naming/MemoizedInstanceVariableName:
 Naming/PredicateName:
   Enabled: false
 
-# The team agreed decided to use exception
+# The team agreed decided to use exception.
 Naming/RescuedExceptionsVariableName:
   PreferredName: 'exception'
 
@@ -160,8 +151,10 @@ Style/FormatString:
 Style/FormatStringToken:
   Enabled: false
 
-# Prefer the latest Hash syntax
+# always - forces use of the 3.1 syntax (e.g. foo:)
+# https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/HashSyntax
 Style/HashSyntax:
+  EnforcedShorthandSyntax: always
   Exclude:
     # Rakefiles generally have definitions like
     #   :default => :test
@@ -191,7 +184,7 @@ Style/MultilineBlockChain:
 Style/NegatedIf:
   Enabled: false
 
-# Magic numbers are not welcomed
+# Magic numbers are not welcomed.
 Style/NumericLiterals:
   Exclude:
     # however tests can use numeric literals for method calls,
@@ -219,13 +212,9 @@ Style/SpecialGlobalVars:
   Enabled: false
   EnforcedStyle: use_perl_names
 
-# We generally use double quotes, sometimes single quotes.
-# Should we enforce it at code level?
 Style/StringLiterals:
-  Enabled: false
   EnforcedStyle: double_quotes
 
-# Pick one option for consistency.
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
@@ -266,11 +255,6 @@ Style/WordArray:
 Layout/CaseIndentation:
   EnforcedStyle: end
 
-# I was a big fan of leading, but trailing seems to be more commonly adopted.
-# At least at the time being.
-Layout/DotPosition:
-  EnforcedStyle: leading
-
 # Double empty lines are useful to separate conceptually different methods
 # in the same class or module.
 Layout/EmptyLines:

data/CHANGELOG.md

@@ -4,6 +4,11 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 ## main
 
+## 11.0.0
+
+- CHANGED: Removed `from` and `to` fields in `EmailForward`
+- CHANGED: Removed `DomainCollaborators`
+
 ## 10.0.0
 
 - CHANGED: Minimum Ruby version is now 3.2

data/Gemfile

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'coveralls', require: false
-gem 'rubocop', '1.75.4', require: false
-gem 'rubocop-performance', '1.25.0', require: false
-gem 'rubocop-rake', '0.7.1', require: false
-gem 'rubocop-rspec', '3.6.0', require: false
-gem "base64", "~> 0.2.0"
+gem "base64", "~> 0.3.0"
 gem "bigdecimal", "~> 3.1"
+gem "coveralls", "~> 0.8", require: false
 gem "csv", "~> 3.2"
+gem "rubocop", "~> 1.75", require: false
+gem "rubocop-performance", "~> 1.25", require: false
+gem "rubocop-rake", "~> 0.7", require: false
+gem "rubocop-rspec", "~> 3.6", require: false

data/lib/dnsimple/client/clients.rb

@@ -120,7 +120,7 @@ module Dnsimple
     end
 
 
-    require_relative 'accounts'
+    require_relative "accounts"
 
     class AccountsService < ClientService
 
@@ -128,7 +128,7 @@ module Dnsimple
 
     end
 
-    require_relative 'billing'
+    require_relative "billing"
 
     class BillingService < ClientService
 
@@ -136,7 +136,7 @@ module Dnsimple
 
     end
 
-    require_relative 'certificates'
+    require_relative "certificates"
 
     class CertificatesService < ClientService
 
@@ -145,7 +145,7 @@ module Dnsimple
     end
 
 
-    require_relative 'contacts'
+    require_relative "contacts"
 
     class ContactsService < ClientService
 
@@ -154,12 +154,11 @@ module Dnsimple
     end
 
 
-    require_relative 'domains'
-    require_relative 'domains_delegation_signer_records'
-    require_relative 'domains_dnssec'
-    require_relative 'domains_email_forwards'
-    require_relative 'domains_pushes'
-    require_relative 'domains_collaborators'
+    require_relative "domains"
+    require_relative "domains_delegation_signer_records"
+    require_relative "domains_dnssec"
+    require_relative "domains_email_forwards"
+    require_relative "domains_pushes"
 
     class DomainsService < ClientService
 
@@ -168,11 +167,10 @@ module Dnsimple
       include Client::DomainsDnssec
       include Client::DomainsEmailForwards
       include Client::DomainsPushes
-      include Client::DomainsCollaborators
 
     end
 
-    require_relative 'dns_analytics'
+    require_relative "dns_analytics"
 
     class DnsAnalyticsService < ClientService
 
@@ -181,7 +179,7 @@ module Dnsimple
     end
 
 
-    require_relative 'identity'
+    require_relative "identity"
 
     class IdentityService < ClientService
 
@@ -190,7 +188,7 @@ module Dnsimple
     end
 
 
-    require_relative 'oauth'
+    require_relative "oauth"
 
     class OauthService < ClientService
 
@@ -198,12 +196,12 @@ module Dnsimple
 
     end
 
-    require_relative 'registrar'
-    require_relative 'registrar_auto_renewal'
-    require_relative 'registrar_whois_privacy'
-    require_relative 'registrar_registrant_changes'
-    require_relative 'registrar_transfer_lock'
-    require_relative 'registrar_delegation'
+    require_relative "registrar"
+    require_relative "registrar_auto_renewal"
+    require_relative "registrar_whois_privacy"
+    require_relative "registrar_registrant_changes"
+    require_relative "registrar_transfer_lock"
+    require_relative "registrar_delegation"
 
     class RegistrarService < ClientService
 
@@ -217,8 +215,8 @@ module Dnsimple
     end
 
 
-    require_relative 'services'
-    require_relative 'services_domains'
+    require_relative "services"
+    require_relative "services_domains"
 
     class ServicesService < ClientService
 
@@ -228,9 +226,9 @@ module Dnsimple
     end
 
 
-    require_relative 'templates'
-    require_relative 'templates_domains'
-    require_relative 'templates_records'
+    require_relative "templates"
+    require_relative "templates_domains"
+    require_relative "templates_records"
 
     class TemplatesService < ClientService
 
@@ -241,7 +239,7 @@ module Dnsimple
     end
 
 
-    require_relative 'tlds'
+    require_relative "tlds"
 
     class TldsService < ClientService
 
@@ -250,7 +248,7 @@ module Dnsimple
     end
 
 
-    require_relative 'vanity_name_servers'
+    require_relative "vanity_name_servers"
 
     class VanityNameServersService < ClientService
 
@@ -259,9 +257,9 @@ module Dnsimple
     end
 
 
-    require_relative 'zones'
-    require_relative 'zones_records'
-    require_relative 'zones_distributions'
+    require_relative "zones"
+    require_relative "zones_records"
+    require_relative "zones_distributions"
 
     class ZonesService < ClientService
 
@@ -272,7 +270,7 @@ module Dnsimple
     end
 
 
-    require_relative 'webhooks'
+    require_relative "webhooks"
 
     class WebhooksService < ClientService
 

data/lib/dnsimple/client/domains_email_forwards.rb

@@ -69,7 +69,7 @@ module Dnsimple
       #
       # @raise  [Dnsimple::RequestError]
       def create_email_forward(account_id, domain_id, attributes, options = {})
-        Extra.validate_mandatory_attributes(attributes, [:from, :to])
+        Extra.validate_mandatory_attributes(attributes, [:alias_name, :destination_email])
         response = client.post(Client.versioned("/%s/domains/%s/email_forwards" % [account_id, domain_id]), attributes, options)
 
         Dnsimple::Response.new(response, Struct::EmailForward.new(response["data"]))

data/lib/dnsimple/client.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'httparty'
-require 'dnsimple/extra'
-require 'dnsimple/struct'
-require 'dnsimple/response'
-require 'dnsimple/client/clients'
+require "httparty"
+require "dnsimple/extra"
+require "dnsimple/struct"
+require "dnsimple/response"
+require "dnsimple/client/clients"
 
 module Dnsimple
   # Client for the DNSimple API

data/lib/dnsimple/default.rb

@@ -35,43 +35,43 @@ module Dnsimple
       # Default API endpoint from ENV or {BASE_URL}
       # @return [String]
       def base_url
-        ENV.fetch('DNSIMPLE_BASE_URL', BASE_URL)
+        ENV.fetch("DNSIMPLE_BASE_URL", BASE_URL)
       end
 
       # Default DNSimple username for Basic Auth from ENV
       # @return [String]
       def username
-        ENV.fetch('DNSIMPLE_USERNAME', nil)
+        ENV.fetch("DNSIMPLE_USERNAME", nil)
       end
 
       # Default DNSimple password for Basic Auth from ENV
       # @return [String]
       def password
-        ENV.fetch('DNSIMPLE_PASSWORD', nil)
+        ENV.fetch("DNSIMPLE_PASSWORD", nil)
       end
 
       # Default DNSimple access token for OAuth authentication from ENV
       # @return [String]
       def access_token
-        ENV.fetch('DNSIMPLE_ACCESS_TOKEN', nil)
+        ENV.fetch("DNSIMPLE_ACCESS_TOKEN", nil)
       end
 
       # Default DNSimple Domain API Token for Token Auth from ENV
       # @return [String]
       def domain_api_token
-        ENV.fetch('DNSIMPLE_API_DOMAIN_TOKEN', nil)
+        ENV.fetch("DNSIMPLE_API_DOMAIN_TOKEN", nil)
       end
 
       # Default User-Agent header string from ENV
       # @return [String]
       def user_agent
-        ENV.fetch('DNSIMPLE_USER_AGENT', nil)
+        ENV.fetch("DNSIMPLE_USER_AGENT", nil)
       end
 
       # Default Proxy address:port from ENV
       # @return [String]
       def proxy
-        ENV.fetch('DNSIMPLE_PROXY', nil)
+        ENV.fetch("DNSIMPLE_PROXY", nil)
       end
 
     end

data/lib/dnsimple/response.rb

@@ -32,9 +32,9 @@ module Dnsimple
       @http_response = http_response
       @data = data
 
-      @rate_limit = http_response.headers['X-RateLimit-Limit'].to_i
-      @rate_limit_remaining = http_response.headers['X-RateLimit-Remaining'].to_i
-      @rate_limit_reset = Time.at(http_response.headers['X-RateLimit-Reset'].to_i)
+      @rate_limit = http_response.headers["X-RateLimit-Limit"].to_i
+      @rate_limit_remaining = http_response.headers["X-RateLimit-Remaining"].to_i
+      @rate_limit_reset = Time.at(http_response.headers["X-RateLimit-Reset"].to_i)
     end
 
   end

data/lib/dnsimple/struct/charge.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bigdecimal'
+require "bigdecimal"
 
 module Dnsimple
   module Struct

data/lib/dnsimple/struct/email_forward.rb

@@ -10,14 +10,6 @@ module Dnsimple
       # @return [Integer] The associated domain ID.
       attr_accessor :domain_id
 
-      # @return [String] The "local part" of the originating email address. Anything to the left of the @ symbol.
-      # @deprecated use {#alias_email} instead
-      attr_accessor :from
-
-      # @return [String] The full email address to forward to.
-      # @deprecated use {#destination_email} instead
-      attr_accessor :to
-
       # @return [String] The receiving email recipient.
       attr_accessor :alias_email
 

data/lib/dnsimple/struct.rb

@@ -15,43 +15,43 @@ module Dnsimple
   end
 end
 
-require_relative 'struct/account'
-require_relative 'struct/collaborator'
-require_relative 'struct/contact'
-require_relative 'struct/certificate'
-require_relative 'struct/certificate_bundle'
-require_relative 'struct/certificate_purchase'
-require_relative 'struct/certificate_renewal'
-require_relative 'struct/charge'
-require_relative 'struct/delegation_signer_record'
-require_relative 'struct/dnssec'
-require_relative 'struct/domain'
-require_relative 'struct/domain_check'
-require_relative 'struct/domain_premium_price'
-require_relative 'struct/domain_price'
-require_relative 'struct/domain_push'
-require_relative 'struct/domain_registration'
-require_relative 'struct/domain_restore'
-require_relative 'struct/domain_transfer'
-require_relative 'struct/domain_renewal'
-require_relative 'struct/dns_analytics'
-require_relative 'struct/email_forward'
-require_relative 'struct/extended_attribute'
-require_relative 'struct/oauth_token'
-require_relative 'struct/registrant_change_check'
-require_relative 'struct/registrant_change'
-require_relative 'struct/transfer_lock'
-require_relative 'struct/zone_record'
-require_relative 'struct/service'
-require_relative 'struct/template'
-require_relative 'struct/template_record'
-require_relative 'struct/tld'
-require_relative 'struct/user'
-require_relative 'struct/vanity_name_server'
-require_relative 'struct/whois_privacy'
-require_relative 'struct/whois_privacy_renewal'
-require_relative 'struct/zone'
-require_relative 'struct/zone_file'
-require_relative 'struct/zone_distribution'
-require_relative 'struct/webhook'
-require_relative 'struct/whoami'
+require_relative "struct/account"
+require_relative "struct/collaborator"
+require_relative "struct/contact"
+require_relative "struct/certificate"
+require_relative "struct/certificate_bundle"
+require_relative "struct/certificate_purchase"
+require_relative "struct/certificate_renewal"
+require_relative "struct/charge"
+require_relative "struct/delegation_signer_record"
+require_relative "struct/dnssec"
+require_relative "struct/domain"
+require_relative "struct/domain_check"
+require_relative "struct/domain_premium_price"
+require_relative "struct/domain_price"
+require_relative "struct/domain_push"
+require_relative "struct/domain_registration"
+require_relative "struct/domain_restore"
+require_relative "struct/domain_transfer"
+require_relative "struct/domain_renewal"
+require_relative "struct/dns_analytics"
+require_relative "struct/email_forward"
+require_relative "struct/extended_attribute"
+require_relative "struct/oauth_token"
+require_relative "struct/registrant_change_check"
+require_relative "struct/registrant_change"
+require_relative "struct/transfer_lock"
+require_relative "struct/zone_record"
+require_relative "struct/service"
+require_relative "struct/template"
+require_relative "struct/template_record"
+require_relative "struct/tld"
+require_relative "struct/user"
+require_relative "struct/vanity_name_server"
+require_relative "struct/whois_privacy"
+require_relative "struct/whois_privacy_renewal"
+require_relative "struct/zone"
+require_relative "struct/zone_file"
+require_relative "struct/zone_distribution"
+require_relative "struct/webhook"
+require_relative "struct/whoami"

data/lib/dnsimple/version.rb

@@ -2,6 +2,6 @@
 
 module Dnsimple
 
-  VERSION = "10.0.0"
+  VERSION = "11.0.0"
 
 end