dnsimple 2.0.0.a → 2.0.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0418d92096c1c920c5693162451754d9bb762958
-  data.tar.gz: 21f57179e35c105fd91708c6e4144bc55c9deafc
+  metadata.gz: 0e16688144a4991e78dc2f86e78dbc558c011aa4
+  data.tar.gz: f7dc21999ebef6b8bfee73a6a9d0afefad8ca89e
 SHA512:
-  metadata.gz: 49dcab64cf05445a94c9b61413935e4bc03b270adcf9c676a69f261bd895d7ae96b870d7a2a38e1d38720cc0cbced0026df8d01f6d0071c538d333aa4a3171d0
-  data.tar.gz: 183e028e671edbd2eba42b19c4e7492ec51808365f6e3a74eebe4dfd3bb72ebeb7ef8c2f52cc66c1003c821cb8a2f36f8deec2d98e6f67c0b21e20a901d43c6b
+  metadata.gz: 461f978e357d7a1b6895253d8c1488f7d8b720fd00b1ef80008b83071ca6d4dc8b5aafcefe927b90aacc708deda5de9fbed6f491de67ef56d0bad4d44adc087c
+  data.tar.gz: aef1ebfd28622173d53fc183a5834f5b42390fc3c7d4aff75686456b9d578fe5059430aab72436c55df836284bde6bde638538d524572bde220fe14e706531ee

data/.gitignore

@@ -6,3 +6,4 @@ Gemfile.lock
 # YARD
 .yardoc
 yardoc/
+doc/

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0
+ruby-2.1

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - 2.1.0
-env: DNSIMPLE_TEST_CONFIG=spec/ci/.dnsimple.test
+env: COVERALL=1

data/CHANGELOG.markdown

@@ -1,8 +1,32 @@
 # Changelog
 
-#### Release 2.0.0
+#### 2.0.0.alpha
 
