dnsimple 2.0.0.a → 2.0.0.alpha2

data/lib/dnsimple/service.rb

@@ -1,4 +1,4 @@
-module DNSimple
+module Dnsimple
 
   # Represents a service that can be applied to a domain.
   class Service < Base
@@ -14,7 +14,7 @@ module DNSimple
     # Find a service by its ID or short name
     def self.find(id_or_short_name, options={})
       id = id_or_short_name
-      response = DNSimple::Client.get("/v1/services/#{id}", options)
+      response = Client.get("/v1/services/#{id}", options)
 
       case response.code
       when 200
@@ -28,7 +28,7 @@ module DNSimple
 
     # Get all of the services that can be applied to a domain
     def self.all(options={})
-      response = DNSimple::Client.get("/v1/services", options)
+      response = Client.get("/v1/services", options)
 
       case response.code
       when 200

data/lib/dnsimple/template.rb

@@ -1,4 +1,4 @@
-module DNSimple
+module Dnsimple
   class Template < Base
 
     attr_accessor :id
@@ -16,7 +16,7 @@ module DNSimple
 
       options.merge!(:body => {:dns_template => template_hash})
 
-      response = DNSimple::Client.post("/v1/templates", options)
+      response = Client.post("/v1/templates", options)
 
       case response.code
       when 201
@@ -28,7 +28,7 @@ module DNSimple
 
     def self.find(id_or_short_name, options={})
       id = id_or_short_name
-      response = DNSimple::Client.get("/v1/templates/#{id}", options)
+      response = Client.get("/v1/templates/#{id}", options)
 
       case response.code
       when 200
@@ -41,7 +41,7 @@ module DNSimple
     end
 
     def self.all(options={})
-      response = DNSimple::Client.get("/v1/templates", options)
+      response = Client.get("/v1/templates", options)
 
       case response.code
       when 200
@@ -52,10 +52,12 @@ module DNSimple
     end
 
 
-    # Delete the template from DNSimple.
+    # #delete the template from DNSimple.
+    #
     # WARNING: this cannot be undone.
+    #
     def delete(options={})
-      DNSimple::Client.delete("/v1/templates/#{id}", options)
+      Client.delete("/v1/templates/#{id}", options)
     end
     alias :destroy :delete
 

data/lib/dnsimple/template_record.rb

@@ -1,4 +1,4 @@
-module DNSimple
+module Dnsimple
 
   # A single record in a template.
   class TemplateRecord < Base
@@ -25,12 +25,12 @@ module DNSimple
     attr_accessor :prio
 
     def delete(options={})
-      DNSimple::Client.delete("/v1/templates/#{template.id}/template_records/#{id}", options)
+      Client.delete("/v1/templates/#{template.id}/template_records/#{id}", options)
     end
     alias :destroy :delete
 
     def self.create(short_name, name, record_type, content, options={})
-      template = DNSimple::Template.find(short_name)
+      template = Template.find(short_name)
 
       record_hash = {:name => name, :record_type => record_type, :content => content}
       record_hash[:ttl] = options.delete(:ttl) || 3600
@@ -38,7 +38,7 @@ module DNSimple
 
       options.merge!({:query => {:dns_template_record => record_hash}})
 
-      response = DNSimple::Client.post("/v1/templates/#{template.id}/template_records", options)
+      response = Client.post("/v1/templates/#{template.id}/template_records", options)
 
       case response.code
       when 201
@@ -49,8 +49,8 @@ module DNSimple
     end
 
     def self.find(short_name, id, options={})
-      template = DNSimple::Template.find(short_name)
-      response = DNSimple::Client.get("/v1/templates/#{template.id}/template_records/#{id}", options)
+      template = Template.find(short_name)
+      response = Client.get("/v1/templates/#{template.id}/template_records/#{id}", options)
 
       case response.code
       when 200
@@ -65,8 +65,8 @@ module DNSimple
     # Get all of the template records for the template with the
     # given short name.
     def self.all(short_name, options={})
-      template = DNSimple::Template.find(short_name)
-      response = DNSimple::Client.get("/v1/templates/#{template.id}/template_records", options)
+      template = Template.find(short_name)
+      response = Client.get("/v1/templates/#{template.id}/template_records", options)
 
       case response.code
       when 200

data/lib/dnsimple/transfer_order.rb

@@ -1,4 +1,4 @@
-module DNSimple
+module Dnsimple
 
   # Represents a transfer order.
   class TransferOrder < Base
@@ -20,7 +20,7 @@ module DNSimple
 
       options.merge!({:body => body})
 
