dnsimple 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39d9b33d782af6a1b17cb008ac9008797b299b28
-  data.tar.gz: c04fb52908ce4bfe2ca7ac005a099c09d7e7d3ab
+  metadata.gz: 0b14f9c45f6173fc08744a1732a9a8ad9ae158ca
+  data.tar.gz: c0e2383549ab9ab518563926243ccf98af981848
 SHA512:
-  metadata.gz: a3e28ab4eadcffc6f883e2d3b9661e6ae82dabcf46fc6863fe0b0ce5c6f64bc38f01e3b57042691b6c6c59584518bb025bc019c7620d178d59948ff7cb965cd3
-  data.tar.gz: 95482c599561709d19941656fec554c4a76d4172d65d3578b40c0773141a33885f066161c65f6cef687fd900d624ee609d50d27c2d7c3bf1d66ab9c063af4253
+  metadata.gz: 79a95261aca54349137b962fd1312862bb70c5caf746b734ad731e4100f95ef68235cf3c9f081013e495bf32e958b45c7b32e8cd2cdd898d2f795cf83d83283a
+  data.tar.gz: 034abea2f3296583a85d1a063076894c3a2521925159d631d98ad847623de00f08d6cd3cec79bf65ce8c1eeaa698ee04cc57dbe9e51eb42a5e93b45e0ff753b3

data/CHANGELOG.markdown

@@ -1,6 +1,10 @@
 # Changelog
 
-#### 2.0.0.alpha
+#### 2.1.0
+
+- NEW: Add the ability to set headers and pass extra connection params in each API method (GH-64) 
+
+#### 2.0.0
 
 **2.0.0.alpha**
 
@@ -24,7 +28,6 @@
 
 - FIXED: Fixed a bug where API token environment variables were not properly detected (GH-59, GH-62). Thanks @oguzbilgic and @rupurt.
 
-
 #### Release 1.7.1
 
 - FIXED: Updated Certificate to match the serialized attributes (GH-53).

data/dnsimple.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   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.homepage    = 'https://github.com/aetrion/dnsimple-ruby'
   s.summary     = 'A Ruby client for the DNSimple API'
   s.description = 'A Ruby client for the DNSimple API.'
 

data/lib/dnsimple/client/certificates.rb

@@ -8,8 +8,8 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Hash] options
-      #
       # @return [Array<Struct::Certificate>]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
       def certificates(domain, options = {})
@@ -17,8 +17,8 @@ module Dnsimple
 
         response.map { |r| Struct::Certificate.new(r["certificate"]) }
       end
-
       alias :list :certificates
+      alias :list_certificates :certificates
 
       # Gets a certificate for a domain.
       #
@@ -26,12 +26,12 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Fixnum] certificate_id The certificate ID.
-      #
       # @return [Struct::Certificate]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def certificate(domain, certificate_id)
-        response = client.get("v1/domains/#{domain}/certificates/#{certificate_id}")
+      def certificate(domain, certificate_id, options = {})
+        response = client.get("v1/domains/#{domain}/certificates/#{certificate_id}", options)
 
         Struct::Certificate.new(response["certificate"])
       end
@@ -54,8 +54,8 @@ module Dnsimple
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [String] name The certificate name.
       # @param  [Fixnum] contact_id The ID of the contact associated to the certificate.
-      #
       # @return [Struct::Certificate]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
       def purchase(domain, name, contact_id, options = {})
@@ -69,12 +69,12 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Fixnum] certificate_id The certificate ID.
-      #
       # @return [Struct::Certificate]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def configure(domain, certificate_id)
-        response = client.put("v1/domains/#{domain}/certificates/#{certificate_id}/configure")
+      def configure(domain, certificate_id, options = {})
+        response = client.put("v1/domains/#{domain}/certificates/#{certificate_id}/configure", options)
 
         Struct::Certificate.new(response["certificate"])
       end
