dnsimple-ruby 1.3.2 → 1.4.0

data/fixtures/vcr_cassettes/DNSimple_Record/find_a_record.yml

@@ -1,44 +1,51 @@
---- 
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
-    method: :get
-    uri: http://<USERNAME>:<PASSWORD>@localhost:3000/domains/example.com/records/70
-    body: 
-    headers: 
-      accept: 
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<USERNAME>:<PASSWORD>@test.dnsimple.com/domains/example.com/records/70
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
       - application/json
-      authorization: 
+      Authorization:
       - Basic YW50aG9ueWVkZW5AZ21haWwuY29tOmxldG1laW4=
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      x-ua-compatible: 
+    headers:
+      X-Ua-Compatible:
       - IE=Edge
-      access-control-allow-headers: 
+      Access-Control-Allow-Headers:
       - Authorization,Accepts,Content-Type
-      x-dnsimple-api-version: 
+      X-Dnsimple-Api-Version:
       - 1.0.0
-      etag: 
-      - "\"e44e23e8947baa8e4e07637aaae785a2\""
-      access-control-allow-methods: 
+      Etag:
+      - ! '"e44e23e8947baa8e4e07637aaae785a2"'
+      Access-Control-Allow-Methods:
       - OPTIONS
-      content-type: 
+      Content-Type:
       - application/json; charset=utf-8
-      access-control-allow-origin: 
-      - "*"
-      date: 
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Date:
       - Fri, 11 Nov 2011 20:23:36 GMT
-      server: 
+      Server:
       - WEBrick/1.3.1 (Ruby/1.9.2/2011-07-09)
-      x-runtime: 
-      - "0.599019"
-      content-length: 
-      - "245"
-      set-cookie: 
-      - _dnsimple_session=BAh7CEkiD3Nlc3Npb25faWQGOgZFRiIlMWJiN2NjM2IzYTM5MzMzOTUyNzllYjk5MzJlYmQ2YWFJIhV1c2VyX2NyZWRlbnRpYWxzBjsARkkiAYA1YzI0ZTYzOGYwNjFkZWRmN2Y5YTNiYjY3MTdiZjUxMjliZmUwYjdjODg5OGZkZTVhNmEzNGMxZDkwOWUyMmNlNmIzMTc4MzRlZTdmY2RkYjllYjQ3ODdhYjZlMDM1Y2E0ZmEyYmY0MWVkYzJiOWMxZGEwNzYwZDdjMzhmNzY1OAY7AFRJIhh1c2VyX2NyZWRlbnRpYWxzX2lkBjsARmkG--a2cdbda5d90cb97836aa557e8d2511b91c1b1b80; path=/; HttpOnly
-      cache-control: 
+      X-Runtime:
+      - '0.599019'
+      Content-Length:
+      - '245'
+      Set-Cookie:
+      - _dnsimple_session=BAh7CEkiD3Nlc3Npb25faWQGOgZFRiIlMWJiN2NjM2IzYTM5MzMzOTUyNzllYjk5MzJlYmQ2YWFJIhV1c2VyX2NyZWRlbnRpYWxzBjsARkkiAYA1YzI0ZTYzOGYwNjFkZWRmN2Y5YTNiYjY3MTdiZjUxMjliZmUwYjdjODg5OGZkZTVhNmEzNGMxZDkwOWUyMmNlNmIzMTc4MzRlZTdmY2RkYjllYjQ3ODdhYjZlMDM1Y2E0ZmEyYmY0MWVkYzJiOWMxZGEwNzYwZDdjMzhmNzY1OAY7AFRJIhh1c2VyX2NyZWRlbnRpYWxzX2lkBjsARmkG--a2cdbda5d90cb97836aa557e8d2511b91c1b1b80;
+        path=/; HttpOnly
+      Cache-Control:
       - max-age=0, private, must-revalidate
-    body: "{\"record\":{\"content\":\"1.2.3.4\",\"created_at\":\"2011-11-11T20:22:26Z\",\"domain_id\":39,\"domain_service_id\":null,\"id\":70,\"name\":\"\",\"pdns_identifier\":null,\"prio\":null,\"record_type\":\"A\",\"special_type\":null,\"ttl\":600,\"updated_at\":\"2011-11-11T20:22:26Z\"}}"
-    http_version: "1.1"
+    body:
+      encoding: UTF-8
+      string: ! '{"record":{"content":"1.2.3.4","created_at":"2011-11-11T20:22:26Z","domain_id":39,"domain_service_id":null,"id":70,"name":"","pdns_identifier":null,"prio":null,"record_type":"A","special_type":null,"ttl":600,"updated_at":"2011-11-11T20:22:26Z"}}'
+    http_version: '1.1'
+  recorded_at: Thu, 06 Sep 2012 18:52:19 GMT
+recorded_with: VCR 2.2.5