-      response = DNSimple::Client.post("/v1/domain_transfers", options)
+      response = Client.post("/v1/domain_transfers", options)
 
       case response.code
       when 201

data/lib/dnsimple/user.rb

@@ -1,4 +1,4 @@
-module DNSimple
+module Dnsimple
   class User < Base
 
     attr_accessor :id
@@ -11,8 +11,12 @@ module DNSimple
     attr_accessor :updated_at
 
 
+    # Fetches the information about the authenticated user.
+    #
+    # @return [User] the authenticated user
+    # @raise  [RequestError] if the user doesn't exist
     def self.me
-      response = DNSimple::Client.get("/v1/user")
+      response = Client.get("/v1/user")
 
       case response.code
       when 200
@@ -22,5 +26,25 @@ module DNSimple
       end
     end
 
+    # Requests a new two-factor authentication exchange token.
+    #
+    # The exchange-token is required to validate API requests
+    # using HTTP Basic Authentication when the account has two-factor authentication enabled.
+    #
+    # @see http://developer.dnsimple.com/authentication/#twofa
+    #
+    # @example Request an Exchange Token
+    #   Dnsimple::User.two_factor_exchange_token('0000000')
+    #   # => "cda038832591e34f5df642ce2b61dc78"
+    #
+    # @param  [String] otp_token the two-factor one time (OTP) token
+    #
+    # @return [String] the two-factor API exchange token
+    # @raise  [AuthenticationFailed] if the provided OTP token is invalid
+    def self.two_factor_exchange_token(otp_token)
+      response = Client.get("/v1/user", :headers => { Client::HEADER_2FA_STRICT => "1", Client::HEADER_OTP_TOKEN => otp_token })
+      response.headers[Client::HEADER_EXCHANGE_TOKEN]
+    end
+
   end
 end

data/lib/dnsimple/version.rb

@@ -1,3 +1,3 @@
-module DNSimple
-  VERSION = '2.0.0.a'
+module Dnsimple
+  VERSION = '2.0.0.alpha2'
 end

data/spec/dnsimple/certificate_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe DNSimple::Certificate do
+describe Dnsimple::Certificate do
 
-  let(:domain) { DNSimple::Domain.new(:name => "example.com") }
+  let(:domain) { Dnsimple::Domain.new(:name => "example.com") }
 
 
   describe ".find" do
@@ -23,17 +23,20 @@ describe DNSimple::Certificate do
         result = described_class.find(domain, "2")
 
         expect(result.id).to eq(4576)
-        expect(result.domain).to eq(domain)
+        expect(result.domain_id).to eq(79569)
+        expect(result.contact_id).to eq(11549)
         expect(result.name).to eq("www")
+        expect(result.state).to eq("cancelled")
         expect(result.csr).to eq("-----BEGIN NEW CERTIFICATE REQUEST-----\nRHr2akB4KMba6FMAsvlStnO/2ika16hNx+d3smPNsER+HA==\n-----END NEW CERTIFICATE REQUEST-----\n")
         expect(result.ssl_certificate).to eq("-----BEGIN CERTIFICATE-----\nXwTkw5UCPpaVyUYcwHlvaprOe9ZbwIyEHm2AT1rW+70=\n-----END CERTIFICATE-----\n")
         expect(result.private_key).to eq("-----BEGIN RSA PRIVATE KEY-----\nUeXbFi7o+nuPfRhpBFQEKwacKFc3Hnc1hH6UsnC0KY25cUif7yz38A==\n-----END RSA PRIVATE KEY-----\n")
         expect(result.approver_email).to eq("example@example.net")
         expect(result.created_at).to eq("2013-09-17T21:54:42Z")
         expect(result.updated_at).to eq("2013-09-17T22:25:36Z")
+        expect(result.configured_at).to eq("2013-09-17T22:25:01Z")
+        expect(result.expires_on).to eq("2014-09-17")
 
-        expect(result.available_approver_emails).to be_nil
-        expect(result.certificate_status).to be_nil
+        expect(result.domain).to eq(domain)
       end
     end
   end

data/spec/dnsimple/client_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe DNSimple::Client do
+describe Dnsimple::Client do
 
   let(:klass) { described_class }
   let(:response) { stub('response', :code => 200) }
@@ -29,10 +29,15 @@ describe DNSimple::Client do
   end
 
   describe ".request" do
+    before do
+      [:username, :password, :exchange_token, :api_token, :domain_api_token].each do |attribute|
+        described_class.send("#{attribute}=", nil)
+      end
+    end
+
     it "uses HTTP authentication if there's a password provided" do
       described_class.username   = 'user'
       described_class.password   = 'pass'
