dnsimple 4.4.0 → 4.5.0

data/lib/dnsimple/client/webhooks.rb

@@ -28,7 +28,6 @@ module Dnsimple
 
         Dnsimple::CollectionResponse.new(response, response["data"].map { |r| Struct::Webhook.new(r) })
       end
-      alias list webhooks
       alias list_webhooks webhooks
 
       # Creates a webhook in the account.
@@ -47,7 +46,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Webhook.new(response["data"]))
       end
-      alias create create_webhook
 
       # Gets a webhook from the account.
       #
@@ -84,7 +82,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
-      alias delete delete_webhook
 
     end
   end

data/lib/dnsimple/client/zones.rb

@@ -33,7 +33,6 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Zone.new(r) })
       end
-      alias list zones
       alias list_zones zones
 
       # Lists ALL the zones in the account.

data/lib/dnsimple/client/zones_distributions.rb

@@ -0,0 +1,47 @@
+module Dnsimple
+  class Client
+    module ZonesDistributions
+
+      # Checks if a zone change is fully distributed to all DNSimple name
+      # servers across the globe.
+      #
+      # @see https://developer.dnsimple.com/v2/zones/#checkZoneDistribution
+      #
+      # @param  account_id [Integer] the account ID
+      # @param  zone_id [#to_s] the zone name
+      # @param  options [Hash]
+      # @return [Dnsimple::Response<Dnsimple::Struct::ZoneDistribution>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def zone_distribution(account_id, zone_id, options = {})
+        response = client.get(Client.versioned("/%s/zones/%s/distribution" % [account_id, zone_id]), options)
+
+        Dnsimple::Response.new(response, Struct::ZoneDistribution.new(response["data"]))
+      end
+
+      # Checks if a zone record is fully distributed to all DNSimple name
+      # servers across the globe.
+      #
+      # @see https://developer.dnsimple.com/v2/zones/records/#checkZoneRecordDistribution
+      #
+      # @example Get record 123 in zone "example.com"
+      #   client.zones.zone_record_distribution(1010, "example.com", 123)
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [String] zone_id the zone name
+      # @param  [Integer] record_id the record ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::ZoneDistribution>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def zone_record_distribution(account_id, zone_id, record_id, options = {})
+        response = client.get(Client.versioned("/%s/zones/%s/records/%s/distribution" % [account_id, zone_id, record_id]), options)
+
+        Dnsimple::Response.new(response, Struct::ZoneDistribution.new(response["data"]))
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/zones_records.rb

@@ -4,20 +4,20 @@ module Dnsimple
 
       # Lists the zone records in the account.
       #
-      # @see https://developer.dnsimple.com/v2/zones/records/#list
+      # @see https://developer.dnsimple.com/v2/zones/records/#listZoneRecords
       # @see #all_records
       #
       # @example List records for the zone "example.com" in the first page
-      #   client.zones.records(1010, "example.com")
+      #   client.zones.list_zone_records(1010, "example.com")
       #
       # @example List records for the zone "example.com", provide a specific page
-      #   client.zones.records(1010, "example.com", page: 2)
+      #   client.zones.list_zone_records(1010, "example.com", page: 2)
       #
       # @example List records for the zone "example.com", sorting in ascending order
-      #   client.zones.records(1010, "example.com", sort: "type:asc")
+      #   client.zones.list_zone_records(1010, "example.com", sort: "type:asc")
       #
       # @example List records for the zone "example.com", filtering by 'A' record type
-      #   client.zones.records(1010, "example.com", filter: { type: 'A' })
+      #   client.zones.list_zone_records(1010, "example.com", filter: { type: 'A' })
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -30,13 +30,12 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def records(account_id, zone_id, options = {})
+      def zone_records(account_id, zone_id, options = {})
         response = client.get(Client.versioned("/%s/zones/%s/records" % [account_id, zone_id]), Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::ZoneRecord.new(r) })
       end
-      alias list records
-      alias list_records records
+      alias list_zone_records zone_records
 
       # Lists ALL the zone records in the account.
       #
@@ -46,11 +45,11 @@ module Dnsimple
       # Please use this method carefully, as fetching the entire collection will increase the number of requests
       # you send to the API server and you may eventually risk to hit the throttle limit.
       #
-      # @see https://developer.dnsimple.com/v2/zones/records/#list
+      # @see https://developer.dnsimple.com/v2/zones/records/#listZoneRecords
       # @see #records
       #
       # @example List all records for the zone "example.com"
