dnsimple 4.3.0 → 5.1.0

data/spec/dnsimple/client/templates_records_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Dnsimple::Client, ".templates" do

data/spec/dnsimple/client/templates_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Dnsimple::Client, ".templates" do

data/spec/dnsimple/client/tlds_spec.rb

@@ -1,41 +1,43 @@
+# frozen_string_literal: true
+
 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,9 +51,9 @@ 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_truthy
+      expect(response.respond_to?(:page)).to be(true)
       expect(response.page).to eq(1)
       expect(response.per_page).to be_a(Integer)
       expect(response.total_entries).to be_a(Integer)
@@ -66,7 +68,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
 
@@ -98,31 +100,31 @@ describe Dnsimple::Client, ".tlds" do
       expect(result).to be_a(Dnsimple::Struct::Tld)
       expect(result.tld).to eq('com')
       expect(result.tld_type).to eq(1)
-      expect(result.whois_privacy).to eq(true)
-      expect(result.auto_renew_only).to eq(false)
-      expect(result.idn).to eq(true)
+      expect(result.whois_privacy).to be(true)
+      expect(result.auto_renew_only).to be(false)
+      expect(result.idn).to be(true)
       expect(result.minimum_registration).to eq(1)
-      expect(result.registration_enabled).to eq(true)
-      expect(result.renewal_enabled).to eq(true)
-      expect(result.transfer_enabled).to eq(true)
+      expect(result.registration_enabled).to be(true)
+      expect(result.renewal_enabled).to be(true)
+      expect(result.transfer_enabled).to be(true)
     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 +134,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 +151,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/vanity_name_servers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Dnsimple::Client, ".vanity_name_servers" do

data/spec/dnsimple/client/webhooks_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Dnsimple::Client, ".webhooks" do

data/spec/dnsimple/client/zones_distributions_spec.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+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

data/spec/dnsimple/client/zones_records_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Dnsimple::Client, ".zones" do
@@ -5,7 +7,7 @@ describe Dnsimple::Client, ".zones" do
   subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").zones }
 
 
-  describe "#records" do
+  describe "#list_zone_records" do
     let(:account_id) { 1010 }
     let(:zone_id) { "example.com" }
 
@@ -15,38 +17,38 @@ describe Dnsimple::Client, ".zones" do
     end
 
     it "builds the correct request" do
-      subject.records(account_id, zone_id)
+      subject.list_zone_records(account_id, zone_id)
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/records")
           .with(headers: { 'Accept' => 'application/json' })
     end
 
     it "supports pagination" do
-      subject.records(account_id, zone_id, page: 2)
+      subject.list_zone_records(account_id, zone_id, page: 2)
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/records?page=2")
     end
 
     it "supports extra request options" do
-      subject.records(account_id, zone_id, query: { foo: "bar" })
+      subject.list_zone_records(account_id, zone_id, query: { foo: "bar" })
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/records?foo=bar")
     end
 
     it "supports sorting" do
-      subject.records(account_id, zone_id, sort: "type:asc")
+      subject.list_zone_records(account_id, zone_id, sort: "type:asc")
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/records?sort=type:asc")
     end
 
     it "supports filtering" do
-      subject.records(account_id, zone_id, filter: { type: "A" })
+      subject.list_zone_records(account_id, zone_id, filter: { type: "A" })
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/records?type=A")
     end
 
     it "returns the records" do
-      response = subject.records(account_id, zone_id)
+      response = subject.list_zone_records(account_id, zone_id)
 
       expect(response).to be_a(Dnsimple::PaginatedResponse)
       expect(response.data).to be_a(Array)
@@ -60,9 +62,9 @@ describe Dnsimple::Client, ".zones" do
     end
 
     it "exposes the pagination information" do
-      response = subject.records(account_id, zone_id)
+      response = subject.list_zone_records(account_id, zone_id)
 
-      expect(response.respond_to?(:page)).to be_truthy
+      expect(response.respond_to?(:page)).to be(true)
       expect(response.page).to eq(1)
       expect(response.per_page).to be_a(Integer)
       expect(response.total_entries).to be_a(Integer)
