dnsimple 4.1.0 → 4.2.0

data/lib/dnsimple/client/zones_records.rb

@@ -13,11 +13,11 @@ module Dnsimple
       # @example List records for the zone "example.com", provide a specific page
       #   client.zones.records(1010, "example.com", page: 2)
       #
-      # @example List records for the zone "example.com", provide sorting policy
+      # @example List records for the zone "example.com", sorting in ascending order
       #   client.zones.records(1010, "example.com", sort: "type:asc")
       #
-      # @example List records for the zone "example.com", provide filtering policy
-      #   client.zones.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' })
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name

data/lib/dnsimple/struct.rb

@@ -18,6 +18,8 @@ require_relative 'struct/collaborator'
 require_relative 'struct/contact'
 require_relative 'struct/certificate'
 require_relative 'struct/certificate_bundle'
+require_relative 'struct/delegation_signer_record'
+require_relative 'struct/dnssec'
 require_relative 'struct/domain'
 require_relative 'struct/domain_check'
 require_relative 'struct/domain_premium_price'

data/lib/dnsimple/struct/delegation_signer_record.rb

@@ -0,0 +1,31 @@
+module Dnsimple
+  module Struct
+
+    class DelegationSignerRecord < Base
+      # @return [Integer] The ID of the delegation signer record in DNSimple.
+      attr_accessor :id
+
+      # @return [Integer] The associated domain ID.
+      attr_accessor :domain_id
+
+      # @return [String] The signing algorithm used.
+      attr_accessor :algorithm
+
+      # @return [String] The digest value.
+      attr_accessor :digest
+
+      # @return [String] The digest type used.
+      attr_accessor :digest_type
+
+      # @return [String] The keytag for the associated DNSKEY.
+      attr_accessor :keytag
+
+      # @return [String] When the delegation signing record was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the delegation signing record was last updated in DNSimple.
+      attr_accessor :updated_at
+    end
+
+  end
+end

data/lib/dnsimple/struct/dnssec.rb

@@ -0,0 +1,10 @@
+module Dnsimple
+  module Struct
+
+    class Dnssec < Base
+      # @return [Boolean] True if DNSSEC is enabled on the domain, otherwise false
+      attr_accessor :enabled
+    end
+
+  end
+end

data/lib/dnsimple/version.rb

@@ -1,3 +1,3 @@
 module Dnsimple
-  VERSION = "4.1.0".freeze
+  VERSION = "4.2.0".freeze
 end

data/spec/dnsimple/client/domains_delegation_signer_records_spec.rb

