dnsimple 2.0.0.a → 2.0.0.alpha2

data/lib/dnsimple/contact.rb

@@ -1,4 +1,4 @@
-module DNSimple
+module Dnsimple
 
   # Represents a contact.
   class Contact < Base
@@ -68,7 +68,7 @@ module DNSimple
     # pass "first" it will be resolved to "first_name", "email" is resolved
     # to "email_address" and so on.
     def self.resolve(name)
-      DNSimple::Contact::Aliases[name.to_s] || name
+      Contact::Aliases[name.to_s] || name
     end
 
     def self.resolve_attributes(attributes)
@@ -86,7 +86,7 @@ module DNSimple
       contact_hash = resolve_attributes(attributes)
 
       options.merge!({:body => {:contact => contact_hash}})
-      response = DNSimple::Client.post("/v1/contacts", options)
+      response = Client.post("/v1/contacts", options)
 
       case response.code
       when 201
@@ -97,7 +97,7 @@ module DNSimple
     end
 
     def self.find(id, options={})
-      response = DNSimple::Client.get("/v1/contacts/#{id}", options)
+      response = Client.get("/v1/contacts/#{id}", options)
 
       case response.code
       when 200
@@ -110,7 +110,7 @@ module DNSimple
     end
 
     def self.all(options={})
-      response = DNSimple::Client.get("/v1/contacts", options)
+      response = Client.get("/v1/contacts", options)
 
       case response.code
       when 200
@@ -129,12 +129,12 @@ module DNSimple
       contact_hash = {}
       %w(first_name last_name organization_name job_title address1 address2 city
       state_province postal_code country email_address phone phone_ext fax).each do |attribute|
-        contact_hash[DNSimple::Contact.resolve(attribute)] = self.send(attribute)
+        contact_hash[Contact.resolve(attribute)] = self.send(attribute)
       end
 
       options.merge!({:body => {:contact => contact_hash}})
 
-      response = DNSimple::Client.put("/v1/contacts/#{id}", options)
+      response = Client.put("/v1/contacts/#{id}", options)
 
       case response.code
         when 200
@@ -144,9 +144,12 @@ module DNSimple
       end
     end
 
-    # Delete the contact from DNSimple. WARNING: this cannot be undone.
+    # #delete the contact from DNSimple.
+    #
+    # WARNING: this cannot be undone.
+    #
     def delete(options={})
-      DNSimple::Client.delete("/v1/contacts/#{id}", options)
+      Client.delete("/v1/contacts/#{id}", options)
     end
     alias :destroy :delete
 

data/lib/dnsimple/domain.rb

@@ -1,64 +1,66 @@
-module DNSimple
+module Dnsimple
   class Domain < Base
 
-    # The domain ID in DNSimple
+    # The Fixnum domain ID in DNSimple.
     attr_accessor :id
 
-    # The domain name
-    attr_accessor :name
-
-    # When the domain was created in DNSimple
-    attr_accessor :created_at
-
-    # When the domain was last update in DNSimple
-    attr_accessor :updated_at
+    # The Fixnum associated user ID.
+    attr_accessor :user_id
 
-    # The current known name server status
-    attr_accessor :name_server_status
+    # The Fixnum associated registrant ID.
+    attr_accessor :registrant_id
 
-    # When the domain is due to expire
-    attr_accessor :expires_on
+    # The String name.
+    attr_accessor :name
 
-    # The state of the domain in DNSimple
+    # The String state.
     attr_accessor :state
 
-    # ID of the registrant in DNSimple
-    attr_accessor :registrant_id
+    # The String API token
+    attr_accessor :token
 
-    # User ID in DNSimple
-    attr_accessor :user_id
-    
-    # Is the domain lockable
-    attr_accessor :lockable
-    
-    # Is the domain set to autorenew
+    # Is the domain set to auto renew?
     attr_accessor :auto_renew
-    
-    # Is the whois information protected
+
+    # Is the whois information protected?
     attr_accessor :whois_protected
 
