dnsimple 8.4.0 → 8.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34867970ac25f062a88e64df5c8ffc1a4cebb69612aea702cf6075ca79a9f9e7
-  data.tar.gz: 79ffa15c0875466c11c175feeda98df3467ddeb0b2229c16aa6c92aecf1e0a39
+  metadata.gz: 644e524e7010bc680c34ba6abf09315fbe41e2a5ec63ee6c82e443df4f21326a
+  data.tar.gz: aa84484bdf2a0b8b48ca45ad448dcea01c8c879acdf4b1c018f2cb8fb73ad7cf
 SHA512:
-  metadata.gz: d7d71422305173c73b5dc948ffaf006d76b651697afc072b90e494dd9051c90424409ad7f16366bbec4ea5992fadcad6463c133c7b0ef522bbabe03c6b78f766
-  data.tar.gz: 980c1e8c59db95933ab3d6e95eea871fcaaf9234b4866efbfc105c7da2fb841097a8e9aec2deb467d3ca1a6a7e9db79bcaed9b3851c6da4429c5799e3ded2a92
+  metadata.gz: fa53931624fc7c23d8f91332c9d86379560fc3609fe0f351d6346b6e38fb5b9337bb04e0aa6120c639431b9931cbc100405bc7bca544e04ee805b1ef07e2d4cb
+  data.tar.gz: 0032b9d9c4b3df0581e9037a5196bc8376c9f01dbb87ced552eb0372f6d30263a1121bdd86ba16e1a5a992974b64639cbdb81b9ba50e8442603bd0c6ab39f0b2

data/CHANGELOG.md

@@ -4,6 +4,24 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 ## main
 
