dnsimple 2.2.0 → 3.0.0.pre.beta1

data/spec/dnsimple/client/zones_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe Dnsimple::Client, ".zones" do
+
+  subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").zones }
+
+
+  describe "#zones" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:get, %r[/v2/#{account_id}/zones])
+          .to_return(read_http_fixture("listZones/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.zones(account_id)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones")
+          .with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "supports pagination" do
+      subject.zones(account_id, query: { page: 2 })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones?page=2")
+    end
+
+    it "supports extra request options" do
+      subject.zones(account_id, query: { foo: "bar" })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones?foo=bar")
+    end
+
+    it "returns the zones" do
+      response = subject.zones(account_id)
+
+      expect(response).to be_a(Dnsimple::PaginatedResponse)
+      expect(response.data).to be_a(Array)
+      expect(response.data.size).to eq(2)
+
+      response.data.each do |result|
+        expect(result).to be_a(Dnsimple::Struct::Zone)
+        expect(result.id).to be_a(Fixnum)
+      end
+    end
+
+    it "exposes the pagination information" do
+      response = subject.zones(account_id)
+
+      expect(response.respond_to?(:page)).to be_truthy
+      expect(response.page).to eq(1)
+      expect(response.per_page).to be_a(Fixnum)
+      expect(response.total_entries).to be_a(Fixnum)
+      expect(response.total_pages).to be_a(Fixnum)
+    end
+  end
+
+  describe "#all_zones" do
+    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
+  end
+
+  describe "#zone" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:get, %r[/v2/#{account_id}/zones/.+$])
+          .to_return(read_http_fixture("getZone/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.zone(account_id, zone = "example.com")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone}")
+          .with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the zone" do
+      response = subject.zone(account_id, "example.com")
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::Zone)
+      expect(result.id).to eq(1)
+      expect(result.account_id).to eq(1010)
+      expect(result.name).to eq("example-alpha.com")
+      expect(result.reverse).to eq(false)
+      expect(result.created_at).to eq("2015-04-23T07:40:03.045Z")
+      expect(result.updated_at).to eq("2015-04-23T07:40:03.051Z")
+    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(account_id, "example.com")
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
+end

data/spec/dnsimple/client_spec.rb

@@ -3,19 +3,24 @@ require 'spec_helper'
 describe Dnsimple::Client do
 
   describe "initialization" do
-    it "accepts :api_endpoint option" do
-      subject = described_class.new(api_endpoint: "https://api.example.com/")
-      expect(subject.api_endpoint).to eq("https://api.example.com/")
+    it "accepts :base_url option" do
+      subject = described_class.new(base_url: "https://api.example.com/")
+      expect(subject.base_url).to eq("https://api.example.com/")
     end
 
-    it "normalizes :api_endpoint trailing slash" do
-      subject = described_class.new(api_endpoint: "https://api.example.com/missing/slash")
-      expect(subject.api_endpoint).to eq("https://api.example.com/missing/slash/")
+    it "access :access_token option" do
+      subject = described_class.new(access_token: "token")
+      expect(subject.access_token).to eq("token")
     end
 
-    it "defaults :api_endpoint to production API" do
+    it "normalizes :base_url trailing slash" do
+      subject = described_class.new(base_url: "https://api.example.com/missing/slash")
+      expect(subject.base_url).to eq("https://api.example.com/missing/slash/")
+    end
+
+    it "defaults :base_url to production API" do
       subject = described_class.new
-      expect(subject.api_endpoint).to eq("https://api.dnsimple.com/")
+      expect(subject.base_url).to eq("https://api.dnsimple.com/")
     end
   end
 
@@ -39,73 +44,56 @@ describe Dnsimple::Client do
                          with { |req| req.headers["X-Dnsimple-Domain-Token"] == "domaintoken" }
     end
 
-    it "uses header authentication if there's an api token provided" do
+    it "uses access token if there's an access token provided" do
       stub_request(:any, %r[/test])
 
-      subject = described_class.new(username: "user", api_token: "token")
+      subject = described_class.new(access_token: "access-token")
       subject.execute(:get, "test", {})
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.com/test").
-                         with { |req| req.headers["X-Dnsimple-Token"] == "user:token" }
+                         with { |req| req.headers["Authorization"] == "Bearer access-token" }
     end
 
-    it "uses HTTP authentication via exchange token if there's an exchange token provided" do
-      stub_request(:any, %r[/test])
-
-      subject = described_class.new(username: "user", password: "pass", exchange_token: "exchange-token")
-      subject.execute(:get, "test", {})
-
-      expect(WebMock).to have_requested(:get, "https://exchange-token:x-2fa-basic@api.dnsimple.com/test")
-    end
-
-    it "raises an error if there's no password or api token provided" do
-      subject = described_class.new(username: "user")
+    it "raises an error if there's no password, domain token or access token provided" do
+      subject = described_class.new(username: "user", oauth_client_id: "id", oauth_client_secret: "secret")
 
       expect {
         subject.execute(:get, "test", {})
-      }.to raise_error(Dnsimple::Error, 'A password or API token is required for all API requests.')
-    end
-
-    context "when 2FA is required" do
-      subject { described_class.new(username: "user", password: "pass") }
-
-      before do
-        stub_request(:any, %r[/test]).
-            to_return(read_fixture("2fa/error-required.http"))
-      end
-
-      it "raises a TwoFactorAuthenticationRequired error" do
-        expect {
-          subject.execute(:get, "test", {})
-        }.to raise_error(Dnsimple::TwoFactorAuthenticationRequired)
-      end
+      }.to raise_error(Dnsimple::Error, "A password, domain API token or access token is required for all API requests.")
     end
   end
 
   describe "#get" do
     it "delegates to #request" do
-      expect(subject).to receive(:execute).with(:get, "path", { foo: "bar" }).and_return(:returned)
+      expect(subject).to receive(:execute).with(:get, "path", nil, { foo: "bar" }).and_return(:returned)
       expect(subject.get("path", foo: "bar")).to eq(:returned)
     end
   end
 
   describe "#post" do
     it "delegates to #request" do
-      expect(subject).to receive(:execute).with(:post, "path", { foo: "bar" }).and_return(:returned)
+      expect(subject).to receive(:execute).with(:post, "path", { foo: "bar" }, {}).and_return(:returned)
       expect(subject.post("path", foo: "bar")).to eq(:returned)
     end
   end
 
   describe "#put" do
     it "delegates to #request" do
-      expect(subject).to receive(:execute).with(:put, "path", { foo: "bar" }).and_return(:returned)
+      expect(subject).to receive(:execute).with(:put, "path", { foo: "bar" }, {}).and_return(:returned)
       expect(subject.put("path", foo: "bar")).to eq(:returned)
     end
   end
 
+  describe "#patch" do
+    it "delegates to #request" do
+      expect(subject).to receive(:execute).with(:patch, "path", { foo: "bar" }, {}).and_return(:returned)
+      expect(subject.patch("path", foo: "bar")).to eq(:returned)
+    end
+  end
+
   describe "#delete" do
     it "delegates to #request" do
-      expect(subject).to receive(:execute).with(:delete, "path", { foo: "bar" }).and_return(:returned)
+      expect(subject).to receive(:execute).with(:delete, "path", { foo: "bar" }, {}).and_return(:returned)
       expect(subject.delete("path", foo: "bar")).to eq(:returned)
     end
   end
@@ -139,19 +127,19 @@ describe Dnsimple::Client do
       stub_request(:get, %r[/foo])
 
       expect(HTTParty).to receive(:get).
-                          with("#{subject.api_endpoint}foo",
+                          with("#{subject.base_url}foo",
                                format: :json,
                                basic_auth: { username: "user", password: "pass" },
                                headers: { 'Accept' => 'application/json', 'User-Agent' => "dnsimple-ruby/#{Dnsimple::VERSION}" }
                           ).
                           and_return(double('response', code: 200))
 
-      subject.request(:get, 'foo', {})
+      subject.request(:get, 'foo')
     end
 
     it "properly extracts options from data" do
       expect(HTTParty).to receive(:put).
-                          with("#{subject.api_endpoint}foo",
+                          with("#{subject.base_url}foo",
                                format: :json,
                                body: { something: "else" },
                                query: { foo: "bar" },
@@ -160,7 +148,7 @@ describe Dnsimple::Client do
                           ).
                           and_return(double('response', code: 200))
 
-      subject.request(:put, 'foo', { something: "else", query: { foo: "bar" }, headers: { "Custom" => "Header" } })
+      subject.request(:put, 'foo', { something: "else" }, { query: { foo: "bar" }, headers: { "Custom" => "Header" } })
     end
   end
 

data/spec/dnsimple/extra_spec.rb

@@ -21,4 +21,26 @@ describe Dnsimple::Extra do
     end
   end
 
+  describe ".validate_mandatory_attributes" do
+    let(:mandatory_attributes) { %i{name email} }
+
+    it "raises an error if a mandatory attribute is not present " do
+      expect {
+        described_class.validate_mandatory_attributes({name: "foo"}, mandatory_attributes)
+      }.to raise_error(ArgumentError, ":email is required")
+    end
+
+    it "does not raise an error if all attributes are present" do
+      expect {
+        described_class.validate_mandatory_attributes({name: "foo", email: "bar"}, mandatory_attributes)
+      }.not_to raise_error
+    end
+
+    it "handles nil as attributes value" do
+      expect {
+        described_class.validate_mandatory_attributes(nil, mandatory_attributes)
+      }.to raise_error(ArgumentError, ":name is required")
+    end
+  end
+
 end

data/spec/{files → fixtures.http}/badgateway.http

@@ -1,14 +1,14 @@
-HTTP/1.1 502 Bad Gateway
-Server: nginx
-Date: Mon, 22 Dec 2014 14:16:12 GMT
-Content-Type: text/html
-Content-Length: 166
-Connection: close
-
-<html>
-<head><title>502 Bad Gateway</title></head>
-<body bgcolor="white">
-<center><h1>502 Bad Gateway</h1></center>
-<hr><center>nginx</center>
-</body>
-</html>
+HTTP/1.1 502 Bad Gateway
+Server: nginx
+Date: Mon, 22 Dec 2014 14:16:12 GMT
+Content-Type: text/html
+Content-Length: 166
+Connection: close
+
+<html>
+<head><title>502 Bad Gateway</title></head>
+<body bgcolor="white">
+<center><h1>502 Bad Gateway</h1></center>
+<hr><center>nginx</center>
+</body>
+</html>

data/spec/fixtures.http/checkDomain/success.http

@@ -0,0 +1,17 @@
+HTTP/1.1 200 OK
+Server: nginx
+Date: Fri, 26 Feb 2016 16:04:05 GMT
+Content-Type: application/json; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+Status: 200 OK
+X-RateLimit-Limit: 4000
+X-RateLimit-Remaining: 3999
+X-RateLimit-Reset: 1456506245
+ETag: W/"f3cf8499e935e48401aae26842f712c4"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: e3c6fac1-a36d-42c3-8a04-d68f127add18
+X-Runtime: 0.605907
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"domain":"example.com","available":true,"premium":false}}

data/spec/fixtures.http/createContact/created.http

@@ -0,0 +1,17 @@
+HTTP/1.1 201 Created
+Server: nginx
+Date: Tue, 19 Jan 2016 20:50:26 GMT
+Content-Type: application/json; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+Status: 201 Created
+X-RateLimit-Limit: 4000
+X-RateLimit-Remaining: 3997
+X-RateLimit-Reset: 1453239045
+ETag: W/"165299b0ea3e5c1c80f1ae622146626f"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: 9f577b9e-5bc4-4a8f-adfb-09dbb1992b0e
+X-Runtime: 0.061482
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"id":1,"account_id":1010,"label":"Default","first_name":"First","last_name":"User","job_title":"CEO","organization_name":"Awesome Company","email_address":"first@example.com","phone":"+18001234567","fax":"+18011234567","address1":"Italian Street, 10","address2":"","city":"Roma","state_province":"RM","postal_code":"00100","country":"IT","created_at":"2016-01-19T20:50:26.066Z","updated_at":"2016-01-19T20:50:26.066Z"}}

