dnsimple-ruby 1.2.6 → 1.3.0

data/lib/dnsimple/client.rb

@@ -1,74 +1,112 @@
-module DNSimple
-  class Client
-    def self.debug?
-      @debug
-    end
-    def self.debug=(debug)
-      @debug = debug
-    end
+class DNSimple::Client
+  def self.debug?
+    @debug
+  end
 
-    def self.username
-      raise RuntimeError, "You must set your username first: DNSimple::Client.username = 'username'" unless defined?(@@username)
-      @@username
-    end
+  def self.debug=(debug)
+    @debug = debug
+  end
 
-    def self.username=(username)
-      @@username = username
-    end
+  def self.username
+    @username
+  end
 
-    def self.password
-      raise RuntimeError, "You must set your password first: DNSimple::Client.password = 'password'" unless defined?(@@password)
-      @@password
-    end
+  def self.username=(username)
+    @username = username
+  end
 
-    def self.password=(password)
-      @@password = password
-    end
+  def self.password
+    @password
+  end
 
-    def self.credentials
-      {:username => self.username, :password => self.password}
-    end
+  def self.password=(password)
+    @password = password
+  end
 
-    def self.base_uri
-      @@base_uri ||= "https://dnsimple.com"
-    end
+  def self.api_token
+    @api_token
+  end
 
-    def self.base_uri=(base_uri)
-      @@base_uri = base_uri ? base_uri.gsub(/\/$/, '') : nil
-    end
+  def self.api_token=(api_token)
+    @api_token = api_token
+  end
 
-    def self.load_credentials_if_necessary
-      load_credentials unless credentials_loaded?
-    end
+  def self.base_uri
+    @base_uri ||= "https://dnsimple.com/"
+  end
 
-    def self.config_path
-      ENV['DNSIMPLE_CONFIG'] || '~/.dnsimple'
-    end
+  def self.base_uri=(base_uri)
+    base_uri += '/' if base_uri[/\/$/].nil?
+    @base_uri = base_uri
+  end
 
-    def self.load_credentials(path=config_path)
-      begin
-        credentials = YAML.load(File.new(File.expand_path(path)))
-        self.username = credentials['username']
-        self.password = credentials['password']
-        self.base_uri = credentials['site']
-        @@credentials_loaded = true
-        "Credentials loaded from #{path}" 
-      rescue
-        puts "Error loading your credentials: #{$!.message}"
-        exit 1
-      end
-    end
+  def self.load_credentials_if_necessary
+    load_credentials unless credentials_loaded?
+  end
+
+  def self.config_path
+    ENV['DNSIMPLE_CONFIG'] || '~/.dnsimple'
+  end
 
-    def self.credentials_loaded?
-      (@@credentials_loaded ||= false) or (defined?(@@username) and defined?(@@password))
+  def self.load_credentials(path=config_path)
+    begin
+      credentials = YAML.load(File.new(File.expand_path(path)))
+      self.username  = credentials['username']
+      self.password  = credentials['password']
+      self.api_token = credentials['api_token']
+      self.base_uri  = credentials['site']
+      @credentials_loaded = true
+      "Credentials loaded from #{path}"
+    rescue
+      puts "Error loading your credentials: #{$!.message}"
+      exit 1
     end
+  end
 
-    def self.standard_options
-      {:format => :json, :headers => {'Accept' => 'application/json'}}
+  def self.credentials_loaded?
+    (@credentials_loaded ||= false) or (username and (password or api_token))
+  end
+
+  def self.standard_options
+    options = {:format => :json, :headers => {'Accept' => 'application/json'}}
+
+    if password
+      options[:basic_auth] = {:username => username, :password => password}
+    elsif api_token
+      options[:headers]['X-DNSimple-Token'] = "#{username}:#{api_token}"
+    else
+      raise RuntimeError, 'A password or API token is required for all API requests.'
     end
 
-    def self.standard_options_with_credentials
-      standard_options.merge({:basic_auth => credentials})
+    options
+  end
+
+  def self.get(path, options = {})
+    request :get, path, options
+  end
+
+  def self.post(path, options = {})
+    request :post, path, options
+  end
+
+  def self.put(path, options = {})
+    request :put, path, options
+  end
+
+  def self.delete(path, options = {})
+    request :delete, path, options
+  end
+
+  def self.request(method, path, options)
+    response = HTTParty.send(method, "#{base_uri}#{path}",
+      standard_options.merge(options))
+
+    pp response if debug?
+
+    if response.code == 401
+      raise DNSimple::AuthenticationFailed, 'Authentication failed'
     end