-      described_class.api_token  = nil
       described_class.base_uri   = 'https://api.example.com/'
 
       HTTParty.expects(:get).
@@ -42,9 +47,19 @@ describe DNSimple::Client do
       described_class.request(:get, '/domains', {})
     end
 
+    it "uses header authentication if there's a domain api token provided" do
+      described_class.domain_api_token  = 'domaintoken'
+      described_class.base_uri   = 'https://api.example.com/'
+
+      HTTParty.expects(:get).
+        with('https://api.example.com/domains', has_entries(:headers => has_entries({ 'X-DNSimple-Domain-Token' => 'domaintoken' }))).
+        returns(response)
+
+      described_class.request(:get, '/domains', {})
+    end
+
     it "uses header authentication if there's an api token provided" do
       described_class.username   = 'user'
-      described_class.password   = nil
       described_class.api_token  = 'token'
       described_class.base_uri   = 'https://api.example.com/'
 
@@ -55,32 +70,48 @@ describe DNSimple::Client do
       described_class.request(:get, '/domains', {})
     end
 
+    it "uses HTTP authentication via exchange token if there's an exchange token provided" do
+      described_class.username = 'user'
+      described_class.password = 'pass'
+      described_class.exchange_token = 'exchange-token'
+      described_class.base_uri = 'https://api.example.com/'
+
+      HTTParty.expects(:get).
+          with('https://api.example.com/domains', has_entries(:basic_auth => { :username => 'exchange-token', :password => 'x-2fa-basic' })).
+          returns(response)
+
+      described_class.request(:get, '/domains', {})
+    end
+
     it "raises an error if there's no password or api token provided" do
       described_class.username   = 'user'
-      described_class.password   = nil
-      described_class.api_token  = nil
       described_class.base_uri   = 'https://api.example.com/'
 
       expect {
         described_class.request(:get, '/domains', {})
-      }.to raise_error(DNSimple::Error, 'A password or API token is required for all API requests.')
+      }.to raise_error(Dnsimple::Error, 'A password or API token is required for all API requests.')
     end
 
     it "adds a custom user-agent" do
+      described_class.api_token  = 'token'
+
       HTTParty.expects(:get).
-        with(is_a(String), has_entries(:headers => has_entries({ 'User-Agent' => "dnsimple-ruby/#{DNSimple::VERSION}" }))).
+        with(is_a(String), has_entries(:headers => has_entries({ 'User-Agent' => "dnsimple-ruby/#{Dnsimple::VERSION}" }))).
         returns(response)
 
       described_class.request(:get, '/foo', {})
     end
 
     it "performs a request" do
+      described_class.username = 'user'
+      described_class.password = 'pass'
+
       HTTParty.expects(:get).
         with("#{described_class.base_uri}/foo",
           :format => :json,
           :basic_auth => { :username => described_class.username, :password => described_class.password },
-          :headers => { 'Accept' => 'application/json', 'User-Agent' => "dnsimple-ruby/#{DNSimple::VERSION}" }
-          ).
+          :headers => { 'Accept' => 'application/json', 'User-Agent' => "dnsimple-ruby/#{Dnsimple::VERSION}" }
+        ).
         returns(response)
 
       described_class.request(:get, '/foo', {})
@@ -104,4 +135,20 @@ describe DNSimple::Client do
     end
   end
 
+
+  describe "authentication" do
+    context "when 2FA is required" do
+      before do
+        stub_request(:get, %r[/foo]).
+            to_return(read_fixture("2fa/error-required.http"))
+      end
+
+      it "raises a TwoFactorAuthenticationRequired error" do
+        expect {
+          described_class.get('/foo', {})
+        }.to raise_error(Dnsimple::TwoFactorAuthenticationRequired)
+      end
+    end
+  end
+
 end

data/spec/dnsimple/contact_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe DNSimple::Contact do
+describe Dnsimple::Contact do
 
   describe ".find" do
     before do
@@ -24,7 +24,7 @@ describe DNSimple::Contact do
         expect(result.first_name).to eq("Simone")
         expect(result.last_name).to eq("Carletti")
         expect(result.job_title).to eq("Underwater Programmer")
-        expect(result.organization_name).to eq("DNSimple")
+        expect(result.organization_name).to eq("Dnsimple")
         expect(result.email_address).to eq("example@example.com")
         expect(result.phone).to eq("+1 111 000000")
         expect(result.fax).to eq("+1 222 000000")

