dnsimple 2.0.0.a

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,8 @@
+# Bundler
+.bundle
+pkg/*
+Gemfile.lock
+
+# YARD
+.yardoc
+yardoc/

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.ruby-gemset

@@ -0,0 +1 @@
+dnsimple-ruby

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0

data/.travis.yml

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

data/CHANGELOG.markdown

@@ -0,0 +1,50 @@
+# Changelog
+
+#### Release 2.0.0
+
+- NEW: Separated CLI from library. The CLI may be found at https://github.com/aetrion/dnsimple-cli
+
+#### Release 1.5.4
+
+- NEW: Added domain#expires_on attribute (GH-34). Thanks @alkema
+
+- NEW: Add various missing domain attributes (GH-38). Thanks @nickhammond
+
+- NEW: Added support for auto-renewal (GH-36). Thanks @mzuneska
+
+- CHANGED: User.me now uses the correct patch for API v1.
+
+#### Release 1.5.3
+
+- FIXED: In some cases the client crashed with NoMethodError VERSION (GH-35).
+
+#### Release 1.5.2
+
+- NEW: Provide a meaningful user-agent.
+
+#### Release 1.5.1
+
+- FIXED: Invalid base URI.
+
+#### Release 1.5.0
+
+- CHANGED: Added support for versioned API (GH-33)
+
+#### Release 1.4.0
+
+- CHANGED: Normalized exception handling. No more RuntimeError.
+  In case of request error, the client raises RequestError, RecordExists or RecodNotFound
+  depending on the called method.
+
+- CHANGED: Use Accept header to determine the request type instead of the .json suffix in the URL.
+
+- CHANGED: Renamed commands to the ObjectAction scheme (e.g. CreateDomain became DomainCreate).
+
+- CHANGED: Removed DomainError, UserNotFound, CertificateNotFound, CertificateExists error classes.
+  See Error and RequestError.
+
+- CHANGED: Removed DNSimple::Command base class.
+
+- FIXED: Cucumber was trying to execute steps on dnsimple.com main website instead of given site.
+
+- FIXED: We're no longer accepting route format. Use the correct header.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010-2014 Aetrion LLC
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.markdown

@@ -0,0 +1,60 @@
+# DNSimple Ruby API Wrapper
+
+[![Build Status](https://secure.travis-ci.org/aetrion/dnsimple-ruby.png)](http://travis-ci.org/aetrion/dnsimple-ruby)
+
+A Ruby API wrapper for the [DNSimple API](http://developer.dnsimple.com/).
+
+[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.
+
+## Installation
+
+    $ gem install dnsimple
+
+## Credentials
+
+Create a file in your home directory called `.dnsimple`.
+
+In this file add the following:
+
+    username: YOUR_USERNAME
+    password: YOUR_PASSWORD
+
+Or if using an API token
+
+    username: YOUR_USERNAME
+    api_token: YOUR_API_TOKEN
+
+## Wrapper Classes
+
+In addition to the command line utility you may also use the included Ruby
+classes directly in your Ruby applications.
+
+Here's a short example.
+
+    require 'rubygems'
+    require 'dnsimple'
+
+    DNSimple::Client.username   = 'YOUR_USERNAME'
+    DNSimple::Client.password   = 'YOUR_PASSWORD'
+    DNSimple::Client.http_proxy = {}
+
+    user = DNSimple::User.me
+    puts "#{user.domain_count} domains"
+
+    puts "Domains..."
+    DNSimple::Domain.all.each do |domain|
+      puts "  #{domain.name}"
+    end
+
+    domain = DNSimple::Domain.find("example.com")
+    domain.apply("template") # applies a standard or custom template to the domain
+
+    domain = DNSimple::Domain.create("newdomain.com")
+    puts "Added #{domain.name}"
+    domain.delete # removes from DNSimple
+
+For the full API documentation visit http://rubydoc.info/gems/dnsimple-ruby

data/Rakefile

@@ -0,0 +1,33 @@
+require 'bundler/gem_tasks'
+
+# Run test by default.
+task :default => :spec
+task :test => :spec
+
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = !!ENV["VERBOSE"]
+end
+
+
+require 'yard'
+
+YARD::Rake::YardocTask.new(:yardoc) do |y|
+  y.options = ["--output-dir", "yardoc"]
+end
+
+namespace :yardoc do
+  task :clobber do
+    rm_r "yardoc" rescue nil
+  end
+end
+
+task :clobber => "yardoc:clobber"
+
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r dnsimple.rb"
+end

data/dnsimple-ruby.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'dnsimple/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'dnsimple'
+  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.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_development_dependency 'rake'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'webmock'
+end

data/lib/dnsimple-ruby.rb

@@ -0,0 +1 @@
+require 'dnsimple'

data/lib/dnsimple.rb

@@ -0,0 +1,33 @@
+require 'httparty'
+
+module DNSimple
+
+  BLANK_REGEX = /\S+/
+
+  # Echoes a deprecation warning message.
+  #
+  # @param  [String] message The message to display.
+  # @return [void]
+  #
+  # @api internal
+  # @private
+  def self.deprecate(message = nil)
+    message ||= "You are using deprecated behavior which will be removed from the next major or minor release."
+    warn("DEPRECATION WARNING: #{message}")
+  end
+
+end
+
+require 'dnsimple/base'
+require 'dnsimple/client'
+require 'dnsimple/error'
+require 'dnsimple/user'
+require 'dnsimple/contact'
+require 'dnsimple/domain'
+require 'dnsimple/record'
+require 'dnsimple/template'
+require 'dnsimple/template_record'
+require 'dnsimple/transfer_order'
+require 'dnsimple/extended_attribute'
+require 'dnsimple/service'
+require 'dnsimple/certificate'

data/lib/dnsimple/base.rb

@@ -0,0 +1,10 @@
+module DNSimple
+  class Base
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        m = "#{key}=".to_sym
+        self.send(m, value) if self.respond_to?(m)
+      end
+    end
+  end
+end

data/lib/dnsimple/certificate.rb

@@ -0,0 +1,129 @@
+module DNSimple
+
+  # Represents an SSL certificate that has been purchased.
+  #
+  # The certificate must also be submitted using the #submit method
+  # before the Certificate Authority will issue a signed certificate.
+  class Certificate < Base
+
+    # The certificate ID in DNSimple
+    attr_accessor :id
+
+    attr_accessor :domain
+
+    # The subdomain on the certificate
+    attr_accessor :name
+
+    # The Certificate Signing Request
+    attr_accessor :csr
+
+    # The SSL certificate, if it has been issued by the Certificate Authority
+    attr_accessor :ssl_certificate
+
+    # The private key, if DNSimple generated the Certificate Signing Request
+    attr_accessor :private_key
+
+    # The approver email address
+    attr_accessor :approver_email
+
+    # When the certificate was purchased
+    attr_accessor :created_at
+
+    # When the certificate was last updated
+    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 order was placed
+    attr_accessor :order_date
+
+    # The date the Certificate will expire
+    attr_accessor :expiration_date
+
+
+    # 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.
+    #
+    # Example: DNSimple::Certificate.purchase(domain, 'www', contact)
+    #
+    # Please note that by 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)
+    def self.purchase(domain, name, contact, options={})
+      certificate_hash = {
+        :name => name,
+        :contact_id => contact.id
+      }
+
+      options.merge!({:body => {:certificate => certificate_hash}})
+
+      response = DNSimple::Client.post("/v1/domains/#{domain.name}/certificates", options)
+
+      case response.code
+      when 201
+        new({ :domain => domain }.merge(response["certificate"]))
+      when 406
+        raise RecordExists, "Certificate for #{domain.name} already exists"
+      else
+        raise RequestError.new("Error purchasing certificate", response)
+      end
+    end
+
+    # 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)
+
+      case response.code
+      when 200
+        response.map { |r| new({:domain => domain}.merge(r["certificate"])) }
+      else
+        raise RequestError.new("Error listing certificates", response)
+      end
+    end
+
+    # 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)
+
+      case response.code
+      when 200
+        new({:domain => domain}.merge(response["certificate"]))
+      when 404
+        raise RecordNotFound, "Could not find certificate #{id} for domain #{domain.name}"
+      else
+        raise RequestError.new("Error finding certificate", response)
+      end
+    end
+
+
+    # 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(".")
+    end
+
+    def submit(approver_email, options={})
+      raise DNSimple::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)
+
+      case response.code
+        when 200
+          Certificate.new({ :domain => domain }.merge(response["certificate"]))
+        else
+          raise RequestError.new("Error submitting certificate", response)
+      end
+    end
+
+  end
+end

data/lib/dnsimple/client.rb

@@ -0,0 +1,144 @@
+require 'dnsimple/version'
+require 'yaml'
+
+module DNSimple
+  class Client
+
+    DEFAULT_BASE_URI  = "https://api.dnsimple.com/"
+
+
+    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
+    end
+
+    # Gets the qualified API base uri.
+    #
+    # @return [String] The qualified API base uri.
+    def self.base_uri
+      @base_uri ||= DEFAULT_BASE_URI.chomp("/")
+    end
+
+    # Sets the qualified API base uri.
+    #
+    # @param [String] value The qualified API base uri.
+    def self.base_uri=(value)
+      @base_uri = value.to_s.chomp("/")
+    end
+
+    def self.http_proxy
+      @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}" },
+      }
+
+      if http_proxy
+        options.merge!(
+          :http_proxyaddr => self.http_proxy[:addr],
+          :http_proxyport => self.http_proxy[:port]
+        )
+      end
+
+      if password
+        options[:basic_auth] = { :username => username, :password => password }
+      elsif api_token
+        options[:headers]['X-DNSimple-Token'] = "#{username}:#{api_token}"
+      else
+        raise Error, 'A password or API token is required for all API requests.'
+      end
+
+      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}", base_options.merge(options))
+
+      if response.code == 401
+        raise AuthenticationFailed
+      end
+
+      response
+    end
+
+  end
+end