dnsmadeeasy-api 0.9 → 0.9.5

data/README.rdoc

@@ -12,8 +12,8 @@ Ruby client for DNSMadeEasy API.
   require "rubygems"
   require "dnsmadeeasy/api"
   
-  api_key = <your dnsmadeeasy api key>
-  secret_ket = <your dnsmadeeasy secret key>
+  api_key = "your-12345-api-67890-key"
+  secret_key = "your-12345-secret-67890-key"
   api = DnsMadeEasy::Api(api_key, secret_key)
   api.list_records "sigfig.com"
 
@@ -23,6 +23,12 @@ This is a great way to test your application without changing your production DN
   api = DnsMadeEasy::Api(api_key, secret_key, true)
   api.list_records "sigfig.com"
   
+The api calls throw the following exceptions:
+ * BadRequestError: For cases when there is missing information or the api limits have been exceeded
+ * ResourceNotFoundError: For cases when a request is made for an unknown domain or record
+ * AuthorizationFailedError: For cases when the request cannot be authorized
+ * InvalidRecordError: When a record to be created or updated is not well formed
+
 == Command line tool
 
 The client comes with a command line tool "dme". Use "dme --help" to see how to use the command.
@@ -33,5 +39,5 @@ The command line tool requires that your api credentials be stored in /etc/dnsma
 The command line tool also allows the running of queries in the sandbox mode. To do so, create
 /etc/dnsmadeeasy/api_sandbox.keys with your sandbox api key and secret key and use the --sandbox option
 with every command.
-  
-=end
+
+=end

data/Rakefile

@@ -2,12 +2,12 @@ require "rubygems"
 require "rake"
 require "echoe"
 
-Echoe.new("dnsmadeeasy-api", "0.9") do |p|
+Echoe.new("dnsmadeeasy-api", "0.9.5") do |p|
   p.description = "Ruby client for DNSMadeEasy API."
   p.summary = "Ruby client for DNSMadeEasy API."
   p.url = "http://rubygems.org/gems/dnsmadeeasy-api"
   p.author = "Nitesh Goel"
-  p.email = "nitesh@wikinvest.com"
+  p.email = "nitesh@sigfig.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
   p.install_message = "Create /etc/dnsmadeeasy/api.keys and/or /etc/dnsmadeeasy/api_sandbox.keys with the following information\napi_key=<your api key>\nsecret_key=<your secret key>\nto use the dme binary."
   p.runtime_dependencies = ["rest-client", "json"]

data/bin/dme

@@ -27,6 +27,7 @@ module DnsMadeEasy
         "describe-domain" => "Describe a domain entry",
         "list-records"    => "List records for a domain",
         "create-record"   => "Create a new dns record",
+        "delete-records"  => "Delete multiple dns records",
         "delete-record"   => "Delete a dns record",
         "update-record"   => "Update an existing dns record",
         "describe-record" => "Describe an existing dns record"
@@ -56,9 +57,7 @@ module DnsMadeEasy
     
     def show_response(response)
       if @json
-        if response.is_a?(TrueClass) || response.is_a?(FalseClass)
-          response = { :success => response }
-        end
+        response = { :data => response }
         puts response.to_json
       elsif response.is_a?(TrueClass) || response.is_a?(FalseClass)
         if response
@@ -70,7 +69,7 @@ module DnsMadeEasy
         response.each do |x|
           puts x
         end
-      else
+      elsif !response.empty?
         table_fields = {}
         response = [response] if response.instance_of?(Hash)
         response.each do |x|
@@ -184,7 +183,9 @@ begin
   when "list-domains"
     printer.show_response api.list_domains
   when "delete-domains"
-    unless force
+    if force
+      printer.show_response api.delete_domains!
+    else
       puts "The following domains are listed in your account:"
       printer.show_response api.list_domains
       puts "Are you sure you want to delete all domains? (yes/no)"
@@ -192,21 +193,25 @@ begin
       unless response.downcase == "yes"
         printer.say_bye "Domains not deleted"
       end
+      api.delete_domains!
+      puts "Done"
     end
