dnsimple 5.2.0 → 7.1.1

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.4"
+  s.required_ruby_version = ">= 2.6"
 
   s.require_paths    = ['lib']
   s.files            = `git ls-files`.split("\n")

data/lib/dnsimple/client/clients.rb

@@ -98,14 +98,15 @@ module Dnsimple
         options = args.pop
         response = nil
 
-        begin
+        loop do
           current_page += 1
           query = Extra.deep_merge(options, query: { page: current_page, per_page: 100 })
 
           response = send(method, *(args + [query]))
           total_pages ||= response.total_pages
           collection.concat(response.data)
-        end while current_page < total_pages
+          break unless current_page < total_pages
+        end
 
         CollectionResponse.new(response.http_response, collection)
       end

data/lib/dnsimple/client/domains.rb

@@ -114,24 +114,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
-
-      # Resets the domain token.
-      #
-      # @see https://developer.dnsimple.com/v2/domains/#reset-token
-      #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] domain_id The domain ID or domain name
-      # @param  [Hash] options
-      # @return [Dnsimple::Response<nil>]
-      #
-      # @raise  [Dnsimple::NotFoundError]
-      # @raise  [Dnsimple::RequestError]
-      def reset_domain_token(account_id, domain_id, options = {})
-        response = client.post(Client.versioned("/%s/domains/%s/token" % [account_id, domain_id]), nil, options)
-
-        Dnsimple::Response.new(response, Struct::Domain.new(response["data"]))
-      end
-
     end
   end
 end

data/lib/dnsimple/client/domains_delegation_signer_records.rb

@@ -67,15 +67,16 @@ module Dnsimple
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] attributes
       # @option attributes [Integer] :algorithm DNSSEC algorithm as number (required)
-      # @option attributes [String] :digest The hexidecimal representation of the digest of the corresponding DNSKEY record (required)
-      # @option attributes [Integer] :digest_type DNSSEC digest type (required)
-      # @option attributes [String] :keytag A keytag that references the corresponding DNSKEY record (required)
+      # @option attributes [String] :digest The hexidecimal representation of the digest of the corresponding DNSKEY record (required if TLD requires DS data)
+      # @option attributes [Integer] :digest_type DNSSEC digest type (required if TLD requires DS data)
+      # @option attributes [String] :keytag A keytag that references the corresponding DNSKEY record (required if TLD requires DS data)
+      # @option attributes [String] :public_key A public key that references the corresponding DNSKEY record (required if TLD requires KEY data)
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::DelegationSignerRecord>]
       #
       # @raise  [Dnsimple::RequestError]
       def create_delegation_signer_record(account_id, domain_id, attributes, options = {})
-        Extra.validate_mandatory_attributes(attributes, [:algorithm, :digest, :digest_type, :keytag])
+        Extra.validate_mandatory_attributes(attributes, [:algorithm])
         response = client.post(Client.versioned("/%s/domains/%s/ds_records" % [account_id, domain_id]), attributes, options)
 
         Dnsimple::Response.new(response, Struct::DelegationSignerRecord.new(response["data"]))

data/lib/dnsimple/client/registrar.rb

@@ -42,7 +42,10 @@ module Dnsimple
       # @return [Struct::DomainPremiumPrice]
       #
       # @raise  [RequestError] When the request fails.
+      #
+      # @deprecated Use {#get_domain_prices} instead of this one as it will soon be removed from the API.
       def domain_premium_price(account_id, domain_name, options = {})
+        Dnsimple.deprecate("Use {#get_domain_prices} instead of this one as it will soon be removed from the API.")
         endpoint = Client.versioned("/%s/registrar/domains/%s/premium_price" % [account_id, domain_name])
         options[:query] = { action: options.delete(:action) } if options.key?(:action)
         response = client.get(endpoint, options)
@@ -50,6 +53,26 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::DomainPremiumPrice.new(response["data"]))
       end
 
