dnsimple 3.0.0.pre.beta2 → 3.0.0

data/lib/dnsimple/client/zones.rb

@@ -23,8 +23,8 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Zone.new(r) })
       end
-      alias :list :zones
-      alias :list_zones :zones
+      alias list zones
+      alias list_zones zones
 
       # Lists ALL the zones in the account.
       #

data/lib/dnsimple/client/zones_records.rb

@@ -24,7 +24,7 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Record.new(r) })
       end
-      alias :list_records :records
+      alias list_records records
 
       # Lists ALL the zone records in the account.
       #

data/lib/dnsimple/default.rb

@@ -7,7 +7,7 @@ module Dnsimple
     BASE_URL = "https://api.dnsimple.com/".freeze
 
     # Default User Agent header
-    USER_AGENT   = "dnsimple-ruby/#{VERSION}".freeze
+    USER_AGENT = "dnsimple-ruby/#{VERSION}".freeze
 
     class << self
 
@@ -28,7 +28,7 @@ module Dnsimple
       # Configuration options
       # @return [Hash]
       def options
-        Hash[keys.map { |key| [key, send(key)]}]
+        Hash[keys.map { |key| [key, send(key)] }]
       end
 
       # Default API endpoint from ENV or {BASE_URL}

data/lib/dnsimple/error.rb

@@ -9,8 +9,21 @@ module Dnsimple
 
     def initialize(http_response)
       @http_response = http_response
-      super(http_response.code.to_s)
+      super(message_from(http_response))
     end
+
+    private
+
+    def message_from(http_response)
+      content_type = http_response.headers["Content-Type"]
+      if content_type && content_type.start_with?("application/json")
+        http_response.parsed_response["message"]
+      else
+        net_http_response = http_response.response
+        "#{net_http_response.code} #{net_http_response.message}"
+      end
+    end
+
   end
 
   class NotFoundError < RequestError

data/lib/dnsimple/struct.rb

@@ -5,7 +5,7 @@ module Dnsimple
       def initialize(attributes = {})
         attributes.each do |key, value|
           m = "#{key}=".to_sym
-          self.send(m, value) if self.respond_to?(m)
+          send(m, value) if respond_to?(m)
         end
       end
     end
@@ -21,6 +21,8 @@ require_relative 'struct/email_forward'
 require_relative 'struct/extended_attribute'
 require_relative 'struct/oauth_token'
 require_relative 'struct/record'
+require_relative 'struct/service'
+require_relative 'struct/template'
 require_relative 'struct/tld'
 require_relative 'struct/user'
 require_relative 'struct/whois_privacy'

data/lib/dnsimple/struct/contact.rb

@@ -56,8 +56,8 @@ module Dnsimple
       # @return [String] When the contact was last updated in DNSimple.
       attr_accessor :updated_at
 
-      alias :email_address :email
-      alias :email_address= :email=
+      alias email_address email
+      alias email_address= email=
     end
 
   end

data/lib/dnsimple/struct/extended_attribute.rb

@@ -23,7 +23,11 @@ module Dnsimple
       # Boolean indicating if the extended attribute is required
       attr_accessor :required
 
-      def options
+      # @return [Array<Options>] The array of options with possible values for the extended attribute
+      attr_accessor :options
+
+      def initialize(*)
+        super
         @options ||= []
       end
 

data/lib/dnsimple/struct/service.rb

@@ -0,0 +1,64 @@
+module Dnsimple
+  module Struct
+
+    class Service < Base
+
+      class Setting < Base
+        # @return [String] The setting name.
+        attr_accessor :name
+
+        # @return [String] The setting label.
+        attr_accessor :label
+
+        # @return [String] A suffix to be appended to the setting value.
+        attr_accessor :append
+
+        # @return [String] The setting description.
+        attr_accessor :description
+
+        # @return [String] An example of the setting value.
+        attr_accessor :example
+
+        # @return [Boolean] Whether the setting requires a password.
+        attr_accessor :password
+      end
+
+      # @return [Fixnum] The service ID in DNSimple.
+      attr_accessor :id
+
+      # @return [String] The service name.
+      attr_accessor :name
+
+      # @return [String] A short name for the service.
+      attr_accessor :short_name
+
+      # @return [String] The service description.
+      attr_accessor :description
+
+      # @return [String] The service setup description.
+      attr_accessor :setup_description
+
+      # @return [Boolean] Whether the service requires extra setup.
+      attr_accessor :requires_setup
+
+      # @return [String] The default subdomain where the service will be applied.
+      attr_accessor :default_subdomain
+
+      # @return [Array<Settings>] The array of settings to setup this service, if setup is required.
+      attr_accessor :settings
+
+      def initialize(*)
+        super
+        @settings ||= []
+      end
+
+      def settings=(settings)
+        @settings = settings.map do |setting|
+          Setting.new(setting)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/dnsimple/struct/template.rb