-- NEW: Separated CLI from library. The CLI may be found at https://github.com/aetrion/dnsimple-cli
+- CHANGED: Drop 1.8.7 support.
+
+- CHANGED: This package no longer provides a CLI. The CLI has been extracted to [aetrion/dnsimple-ruby-cli](https://github.com/aetrion/dnsimple-ruby-cli)
+
+- CHANGED: Renamed the Gem from "dnsimple-ruby" to "dnsimple". (GH-23)
+
+- CHANGED: Renamed the namespace from DNSimple to Dnsimple.
+
+- REMOVED: The library no longer provides built-in support for loading the credentials from a config file.
+
+#### Release 1.7.1
+
+- FIXED: Updated Certificate to match the serialized attributes (GH-53)
+
+#### Release 1.7.0
+
+- NEW: Add support for Domain-based authentication (GH-40, GH-46). Thanks @dwradcliffe and @samsonasu.
+
+#### Release 1.6.0
+
+- NEW: Add support for 2FA (GH-44)
+
+#### Release 1.5.5
+
+- NEW: Add notice about the CLI moving to a new location
 
 #### Release 1.5.4
 

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'coveralls', :require => false

data/README.markdown

@@ -1,60 +1,80 @@
-# DNSimple Ruby API Wrapper
+# DNSimple Ruby Client
 
-[![Build Status](https://secure.travis-ci.org/aetrion/dnsimple-ruby.png)](http://travis-ci.org/aetrion/dnsimple-ruby)
+A Ruby client for the [DNSimple API](http://developer.dnsimple.com/).
 
-A Ruby API wrapper for the [DNSimple API](http://developer.dnsimple.com/).
+[![Build Status](https://travis-ci.org/aetrion/dnsimple-ruby.svg?branch=master)](https://travis-ci.org/aetrion/dnsimple-ruby)
+[![Coverage Status](https://img.shields.io/coveralls/aetrion/dnsimple-ruby.svg)](https://coveralls.io/r/aetrion/dnsimple-ruby?branch=master)
 
-[DNSimple](https://dnsimple.com/) provides DNS hosting
-and domain registration that is simple and friendly.
+[DNSimple](https://dnsimple.com/) provides DNS hosting and domain registration that is simple and friendly.
+We provide a full API and an easy-to-use web interface so you can get your domain registered and set up with a minimal amount of effort.
 
-We provide a full API and an easy-to-use web interface so you can get
-your domain registered and set up with a minimal amount of effort.
 
 ## Installation
 
     $ gem install dnsimple
 
-## Credentials
 
-Create a file in your home directory called `.dnsimple`.
+## DNSimple Client
 
-In this file add the following:
+This library provides a Ruby DNSimple client you can use to interact with the [DNSimple API](http://developer.dnsimple.com/). Here's a short example.
 
-    username: YOUR_USERNAME
-    password: YOUR_PASSWORD
+```ruby
+require 'dnsimple'
 
-Or if using an API token
+DNSimple::Client.username   = 'YOUR_USERNAME'
+DNSimple::Client.password   = 'YOUR_PASSWORD'
 
-    username: YOUR_USERNAME
-    api_token: YOUR_API_TOKEN
+user = DNSimple::User.me
+puts "#{user.domain_count} domains"
 
-## Wrapper Classes
+puts "Domains..."
+DNSimple::Domain.all.each do |domain|
+  puts "  #{domain.name}"
+end
 
-In addition to the command line utility you may also use the included Ruby
-classes directly in your Ruby applications.
+domain = DNSimple::Domain.find("example.com")
+domain.apply("template") # applies a standard or custom template to the domain
 
-Here's a short example.
+domain = DNSimple::Domain.create("newdomain.com")
+puts "Added #{domain.name}"
+domain.delete # removes from DNSimple
+```
 
-    require 'rubygems'
-    require 'dnsimple'
+For the full API documentation visit http://rubydoc.info/gems/dnsimple
 
-    DNSimple::Client.username   = 'YOUR_USERNAME'
-    DNSimple::Client.password   = 'YOUR_PASSWORD'
-    DNSimple::Client.http_proxy = {}
+### Authentication
 
-    user = DNSimple::User.me
-    puts "#{user.domain_count} domains"
+This client supports both the HTTP Basic and API Token authentication mechanism.
 
-    puts "Domains..."
-    DNSimple::Domain.all.each do |domain|
-      puts "  #{domain.name}"
-    end
+#### HTTP Basic
 
-    domain = DNSimple::Domain.find("example.com")
-    domain.apply("template") # applies a standard or custom template to the domain
+```ruby
+DNSimple::Client.username = 'YOUR_USERNAME'
+DNSimple::Client.password = 'YOUR_PASSWORD'
 
-    domain = DNSimple::Domain.create("newdomain.com")
-    puts "Added #{domain.name}"
-    domain.delete # removes from DNSimple
+user = DNSimple::User.me
+```
 
-For the full API documentation visit http://rubydoc.info/gems/dnsimple-ruby
+#### HTTP Basic with two-factor authentication enabled
+
+See the [2FA API documentation](http://developer.dnsimple.com/authentication/#twofa).
+
+```ruby
+# Request the 2FA exchange token
+DNSimple::Client.username = 'YOUR_USERNAME'
+DNSimple::Client.password = 'YOUR_PASSWORD'
+token = DNSimple::User.two_factor_exchange_token('otp-token')
+
+# Authenticate with the exchange token
+DNSimple::Client.exchange_token = token
+user = DNSimple::User.me
+```
+
+#### API Token
+
+```ruby
+DNSimple::Client.username  = 'YOUR_USERNAME'
+DNSimple::Client.api_token = 'API_TOKEN'
+
+user = DNSimple::User.me
+```

data/Rakefile

@@ -2,7 +2,6 @@ require 'bundler/gem_tasks'
 
 # Run test by default.
 task :default => :spec
-task :test => :spec
 
 
 require 'rspec/core/rake_task'

data/{dnsimple-ruby.gemspec → dnsimple.gemspec}

@@ -4,19 +4,21 @@ require 'dnsimple/version'
 
 Gem::Specification.new do |s|
   s.name        = 'dnsimple'
-  s.version     = DNSimple::VERSION
+  s.version     = Dnsimple::VERSION
   s.authors     = ['Anthony Eden', 'Simone Carletti']
   s.email       = ['anthony.eden@dnsimple.com', 'simone.carletti@dnsimple.com']
   s.homepage    = 'http://github.com/aetrion/dnsimple-ruby'
-  s.summary     = 'A ruby wrapper for the DNSimple API'
-  s.description = 'A ruby wrapper for the DNSimple API.'
+  s.summary     = 'A Ruby client for the DNSimple API'
+  s.description = 'A Ruby client for the DNSimple API that also includes a command-line client.'
+
+  s.required_ruby_version = ">= 1.9.3"
 
   s.require_paths    = ['lib']
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.extra_rdoc_files = %w( README.markdown CHANGELOG.markdown LICENSE )
 
-  s.add_dependency  'httparty', RUBY_VERSION < "1.9.3" ? [">= 0.10", "< 0.12"] : "~> 0.12"
+  s.add_dependency  'httparty'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'mocha'

data/lib/dnsimple.rb

@@ -1,6 +1,6 @@
 require 'httparty'
 
-module DNSimple
+module Dnsimple
 
   BLANK_REGEX = /\S+/
 

data/lib/dnsimple/base.rb

@@ -1,4 +1,4 @@
-module DNSimple
+module Dnsimple
   class Base
     def initialize(attributes = {})
       attributes.each do |key, value|

data/lib/dnsimple/certificate.rb

@@ -1,4 +1,4 @@
-module DNSimple
+module Dnsimple
 
   # Represents an SSL certificate that has been purchased.
   #
@@ -6,57 +6,71 @@ module DNSimple
   # before the Certificate Authority will issue a signed certificate.
   class Certificate < Base
 
-    # The certificate ID in DNSimple
+    # The Fixnum certificate ID in DNSimple.
     attr_accessor :id
 
-    attr_accessor :domain
+    # The Fixnum associated domain ID.
+    attr_accessor :domain_id
+
+    # The Fixnum associated contact ID.
+    attr_accessor :contact_id
 
-    # The subdomain on the certificate
+    # The String subdomain on the certificate.
     attr_accessor :name
 
-    # The Certificate Signing Request
+    # The String state.
+    attr_accessor :state
+
+    # The String Certificate Signing Request.
     attr_accessor :csr
 
-    # The SSL certificate, if it has been issued by the Certificate Authority
+    # The String SSL certificate.
+    # It is set only if the order issued by the Certificate Authority.
     attr_accessor :ssl_certificate
 
-    # The private key, if DNSimple generated the Certificate Signing Request
+    # The String private key.
+    # It is set only if DNSimple generated the Certificate Signing Request.
     attr_accessor :private_key
 
-    # The approver email address
+    # The String approver email address
+    # It is set only if the state is submitted.
     attr_accessor :approver_email
 
-    # When the certificate was purchased
+    # The Array of all emails that can be used to approve the certificate.
+    # It is set only if the state is configured.
+    attr_accessor :approver_emails
+
+    # The Date the certificate was create in DNSimple.
     attr_accessor :created_at
 
-    # When the certificate was last updated
+    # The Date the certificate was last updated in DNSimple.
     attr_accessor :updated_at
 
-    # An array of all emails that can be used to approve the certificate
-    attr_accessor :available_approver_emails
-
-    # The Certificate status
-    attr_accessor :certificate_status
+    # The Date the certificate was configured.
+    attr_accessor :configured_at
 
-    # The date the Certificate order was placed
-    attr_accessor :order_date
+    # The Date the certificate will expire.
+    attr_accessor :expires_on
 
-    # The date the Certificate will expire
-    attr_accessor :expiration_date
+    # The associated Domain.
+    attr_accessor :domain
 
 
-    # Purchase a certificate under the given domain with the given name. The
-    # name will be appended to the domain name, and thus should only be the
-    # subdomain part.
+    # Purchases a certificate under the given domain with the given name.
     #
-    # Example: DNSimple::Certificate.purchase(domain, 'www', contact)
+    # The name will be appended to the domain name, and thus should only be the subdomain part.
     #
-    # Please note that by invoking this method DNSimple will immediately charge
+    # Invoking this method DNSimple will immediately charge
     # your credit card on file at DNSimple for the full certificate price.
     #
     # For wildcard certificates an asterisk must appear in the name.
     #
-    # Example: DNSimple::Certificate.purchase(domain, '*', contact)
+    # @example Purchase a single-hostname certificate
+    #   Dnsimple::Certificate.purchase(domain, 'www', contact)
+    #
+    # @example Purchase a wildcard certificate
+    #   Dnsimple::Certificate.purchase(domain, '*', contact)
+    #
     def self.purchase(domain, name, contact, options={})
       certificate_hash = {
         :name => name,
@@ -65,7 +79,7 @@ module DNSimple
 
       options.merge!({:body => {:certificate => certificate_hash}})
 
-      response = DNSimple::Client.post("/v1/domains/#{domain.name}/certificates", options)
+      response = Client.post("/v1/domains/#{domain.name}/certificates", options)
 
       case response.code
       when 201
@@ -79,7 +93,7 @@ module DNSimple
 
     # Get an array of all certificates for the given domain.
     def self.all(domain, options={})
-      response = DNSimple::Client.get("/v1/domains/#{domain.name}/certificates", options)
+      response = Client.get("/v1/domains/#{domain.name}/certificates", options)
 
       case response.code
       when 200
@@ -91,7 +105,7 @@ module DNSimple
 
     # Find a specific certificate for the given domain.
     def self.find(domain, id, options = {})
-      response = DNSimple::Client.get("/v1/domains/#{domain.name}/certificates/#{id}", options)
+      response = Client.get("/v1/domains/#{domain.name}/certificates/#{id}", options)
 
       case response.code
       when 200
@@ -107,21 +121,21 @@ module DNSimple
     # Get the fully-qualified domain name for the certificate. This is the
     # domain.name joined with the certificate name, separated by a period.
     def fqdn
-      [name, domain.name].delete_if { |p| p !~ DNSimple::BLANK_REGEX }.join(".")
+      [name, domain.name].delete_if { |p| p !~ BLANK_REGEX }.join(".")
     end
 
     def submit(approver_email, options={})
-      raise DNSimple::Error, "Approver email is required" unless approver_email
+      raise Error, "Approver email is required" unless approver_email
 
       options.merge!(:body => {:certificate => {:approver_email => approver_email}})
 
-      response = DNSimple::Client.put("/v1/domains/#{domain.name}/certificates/#{id}/submit", options)
+      response = Client.put("/v1/domains/#{domain.name}/certificates/#{id}/submit", options)
 
       case response.code
-        when 200
-          Certificate.new({ :domain => domain }.merge(response["certificate"]))
-        else
-          raise RequestError.new("Error submitting certificate", response)
+      when 200
+        Certificate.new({ :domain => domain }.merge(response["certificate"]))
+      else
+        raise RequestError.new("Error submitting certificate", response)
       end
     end
 

data/lib/dnsimple/client.rb

@@ -1,42 +1,22 @@
 require 'dnsimple/version'
 require 'yaml'
 
-module DNSimple
+module Dnsimple
   class Client
 
-    DEFAULT_BASE_URI  = "https://api.dnsimple.com/"
+    DEFAULT_BASE_URI = "https://api.dnsimple.com/"
+    HEADER_2FA_STRICT = "X-DNSimple-2FA-Strict"
+    HEADER_API_TOKEN = "X-DNSimple-Token"
+    HEADER_DOMAIN_API_TOKEN = "X-DNSimple-Domain-Token"
+    HEADER_OTP_TOKEN = "X-DNSimple-OTP"
+    HEADER_EXCHANGE_TOKEN = "X-DNSimple-OTP-Token"
 
+    class << self
+      # @return [Boolean] if the debug mode is enabled.
+      #   Defaults to false.
+      attr_accessor :debug
 
-    def self.debug?
-      @debug
-    end
-
-    def self.debug=(debug)
-      @debug = debug
-    end
-
-    def self.username
-      @username
-    end
-
-    def self.username=(username)
-      @username = username
-    end
-
-    def self.password
-      @password
-    end
-
-    def self.password=(password)
-      @password = password
-    end
-
-    def self.api_token
-      @api_token
-    end
-
-    def self.api_token=(api_token)
-      @api_token = api_token
+      attr_accessor :username, :password, :exchange_token, :api_token, :domain_api_token
     end
 
     # Gets the qualified API base uri.
@@ -57,56 +37,27 @@ module DNSimple
       @http_proxy
     end
 
-    def self.http_proxy=(http_proxy)
-      @http_proxy = http_proxy
-    end
-
-    def self.load_credentials_if_necessary
-      load_credentials unless credentials_loaded?
-    end
-
-    def self.config_path
-      ENV['DNSIMPLE_CONFIG'] || '~/.dnsimple'
-    end
-
-    def self.load_credentials(path = config_path)
-      begin
-        credentials = YAML.load_file(File.expand_path(path))
-        self.username   ||= credentials['username']
-        self.password   ||= credentials['password']
-        self.api_token  ||= credentials['api_token']
-        self.base_uri     = credentials['site']       if credentials['site']
-        self.base_uri     = credentials['base_uri']   if credentials['base_uri']
-        self.http_proxy   = { :addr => credentials['proxy_addr'], :port => credentials['proxy_port'] } if credentials['proxy_addr'] || credentials['proxy_port']
-        @credentials_loaded = true
-        puts "Credentials loaded from #{path}"
-      rescue => error
-        puts "Error loading your credentials: #{error.message}"
-        exit 1
-      end
-    end
-
-    def self.credentials_loaded?
-      (@credentials_loaded ||= false) or (username and (password or api_token))
-    end
-
     def self.base_options
       options = {
         :format => :json,
-        :headers => { 'Accept' => 'application/json', 'User-Agent' => "dnsimple-ruby/#{DNSimple::VERSION}" },
+        :headers => { 'Accept' => 'application/json', 'User-Agent' => "dnsimple-ruby/#{VERSION}" },
       }
 
       if http_proxy
         options.merge!(
-          :http_proxyaddr => self.http_proxy[:addr],
-          :http_proxyport => self.http_proxy[:port]
+          :http_proxyaddr => http_proxy[:addr],
+          :http_proxyport => http_proxy[:port]
         )
       end
 
-      if password
+      if exchange_token
+        options[:basic_auth] = { :username => exchange_token, :password => "x-2fa-basic" }
+      elsif password
         options[:basic_auth] = { :username => username, :password => password }
+      elsif domain_api_token
+        options[:headers][HEADER_DOMAIN_API_TOKEN] = domain_api_token
       elsif api_token
-        options[:headers]['X-DNSimple-Token'] = "#{username}:#{api_token}"
+        options[:headers][HEADER_API_TOKEN] = "#{username}:#{api_token}"
       else
         raise Error, 'A password or API token is required for all API requests.'
       end
@@ -133,8 +84,10 @@ module DNSimple
     def self.request(method, path, options)
       response = HTTParty.send(method, "#{base_uri}#{path}", base_options.merge(options))
 
-      if response.code == 401
-        raise AuthenticationFailed
+      if response.code == 401 && response.headers[HEADER_OTP_TOKEN] == "required"
+        raise TwoFactorAuthenticationRequired, response["message"]
+      elsif response.code == 401
+        raise AuthenticationFailed, response["message"]
       end
 
       response