data/spec/dnsimple/domain_spec.rb

@@ -1,9 +1,59 @@
 require 'spec_helper'
 
-describe DNSimple::Domain do
+describe Dnsimple::Domain do
 
   let(:contact_id) { 1001 }
 
+
+  describe ".list" do
+    before do
+      stub_request(:get, %r[/v1/domains$]).
+          to_return(read_fixture("domains/index/success.http"))
+    end
+
+    it "builds the correct request" do
+      described_class.list
+
+      expect(WebMock).to have_requested(:get, "https://#{CONFIG['username']}:#{CONFIG['password']}@#{CONFIG['host']}/v1/domains").
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the list of domains" do
+      results = described_class.list
+
+      expect(results).to be_a(Array)
+      expect(results.size).to eq(2)
+
+      result = results[0]
+      expect(result.id).to eq(228)
+
+      result = results[1]
+      expect(result.id).to eq(227)
+    end
+  end
+
+  describe ".create" do
+    before do
+      stub_request(:post, %r[/v1/domains$]).
+          to_return(read_fixture("domains/create/success.http"))
+    end
+
+    it "builds the correct request" do
+      described_class.create("example.com")
+
+      expect(WebMock).to have_requested(:post, "https://#{CONFIG['username']}:#{CONFIG['password']}@#{CONFIG['host']}/v1/domains").
+          with(headers: { 'Accept' => 'application/json' }).
+          with(body: { "domain" => { "name" => "example.com" }})
+    end
+
+    it "returns the domain" do
+      result = described_class.create("example.com")
+
+      expect(result).to be_a(described_class)
+      expect(result.id).to eq(6)
+    end
+  end
+
   describe ".find" do
     before do
       stub_request(:get, %r[/v1/domains/example.com]).
@@ -14,33 +64,90 @@ describe DNSimple::Domain do
       described_class.find("example.com")
 
       expect(WebMock).to have_requested(:get, "https://#{CONFIG['username']}:#{CONFIG['password']}@#{CONFIG['host']}/v1/domains/example.com").
-          with(:headers => { 'Accept' => 'application/json' })
-    end
-
-    context "when the domain exists" do
-      it "returns the domain" do
-        result = described_class.find("example.com")
-
-        expect(result).to be_a(described_class)
-        expect(result.id).to eq(6)
-        expect(result.name).to eq("test-1383931357.com")
-        expect(result.expires_on).to eq('2015-11-08')
-        expect(result.created_at).to eq("2013-11-08T17:22:48Z")
-        expect(result.updated_at).to eq("2014-01-14T18:27:04Z")
-        expect(result.state).to eq("registered")
-        expect(result.registrant_id).to eq(2)
-        expect(result.user_id).to eq(2)
-        expect(result.lockable).to eq(true)
-        expect(result.auto_renew).to eq(true)
-        expect(result.whois_protected).to eq(false)
-
-        expect(result.name_server_status).to be_nil
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the domain" do
+      result = described_class.find("example.com")
+
+      expect(result).to be_a(described_class)
+      expect(result.id).to eq(6)
+      expect(result.user_id).to eq(2)
+      expect(result.registrant_id).to eq(2)
+      expect(result.user_id).to eq(2)
+      expect(result.name).to eq("test-1383931357.com")
+      expect(result.state).to eq("registered")
+      expect(result.auto_renew).to eq(true)
+      expect(result.whois_protected).to eq(false)
+      expect(result.expires_on).to eq("2015-11-08")
+      expect(result.created_at).to eq("2013-11-08T17:22:48Z")
+      expect(result.updated_at).to eq("2014-01-14T18:27:04Z")
+    end
+
+    context "when the domain does not exist" do
+      it "raises RecordNotFound" do
+        stub_request(:get, %r[/v1/domains/example.com]).
+            to_return(read_fixture("domains/notfound.http"))
+
+        expect {
+          described_class.find("example.com")
+        }.to raise_error(Dnsimple::RecordNotFound)
       end
     end
   end
 