-      #   client.zones.all_records(1010, "example.com")
+      #   client.zones.all_zone_records(1010, "example.com")
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -63,17 +62,16 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def all_records(account_id, zone_id, options = {})
-        paginate(:records, account_id, zone_id, options)
+      def all_zone_records(account_id, zone_id, options = {})
+        paginate(:list_zone_records, account_id, zone_id, options)
       end
-      alias all all_records
 
       # Creates a zone record in the account.
       #
-      # @see https://developer.dnsimple.com/v2/zones/records/#create
+      # @see https://developer.dnsimple.com/v2/zones/records/#createZoneRecord
       #
       # @example Create a URL record in zone "example.com"
-      #   client.zones.create_record(1010, "example.com", name: "www", type: "url", content: "example.com")
+      #   client.zones.create_zone_record(1010, "example.com", name: "www", type: "url", content: "example.com")
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -83,20 +81,19 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def create_record(account_id, zone_id, attributes, options = {})
+      def create_zone_record(account_id, zone_id, attributes, options = {})
         Extra.validate_mandatory_attributes(attributes, [:type, :name, :content])
         response = client.post(Client.versioned("/%s/zones/%s/records" % [account_id, zone_id]), attributes, options)
 
         Dnsimple::Response.new(response, Struct::ZoneRecord.new(response["data"]))
       end
-      alias create create_record
 
       # Gets a zone record from the account.
       #
-      # @see https://developer.dnsimple.com/v2/zones/records/#get
+      # @see https://developer.dnsimple.com/v2/zones/records/#getZoneRecord
       #
       # @example Get record 123 in zone "example.com"
-      #   client.zones.record(1010, "example.com", 123)
+      #   client.zones.zone_record(1010, "example.com", 123)
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -106,7 +103,7 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def record(account_id, zone_id, record_id, options = {})
+      def zone_record(account_id, zone_id, record_id, options = {})
         response = client.get(Client.versioned("/%s/zones/%s/records/%s" % [account_id, zone_id, record_id]), options)
 
         Dnsimple::Response.new(response, Struct::ZoneRecord.new(response["data"]))
@@ -114,10 +111,10 @@ module Dnsimple
 
       # Updates a zone record in the account.
       #
-      # @see https://developer.dnsimple.com/v2/zones/records/#update
+      # @see https://developer.dnsimple.com/v2/zones/records/#updateZoneRecord
       #
       # @example Update the TTL to 600 of record 123 in zone "example.com"
-      #   client.zones.update_record(1010, "example.com", 123, ttl: 600)
+      #   client.zones.update_zone_record(1010, "example.com", 123, ttl: 600)
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -128,21 +125,20 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def update_record(account_id, zone_id, record_id, attributes, options = {})
+      def update_zone_record(account_id, zone_id, record_id, attributes, options = {})
         response = client.patch(Client.versioned("/%s/zones/%s/records/%s" % [account_id, zone_id, record_id]), attributes, options)
 
         Dnsimple::Response.new(response, Struct::ZoneRecord.new(response["data"]))
       end
-      alias update update_record
 
       # Deletes a zone record from the account.
       #
       # WARNING: this cannot be undone.
       #
-      # @see https://developer.dnsimple.com/v2/zones/records/#delete
+      # @see https://developer.dnsimple.com/v2/zones/records/#deleteZoneRecord
       #
       # @example Delete record 123 in zone "example.com"
-      #   client.zones.delete_record(1010, "example.com", 123)
+      #   client.zones.delete_zone_record(1010, "example.com", 123)
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -152,12 +148,11 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def delete_record(account_id, zone_id, record_id, options = {})
+      def delete_zone_record(account_id, zone_id, record_id, options = {})
         response = client.delete(Client.versioned("/%s/zones/%s/records/%s" % [account_id, zone_id, record_id]), nil, options)
 
         Dnsimple::Response.new(response, nil)
       end
-      alias delete delete_record
 
     end
   end

data/lib/dnsimple/struct.rb

@@ -38,8 +38,10 @@ require_relative 'struct/template'
 require_relative 'struct/template_record'
 require_relative 'struct/tld'
 require_relative 'struct/user'
+require_relative 'struct/vanity_name_server'
 require_relative 'struct/whois_privacy'
 require_relative 'struct/zone'
 require_relative 'struct/zone_file'
+require_relative 'struct/zone_distribution'
 require_relative 'struct/webhook'
 require_relative 'struct/whoami'