data/fixtures/vcr_cassettes/DNSimple_Template/a_template.yml

@@ -1,44 +1,53 @@
---- 
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
-    method: :get
-    uri: http://<USERNAME>:<PASSWORD>@localhost:3000/templates/googleapps
-    body: 
-    headers: 
-      accept: 
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<USERNAME>:<PASSWORD>@test.dnsimple.com/templates/googleapps
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
       - application/json
-      authorization: 
+      Authorization:
       - Basic YW50aG9ueWVkZW5AZ21haWwuY29tOmxldG1laW4=
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      x-ua-compatible: 
+    headers:
+      X-Ua-Compatible:
       - IE=Edge
-      access-control-allow-headers: 
+      Access-Control-Allow-Headers:
       - Authorization,Accepts,Content-Type
-      x-dnsimple-api-version: 
+      X-Dnsimple-Api-Version:
       - 1.0.0
-      etag: 
-      - "\"3649a89c5333cc5c491e30a29901f286\""
-      access-control-allow-methods: 
+      Etag:
+      - ! '"3649a89c5333cc5c491e30a29901f286"'
+      Access-Control-Allow-Methods:
       - OPTIONS
-      content-type: 
+      Content-Type:
       - application/json; charset=utf-8
-      access-control-allow-origin: 
-      - "*"
-      date: 
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Date:
       - Fri, 11 Nov 2011 20:26:05 GMT
-      server: 
+      Server:
       - WEBrick/1.3.1 (Ruby/1.9.2/2011-07-09)
-      x-runtime: 
-      - "0.301433"
-      content-length: 
-      - "266"
-      set-cookie: 
-      - _dnsimple_session=BAh7CEkiD3Nlc3Npb25faWQGOgZFRiIlYjMyMDBiMjQwNDdiN2FlMjE4OTUxMDU5ZGYzY2EyMjNJIhV1c2VyX2NyZWRlbnRpYWxzBjsARkkiAYA1YzI0ZTYzOGYwNjFkZWRmN2Y5YTNiYjY3MTdiZjUxMjliZmUwYjdjODg5OGZkZTVhNmEzNGMxZDkwOWUyMmNlNmIzMTc4MzRlZTdmY2RkYjllYjQ3ODdhYjZlMDM1Y2E0ZmEyYmY0MWVkYzJiOWMxZGEwNzYwZDdjMzhmNzY1OAY7AFRJIhh1c2VyX2NyZWRlbnRpYWxzX2lkBjsARmkG--f1d49fb81f9ca5dae40e254e327c1c69b5352921; path=/; HttpOnly
-      cache-control: 
+      X-Runtime:
+      - '0.301433'
+      Content-Length:
+      - '266'
+      Set-Cookie:
+      - _dnsimple_session=BAh7CEkiD3Nlc3Npb25faWQGOgZFRiIlYjMyMDBiMjQwNDdiN2FlMjE4OTUxMDU5ZGYzY2EyMjNJIhV1c2VyX2NyZWRlbnRpYWxzBjsARkkiAYA1YzI0ZTYzOGYwNjFkZWRmN2Y5YTNiYjY3MTdiZjUxMjliZmUwYjdjODg5OGZkZTVhNmEzNGMxZDkwOWUyMmNlNmIzMTc4MzRlZTdmY2RkYjllYjQ3ODdhYjZlMDM1Y2E0ZmEyYmY0MWVkYzJiOWMxZGEwNzYwZDdjMzhmNzY1OAY7AFRJIhh1c2VyX2NyZWRlbnRpYWxzX2lkBjsARmkG--f1d49fb81f9ca5dae40e254e327c1c69b5352921;
+        path=/; HttpOnly
+      Cache-Control:
       - max-age=0, private, must-revalidate
-    body: "{\"dns_template\":{\"created_at\":\"2011-09-04T01:08:50Z\",\"description\":\"The Google Mail Servers and Google Apps CNAME records in a single template.\",\"id\":3,\"name\":\"Google Apps\",\"short_name\":\"googleapps\",\"updated_at\":\"2011-09-04T01:08:50Z\",\"user_id\":null,\"visible\":true}}"
-    http_version: "1.1"
+    body:
+      encoding: UTF-8
+      string: ! '{"dns_template":{"created_at":"2011-09-04T01:08:50Z","description":"The
+        Google Mail Servers and Google Apps CNAME records in a single template.","id":3,"name":"Google
+        Apps","short_name":"googleapps","updated_at":"2011-09-04T01:08:50Z","user_id":null,"visible":true}}'
+    http_version: '1.1'
+  recorded_at: Thu, 06 Sep 2012 18:52:19 GMT
+recorded_with: VCR 2.2.5

data/fixtures/vcr_cassettes/DNSimple_User/_me.yml