data/spec/fixtures.http/createDomain/created.http

@@ -0,0 +1,16 @@
+HTTP/1.1 201 Created
+Server: nginx
+Date: Fri, 18 Dec 2015 16:38:07 GMT
+Content-Type: application/json; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+X-RateLimit-Limit: 4000
+X-RateLimit-Remaining: 3986
+X-RateLimit-Reset: 1450456686
+ETag: W/"87e018b900e5f210c3236f63d3b2f4df"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: 0d6f1ea7-f702-4317-85f0-04874b69315d
+X-Runtime: 0.257489
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"id":1,"account_id":1010,"registrant_id":null,"name":"example-alpha.com","unicode_name":"example-alpha.com","token":"domain-token","state":"hosted","auto_renew":false,"private_whois":false,"expires_on":null,"created_at":"2014-12-06T15:56:55.573Z","updated_at":"2015-12-09T00:20:56.056Z"}}

data/spec/fixtures.http/createEmailForward/created.http

@@ -0,0 +1,17 @@
+HTTP/1.1 201 Created
+Server: nginx
+Date: Thu, 04 Feb 2016 14:26:51 GMT
+Content-Type: application/json; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+Status: 201 Created
+X-RateLimit-Limit: 4000
+X-RateLimit-Remaining: 3991
+X-RateLimit-Reset: 1454596042
+ETag: W/"10dd958c5a3a43eec0af1d8da655cab0"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: fca523a2-aad9-49e6-a828-a0e7711a8501
+X-Runtime: 1.711621
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"id":17706,"domain_id":228963,"from":"jim@a-domain.com","to":"jim@another.com","created_at":"2016-02-04T14:26:50.282Z","updated_at":"2016-02-04T14:26:50.282Z"}}

