dnsimple 2.0.0 → 2.1.0

data/lib/dnsimple/client/domains_records.rb

@@ -8,8 +8,8 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Hash] options
-      #
       # @return [Array<Struct::Record>]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
       def records(domain, options = {})
@@ -17,6 +17,7 @@ module Dnsimple
 
         response.map { |r| Struct::Record.new(r["record"]) }
       end
+      alias :list_record :records
 
       # Creates a record for a domain.
       #
@@ -24,13 +25,13 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Hash] attributes
-      #
       # @return [Struct::Record]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def create_record(domain, attributes = {})
+      def create_record(domain, attributes = {}, options = {})
         Extra.validate_mandatory_attributes(attributes, [:name, :record_type, :content])
-        options  = { record: attributes }
+        options  = options.merge({ record: attributes })
         response = client.post("v1/domains/#{domain}/records", options)
 
         Struct::Record.new(response["record"])
@@ -42,12 +43,12 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Fixnum] record The record id.
-      #
       # @return [Struct::Record]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def record(domain, record)
-        response = client.get("v1/domains/#{domain}/records/#{record}")
+      def record(domain, record, options = {})
+        response = client.get("v1/domains/#{domain}/records/#{record}", options)
 
         Struct::Record.new(response["record"])
       end
@@ -59,12 +60,12 @@ module Dnsimple
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Fixnum] record The record id.
       # @param  [Hash] attributes
-      #
       # @return [Struct::Record]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def update_record(domain, record, attributes = {})
-        options  = { record: attributes }
+      def update_record(domain, record, attributes = {}, options = {})
+        options  = options.merge({ record: attributes })
         response = client.put("v1/domains/#{domain}/records/#{record}", options)
 
         Struct::Record.new(response["record"])
@@ -76,12 +77,12 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Fixnum] record The record id.
-      #
       # @return [void]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def delete_record(domain, record)
-        client.delete("v1/domains/#{domain}/records/#{record}")
+      def delete_record(domain, record, options = {})
+        client.delete("v1/domains/#{domain}/records/#{record}", options)
       end
 
     end

data/lib/dnsimple/client/domains_sharing.rb

@@ -7,15 +7,16 @@ module Dnsimple
       # @see http://developer.dnsimple.com/domains/sharing/#list
       #
       # @param  [#to_s] domain The domain id or domain name.
-      #
       # @return [Array<Struct::Membership>]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def memberships(domain)
-        response = client.get("v1/domains/#{domain}/memberships")
+      def memberships(domain, options = {})
+        response = client.get("v1/domains/#{domain}/memberships", options)
 
         response.map { |r| Struct::Membership.new(r["membership"]) }
       end
+      alias :list_memberships :memberships
 
       # Shares a domain.
       #
@@ -23,12 +24,12 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [String] email
-      #
       # @return [Struct::Membership]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def create_membership(domain, email)
-        options  = { membership: { email: email }}
+      def create_membership(domain, email, options = {})
+        options  = options.merge({ membership: { email: email }})
         response = client.post("v1/domains/#{domain}/memberships", options)
 
         Struct::Membership.new(response["membership"])
@@ -40,12 +41,12 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Fixnum] membership The membership id.
-      #
       # @return [void]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def delete_membership(domain, membership)
-        client.delete("v1/domains/#{domain}/memberships/#{membership}")
+      def delete_membership(domain, membership, options = {})
+        client.delete("v1/domains/#{domain}/memberships/#{membership}", options)
       end
 
     end

data/lib/dnsimple/client/domains_zones.rb

@@ -7,12 +7,12 @@ module Dnsimple
       # @see http://developer.dnsimple.com/domains/zones/#get
       #
       # @param  [#to_s] domain The domain id or domain name.
-      #
       # @return [String]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def zone(domain)
-        response = client.get("v1/domains/#{domain}/zone")
+      def zone(domain, options = {})
+        response = client.get("v1/domains/#{domain}/zone", options)
 
         response["zone"]
       end

