dnsimple 12.0.0 → 12.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf5d85da45a3b9f1f9cfdf8eebb6e138f7701b105d3b5e1168374712bf0c962a
-  data.tar.gz: 243d214bf5ecc19649eeac0ee2035591702108e0b49588921466ddba787623d6
+  metadata.gz: aba3fa999d47316cbc09c4084e223279a1fea0b0694f47fae6ad439aea1eba61
+  data.tar.gz: 9ecf0f9812b057a8f091ff7dbeedc0978b4adc167f470e33883c9562699d1625
 SHA512:
-  metadata.gz: 529d35b92ffd260c29bd62c0dfe5302112b82620cf77f3b59b69c8bae4d7705a47dee1b09d86af8431f420c56fb916860bee1c6b2718b6441e61d08635823f98
-  data.tar.gz: 5a0536f22fb8fe8e0833fad81476c2e92433e349b4c8722c9cc57270644bab5931bea8cf67172f971f886e0b6db35c15e719af4bef20cc61c393423c10bb5dd9
+  metadata.gz: 3e30070f4e8fbbea5ccba3118edaf80282ca77edfe96010d10f94a299dbd33f18866c8119abcb1a8ea057b2a65a04ac979de4bc652d5aba0c060e6d06c9cfd4f
+  data.tar.gz: 710dd46a4f23519e218c7e9e83c06043e605dcf7fdb5b203088b366e2b23db47697003d3d8ad4b2cae9ab501626c1923bb46eba84e781753c467925181a13517

data/.github/workflows/ci.yml

@@ -15,7 +15,6 @@ concurrency:
 
 jobs:
   markdown-lint:
-    name: Lint markdown
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
@@ -27,10 +26,10 @@ jobs:
           config_file: ".markdownlint.yaml"
 
   test:
+    name: Ruby ${{ matrix.ruby-version }}
+    runs-on: ubuntu-latest
     needs:
       - markdown-lint
-    runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby-version }}
     strategy:
       matrix:
         ruby-version:

data/.github/workflows/release.yml

@@ -1,54 +1,27 @@
 name: Release
 
 on:
-  workflow_run:
-    workflows:
-      - "CI"
-    types:
-      - completed
+  push:
+    tags:
+      - v*.*.*
+
 jobs:
-  validate-tag:
-    name: Check tag
+  wait-for-ci:
+    name: Wait for CI
     runs-on: ubuntu-latest
-    outputs:
-      valid_tag: ${{ steps.validation.outputs.valid_tag }}
-    if: ${{ github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'push' && startsWith(github.event.workflow_run.head_branch, 'v') }}
     steps:
-      - name: Check out the repository including tags
-        uses: actions/checkout@v6
+      - name: Wait for CI to pass
+        uses: lewagon/wait-on-check-action@v1.5.0
         with:
-          ref: ${{ github.event.workflow_run.head_sha }}
-          fetch-depth: 0
-          fetch-tags: true
-      - name: Validate tag
-        id: validation
-        run: |
-          # Validation is necessary in the unlikely case that a branch matching the tag naming pattern is pushed
-          # and the CI workflow in that branch is modified to run upon a push to that branch
-          REF='${{ github.event.workflow_run.head_branch }}' # This can be a branch or tag name
-          if [[ "$REF" != v*.*.* ]]; then
-            echo "valid_tag=false" >> "$GITHUB_OUTPUT"; exit 0
-          fi
-          # Validate that the tag exists
-          if ! git rev-parse -q --verify "refs/tags/$REF" >/dev/null; then
-            echo "There is no tag matching $REF - $REF is a branch"
-            echo "valid_tag=false" >> "$GITHUB_OUTPUT"; exit 0
-          fi
-          # Validate that the tag is for the same commit that was pushed
-          TAG_SHA="$(git rev-parse "$REF^{commit}")"
-          COMMIT_SHA="${{ github.event.workflow_run.head_sha }}"
-          if [ "$TAG_SHA" != "$COMMIT_SHA" ]; then
-            echo "Tag SHA $TAG_SHA does not match pushed commit SHA $COMMIT_SHA"
-            echo "valid_tag=false" >> "$GITHUB_OUTPUT"; exit 0
-          fi
-          echo "Tag $REF exists and is valid. Tag $TAG_SHA matches the pushed commit $COMMIT_SHA."
-          echo "valid_tag=true"  >> "$GITHUB_OUTPUT"
+          ref: ${{ github.sha }}
+          running-workflow-name: Wait for CI
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          wait-interval: 10
+
   publish:
     name: Release to RubyGems