@@ -88,8 +88,8 @@ module Dnsimple
       # @return [Struct::Certificate]
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def submit(domain, certificate_id, email)
-        options = { certificate: { approver_email: email }}
+      def submit(domain, certificate_id, email, options = {})
+        options  = options.merge(certificate: { approver_email: email })
         response = client.put("v1/domains/#{domain}/certificates/#{certificate_id}/submit", options)
 
         Struct::Certificate.new(response["certificate"])

data/lib/dnsimple/client/clients.rb

@@ -62,7 +62,7 @@ module Dnsimple
 
     require 'dnsimple/client/domains'
     require 'dnsimple/client/domains_records'
-    require 'dnsimple/client/domains_autorenewals'
+    require 'dnsimple/client/domains_autorenewal'
     require 'dnsimple/client/domains_privacy'
     require 'dnsimple/client/domains_sharing'
     require 'dnsimple/client/domains_forwards'
@@ -71,7 +71,7 @@ module Dnsimple
     class DomainsService < ClientService
       include Client::Domains
       include Client::DomainsRecords
-      include Client::DomainsAutorenewals
+      include Client::DomainsAutorenewal
       include Client::DomainsPrivacy
       include Client::DomainsSharing
       include Client::DomainsForwards
@@ -103,10 +103,12 @@ module Dnsimple
 
 
     require 'dnsimple/client/templates'
+    require 'dnsimple/client/templates_domains'
     require 'dnsimple/client/templates_records'
 
     class TemplatesService < ClientService
       include Client::Templates
+      include Client::TemplatesDomains
       include Client::TemplatesRecords
     end
 

data/lib/dnsimple/client/contacts.rb

@@ -7,42 +7,44 @@ module Dnsimple
       # @see http://developer.dnsimple.com/contacts/#list
       #
       # @return [Array<Struct::Contact>]
+      #
       # @raise  [RequestError] When the request fails.
-      def contacts
-        response = client.get("v1/contacts")
+      def contacts(options = {})
+        response = client.get("v1/contacts", options)
 
         response.map { |r| Struct::Contact.new(r["contact"]) }
       end
-
       alias :list :contacts
+      alias :list_contacts :contacts
 
       # Creates a contact in the account.
       #
       # @see http://developer.dnsimple.com/contacts/#create
       #
       # @param  [Hash] attributes
-      #
       # @return [Struct::Contact]
+      #
       # @raise  [RequestError] When the request fails.
-      def create(attributes = {})
+      def create_contact(attributes = {}, options = {})
         Extra.validate_mandatory_attributes(attributes, [:first_name, :last_name, :address1, :city, :state_province, :postal_code, :country, :phone, :email_address])
-        options  = { contact: attributes }
+        options  = options.merge(contact: attributes)
         response = client.post("v1/contacts", options)
 
         Struct::Contact.new(response["contact"])
       end
+      alias :create :create_contact
 
       # Gets a contact from the account.
       #
       # @see http://developer.dnsimple.com/contacts/#get
       #
       # @param  [Fixnum] contact The contact id.
-      #
       # @return [Struct::Contact]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def contact(contact)
-        response = client.get("v1/contacts/#{contact}")
+      def contact(contact, options = {})
+        response = client.get("v1/contacts/#{contact}", options)
 
         Struct::Contact.new(response["contact"])
       end
@@ -53,16 +55,17 @@ module Dnsimple
       #
       # @param  [Fixnum] contact The contact id.
       # @param  [Hash] attributes
-      #
       # @return [Struct::Contact]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def update(contact, attributes = {})
-        options  = { contact: attributes }
+      def update_contact(contact, attributes = {}, options = {})
+        options  = options.merge(contact: attributes)
         response = client.put("v1/contacts/#{contact}", options)
 
         Struct::Contact.new(response["contact"])
       end
+      alias :update :update_contact
 
       # Deletes a contact from the account.
       #
@@ -71,13 +74,14 @@ module Dnsimple
       # @see http://developer.dnsimple.com/contacts/#delete
       #
       # @param  [Fixnum] contact The contact id.