+## 8.6.0
+
+FEATURES:
+
+- NEW: Added `Dnsimple::Client::Registrar#get_domain_transfer_lock` to retrieves the transfer lock status of a registered domain. (dnsimple/dnsimple-ruby#356)
+- NEW: Added `Dnsimple::Client::Registrar#enable_domain_transfer_lock` to enable the transfer lock for a registered domain. (dnsimple/dnsimple-ruby#356)
+- NEW: Added `Dnsimple::Client::Registrar#disable_domain_transfer_lock` to disable the transfer lock for a registered domain. (dnsimple/dnsimple-ruby#356)
+
+## 8.5.0
+
+FEATURES:
+
+- NEW: Added `Dnsimple::Client::Registrar#check_registrant_change` to retrieves the requirements of a registrant change. (dnsimple/dnsimple-ruby#355)
+- NEW: Added `Dnsimple::Client::Registrar#get_registrant_change` to retrieves the details of an existing registrant change. (dnsimple/dnsimple-ruby#355)
+- NEW: Added `Dnsimple::Client::Registrar#create_registrant_change` to start registrant change. (dnsimple/dnsimple-ruby#355)
+- NEW: Added `Dnsimple::Client::Registrar#list_registrant_changes` to lists the registrant changes for a domain. (dnsimple/dnsimple-ruby#355)
+- NEW: Added `Dnsimple::Client::Registrar#delete_registrant_change` to cancel an ongoing registrant change from the account. (dnsimple/dnsimple-ruby#355)
+
 ## 8.4.0
 
 FEATURES:

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
-gem 'rubocop', '1.55.1', require: false
-gem 'rubocop-performance', '1.18.0', require: false
+gem 'rubocop', '1.56.2', require: false
+gem 'rubocop-performance', '1.19.0', require: false
 gem 'rubocop-rake', '0.6.0', require: false
-gem 'rubocop-rspec', '2.23.0', require: false
+gem 'rubocop-rspec', '2.23.2', require: false

data/lib/dnsimple/client/clients.rb

@@ -160,17 +160,20 @@ module Dnsimple
       include Client::Oauth
     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'
 
     class RegistrarService < ClientService
       include Client::Registrar
       include Client::RegistrarAutoRenewal
-      include Client::RegistrarWhoisPrivacy
       include Client::RegistrarDelegation
+      include Client::RegistrarRegistrantChanges
+      include Client::RegistrarTransferLock
+      include Client::RegistrarWhoisPrivacy
     end
 
 

data/lib/dnsimple/client/registrar_registrant_changes.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  class Client
+    module RegistrarRegistrantChanges
+
+      # Retrieves the requirements of a registrant change
+      #
+      # @example Check the requirements to change the contact for example.com to contact 1234:
+      #   client.registrar.check_registrant_change(1010, { domain_id: "example.com", contact_id: 1234 })
+      #
+      # @param  [Integer] account_id the account ID
+      # @param [Hash] attributes the attributes to check the registrant change
+      # @option attributes [String, Integer] :domain_id the domain ID to check
+      # @option attributes [Integer] :contact_id the contact ID to check against
+      # @param  [Hash] options
+      # @return [Struct::RegistrantChangeCheck]
+      #
+      # @raise  [RequestError] When the request fails.
+      def check_registrant_change(account_id, attributes, options = {})
+        Extra.validate_mandatory_attributes(attributes, [:domain_id, :contact_id])
+        endpoint = Client.versioned("/%s/registrar/registrant_changes/check" % [account_id])
+        response = client.post(endpoint, attributes, options)
+
+        Dnsimple::Response.new(response, Struct::RegistrantChangeCheck.new(response["data"]))
+      end
+
+      # Retrieves the details of an existing registrant change.
+      #
+      # @example Retrieve the registrant change 42:
+      #   client.registrar.get_registrant_change(1010, 42)
+      #
+      # @param [Integer] account_id the Account id
+      # @param [#to_s] registrant_change_id the registrant change id
+      # @param [Hash] options
+      #
+      # @return [Struct::RegistrantChange]
+      #
+      # @raise [NotFoundError] When record is not found.
+      # @raise [RequestError] When the request fails.
+      def get_registrant_change(account_id, registrant_change_id, options = {})
+        endpoint = Client.versioned("/%s/registrar/registrant_changes/%s" % [account_id, registrant_change_id])
+        response = client.get(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::RegistrantChange.new(response["data"]))
+      end
+
+      # Start registrant change.
+      #
+      # @example Start a registrant change for example.com to contact 1234:
+      #   including WHOIS privacy for the domain and enabling auto renewal:
+      #   client.registrar.create_registrant_change(1010, { domain_id: "example.com", contact_id: 1234, extended_attributes: { "x-fi-registrant-idnumber" => "1234" } })
+      #
+      # @param  [Integer] account_id the account ID
+      # @param [Hash] attributes the attributes to start a registrant change
+      # @option attributes [String, Integer] :domain_id the domain ID
+      # @option attributes [Integer] :contact_id the contact ID to change to
+      # @option attributes [Array<Hash>, nil] :extended_attributes the extended attributes to pass to the registry
+      # @param  [Hash] options
+      # @return [Struct::RegistrantChange]
+      #
+      # @raise  [RequestError] When the request fails.
+      def create_registrant_change(account_id, attributes, options = {})
+        Extra.validate_mandatory_attributes(attributes, [:domain_id, :contact_id])
+        endpoint = Client.versioned("/%s/registrar/registrant_changes" % [account_id])
+        response = client.post(endpoint, attributes, options)
+
+        Dnsimple::Response.new(response, Struct::RegistrantChange.new(response["data"]))
+      end
+
+      # List registrant changes in the account.
+      #
+      # @example List registrant changes for the account:
+      #   client.registrar.list_registrant_changes(1010)
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [Hash] options
+      # @return [Dnsimple::PaginatedResponse<Struct::DomainRegistration>]
+      #
+      # @raise  [NotFoundError] When record is not found.
+      # @raise  [RequestError]  When the request fails.
+      def list_registrant_changes(account_id, options = {})
+        endpoint = Client.versioned("/%s/registrar/registrant_changes" % [account_id])
+        response = client.get(endpoint, options)
+
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::RegistrantChange.new(r) })
+      end
+
+      # Cancel an ongoing registrant change from the account.
+      #
+      # @example Cancel a registrant change 42:
+      #   client.registrar.delete_registrant_change(1010, 42)
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] registrant_change_id the registrant change ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [NotFoundError] When record is not found.
+      # @raise  [RequestError] When the request fails.
+      def delete_registrant_change(account_id, registrant_change_id, options = {})
+        endpoint = Client.versioned("/%s/registrar/registrant_changes/%s" % [account_id, registrant_change_id])
+        response = client.delete(endpoint, nil, options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+    end
+  end
+end

data/lib/dnsimple/client/registrar_transfer_lock.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  class Client
+    module RegistrarTransferLock
+
+      # Gets the transfer lock for the domain.
+      #
+      # @example Get the transfer lock for "example.com":
+      #   client.registrar.get_domain_transfer_lock(1010, "example.com")
+      #
+      # @param  [#to_s] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Hash] options
+      # @return [Struct::TransferLock]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [RequestError] When the request fails.
+      def get_domain_transfer_lock(account_id, domain_name, options = {})
+        response = client.get(Client.versioned("/%s/registrar/domains/%s/transfer_lock" % [account_id, domain_name]), options)
+
+        Dnsimple::Response.new(response, Struct::TransferLock.new(response["data"]))
+      end
+
+      # Enable transfer lock for the domain in the account.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/#enableDomainTransferLock
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Hash] options
+      # @return [Struct::TransferLock]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def enable_domain_transfer_lock(account_id, domain_name, options = {})
+        response = client.post(Client.versioned("/%s/registrar/domains/%s/transfer_lock" % [account_id, domain_name]), nil, options)
+
+        Dnsimple::Response.new(response, Struct::TransferLock.new(response["data"]))
+      end
+
+      # Disable trasnfer lock for the domain in the account.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/#disableDomainTransferLock
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Hash] options
+      # @return [Struct::TransferLock]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def disable_domain_transfer_lock(account_id, domain_name, options = {})
+        response = client.delete(Client.versioned("/%s/registrar/domains/%s/transfer_lock" % [account_id, domain_name]), nil, options)
+
+        Dnsimple::Response.new(response, Struct::TransferLock.new(response["data"]))
+      end
+
+    end
+  end
+end

data/lib/dnsimple/struct/registrant_change.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  module Struct
+
+    class RegistrantChange < Base
+      # @return [Integer] The registrant change ID in DNSimple.
+      attr_accessor :id
+
+      # @return [Integer] The associated account ID.
+      attr_accessor :account_id
+
+      # @return [Integer] The associated contact ID.
+      attr_accessor :contact_id
+
+      # @return [Integer] The associated domain ID.
+      attr_accessor :domain_id
+
+      # @return [String] The registrant change state.
+      attr_accessor :state
+
+      # @return [Hash] The extended attributes.
+      attr_accessor :extended_attributes
+
+      # @return [Boolean] True if the registrant change is a registry owner change.
+      attr_accessor :registry_owner_change
+
+      # @return [String] When the Inter-Registrar Transfer lock (60 days) is going to be lifted.
+      attr_accessor :irt_lock_lifted_by
+
+      # @return [String] When the registrant change was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the registrant change was last updated in DNSimple.
+      attr_accessor :updated_at
+    end
+  end
+end

data/lib/dnsimple/struct/registrant_change_check.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  module Struct
+
+    class RegistrantChangeCheck < Base
+      # @return [Integer] The associated contact ID.
+      attr_accessor :contact_id
+
+      # @return [Integer] The associated domain ID.
+      attr_accessor :domain_id
+
+      # @return [Array<Hash>] The extended attributes.
+      attr_accessor :extended_attributes
+
+      # # @return [Boolean] True if the registrant change is a registry owner change.
+      attr_accessor :registry_owner_change
+    end
+  end
+end

data/lib/dnsimple/struct/transfer_lock.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  module Struct
+
+    class TransferLock < Base
+      # @return [Boolean] True if Transfer Lock is enabled on the domain, otherwise false
+      attr_accessor :enabled
+    end
+
+  end
+end

data/lib/dnsimple/struct.rb

@@ -35,6 +35,9 @@ require_relative 'struct/domain_renewal'
 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'

data/lib/dnsimple/version.rb

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

data/spec/dnsimple/client/registrar_spec.rb

@@ -3,7 +3,6 @@
 require 'spec_helper'
 
 describe Dnsimple::Client, ".registrar" do
-
   subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").registrar }
 
 
@@ -283,7 +282,7 @@ describe Dnsimple::Client, ".registrar" do
       result = response.data
       expect(result).to be_a(Dnsimple::Struct::DomainTransfer)
       expect(result.id).to eq(361)
-      expect(result.domain_id).to eq(182245)
+      expect(result.domain_id).to eq(182_245)
       expect(result.registrant_id).to eq(2715)
       expect(result.state).to eq("cancelled")
       expect(result.auto_renew).to be(false)
@@ -316,7 +315,7 @@ describe Dnsimple::Client, ".registrar" do
       result = response.data
       expect(result).to be_a(Dnsimple::Struct::DomainTransfer)
       expect(result.id).to eq(361)
-      expect(result.domain_id).to eq(182245)
+      expect(result.domain_id).to eq(182_245)
       expect(result.registrant_id).to eq(2715)
       expect(result.state).to eq("transferring")
       expect(result.auto_renew).to be(false)
@@ -352,4 +351,224 @@ describe Dnsimple::Client, ".registrar" do
     end
   end
 
+  describe "#check_registrant_change" do
+    let(:account_id) { 1010 }
+    let(:attributes) { { domain_id: "example.com", contact_id: 1234 } }
+
+    before do
+      stub_request(:post, %r{/v2/#{account_id}/registrar/registrant_changes/check$})
+          .to_return(read_http_fixture("checkRegistrantChange/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.check_registrant_change(account_id, attributes)
+
+      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/registrar/registrant_changes/check")
+          .with(headers: { "Accept" => "application/json" })
+          .with(body: attributes)
+    end
+
+    it "returns the registrant change check" do
+      response = subject.check_registrant_change(account_id, attributes)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::RegistrantChangeCheck)
+      expect(result.contact_id).to eq(101)
+      expect(result.domain_id).to eq(101)
+      expect(result.extended_attributes).to be_a(Array)
+      expect(result.extended_attributes).to be_empty
+      expect(result.registry_owner_change).to be(true)
+    end
+
+    context "when the attributes are incomplete" do
+      it "raises ArgumentError" do
+        expect { subject.check_registrant_change(account_id, domain_id: "example.com") }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when the domain is not found" do
+      it "raises a NotFoundError" do
+        stub_request(:post, %r{/v2/#{account_id}/registrar/registrant_changes/check$})
+            .to_return(read_http_fixture("checkRegistrantChange/error-domainnotfound.http"))
+
+        expect {
+          subject.check_registrant_change(account_id, attributes)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+
+    context "when the contact is not found" do
+      it "raises a NotFoundError" do
+        stub_request(:post, %r{/v2/#{account_id}/registrar/registrant_changes/check$})
+            .to_return(read_http_fixture("checkRegistrantChange/error-contactnotfound.http"))
+
+        expect {
+          subject.check_registrant_change(account_id, attributes)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+  describe "#get_registrant_change" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/registrar/registrant_changes/.+$})
+          .to_return(read_http_fixture("getRegistrantChange/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.get_registrant_change(account_id, registrant_change_id = 42)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/registrar/registrant_changes/#{registrant_change_id}")
+          .with(headers: { "Accept" => "application/json" })
+    end
+
+    it "returns the registrant change" do
+      response = subject.get_registrant_change(account_id, 42)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::RegistrantChange)
+      expect(result.id).to eq(101)
+      expect(result.account_id).to eq(101)
+      expect(result.contact_id).to eq(101)
+      expect(result.domain_id).to eq(101)
+      expect(result.state).to eq("new")
+      expect(result.extended_attributes).to be_a(Hash)
+      expect(result.extended_attributes).to be_empty
+      expect(result.registry_owner_change).to be(true)
+      expect(result.irt_lock_lifted_by).to be_nil
+      expect(result.created_at).to eq("2017-02-03T17:43:22Z")
+      expect(result.updated_at).to eq("2017-02-03T17:43:22Z")
+    end
+  end
+
+  describe "#create_registrant_change" do
+    let(:account_id) { 1010 }
+    let(:attributes) { { domain_id: "example.com", contact_id: 1234, extended_attributes: { "x-fi-registrant-idnumber" => "1234" } } }
+
+    before do
+      stub_request(:post, %r{/v2/#{account_id}/registrar/registrant_changes$})
+          .to_return(read_http_fixture("createRegistrantChange/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.create_registrant_change(account_id, attributes)
+
+      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/registrar/registrant_changes")
+          .with(headers: { "Accept" => "application/json" })
+          .with(body: attributes)
+    end
+
+    it "returns the registrant change" do
+      response = subject.create_registrant_change(account_id, attributes)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::RegistrantChange)
+      expect(result.id).to eq(101)
+      expect(result.account_id).to eq(101)
+      expect(result.contact_id).to eq(101)
+      expect(result.domain_id).to eq(101)
+      expect(result.state).to eq("new")
+      expect(result.extended_attributes).to be_a(Hash)
+      expect(result.extended_attributes).to be_empty
+      expect(result.registry_owner_change).to be(true)
+      expect(result.irt_lock_lifted_by).to be_nil
+      expect(result.created_at).to eq("2017-02-03T17:43:22Z")
+      expect(result.updated_at).to eq("2017-02-03T17:43:22Z")
+    end
+
+    context "when the attributes are incomplete" do
+      it "raises ArgumentError" do
+        expect { subject.create_registrant_change(account_id, domain_id: "example.com") }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when the domain is not found" do
+      it "raises a NotFoundError" do
+        stub_request(:post, %r{/v2/#{account_id}/registrar/registrant_changes$})
+            .to_return(read_http_fixture("checkRegistrantChange/error-domainnotfound.http"))
+
+        expect {
+          subject.create_registrant_change(account_id, attributes)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+
+    context "when the contact is not found" do
+      it "raises a NotFoundError" do
+        stub_request(:post, %r{/v2/#{account_id}/registrar/registrant_changes$})
+            .to_return(read_http_fixture("checkRegistrantChange/error-contactnotfound.http"))
+
+        expect {
+          subject.create_registrant_change(account_id, attributes)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+  describe "#list_registrant_changes" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/registrar/registrant_changes$})
+          .to_return(read_http_fixture("listRegistrantChanges/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.list_registrant_changes(account_id)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/registrar/registrant_changes")
+          .with(headers: { "Accept" => "application/json" })
+    end
+
+    it "returns the registrant changes" do
+      response = subject.list_registrant_changes(account_id)
+      expect(response).to be_a(Dnsimple::PaginatedResponse)
+
+      results = response.data
+
+      results.each do |result|
+        expect(result).to be_a(Dnsimple::Struct::RegistrantChange)
+        expect(result.id).to be_a(Integer)
+        expect(result.account_id).to be_a(Integer)
+        expect(result.contact_id).to be_a(Integer)
+        expect(result.domain_id).to be_a(Integer)
+        expect(result.state).to be_a(String)
+        expect(result.extended_attributes).to be_a(Hash)
+        expect(result.extended_attributes).to be_empty
+        expect(result.registry_owner_change).to be(true).or be(false)
+        expect(result.irt_lock_lifted_by).to be_nil
+        expect(result.created_at).to be_a(String)
+        expect(result.updated_at).to be_a(String)
+      end
+    end
+  end
+
+  describe "#delete_registrant_change" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:delete, %r{/v2/#{account_id}/registrar/registrant_changes/.+$})
+          .to_return(read_http_fixture("deleteRegistrantChange/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.delete_registrant_change(account_id, registrant_change_id = 42)
+
+      expect(WebMock).to have_requested(:delete, "https://api.dnsimple.test/v2/#{account_id}/registrar/registrant_changes/#{registrant_change_id}")
+          .with(headers: { "Accept" => "application/json" })
+    end
+
+    it "returns nothing" do
+      response = subject.delete_registrant_change(account_id, 42)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_nil
+    end
+  end
 end

data/spec/dnsimple/client/registrar_transfer_lock_spec.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Dnsimple::Client, ".registrar" do
+  subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").registrar }
+
+  describe "#get_domain_transfer_lock" do
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/registrar/domains/#{domain_id}/transfer_lock})
+          .to_return(read_http_fixture("getDomainTransferLock/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.get_domain_transfer_lock(account_id, domain_id)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/registrar/domains/#{domain_id}/transfer_lock")
+          .with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the transfer lock state" do
+      response = subject.get_domain_transfer_lock(account_id, domain_id)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::TransferLock)
+      expect(result.enabled).to be(true)
+    end
+
+    context "when the domain does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:get, %r{/v2})
+            .to_return(read_http_fixture("notfound-domain.http"))
+
+        expect {
+          subject.get_domain_transfer_lock(account_id, domain_id)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+  describe "#enable_domain_transfer_lock" do
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+
+    before do
+      stub_request(:post, %r{/v2/#{account_id}/registrar/domains/#{domain_id}/transfer_lock})
+          .to_return(read_http_fixture("enableDomainTransferLock/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.enable_domain_transfer_lock(account_id, domain_id)
+
+      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/registrar/domains/#{domain_id}/transfer_lock")
+          .with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the transfer lock state" do
+      response = subject.enable_domain_transfer_lock(account_id, domain_id)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::TransferLock)
+      expect(result.enabled).to be(true)
+    end
+
+    context "when the domain does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:post, %r{/v2})
+            .to_return(read_http_fixture("notfound-domain.http"))
+
+        expect {
+          subject.enable_domain_transfer_lock(account_id, domain_id)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+  describe "#disable_domain_transfer_lock" do
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+
+    before do
+      stub_request(:delete, %r{/v2/#{account_id}/registrar/domains/#{domain_id}})
+          .to_return(read_http_fixture("disableDomainTransferLock/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.disable_domain_transfer_lock(account_id, domain_id)
+
+      expect(WebMock).to have_requested(:delete, "https://api.dnsimple.test/v2/#{account_id}/registrar/domains/#{domain_id}/transfer_lock")
+          .with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the transfer lock state" do
+      response = subject.disable_domain_transfer_lock(account_id, domain_id)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::TransferLock)
+      expect(result.enabled).to be(false)
+    end
+
+    context "when the domain does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:delete, %r{/v2})
+            .to_return(read_http_fixture("notfound-domain.http"))
+
+        expect {
+          subject.disable_domain_transfer_lock(account_id, domain_id)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+end

data/spec/fixtures.http/checkRegistrantChange/error-contactnotfound.http

@@ -0,0 +1,14 @@
+HTTP/1.1 404
+server: nginx
+date: Tue, 22 Aug 2023 13:59:02 GMT
+content-type: application/json; charset=utf-8
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2398
+x-ratelimit-reset: 1692716201
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+cache-control: no-cache
+x-request-id: b1dd3f42-ebb9-42fd-a121-d595de96f667
+x-runtime: 0.019122
+strict-transport-security: max-age=63072000
+
+{"message":"Contact `21` not found"}

data/spec/fixtures.http/checkRegistrantChange/error-domainnotfound.http

@@ -0,0 +1,15 @@
+HTTP/1.1 404 
+server: nginx
+date: Tue, 22 Aug 2023 11:09:40 GMT
+content-type: application/json; charset=utf-8
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2395
+x-ratelimit-reset: 1692705338
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+etag: W/"cef1e7d85d0b9bfd25e81b812891d34f"
+cache-control: max-age=0, private, must-revalidate
+x-request-id: 5b0d8bfb-7b6a-40b5-a079-b640fd817e34
+x-runtime: 3.066249
+strict-transport-security: max-age=63072000
+
+{"message":"Domain `example.com` not found"}

data/spec/fixtures.http/checkRegistrantChange/success.http

@@ -0,0 +1,15 @@
+HTTP/1.1 200 
+server: nginx
+date: Tue, 22 Aug 2023 11:09:40 GMT
+content-type: application/json; charset=utf-8
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2395
+x-ratelimit-reset: 1692705338
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+etag: W/"cef1e7d85d0b9bfd25e81b812891d34f"
+cache-control: max-age=0, private, must-revalidate
+x-request-id: 5b0d8bfb-7b6a-40b5-a079-b640fd817e34
+x-runtime: 3.066249
+strict-transport-security: max-age=63072000
+
+{"data":{"domain_id":101,"contact_id":101,"extended_attributes":[],"registry_owner_change":true}}

data/spec/fixtures.http/createRegistrantChange/success.http

@@ -0,0 +1,14 @@
+HTTP/1.1 202 
+server: nginx
+date: Tue, 22 Aug 2023 11:11:00 GMT
+content-type: application/json; charset=utf-8
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2394
+x-ratelimit-reset: 1692705339
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+cache-control: no-cache
+x-request-id: 26bf7ff9-2075-42b0-9431-1778c825b6b0
+x-runtime: 3.408950
+strict-transport-security: max-age=63072000
+
+{"data":{"id":101,"account_id":101,"domain_id":101,"contact_id":101,"state":"new","extended_attributes":{},"registry_owner_change":true,"irt_lock_lifted_by":null,"created_at":"2017-02-03T17:43:22Z","updated_at":"2017-02-03T17:43:22Z"}}

data/spec/fixtures.http/deleteRegistrantChange/success.http

@@ -0,0 +1,13 @@
+HTTP/1.1 201 
+server: nginx
+date: Tue, 22 Aug 2023 11:14:44 GMT
+content-type: application/json; charset=utf-8
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2391
+x-ratelimit-reset: 1692705338
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+cache-control: no-cache
+x-request-id: b123e1f0-aa70-4abb-95cf-34f377c83ef4
+x-runtime: 0.114839
+strict-transport-security: max-age=63072000
+

data/spec/fixtures.http/disableDomainTransferLock/success.http

@@ -0,0 +1,20 @@
+HTTP/1.1 200 OK
+Server: nginx
+Date: Tue, 15 Aug 2023 09:58:37 GMT
+Content-Type: application/json; charset=utf-8
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2398
+X-RateLimit-Reset: 1488538623
+ETag: W/"fc2368a31a1b6a3afcca33bb37ff6b9d"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: 8b0fe49a-c810-4552-84ab-a1cd9b4a7786
+X-Runtime: 0.024780
+X-Content-Type-Options: nosniff
+X-Download-Options: noopen
+X-Frame-Options: DENY
+X-Permitted-Cross-Domain-Policies: none
+X-XSS-Protection: 1; mode=block
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"enabled":false}}

data/spec/fixtures.http/enableDomainTransferLock/success.http

@@ -0,0 +1,20 @@
+HTTP/1.1 201 Created
+Server: nginx
+Date: Tue, 15 Aug 2023 09:58:37 GMT
+Content-Type: application/json; charset=utf-8
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2398
+X-RateLimit-Reset: 1488538623
+ETag: W/"fc2368a31a1b6a3afcca33bb37ff6b9d"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: 8b0fe49a-c810-4552-84ab-a1cd9b4a7786
+X-Runtime: 0.024780
+X-Content-Type-Options: nosniff
+X-Download-Options: noopen
+X-Frame-Options: DENY
+X-Permitted-Cross-Domain-Policies: none
+X-XSS-Protection: 1; mode=block
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"enabled":true}}

data/spec/fixtures.http/getDomainTransferLock/success.http

@@ -0,0 +1,20 @@
+HTTP/1.1 200 OK
+Server: nginx
+Date: Tue, 15 Aug 2023 09:58:37 GMT
+Content-Type: application/json; charset=utf-8
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2398
+X-RateLimit-Reset: 1488538623
+ETag: W/"fc2368a31a1b6a3afcca33bb37ff6b9d"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: 8b0fe49a-c810-4552-84ab-a1cd9b4a7786
+X-Runtime: 0.024780
+X-Content-Type-Options: nosniff
+X-Download-Options: noopen
+X-Frame-Options: DENY
+X-Permitted-Cross-Domain-Policies: none
+X-XSS-Protection: 1; mode=block
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"enabled":true}}

data/spec/fixtures.http/getRegistrantChange/success.http

@@ -0,0 +1,15 @@
+HTTP/1.1 200 
+server: nginx
+date: Tue, 22 Aug 2023 11:13:58 GMT
+content-type: application/json; charset=utf-8
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2392
+x-ratelimit-reset: 1692705338
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+etag: W/"76c5d4c7579b754b94a42ac7fa37a901"
+cache-control: max-age=0, private, must-revalidate
+x-request-id: e910cd08-3f9c-4da4-9986-50dbe9c3bc55
+x-runtime: 0.022006
+strict-transport-security: max-age=63072000
+
+{"data":{"id":101,"account_id":101,"domain_id":101,"contact_id":101,"state":"new","extended_attributes":{},"registry_owner_change":true,"irt_lock_lifted_by":null,"created_at":"2017-02-03T17:43:22Z","updated_at":"2017-02-03T17:43:22Z"}}

data/spec/fixtures.http/listRegistrantChanges/success.http

@@ -0,0 +1,15 @@
+HTTP/1.1 200 
+server: nginx
+date: Tue, 22 Aug 2023 11:12:49 GMT
+content-type: application/json; charset=utf-8
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2393
+x-ratelimit-reset: 1692705338
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+etag: W/"0049703ea058b06346df4c0e169eac29"
+cache-control: max-age=0, private, must-revalidate
+x-request-id: fd0334ce-414a-4872-8889-e548e0b1410c
+x-runtime: 0.030759
+strict-transport-security: max-age=63072000
+
+{"data":[{"id":101,"account_id":101,"domain_id":101,"contact_id":101,"state":"new","extended_attributes":{},"registry_owner_change":true,"irt_lock_lifted_by":null,"created_at":"2017-02-03T17:43:22Z","updated_at":"2017-02-03T17:43:22Z"}],"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: 8.4.0
+  version: 8.6.0
 platform: ruby
 authors:
 - DNSimple
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 2023-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -124,6 +124,8 @@ files:
 - lib/dnsimple/client/registrar.rb
 - lib/dnsimple/client/registrar_auto_renewal.rb
 - lib/dnsimple/client/registrar_delegation.rb
+- lib/dnsimple/client/registrar_registrant_changes.rb
+- lib/dnsimple/client/registrar_transfer_lock.rb
 - lib/dnsimple/client/registrar_whois_privacy.rb
 - lib/dnsimple/client/services.rb
 - lib/dnsimple/client/services_domains.rb
@@ -162,10 +164,13 @@ files:
 - lib/dnsimple/struct/email_forward.rb
 - lib/dnsimple/struct/extended_attribute.rb
 - lib/dnsimple/struct/oauth_token.rb
+- lib/dnsimple/struct/registrant_change.rb
+- lib/dnsimple/struct/registrant_change_check.rb
 - lib/dnsimple/struct/service.rb
 - lib/dnsimple/struct/template.rb
 - lib/dnsimple/struct/template_record.rb
 - lib/dnsimple/struct/tld.rb
+- lib/dnsimple/struct/transfer_lock.rb
 - lib/dnsimple/struct/user.rb
 - lib/dnsimple/struct/vanity_name_server.rb
 - lib/dnsimple/struct/webhook.rb
@@ -192,6 +197,7 @@ files:
 - spec/dnsimple/client/registrar_auto_renewal_spec.rb
 - spec/dnsimple/client/registrar_delegation_spec.rb
 - spec/dnsimple/client/registrar_spec.rb
+- spec/dnsimple/client/registrar_transfer_lock_spec.rb
 - spec/dnsimple/client/registrar_whois_privacy_spec.rb
 - spec/dnsimple/client/services_domains_spec.rb
 - spec/dnsimple/client/services_spec.rb
@@ -227,6 +233,9 @@ files:
 - spec/fixtures.http/checkDomainPremiumPrice/error_400_not_a_premium_domain.http
 - spec/fixtures.http/checkDomainPremiumPrice/error_400_tld_not_supported.http
 - spec/fixtures.http/checkDomainPremiumPrice/success.http
+- spec/fixtures.http/checkRegistrantChange/error-contactnotfound.http
+- spec/fixtures.http/checkRegistrantChange/error-domainnotfound.http
+- spec/fixtures.http/checkRegistrantChange/success.http
 - spec/fixtures.http/checkZoneDistribution/error.http
 - spec/fixtures.http/checkZoneDistribution/failure.http
 - spec/fixtures.http/checkZoneDistribution/success.http
@@ -239,6 +248,7 @@ files:
 - spec/fixtures.http/createDomain/created.http
 - spec/fixtures.http/createEmailForward/created.http
 - spec/fixtures.http/createPrimaryServer/created.http
+- spec/fixtures.http/createRegistrantChange/success.http
 - spec/fixtures.http/createSecondaryZone/created.http
 - spec/fixtures.http/createTemplate/created.http
 - spec/fixtures.http/createTemplateRecord/created.http
@@ -251,6 +261,7 @@ files:
 - spec/fixtures.http/deleteDelegationSignerRecord/success.http
 - spec/fixtures.http/deleteDomain/success.http
 - spec/fixtures.http/deleteEmailForward/success.http
+- spec/fixtures.http/deleteRegistrantChange/success.http
 - spec/fixtures.http/deleteTemplate/success.http
 - spec/fixtures.http/deleteTemplateRecord/success.http
 - spec/fixtures.http/deleteWebhook/success.http
@@ -258,11 +269,13 @@ files:
 - spec/fixtures.http/disableDnssec/not-enabled.http
 - spec/fixtures.http/disableDnssec/success.http
 - spec/fixtures.http/disableDomainAutoRenewal/success.http
+- spec/fixtures.http/disableDomainTransferLock/success.http
 - spec/fixtures.http/disableVanityNameServers/success.http
 - spec/fixtures.http/disableWhoisPrivacy/success.http
 - spec/fixtures.http/downloadCertificate/success.http
 - spec/fixtures.http/enableDnssec/success.http
 - spec/fixtures.http/enableDomainAutoRenewal/success.http
+- spec/fixtures.http/enableDomainTransferLock/success.http
 - spec/fixtures.http/enableVanityNameServers/success.http
 - spec/fixtures.http/enableWhoisPrivacy/created.http
 - spec/fixtures.http/enableWhoisPrivacy/success.http
@@ -281,8 +294,10 @@ files:
 - spec/fixtures.http/getDomainRegistration/success.http
 - spec/fixtures.http/getDomainRenewal/success.http
 - spec/fixtures.http/getDomainTransfer/success.http
+- spec/fixtures.http/getDomainTransferLock/success.http
 - spec/fixtures.http/getEmailForward/success.http
 - spec/fixtures.http/getPrimaryServer/success.http
+- spec/fixtures.http/getRegistrantChange/success.http
 - spec/fixtures.http/getService/success.http
 - spec/fixtures.http/getTemplate/success.http
 - spec/fixtures.http/getTemplateRecord/success.http
@@ -309,6 +324,7 @@ files:
 - spec/fixtures.http/listEmailForwards/success.http
 - spec/fixtures.http/listPrimaryServers/success.http
 - spec/fixtures.http/listPushes/success.http
+- spec/fixtures.http/listRegistrantChanges/success.http
 - spec/fixtures.http/listServices/success.http
 - spec/fixtures.http/listTemplateRecords/success.http
 - spec/fixtures.http/listTemplates/success.http