+  describe ".delete" do
+    before do
+      stub_request(:delete, %r[/v1/domains/example.com]).
+          to_return(read_fixture("domains/delete/success.http"))
+    end
+
+    it "builds the correct request" do
+      described_class.delete("example.com")
+
+      expect(WebMock).to have_requested(:delete, "https://#{CONFIG['username']}:#{CONFIG['password']}@#{CONFIG['host']}/v1/domains/example.com").
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns nothing" do
+      result = described_class.delete("example.com")
+
+      expect(result).to be_truthy
+    end
+
+    it "supports HTTP 204" do
+      stub_request(:delete, %r[/v1/domains/example.com]).
+          to_return(read_fixture("domains/delete/success-204.http"))
+
+      result = described_class.delete("example.com")
+
+      expect(result).to be_truthy
+    end
+
+    context "when the domain does not exist" do
+      it "raises RecordNotFound" do
+        stub_request(:delete, %r[/v1/domains/example.com]).
+            to_return(read_fixture("domains/notfound.http"))
+
+        expect {
+          described_class.delete("example.com")
+        }.to raise_error(Dnsimple::RecordNotFound)
+      end
+    end
+  end
+
+
+  describe "#delete" do
+    it "delegates to .delete" do
+      subject = described_class.new(name: "example.com")
+      described_class.expects(:delete).with(subject.name).returns(:returned)
+
+      expect(subject.delete).to eq(:returned)
+    end
+  end
+
   describe "#enable_auto_renew" do
-    let(:domain) { described_class.new(name: 'example.com', auto_renew: false) }
+    let(:domain) { described_class.new(:name => 'example.com', :auto_renew => false) }
 
     context "when response is not 200" do
       before do
@@ -49,12 +156,12 @@ describe DNSimple::Domain do
       end
 
       it "raises a RequestError" do
-        expect { domain.enable_auto_renew }.to raise_error(DNSimple::RequestError)
+        expect { domain.enable_auto_renew }.to raise_error(Dnsimple::RequestError)
       end
     end
 
     context "when auto_renew is true" do
-      let(:domain) { described_class.new(name: 'example.com', auto_renew: true) }
+      let(:domain) { described_class.new(:name => 'example.com', :auto_renew => true) }
 
       it "does not send a web request" do
         domain.enable_auto_renew
@@ -63,7 +170,7 @@ describe DNSimple::Domain do
     end
 
     context "when auto_renew is false" do
-      let(:domain) { described_class.new(name: 'example.com', auto_renew: false) }
+      let(:domain) { described_class.new(:name => 'example.com', :auto_renew => false) }
 
       before do
         stub_request(:post, %r[/v1/domains/example.com/auto_renewal]).
@@ -74,7 +181,7 @@ describe DNSimple::Domain do
         domain.enable_auto_renew
 
         expect(WebMock).to have_requested(:post, "https://#{CONFIG['username']}:#{CONFIG['password']}@#{CONFIG['host']}/v1/domains/example.com/auto_renewal").
-            with(:headers => { 'Accept' => 'application/json' })
+            with(headers: { 'Accept' => 'application/json' })
       end
 
       it "sets auto_renew to true on the domain" do
@@ -86,7 +193,7 @@ describe DNSimple::Domain do
   end
 
   describe "#disable_auto_renew" do
-    let(:domain) { described_class.new(name: 'example.com', auto_renew: true) }
+    let(:domain) { described_class.new(:name => 'example.com', :auto_renew => true) }
 
     context "when response is not 200" do
       before do
@@ -95,12 +202,12 @@ describe DNSimple::Domain do
       end
 
       it "raises a RequestError" do
-        expect { domain.disable_auto_renew }.to raise_error(DNSimple::RequestError)
+        expect { domain.disable_auto_renew }.to raise_error(Dnsimple::RequestError)
       end
     end
 
     context "when auto_renew is false" do
-      let(:domain) { described_class.new(name: 'example.com', auto_renew: false) }
+      let(:domain) { described_class.new(:name => 'example.com', :auto_renew => false) }
 
       it "does not send a web request" do
         domain.disable_auto_renew
@@ -109,7 +216,7 @@ describe DNSimple::Domain do
     end
 
     context "when auto_renew is true" do
-      let(:domain) { described_class.new(name: 'example.com', auto_renew: true) }
+      let(:domain) { described_class.new(:name => 'example.com', :auto_renew => true) }
 
       before do
         stub_request(:delete, %r[/v1/domains/example.com/auto_renewal]).
@@ -120,7 +227,7 @@ describe DNSimple::Domain do
         domain.disable_auto_renew
 
         expect(WebMock).to have_requested(:delete, "https://#{CONFIG['username']}:#{CONFIG['password']}@#{CONFIG['host']}/v1/domains/example.com/auto_renewal").
-            with(:headers => { 'Accept' => 'application/json' })
+            with(headers: { 'Accept' => 'application/json' })
       end
 
       it "sets auto_renew to false on the domain" do
@@ -130,4 +237,5 @@ describe DNSimple::Domain do
     end
 
   end
+
 end