dnsimple 12.0.0 → 12.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf5d85da45a3b9f1f9cfdf8eebb6e138f7701b105d3b5e1168374712bf0c962a
-  data.tar.gz: 243d214bf5ecc19649eeac0ee2035591702108e0b49588921466ddba787623d6
+  metadata.gz: 371112dc13ce900d770aa434d297b19f75892d3a90a3b2f4292ddffb88574c3f
+  data.tar.gz: c312bc89ea319f11c94bf3ed157c663264d206480033076c9b122a5d31dee2a2
 SHA512:
-  metadata.gz: 529d35b92ffd260c29bd62c0dfe5302112b82620cf77f3b59b69c8bae4d7705a47dee1b09d86af8431f420c56fb916860bee1c6b2718b6441e61d08635823f98
-  data.tar.gz: 5a0536f22fb8fe8e0833fad81476c2e92433e349b4c8722c9cc57270644bab5931bea8cf67172f971f886e0b6db35c15e719af4bef20cc61c393423c10bb5dd9
+  metadata.gz: 40334df4d23d15a5a70fde859aacfaffe0407f71fb8cde5524a03b4be98b4df710d71b8eaa7fb3c8484c38fb7845b3b54c95326c84328d44524d771700a39f39
+  data.tar.gz: 190c114666115887b7724778e72ad511a204a084f06d30494fed5cc47f8a4ca76a4465e1e8d3b44773b71b55105bdfcfca00c38aaf50a20beb714926e2fd2b5f

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 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.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/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/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.0"
 end

data/spec/dnsimple/client/domains_research_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Dnsimple::Client, ".domains" do
+
+  subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").domains }
+
+  describe "#domain_research_status" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/domains/research/status})
+          .with(query: { domain: "taken.com" })
+          .to_return(read_http_fixture("getDomainsResearchStatus/success-unavailable.http"))
+    end
+
+    it "builds the correct request" do
+      subject.domain_research_status(account_id, domain_name = "taken.com")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/research/status")
+          .with(query: { domain: domain_name })
+          .with(headers: { "Accept" => "application/json" })
+    end
+
+    it "returns the domain research status" do
+      response = subject.domain_research_status(account_id, "taken.com")
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::DomainResearchStatus)
+      expect(result.request_id).to eq("25dd77cb-2f71-48b9-b6be-1dacd2881418")
+      expect(result.domain).to eq("taken.com")
+      expect(result.availability).to eq("unavailable")
+      expect(result.errors).to eq([])
+    end
+  end
+end

data/spec/fixtures.http/createEmailForward/created.http

@@ -18,4 +18,4 @@ x-permitted-cross-domain-policies: none
 content-security-policy: frame-ancestors 'none'
 strict-transport-security: max-age=31536000
 
-{"data":{"id":41872,"domain_id":235146,"alias_email":"example@dnsimple.xyz","destination_email":"example@example.com","created_at":"2021-01-25T13:54:40Z","updated_at":"2021-01-25T13:54:40Z","from":"example@dnsimple.xyz","to":"example@example.com","active":true}}
+{"data":{"id":41872,"domain_id":235146,"alias_email":"example@dnsimple.xyz","destination_email":"example@example.com","created_at":"2021-01-25T13:54:40Z","updated_at":"2021-01-25T13:54:40Z","active":true}}

data/spec/fixtures.http/enableDnssec/success.http

@@ -17,4 +17,4 @@ x-permitted-cross-domain-policies: none
 x-xss-protection: 1; mode=block
 strict-transport-security: max-age=31536000
 
-{"data":{"enabled":true,"created_at":"2017-03-03T13:49:58Z","updated_at":"2017-03-03T13:49:58Z"}}
+{"data":{"enabled":true,"active":true,"created_at":"2017-03-03T13:49:58Z","updated_at":"2017-03-03T13:49:58Z"}}

data/spec/fixtures.http/getDnssec/success.http

