dnsimple-ruby 1.4.1 → 1.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ad2f0f53848ebf458ce24ef1c93ffcc13987d20
+  data.tar.gz: 8dc6ab4a793415fa47675c1b32b98a9cdf8188e1
+SHA512:
+  metadata.gz: 9047c85d1d90c5da44eacf36e79cd729e346efaed3defb34340bf482605d763bad9099ee2446af89787de2bb64149a51953f36bd61ae7d4743616f34a9d1a2eb
+  data.tar.gz: cde66935f2047f166573598bc7358d7785b659e0aedbec6693dda775186ed4418adba10b348b656e65a3eb889daf01ee90bafd399d247578377e331b48e880e1

data/.gitignore

@@ -1,6 +1,3 @@
-turbulence
-.rvmrc
-
 # Bundler
 .bundle
 pkg/*

data/.ruby-version

@@ -1 +1 @@
-ruby-1.9.3
+ruby-2.0

data/.travis.yml

@@ -4,4 +4,5 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
 env: DNSIMPLE_TEST_CONFIG=spec/ci/.dnsimple.test

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 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.

data/README.md

@@ -1,8 +1,6 @@
-# DNSimple Ruby Client
+# DNSimple Ruby Client  [![Build Status](https://secure.travis-ci.org/aetrion/dnsimple-ruby.png)](http://travis-ci.org/aetrion/dnsimple-ruby)
 
-A Ruby command line utility and wrapper for the [DNSimple API](https://dnsimple.com/documentation/api).
-
-[![Build Status](https://secure.travis-ci.org/aetrion/dnsimple-ruby.png)](http://travis-ci.org/aetrion/dnsimple-ruby)
+A Ruby command line utility and wrapper for the [DNSimple API](http://developer.dnsimple.com/).
 
 [DNSimple](https://dnsimple.com/) provides DNS hosting
 and domain registration that is simple and friendly.

data/dnsimple-ruby.gemspec

@@ -15,18 +15,15 @@ Gem::Specification.new do |s|
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.extra_rdoc_files = %w( README.md CHANGELOG.md LICENSE )
-  s.executables      = `git ls-files -- bin/*`.split("\n").collect { |f|
-    File.basename(f)
-  }
+  s.executables      = `git ls-files -- bin/*`.split("\n").collect { |f| File.basename(f) }
 
-  s.add_runtime_dependency     'httparty', '>= 0'
+  s.add_dependency  'httparty', RUBY_VERSION < "1.9.3" ? [">= 0.10", "< 0.12"] : "~> 0.12"
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'aruba'
   s.add_development_dependency 'cucumber'
-  s.add_development_dependency 'fakeweb'
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'vcr'
   s.add_development_dependency 'yard'
+  s.add_development_dependency 'webmock'
 end

data/features/README.md

@@ -0,0 +1,9 @@
+Before running the DNSimple Ruby Client cucumber feature files, you must do the following:
+
+1. If you haven't already go to https://sandbox.dnsimple.com and create an account. Activate your account to the Platinum level using the credit card number of "1".
+
+2. Create a file in your home directory called .dnsimple.test and include the following:
+
+        username: YOUR_USERNAME
+        password: YOUR_PASSWORD
+        base_uri: https://api.sandbox.dnsimple.com/

data/lib/dnsimple/certificate.rb

@@ -14,57 +14,36 @@ module DNSimple
     # The subdomain on the certificate
     attr_accessor :name
 
-    # The private key, if DNSimple generated the Certificate Signing Request
-    attr_accessor :private_key
-
-    # The SSL certificate, if it has been issued by the Certificate Authority
-    attr_accessor :ssl_certificate
-
     # The Certificate Signing Request
     attr_accessor :csr
 
-    # The Certificate status
-    attr_accessor :certificate_status
-
-    # The date the Certificate order was placed
-    attr_accessor :order_date
+    # The SSL certificate, if it has been issued by the Certificate Authority
+    attr_accessor :ssl_certificate
 
-    # The date the Certificate will expire
-    attr_accessor :expiration_date
+    # The private key, if DNSimple generated the Certificate Signing Request
+    attr_accessor :private_key
 
     # The approver email address
     attr_accessor :approver_email
 
-    # An array of all emails that can be used to approve the certificate
-    attr_accessor :available_approver_emails
-
     # 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
 
-    # 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
+    # The Certificate status
+    attr_accessor :certificate_status
 
-      options.merge!(:body => {:certificate => {:approver_email => approver_email}})
+    # The date the Certificate order was placed
+    attr_accessor :order_date
 
-      response = DNSimple::Client.put("domains/#{domain.name}/certificates/#{id}/submit", options)
+    # The date the Certificate will expire
+    attr_accessor :expiration_date
 
-      case response.code
-      when 200
-        Certificate.new({ :domain => domain }.merge(response["certificate"]))
-      else
-        raise RequestError.new("Error submitting certificate", response)
-      end
-    end
 
     # 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
@@ -86,7 +65,7 @@ module DNSimple
 
       options.merge!({:body => {:certificate => certificate_hash}})
 
-      response = DNSimple::Client.post("domains/#{domain.name}/certificates", options)
+      response = DNSimple::Client.post("/v1/domains/#{domain.name}/certificates", options)
 
       case response.code
       when 201
@@ -100,7 +79,7 @@ module DNSimple
 
     # Get an array of all certificates for the given domain.
     def self.all(domain, options={})
-      response = DNSimple::Client.get("domains/#{domain.name}/certificates", options)
+      response = DNSimple::Client.get("/v1/domains/#{domain.name}/certificates", options)
 
       case response.code
       when 200
@@ -112,7 +91,7 @@ module DNSimple
 
     # Find a specific certificate for the given domain.
     def self.find(domain, id, options = {})
-      response = DNSimple::Client.get("domains/#{domain.name}/certificates/#{id}", options)
+      response = DNSimple::Client.get("/v1/domains/#{domain.name}/certificates/#{id}", options)
 
       case response.code
       when 200
@@ -124,5 +103,27 @@ module DNSimple
       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

@@ -3,6 +3,9 @@ require 'yaml'
 module DNSimple
   class Client
 
+    API_BASE_URI = "https://api.dnsimple.com/"
+
+
     def self.debug?
       @debug
     end
@@ -39,7 +42,7 @@ module DNSimple
     #
     # @return [String] The qualified API base uri.
     def self.base_uri
-      @base_uri ||= "https://dnsimple.com"
+      @base_uri ||= API_BASE_URI.chomp("/")
     end
 
     # Sets the qualified API base uri.
@@ -67,13 +70,13 @@ module DNSimple
 
     def self.load_credentials(path = config_path)
       begin
-        credentials = YAML.load(File.new(File.expand_path(path)))
+        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'] }
+        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
@@ -127,7 +130,7 @@ module DNSimple
     end
 
     def self.request(method, path, options)
-      response = HTTParty.send(method, "#{base_uri}/#{path}",
+      response = HTTParty.send(method, "#{base_uri}#{path}",
         standard_options.merge(options))
 
       if response.code == 401

data/lib/dnsimple/contact.rb

@@ -15,19 +15,30 @@ module DNSimple
     # The contact ID in DNSimple
     attr_accessor :id
 
-    # The name of the organization in which the contact works
-    # (may be omitted)
-    attr_accessor :organization_name
-
     # The contact first name
     attr_accessor :first_name
 
     # The contact last name
     attr_accessor :last_name
 
-    # The contact's job title (may be omitted)
+    # The contact's job title
     attr_accessor :job_title
 
+    # The name of the organization in which the contact works
+    attr_accessor :organization_name
+
+    # The contact email address
+    attr_accessor :email_address
+
+    # The contact phone number
+    attr_accessor :phone
+
+    # The contact phone extension (may be omitted)
+    attr_accessor :phone_ext
+
+    # The contact fax number (may be omitted)
+    attr_accessor :fax
+
     # The contact street address
     attr_accessor :address1
 
@@ -46,52 +57,12 @@ module DNSimple
     # The contact country (as a 2-character country code)
     attr_accessor :country
 
-    # The contact email address
-    attr_accessor :email_address
-
-    # The contact phone number
-    attr_accessor :phone
-
-    # The contact phone extension (may be omitted)
-    attr_accessor :phone_ext
-
-    # The contact fax number (may be omitted)
-    attr_accessor :fax
-
     # When the contact was created in DNSimple
     attr_accessor :created_at
 
     # When the contact was last updated in DNSimple
     attr_accessor :updated_at
 
-    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[DNSimple::Contact.resolve(attribute)] = self.send(attribute)
-      end
-
-      options.merge!({:body => {:contact => contact_hash}})
-
-      response = DNSimple::Client.put("contacts/#{id}", options)
-
-      case response.code
-      when 200
-        return self
-      else
-        raise RequestError.new("Error updating contact", response)
-      end
-    end
-
-    # Delete the contact from DNSimple. WARNING: this cannot be undone.
-    def delete(options={})
-      DNSimple::Client.delete("contacts/#{id}", 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
@@ -115,7 +86,7 @@ module DNSimple
       contact_hash = resolve_attributes(attributes)
 
       options.merge!({:body => {:contact => contact_hash}})
-      response = DNSimple::Client.post("contacts", options)
+      response = DNSimple::Client.post("/v1/contacts", options)
 
       case response.code
       when 201
@@ -126,7 +97,7 @@ module DNSimple
     end
 
     def self.find(id, options={})
-      response = DNSimple::Client.get("contacts/#{id}", options)
+      response = DNSimple::Client.get("/v1/contacts/#{id}", options)
 
       case response.code
       when 200
@@ -139,7 +110,7 @@ module DNSimple
     end
 
     def self.all(options={})
-      response = DNSimple::Client.get("contacts", options)
+      response = DNSimple::Client.get("/v1/contacts", options)
 
       case response.code
       when 200
@@ -149,5 +120,35 @@ module DNSimple
       end
     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[DNSimple::Contact.resolve(attribute)] = self.send(attribute)
+      end
+
+      options.merge!({:body => {:contact => contact_hash}})
+
+      response = DNSimple::Client.put("/v1/contacts/#{id}", options)
+
+      case response.code
+        when 200
+          return self
+        else
+          raise RequestError.new("Error updating contact", response)
+      end
+    end
+
+    # Delete the contact from DNSimple. WARNING: this cannot be undone.
+    def delete(options={})
+      DNSimple::Client.delete("/v1/contacts/#{id}", options)
+    end
+    alias :destroy :delete
+
   end
 end

data/lib/dnsimple/domain.rb

@@ -1,7 +1,6 @@
 module DNSimple
-
-  # Represents a single domain.
   class Domain < Base
+
     # The domain ID in DNSimple
     attr_accessor :id
 
@@ -17,80 +16,10 @@ module DNSimple
     # The current known name server status
     attr_accessor :name_server_status
 
-    # Delete the domain from DNSimple. WARNING: this cannot
-    # be undone.
-    def delete(options={})
-      DNSimple::Client.delete("domains/#{name}", options)
-    end
-    alias :destroy :delete
-
-    # Apply the given named template to the domain. This will add
-    # all of the records in the template to the domain.
-    def apply(template, options={})
-      options.merge!(:body => {})
-      template = resolve_template(template)
-
-      DNSimple::Client.post("domains/#{name}/templates/#{template.id}/apply", options)
-    end
-
-    #:nodoc:
-    def resolve_template(template)
-      case template
-      when DNSimple::Template
-        template
-      else
-        DNSimple::Template.find(template)
-      end
-    end
-
-    def applied_services(options={})
-      response = DNSimple::Client.get("domains/#{name}/applied_services", options)
-
-      case response.code
-      when 200
-        response.map { |r| DNSimple::Service.new(r["service"]) }
-      else
-        raise RequestError.new("Error listing applied services", response)
-      end
-    end
-
-    def available_services(options={})
-      response = DNSimple::Client.get("domains/#{name}/available_services", options)
-
-      case response.code
-      when 200
-        response.map { |r| DNSimple::Service.new(r["service"]) }
-      else
-        raise RequestError.new("Error listing available services", response)
-      end
-    end
-
-    def add_service(id_or_short_name, options={})
-      options.merge!(:body => {:service => {:id => id_or_short_name}})
-      response = DNSimple::Client.post("domains/#{name}/applied_services", options)
-
-      case response.code
-      when 200
-        true
-      else
-        raise RequestError.new("Error adding service", response)
-      end
-    end
-
-    def remove_service(id, options={})
-      response = DNSimple::Client.delete("domains/#{name}/applied_services/#{id}", options)
-
-      case response.code
-      when 200
-        true
-      else
-        raise RequestError.new("Error removing service", response)
-      end
-    end
 
     # Check the availability of a name
     def self.check(name, options={})
-      response = DNSimple::Client.get("domains/#{name}/check", options)
+      response = DNSimple::Client.get("/v1/domains/#{name}/check", options)
 
       case response.code
       when 200
@@ -108,7 +37,7 @@ module DNSimple
     def self.create(name, options={})
       options.merge!({:body => {:domain => {:name => name}}})
 
-      response = DNSimple::Client.post("domains", options)
+      response = DNSimple::Client.post("/v1/domains", options)
 
       case response.code
       when 201
@@ -131,7 +60,7 @@ module DNSimple
       body.merge!(:extended_attribute => extended_attributes)
       options.merge!({:body => body})
 
-      response = DNSimple::Client.post("domain_registrations", options)
+      response = DNSimple::Client.post("/v1/domain_registrations", options)
 
       case response.code
       when 201
@@ -143,9 +72,8 @@ module DNSimple
 
     # Find a specific domain in the account either by the numeric ID
     # or by the fully-qualified domain name.
-    def self.find(id_or_name, options={})
-      id = id_or_name
-      response = DNSimple::Client.get("domains/#{id}", options)
+    def self.find(id, options={})
+      response = DNSimple::Client.get("/v1/domains/#{id}", options)
 
       case response.code
       when 200
@@ -159,7 +87,7 @@ module DNSimple
 
     # Get all domains for the account.
     def self.all(options={})
-      response = DNSimple::Client.get("domains", options)
+      response = DNSimple::Client.get("/v1/domains", options)
 
       case response.code
       when 200
@@ -169,5 +97,77 @@ module DNSimple
       end
     end
 
+
+    # Delete the domain from DNSimple. WARNING: this cannot
+    # be undone.
+    def delete(options={})
+      DNSimple::Client.delete("/v1/domains/#{name}", options)
+    end
+    alias :destroy :delete
+
+    # Apply the given named template to the domain. This will add
+    # all of the records in the template to the domain.
+    def apply(template, options={})
+      options.merge!(:body => {})
+      template = resolve_template(template)
+
+      DNSimple::Client.post("/v1/domains/#{name}/templates/#{template.id}/apply", options)
+    end
+
+    #:nodoc:
+    def resolve_template(template)
+      case template
+      when DNSimple::Template
+        template
+      else
+        DNSimple::Template.find(template)
+      end
+    end
+
+    def applied_services(options={})
+      response = DNSimple::Client.get("/v1/domains/#{name}/applied_services", options)
+
+      case response.code
+      when 200
+        response.map { |r| DNSimple::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)
+
+      case response.code
+      when 200
+        response.map { |r| DNSimple::Service.new(r["service"]) }
+      else
+        raise RequestError.new("Error listing available services", response)
+      end
+    end
+
+    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)
+
+      case response.code
+      when 200
+        true
+      else
+        raise RequestError.new("Error adding service", response)
+      end
+    end
+
+    def remove_service(id, options={})
+      response = DNSimple::Client.delete("/v1/domains/#{name}/applied_services/#{id}", options)
+
+      case response.code
+      when 200
+        true
+      else
+        raise RequestError.new("Error removing service", response)
+      end
+    end
+
   end
 end