dnsimple 11.1.0 → 12.0.0

data/CONTRIBUTING.md

@@ -2,8 +2,6 @@
 
 ## Getting started
 
-### 1. Clone the repository
-
 Clone the repository and move into it:
 
 ```shell
@@ -11,47 +9,13 @@ git clone git@github.com:dnsimple/dnsimple-ruby.git
 cd dnsimple-ruby
 ```
 
-### 2. Install the dependencies
-
 Install the dependencies using [Bundler](http://bundler.io/):
 
 ```shell
 bundle
 ```
 
-### 3. Build and test
-
-[Run the test suite](#testing) to check everything works as expected.
-
-## Releasing
-
-The following instructions uses `$VERSION` as a placeholder, where `$VERSION` is a `MAJOR.MINOR.BUGFIX` release such as `1.2.0`.
-
-1. Set the version in `version.rb`:
-
-    ```ruby
-    VERSION = "$VERSION"
-    ```
-
-1. Run the test suite and ensure all the tests pass.
-
-1. Finalize the `## main` section in `CHANGELOG.md` assigning the version.
-
-1. Commit and push the changes
-
-    ```shell
-    git commit -a -m "Release $VERSION"
-    git push origin main
-    ```
-
-1. Wait for CI to complete.
-
-1. Create a signed tag.
-
-    ```shell
-    git tag -a v$VERSION -s -m "Release $VERSION"
-    git push origin --tags
-    ```
+Run the test suite to check everything works as expected.
 
 ## Testing
 
@@ -61,8 +25,10 @@ To run the test suite:
 rake
 ```
 
-## Tests
-
-Submit unit tests for your changes. You can test your changes on your machine by [running the test suite](#testing).
+Submit unit tests for your changes. You can test your changes on your machine by running the test suite.
 
 When you submit a PR, tests will also be run on the [continuous integration environment via GitHub Actions](https://github.com/dnsimple/dnsimple-ruby/actions).
+
+## Changelog
+
+We follow the [Common Changelog](https://common-changelog.org/) format for changelog entries.

data/Gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "base64", "~> 0.3.0"
-gem "bigdecimal", "~> 3.1"
+gem "bigdecimal", "~> 4.0"
 gem "coveralls", "~> 0.8", require: false
 gem "csv", "~> 3.2"
 gem "rubocop", "~> 1.75", require: false

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2010-2025 DNSimple Corporation
+Copyright (c) 2010-2026 DNSimple Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -11,6 +11,7 @@ We provide a full API and an easy-to-use web interface so you can get your domai
 ## Requirements
 
 - Ruby: MRI > 3.2+
+- An activated DNSimple account
 
 ## Installation
 
@@ -23,31 +24,10 @@ gem install dnsimple
 Or use Bundler and define it as a dependency in your Gemfile:
 
 ```ruby
-gem 'dnsimple', '~> 10.0'
+gem 'dnsimple', '~> 11.0'
 ```
 
-## Documentation
-
-### Relevant links
-
-- [`dnsimple-ruby` RDocs](https://www.rubydoc.info/gems/dnsimple/).
-- [DNSimple API documentation](https://developer.dnsimple.com).
-- [DNSimple API examples repository](https://github.com/dnsimple/dnsimple-api-examples).
-- [DNSimple support documentation](https://support.dnsimple.com).
-
-### Sandbox Environment
-
-We highly recommend testing against our [sandbox environment](https://developer.dnsimple.com/sandbox/) before using our production environment. This will allow you to avoid real purchases, live charges on your credit card, and reduce the chance of your running up against rate limits.
-
-The client supports both the production and sandbox environment. To switch to sandbox pass the sandbox API host using the `base_url` option when you construct the client:
-
-```ruby
-client = Dnsimple::Client.new(base_url: "https://api.sandbox.dnsimple.com", access_token: "a1b2c3")
-```
-
-You will need to ensure that you are using an access token created in the sandbox environment. Production tokens will *not* work in the sandbox environment.
-
-### Examples
+## Usage
 
 Be sure to require the gem before trying any of the examples:
 
@@ -55,19 +35,7 @@ Be sure to require the gem before trying any of the examples:
 require 'dnsimple'
 ```
 
-#### Setting a custom `User-Agent` header
-
-You can customize the `User-Agent` header for the calls made to the DNSimple API:
-
-```ruby
-client = Dnsimple::Client.new(user_agent: "my-app/1.0")
-```
-
-The value you provide will be prepended to the default `User-Agent` the client uses. For example, if you use `my-app/1.0`, the final header value will be `my-app/1.0 dnsimple-ruby/0.14.0` (note that it will vary depending on the client version).
-
-We recommend to customize the user agent. If you are building a library or integration on top of the official client, customizing the client will help us to understand what is this client used for, and allow to contribute back or get in touch.
-
-#### Authentication
+### Authentication
 
 ```ruby
 client = Dnsimple::Client.new(access_token: "a1b2c3")
@@ -86,7 +54,7 @@ whoami = client.identity.whoami.data
 account_id = whoami.account.id
 ```
 
-#### Listing your domains
+### Listing your domains
 
 ```ruby
 puts client.domains.list_domains(account_id).data                      # => domains from the account 1234, first page
@@ -94,20 +62,61 @@ puts client.domains.list_domains(account_id, query: { page: 3 }).data  # => doma
 puts client.domains.all_domains(account_id).data                       # => all domains from the account 1234 (use carefully)
 ```
 
-#### Create a domain
+### Create a domain
 
 ```ruby
 response = client.domains.create_domain(account_id, name: "example.com")
 puts response.data
 ```
 
-#### Get a domain
+### Get a domain
 
 ```ruby
 response = client.domains.domain(account_id, "example.com")
 puts response.data
 ```
 
+## Configuration
+
+### Sandbox Environment
+
+We highly recommend testing against our [sandbox environment](https://developer.dnsimple.com/sandbox/) before using our production environment. This will allow you to avoid real purchases, live charges on your credit card, and reduce the chance of your running up against rate limits.
+
+The client supports both the production and sandbox environment. To switch to sandbox pass the sandbox API host using the `base_url` option when you construct the client:
+
+```ruby
+client = Dnsimple::Client.new(base_url: "https://api.sandbox.dnsimple.com", access_token: "a1b2c3")
+```
+
+You will need to ensure that you are using an access token created in the sandbox environment. Production tokens will *not* work in the sandbox environment.
+
+### Setting a custom `User-Agent` header
+
+You can customize the `User-Agent` header for the calls made to the DNSimple API:
+
+```ruby
+client = Dnsimple::Client.new(user_agent: "my-app/1.0")
+```
+
+The value you provide will be prepended to the default `User-Agent` the client uses. For example, if you use `my-app/1.0`, the final header value will be `my-app/1.0 dnsimple-ruby/0.14.0` (note that it will vary depending on the client version).
+
+We recommend to customize the user agent. If you are building a library or integration on top of the official client, customizing the client will help us to understand what is this client used for, and allow to contribute back or get in touch.
+
+## Documentation
+
+- [dnsimple-ruby RDocs](https://www.rubydoc.info/gems/dnsimple/).
+- [DNSimple API documentation](https://developer.dnsimple.com).
+- [DNSimple API examples repository](https://github.com/dnsimple/dnsimple-api-examples).
+- [DNSimple support documentation](https://support.dnsimple.com).
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit issues and pull requests. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
 ## License
 
-Copyright (c) 2010-2025 DNSimple Corporation. This is Free Software distributed under the MIT license.
+Copyright (c) 2010-2026 DNSimple Corporation. This is Free Software distributed under the [MIT License](LICENSE.txt).

data/RELEASING.md

@@ -0,0 +1,67 @@
+# Releasing
+
+This document describes the steps to release a new version of DNSimple/Ruby.
+
+## Prerequisites
+
+- You have commit access to the repository
+- You have push access to the repository
+- You have a GPG key configured for signing tags
+- You have permission to publish to RubyGems
+
+## Release process
+
+1. **Determine the new version** using [Semantic Versioning](https://semver.org/)
+
+   ```shell
+   VERSION=X.Y.Z
+   ```
+
+   - **MAJOR** version for incompatible API changes
+   - **MINOR** version for backwards-compatible functionality additions
+   - **PATCH** version for backwards-compatible bug fixes
+
+2. **Update the version file** with the new version
+
+   Edit `version.rb` and update the `VERSION` constant:
+
+   ```ruby
+   VERSION = "$VERSION"
+   ```
+
+3. **Run tests** and confirm they pass
+
+   ```shell
+   rake
+   ```
+
+4. **Update the changelog** with the new version
+
+   Finalize the `## main` section in `CHANGELOG.md` assigning the version.
+
+5. **Commit the new version**
+
+   ```shell
+   git commit -a -m "Release $VERSION"
+   ```
+
+6. **Push the changes**
+
+   ```shell
+   git push origin main
+   ```
+
+7. **Wait for CI to complete**
+
+8. **Create a signed tag**
+
+   ```shell
+   git tag -a v$VERSION -s -m "Release $VERSION"
+   git push origin --tags
+   ```
+
+## Post-release
+
+- Verify the new version appears on [RubyGems](https://rubygems.org/gems/dnsimple)
+- Verify the GitHub release was created
+- Announce the release if necessary

data/dnsimple.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.summary     = 'The DNSimple API client for Ruby'
   s.description = 'The DNSimple API client for Ruby.'
 
-  s.required_ruby_version = ">= 2.7"
+  s.required_ruby_version = ['>= 3.2', '< 5']
 
   s.require_paths    = ['lib']
   s.files            = `git ls-files`.split("\n")

data/lib/dnsimple/client/accounts.rb

@@ -3,7 +3,6 @@
 module Dnsimple
   class Client
     module Accounts
-
       # Lists the accounts the authenticated entity has access to.
       #
       # @see https://developer.dnsimple.com/v2/accounts
@@ -11,7 +10,7 @@ module Dnsimple
       # @example List the accounts:
       #   client.accounts.list
       #
-      # @param  [Hash] options
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::Account>]
       #
       # @raise  [Dnsimple::RequestError]
@@ -21,7 +20,6 @@ module Dnsimple
         Dnsimple::Response.new(response, response["data"].map { |r| Struct::Account.new(r) })
       end
       alias list_accounts accounts
-
     end
   end
 end

data/lib/dnsimple/client/billing.rb

@@ -3,7 +3,6 @@
 module Dnsimple
   class Client
     module Billing
-
       # List the billing charges for the account.
       #
       # @see https://developer.dnsimple.com/v2/billing/#listCharges
@@ -17,8 +16,8 @@ module Dnsimple
       # @example List charges, provide a sorting policy
       #   client.charges.list(1010, sort: "invoiced:asc")
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [Hash] options the filtering and sorting options
+      # @param  account_id [Integer] the account ID
+      # @param  options [Hash] the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
       # @option options [String] :sort sorting policy
@@ -31,7 +30,6 @@ module Dnsimple
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Charge.new(r) })
       end
       alias list_charges charges
-
     end
   end
 end

data/lib/dnsimple/client/certificates.rb

@@ -3,7 +3,6 @@
 module Dnsimple
   class Client
     module Certificates
-
       # List the certificates for the domain in the account.
       #
       # @see https://developer.dnsimple.com/v2/certificates/#listCertificates
@@ -284,7 +283,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Certificate.new(response["data"]))
       end
-
     end
   end
 end

data/lib/dnsimple/client/clients.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 module Dnsimple
-
   class Client
-
     # @return [Dnsimple::Client::AccountsService] The account-related API proxy.
     def accounts
       @services[:accounts] ||= Client::AccountsService.new(self)
@@ -82,7 +80,6 @@ module Dnsimple
 
     # Struct
     class ClientService
-
       # @return [Dnsimple::Client]
       attr_reader :client
 
@@ -94,8 +91,8 @@ module Dnsimple
       #
       # @api private
       #
-      # @param  [Symbol] method The client method to execute
-      # @param  [Array] args The args to call the method with
+      # @param  method [Symbol] The client method to execute
+      # @param  args [Array] The args to call the method with
       # @return [Dnsimple::CollectionResponse]
       def paginate(method, *args)
         current_page = 0
@@ -116,41 +113,32 @@ module Dnsimple
 
         CollectionResponse.new(response.http_response, collection)
       end
-
     end
 
 
     require_relative "accounts"
 
     class AccountsService < ClientService
-
       include Client::Accounts
-
     end
 
     require_relative "billing"
 
     class BillingService < ClientService
-
       include Client::Billing
-
     end
 
     require_relative "certificates"
 
     class CertificatesService < ClientService
-
       include Client::Certificates
-
     end
 
 
     require_relative "contacts"
 
     class ContactsService < ClientService
-
       include Client::Contacts
-
     end
 
 
@@ -161,39 +149,31 @@ module Dnsimple
     require_relative "domains_pushes"
 
     class DomainsService < ClientService
-
       include Client::Domains
       include Client::DomainsDelegationSignerRecords
       include Client::DomainsDnssec
       include Client::DomainsEmailForwards
       include Client::DomainsPushes
-
     end
 
     require_relative "dns_analytics"
 
     class DnsAnalyticsService < ClientService
-
       include Client::DnsAnalytics
-
     end
 
 
     require_relative "identity"
 
     class IdentityService < ClientService
-
       include Client::Identity
-
     end
 
 
     require_relative "oauth"
 
     class OauthService < ClientService
-
       include Client::Oauth
-
     end
 
     require_relative "registrar"
@@ -204,14 +184,12 @@ module Dnsimple
     require_relative "registrar_delegation"
 
     class RegistrarService < ClientService
-
       include Client::Registrar
       include Client::RegistrarAutoRenewal
       include Client::RegistrarDelegation
       include Client::RegistrarRegistrantChanges
       include Client::RegistrarTransferLock
       include Client::RegistrarWhoisPrivacy
-
     end
 
 
@@ -219,10 +197,8 @@ module Dnsimple
     require_relative "services_domains"
 
     class ServicesService < ClientService
-
       include Client::Services
       include Client::ServicesDomains
-
     end
 
 
@@ -231,29 +207,23 @@ module Dnsimple
     require_relative "templates_records"
 
     class TemplatesService < ClientService
-
       include Client::Templates
       include Client::TemplatesDomains
       include Client::TemplatesRecords
-
     end
 
 
     require_relative "tlds"
 
     class TldsService < ClientService
-
       include Client::Tlds
-
     end
 
 
     require_relative "vanity_name_servers"
 
     class VanityNameServersService < ClientService
-
       include Client::VanityNameServers
-
     end
 
 
@@ -262,22 +232,17 @@ module Dnsimple
     require_relative "zones_distributions"
 
     class ZonesService < ClientService
-
       include Client::Zones
       include Client::ZonesRecords
       include Client::ZonesDistributions
-
     end
 
 
     require_relative "webhooks"
 
     class WebhooksService < ClientService
-
       include Client::Webhooks
-
     end
-
   end
 
   # This module exposes static helpers for the API v2.
@@ -286,9 +251,6 @@ module Dnsimple
   # these static methods return directly the underlying data objects.
   # Therefore, it's not possible to access response metadata such as throttling or pagination info.
   module V2
-
     extend Client::Identity::StaticHelpers
-
   end
-
 end

data/lib/dnsimple/client/contacts.rb

@@ -3,7 +3,6 @@
 module Dnsimple
   class Client
     module Contacts
-
       # Lists the contacts in the account.
       #
       # @see https://developer.dnsimple.com/v2/contacts/#list
@@ -18,8 +17,8 @@ module Dnsimple
       # @example List contacts, provide a sorting policy
       #   client.contacts.list(1010, sort: "email:asc")
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [Hash] options the filtering and sorting options
+      # @param  account_id [Integer] the account ID
+      # @param  options [Hash] the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
       # @option options [String] :sort sorting policy
@@ -44,8 +43,8 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/contacts/#list
       # @see #contacts
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [Hash] options the filtering and sorting options
+      # @param  account_id [Integer] the account ID
+      # @param  options [Hash] the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
       # @option options [String] :sort sorting policy
@@ -60,9 +59,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/contacts/#create
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [Hash] attributes
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  attributes [Hash]
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::Contact>]
       #
       # @raise  [Dnsimple::RequestError]
@@ -77,9 +76,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/contacts/#get
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] contact_id the contact ID
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  contact_id [#to_s] the contact ID
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::Contact>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -94,10 +93,10 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/contacts/#update
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] contact_id the contact ID
-      # @param  [Hash] attributes
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  contact_id [#to_s] the contact ID
+      # @param  attributes [Hash]
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::Contact>]
       #
       # @raise  [Dnsimple::RequestError]
@@ -113,9 +112,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/contacts/#delete
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] contact_id the contact ID
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  contact_id [#to_s] the contact ID
+      # @param  options [Hash]
       # @return [Dnsimple::Response<nil>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -125,7 +124,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
-
     end
   end
 end

data/lib/dnsimple/client/dns_analytics.rb

@@ -3,13 +3,12 @@
 module Dnsimple
   class Client
     module DnsAnalytics
-
       # Queries DNS Analytics data for the provided account
       #
       # @see https://developer.dnsimple.com/v2/dns-analytics#queryDnsAnalytics
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [Hash] options the filtering, sorting, and grouping options
+      # @param  account_id [Integer] the account ID
+      # @param  options [Hash] the filtering, sorting, and grouping options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
       # @option options [String] :sort sorting policy
@@ -24,7 +23,6 @@ module Dnsimple
 
         Dnsimple::PaginatedResponseWithQuery.new(response, response["data"]["rows"].map { |row| Struct::DnsAnalytics.new(response["data"]["headers"].zip(row)) })
       end
-
     end
   end
 end