data/lib/dnsimple/client/name_servers.rb

@@ -7,17 +7,17 @@ module Dnsimple
       # @see http://developer.dnsimple.com/domains/nameservers/#list
       #
       # @param  [#to_s] domain The domain id or domain name.
-      #
       # @return [Array<String>] The delegates name servers.
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def name_servers(domain)
-        response = client.get("v1/domains/#{domain}/name_servers")
+      def name_servers(domain, options = {})
+        response = client.get("v1/domains/#{domain}/name_servers", options)
 
         response.parsed_response
       end
-
       alias :list :name_servers
+      alias :list_name_servers :name_servers
 
       # Changes the name servers for a domain.
       #
@@ -25,13 +25,13 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Array<String>] servers The name server list.
-      #
       # @return [Array<String>] The delegates name servers.
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def change(domain, servers)
-        servers = servers.inject({}) { |hash, server| hash.merge("ns#{hash.length + 1}" => server) }
-        options = { name_servers: servers }
+      def change(domain, servers, options = {})
+        servers  = servers.inject({}) { |hash, server| hash.merge("ns#{hash.length + 1}" => server) }
+        options  = options.merge({ name_servers: servers })
         response = client.post("v1/domains/#{domain}/name_servers", options)
 
         response.parsed_response
@@ -45,11 +45,11 @@ module Dnsimple
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [String] name The hostname to register.
       # @param  [String] ip The hostname IP address.
-      #
       # @return [void]
+      #
       # @raise  [RequestError] When the request fails.
-      def register(domain, name, ip)
-        options = { name_server: { name: name, ip: ip } }
+      def register(domain, name, ip, options = {})
+        options = options.merge({ name_server: { name: name, ip: ip } })
         client.post("v1/domains/#{domain}/registry_name_servers", options)
       end
 
@@ -59,11 +59,11 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [String] name The hostname to register.
-      #
       # @return [void]
+      #
       # @raise  [RequestError] When the request fails.
-      def deregister(domain, name)
-        client.delete("v1/domains/#{domain}/registry_name_servers/#{name}")
+      def deregister(domain, name, options = {})
+        client.delete("v1/domains/#{domain}/registry_name_servers/#{name}", options)
       end
 
     end

data/lib/dnsimple/client/registrar.rb

@@ -7,12 +7,12 @@ module Dnsimple
       # @see http://developer.dnsimple.com/domains/registry/#check
       #
       # @param  [#to_s] name The domain name to check.
-      #
       # @return [Hash] The response containing the status, price, and more details.
+      #
       # @raise  [RequestError] When the request fails.
-      def check(name)
+      def check(name, options = {})
         response = begin
-          client.get("v1/domains/#{name}/check")
+          client.get("v1/domains/#{name}/check", options)
         rescue NotFoundError => e
           e.response
         end
@@ -25,11 +25,11 @@ module Dnsimple
       # @see http://developer.dnsimple.com/domains/registry/#check
       #
       # @param  [#to_s] name The domain name to check.
-      #
       # @return [Boolean] true if the domain is available
+      #
       # @raise  [RequestError] When the request fails.
-      def available?(name)
-        check(name)["status"] == "available"
+      def available?(name, options = {})
+        check(name, options)["status"] == "available"
       end
 
       # Registers a domain.
@@ -40,8 +40,8 @@ module Dnsimple
       # @param  [Fixnum] registrant_id The id of the contact to use as registrant.
       # @param  [Hash] extended_attributes
       # @param  [Hash] options
-      #
       # @return [Struct::Domain]
+      #
       # @raise  [RequestError] When the request fails.
       def register(name, registrant_id, extended_attributes = {}, options = {})
         options = Extra.deep_merge(options, { domain: { name: name, registrant_id: registrant_id }, extended_attribute: extended_attributes })