-    printer.show_response api.delete_domains!
   when "create-domain"
     printer.show_error "Please specify a domain name" if domain.nil?
     printer.show_response api.create_domain!(domain)
   when "delete-domain"
     printer.show_error "Please specify a domain name" if domain.nil?
-    unless force
+    if force
+      printer.show_response api.delete_domain!(domain)
+    else
       puts "Are you sure you want to delete #{domain}? (yes/no)"
       response = STDIN.gets.chomp.downcase
       unless response.downcase == "yes"
         printer.say_bye "Domain #{domain} not deleted"
       end
+      api.delete_domain!(domain)
+      puts "Done"
     end
-    printer.show_response api.delete_domain!(domain)
   when "describe-domain"
     printer.show_error "Please specify a domain name" if domain.nil?
     printer.show_response api.describe_domain(domain)
@@ -219,23 +224,39 @@ begin
   when "delete-record"
     printer.show_error "Please specify a domain name" if domain.nil?
     printer.show_response api.describe_record(domain, record_id)
-    unless force
+    if force
+      printer.show_response api.delete_record!(domain, record_id)
+    else
       puts "Are you sure you want to delete this record? (yes/no)"
       response = STDIN.gets.chomp.downcase
       unless response.downcase == "yes"
         printer.say_bye "Record not deleted"
       end
+      api.delete_record!(domain, record_id)
+      puts "Done"
     end
-    printer.show_response api.delete_record!(domain, record_id)
   when "update-record"
     printer.show_error "Please specify a domain name" if domain.nil?
     printer.show_response api.update_record!(domain, record_id, options)
   when "describe-record"
     printer.show_error "Please specify a domain name" if domain.nil?
     printer.show_response api.describe_record(domain, record_id)
+  when "delete-records"
+    printer.show_error "Please specify a domain name" if domain.nil?
+    printer.show_response api.list_records(domain, options)
+    if force
+      printer.show_response api.delete_records!(domain, options)
+    else
+      puts "Are you sure you want to delete these records? (yes/no)"
+      response = STDIN.gets.chomp.downcase
+      unless response.downcase == "yes"
+        printer.say_bye "Records not deleted"
+      end
+      api.delete_records!(domain, options)
+      puts "Done"
+    end
   when "help"
     help_for_command = ARGV.shift
-    
   else
     printer.show_error "Please enter a valid command"
   end

data/dnsmadeeasy-api.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dnsmadeeasy-api}
-  s.version = "0.9"
+  s.version = "0.9.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Nitesh Goel}]
-  s.date = %q{2011-07-06}
+  s.date = %q{2011-07-07}
   s.description = %q{Ruby client for DNSMadeEasy API.}
-  s.email = %q{nitesh@wikinvest.com}
+  s.email = %q{nitesh@sigfig.com}
   s.executables = [%q{dme}]
   s.extra_rdoc_files = [%q{README.rdoc}, %q{bin/dme}, %q{lib/dnsmadeeasy/api.rb}, %q{lib/dnsmadeeasy/exceptions.rb}]
   s.files = [%q{Manifest}, %q{README.rdoc}, %q{Rakefile}, %q{bin/dme}, %q{lib/dnsmadeeasy/api.rb}, %q{lib/dnsmadeeasy/exceptions.rb}, %q{dnsmadeeasy-api.gemspec}]

data/lib/dnsmadeeasy/api.rb

@@ -19,8 +19,8 @@ Ruby client for DNSMadeEasy API.
   require "rubygems"
   require "dnsmadeeasy/api"
   
-  api_key = <your dnsmadeeasy api key>
-  secret_ket = <your dnsmadeeasy secret key>
+  api_key = "your-12345-api-67890-key"
+  secret_key = "your-12345-secret-67890-key"
   api = DnsMadeEasy::Api(api_key, secret_key)
   api.list_records "sigfig.com"
 
@@ -30,6 +30,12 @@ This is a great way to test your application without changing your production DN
   api = DnsMadeEasy::Api(api_key, secret_key, true)
   api.list_records "sigfig.com"
   