+      # Get prices for a domain.
+      # @see https://developer.dnsimple.com/v2/registrar/#getDomainPrices
+      #
+      # @example Check prices for example.com:
+      #   client.registrar.get_domain_prices(1010, "example.com")
+      #
+      # @param [Integer] account_id the Account id
+      # @param [String] domain_name the domain name to find the prices
+      # @param [Hash] options
+      #
+      # @return [Struct::DomainPrice]
+      #
+      # @raise [RequestError] When the request fails.
+      def get_domain_prices(account_id, domain_name, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/prices" % [account_id, domain_name])
+        response = client.get(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::DomainPrice.new(response["data"]))
+      end
+
       # Registers a domain.
       #
       # @see https://developer.dnsimple.com/v2/registrar/#register

data/lib/dnsimple/client/registrar_whois_privacy.rb

@@ -78,7 +78,7 @@ module Dnsimple
       #
       # @raise  [RequestError] When the request fails.
       def renew_whois_privacy(account_id, domain_name, options = {})
-        endpoint = whois_privacy_endpoint(account_id, domain_name) + "/renewals"
+        endpoint = "#{whois_privacy_endpoint(account_id, domain_name)}/renewals"
         response = client.post(endpoint, nil, options)
 
         Dnsimple::Response.new(response, Struct::WhoisPrivacyRenewal.new(response["data"]))

data/lib/dnsimple/client.rb

@@ -42,22 +42,30 @@ module Dnsimple
     # @!attribute username
     #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] DNSimple username for Basic Authentication
+    attr_accessor :username
+
     # @!attribute password
     #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] DNSimple password for Basic Authentication
+    attr_accessor :password
+
     # @!attribute domain_api_token
     #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] Domain API access token for authentication
+    attr_accessor :domain_api_token
+
     # @!attribute access_token
     #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] Domain API access token for authentication
+    attr_accessor :access_token
+
     # @!attribute user_agent
     #   @return [String] Configure User-Agent header for requests.
+    attr_accessor :user_agent
+
     # @!attribute proxy
     #   @return [String,nil] Configure address:port values for proxy server
-
-    attr_accessor :username, :password, :domain_api_token, :access_token,
-                  :user_agent, :proxy
+    attr_accessor :proxy
 
 
     def initialize(options = {})

data/lib/dnsimple/default.rb

@@ -9,7 +9,7 @@ module Dnsimple
     BASE_URL = "https://api.dnsimple.com/"
 
     # Default User Agent header
-    USER_AGENT = "dnsimple-ruby/#{VERSION}"
+    USER_AGENT = "dnsimple-ruby/#{VERSION}".freeze
 
     class << self
 
@@ -30,7 +30,7 @@ module Dnsimple
       # Configuration options
       # @return [Hash]
       def options
-        Hash[keys.map { |key| [key, send(key)] }]
+        keys.to_h { |key| [key, send(key)] }
       end
 
       # Default API endpoint from ENV or {BASE_URL}

data/lib/dnsimple/error.rb

@@ -18,7 +18,7 @@ module Dnsimple
 
     def message_from(http_response)
       content_type = http_response.headers["Content-Type"]
-      if content_type && content_type.start_with?("application/json")
+      if content_type&.start_with?("application/json")
         http_response.parsed_response["message"]
       else
         net_http_response = http_response.response

data/lib/dnsimple/extra.rb

@@ -36,8 +36,8 @@ module Dnsimple
         this[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
           deep_merge(this_value, other_value, &block)
         else
-          if block_given? && key?(current_key)
-            block.call(current_key, this_value, other_value)
+          if block && key?(current_key)
+            yield(current_key, this_value, other_value)
           else
             other_value
           end
@@ -55,7 +55,7 @@ module Dnsimple
     # @raise  [ArgumentError]
     def self.validate_mandatory_attributes(attributes, required)
       required.each do |name|
-        attributes && attributes.key?(name) or raise(ArgumentError, ":#{name} is required")
+        attributes&.key?(name) or raise(ArgumentError, ":#{name} is required")
       end
     end
 

data/lib/dnsimple/response.rb

@@ -41,9 +41,7 @@ module Dnsimple
 
   # The CollectionResponse is a specific type of Response where the data is a collection of enumerable objects.
   class CollectionResponse < Response
-    def initialize(http_response, collection)
-      super
-    end
+
   end
 
   # The PaginatedResponse is a specific type of Response that also exposes pagination metadata.

data/lib/dnsimple/struct/certificate.rb

@@ -4,13 +4,6 @@ module Dnsimple
   module Struct
 
     class Certificate < Base
-
-      def initialize(attributes = {})
-        attributes.delete("expires_on")
-        super
-        @expires_on = Date.parse(expires_at).to_s if expires_at
-      end
-
       # @return [Integer] The certificate ID in DNSimple.
       attr_accessor :id
 
@@ -49,18 +42,6 @@ module Dnsimple
 
       # @return [String] The timestamp when the certificate will expire.
       attr_accessor :expires_at
-
-      # @deprecated Please use #expires_at instead.
-      # @return [String] The date when the certificate will expire.
-      def expires_on
-        warn "[DEPRECATION] Certificate#expires_on is deprecated. Please use `expires_at` instead."
-        @expires_on
-      end
-
-      def expires_on=(expiration_date)
-        warn "[DEPRECATION] Certificate#expires_on= is deprecated. Please use `expires_at=` instead."
-        @expires_on = expiration_date
-      end
     end
 
   end

data/lib/dnsimple/struct/delegation_signer_record.rb

@@ -22,6 +22,9 @@ module Dnsimple
       # @return [String] The keytag for the associated DNSKEY.
       attr_accessor :keytag
 
+      # @return [String] The public key that references the corresponding DNSKEY record.
+      attr_accessor :public_key
+
       # @return [String] When the delegation signing record was created in DNSimple.
       attr_accessor :created_at
 

data/lib/dnsimple/struct/domain.rb

@@ -4,13 +4,6 @@ module Dnsimple
   module Struct
 
     class Domain < Base
-
-      def initialize(attributes = {})
-        attributes.delete("expires_on")
-        super
-        @expires_on = Date.parse(expires_at).to_s if expires_at
-      end
-
       # @return [Integer] The domain ID in DNSimple.
       attr_accessor :id
 
@@ -43,19 +36,6 @@ module Dnsimple
 
       # @return [String] When the domain was last updated in DNSimple.
       attr_accessor :updated_at
-
-      # @deprecated Please use #expires_at instead.
-      # @return [String] The date the domain will expire.
-      def expires_on
-        warn "[DEPRECATION] Domain#expires_on is deprecated. Please use `expires_at` instead."
-        @expires_on
-      end
-
-      def expires_on=(expiration_date)
-        warn "[DEPRECATION] Domain#expires_on= is deprecated. Please use `expires_at=` instead."
-        @expires_on = expiration_date
-      end
-
     end
   end
 end

data/lib/dnsimple/struct/domain_price.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  module Struct
+
+    class DomainPrice < Base
+      # @return [String] The domain name
+      attr_accessor :domain
+
+      # @return [Boolean] Whether the domain is premium.
+      attr_accessor :premium
+
+      # @return [Float] The price for registration
+      attr_accessor :registration_price
+
+      # @return [Float] The price for renewal
+      attr_accessor :renewal_price
+
+      # @return [Float] The price for transfer
+      attr_accessor :transfer_price
+    end
+
+  end
+end

data/lib/dnsimple/struct/tld.rb

@@ -30,6 +30,9 @@ module Dnsimple
 
       # @return [Boolean] True if DNSimple supports inbound transfers for this TLD.
       attr_accessor :transfer_enabled
+
+      # @return [String, nil] Type of data interface required for DNSSEC for this TLD.
+      attr_accessor :dnssec_interface_type
     end
 
   end

data/lib/dnsimple/struct.rb

@@ -27,6 +27,7 @@ require_relative 'struct/dnssec'
 require_relative 'struct/domain'
 require_relative 'struct/domain_check'
 require_relative 'struct/domain_premium_price'
+require_relative 'struct/domain_price'
 require_relative 'struct/domain_push'
 require_relative 'struct/domain_registration'
 require_relative 'struct/domain_transfer'

data/lib/dnsimple/version.rb

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

data/spec/dnsimple/client/certificates_spec.rb

@@ -120,7 +120,6 @@ describe Dnsimple::Client, ".certificates" do
       expect(result.auto_renew).to be(false)
       expect(result.created_at).to eq("2020-06-18T18:54:17Z")
       expect(result.updated_at).to eq("2020-06-18T19:10:14Z")
-      expect(result.expires_on).to eq("2020-09-16")
       expect(result.expires_at).to eq("2020-09-16T18:10:13Z")
     end
 

data/spec/dnsimple/client/client_service_spec.rb

@@ -6,7 +6,7 @@ describe Dnsimple::Client::ClientService do
 
   describe "#paginate" do
     service_class = Class.new(Dnsimple::Client::ClientService) do
-      Item = Class.new(Dnsimple::Struct::Base) do
+      Item = Class.new(Dnsimple::Struct::Base) do # rubocop:disable Lint/ConstantDefinitionInBlock
         attr_accessor :id
       end
 

data/spec/dnsimple/client/contacts_spec.rb

@@ -86,13 +86,13 @@ describe Dnsimple::Client, ".contacts" do
 
   describe "#create_contact" do
     let(:account_id) { 1010 }
+    let(:attributes) { { first_name: "Simone", last_name: "Carletti", address1: "Italian Street", city: "Rome", state_province: "RM", postal_code: "00171", country: "IT", email: "example@example.com", phone: "+393391234567" } }
 
     before do
       stub_request(:post, %r{/v2/#{account_id}/contacts$})
           .to_return(read_http_fixture("createContact/created.http"))
     end
 
-    let(:attributes) { { first_name: "Simone", last_name: "Carletti", address1: "Italian Street", city: "Rome", state_province: "RM", postal_code: "00171", country: "IT", email: "example@example.com", phone: "+393391234567" } }
 
     it "builds the correct request" do
       subject.create_contact(account_id, attributes)
@@ -153,13 +153,13 @@ describe Dnsimple::Client, ".contacts" do
 
   describe "#update_contact" do
     let(:account_id) { 1010 }
+    let(:attributes) { { first_name: "Updated" } }
 
     before do
       stub_request(:patch, %r{/v2/#{account_id}/contacts/.+$})
           .to_return(read_http_fixture("updateContact/success.http"))
     end
 
-    let(:attributes) { { first_name: "Updated" } }
 
     it "builds the correct request" do
       subject.update_contact(account_id, contact_id = 1, attributes)

data/spec/dnsimple/client/domains_collaborators_spec.rb

@@ -63,7 +63,7 @@ describe Dnsimple::Client, ".domains" do
     let(:account_id) { 1010 }
     let(:domain_id)  { "example.com" }
 
-    context "invite user already registered on DNSimple" do
+    context "when inviting a user already registered on DNSimple" do
       before do
         stub_request(:post, %r{/v2/#{account_id}/domains/#{domain_id}/collaborators$})
             .to_return(read_http_fixture("addCollaborator/success.http"))
@@ -93,7 +93,7 @@ describe Dnsimple::Client, ".domains" do
       end
     end
 
-    context "invite not registered on DNSimple" do
+    context "when inviting a user not registered on DNSimple" do
       before do
         stub_request(:post, %r{/v2/#{account_id}/domains/#{domain_id}/collaborators$})
             .to_return(read_http_fixture("addCollaborator/invite-success.http"))

data/spec/dnsimple/client/domains_delegation_signer_records_spec.rb

@@ -99,6 +99,7 @@ describe Dnsimple::Client, ".domains" do
 
   describe "#create_delegation_signer_record" do
     let(:account_id) { 1010 }
+    let(:attributes) { { algorithm: "13", digest: "ABC123", digest_type: "2", keytag: "1111" } }
     let(:domain_id) { "example.com" }
 
     before do
@@ -106,7 +107,6 @@ describe Dnsimple::Client, ".domains" do
           .to_return(read_http_fixture("createDelegationSignerRecord/created.http"))
     end
 
-    let(:attributes) { { algorithm: "13", digest: "ABC123", digest_type: "2", keytag: "1111" } }
 
     it "builds the correct request" do
       subject.create_delegation_signer_record(account_id, domain_id, attributes)
@@ -155,6 +155,7 @@ describe Dnsimple::Client, ".domains" do
       expect(result.digest).to eq("C1F6E04A5A61FBF65BF9DC8294C363CF11C89E802D926BDAB79C55D27BEFA94F")
       expect(result.digest_type).to eq("2")
       expect(result.keytag).to eq("44620")
+      expect(result.public_key).to be_nil
       expect(result.created_at).to eq("2017-03-03T13:49:58Z")
       expect(result.updated_at).to eq("2017-03-03T13:49:58Z")
     end

data/spec/dnsimple/client/domains_email_forwards_spec.rb

@@ -99,6 +99,7 @@ describe Dnsimple::Client, ".domains" do
 
   describe "#create_email_forward" do
     let(:account_id) { 1010 }
+    let(:attributes) { { from: "jim", to: "jim@another.com" } }
     let(:domain_id) { "example.com" }
 
     before do
@@ -106,7 +107,6 @@ describe Dnsimple::Client, ".domains" do
           .to_return(read_http_fixture("createEmailForward/created.http"))
     end
 
-    let(:attributes) { { from: "jim", to: "jim@another.com" } }
 
     it "builds the correct request" do
       subject.create_email_forward(account_id, domain_id, attributes)
@@ -129,7 +129,7 @@ describe Dnsimple::Client, ".domains" do
   describe "#email_forward" do
     let(:account_id) { 1010 }
     let(:domain_id) { "example.com" }
-    let(:email_forward_id) { 17706 }
+    let(:email_forward_id) { 41872 }
 
     before do
       stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/email_forwards.+$})
@@ -149,12 +149,12 @@ describe Dnsimple::Client, ".domains" do
 
       result = response.data
       expect(result).to be_a(Dnsimple::Struct::EmailForward)
-      expect(result.id).to eq(17706)
-      expect(result.domain_id).to eq(228963)
-      expect(result.from).to eq("jim@a-domain.com")
-      expect(result.to).to eq("jim@another.com")
-      expect(result.created_at).to eq("2016-02-04T14:26:50Z")
-      expect(result.updated_at).to eq("2016-02-04T14:26:50Z")
+      expect(result.id).to eq(41872)
+      expect(result.domain_id).to eq(235146)
+      expect(result.from).to eq("example@dnsimple.xyz")
+      expect(result.to).to eq("example@example.com")
+      expect(result.created_at).to eq("2021-01-25T13:54:40Z")
+      expect(result.updated_at).to eq("2021-01-25T13:54:40Z")
     end
 
     context "when the email forward does not exist" do

data/spec/dnsimple/client/domains_pushes_spec.rb

@@ -8,6 +8,7 @@ describe Dnsimple::Client, ".domains" do
 
   describe "#initiate_push" do
     let(:account_id) { 1010 }
+    let(:attributes) { { new_account_email: "admin@target-account.test" } }
     let(:domain_id) { "example.com" }
 
     before do
@@ -15,7 +16,6 @@ describe Dnsimple::Client, ".domains" do
           .to_return(read_http_fixture("initiatePush/success.http"))
     end
 
-    let(:attributes) { { new_account_email: "admin@target-account.test" } }
 
     it "builds the correct request" do
       subject.initiate_push(account_id, domain_id, attributes)
@@ -88,6 +88,7 @@ describe Dnsimple::Client, ".domains" do
 
   describe "#accept_push" do
     let(:account_id) { 2020 }
+    let(:attributes) { { contact_id: 2 } }
     let(:push_id) { 1 }
 
     before do
@@ -95,7 +96,6 @@ describe Dnsimple::Client, ".domains" do
           .to_return(read_http_fixture("acceptPush/success.http"))
     end
 
-    let(:attributes) { { contact_id: 2 } }
 
     it "builds the correct request" do
       subject.accept_push(account_id, push_id, attributes)

data/spec/dnsimple/client/domains_spec.rb

@@ -98,13 +98,13 @@ describe Dnsimple::Client, ".domains" do
 
   describe "#create_domain" do
     let(:account_id) { 1010 }
+    let(:attributes) { { name: "example.com" } }
 
     before do
       stub_request(:post, %r{/v2/#{account_id}/domains$})
           .to_return(read_http_fixture("createDomain/created.http"))
     end
 
-    let(:attributes) { { name: "example.com" } }
 
     it "builds the correct request" do
       subject.create_domain(account_id, attributes)
@@ -153,7 +153,6 @@ describe Dnsimple::Client, ".domains" do
       expect(result.auto_renew).to be(false)
       expect(result.private_whois).to be(false)
       expect(result.expires_at).to eq("2021-06-05T02:15:00Z")
-      expect(result.expires_on).to eq("2021-06-05")
       expect(result.created_at).to eq("2020-06-04T19:15:14Z")
       expect(result.updated_at).to eq("2020-06-04T19:15:21Z")
     end
@@ -204,31 +203,4 @@ describe Dnsimple::Client, ".domains" do
       end
     end
   end
-
-  describe "#reset_domain_token" do
-    let(:account_id) { 1010 }
-    let(:domain_id) { "example.com" }
-
-    before do
-      stub_request(:post, %r{/v2/#{account_id}/domains/#{domain_id}/token})
-          .to_return(read_http_fixture("resetDomainToken/success.http"))
-    end
-
-    it "builds the correct request" do
-      subject.reset_domain_token(account_id, domain_id)
-
-      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/token")
-          .with(headers: { 'Accept' => 'application/json' })
-    end
-
-    it "returns the domain" do
-      response = subject.reset_domain_token(account_id, domain_id)
-      expect(response).to be_a(Dnsimple::Response)
-
-      result = response.data
-      expect(result).to be_a(Dnsimple::Struct::Domain)
-      expect(result.id).to be_a(Integer)
-    end
-  end
-
 end

data/spec/dnsimple/client/registrar_delegation_spec.rb

@@ -31,13 +31,13 @@ describe Dnsimple::Client, ".registrar" do
 
   describe "#change_domain_delegation" do
     let(:account_id) { 1010 }
+    let(:attributes) { %w(ns1.dnsimple.com ns2.dnsimple.com ns3.dnsimple.com ns4.dnsimple.com) }
 
     before do
       stub_request(:put, %r{/v2/#{account_id}/registrar/domains/.+/delegation$})
           .to_return(read_http_fixture("changeDomainDelegation/success.http"))
     end
 
-    let(:attributes) { %w(ns1.dnsimple.com ns2.dnsimple.com ns3.dnsimple.com ns4.dnsimple.com) }
 
     it "builds the correct request" do
       subject.change_domain_delegation(account_id, domain_name = "example.com", attributes)
@@ -57,13 +57,13 @@ describe Dnsimple::Client, ".registrar" do
 
   describe "#change_domain_delegation_to_vanity" do
     let(:account_id) { 1010 }
+    let(:attributes) { %w(ns1.example.com ns2.example.com) }
 
     before do
       stub_request(:put, %r{/v2/#{account_id}/registrar/domains/.+/delegation/vanity$})
           .to_return(read_http_fixture("changeDomainDelegationToVanity/success.http"))
     end
 
-    let(:attributes) { %w(ns1.example.com ns2.example.com) }
 
     it "builds the correct request" do
       subject.change_domain_delegation_to_vanity(account_id, domain_name = "example.com", attributes)