@@ -17,4 +17,4 @@ x-permitted-cross-domain-policies: none
 x-xss-protection: 1; mode=block
 strict-transport-security: max-age=31536000
 
-{"data":{"enabled":true,"created_at":"2017-02-03T17:43:22Z","updated_at":"2017-02-03T17:43:22Z"}}
+{"data":{"enabled":true,"active":true,"created_at":"2017-02-03T17:43:22Z","updated_at":"2017-02-03T17:43:22Z"}}

data/spec/fixtures.http/getDomainsResearchStatus/error-validation.http

@@ -0,0 +1,15 @@
+HTTP/1.1 400 Bad Request
+server: nginx
+date: Mon, 16 Feb 2026 11:30:46 GMT
+content-type: application/json; charset=utf-8
+content-length: 176
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2394
+x-ratelimit-reset: 1771244870
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+cache-control: no-cache
+x-request-id: 5e818c7b-2bd3-478b-9b0d-23dcfedb276d
+x-runtime: 0.030532
+strict-transport-security: max-age=63072000
+
+{"data":{"request_id":"5e818c7b-2bd3-478b-9b0d-23dcfedb276d","domain":"not..a..domain..name","availability":"unknown","errors":["'not..a..domain..name': Invalid domain name"]}}

data/spec/fixtures.http/getDomainsResearchStatus/success-available.http

@@ -0,0 +1,16 @@
+HTTP/1.1 200 OK
+server: nginx
+date: Mon, 16 Feb 2026 11:44:31 GMT
+content-type: application/json; charset=utf-8
+content-length: 126
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2393
+x-ratelimit-reset: 1771244869
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+etag: W/"95174d25b104c446b9516f4a3a6fc4f4"
+cache-control: max-age=0, private, must-revalidate
+x-request-id: 275ba39a-88a5-4ca5-892a-7e991af4b31c
+x-runtime: 0.042963
+strict-transport-security: max-age=63072000
+
+{"data":{"request_id":"275ba39a-88a5-4ca5-892a-7e991af4b31c","domain":"available.com","availability":"available","errors":[]}}

data/spec/fixtures.http/getDomainsResearchStatus/success-unavailable.http

@@ -0,0 +1,16 @@
+HTTP/1.1 200 OK
+server: nginx
+date: Mon, 16 Feb 2026 11:29:45 GMT
+content-type: application/json; charset=utf-8
+content-length: 124
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2396
+x-ratelimit-reset: 1771244869
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+etag: W/"b51102adca57ea1f194855dffa8d4d25"
+cache-control: max-age=0, private, must-revalidate
+x-request-id: 25dd77cb-2f71-48b9-b6be-1dacd2881418
+x-runtime: 0.025187
+strict-transport-security: max-age=63072000
+
+{"data":{"request_id":"25dd77cb-2f71-48b9-b6be-1dacd2881418","domain":"taken.com","availability":"unavailable","errors":[]}}

data/spec/fixtures.http/getDomainsResearchStatus/success-unsupported-tld.http

@@ -0,0 +1,16 @@
+HTTP/1.1 200 OK
+server: nginx
+date: Mon, 16 Feb 2026 11:29:59 GMT
+content-type: application/json; charset=utf-8
+content-length: 158
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2395
+x-ratelimit-reset: 1771244870
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+etag: W/"9e0846a6b79a3ce70c53bcd660d5524f"
+cache-control: max-age=0, private, must-revalidate
+x-request-id: 7f417577-eafb-41ff-ac21-51f7a5ca0170
+x-runtime: 0.031308
+strict-transport-security: max-age=63072000
+
+{"data":{"request_id":"7f417577-eafb-41ff-ac21-51f7a5ca0170","domain":"taken.co.fa","availability":"unknown","errors":["TLD not supported for registration"]}}

data/spec/fixtures.http/getEmailForward/success.http

@@ -18,4 +18,4 @@ x-permitted-cross-domain-policies: none
 content-security-policy: frame-ancestors 'none'
 strict-transport-security: max-age=31536000
 