+The api calls throw the following exceptions:
+ * BadRequestError: For cases when there is missing information or the api limits have been exceeded
+ * ResourceNotFoundError: For cases when a request is made for an unknown domain or record
+ * AuthorizationFailedError: For cases when the request cannot be authorized
+ * InvalidRecordError: When a record to be created or updated is not well formed
+
 == Command line tool
 
 The client comes with a command line tool "dme". Use "dme --help" to see how to use the command.
@@ -40,7 +46,7 @@ The command line tool requires that your api credentials be stored in /etc/dnsma
 The command line tool also allows the running of queries in the sandbox mode. To do so, create
 /etc/dnsmadeeasy/api_sandbox.keys with your sandbox api key and secret key and use the --sandbox option
 with every command.
-  
+
 =end
 
 module DnsMadeEasy
@@ -60,169 +66,224 @@ module DnsMadeEasy
     end
     
     # List all domains in the account.
-    # Returns an array of domain names in the account.
-    # Throws DnsMadeEasy::AuthorizationFailedError
+    #
+    # Returns an array of domain names in the account, e.g.
+    #   ["sigfig.com", "wikinvest.com"]
     def list_domains
-      begin
+      execute_with_caution do
         response = RestClient.get request_url, headers
         response_hash = JSON.parse(response)
         return response_hash.has_key?("list") ? response_hash["list"] : []
-      rescue RestClient::Forbidden => e
-        raise DnsMadeEasy::AuthorizationFailedError
       end
     end
     
     # Delete all domains in the account.
-    # Returns true or throws an exception.
-    # Throws DnsMadeEasy::AuthorizationFailedError
+    #
+    # Returns an array of domains deleted, e.g.
+    #   ["sigfig.com", "wikinvest.com"]
     def delete_domains!
-      begin
+      execute_with_caution do
+        domains = list_domains
         response = RestClient.delete request_url, headers
-        return true
-      rescue RestClient::Forbidden => e
-        raise DnsMadeEasy::AuthorizationFailedError
+        return domains
       end
     end
     
     # Create a new domain entry.
-    # Returns a hash of the newly created domain entry.
-    # Throws DnsMadeEasy::InvalidDomainNameError, DnsMadeEasy::DuplicateDomainError, or DnsMadeEasy::AuthorizationFailedError
+    
+    # Returns a hash of the newly created domain entry, e.g.
+    #   { "name" => "sigfig.com", "nameServer" => ["ns66.dnsmadeeasy.com", "ns99.dnsmadeeasy.com"], "gtdEnabled" => true }
     def create_domain!(domain)
-      begin
+      execute_with_caution :domain => domain do
         response = RestClient.put request_url(:path => "#{domain}"), {}, headers
         return JSON.parse(response)
-      rescue RestClient::BadRequest => e
-        error = JSON.parse(e.http_body)
-        if error["error"][0] == "Invalid domain name."
-          raise DnsMadeEasy::InvalidDomainNameError, domain
-        else
-          raise DnsMadeEasy::DuplicateDomainError, domain
-        end
-      rescue RestClient::Forbidden => e
-        raise DnsMadeEasy::AuthorizationFailedError
       end
     end
     
     # Delete a domain entry.
-    # Returns true or throws an exception.
-    # Throws DnsMadeEasy::UnknownDomainError, DnsMadeEasy::RequestFailedError, or DnsMadeEasy::AuthorizationFailedError
+
+    # Returns a hash of the deleted domain entry, e.g.
+    #   { "name" => "sigfig.com", "nameServer" => ["ns66.dnsmadeeasy.com", "ns99.dnsmadeeasy.com"], "gtdEnabled" => true }
     def delete_domain!(domain)
-      begin
+      execute_with_caution :domain => domain do
+        description = describe_domain(domain)
         response = RestClient.delete request_url(:path => "#{domain}"), headers
-        return true
-      rescue RestClient::ResourceNotFound => e
-        raise DnsMadeEasy::UnknownDomainError, domain
-      rescue RestClient::BadRequest => e
-        error = JSON.parse(e.http_body)
-        raise DnsMadeEasy::RequestFailedError, error["error"][0]
-      rescue RestClient::Forbidden => e
-        raise DnsMadeEasy::AuthorizationFailedError
+        return description
       end
     end
     
     # Describe a domain entry.