-    needs: validate-tag
+    needs: wait-for-ci
     runs-on: ubuntu-latest
-    if: ${{ needs.validate-tag.outputs.valid_tag == 'true' && github.event.workflow_run.conclusion == 'success' }}
-
     steps:
       - uses: actions/checkout@v6
 

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

@@ -15,7 +15,7 @@ jobs:
           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/
+          rsync -a --delete "$TMP_DIR/dnsimple-developer-main/fixtures/v2/api/" test/fixtures.http/
       - name: Create a PR to sync fixtures if there are changes
         run: |
           cat <<'MD' > pr_body.md
@@ -36,7 +36,7 @@ jobs:
           git checkout -b "$BRANCH"
 
           # Stage changes
-          git add spec/fixtures.http
+          git add test/fixtures.http
 
           # Commit if there are staged changes
           if ! git diff --cached --quiet; then

data/.rubocop.yml

@@ -6,7 +6,7 @@ inherit_from:
 plugins:
   - rubocop-performance
   - rubocop-rake
-  - rubocop-rspec
+  - rubocop-minitest
 
 AllCops:
   TargetRubyVersion: 3.2

data/.rubocop_todo.yml

@@ -1,49 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-12-27 17:14:14 UTC using RuboCop version 1.82.1.
+# on 2026-01-14 23:11:38 UTC using RuboCop version 1.82.1.
 # 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: 90
-# Configuration parameters: CountAsOne.
-RSpec/ExampleLength:
-  Max: 17
-
-# Offense count: 1
-RSpec/LeakyConstantDeclaration:
-  Exclude:
-    - 'spec/dnsimple/client/client_service_spec.rb'
-
-# Offense count: 12
-# Configuration parameters: .
-# SupportedStyles: have_received, receive
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-
-# Offense count: 134
-RSpec/MultipleExpectations:
+# Offense count: 79
+Minitest/MultipleAssertions:
   Max: 15