data/lib/dnsimple/struct/vanity_name_server.rb

@@ -0,0 +1,25 @@
+module Dnsimple
+  module Struct
+
+    class VanityNameServer < Base
+      # @return [Integer] The vanity name server ID in DNSimple.
+      attr_accessor :id
+
+      # @return [String] The vanity name server name.
+      attr_accessor :name
+
+      # @return [String] The vanity name server IPv4.
+      attr_accessor :ipv4
+
+      # @return [String] The vanity name server IPv6.
+      attr_accessor :ipv6
+
+      # @return [String] When the vanity name server was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the vanity name server was last updated in DNSimple.
+      attr_accessor :updated_at
+    end
+
+  end
+end

data/lib/dnsimple/struct/zone_distribution.rb

@@ -0,0 +1,11 @@
+module Dnsimple
+  module Struct
+
+    class ZoneDistribution < Base
+      # @return [Boolean] true if the zone is properly distributed across
+      #         all DNSimple name servers.
+      attr_accessor :distributed
+    end
+
+  end
+end

data/lib/dnsimple/version.rb

@@ -1,3 +1,3 @@
 module Dnsimple
-  VERSION = "4.4.0".freeze
+  VERSION = "4.5.0".freeze
 end

data/spec/dnsimple/client/registrar_delegation_spec.rb

@@ -75,8 +75,9 @@ describe Dnsimple::Client, ".registrar" do
       response = subject.change_domain_delegation_to_vanity(account_id, "example.com", attributes)
       expect(response).to be_a(Dnsimple::Response)
 
-      vanity_name_servers = response.data.map { |ns| ns["name"] }
-      expect(vanity_name_servers).to match_array(%w(ns1.example.com ns2.example.com))
+      vanity_name_server = response.data.first
+      expect(vanity_name_server).to be_a(Dnsimple::Struct::VanityNameServer)
+      expect(vanity_name_server.name).to eq("ns1.example.com")
     end
   end
 

data/spec/dnsimple/client/tlds_spec.rb

@@ -3,39 +3,39 @@ require 'spec_helper'
 describe Dnsimple::Client, ".tlds" do
   subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").tlds }
 
-  describe "#tlds" do
+  describe "#list_tlds" do
     before do
       stub_request(:get, %r{/v2/tlds})
           .to_return(read_http_fixture("listTlds/success.http"))
     end
 
     it "builds the correct request" do
-      subject.tlds
+      subject.list_tlds
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/tlds")
           .with(headers: { 'Accept' => 'application/json' })
     end
 
     it "supports pagination" do
-      subject.tlds(page: 2)
+      subject.list_tlds(page: 2)
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/tlds?page=2")
     end
 
     it "supports additional options" do
-      subject.tlds(query: { foo: "bar" })
+      subject.list_tlds(query: { foo: "bar" })
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/tlds?foo=bar")
     end
 
     it "supports sorting" do
-      subject.tlds(sort: "tld:asc")
+      subject.list_tlds(sort: "tld:asc")
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/tlds?sort=tld:asc")
     end
 
     it "returns the tlds" do
-      response = subject.tlds
+      response = subject.list_tlds
 
       expect(response).to be_a(Dnsimple::PaginatedResponse)
       expect(response.data).to be_an(Array)
@@ -49,7 +49,7 @@ describe Dnsimple::Client, ".tlds" do
     end
 
     it "exposes the pagination information" do
-      response = subject.tlds
+      response = subject.list_tlds
 
       expect(response.respond_to?(:page)).to be(true)
       expect(response.page).to eq(1)
@@ -66,7 +66,7 @@ describe Dnsimple::Client, ".tlds" do
     end
 
     it "delegates to client.paginate" do
-      expect(subject).to receive(:paginate).with(:tlds, foo: "bar")
+      expect(subject).to receive(:paginate).with(:list_tlds, foo: "bar")
       subject.all_tlds(foo: "bar")
     end
 
@@ -108,21 +108,21 @@ describe Dnsimple::Client, ".tlds" do
     end
   end
 
-  describe "#extended_attributes" do
+  describe "#tld_extended_attributes" do
     before do
       stub_request(:get, %r{/v2/tlds/uk/extended_attributes$})
           .to_return(read_http_fixture("getTldExtendedAttributes/success.http"))
     end
 
     it "builds the correct request" do
-      subject.extended_attributes(tld = "uk")
+      subject.tld_extended_attributes(tld = "uk")
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/tlds/#{tld}/extended_attributes")
           .with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns the extended attributes" do