@@ -0,0 +1,209 @@
+require 'spec_helper'
+
+describe Dnsimple::Client, ".domains" do
+
+  subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").domains }
+
+
+  describe "#delegation_signer_records" do
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/ds_records}).
+          to_return(read_http_fixture("listDelegationSignerRecords/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.delegation_signer_records(account_id, domain_id)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/ds_records").
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "supports pagination" do
+      subject.delegation_signer_records(account_id, domain_id, page: 2)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/ds_records?page=2")
+    end
+
+    it "supports extra request options" do
+      subject.delegation_signer_records(account_id, domain_id, query: { foo: "bar" })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/ds_records?foo=bar")
+    end
+
+    it "supports sorting" do
+      subject.delegation_signer_records(account_id, domain_id, sort: "id:asc,from:desc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/ds_records?sort=id:asc,from:desc")
+    end
+
+    it "returns the delegation signer records" do
+      response = subject.delegation_signer_records(account_id, domain_id)
+
+      expect(response).to be_a(Dnsimple::PaginatedResponse)
+      expect(response.data).to be_a(Array)
+      expect(response.data.size).to eq(1)
+
+      response.data.each do |result|
+        expect(result).to be_a(Dnsimple::Struct::DelegationSignerRecord)
+        expect(result.id).to be_a(Integer)
+      end
+    end
+
+    it "exposes the pagination information" do
+      response = subject.delegation_signer_records(account_id, domain_id)
+
+      expect(response.respond_to?(:page)).to be_truthy
+      expect(response.page).to eq(1)
+      expect(response.per_page).to be_a(Integer)
+      expect(response.total_entries).to be_a(Integer)
+      expect(response.total_pages).to be_a(Integer)
+    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.delegation_signer_records(account_id, domain_id)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+  describe "#all_delegation_signer_records" do
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/ds_records}).
+          to_return(read_http_fixture("listDelegationSignerRecords/success.http"))
+    end
+
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+
+    it "delegates to client.paginate" do
+      expect(subject).to receive(:paginate).with(:delegation_signer_records, account_id, domain_id, foo: "bar")
+      subject.all_delegation_signer_records(account_id, domain_id, foo: "bar")
+    end
+
+    it "supports sorting" do
+      subject.all_delegation_signer_records(account_id, domain_id, sort: "id:asc,from:desc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/ds_records?page=1&per_page=100&sort=id:asc,from:desc")
+    end
+  end
+
+  describe "#create_delegation_signer_record" do
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+
+    before do
+      stub_request(:post, %r{/v2/#{account_id}/domains/#{domain_id}/ds_records$}).
+          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)
+
+      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/ds_records").
+          with(body: attributes).
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the delegation signer record" do
+      response = subject.create_delegation_signer_record(account_id, domain_id, attributes)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::DelegationSignerRecord)
+      expect(result.id).to be_a(Integer)
+    end
+  end
+
+  describe "#delegation_signer_record" do
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+    let(:ds_record_id) { 24 }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/ds_records.+$}).
+          to_return(read_http_fixture("getDelegationSignerRecord/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.delegation_signer_record(account_id, domain_id, ds_record_id)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/ds_records/#{ds_record_id}").
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the delegation signer record" do
+      response = subject.delegation_signer_record(account_id, domain_id, ds_record_id)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::DelegationSignerRecord)
+      expect(result.id).to eq(24)
+      expect(result.domain_id).to eq(1010)
+      expect(result.algorithm).to eq("8")
+      expect(result.digest).to eq("C1F6E04A5A61FBF65BF9DC8294C363CF11C89E802D926BDAB79C55D27BEFA94F")
+      expect(result.digest_type).to eq("2")
+      expect(result.keytag).to eq("44620")
+      expect(result.created_at).to eq("2017-03-03T13:49:58Z")
+      expect(result.updated_at).to eq("2017-03-03T13:49:58Z")
+    end
+
+    context "when the delegation signer record does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:get, %r{/v2}).
+            to_return(read_http_fixture("notfound-delegationsignerrecord.http"))
+
+        expect {
+          subject.delegation_signer_record(account_id, domain_id, ds_record_id)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+  describe "#delete_delegation_signer_record" do
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+    let(:ds_record_id) { 1 }
+
+    before do
+      stub_request(:delete, %r{/v2/#{account_id}/domains/#{domain_id}/ds_records/#{ds_record_id}$}).
+          to_return(read_http_fixture("deleteDelegationSignerRecord/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.delete_delegation_signer_record(account_id, domain_id, ds_record_id)
+
+      expect(WebMock).to have_requested(:delete, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/ds_records/#{ds_record_id}").
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns nothing" do
+      response = subject.delete_delegation_signer_record(account_id, domain_id, ds_record_id)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_nil
+    end
+
+    context "when the delegation signer record does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:delete, %r{/v2}).
+            to_return(read_http_fixture("notfound-delegationsignerrecord.http"))
+
+        expect {
+          subject.delete_delegation_signer_record(account_id, domain_id, ds_record_id)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+end

data/spec/dnsimple/client/domains_dnssec_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe Dnsimple::Client, ".domains" do
+
+  subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").domains }
+
+  describe "#enable_dnssec" do
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+
+    before do
+      stub_request(:post, %r{/v2/#{account_id}/domains/#{domain_id}/dnssec}).
+          to_return(read_http_fixture("enableDnssec/success.http"))
+    end
+
+
+    it "builds the correct request" do
+      subject.enable_dnssec(account_id, domain_id)
+
+      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/dnssec").
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the dnssec status" do
+      response = subject.enable_dnssec(account_id, domain_id)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::Dnssec)
+      expect(result.enabled).to be_truthy
+    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_dnssec(account_id, domain_id)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+
+  end
+
+  describe "#disable_dnssec" do
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+
+    before do
+      stub_request(:delete, %r{/v2/#{account_id}/domains/#{domain_id}/dnssec}).
+          to_return(read_http_fixture("disableDnssec/success.http"))
+    end
+
+
+    it "builds the correct request" do
+      subject.disable_dnssec(account_id, domain_id)
+
+      expect(WebMock).to have_requested(:delete, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/dnssec").
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns nothing" do
+      response = subject.disable_dnssec(account_id, domain_id)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_nil
+    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_dnssec(account_id, domain_id)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+  describe "#get_dnssec" do
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/dnssec}).
+          to_return(read_http_fixture("getDnssec/success.http"))
+    end
+
+
+    it "builds the correct request" do
+      subject.get_dnssec(account_id, domain_id)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/dnssec").
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the dnssec status" do
+      response = subject.get_dnssec(account_id, domain_id)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::Dnssec)
+      expect(result.enabled).to be_truthy
+    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_dnssec(account_id, domain_id)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+
+  end
+
+end

data/spec/dnsimple/client/oauth_spec.rb

@@ -2,13 +2,14 @@ require 'spec_helper'
 
 describe Dnsimple::Client, ".oauth" do
 
-  subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").oauth }
+  subject { described_class.new(base_url: "https://api.dnsimple.test").oauth }
 
 
   describe "#exchange_authorization_for_token" do
     let(:client_id) { "super-client" }
     let(:client_secret) { "super-secret" }
     let(:code) { "super-code" }
+    let(:state) { "super-state" }
 
     before do
       stub_request(:post, %r{/v2/oauth/access_token$}).
@@ -16,15 +17,15 @@ describe Dnsimple::Client, ".oauth" do
     end
 
     it "builds the correct request" do
-      subject.exchange_authorization_for_token(code, client_id, client_secret)
+      subject.exchange_authorization_for_token(code, client_id, client_secret, state: state)
 
       expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/oauth/access_token").
-          with(body: { client_id: client_id, client_secret: client_secret, code: code, grant_type: "authorization_code" }).
+          with(body: { client_id: client_id, client_secret: client_secret, code: code, state: state, grant_type: "authorization_code" }).
           with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns oauth token" do
-      result = subject.exchange_authorization_for_token(code, client_id, client_secret)
+      result = subject.exchange_authorization_for_token(code, client_id, client_secret, state: state)
 
       expect(result).to be_a(Dnsimple::Struct::OauthToken)
       expect(result.access_token).to eq("zKQ7OLqF5N1gylcJweA9WodA000BUNJD")
@@ -33,7 +34,6 @@ describe Dnsimple::Client, ".oauth" do
     end
 
     context "when state and redirect_uri are provided" do
-      let(:state) { "super-state" }
       let(:redirect_uri) { "super-redirect-uri" }
 
       it "builds the correct request" do