+    # The Date the domain will expire.
+    attr_accessor :expires_on
 
-    # Check the availability of a name
-    def self.check(name, options={})
-      response = DNSimple::Client.get("/v1/domains/#{name}/check", options)
+    # The Date the domain was created in DNSimple.
+    attr_accessor :created_at
+
+    # The Date the domain was last update in DNSimple.
+    attr_accessor :updated_at
+
+
+    # Lists the domains in the DNSimple account.
+    #
+    # @return [Array<Domain>]
+    def self.list(options = {})
+      response = Client.get("/v1/domains", options)
 
       case response.code
       when 200
-        "registered"
-      when 404
-        "available"
+        response.map { |r| new(r["domain"]) }
       else
-        raise RequestError.new("Error checking availability", response)
+        raise RequestError.new("Error listing domains", response)
       end
     end
 
-    # Create the domain with the given name in DNSimple. This
-    # method returns a Domain instance if the name is created
-    # and raises an error otherwise.
-    def self.create(name, options={})
-      options.merge!({:body => {:domain => {:name => name}}})
+    def self.all(*args); list(*args); end
 
-      response = DNSimple::Client.post("/v1/domains", options)
+    # Creates the domain in the DNSimple account.
+    #
+    # @param  [String] name The domain name.
+    #
+    # @return [Domain] The newly created domain.
+    # @raise  [RequestError] When the request fails.
+    def self.create(name)
+      options = { body: { domain: { name: name }}}
+
+      response = Client.post("/v1/domains", options)
 
       case response.code
       when 201
@@ -68,6 +70,62 @@ module DNSimple
       end
     end
 
+    # Gets a specific domain in the account.
+    #
+    # @param [Fixnum,String] id Either the numeric ID or the fully-qualified domain name.
+    #
+    # @return [Domain] The domain.
+    # @raise  [RecordNotFound] When the domain doesn't exist.
+    # @raise  [RequestError] When the request fails.
+    def self.find(id)
+      response = Client.get("/v1/domains/#{id}")
+
+      case response.code
+      when 200
+        new(response["domain"])
+      when 404
+        raise RecordNotFound, "Could not find domain #{id}"
+      else
+        raise RequestError.new("Error finding domain", response)
+      end
+    end
+
+    # Deletes a specific domain from the account.
+    #
+    # WARNING: this cannot be undone.
+    #
+    # @param [Fixnum,String] id Either the numeric ID or the fully-qualified domain name.
+    #
+    # @return [void]
+    # @raise  [RecordNotFound] When the domain doesn't exist.
+    # @raise  [RequestError] When the request fails.
+    def self.delete(id)
+      response = Client.delete("/v1/domains/#{id}")
+
+      case response.code
+      when 200, 204
+        true
+      when 404
+        raise RecordNotFound, "Could not find domain #{id}"
+      else
+        raise RequestError.new("Error deleting domain", response)
+      end
+    end
+
+    # Check the availability of a name
+    def self.check(name, options={})
+      response = Client.get("/v1/domains/#{name}/check", options)
+
+      case response.code
+        when 200
+          "registered"
+        when 404
+          "available"
+        else
+          raise RequestError.new("Error checking availability", response)
+      end
+    end
+
     # Purchase a domain name.
     def self.register(name, registrant={}, extended_attributes={}, options={})
       body = {:domain => {:name => name}}
@@ -75,48 +133,22 @@ module DNSimple
         if registrant[:id]
           body[:domain][:registrant_id] = registrant[:id]
         else
-          body.merge!(:contact => DNSimple::Contact.resolve_attributes(registrant))
+          body.merge!(:contact => Contact.resolve_attributes(registrant))
         end
       end
       body.merge!(:extended_attribute => extended_attributes)
       options.merge!({:body => body})
 
-      response = DNSimple::Client.post("/v1/domain_registrations", options)
+      response = Client.post("/v1/domain_registrations", options)
 
       case response.code
       when 201