@@ -0,0 +1,22 @@
+module Dnsimple
+  module Struct
+
+    class Template < Base
+      # @return [Fixnum] The template ID in DNSimple.
+      attr_accessor :id
+
+      # @return [Fixnum] The associated account ID.
+      attr_accessor :account_id
+
+      # @return [String] The template name.
+      attr_accessor :name
+
+      # @return [String] The short name for the template.
+      attr_accessor :short_name
+
+      # @return [String] The template description.
+      attr_accessor :description
+    end
+
+  end
+end

data/lib/dnsimple/struct/tld.rb

@@ -7,7 +7,7 @@ module Dnsimple
 
       # @return [Fixnum] The TLD type.
       attr_accessor :tld_type
-      
+
       # @return [Boolean] True if Whois Privacy Protection is available.
       attr_accessor :whois_privacy
 

data/lib/dnsimple/version.rb

@@ -1,3 +1,3 @@
 module Dnsimple
-  VERSION = "3.0.0-beta2"
+  VERSION = "3.0.0".freeze
 end

data/spec/dnsimple/client/client_service_spec.rb

@@ -19,12 +19,12 @@ describe Dnsimple::Client::ClientService do
     let(:account_id) { 1010 }
 
     before do
-      stub_request(:get, %r[/v2/#{account_id}/list\?page=1&per_page=100])
-          .to_return(read_http_fixture("pages-1of3.http"))
-      stub_request(:get, %r[/v2/#{account_id}/list\?page=2&per_page=100])
-          .to_return(read_http_fixture("pages-2of3.http"))
-      stub_request(:get, %r[/v2/#{account_id}/list\?page=3&per_page=100])
-          .to_return(read_http_fixture("pages-3of3.http"))
+      stub_request(:get, %r{/v2/#{account_id}/list\?page=1&per_page=100}).
+          to_return(read_http_fixture("pages-1of3.http"))
+      stub_request(:get, %r{/v2/#{account_id}/list\?page=2&per_page=100}).
+          to_return(read_http_fixture("pages-2of3.http"))
+      stub_request(:get, %r{/v2/#{account_id}/list\?page=3&per_page=100}).
+          to_return(read_http_fixture("pages-3of3.http"))
     end
 
     it "loops all the pages" do

data/spec/dnsimple/client/contacts_spec.rb

@@ -9,15 +9,15 @@ describe Dnsimple::Client, ".contacts" do
     let(:account_id) { 1010 }
 
     before do
-      stub_request(:get, %r[/v2/#{account_id}/contacts])
-          .to_return(read_http_fixture("listContacts/success.http"))
+      stub_request(:get, %r{/v2/#{account_id}/contacts}).
+          to_return(read_http_fixture("listContacts/success.http"))
     end
 
     it "builds the correct request" do
       subject.contacts(account_id)
 
-      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/contacts")
-          .with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/contacts").
+          with(headers: { 'Accept' => 'application/json' })
     end
 
     it "supports pagination" do
@@ -60,8 +60,8 @@ describe Dnsimple::Client, ".contacts" do
     let(:account_id) { 1010 }
 
     it "delegates to client.paginate" do
-      expect(subject).to receive(:paginate).with(:contacts, account_id, { foo: "bar" })
-      subject.all_contacts(account_id, { foo: "bar" })
+      expect(subject).to receive(:paginate).with(:contacts, account_id, foo: "bar")
+      subject.all_contacts(account_id, foo: "bar")
     end
   end
 
@@ -69,8 +69,8 @@ describe Dnsimple::Client, ".contacts" do
     let(:account_id) { 1010 }
 
     before do
-      stub_request(:post, %r[/v2/#{account_id}/contacts$])
-          .to_return(read_http_fixture("createContact/created.http"))
+      stub_request(:post, %r{/v2/#{account_id}/contacts$}).
+          to_return(read_http_fixture("createContact/created.http"))
     end
 
     let(:attributes) { { first_name: "Simone", last_name: "Carletti", address1: "Italian Street", city: "Rome", state_province: "RM", postal_code: "00171", country: "IT", email_address: "example@example.com", phone: "+393391234567" } }
@@ -78,9 +78,9 @@ describe Dnsimple::Client, ".contacts" do
     it "builds the correct request" do
       subject.create_contact(account_id, attributes)
 
-      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/contacts")
-          .with(body: attributes)
-          .with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/contacts").
+          with(body: attributes).
+          with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns the contact" do
@@ -97,15 +97,15 @@ describe Dnsimple::Client, ".contacts" do
     let(:account_id) { 1010 }
 
     before do
-      stub_request(:get, %r[/v2/#{account_id}/contacts/.+$])
-          .to_return(read_http_fixture("getContact/success.http"))
+      stub_request(:get, %r{/v2/#{account_id}/contacts/.+$}).
+          to_return(read_http_fixture("getContact/success.http"))
     end
 
     it "builds the correct request" do
       subject.contact(account_id, contact = 1)
 
-      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/contacts/#{contact}")
-          .with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/contacts/#{contact}").
+          with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns the contact" do
@@ -122,8 +122,8 @@ describe Dnsimple::Client, ".contacts" do
 
     context "when the contact does not exist" do
       it "raises NotFoundError" do
-        stub_request(:get, %r[/v2])
-            .to_return(read_http_fixture("notfound-contact.http"))
+        stub_request(:get, %r{/v2}).
+            to_return(read_http_fixture("notfound-contact.http"))
 
         expect {
           subject.contact(account_id, 0)
@@ -136,8 +136,8 @@ describe Dnsimple::Client, ".contacts" do
     let(:account_id) { 1010 }
 
     before do
-      stub_request(:patch, %r[/v2/#{account_id}/contacts/.+$])
-          .to_return(read_http_fixture("updateContact/success.http"))
+      stub_request(:patch, %r{/v2/#{account_id}/contacts/.+$}).
+          to_return(read_http_fixture("updateContact/success.http"))
     end
 
     let(:attributes) { { first_name: "Updated" } }
@@ -145,9 +145,9 @@ describe Dnsimple::Client, ".contacts" do
     it "builds the correct request" do
       subject.update_contact(account_id, contact_id = 1, attributes)
 
-      expect(WebMock).to have_requested(:patch, "https://api.dnsimple.test/v2/#{account_id}/contacts/#{contact_id}")
-          .with(body: attributes)
-          .with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:patch, "https://api.dnsimple.test/v2/#{account_id}/contacts/#{contact_id}").
+          with(body: attributes).
+          with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns the contact" do
@@ -161,8 +161,8 @@ describe Dnsimple::Client, ".contacts" do
 
     context "when the contact does not exist" do
       it "raises NotFoundError" do
-        stub_request(:patch, %r[/v2])
-            .to_return(read_http_fixture("notfound-contact.http"))
+        stub_request(:patch, %r{/v2}).
+            to_return(read_http_fixture("notfound-contact.http"))
 
         expect {
           subject.update_contact(account_id, 0, {})
@@ -175,15 +175,15 @@ describe Dnsimple::Client, ".contacts" do
     let(:account_id) { 1010 }
 
     before do
-      stub_request(:delete, %r[/v2/#{account_id}/contacts/.+$])
-          .to_return(read_http_fixture("deleteContact/success.http"))
+      stub_request(:delete, %r{/v2/#{account_id}/contacts/.+$}).
+          to_return(read_http_fixture("deleteContact/success.http"))
     end
 
     it "builds the correct request" do
       subject.delete_contact(account_id, domain = "example.com")
 
-      expect(WebMock).to have_requested(:delete, "https://api.dnsimple.test/v2/#{account_id}/contacts/#{domain}")
-          .with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:delete, "https://api.dnsimple.test/v2/#{account_id}/contacts/#{domain}").
+          with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns nothing" do
@@ -196,8 +196,8 @@ describe Dnsimple::Client, ".contacts" do
 
     context "when the contact does not exist" do
       it "raises NotFoundError" do
-        stub_request(:delete, %r[/v2])
-            .to_return(read_http_fixture("notfound-contact.http"))
+        stub_request(:delete, %r{/v2}).
+            to_return(read_http_fixture("notfound-contact.http"))
 
         expect {
           subject.delete_contact(account_id, 0)

data/spec/dnsimple/client/domains_email_forwards_spec.rb

@@ -10,15 +10,15 @@ describe Dnsimple::Client, ".domains" do
     let(:domain_id) { "example.com" }
 
     before do
-      stub_request(:get, %r[/v2/#{account_id}/domains/#{domain_id}/email_forwards])
-          .to_return(read_http_fixture("listEmailForwards/success.http"))
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/email_forwards}).
+          to_return(read_http_fixture("listEmailForwards/success.http"))
     end
 
     it "builds the correct request" do
       subject.email_forwards(account_id, domain_id)
 
-      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards")
-          .with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards").
+          with(headers: { 'Accept' => 'application/json' })
     end
 
     it "supports pagination" do
@@ -58,8 +58,8 @@ describe Dnsimple::Client, ".domains" do
 
     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"))
+        stub_request(:get, %r{/v2}).
+            to_return(read_http_fixture("notfound-domain.http"))
 
         expect {
           subject.email_forwards(account_id, domain_id)
@@ -73,8 +73,8 @@ describe Dnsimple::Client, ".domains" do
     let(:domain_id) { "example.com" }
 
     it "delegates to client.paginate" do
-      expect(subject).to receive(:paginate).with(:email_forwards, account_id, domain_id, { foo: "bar" })
-      subject.all_email_forwards(account_id, domain_id, { foo: "bar" })
+      expect(subject).to receive(:paginate).with(:email_forwards, account_id, domain_id, foo: "bar")
+      subject.all_email_forwards(account_id, domain_id, foo: "bar")
     end
   end
 
@@ -83,8 +83,8 @@ describe Dnsimple::Client, ".domains" do
     let(:domain_id) { "example.com" }
 
     before do
-      stub_request(:post, %r[/v2/#{account_id}/domains/#{domain_id}/email_forwards$])
-          .to_return(read_http_fixture("createEmailForward/created.http"))
+      stub_request(:post, %r{/v2/#{account_id}/domains/#{domain_id}/email_forwards$}).
+          to_return(read_http_fixture("createEmailForward/created.http"))
     end
 
     let(:attributes) { { from: "jim", to: "jim@another.com" } }
@@ -92,9 +92,9 @@ describe Dnsimple::Client, ".domains" do
     it "builds the correct request" do
       subject.create_email_forward(account_id, domain_id, attributes)
 
-      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards")
-          .with(body: attributes)
-          .with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards").
+          with(body: attributes).
+          with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns the email forward" do
@@ -113,15 +113,15 @@ describe Dnsimple::Client, ".domains" do
     let(:email_forward_id) { 17706 }
 
     before do
-      stub_request(:get, %r[/v2/#{account_id}/domains/#{domain_id}/email_forwards.+$])
-          .to_return(read_http_fixture("getEmailForward/success.http"))
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/email_forwards.+$}).
+          to_return(read_http_fixture("getEmailForward/success.http"))
     end
 
     it "builds the correct request" do
       subject.email_forward(account_id, domain_id, email_forward_id)
 
-      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards/#{email_forward_id}")
-          .with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards/#{email_forward_id}").
+          with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns the email forward" do
@@ -140,8 +140,8 @@ describe Dnsimple::Client, ".domains" do
 
     context "when the email forward does not exist" do
       it "raises NotFoundError" do
-        stub_request(:get, %r[/v2])
-            .to_return(read_http_fixture("notfound-emailforward.http"))
+        stub_request(:get, %r{/v2}).
+            to_return(read_http_fixture("notfound-emailforward.http"))
 
         expect {
           subject.email_forward(account_id, domain_id, email_forward_id)
@@ -156,15 +156,15 @@ describe Dnsimple::Client, ".domains" do
     let(:email_forward_id) { 1 }
 
     before do
-      stub_request(:delete, %r[/v2/#{account_id}/domains/#{domain_id}/email_forwards/#{email_forward_id}$])
-          .to_return(read_http_fixture("deleteEmailForward/success.http"))
+      stub_request(:delete, %r{/v2/#{account_id}/domains/#{domain_id}/email_forwards/#{email_forward_id}$}).
+          to_return(read_http_fixture("deleteEmailForward/success.http"))
     end
 
     it "builds the correct request" do
       subject.delete_email_forward(account_id, domain_id, email_forward_id)
 
-      expect(WebMock).to have_requested(:delete, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards/#{email_forward_id}")
-          .with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:delete, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards/#{email_forward_id}").
+          with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns nothing" do
@@ -177,8 +177,8 @@ describe Dnsimple::Client, ".domains" do
 
     context "when the email forward does not exist" do
       it "raises NotFoundError" do
-        stub_request(:delete, %r[/v2])
-            .to_return(read_http_fixture("notfound-emailforward.http"))
+        stub_request(:delete, %r{/v2}).
+            to_return(read_http_fixture("notfound-emailforward.http"))
 
         expect {
           subject.delete_email_forward(account_id, domain_id, email_forward_id)