+
+    response
   end
 end

data/lib/dnsimple/contact.rb

@@ -1,181 +1,148 @@
-module DNSimple #:nodoc:
-  # CLass representing a contact in DNSimple
-  class Contact
-    include HTTParty
+class DNSimple::Contact < DNSimple::Base # Class representing a contact in DNSimple
 
-    # The contact ID in DNSimple
-    attr_accessor :id
+  Aliases = {
+    'first'             => 'first_name',
+    'last'              => 'last_name',
+    'state'             => 'state_province',
+    'province'          => 'state_province',
+    'state_or_province' => 'state_province',
+    'email'             => 'email_address',
+  }
 
-    # The name of the organization in which the contact works
-    # (may be omitted)
-    attr_accessor :organization_name
+  # The contact ID in DNSimple
+  attr_accessor :id
 
-    # The contact first name
-    attr_accessor :first_name
+  # The name of the organization in which the contact works
+  # (may be omitted)
+  attr_accessor :organization_name
 
-    # The contact last name
-    attr_accessor :last_name
+  # The contact first name
+  attr_accessor :first_name
 
-    # The contact's job title (may be omitted)
-    attr_accessor :job_title
+  # The contact last name
+  attr_accessor :last_name
 
-    # The contact street address
-    attr_accessor :address1
+  # The contact's job title (may be omitted)
+  attr_accessor :job_title
 
-    # Apartment or suite number
-    attr_accessor :address2
+  # The contact street address
+  attr_accessor :address1
 
-    # The city name
-    attr_accessor :city
+  # Apartment or suite number
+  attr_accessor :address2
 
-    # The state or province name
-    attr_accessor :state_province
+  # The city name
+  attr_accessor :city
 
-    # The contact postal code
-    attr_accessor :postal_code
+  # The state or province name
+  attr_accessor :state_province
 
-    # The contact country (as a 2-character country code)
-    attr_accessor :country
+  # The contact postal code
+  attr_accessor :postal_code
 
-    # The contact email address
-    attr_accessor :email_address
+  # The contact country (as a 2-character country code)
+  attr_accessor :country
 
-    # The contact phone number
-    attr_accessor :phone
+  # The contact email address
+  attr_accessor :email_address
 
-    # The contact phone extension (may be omitted)
-    attr_accessor :phone_ext
+  # The contact phone number
+  attr_accessor :phone
 
-    # The contact fax number (may be omitted)
-    attr_accessor :fax
+  # The contact phone extension (may be omitted)
+  attr_accessor :phone_ext
 
-    # When the contact was created in DNSimple
-    attr_accessor :created_at
+  # The contact fax number (may be omitted)
+  attr_accessor :fax
 
-    # When the contact was last updated in DNSimple
-    attr_accessor :updated_at
+  # When the contact was created in DNSimple
+  attr_accessor :created_at
 
-    #:nodoc:
-    def initialize(attributes)
-      attributes.each do |key, value|
-        m = "#{key}=".to_sym
-        self.send(m, value) if self.respond_to?(m)
-      end
-    end
+  # When the contact was last updated in DNSimple
+  attr_accessor :updated_at
 
-    def name
-      [first_name, last_name].join(' ')
-    end
+  def name
+    [first_name, last_name].join(' ')
+  end
 
-    def save(options={})
-      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[Contact.resolve(attribute)] = self.send(attribute)
-      end
-
-      options.merge!(DNSimple::Client.standard_options_with_credentials)
-      options.merge!({:body => {:contact => contact_hash}})
-      
-      response = self.class.put("#{Client.base_uri}/contacts/#{id}", options)
-
-      pp response if Client.debug?
-
-      case response.code
-      when 200
-        return self
-      when 401
-        raise RuntimeError, "Authentication failed"
-      else
-        raise RuntimeError, "Failed to update contact: #{response.inspect}"
-      end
+  def save(options={})
+    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)
     end
 