-      #
       # @return [void]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def delete(contact)
-        client.delete("v1/contacts/#{contact}")
+      def delete_contact(contact, options = {})
+        client.delete("v1/contacts/#{contact}", options)
       end
+      alias :delete :delete_contact
 
     end
   end

data/lib/dnsimple/client/domains.rb

@@ -6,43 +6,46 @@ module Dnsimple
       #
       # @see http://developer.dnsimple.com/domains/#list
       #
+      # @param  [Hash] options the filtering and sorting option
       # @return [Array<Struct::Domain>]
+      #
       # @raise  [RequestError] When the request fails.
       def domains(options = {})
         response = client.get("v1/domains", options)
 
         response.map { |r| Struct::Domain.new(r["domain"]) }
       end
-
       alias :list :domains
+      alias :list_domains :domains
 
-      # Gets a domain from the account.
-      #
-      # @see http://developer.dnsimple.com/domains/#get
+      # Creates a domain in the account.
       #
-      # @param  [#to_s] domain The domain id or domain name.
+      # @see http://developer.dnsimple.com/domains/#create
       #
+      # @param  [Hash] attributes
       # @return [Struct::Domain]
-      # @raise  [NotFoundError]
+      #
       # @raise  [RequestError] When the request fails.
-      def domain(domain)
-        response = client.get("v1/domains/#{domain}")
+      def create_domain(attributes = {}, options = {})
+        Extra.validate_mandatory_attributes(attributes, [:name])
+        options  = options.merge({ domain: attributes })
+        response = client.post("v1/domains", options)
 
         Struct::Domain.new(response["domain"])
       end
+      alias :create :create_domain
 
-      # Creates a domain in the account.
-      #
-      # @see http://developer.dnsimple.com/domains/#create
+      # Gets a domain from the account.
       #
-      # @param  [Hash] attributes
+      # @see http://developer.dnsimple.com/domains/#get
       #
+      # @param  [#to_s] domain The domain id or domain name.
       # @return [Struct::Domain]
+      #
+      # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def create(attributes = {})
-        Extra.validate_mandatory_attributes(attributes, [:name])
-        options  = { domain: attributes }
-        response = client.post("v1/domains", options)
+      def domain(domain, options = {})
+        response = client.get("v1/domains/#{domain}", options)
 
         Struct::Domain.new(response["domain"])
       end
@@ -54,13 +57,14 @@ module Dnsimple
       # @see http://developer.dnsimple.com/domains/#delete
       #
       # @param  [#to_s] domain The domain id or domain name.
-      #
       # @return [void]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def delete(domain)
-        client.delete("v1/domains/#{domain}")
+      def delete_domain(domain, options = {})
+        client.delete("v1/domains/#{domain}", options)
       end
+      alias :delete :delete_domain
 
     end
   end

data/lib/dnsimple/client/{domains_autorenewals.rb → domains_autorenewal.rb}

@@ -1,17 +1,17 @@
 module Dnsimple
   class Client
-    module DomainsAutorenewals
+    module DomainsAutorenewal
 
       # Enables auto-renewal for a domain.
       #
       # @see http://developer.dnsimple.com/domains/autorenewal/#enable
       #
       # @param  [#to_s] domain The domain id or domain name.
-      #
       # @return [Struct::Domain]
+      #
       # @raise  [RequestError] When the request fails.
-      def enable_auto_renewal(domain)
-        response = client.post("v1/domains/#{domain}/auto_renewal")
+      def enable_auto_renewal(domain, options = {})
+        response = client.post("v1/domains/#{domain}/auto_renewal", options)
 
         Struct::Domain.new(response["domain"])
       end
@@ -21,11 +21,11 @@ module Dnsimple
       # @see http://developer.dnsimple.com/domains/autorenewal/#disable
       #
       # @param  [#to_s] domain The domain id or domain name.
-      #
       # @return [Struct::Domain]