-    # Returns a hash of the domain entry.
-    # Throws DnsMadeEasy::UnknownDomainError or DnsMadeEasy::AuthorizationFailedError
+    
+    # Returns a hash of the domain entry, e.g.
+    #   { "name" => "sigfig.com", "nameServer" => ["ns66.dnsmadeeasy.com", "ns99.dnsmadeeasy.com"], "gtdEnabled" => true }
     def describe_domain(domain)
-      begin
+      execute_with_caution :domain => domain do
         response = RestClient.get request_url(:path => "#{domain}"), headers
         return JSON.parse(response)
-      rescue RestClient::ResourceNotFound => e
-        raise DnsMadeEasy::UnknownDomainError, domain
-      rescue RestClient::Forbidden => e
-        raise DnsMadeEasy::AuthorizationFailedError
       end
     end
     
     # List records for a domain.
-    # Returns an array of hashes, each hash representing a dns entry.
-    # Throws DnsMadeEasy::UnknownDomainError or DnsMadeEasy::AuthorizationFailedError
+    #
+    # The filter parameter allows you to list a list a subset of records filtered by a criteria. Available filters:
+    # * { :name => "www" }: Lists all entries for host "www"
+    # * { :type => :A }: Lists all A records
+    # * { :gtdLocation => :EUROPE } List all entries for EUROPE Traffic Director
+    #
+    # Returns an array of hashes, each hash representing a dns entry, e.g.
+    #   [
+    #     {  "name" => "", "type" => "A", "data" => "127.0.0.1", "ttl" => 7200, "id" => 12345, "gtdLocation" => "DEFAULT" }
+    #     { "name" => "www", "type" => "CNAME", data => "sigfig.com.", "ttl" => 7200, id => 23456, "gtdLocation" => "DEFAULT" }
+    #   ]
     def list_records(domain, filter={})
-      begin
+      execute_with_caution :domain => domain do
         response = RestClient.get request_url(:path => "#{domain}/records", :query => filter), headers
         return JSON.parse(response)
-      rescue RestClient::ResourceNotFound => e
-        raise DnsMadeEasy::UnknownDomainError, domain
-      rescue RestClient::Forbidden => e
-        raise DnsMadeEasy::AuthorizationFailedError
       end
     end
     
-    # Create a new dns record
-    # record should be a hash with the following values:
+    # Create a new dns record.
+    #
+    # Record should be a hash with the following values:
     #
-    #   :name        => hostname, e.g. www
-    #   :type        => e.g. :A, :CNAME, :MX, :TXT, :SRV, :NS, :AAAA, :HTTPRED, :PTR
-    #   :data        => publicname, e.g. "66.88.99.44" or "ec2-gibberish.amazonaws.com"
-    #   :gtdLocation => "DEFAULT", (optional, defaults to DEFAULT)
-    #   :ttl         => time to live, e.g. 300
+    #   :name        => Hostname. E.g. www, or empty string for root domain
+    #   :type        => Record type. E.g. :A, :CNAME, :MX, :TXT, :SRV, :NS, :AAAA, :HTTPRED, :PTR
+    #   :data        => Public name. E.g. "66.88.99.44" or "ec2-gibberish.amazonaws.com."
+    #   :gtdLocation => Global Traffic Director location. Values: DEFAULT, US_EAST, US_WEST, EUROPE (optional, defaults to DEFAULT)
+    #   :ttl         => Time to live. The amount of time a record will be cached before being refreshed. E.g. 300
     #
-    # for :CNAME record type, the domain name is automatically added to the entry unless
-    # the :data field ends in a .
-    # e.g., for domain sigfig.com,
-    # :data => "blog.google.com" for a cname entry resolves to blog.google.com.sigfig.com
-    # but :data => "blog.google.com." resolves to blog.google.com.
+    # Here's a list of possible data values, with the record type they are used with:
+    # * A: <host IP>
+    # * AAAA: <IPv6 host IP>
+    # * CNAME: <target name>
+    # * HTTPRED: <redirection URL>
+    # * MX: <priority> <target name>
+    # * NS: <name server>
+    # * PTR: <target name>
+    # * SRV: <priority> <weight> <port> <target name>
+    # * TXT: <text value>
     #