-{"data":{"id":41872,"domain_id":235146,"alias_email":"example@dnsimple.xyz","destination_email":"example@example.com","created_at":"2021-01-25T13:54:40Z","updated_at":"2021-01-25T13:54:40Z","from":"example@dnsimple.xyz","to":"example@example.com","active":true}}
+{"data":{"id":41872,"domain_id":235146,"alias_email":"example@dnsimple.xyz","destination_email":"example@example.com","created_at":"2021-01-25T13:54:40Z","updated_at":"2021-01-25T13:54:40Z","active":true}}

data/spec/fixtures.http/listEmailForwards/success.http

@@ -13,4 +13,4 @@ x-request-id: e42df983-a8a5-4123-8c74-fb89ab934aba
 x-runtime: 0.025456
 strict-transport-security: max-age=63072000
 
-{"data":[{"id":24809,"domain_id":235146,"alias_email":".*@a-domain.com","destination_email":"jane.smith@example.com","created_at":"2017-05-25T19:23:16Z","updated_at":"2017-05-25T19:23:16Z","from":".*@a-domain.com","to":"jane.smith@example.com","active":true}],"pagination":{"current_page":1,"per_page":30,"total_entries":1,"total_pages":1}}
+{"data":[{"id":24809,"domain_id":235146,"alias_email":".*@a-domain.com","destination_email":"jane.smith@example.com","created_at":"2017-05-25T19:23:16Z","updated_at":"2017-05-25T19:23:16Z","active":true}],"pagination":{"current_page":1,"per_page":30,"total_entries":1,"total_pages":1}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dnsimple
 version: !ruby/object:Gem::Version
-  version: 12.0.0
+  version: 12.1.0
 platform: ruby
 authors:
 - DNSimple
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-22 00:00:00.000000000 Z
+date: 2026-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -120,6 +120,7 @@ files:
 - lib/dnsimple/client/domains_dnssec.rb
 - lib/dnsimple/client/domains_email_forwards.rb
 - lib/dnsimple/client/domains_pushes.rb
+- lib/dnsimple/client/domains_research.rb
 - lib/dnsimple/client/identity.rb
 - lib/dnsimple/client/oauth.rb
 - lib/dnsimple/client/registrar.rb
@@ -163,6 +164,7 @@ files:
 - lib/dnsimple/struct/domain_push.rb
 - lib/dnsimple/struct/domain_registration.rb
 - lib/dnsimple/struct/domain_renewal.rb
+- lib/dnsimple/struct/domain_research_status.rb
 - lib/dnsimple/struct/domain_restore.rb
 - lib/dnsimple/struct/domain_transfer.rb
 - lib/dnsimple/struct/email_forward.rb
@@ -197,6 +199,7 @@ files:
 - spec/dnsimple/client/domains_dnssec_spec.rb
 - spec/dnsimple/client/domains_email_forwards_spec.rb
 - spec/dnsimple/client/domains_pushes_spec.rb
+- spec/dnsimple/client/domains_research_spec.rb
 - spec/dnsimple/client/domains_spec.rb
 - spec/dnsimple/client/identity_spec.rb
 - spec/dnsimple/client/oauth_spec.rb
@@ -302,6 +305,10 @@ files:
 - spec/fixtures.http/getDomainRestore/success.http
 - spec/fixtures.http/getDomainTransfer/success.http
 - spec/fixtures.http/getDomainTransferLock/success.http
+- spec/fixtures.http/getDomainsResearchStatus/error-validation.http
+- spec/fixtures.http/getDomainsResearchStatus/success-available.http
+- spec/fixtures.http/getDomainsResearchStatus/success-unavailable.http
+- spec/fixtures.http/getDomainsResearchStatus/success-unsupported-tld.http
 - spec/fixtures.http/getEmailForward/success.http
 - spec/fixtures.http/getPrimaryServer/success.http
 - spec/fixtures.http/getRegistrantChange/success.http