-      response = subject.extended_attributes("uk")
+      response = subject.tld_extended_attributes("uk")
       expect(response).to be_a(Dnsimple::CollectionResponse)
 
       response.data.each do |result|
@@ -132,6 +132,7 @@ describe Dnsimple::Client, ".tlds" do
         expect(result).to respond_to(:required)
 
         next if result.options.empty?
+
         result.options.each do |option|
           expect(option).to be_a(Dnsimple::Struct::ExtendedAttribute::Option)
           expect(option.title).to be_a(String)
@@ -148,7 +149,7 @@ describe Dnsimple::Client, ".tlds" do
       end
 
       it "returns an empty CollectionResponse" do
-        response = subject.extended_attributes("com")
+        response = subject.tld_extended_attributes("com")
         expect(response).to be_a(Dnsimple::CollectionResponse)
 
         result = response.data

data/spec/dnsimple/client/zones_distributions_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe Dnsimple::Client, ".zones" do
+
+  subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").zones }
+
+  describe "#zone_distribution" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/zones/.+$})
+          .to_return(read_http_fixture("checkZoneDistribution/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.zone_distribution(account_id, zone = "example.com")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone}/distribution")
+          .with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the zone distribution check with true when the zone is fully distributed" do
+      response = subject.zone_distribution(account_id, "example.com")
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::ZoneDistribution)
+      expect(result.distributed).to be(true)
+    end
+
+    it "returns the zone distribution check with false when the zone isn't fully distributed" do
+      stub_request(:get, %r{/v2/#{account_id}/zones/.+$})
+          .to_return(read_http_fixture("checkZoneDistribution/failure.http"))
+
+      response = subject.zone_distribution(account_id, "example.com")
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::ZoneDistribution)
+      expect(result.distributed).to be(false)
+    end
+
+    it "raises an error when the server wasn't able to complete the check" do
+      stub_request(:get, %r{/v2/#{account_id}/zones/.+$})
+          .to_return(read_http_fixture("checkZoneDistribution/error.http"))
+
+      expect {
+        subject.zone_distribution(account_id, "example.com")
+      }.to raise_error(Dnsimple::RequestError, "Could not query zone, connection timed out")
+    end
+
+    context "when the zone does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:get, %r{/v2})
+            .to_return(read_http_fixture("notfound-zone.http"))
+
+        expect {
+          subject.zone_distribution(account_id, "example.com")
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+
+  describe "#zone_record_distribution" do
+    let(:account_id) { 1010 }
+    let(:zone_id) { "example.com" }
+    let(:record_id) { 5 }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/zones/#{zone_id}/records/#{record_id}/distribution$})
+          .to_return(read_http_fixture("checkZoneRecordDistribution/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.zone_record_distribution(account_id, zone_id, record_id)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/records/#{record_id}/distribution")
+          .with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the zone record distribution check with true when the zone is fully distributed" do
+      response = subject.zone_record_distribution(account_id, zone_id, record_id)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::ZoneDistribution)
+      expect(result.distributed).to be(true)
+    end
+
+    it "returns the zone distribution check with false when the zone isn't fully distributed" do
+      stub_request(:get, %r{/v2/#{account_id}/zones/#{zone_id}/records/#{record_id}/distribution$})
+          .to_return(read_http_fixture("checkZoneRecordDistribution/failure.http"))
+
+      response = subject.zone_record_distribution(account_id, zone_id, record_id)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::ZoneDistribution)
+      expect(result.distributed).to be(false)
+    end
+
+    it "raises an error when the server wasn't able to complete the check" do
+      stub_request(:get, %r{/v2/#{account_id}/zones/#{zone_id}/records/#{record_id}/distribution$})
+          .to_return(read_http_fixture("checkZoneRecordDistribution/error.http"))
+
+      expect {
+        subject.zone_record_distribution(account_id, zone_id, record_id)
+      }.to raise_error(Dnsimple::RequestError, "Could not query zone, connection timed out")
+    end
+
+    context "when the zone does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:get, %r{/v2})
+            .to_return(read_http_fixture("notfound-zone.http"))
+
+        expect {
+          subject.zone_record_distribution(account_id, zone_id, "0")
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+
+    context "when the record does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:get, %r{/v2})
+            .to_return(read_http_fixture("notfound-record.http"))
+
+        expect {
+          subject.zone_record_distribution(account_id, zone_id, "0")
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+end