-    # Returns a hash of the newly created dns entry.
-    # Throws DnsMadeEasy::InvalidRecordError, DnsMadeEasy::UnknownDomainError, or DnsMadeEasy::AuthorizationFailedError
+    # N.B. for CNAME, MX, NS, PTR, and SRV records, the domain name of the dns record is automatically
+    # appended to the given data unless the data ends with a "." So, to map, say mail to mail.google.com,
+    # use "mail.google.com." as the data value. By the same logic, to map "www.sigfig.com" to, say, "server1.sigfig.com",
+    # just use "server1" as the data value or "server1.sigfig.com."; don't give "server1.sigfig.com" because that'll
+    # essentially resolve to server1.sigfig.com.sigfig.com.
+    #
+    # Returns a hash of the newly created dns entry, e.g.
+    #   { "name" => "www", "type" => "CNAME", data => "sigfig.com.", "ttl" => 7200, id => 23456, "gtdLocation" => "DEFAULT" }
     def create_record!(domain, record)
       validate_record(record)
       request_data = {
         :gtdLocation => "DEFAULT"
       }.merge(record)
-      begin
+      execute_with_caution :domain => domain do
         response = RestClient.post request_url(:path => "#{domain}/records"), request_data.to_json, headers(:content_type => "application/json")
         return JSON.parse(response)
-      rescue RestClient::BadRequest => e
-        raise DnsMadeEasy::InvalidRecordError, e.http_body
-      rescue RestClient::ResourceNotFound => e
-        raise DnsMadeEasy::UnknownDomainError, domain
-      rescue RestClient::Forbidden => e
-        raise DnsMadeEasy::AuthorizationFailedError
       end
     end
     
     # Delete a dns record.
-    # Returns true or throws an exception.
-    # Throws DnsMadeEasy::UnknownRecordError, or DnsMadeEasy::AuthorizationFailedError
+    #
+    # Returns a hash of the deleted dns entry, e.g.
+    #   {  "name" => "", "type" => "A", "data" => "127.0.0.1", "ttl" => 7200, "id" => 12345, "gtdLocation" => "DEFAULT" }
     def delete_record!(domain, record_id)
-      begin
+      execute_with_caution :domain => domain, :record => record_id do
+        record = describe_record(domain, record_id)
         response = RestClient.delete request_url(:path => "#{domain}/records/#{record_id}"), headers
-        return true
-      rescue RestClient::ResourceNotFound => e
-        raise DnsMadeEasy::UnknownRecordError.new(domain, record_id)
-      rescue RestClient::Forbidden => e
-        raise DnsMadeEasy::AuthorizationFailedError
+        return record
+      end
+    end
+    
+    # Delete multiple records for a domain.
+    #
+    # The filter parameter allows you to list a list a subset of records filtered by a criteria. Available filters:
+    # * { :name => "www" }: Lists all entries for host "www"
+    # * { :type => :A }: Lists all A records
+    # * { :gtdLocation => :EUROPE } List all entries for EUROPE Traffic Director
+    # 
+    # N.B. Given that there are limits to the number of api requests, the amoticity of this action is not guaranteed.
+    # This means that it is possible under certain circumstances that not all records that match the given criteria
+    # will be deleted.
+    # 
+    # Returns an array of hashes, each hash representing a deleted dns entry, e.g.
+    #   [
+    #     {  "name" => "", "type" => "A", "data" => "127.0.0.1", "ttl" => 7200, "id" => 12345, "gtdLocation" => "DEFAULT" }
+    #     { "name" => "www", "type" => "CNAME", data => "sigfig.com.", "ttl" => 7200, id => 23456, "gtdLocation" => "DEFAULT" }
+    #   ]
+    # An empty array is returned if no deletions are made.
+    def delete_records!(domain, filter={})
+      record_list = list_records(domain, filter)
+      unless record_list.empty?
+        if record_list.size == 1
+          delete_record!(domain, record_list[0]["id"])
+        elsif requests_remaining >= record_list.size
+          record_list.each do |record|
+            delete_record!(domain, record["id"])
+          end
+        else
+          raise DnsMadeEasy::BadRequestError, "Not enough requests remaining to complete the operation"
+        end
       end