@@ -1,42 +1,49 @@
---- 
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
-    method: :get
-    uri: http://<USERNAME>:<PASSWORD>@localhost:3000/users/me.json
-    body: 
-    headers: 
-      authorization: 
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<USERNAME>:<PASSWORD>@test.dnsimple.com/users/me
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
       - Basic YW50aG9ueWVkZW5AZ21haWwuY29tOmxldG1laW4=
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      x-ua-compatible: 
+    headers:
+      X-Ua-Compatible:
       - IE=Edge
-      access-control-allow-headers: 
+      Access-Control-Allow-Headers:
       - Authorization,Accepts,Content-Type
-      x-dnsimple-api-version: 
+      X-Dnsimple-Api-Version:
       - 1.0.0
-      etag: 
-      - "\"3aec1a878ad478216d54579f95258697\""
-      access-control-allow-methods: 
+      Etag:
+      - ! '"3aec1a878ad478216d54579f95258697"'
+      Access-Control-Allow-Methods:
       - OPTIONS
-      content-type: 
+      Content-Type:
       - application/json; charset=utf-8
-      access-control-allow-origin: 
-      - "*"
-      date: 
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Date:
       - Fri, 11 Nov 2011 20:33:01 GMT
-      server: 
+      Server:
       - WEBrick/1.3.1 (Ruby/1.9.2/2011-07-09)
-      x-runtime: 
-      - "5.589996"
-      content-length: 
-      - "325"
-      set-cookie: 
-      - _dnsimple_session=BAh7CEkiD3Nlc3Npb25faWQGOgZFRiIlZTBlZTI5ZGMzYmNkZDgxY2QzMjZmMTQwZWEwOTdmMDVJIhV1c2VyX2NyZWRlbnRpYWxzBjsARkkiAYA1YzI0ZTYzOGYwNjFkZWRmN2Y5YTNiYjY3MTdiZjUxMjliZmUwYjdjODg5OGZkZTVhNmEzNGMxZDkwOWUyMmNlNmIzMTc4MzRlZTdmY2RkYjllYjQ3ODdhYjZlMDM1Y2E0ZmEyYmY0MWVkYzJiOWMxZGEwNzYwZDdjMzhmNzY1OAY7AFRJIhh1c2VyX2NyZWRlbnRpYWxzX2lkBjsARmkG--ec4d0fa610542fdbeb1dca4838d8b4bb91e8597a; path=/; HttpOnly
-      cache-control: 
+      X-Runtime:
+      - '5.589996'
+      Content-Length:
+      - '325'
+      Set-Cookie:
+      - _dnsimple_session=BAh7CEkiD3Nlc3Npb25faWQGOgZFRiIlZTBlZTI5ZGMzYmNkZDgxY2QzMjZmMTQwZWEwOTdmMDVJIhV1c2VyX2NyZWRlbnRpYWxzBjsARkkiAYA1YzI0ZTYzOGYwNjFkZWRmN2Y5YTNiYjY3MTdiZjUxMjliZmUwYjdjODg5OGZkZTVhNmEzNGMxZDkwOWUyMmNlNmIzMTc4MzRlZTdmY2RkYjllYjQ3ODdhYjZlMDM1Y2E0ZmEyYmY0MWVkYzJiOWMxZGEwNzYwZDdjMzhmNzY1OAY7AFRJIhh1c2VyX2NyZWRlbnRpYWxzX2lkBjsARmkG--ec4d0fa610542fdbeb1dca4838d8b4bb91e8597a;
+        path=/; HttpOnly
+      Cache-Control:
       - max-age=0, private, must-revalidate
-    body: "{\"user\":{\"access_code\":null,\"created_at\":\"2011-09-25T09:11:23Z\",\"default_contact_id\":null,\"email\":\"anthonyeden@gmail.com\",\"failed_login_count\":0,\"first_name\":null,\"id\":1,\"last_name\":null,\"login_count\":2,\"referral_token\":\"a93b6fa7c98483\",\"style\":\"light\",\"updated_at\":\"2011-11-11T20:32:56Z\",\"domain_count\":5,\"domain_limit\":10}}"
-    http_version: "1.1"
+    body:
+      encoding: UTF-8
+      string: ! '{"user":{"access_code":null,"created_at":"2011-09-25T09:11:23Z","default_contact_id":null,"email":"anthonyeden@gmail.com","failed_login_count":0,"first_name":null,"id":1,"last_name":null,"login_count":2,"referral_token":"a93b6fa7c98483","style":"light","updated_at":"2011-11-11T20:32:56Z","domain_count":5,"domain_limit":10}}'
+    http_version: '1.1'
+  recorded_at: Thu, 06 Sep 2012 18:52:19 GMT
+recorded_with: VCR 2.2.5