-    # Delete the contact from DNSimple. WARNING: this cannot be undone.
-    def delete(options={})
-      options.merge!({:basic_auth => Client.credentials})
-      self.class.delete("#{Client.base_uri}/contacts/#{id}.json", options)
-    end
-    alias :destroy :delete
-
-    # Map an aliased field name to it's real name. For example, if you
-    # pass "first" it will be resolved to "first_name", "email" is resolved
-    # to "email_address" and so on.
-    def self.resolve(name)
-      aliases = {
-        'first' => 'first_name',
-        'last' => 'last_name',
-        'state' => 'state_province',
-        'province' => 'state_province',
-        'state_or_province' => 'state_province',
-        'email' => 'email_address',
-      }
-      aliases[name.to_s] || name
-    end
+    options.merge!({:body => {:contact => contact_hash}})
+
+    response = DNSimple::Client.put("contacts/#{id}", options)
 
-    def self.resolve_attributes(attributes)
-      resolved_attributes = {}
-      attributes.each do |k, v|
-        resolved_attributes[resolve(k)] = v
-      end
-      resolved_attributes
+    case response.code
+    when 200
+      return self
+    else
+      raise RuntimeError, "Failed to update contact: #{response.inspect}"
     end
+  end
+
+  # Delete the contact from DNSimple. WARNING: this cannot be undone.
+  def delete(options={})
+    DNSimple::Client.delete("contacts/#{id}.json", options)
+  end
+  alias :destroy :delete
 
-    # Create the contact with the given attributes in DNSimple.
-    # This method returns a Contact instance of the contact is created
-    # and raises an error otherwise.
-    def self.create(attributes, options={})
-      contact_hash = resolve_attributes(attributes)
+  # Map an aliased field name to it's real name. For example, if you
+  # 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
+  end
 
-      options.merge!({:body => {:contact => contact_hash}})
-      options.merge!({:basic_auth => Client.credentials})
+  def self.resolve_attributes(attributes)
+    resolved_attributes = {}
+    attributes.each do |k, v|
+      resolved_attributes[resolve(k)] = v
+    end
+    resolved_attributes
+  end
 
-      response = self.post("#{Client.base_uri}/contacts.json", options)
+  # Create the contact with the given attributes in DNSimple.
+  # This method returns a Contact instance of the contact is created
+  # and raises an error otherwise.
+  def self.create(attributes, options={})
+    contact_hash = resolve_attributes(attributes)
 
-      pp response if Client.debug?
+    options.merge!({:body => {:contact => contact_hash}})
+    response = DNSimple::Client.post 'contacts.json', options
 
-      case response.code
-      when 201
-        return Contact.new(response["contact"])
-      when 401
-        raise RuntimeError, "Authentication failed"
-      else
-        raise RuntimeError, "Failed to create contact: #{response.inspect}"
-      end
+    case response.code
+    when 201
+      return new(response["contact"])
+    else
+      raise RuntimeError, "Failed to create contact: #{response.inspect}"
     end
+  end
 
-    def self.find(id, options={})
-      options.merge!({:basic_auth => Client.credentials})
-      response = self.get("#{Client.base_uri}/contacts/#{id}.json", options)
-
-      pp response if Client.debug?
-
-      case response.code
-      when 200
-        return Contact.new(response["contact"])
-      when 401
-        raise RuntimeError, "Authentication failed"
-      when 404
-        raise RuntimeError, "Could not find contact #{id}"
-      else
-        raise DNSimple::Error.new(id, response["errors"])
-      end
-    end
+  def self.find(id, options={})
+    response = DNSimple::Client.get "contacts/#{id}.json", options
 
-    def self.all(options={})
-      options.merge!({:basic_auth => Client.credentials})
-      response = self.get("#{Client.base_uri}/contacts.json", options)
+    case response.code
+    when 200
+      return new(response["contact"])
+    when 404
+      raise RuntimeError, "Could not find contact #{id}"
+    else
+      raise DNSimple::Error.new(id, response["errors"])
+    end
+  end
 
-      pp response if Client.debug?
+  def self.all(options={})
+    response = DNSimple::Client.get 'contacts.json', options
 
-      case response.code
-      when 200
-        response.map { |r| Contact.new(r["contact"]) }
-      when 401
-        raise RuntimeError, "Authentication failed"
-      else
-        raise RuntimeError, "Error: #{response.code}"
-      end
+    case response.code
+    when 200
+      response.map { |r| new(r["contact"]) }
+    else
+      raise RuntimeError, "Error: #{response.code}"
     end
   end
 end