+      return record_list
     end
     
-    # Update an existing dns record
-    # Returns the latest hash of the dns entry.
-    # Throws DnsMadeEasy::InvalidRecordError, DnsMadeEasy::UnknownRecordError, or DnsMadeEasy::AuthorizationFailedError
+    # Update an existing dns record.
+    #
+    # Record should be a hash with the following values:
+    #
+    #   :name        => Hostname. E.g. www, or empty string for root domain
+    #   :type        => Record type. E.g. :A, :CNAME, :MX, :TXT, :SRV, :NS, :AAAA, :HTTPRED, :PTR
+    #   :data        => Public name. E.g. "66.88.99.44" or "ec2-gibberish.amazonaws.com."
+    #   :gtdLocation => Global Traffic Director location. Values: DEFAULT, US_EAST, US_WEST, EUROPE (optional, defaults to DEFAULT)
+    #   :ttl         => Time to live. The amount of time a record will be cached before being refreshed. E.g. 300
+    #
+    # Here's a list of possible data values, with the record type they are used with:
+    # * A: <host IP>
+    # * AAAA: <IPv6 host IP>
+    # * CNAME: <target name>
+    # * HTTPRED: <redirection URL>
+    # * MX: <priority> <target name>
+    # * NS: <name server>
+    # * PTR: <target name>
+    # * SRV: <priority> <weight> <port> <target name>
+    # * TXT: <text value>
+    #
+    # N.B. for CNAME, MX, NS, PTR, and SRV records, the domain name of the dns record is automatically
+    # appended to the given data unless the data ends with a "." So, to map, say mail to mail.google.com,
+    # use "mail.google.com." as the data value. By the same logic, to map "www.sigfig.com" to, say, "server1.sigfig.com",
+    # just use "server1" as the data value or "server1.sigfig.com."; don't give "server1.sigfig.com" because that'll
+    # essentially resolve to server1.sigfig.com.sigfig.com.
+    #
+    # Returns a hash of the newly updated dns entry, e.g.
+    #   { "name" => "www", "type" => "CNAME", data => "sigfig.com.", "ttl" => 7200, id => 23456, "gtdLocation" => "DEFAULT" }
     def update_record!(domain, record_id, record)
-      begin
+      validate_record(record)
+      execute_with_caution :domain => domain, :record => record_id do
         response = RestClient.put request_url(:path => "#{domain}/records/#{record_id}"), record.to_json, headers(:content_type => "application/json")
         return describe_record(domain, record_id)
-      rescue RestClient::BadRequest => e
-        raise DnsMadeEasy::InvalidRecordError, e.http_body
-      rescue RestClient::ResourceNotFound => e
-        raise DnsMadeEasy::UnknownRecordError.new(domain, record_id)
-      rescue RestClient::Forbidden => e
-        raise DnsMadeEasy::AuthorizationFailedError
       end
     end
     
     # Describe an existing dns record.
+    #
     # Returns a hash of the dns entry.
-    # Throws DnsMadeEasy::UnknownRecordError, or DnsMadeEasy::AuthorizationFailedError
+    #   { "name" => "www", "type" => "CNAME", data => "sigfig.com.", "ttl" => 7200, id => 23456, "gtdLocation" => "DEFAULT" }
     def describe_record(domain, record_id)
-      begin
+      execute_with_caution :domain => domain, :record => record_id do
         response = RestClient.get request_url(:path => "#{domain}/records/#{record_id}"), headers
         return JSON.parse(response)