-        return DNSimple::Domain.new(response["domain"])
+        return Domain.new(response["domain"])
       else
         raise RequestError.new("Error registering domain", response)
       end
     end
 
-    # Find a specific domain in the account either by the numeric ID
-    # or by the fully-qualified domain name.
-    def self.find(id, options={})
-      response = DNSimple::Client.get("/v1/domains/#{id}", options)
-
-      case response.code
-      when 200
-        new(response["domain"])
-      when 404
-        raise RecordNotFound, "Could not find domain #{id}"
-      else
-        raise RequestError.new("Error finding domain", response)
-      end
-    end
-
-    # Get all domains for the account.
-    def self.all(options={})
-      response = DNSimple::Client.get("/v1/domains", options)
-
-      case response.code
-      when 200
-        response.map { |r| new(r["domain"]) }
-      else
-        raise RequestError.new("Error listing domains", response)
-      end
-    end
 
     # Enable auto_renew on the domain
     def enable_auto_renew
@@ -130,10 +162,13 @@ module DNSimple
       auto_renew!(:delete)
     end
 
-    # Delete the domain from DNSimple. WARNING: this cannot
-    # be undone.
-    def delete(options={})
-      DNSimple::Client.delete("/v1/domains/#{name}", options)
+    # Deletes this domain from the account.
+    #
+    # WARNING: this cannot be undone.
+    #
+    # @see .delete
+    def delete
+      self.class.delete(name)
     end
     alias :destroy :delete
 
@@ -143,35 +178,35 @@ module DNSimple
       options.merge!(:body => {})
       template = resolve_template(template)
 
-      DNSimple::Client.post("/v1/domains/#{name}/templates/#{template.id}/apply", options)
+      Client.post("/v1/domains/#{name}/templates/#{template.id}/apply", options)
     end
 
     def resolve_template(template)
       case template
-      when DNSimple::Template
+      when Template
         template
       else
-        DNSimple::Template.find(template)
+        Template.find(template)
       end
     end
 
     def applied_services(options={})
-      response = DNSimple::Client.get("/v1/domains/#{name}/applied_services", options)
+      response = Client.get("/v1/domains/#{name}/applied_services", options)
 
       case response.code
       when 200
-        response.map { |r| DNSimple::Service.new(r["service"]) }
+        response.map { |r| Service.new(r["service"]) }
       else
         raise RequestError.new("Error listing applied services", response)
       end
     end
 
     def available_services(options={})
-      response = DNSimple::Client.get("/v1/domains/#{name}/available_services", options)
+      response = Client.get("/v1/domains/#{name}/available_services", options)
 
       case response.code
       when 200
-        response.map { |r| DNSimple::Service.new(r["service"]) }
+        response.map { |r| Service.new(r["service"]) }
       else
         raise RequestError.new("Error listing available services", response)
       end
@@ -179,7 +214,7 @@ module DNSimple
 
     def add_service(id_or_short_name, options={})
       options.merge!(:body => {:service => {:id => id_or_short_name}})
-      response = DNSimple::Client.post("/v1/domains/#{name}/applied_services", options)
+      response = Client.post("/v1/domains/#{name}/applied_services", options)
 
       case response.code
       when 200
@@ -190,7 +225,7 @@ module DNSimple
     end
 
     def remove_service(id, options={})
-      response = DNSimple::Client.delete("/v1/domains/#{name}/applied_services/#{id}", options)
+      response = Client.delete("/v1/domains/#{name}/applied_services/#{id}", options)
 
       case response.code
       when 200
@@ -204,7 +239,7 @@ module DNSimple
     private
 
     def auto_renew!(method)
-      response = DNSimple::Client.send(method, "/v1/domains/#{name}/auto_renewal")
+      response = Client.send(method, "/v1/domains/#{name}/auto_renewal")
       case response.code
       when 200
         self.auto_renew = response['domain']['auto_renew']

data/lib/dnsimple/error.rb