data/lib/dnsimple.rb

@@ -1,8 +1,21 @@
-require 'pp'
 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'

data/lib/dnsimple/base.rb

@@ -1,8 +1,10 @@
-class DNSimple::Base
-  def initialize(attributes)
-    attributes.each do |key, value|
-      m = "#{key}=".to_sym
-      self.send(m, value) if self.respond_to?(m)
+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

@@ -1,123 +1,128 @@
-# 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 DNSimple::Certificate < DNSimple::Base
-  #debug_output $stdout
+module DNSimple
 
-  # The certificate ID in DNSimple
-  attr_accessor :id
+  # 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
 
-  attr_accessor :domain
+    # The certificate ID in DNSimple
+    attr_accessor :id
 
-  # The subdomain on the certificate
-  attr_accessor :name
+    attr_accessor :domain
 
-  # The private key, if DNSimple generated the Certificate Signing Request
-  attr_accessor :private_key
+    # The subdomain on the certificate
+    attr_accessor :name
 
-  # 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 Certificate Signing Request
-  attr_accessor :csr
+    # The SSL certificate, if it has been issued by the Certificate Authority
+    attr_accessor :ssl_certificate
 
-  # The Certificate status
-  attr_accessor :certificate_status
+    # The Certificate Signing Request
+    attr_accessor :csr
 
-  # The date the Certificate order was placed
-  attr_accessor :order_date
+    # The Certificate status
+    attr_accessor :certificate_status
 
-  # The date the Certificate will expire
-  attr_accessor :expiration_date
+    # The date the Certificate order was placed
+    attr_accessor :order_date
 
-  # The approver email address
-  attr_accessor :approver_email
+    # The date the Certificate will expire
+    attr_accessor :expiration_date
 
-  # An array of all emails that can be used to approve the certificate
-  attr_accessor :available_approver_emails
+    # The approver email address
+    attr_accessor :approver_email
 
-  # When the certificate was purchased
-  attr_accessor :created_at
+    # An array of all emails that can be used to approve the certificate
+    attr_accessor :available_approver_emails
 
-  # When the certificate was last updated
-  attr_accessor :updated_at
+    # When the certificate was purchased
+    attr_accessor :created_at
 
-  # 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
+    # When the certificate was last updated
+    attr_accessor :updated_at
 
-  def submit(approver_email, options={})
-    raise DNSimple::Error, "Approver email is required" unless approver_email
 
-    options.merge!(:body => {:certificate => {:approver_email => approver_email}})
+    # 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
 
-    response = DNSimple::Client.put "domains/#{domain.name}/certificates/#{id}/submit", options
+      options.merge!(:body => {:certificate => {:approver_email => approver_email}})
 
-    case response.code
-    when 200
-      return DNSimple::Certificate.new({:domain => domain}.merge(response["certificate"]))
-    else
-      raise DNSimple::Error.new("Error submitting certificate: #{response["errors"]}")
+      response = DNSimple::Client.put("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
 
-  # 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 "domains/#{domain.name}/certificates", options
-
-    case response.code
-    when 201
-      return new({:domain => domain}.merge(response["certificate"]))
-    when 406
-      raise DNSimple::CertificateExists.new("#{name}.#{domain.name}", response["errors"])
-    else
-      raise DNSimple::Error.new("#{name}.#{domain.name}", response["errors"])
+    # 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("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
-  end
 
-  # Get an array of all certificates for the given domain.
-  def self.all(domain, options={})
-    response = DNSimple::Client.get "domains/#{domain.name}/certificates", options
+    # Get an array of all certificates for the given domain.
+    def self.all(domain, options={})
+      response = DNSimple::Client.get("domains/#{domain.name}/certificates", options)
 
-    case response.code
-    when 200
-      response.map { |r| new({:domain => domain}.merge(r["certificate"])) }
-    else
-      raise DNSimple::Error.new("List certificates error: #{response["errors"]}")
+      case response.code
+      when 200
+        response.map { |r| new({:domain => domain}.merge(r["certificate"])) }
+      else
+        raise RequestError.new("Error listing certificates", response)
+      end
     end
-  end
 
-  # Find a specific certificate for the given domain.
-  def self.find(domain, certificate_id, options={})
-    response = DNSimple::Client.get "domains/#{domain.name}/certificates/#{certificate_id}", options
-
-    case response.code
-    when 200
-      new({:domain => domain}.merge(response["certificate"]))
-    when 404
-      raise DNSimple::CertificateNotFound, "Could not find certificate #{certificate_id} for domain #{domain.name}"
-    else
-      raise DNSimple::Error.new("Find certificate error: #{response["errors"]}")
+    # Find a specific certificate for the given domain.
+    def self.find(domain, id, options = {})
+      response = DNSimple::Client.get("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
+
   end
 end