data/spec/fixtures.http/createWebhook/created.http

@@ -0,0 +1,17 @@
+HTTP/1.1 201 Created
+Server: nginx
+Date: Mon, 15 Feb 2016 17:04:38 GMT
+Content-Type: application/json; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+Status: 201 Created
+X-RateLimit-Limit: 4000
+X-RateLimit-Remaining: 3996
+X-RateLimit-Reset: 1455559348
+ETag: W/"a4b43ee926d18d0839f1eae08e78c66b"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: dca89281-416a-4766-9428-d0295f58586e
+X-Runtime: 0.175179
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"id":1,"url":"https://webhook.test"}}

data/spec/fixtures.http/createZoneRecord/created.http

@@ -0,0 +1,17 @@
+HTTP/1.1 201 Created
+Server: nginx
+Date: Thu, 07 Jan 2016 17:45:13 GMT
+Content-Type: application/json; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+Status: 201 Created
+X-RateLimit-Limit: 4000
+X-RateLimit-Remaining: 3990
+X-RateLimit-Reset: 1452188712
+ETag: W/"a7ddff4ee5dc28bbebf3d416e8bd0f04"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: f96f5034-bf0c-4201-9564-493c162e3cb4
+X-Runtime: 0.099095
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"id":64784,"zone_id":"example.com","parent_id":null,"name":"www","content":"127.0.0.1","ttl":600,"priority":null,"type":"A","system_record":false,"created_at":"2016-01-07T17:45:13.653Z","updated_at":"2016-01-07T17:45:13.653Z"}}

data/spec/fixtures.http/deleteContact/success.http

@@ -0,0 +1,13 @@
+HTTP/1.1 204 No Content
+Server: nginx
+Date: Tue, 19 Jan 2016 21:49:42 GMT
+Connection: keep-alive
+Status: 204 No Content
+X-RateLimit-Limit: 4000
+X-RateLimit-Remaining: 3999
+X-RateLimit-Reset: 1453243782
+Cache-Control: no-cache
+X-Request-Id: 10c8528b-569b-4152-a89c-fc9c5f94afe9
+X-Runtime: 0.029858
+Strict-Transport-Security: max-age=31536000
+