@@ -1,4 +1,4 @@
-module DNSimple
+module Dnsimple
 
   class Error < StandardError
   end
@@ -9,13 +9,24 @@ module DNSimple
   class RecordNotFound < Error
   end
 
+  # An exception that is raised if a method is called with missing or invalid parameter values.
+  class ValidationError < Error
+  end
+
   class RequestError < Error
     def initialize(description, response)
       super("#{description}: #{response["error"]}")
     end
   end
 
-  class AuthenticationFailed < Error
+  class AuthenticationError < Error
+  end
+
+  class AuthenticationFailed < AuthenticationError
+  end
+
+  # An exception that is raised if a request is executed for an account that requires two-factor authentication.
+  class TwoFactorAuthenticationRequired < AuthenticationError
   end
 
 end

data/lib/dnsimple/extended_attribute.rb

@@ -1,4 +1,4 @@
-module DNSimple
+module Dnsimple
 
   # Used for domains that require extended attributes.
   class ExtendedAttribute < Base
@@ -32,13 +32,13 @@ module DNSimple
     def options=(opts)
       @options = []
       opts.each do |opt|
-        @options << DNSimple::ExtendedAttribute::Option.new(opt)
+        @options << ExtendedAttribute::Option.new(opt)
       end
     end
 
     # Find the extended attributes for the given TLD
     def self.find(tld, options={})
-      response = DNSimple::Client.get("/v1/extended_attributes/#{tld}", options)
+      response = Client.get("/v1/extended_attributes/#{tld}", options)
 
       case response.code
       when 200

data/lib/dnsimple/record.rb

@@ -1,4 +1,4 @@
-module DNSimple
+module Dnsimple
 
   class Record < Base
     Aliases = {
@@ -16,18 +16,18 @@ module DNSimple
 
 
     def fqdn
-      [name, domain.name].delete_if { |v| v !~ DNSimple::BLANK_REGEX }.join(".")
+      [name, domain.name].delete_if { |v| v !~ BLANK_REGEX }.join(".")
     end
 
     def save(options={})
       record_hash = {}
       %w(name content ttl prio).each do |attribute|
-        record_hash[DNSimple::Record.resolve(attribute)] = self.send(attribute)
+        record_hash[Record.resolve(attribute)] = self.send(attribute)
       end
 
       options.merge!(:body => {:record => record_hash})
 
-      response = DNSimple::Client.put("/v1/domains/#{domain.id}/records/#{id}", options)
+      response = Client.put("/v1/domains/#{domain.id}/records/#{id}", options)
 
       case response.code
       when 200
@@ -38,12 +38,12 @@ module DNSimple
     end
 
     def delete(options={})
-      DNSimple::Client.delete("/v1/domains/#{domain.id}/records/#{id}", options)
+      Client.delete("/v1/domains/#{domain.id}/records/#{id}", options)
     end
     alias :destroy :delete
 
     def self.resolve(name)
-      DNSimple::Record::Aliases[name] || name
+      Record::Aliases[name] || name
     end
 
     def self.create(domain, name, record_type, content, options={})
@@ -54,7 +54,7 @@ module DNSimple
 
       options.merge!({:body => {:record => record_hash}})
 
-      response = DNSimple::Client.post("/v1/domains/#{domain.name}/records", options)
+      response = Client.post("/v1/domains/#{domain.name}/records", options)
 
       case response.code
       when 201
@@ -67,7 +67,7 @@ module DNSimple
     end
 
     def self.find(domain, id, options={})
-      response = DNSimple::Client.get("/v1/domains/#{domain.name}/records/#{id}", options)
+      response = Client.get("/v1/domains/#{domain.name}/records/#{id}", options)
 
       case response.code
       when 200
@@ -80,7 +80,7 @@ module DNSimple
     end
 
     def self.all(domain, options={})
-      response = DNSimple::Client.get("/v1/domains/#{domain.name}/records", options)
+      response = Client.get("/v1/domains/#{domain.name}/records", options)
 
       case response.code
       when 200