@@ -75,13 +77,13 @@ describe Dnsimple::Client, ".zones" do
             .to_return(read_http_fixture("notfound-zone.http"))
 
         expect {
-          subject.records(account_id, zone_id)
+          subject.list_zone_records(account_id, zone_id)
         }.to raise_error(Dnsimple::NotFoundError)
       end
     end
   end
 
-  describe "#all_records" do
+  describe "#all_zone_records" do
     before do
       stub_request(:get, %r{/v2/#{account_id}/zones/#{zone_id}/records})
           .to_return(read_http_fixture("listZoneRecords/success.http"))
@@ -91,24 +93,24 @@ describe Dnsimple::Client, ".zones" do
     let(:zone_id) { "example.com" }
 
     it "delegates to client.paginate" do
-      expect(subject).to receive(:paginate).with(:records, account_id, zone_id, foo: "bar")
-      subject.all_records(account_id, zone_id, foo: "bar")
+      expect(subject).to receive(:paginate).with(:list_zone_records, account_id, zone_id, foo: "bar")
+      subject.all_zone_records(account_id, zone_id, foo: "bar")
     end
 
     it "supports sorting" do
-      subject.all_records(account_id, zone_id, sort: "type:asc")
+      subject.all_zone_records(account_id, zone_id, sort: "type:asc")
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/records?page=1&per_page=100&sort=type:asc")
     end
 
     it "supports filtering" do
-      subject.all_records(account_id, zone_id, filter: { name: "foo", type: "AAAA" })
+      subject.all_zone_records(account_id, zone_id, filter: { name: "foo", type: "AAAA" })
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/records?page=1&per_page=100&name=foo&type=AAAA")
     end
   end
 
-  describe "#create_record" do
+  describe "#create_zone_record" do
     let(:account_id) { 1010 }
     let(:zone_id) { "example.com" }
 
@@ -120,7 +122,7 @@ describe Dnsimple::Client, ".zones" do
     let(:attributes) { { type: "A", name: "www", content: "127.0.0.1", regions: %w(global) } }
 
     it "builds the correct request" do
-      subject.create_record(account_id, zone_id, attributes)
+      subject.create_zone_record(account_id, zone_id, attributes)
 
       expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/records")
           .with(body: attributes)
@@ -128,7 +130,7 @@ describe Dnsimple::Client, ".zones" do
     end
 
     it "returns the record" do
-      response = subject.create_record(account_id, zone_id, attributes)
+      response = subject.create_zone_record(account_id, zone_id, attributes)
       expect(response).to be_a(Dnsimple::Response)
 
       result = response.data
@@ -146,13 +148,13 @@ describe Dnsimple::Client, ".zones" do
             .to_return(read_http_fixture("notfound-zone.http"))
 
         expect {
-          subject.create_record(account_id, zone_id, attributes)
+          subject.create_zone_record(account_id, zone_id, attributes)
         }.to raise_error(Dnsimple::NotFoundError)
       end
     end
   end
 
-  describe "#record" do
+  describe "#zone_record" do
     let(:account_id) { 1010 }
     let(:zone_id) { "example.com" }
     let(:record_id) { 5 }
@@ -163,14 +165,14 @@ describe Dnsimple::Client, ".zones" do
     end
 
     it "builds the correct request" do
-      subject.record(account_id, zone_id, record_id)
+      subject.zone_record(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}")
           .with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns the record" do
-      response = subject.record(account_id, zone_id, record_id)
+      response = subject.zone_record(account_id, zone_id, record_id)
       expect(response).to be_a(Dnsimple::Response)
 
       result = response.data
@@ -183,7 +185,7 @@ describe Dnsimple::Client, ".zones" do
       expect(result.content).to eq("mxa.example.com")
       expect(result.ttl).to eq(600)
       expect(result.priority).to eq(10)
-      expect(result.system_record).to eq(false)
+      expect(result.system_record).to be(false)
       expect(result.regions).to eq(%w(SV1 IAD))
       expect(result.created_at).to eq("2016-10-05T09:51:35Z")
       expect(result.updated_at).to eq("2016-10-05T09:51:35Z")
@@ -195,7 +197,7 @@ describe Dnsimple::Client, ".zones" do
             .to_return(read_http_fixture("notfound-zone.http"))
 
         expect {
-          subject.record(account_id, zone_id, "0")
+          subject.zone_record(account_id, zone_id, "0")
         }.to raise_error(Dnsimple::NotFoundError)
       end
     end
@@ -206,13 +208,13 @@ describe Dnsimple::Client, ".zones" do
             .to_return(read_http_fixture("notfound-record.http"))
 
         expect {
-          subject.record(account_id, zone_id, "0")
+          subject.zone_record(account_id, zone_id, "0")
         }.to raise_error(Dnsimple::NotFoundError)
       end
     end
   end
 
-  describe "#update_record" do
+  describe "#update_zone_record" do
     let(:account_id) { 1010 }
     let(:zone_id) { "example.com" }
     let(:record_id) { 5 }
@@ -225,7 +227,7 @@ describe Dnsimple::Client, ".zones" do
     let(:attributes) { { content: "mxb.example.com", priority: "20", regions: ['global'] } }
 
     it "builds the correct request" do
-      subject.update_record(account_id, zone_id, record_id, attributes)
+      subject.update_zone_record(account_id, zone_id, record_id, attributes)
 
       expect(WebMock).to have_requested(:patch, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/records/#{record_id}")
           .with(body: attributes)
@@ -233,7 +235,7 @@ describe Dnsimple::Client, ".zones" do
     end
 
     it "returns the record" do
-      response = subject.update_record(account_id, zone_id, record_id, attributes)
+      response = subject.update_zone_record(account_id, zone_id, record_id, attributes)
       expect(response).to be_a(Dnsimple::Response)
 
       result = response.data
@@ -250,7 +252,7 @@ describe Dnsimple::Client, ".zones" do
             .to_return(read_http_fixture("notfound-zone.http"))
 
         expect {
-          subject.update_record(account_id, zone_id, "0", {})
+          subject.update_zone_record(account_id, zone_id, "0", {})
         }.to raise_error(Dnsimple::NotFoundError)
       end
     end
@@ -261,13 +263,13 @@ describe Dnsimple::Client, ".zones" do
             .to_return(read_http_fixture("notfound-record.http"))
 
         expect {
-          subject.update_record(account_id, zone_id, "0", {})
+          subject.update_zone_record(account_id, zone_id, "0", {})
         }.to raise_error(Dnsimple::NotFoundError)
       end
     end
   end
 
-  describe "#delete_record" do
+  describe "#delete_zone_record" do
     let(:account_id) { 1010 }
     let(:zone_id) { "example.com" }
 
@@ -277,14 +279,14 @@ describe Dnsimple::Client, ".zones" do
     end
 
     it "builds the correct request" do
-      subject.delete_record(account_id, zone_id, record_id = 2)
+      subject.delete_zone_record(account_id, zone_id, record_id = 2)
 
       expect(WebMock).to have_requested(:delete, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/records/#{record_id}")
           .with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns nothing" do
-      response = subject.delete_record(account_id, zone_id, 2)
+      response = subject.delete_zone_record(account_id, zone_id, 2)
       expect(response).to be_a(Dnsimple::Response)
 
       result = response.data
@@ -297,7 +299,7 @@ describe Dnsimple::Client, ".zones" do
             .to_return(read_http_fixture("notfound-zone.http"))
 
         expect {
-          subject.delete_record(account_id, zone_id, "0")
+          subject.delete_zone_record(account_id, zone_id, "0")
         }.to raise_error(Dnsimple::NotFoundError)
       end
     end
@@ -308,7 +310,7 @@ describe Dnsimple::Client, ".zones" do
             .to_return(read_http_fixture("notfound-record.http"))
 
         expect {
-          subject.delete_record(account_id, zone_id, "0")
+          subject.delete_zone_record(account_id, zone_id, "0")
         }.to raise_error(Dnsimple::NotFoundError)
       end
     end