dnsimple 2.0.0 → 2.1.0

data/lib/dnsimple/client/templates_domains.rb

@@ -0,0 +1,23 @@
+module Dnsimple
+  class Client
+    module TemplatesDomains
+
+      # Applies the template to the domain.
+      #
+      # @see http://developer.dnsimple.com/templates/#apply
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [#to_s] template The template id or short-name.
+      # @return [void]
+      #
+      # @raise  [NotFoundError]
+      # @raise  [RequestError] When the request fails.
+      def apply_template(domain, template, options = {})
+        response = client.post("v1/domains/#{domain}/templates/#{template}/apply", options)
+        response.code == 200
+      end
+      alias :apply :apply_template
+
+    end
+  end
+end

data/lib/dnsimple/client/templates_records.rb

@@ -7,12 +7,12 @@ module Dnsimple
       # @see http://developer.dnsimple.com/templates/records/#list
       #
       # @param  [#to_s] template The template id or short-name.
-      #
       # @return [Array<Struct::TemplateRecord>]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def records(template)
-        response = client.get("v1/templates/#{template}/records")
+      def records(template, options = {})
+        response = client.get("v1/templates/#{template}/records", options)
 
         response.map { |r| Struct::TemplateRecord.new(r["dns_template_record"]) }
       end
@@ -23,13 +23,13 @@ module Dnsimple
       #
       # @param  [#to_s] template The template id or short-name.
       # @param  [Hash] attributes
-      #
       # @return [Struct::TemplateRecord]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def create_record(template, attributes = {})
+      def create_record(template, attributes = {}, options = {})
         Extra.validate_mandatory_attributes(attributes, [:name, :record_type, :content])
-        options  = { dns_template_record: attributes }
+        options  = options.merge({ dns_template_record: attributes })
         response = client.post("v1/templates/#{template}/records", options)
 
         Struct::TemplateRecord.new(response["dns_template_record"])
@@ -41,12 +41,12 @@ module Dnsimple
       #
       # @param  [#to_s] template The template id or short-name.
       # @param  [Fixnum] record The record id.
-      #
       # @return [Struct::TemplateRecord]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def record(template, record)
-        response = client.get("v1/templates/#{template}/records/#{record}")
+      def record(template, record, options = {})
+        response = client.get("v1/templates/#{template}/records/#{record}", options)
 
         Struct::TemplateRecord.new(response["dns_template_record"])
       end
@@ -58,12 +58,12 @@ module Dnsimple
       # @param  [#to_s] template The template id or short-name.
       # @param  [Fixnum] record The record id.
       # @param  [Hash] attributes
-      #
       # @return [Struct::TemplateRecord]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def update_record(template, record, attributes = {})
-        options  = { dns_template_record: attributes }
+      def update_record(template, record, attributes = {}, options = {})
+        options  = options.merge({ dns_template_record: attributes })
         response = client.put("v1/templates/#{template}/records/#{record}", options)
 
         Struct::TemplateRecord.new(response["dns_template_record"])
@@ -75,12 +75,12 @@ module Dnsimple
       #
       # @param  [#to_s] template The template id or short-name.
       # @param  [Fixnum] record The record id.
-      #
       # @return [Template]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def delete_record(template, record)
-        client.delete("v1/templates/#{template}/records/#{record}")
+      def delete_record(template, record, options = {})
+        client.delete("v1/templates/#{template}/records/#{record}", options)
       end
 
     end

data/lib/dnsimple/client/users.rb

@@ -5,9 +5,10 @@ module Dnsimple
       # Fetches the information about the authenticated user.
       #
       # @return [Struct::User] The authenticated user.
+      #
       # @raise  [RequestError] When the request fails.
-      def user
-        response = client.get("v1/user")
+      def user(options = {})
+        response = client.get("v1/user", options)
 
         Struct::User.new(response["user"])
       end
@@ -24,11 +25,12 @@ module Dnsimple
       #   # => "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 exchange_token(otp_token)
-        response = client.get("v1/user", headers: { Client::HEADER_2FA_STRICT => "1", Client::HEADER_OTP_TOKEN => otp_token })
+      def exchange_token(otp_token, options = {})
+        options  = Extra.deep_merge(options, headers: { Client::HEADER_2FA_STRICT => "1", Client::HEADER_OTP_TOKEN => otp_token })
+        response = client.get("v1/user", options)
         response.headers[Client::HEADER_EXCHANGE_TOKEN]
       end
 

data/lib/dnsimple/version.rb

@@ -1,3 +1,3 @@
 module Dnsimple
-  VERSION = '2.0.0'
+  VERSION = "2.1.0"
 end

data/spec/dnsimple/client/certificates_spec.rb

@@ -33,7 +33,7 @@ describe Dnsimple::Client, ".certificates" do
     context "when something does not exist" do
       it "raises NotFoundError" do
         stub_request(:get, %r[/v1]).
-            to_return(read_fixture("domains/notfound.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.certificates("example.com")
@@ -118,7 +118,7 @@ describe Dnsimple::Client, ".certificates" do
     context "when something does not exist" do
       it "raises NotFoundError" do
         stub_request(:post, %r[/v1]).
-            to_return(read_fixture("domains/notfound.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.purchase("example.com", "www", 100)

data/spec/dnsimple/client/contacts_spec.rb

@@ -8,7 +8,7 @@ describe Dnsimple::Client, ".contacts" do
   describe "#contacts" do
     before do
       stub_request(:get, %r[/v1/contacts$]).
-          to_return(read_fixture("contacts/list/success.http"))
+          to_return(read_fixture("contacts/contacts/success.http"))
     end
 
     it "builds the correct request" do
@@ -31,24 +31,24 @@ describe Dnsimple::Client, ".contacts" do
     end
   end
 
-  describe "#create" do
+  describe "#create_contact" do
     before do
       stub_request(:post, %r[/v1/contacts$]).
-          to_return(read_fixture("contacts/create/created.http"))
+          to_return(read_fixture("contacts/create_contact/created.http"))
     end
 
     let(:attributes) { { first_name: "Simone", last_name: "Carletti", address1: "", city: "Rome", state_province: "RM", postal_code: "00171", country: "IT", email_address: "", phone: "" } }
 
     it "builds the correct request" do
-      subject.create(attributes)
+      subject.create_contact(attributes)
 
       expect(WebMock).to have_requested(:post, "https://api.zone/v1/contacts").
-                         with(body: { contact: attributes }).
-                         with(headers: { 'Accept' => 'application/json' })
+                             with(body: { contact: attributes }).
+                             with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns the contact" do
-      result = subject.create(attributes)
+      result = subject.create_contact(attributes)
 
       expect(result).to be_a(Dnsimple::Struct::Contact)
       expect(result.id).to be_a(Fixnum)
@@ -58,7 +58,7 @@ describe Dnsimple::Client, ".contacts" do
   describe "#contact" do
     before do
       stub_request(:get, %r[/v1/contacts/.+$]).
-          to_return(read_fixture("contacts/get/success.http"))
+          to_return(read_fixture("contacts/contact/success.http"))
     end
 
     it "builds the correct request" do
@@ -94,7 +94,7 @@ describe Dnsimple::Client, ".contacts" do
     context "when something does not exist" do
       it "raises NotFoundError" do
         stub_request(:get, %r[/v1]).
-            to_return(read_fixture("contacts/notfound.http"))
+            to_return(read_fixture("contacts/notfound-contact.http"))
 
         expect {
           subject.contact(1)
@@ -103,10 +103,10 @@ describe Dnsimple::Client, ".contacts" do
     end
   end
 
-  describe "#update" do
+  describe "#update_contact" do
     before do
       stub_request(:put, %r[/v1/contacts/.+$]).
-          to_return(read_fixture("contacts/update/success.http"))
+          to_return(read_fixture("contacts/update_contact/success.http"))
     end
 
     it "builds the correct request" do
@@ -118,7 +118,7 @@ describe Dnsimple::Client, ".contacts" do
     end
 
     it "returns the contact" do
-      result = subject.update(1, {})
+      result = subject.update_contact(1, {})
 
       expect(result).to be_a(Dnsimple::Struct::Contact)
       expect(result.id).to be_a(Fixnum)
@@ -127,39 +127,39 @@ describe Dnsimple::Client, ".contacts" do
     context "when something does not exist" do
       it "raises NotFoundError" do
         stub_request(:put, %r[/v1]).
-            to_return(read_fixture("contacts/notfound.http"))
+            to_return(read_fixture("contacts/notfound-contact.http"))
 
         expect {
-          subject.update(1, {})
+          subject.update_contact(1, {})
         }.to raise_error(Dnsimple::NotFoundError)
       end
     end
   end
 
-  describe "#delete" do
+  describe "#delete_contact" do
     before do
       stub_request(:delete, %r[/v1/contacts/1$]).
-          to_return(read_fixture("contacts/delete/success.http"))
+          to_return(read_fixture("contacts/delete_contact/success.http"))
     end
 
     it "builds the correct request" do
-      subject.delete(1)
+      subject.delete_contact(1)
 
       expect(WebMock).to have_requested(:delete, "https://api.zone/v1/contacts/1").
                          with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns nothing" do
-      result = subject.delete(1)
+      result = subject.delete_contact(1)
 
       expect(result).to be_truthy
     end
 
     it "supports HTTP 204" do
       stub_request(:delete, %r[/v1]).
-          to_return(read_fixture("contacts/delete/success-204.http"))
+          to_return(read_fixture("contacts/delete_contact/success-204.http"))
 
-      result = subject.delete(1)
+      result = subject.delete_contact(1)
 
       expect(result).to be_truthy
     end
@@ -167,10 +167,10 @@ describe Dnsimple::Client, ".contacts" do
     context "when something does not exist" do
       it "raises NotFoundError" do
         stub_request(:delete, %r[/v1]).
-            to_return(read_fixture("contacts/notfound.http"))
+            to_return(read_fixture("contacts/notfound-contact.http"))
 
         expect {
-          subject.delete(1)
+          subject.delete_contact(1)
         }.to raise_error(Dnsimple::NotFoundError)
       end
     end

data/spec/dnsimple/client/domains_autorenewals_spec.rb

@@ -8,7 +8,7 @@ describe Dnsimple::Client, ".domains / autorenewals" do
   describe "#enable_auto_renewal" do
     before do
       stub_request(:post, %r[/v1/domains/.+/auto_renewal$]).
-          to_return(read_fixture("domains_autorenewal/enable/success.http"))
+          to_return(read_fixture("domains/enable_auto_renewal/success.http"))
     end
 
     it "builds the correct request" do
@@ -28,7 +28,7 @@ describe Dnsimple::Client, ".domains / autorenewals" do
     context "when the domain does not exist" do
       it "raises NotFoundError" do
         stub_request(:post, %r[/v1]).
-            to_return(read_fixture("domains_autorenewal/notfound-domain.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.enable_auto_renewal("example.com")
@@ -40,7 +40,7 @@ describe Dnsimple::Client, ".domains / autorenewals" do
   describe "#disable_auto_renewal" do
     before do
       stub_request(:delete, %r[/v1/domains/.+/auto_renewal$]).
-          to_return(read_fixture("domains_autorenewal/disable/success.http"))
+          to_return(read_fixture("domains/disable_auto_renewal/success.http"))
     end
 
     it "builds the correct request" do
@@ -60,7 +60,7 @@ describe Dnsimple::Client, ".domains / autorenewals" do
     context "when the domain does not exist" do
       it "raises NotFoundError" do
         stub_request(:delete, %r[/v1]).
-            to_return(read_fixture("domains_autorenewal/notfound-domain.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.disable_auto_renewal("example.com")

data/spec/dnsimple/client/domains_forwards_spec.rb

@@ -8,7 +8,7 @@ describe Dnsimple::Client, ".domains / forwards" do
   describe "#email_forwards" do
     before do
       stub_request(:get, %r[/v1/domains/.+/email_forwards$]).
-          to_return(read_fixture("domains_forwards/list/success.http"))
+          to_return(read_fixture("domains/forwards/success.http"))
     end
 
     it "builds the correct request" do
@@ -33,7 +33,7 @@ describe Dnsimple::Client, ".domains / forwards" do
     context "when the domain does not exist" do
       it "raises NotFoundError" do
         stub_request(:get, %r[/v1]).
-            to_return(read_fixture("domains_forwards/notfound-domain.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.email_forwards("example.com")
@@ -45,7 +45,7 @@ describe Dnsimple::Client, ".domains / forwards" do
   describe "#create_email_forward" do
     before do
       stub_request(:post, %r[/v1/domains/.+/email_forwards$]).
-          to_return(read_fixture("domains_forwards/create/created.http"))
+          to_return(read_fixture("domains/create_forward/created.http"))
     end
 
     it "builds the correct request" do
@@ -66,7 +66,7 @@ describe Dnsimple::Client, ".domains / forwards" do
     context "when the domain does not exist" do
       it "raises NotFoundError" do
         stub_request(:post, %r[/v1]).
-            to_return(read_fixture("domains_forwards/notfound-domain.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.create_email_forward("example.com", { from: "", to: "" })
@@ -78,7 +78,7 @@ describe Dnsimple::Client, ".domains / forwards" do
   describe "#email_forward" do
     before do
       stub_request(:get, %r[/v1/domains/.+/email_forwards/.+$]).
-          to_return(read_fixture("domains_forwards/get/success.http"))
+          to_return(read_fixture("domains/forward/success.http"))
     end
 
     it "builds the correct request" do
@@ -103,7 +103,7 @@ describe Dnsimple::Client, ".domains / forwards" do
     context "when forward does not exist" do
       it "raises NotFoundError" do
         stub_request(:get, %r[/v1]).
-            to_return(read_fixture("domains_forwards/notfound.http"))
+            to_return(read_fixture("domains/notfound-forward.http"))
 
         expect {
           subject.email_forward("example.com", 2)
@@ -115,7 +115,7 @@ describe Dnsimple::Client, ".domains / forwards" do
   describe "#delete_email_forward" do
     before do
       stub_request(:delete, %r[/v1/domains/.+/email_forwards/.+$]).
-          to_return(read_fixture("domains_forwards/delete/success.http"))
+          to_return(read_fixture("domains/delete_forward/success.http"))
     end
 
     it "builds the correct request" do
@@ -134,7 +134,7 @@ describe Dnsimple::Client, ".domains / forwards" do
     context "when the forward does not exist" do
       it "raises NotFoundError" do
         stub_request(:delete, %r[/v1]).
-            to_return(read_fixture("domains_forwards/notfound.http"))
+            to_return(read_fixture("domains/notfound-forward.http"))
 
         expect {
           subject.delete_email_forward("example.com", 2)

data/spec/dnsimple/client/domains_privacy_spec.rb

@@ -8,7 +8,7 @@ describe Dnsimple::Client, ".domains / privacy" do
   describe "#enable_whois_privacy" do
     before do
       stub_request(:post, %r[/v1/domains/.+/whois_privacy$]).
-          to_return(read_fixture("domains_privacy/enable/success.http"))
+          to_return(read_fixture("domains/enable_whois_privacy/success.http"))
     end
 
     it "builds the correct request" do
@@ -28,7 +28,7 @@ describe Dnsimple::Client, ".domains / privacy" do
     context "when the domain does not exist" do
       it "raises NotFoundError" do
         stub_request(:post, %r[/v1]).
-            to_return(read_fixture("domains_privacy/notfound-domain.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.enable_whois_privacy("example.com")
@@ -40,7 +40,7 @@ describe Dnsimple::Client, ".domains / privacy" do
   describe "#disable_whois_privacy" do
     before do
       stub_request(:delete, %r[/v1/domains/.+/whois_privacy]).
-          to_return(read_fixture("domains_privacy/disable/success.http"))
+          to_return(read_fixture("domains/disable_whois_privacy/success.http"))
     end
 
     it "builds the correct request" do
@@ -60,7 +60,7 @@ describe Dnsimple::Client, ".domains / privacy" do
     context "when the domain does not exist" do
       it "raises NotFoundError" do
         stub_request(:delete, %r[/v1]).
-            to_return(read_fixture("domains_privacy/notfound-domain.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.disable_whois_privacy("example.com")

data/spec/dnsimple/client/domains_records_spec.rb

@@ -8,7 +8,7 @@ describe Dnsimple::Client, ".domains / records" do
   describe "#records" do
     before do
       stub_request(:get, %r[/v1/domains/.+/records$]).
-          to_return(read_fixture("domains_records/list/success.http"))
+          to_return(read_fixture("domains/records/success.http"))
     end
 
     it "builds the correct request" do
@@ -33,7 +33,7 @@ describe Dnsimple::Client, ".domains / records" do
     context "when something does not exist" do
       it "raises NotFoundError" do
         stub_request(:get, %r[/v1]).
-            to_return(read_fixture("domains_records/notfound.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.records("example.com")
@@ -45,7 +45,7 @@ describe Dnsimple::Client, ".domains / records" do
   describe "#create_record" do
     before do
       stub_request(:post, %r[/v1/domains/.+/records$]).
-          to_return(read_fixture("domains_records/create/created.http"))
+          to_return(read_fixture("domains/create_record/created.http"))
     end
 
     it "builds the correct request" do
@@ -66,7 +66,7 @@ describe Dnsimple::Client, ".domains / records" do
     context "when something does not exist" do
       it "raises NotFoundError" do
         stub_request(:post, %r[/v1]).
-            to_return(read_fixture("domains/notfound.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.create_record("example.com", { name: "", record_type: "", content: "" })
@@ -78,7 +78,7 @@ describe Dnsimple::Client, ".domains / records" do
   describe "#record" do
     before do
       stub_request(:get, %r[/v1/domains/.+/records/.+$]).
-          to_return(read_fixture("domains_records/get/success.http"))
+          to_return(read_fixture("domains/record/success.http"))
     end
 
     it "builds the correct request" do
@@ -106,7 +106,7 @@ describe Dnsimple::Client, ".domains / records" do
     context "when something does not exist" do
       it "raises NotFoundError" do
         stub_request(:get, %r[/v1]).
-            to_return(read_fixture("domains_records/notfound.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.record("example.com", 2)
@@ -118,7 +118,7 @@ describe Dnsimple::Client, ".domains / records" do
   describe "#update_record" do
     before do
       stub_request(:put, %r[/v1/domains/.+/records/.+$]).
-          to_return(read_fixture("domains_records/update/success.http"))
+          to_return(read_fixture("domains/update_record/success.http"))
     end
 
     it "builds the correct request" do
@@ -139,7 +139,7 @@ describe Dnsimple::Client, ".domains / records" do
     context "when something does not exist" do
       it "raises NotFoundError" do
         stub_request(:put, %r[/v1]).
-            to_return(read_fixture("domains_records/notfound.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.update_record("example.com", 2, {})
@@ -151,7 +151,7 @@ describe Dnsimple::Client, ".domains / records" do
   describe "#delete_record" do
     before do
       stub_request(:delete, %r[/v1/domains/.+/records/.+$]).
-          to_return(read_fixture("domains/delete/success.http"))
+          to_return(read_fixture("domains/delete_record/success.http"))
     end
 
     it "builds the correct request" do
@@ -169,7 +169,7 @@ describe Dnsimple::Client, ".domains / records" do
 
     it "supports HTTP 204" do
       stub_request(:delete, %r[/v1]).
-          to_return(read_fixture("domains_records/delete/success-204.http"))
+          to_return(read_fixture("domains/delete_record/success-204.http"))
 
       result = subject.delete_record("example.com", 2)
 
@@ -179,7 +179,7 @@ describe Dnsimple::Client, ".domains / records" do
     context "when something does not exist" do
       it "raises NotFoundError" do
         stub_request(:delete, %r[/v1]).
-            to_return(read_fixture("domains_records/notfound.http"))
+            to_return(read_fixture("domains/notfound-domain.http"))
 
         expect {
           subject.delete_record("example.com", 2)