@@ -59,8 +59,8 @@ module Dnsimple
       # @param  [Fixnum] registrant_id The id of the contact to use as registrant.
       # @param  [Hash] extended_attributes
       # @param  [Hash] options
-      #
       # @return [Struct::TransferOrder]
+      #
       # @raise  [RequestError] When the request fails.
       def transfer(name, auth_code, registrant_id, extended_attributes = {}, options = {})
         options = Extra.deep_merge(options, { domain: { name: name, registrant_id: registrant_id }, extended_attribute: extended_attributes, transfer_order: { authinfo: auth_code }})
@@ -75,8 +75,8 @@ module Dnsimple
       #
       # @param  [#to_s] name The domain name to renew.
       # @param  [Hash] options
-      #
       # @return [Struct::Domain]
+      #
       # @raise  [RequestError] When the request fails.
       def renew(name, options = {})
         options = Extra.deep_merge(options, { domain: { name: name }})
@@ -91,27 +91,29 @@ module Dnsimple
       # @see http://developer.dnsimple.com/registrar/extended-attributes/#list
       #
       # @param  [#to_s] tld The TLD name.
-      #
       # @return [Array<Struct::ExtendedAttribute>]
+      #
       # @raise  [RequestError] When the request fails.
-      def list_extended_attributes(tld)
-        response = client.get("v1/extended_attributes/#{tld}")
+      def extended_attributes(tld, options = {})
+        response = client.get("v1/extended_attributes/#{tld}", options)
 
         response.map { |r| Struct::ExtendedAttribute.new(r) }
       end
-
+      alias :list_extended_attributes :extended_attributes
 
       # List all the TLD prices.
       #
       # @see http://developer.dnsimple.com/registrar/prices/#list
       #
       # @return [Array<Struct::Price>]
+      #
       # @raise  [RequestError] When the request fails.
-      def list_prices
-        response = client.get("v1/prices")
+      def prices(options = {})
+        response = client.get("v1/prices", options)
 
         response.map { |r| Struct::Price.new(r["price"]) }
       end
+      alias :list_prices :prices
 
     end
   end

data/lib/dnsimple/client/services.rb

@@ -7,26 +7,27 @@ module Dnsimple
       # @see http://developer.dnsimple.com/services/#list
       #
       # @return [Array<Struct::Service>]
+      #
       # @raise  [RequestError] When the request fails.
-      def services
-        response = client.get("v1/services")
+      def services(options = {})
+        response = client.get("v1/services", options)
 
         response.map { |r| Struct::Service.new(r["service"]) }
       end
-
       alias :list :services
+      alias :list_services :services
 
       # Gets a service.
       #
       # @see http://developer.dnsimple.com/services/#get
       #
       # @param  [Fixnum] service The service id.
-      #
       # @return [Struct::Service]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def service(service)
-        response = client.get("v1/services/#{service}")
+      def service(service, options = {})
+        response = client.get("v1/services/#{service}", options)
 
         Struct::Service.new(response["service"])
       end

data/lib/dnsimple/client/services_domains.rb

@@ -7,12 +7,12 @@ module Dnsimple
       # @see http://developer.dnsimple.com/services/#applied
       #
       # @param  [#to_s] domain The domain id or domain name.
-      #
       # @return [Array<Struct::Service>]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def applied(domain)
-        response = client.get("v1/domains/#{domain}/applied_services")
+      def applied(domain, options = {})
+        response = client.get("v1/domains/#{domain}/applied_services", options)
 
         response.map { |r| Struct::Service.new(r["service"]) }
       end
@@ -22,12 +22,12 @@ module Dnsimple
       # @see http://developer.dnsimple.com/services/#available
       #
       # @param  [#to_s] domain The domain id or domain name.
-      #
       # @return [Array<Struct::Service>]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def available(domain)
-        response = client.get("v1/domains/#{domain}/available_services")
+      def available(domain, options = {})
+        response = client.get("v1/domains/#{domain}/available_services", options)
 
         response.map { |r| Struct::Service.new(r["service"]) }
       end