+      #
       # @raise  [RequestError] When the request fails.
-      def disable_auto_renewal(domain)
-        response = client.delete("v1/domains/#{domain}/auto_renewal")
+      def disable_auto_renewal(domain, options = {})
+        response = client.delete("v1/domains/#{domain}/auto_renewal", options)
 
         Struct::Domain.new(response["domain"])
       end

data/lib/dnsimple/client/domains_forwards.rb

@@ -7,15 +7,16 @@ module Dnsimple
       # @see http://developer.dnsimple.com/domains/forwards/#list
       #
       # @param  [#to_s] domain The domain id or domain name.
-      #
       # @return [Array<Struct::EmailForward>]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def email_forwards(domain)
-        response = client.get("v1/domains/#{domain}/email_forwards")
+      def email_forwards(domain, options = {})
+        response = client.get("v1/domains/#{domain}/email_forwards", options)
 
         response.map { |r| Struct::EmailForward.new(r["email_forward"]) }
       end
+      alias :list_email_forwards :email_forwards
 
       # Creates an email forward for a domain.
       #
@@ -23,13 +24,13 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Hash] attributes
-      #
       # @return [Struct::EmailForward]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def create_email_forward(domain, attributes = {})
+      def create_email_forward(domain, attributes = {}, options = {})
         Extra.validate_mandatory_attributes(attributes, [:from, :to])
-        options  = { email_forward: attributes }
+        options  = options.merge({ email_forward: attributes })
         response = client.post("v1/domains/#{domain}/email_forwards", options)
 
         Struct::EmailForward.new(response["email_forward"])
@@ -41,12 +42,12 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Fixnum] forward The forward id.
-      #
       # @return [Struct::EmailForward]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def email_forward(domain, forward)
-        response = client.get("v1/domains/#{domain}/email_forwards/#{forward}")
+      def email_forward(domain, forward, options = {})
+        response = client.get("v1/domains/#{domain}/email_forwards/#{forward}", options)
 
         Struct::EmailForward.new(response["email_forward"])
       end
@@ -57,12 +58,12 @@ module Dnsimple
       #
       # @param  [#to_s] domain The domain id or domain name.
       # @param  [Fixnum] forward The forward id.
-      #
       # @return [void]
+      #
       # @raise  [NotFoundError]
       # @raise  [RequestError] When the request fails.
-      def delete_email_forward(domain, forward)
-        client.delete("v1/domains/#{domain}/email_forwards/#{forward}")
+      def delete_email_forward(domain, forward, options = {})
+        client.delete("v1/domains/#{domain}/email_forwards/#{forward}", options)
       end
 
     end

data/lib/dnsimple/client/domains_privacy.rb

@@ -7,11 +7,11 @@ module Dnsimple
       # @see http://developer.dnsimple.com/domains/privacy/#enable
       #
       # @param  [#to_s] domain The domain id or domain name.
-      #
       # @return [Struct::WhoisPrivacy]
+      #
       # @raise  [RequestError] When the request fails.
-      def enable_whois_privacy(domain)
-        response = client.post("v1/domains/#{domain}/whois_privacy")
+      def enable_whois_privacy(domain, options = {})
+        response = client.post("v1/domains/#{domain}/whois_privacy", options)
 
         Struct::WhoisPrivacy.new(response["whois_privacy"])
       end
@@ -21,11 +21,11 @@ module Dnsimple
       # @see http://developer.dnsimple.com/domains/privacy/#disable
       #
       # @param  [#to_s] domain The domain id or domain name.
-      #
       # @return [Struct::WhoisPrivacy]
+      #
       # @raise  [RequestError] When the request fails.
-      def disable_whois_privacy(domain)
-        response = client.delete("v1/domains/#{domain}/whois_privacy")
+      def disable_whois_privacy(domain, options = {})
+        response = client.delete("v1/domains/#{domain}/whois_privacy", options)
 
         Struct::WhoisPrivacy.new(response["whois_privacy"])
       end