-
-# Offense count: 422
-# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
-# SupportedStyles: always, named_only
-RSpec/NamedSubject:
-  Enabled: false
-
-# Offense count: 16
-RSpec/SubjectStub:
-  Exclude:
-    - 'spec/dnsimple/client/certificates_spec.rb'
-    - 'spec/dnsimple/client/contacts_spec.rb'
-    - 'spec/dnsimple/client/domains_delegation_signer_records_spec.rb'
-    - 'spec/dnsimple/client/domains_email_forwards_spec.rb'
-    - 'spec/dnsimple/client/domains_spec.rb'
-    - 'spec/dnsimple/client/services_spec.rb'
-    - 'spec/dnsimple/client/templates_records_spec.rb'
-    - 'spec/dnsimple/client/templates_spec.rb'
-    - 'spec/dnsimple/client/tlds_spec.rb'
-    - 'spec/dnsimple/client/zones_records_spec.rb'
-    - 'spec/dnsimple/client/zones_spec.rb'
-    - 'spec/dnsimple/client_spec.rb'

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 This project uses [Semantic Versioning 2.0.0](http://semver.org/), the format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## 12.1.1 - 2026-03-11
+
+### Changed
+
+- Migrated the test suite from RSpec to Minitest. This is an internal change with no public API impact. (#448)
+
+## 12.1.0 - 2025-02-26
+
+### Added
+
+- Added `Dnsimple::Client::DomainsResearch#domain_research_status` to research a domain for availability and registration status. (#450)
+
 ## 12.0.0 - 2026-01-22
 
 ### Removed

data/Gemfile

@@ -9,6 +9,6 @@ gem "bigdecimal", "~> 4.0"
 gem "coveralls", "~> 0.8", require: false
 gem "csv", "~> 3.2"
 gem "rubocop", "~> 1.75", require: false
+gem "rubocop-minitest", "~> 0.36", require: false
 gem "rubocop-performance", "~> 1.25", require: false
 gem "rubocop-rake", "~> 0.7", require: false
-gem "rubocop-rspec", "~> 3.6", require: false

data/README.md

@@ -76,6 +76,21 @@ response = client.domains.domain(account_id, "example.com")
 puts response.data
 ```
 
+### Research a domain
+
+> **Note:** This endpoint is part of a Private Beta. During the beta period, changes to the endpoint may occur at any time. If interested in using this endpoint, reach out to [DNSimple support](support@dnsimple.com).
+
+Research a domain name for availability and registration status information:
+
+```ruby
+response = client.domains.domain_research_status(account_id, "example.com")
+research = response.data
+puts research.domain          # => "example.com"
+puts research.availability    # => "unavailable"
+puts research.request_id      # => "f453dabc-a27e-4bf1-a93e-f263577ffaae"
+puts research.errors          # => []
+```
+
 ## Configuration
 
 ### Sandbox Environment

data/Rakefile

@@ -1,12 +1,14 @@
 require 'bundler/gem_tasks'
 
 # By default, run tests and linter.
-task default: [:spec, :rubocop]
+task default: [:test, :rubocop]
 
 
-require 'rspec/core/rake_task'
+require 'rake/testtask'
 
-RSpec::Core::RakeTask.new do |t|
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = !ENV["VERBOSE"].nil?
 end
 

data/dnsimple.gemspec

@@ -21,7 +21,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'httparty'
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-mock'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'webmock'
 end

data/lib/dnsimple/client/clients.rb

@@ -143,6 +143,7 @@ module Dnsimple
 
 
     require_relative "domains"
+    require_relative "domains_research"
     require_relative "domains_delegation_signer_records"
     require_relative "domains_dnssec"
     require_relative "domains_email_forwards"
@@ -150,6 +151,7 @@ module Dnsimple
 
     class DomainsService < ClientService
       include Client::Domains
+      include Client::DomainsResearch
       include Client::DomainsDelegationSignerRecords
       include Client::DomainsDnssec
       include Client::DomainsEmailForwards

data/lib/dnsimple/client/domains_research.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  class Client
+    module DomainsResearch
+      # Research a domain name for availability and registration status information.
+      #
+      # This endpoint provides information about a domain's availability status.
+      #
+      # @example Research the domain example.com:
+      #   client.domains.domain_research_status(1010, "example.com")
+      #
+      # @param  account_id [Integer] the account ID
+      # @param  domain_name [#to_s] the domain name to research
+      # @param  options [Hash]
+      # @return [Dnsimple::Response<Dnsimple::Struct::DomainResearchStatus>]
+      #
+      # @raise  [Dnsimple::RequestError] When the request fails.
+      def domain_research_status(account_id, domain_name, options = {})
+        endpoint = Client.versioned("/%s/domains/research/status" % [account_id])
+        options = options.merge(query: { domain: domain_name })
+        response = client.get(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::DomainResearchStatus.new(response["data"]))
+      end
+    end
+  end
+end

data/lib/dnsimple/struct/domain_research_status.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  module Struct
+    class DomainResearchStatus < Base
+      # @return [String] UUID identifier for this research request.
+      attr_accessor :request_id
+
+      # @return [String] The domain name that was researched.
+      attr_accessor :domain
+
+      # @return [String] The availability status. See https://developer.dnsimple.com/v2/domains/research/#getDomainsResearchStatus
+      attr_accessor :availability
+
+      # @return [Array<String>] Array of error messages if the domain cannot be researched.
+      attr_accessor :errors
+    end
+  end
+end

data/lib/dnsimple/struct.rb

@@ -29,6 +29,7 @@ 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_research_status"
 require_relative "struct/domain_restore"
 require_relative "struct/domain_transfer"
 require_relative "struct/domain_renewal"

data/lib/dnsimple/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dnsimple
-  VERSION = "12.0.0"
+  VERSION = "12.1.1"
 end

data/test/dnsimple/client/accounts_test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class AccountsTest < Minitest::Test
+  def setup
+    @subject = Dnsimple::Client.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").accounts
+  end
+
+  test "builds the correct request" do
+    stub_request(:get, %r{/v2/accounts$})
+        .to_return(read_http_fixture("listAccounts/success-user.http"))
+
+    @subject.accounts
+
+    assert_requested(:get, "https://api.dnsimple.test/v2/accounts",
+                     headers: { "Accept" => "application/json" })
+  end
+
+  test "returns the accounts" do
+    stub_request(:get, %r{/v2/accounts$})
+        .to_return(read_http_fixture("listAccounts/success-user.http"))
+
+    response = @subject.accounts
+
+    assert_kind_of(Dnsimple::Response, response)
+
+    result = response.data
+
+    assert_kind_of(Dnsimple::Struct::Account, result.first)
+    assert_kind_of(Dnsimple::Struct::Account, result.last)
+  end
+end

data/test/dnsimple/client/billing_test.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+require "bigdecimal/util"
+
+class BillingTest < Minitest::Test
+  def setup
+    @subject = Dnsimple::Client.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").billing
+    @account_id = 1010
+  end
+
+  test "builds the correct request" do
+    stub_request(:get, %r{/v2/#{@account_id}/billing/charges})
+        .to_return(read_http_fixture("listCharges/success.http"))
+
+    @subject.charges(@account_id)
+
+    assert_requested(:get, "https://api.dnsimple.test/v2/#{@account_id}/billing/charges",
+                     headers: { "Accept" => "application/json" })
+  end
+
+  test "exposes the pagination information" do
+    stub_request(:get, %r{/v2/#{@account_id}/billing/charges})
+        .to_return(read_http_fixture("listCharges/success.http"))
+
+    response = @subject.charges(@account_id)
+
+    assert_respond_to(response, :page)
+    assert_equal(1, response.page)
+    assert_kind_of(Integer, response.per_page)
+    assert_kind_of(Integer, response.total_entries)
+    assert_kind_of(Integer, response.total_pages)
+  end
+
+  test "returns the charges" do
+    stub_request(:get, %r{/v2/#{@account_id}/billing/charges})
+        .to_return(read_http_fixture("listCharges/success.http"))
+
+    response = @subject.charges(@account_id)
+
+    assert_kind_of(Dnsimple::PaginatedResponse, response)
+    assert_kind_of(Array, response.data)
+    assert_equal(3, response.data.size)
+
+    response.data.each do |result|
+      assert_kind_of(Dnsimple::Struct::Charge, result)
+      assert_kind_of(BigDecimal, result.balance_amount)
+      assert_kind_of(String, result.reference)
+      assert_kind_of(Array, result.items)
+      assert_kind_of(Dnsimple::Struct::Charge::ChargeItem, result.items[0])
+    end
+
+    assert_kind_of(BigDecimal, response.data[0].total_amount)
+    assert_equal("14.5", response.data[0].total_amount.to_s("F"))
+    assert_kind_of(BigDecimal, response.data[0].items[0].amount)
+    assert_equal("14.5", response.data[0].items[0].amount.to_s("F"))
+  end
+
+  test "supports filters" do
+    stub_request(:get, %r{/v2/#{@account_id}/billing/charges})
+        .to_return(read_http_fixture("listCharges/success.http"))
+
+    @subject.charges(@account_id, filter: { start_date: "2023-01-01", end_date: "2023-08-31" })
+
+    assert_requested(:get, "https://api.dnsimple.test/v2/#{@account_id}/billing/charges?start_date=2023-01-01&end_date=2023-08-31")
+  end
+
+  test "supports pagination" do
+    stub_request(:get, %r{/v2/#{@account_id}/billing/charges})
+        .to_return(read_http_fixture("listCharges/success.http"))
+
+    @subject.charges(@account_id, page: 2)
+
+    assert_requested(:get, "https://api.dnsimple.test/v2/#{@account_id}/billing/charges?page=2")
+  end
+
+  test "supports sorting" do
+    stub_request(:get, %r{/v2/#{@account_id}/billing/charges})
+        .to_return(read_http_fixture("listCharges/success.http"))
+
+    @subject.charges(@account_id, sort: "invoiced:asc")
+
+    assert_requested(:get, "https://api.dnsimple.test/v2/#{@account_id}/billing/charges?sort=invoiced:asc")
+  end
+
+  test "raises error when using a bad filter" do
+    stub_request(:get, %r{/v2/#{@account_id}/billing/charges})
+        .to_return(read_http_fixture("listCharges/fail-400-bad-filter.http"))
+
+    error = assert_raises(Dnsimple::RequestError) do
+      @subject.charges(@account_id, filter: { start_date: "01-01-2023" })
+    end
+    assert_equal("Invalid date format must be ISO8601 (YYYY-MM-DD)", error.message)
+  end
+
+  test "raises error when account is not authorized" do
+    stub_request(:get, %r{/v2/#{@account_id}/billing/charges})
+        .to_return(read_http_fixture("listCharges/fail-403.http"))
+
+    error = assert_raises(Dnsimple::RequestError) do
+      @subject.charges(@account_id)
+    end
+    assert_equal("Permission Denied. Required Scope: billing:*:read", error.message)
+  end
+end