@@ -38,12 +38,12 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Fixnum] service The service id.
-      #
       # @return [void]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def apply(domain, service)
-        options  = { service: { id: service }}
+      def apply(domain, service, options = {})
+        options  = Extra.deep_merge(options, { service: { id: service }})
         response = client.post("v1/domains/#{domain}/applied_services", options)
         response.code == 200
       end
@@ -54,12 +54,12 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Fixnum] service The service id.
-      #
       # @return [void]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def unapply(domain, service)
-        response = client.delete("v1/domains/#{domain}/applied_services/#{service}")
+      def unapply(domain, service, options = {})
+        response = client.delete("v1/domains/#{domain}/applied_services/#{service}", options)
         response.code == 200
       end
 

data/lib/dnsimple/client/templates.rb

@@ -7,42 +7,44 @@ module Dnsimple
       # @see http://developer.dnsimple.com/templates/#list
       #
       # @return [Array<Struct::Template>]
+      #
       # @raise  [RequestError] When the request fails.
-      def templates
-        response = client.get("v1/templates")
+      def templates(options = {})
+        response = client.get("v1/templates", options)
 
         response.map { |r| Struct::Template.new(r["dns_template"]) }
       end
-
       alias :list :templates
+      alias :list_templates :templates
 
       # Creates a template in the account.
       #
       # @see http://developer.dnsimple.com/templates/#create
       #
       # @param  [Hash] attributes
-      #
       # @return [Struct::Template]
+      #
       # @raise  [RequestError] When the request fails.
-      def create(attributes = {})
+      def create_template(attributes = {}, options = {})
         Extra.validate_mandatory_attributes(attributes, [:name, :short_name])
-        options  = { dns_template: attributes }
+        options  = options.merge({ dns_template: attributes })
         response = client.post("v1/templates", options)
 
         Struct::Template.new(response["dns_template"])
       end
+      alias :create :create_template
 
       # Gets a template from the account.
       #
       # @see http://developer.dnsimple.com/templates/#get
       #
       # @param  [#to_s] template The template id or short-name.
-      #
       # @return [Struct::Template]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def template(template)
-        response = client.get("v1/templates/#{template}")
+      def template(template, options = {})
+        response = client.get("v1/templates/#{template}", options)
 
         Struct::Template.new(response["dns_template"])
       end
@@ -53,16 +55,17 @@ module Dnsimple
       #
       # @param  [#to_s] template The template id or short-name.
       # @param  [Hash] attributes
-      #
       # @return [Struct::Template]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def update(template, attributes = {})
-        options  = { dns_template: attributes }
+      def update_template(template, attributes = {}, options = {})
+        options  = options.merge({ dns_template: attributes })
         response = client.put("v1/templates/#{template}", options)
 
         Struct::Template.new(response["dns_template"])
       end
+      alias :update :update_template
 
       # Deletes a template from the account.
       #
@@ -71,29 +74,14 @@ module Dnsimple
       # @see http://developer.dnsimple.com/templates/#delete
       #
       # @param  [#to_s] template The template id or short-name.
-      #
       # @return [void]
-      # @raise  [NotFoundError]
-      # @raise  [RequestError] When the request fails.
-      def delete(template)
-        client.delete("v1/templates/#{template}")
-      end
-
-
-      # Applies the template to the domain.
       #
-      # @see http://developer.dnsimple.com/templates/#apply
-      #
-      # @param  [#to_s] domain The domain id or domain name.
-      # @param  [#to_s] template The template id or short-name.
-      #
-      # @return [void]
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def apply(domain, template)
-        response = client.post("v1/domains/#{domain}/templates/#{template}/apply")
-        response.code == 200
+      def delete_template(template, options = {})
+        client.delete("v1/templates/#{template}", options)
       end
+      alias :delete :delete_template
 
     end
   end