-      rescue RestClient::ResourceNotFound => e
-        raise DnsMadeEasy::UnknownRecordError.new(domain, record_id)
-      rescue RestClient::Forbidden => e
-        raise DnsMadeEasy::AuthorizationFailedError
+      end
+    end
+    
+    # Return the umber of api requests remaining.
+    def requests_remaining
+      begin
+        execute_with_caution do
+          response = RestClient.get request_url, headers
+          return response.headers[:x_dnsme_requestsremaining].to_i if response.headers.has_key?(:x_dnsme_requestsremaining)
+        end
+      rescue DnsMadeEasy::BadRequestError => e
+        return 0
       end
     end
     
@@ -238,8 +299,14 @@ module DnsMadeEasy
       
       # check record types
       acceptable_types = [:A, :CNAME, :MX, :TXT, :SRV, :NS, :AAAA, :HTTPRED, :PTR]
-      raise DnsMadeEasy::InvalidRecordError, "Invalid record type #{record[:type]}" unless acceptable_types.include?(record[:type])
+      raise DnsMadeEasy::InvalidRecordError, "Invalid record type #{record[:type]}" unless acceptable_types.include?(record[:type].to_sym)
       
+      # check gtd location
+      acceptable_location = [:DEFAULT, :US_EAST, :US_WEST, :EUROPE]
+      if record.has_key?(:gtdLocation) && acceptable_location.include?(record[:gtdLocation].to_sym)
+        raise DnsMadeEasy::InvalidRecordError, "Invalid gtd location #{record[:gtdLocation]}"
+      end
+            
       # check non empty fields
       non_empty_fields = [:ttl, :data]
       non_empty_fields.each do |field|
@@ -271,5 +338,19 @@ module DnsMadeEasy
       }
       return default_headers.merge( more_headers )
     end
+    
+    # Execute a block and handle all the errors it may throw
+    def execute_with_caution(namespace={})
+      begin
+        return yield
+      rescue RestClient::BadRequest => e
+        error = JSON.parse(e.http_body)
+        raise DnsMadeEasy::BadRequestError, error["error"][0]
+      rescue RestClient::ResourceNotFound => e
+        raise DnsMadeEasy::ResourceNotFoundError, namespace
+      rescue RestClient::Forbidden => e
+        raise DnsMadeEasy::AuthorizationFailedError
+      end
+    end
   end
 end

data/lib/dnsmadeeasy/exceptions.rb

@@ -10,31 +10,16 @@ module DnsMadeEasy
     end
   end
   
-  # Error raised when actions are performed on an domain not listed in the account
-  class UnknownDomainError < RequestFailedError
-    def initialize(domain)
-      super "Domain #{domain} does not exist."
-    end
-  end
-  
-  # Error raised when an invalid domain is being created
-  class InvalidDomainNameError < RequestFailedError
-    def initialize(domain)
-      super "Domain #{domain} is not valid."
-    end
-  end
-  
-  # Error raised when a duplicate domain is being created
-  class DuplicateDomainError < RequestFailedError
-    def initialize(domain)
-      super "Domain #{domain} already exists."
-    end
+  # Error raised when the request is bad. Likely causes are exceeding api limits, 
+  # creating an existing domain/record, or creating a mal-formed record.
+  class BadRequestError < RequestFailedError
   end
   
-  # Error raised when an unknown record is being modified or deleted
-  class UnknownRecordError < RequestFailedError
-    def initialize(domain, record_id)
-      super "Record id #{record_id} and/or domain #{domain} does not exist"
+  # Error raised when actions are performed against an unknown resource (domain or record)
+  class ResourceNotFoundError < RequestFailedError
+    def initialize(resource)
+      flattened_resource = resource.to_a.map { |x| "#{x[0]}: #{x[1]}" }.join(", ")
+      super "Could not find resource - #{flattened_resource}"
     end
   end
   

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dnsmadeeasy-api
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 49
   prerelease: 
   segments: 
   - 0
   - 9
-  version: "0.9"
+  - 5
+  version: 0.9.5
 platform: ruby
 authors: 
 - Nitesh Goel
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-06 00:00:00 Z
+date: 2011-07-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -73,7 +74,7 @@ dependencies:
   type: :development
   version_requirements: *id004
 description: Ruby client for DNSMadeEasy API.
-email: nitesh@wikinvest.com
+email: nitesh@sigfig.com
 executables: 
 - dme
 extensions: []