dnsimple 3.0.0 → 3.1.0

data/spec/dnsimple/client/templates_records_spec.rb

@@ -0,0 +1,226 @@
+require 'spec_helper'
+
+describe Dnsimple::Client, ".templates" do
+
+  subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").templates }
+
+
+  describe "#list_records" do
+    let(:account_id) { 1010 }
+    let(:template_id) { "alpha" }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/templates/#{template_id}/records}).
+          to_return(read_http_fixture("listTemplateRecords/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.records(account_id, template_id)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/templates/#{template_id}/records").
+          with(headers: { "Accept" => "application/json" })
+    end
+
+    it "supports pagination" do
+      subject.records(account_id, template_id, page: 2)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/templates/#{template_id}/records?page=2")
+    end
+
+    it "supports extra request options" do
+      subject.records(account_id, template_id, query: { foo: "bar" })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/templates/#{template_id}/records?foo=bar")
+    end
+
+    it "supports sorting" do
+      subject.records(account_id, template_id, sort: "type:asc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/templates/#{template_id}/records?sort=type:asc")
+    end
+
+    it "returns the list of template's records" do
+      response = subject.records(account_id, template_id)
+      expect(response).to be_a(Dnsimple::PaginatedResponse)
+
+      response.data.each do |result|
+        expect(result).to be_a(Dnsimple::Struct::TemplateRecord)
+        expect(result.id).to be_a(Fixnum)
+        expect(result.type).to be_a(String)
+        expect(result.name).to be_a(String)
+        expect(result.content).to be_a(String)
+      end
+    end
+  end
+
+  describe "#all_templates" do
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/templates/#{template_id}/records}).
+          to_return(read_http_fixture("listTemplateRecords/success.http"))
+    end
+
+    let(:account_id) { 1010 }
+    let(:template_id) { "alpha" }
+
+    it "delegates to client.paginate" do
+      expect(subject).to receive(:paginate).with(:records, account_id, template_id, option: "value")
+      subject.all_records(account_id, template_id, option: "value")
+    end
+
+    it "supports sorting" do
+      subject.all_records(account_id, template_id, sort: "type:asc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/templates/#{template_id}/records?page=1&per_page=100&sort=type:asc")
+    end
+  end
+
+  describe "#create_record" do
+    let(:account_id) { 1010 }
+    let(:template_id) { "alpha" }
+
+    before do
+      stub_request(:post, %r{/v2/#{account_id}/templates/#{template_id}/records$}).
+          to_return(read_http_fixture("createTemplateRecord/created.http"))
+    end
+
+    let(:attributes) { { type: "MX", name: "", content: "mx.example.com", priority: 10, ttl: 600 } }
+
+    it "builds the correct request" do
+      subject.create_record(account_id, template_id, attributes)
+
+      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/templates/#{template_id}/records").
+          with(body: attributes).
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the record" do
+      response = subject.create_record(account_id, template_id, attributes)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::TemplateRecord)
+      expect(result.id).to eq(300)
+      expect(result.template_id).to eq(268)
+      expect(result.name).to eq("")
+      expect(result.type).to eq("MX")
+      expect(result.content).to eq("mx.example.com")
+      expect(result.ttl).to eq(600)
+      expect(result.priority).to eq(10)
+      expect(result.created_at).to eq("2016-05-03T07:51:33.202Z")
+      expect(result.updated_at).to eq("2016-05-03T07:51:33.202Z")
+    end
+
+    context "with missing data" do
+      it "raises an error when the type is missing" do
+        expect {
+          subject.create_record(account_id, template_id, name: "", content: "192.168.1.1")
+        }.to raise_error(ArgumentError)
+      end
+
+      it "raises an error when the name is missing" do
+        expect {
+          subject.create_record(account_id, template_id, type: "A", content: "192.168.1.1")
+        }.to raise_error(ArgumentError)
+      end
+
+      it "raises an error when the content is missing" do
+        expect {
+          subject.create_record(account_id, template_id, type: "A", name: "")
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when the template does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:post, %r{/v2}).
+            to_return(read_http_fixture("notfound-template.http"))
+
+        expect {
+          subject.create_record(account_id, template_id, attributes)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+  describe "#record" do
+    let(:account_id) { 1010 }
+    let(:template_id) { "alpha.com" }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/templates/#{template_id}/records/.+$}).
+          to_return(read_http_fixture("getTemplateRecord/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.record(account_id, template_id, record_id = 301)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/templates/#{template_id}/records/#{record_id}").
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the record" do
+      response = subject.record(account_id, template_id, 301)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::TemplateRecord)
+      expect(result.id).to eq(301)
+      expect(result.template_id).to eq(268)
+      expect(result.type).to eq("MX")
+      expect(result.name).to eq("")
+      expect(result.content).to eq("mx.example.com")
+      expect(result.ttl).to eq(600)
+      expect(result.priority).to eq(10)
+      expect(result.created_at).to eq("2016-05-03T08:03:26.444Z")
+      expect(result.updated_at).to eq("2016-05-03T08:03:26.444Z")
+    end
+  end
+
+  describe "#delete_record" do
+    let(:account_id) { 1010 }
+    let(:template_id) { "example.com" }
+
+    before do
+      stub_request(:delete, %r{/v2/#{account_id}/templates/#{template_id}/records/.+$}).
+          to_return(read_http_fixture("deleteTemplateRecord/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.delete_record(account_id, template_id, record_id = 301)
+
+      expect(WebMock).to have_requested(:delete, "https://api.dnsimple.test/v2/#{account_id}/templates/#{template_id}/records/#{record_id}").
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns nothing" do
+      response = subject.delete_record(account_id, template_id, 301)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_nil
+    end
+
+    context "when the template does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:delete, %r{/v2}).
+            to_return(read_http_fixture("notfound-template.http"))
+
+        expect {
+          subject.delete_record(account_id, template_id, 0)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+
+    context "when the record does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:delete, %r{/v2}).
+            to_return(read_http_fixture("notfound-record.http"))
+
+        expect {
+          subject.delete_record(account_id, template_id, 0)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+end

data/spec/dnsimple/client/templates_spec.rb

@@ -9,7 +9,7 @@ describe Dnsimple::Client, ".templates" do
     let(:account_id) { 1010 }
 
     before do
-      stub_request(:get, %r{/v2/#{account_id}/templates$}).
+      stub_request(:get, %r{/v2/#{account_id}/templates}).
           to_return(read_http_fixture("listTemplates/success.http"))
     end
 
@@ -20,6 +20,24 @@ describe Dnsimple::Client, ".templates" do
           with(headers: { "Accept" => "application/json" })
     end
 
+    it "supports pagination" do
+      subject.templates(account_id, page: 2)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/templates?page=2")
+    end
+
+    it "supports extra request options" do
+      subject.templates(account_id, query: { foo: "bar" })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/templates?foo=bar")
+    end
+
+    it "supports sorting" do
+      subject.templates(account_id, sort: "short_name:desc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/templates?sort=short_name:desc")
+    end
+
     it "returns the list of templates" do
       response = subject.list_templates(account_id)
       expect(response).to be_a(Dnsimple::CollectionResponse)
@@ -36,12 +54,23 @@ describe Dnsimple::Client, ".templates" do
   end
 
   describe "#all_templates" do
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/templates}).
+          to_return(read_http_fixture("listTemplates/success.http"))
+    end
+
     let(:account_id) { 1010 }
 
     it "delegates to client.paginate" do
       expect(subject).to receive(:paginate).with(:templates, account_id, foo: "bar")
       subject.all_templates(account_id, foo: "bar")
     end
+
+    it "supports sorting" do
+      subject.all_templates(account_id, sort: "short_name:desc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/templates?page=1&per_page=100&sort=short_name:desc")
+    end
   end
 
   describe "#create_template" do

data/spec/dnsimple/client/tlds_spec.rb

@@ -17,7 +17,7 @@ describe Dnsimple::Client, ".tlds" do
     end
 
     it "supports pagination" do
-      subject.tlds(query: { page: 2 })
+      subject.tlds(page: 2)
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/tlds?page=2")
     end
@@ -28,6 +28,12 @@ describe Dnsimple::Client, ".tlds" do
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/tlds?foo=bar")
     end
 
+    it "supports sorting" do
+      subject.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
 
@@ -54,10 +60,21 @@ describe Dnsimple::Client, ".tlds" do
   end
 
   describe "#all_tlds" do
+    before do
+      stub_request(:get, %r{/v2/tlds}).
+          to_return(read_http_fixture("listTlds/success.http"))
+    end
+
     it "delegates to client.paginate" do
       expect(subject).to receive(:paginate).with(:tlds, foo: "bar")
       subject.all_tlds(foo: "bar")
     end
+
+    it "supports sorting" do
+      subject.all_tlds(sort: "tld:asc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/tlds?page=1&per_page=100&sort=tld:asc")
+    end
   end
 
   describe "#tld" do

data/spec/dnsimple/client/webhooks_spec.rb

@@ -25,6 +25,12 @@ describe Dnsimple::Client, ".webhooks" do
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/webhooks?foo=bar")
     end
 
+    it "supports sorting" do
+      subject.webhooks(account_id, sort: "id:asc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/webhooks?sort=id:asc")
+    end
+
     it "returns the webhooks" do
       response = subject.webhooks(account_id)
 

data/spec/dnsimple/client/zones_records_spec.rb

@@ -22,7 +22,7 @@ describe Dnsimple::Client, ".zones" do
     end
 
     it "supports pagination" do
-      subject.records(account_id, zone_id, query: { page: 2 })
+      subject.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
@@ -33,6 +33,18 @@ describe Dnsimple::Client, ".zones" do
       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")
+
+      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" })
+
+      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)
 
@@ -69,6 +81,11 @@ describe Dnsimple::Client, ".zones" do
   end
 
   describe "#all_records" do
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/zones/#{zone_id}/records}).
+          to_return(read_http_fixture("listZoneRecords/success.http"))
+    end
+
     let(:account_id) { 1010 }
     let(:zone_id) { "example.com" }
 
@@ -76,6 +93,18 @@ describe Dnsimple::Client, ".zones" do
       expect(subject).to receive(:paginate).with(:records, account_id, zone_id, foo: "bar")
       subject.all_records(account_id, zone_id, foo: "bar")
     end
+
+    it "supports sorting" do
+      subject.all_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" })
+
+      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

data/spec/dnsimple/client/zones_spec.rb

@@ -21,7 +21,7 @@ describe Dnsimple::Client, ".zones" do
     end
 
     it "supports pagination" do
-      subject.zones(account_id, query: { page: 2 })
+      subject.zones(account_id, page: 2)
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones?page=2")
     end
@@ -32,6 +32,18 @@ describe Dnsimple::Client, ".zones" do
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones?foo=bar")
     end
 
+    it "supports sorting" do
+      subject.zones(account_id, sort: "name:desc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones?sort=name:desc")
+    end
+
+    it "supports filtering" do
+      subject.zones(account_id, filter: { name_like: "example" })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones?name_like=example")
+    end
+
     it "returns the zones" do
       response = subject.zones(account_id)
 
@@ -57,12 +69,29 @@ describe Dnsimple::Client, ".zones" do
   end
 
   describe "#all_zones" do
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/zones}).
+          to_return(read_http_fixture("listZones/success.http"))
+    end
+
     let(:account_id) { 1010 }
 
     it "delegates to client.paginate" do
       expect(subject).to receive(:paginate).with(:zones, account_id, foo: "bar")
       subject.all_zones(account_id, foo: "bar")
     end
+
+    it "supports sorting" do
+      subject.all_zones(account_id, sort: "name:desc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones?page=1&per_page=100&sort=name:desc")
+    end
+
+    it "supports sorting" do
+      subject.all_zones(account_id, filter: { name_like: "zone.test" })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones?page=1&per_page=100&name_like=zone.test")
+    end
   end
 
   describe "#zone" do