dnsimple 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8aca4eb6f6813b601531e5c5d82f9db0ec222dd5
-  data.tar.gz: 6076520c66e7ac64e23e1e006a9342f96cefabc5
+  metadata.gz: eb3f3b1fc8b0c99b792b0c1a1d6b27830ff2331f
+  data.tar.gz: 1c79d167d1d71d3af51981a326494c1a3b02fb53
 SHA512:
-  metadata.gz: 3b56cb8d598eec60f48cf0eb63594e323b3a16d2d02a73a003e4fd7c64030f6a2d488fc77b8e4abab8c33598a28411aa15fdb946db4c0db2dc4faeafb1507303
-  data.tar.gz: d9cc0e1e056166b2cc5952ecd3d317bb524341ea92aaaac581a9e414bbc4e6164837f40b65566420281633a17ecb6c707430db2d0ee56e3053e439c9d96d9a65
+  metadata.gz: 2f56e2bf1ca4267264aa5730b146de169430497389827745a8ce6bf80bd34dc5f8721454d9c330a83c6684e43f2fbb8ff0d0ec22ad30f70f9892ce64fb952872
+  data.tar.gz: 2574f383a0a03086b280ded7535153f563364e51d015a5499ea18ca93187f4eaa4c14e76109baab246f2837699426683159ece814c37f930edf8c19f5cc86a31

data/CHANGELOG.md

@@ -3,6 +3,25 @@
 This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 
+#### 3.1.0
+
+- NEW: Added accounts support (GH-113).
+
+- NEW: Added sorting and filtering support (GH-112).
+
+- NEW: Added template record support (GH-104).
+
+- CHANGED: Pagination params must be passed as top level options. Previously they were passed inside `:query` options (GH-116).
+
+- CHANGED: Authentication credentials presence is no longer validated on the client as it was causing an error getting the access token (GH-74 and GH-102).
+
+- CHANGED: Setting a custom user-agent no longer overrides the origina user-agent (GH-105).
+
+- CHANGED: Updated client to use Contact#email (GH-108).
+
+- REMOVED: Removed support for wildcard accounts (GH-107).
+
+
 #### 3.0.0
 
 ##### stable
@@ -19,7 +38,6 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 - CHANGED: Error detection is now smarter. If the error is deserializable and contains a message, the message is attached to the exception (GH-94, GH-95, GH-100).
 
-
 ##### beta2
 
 - FIXED: `state` and `redirect_uri` are not properly passed in the request to exchang the code for an access token (GH-89, GH-90).
@@ -42,7 +60,7 @@ Internal changes were made to match conventions adopted in other clients, such a
 
 #### 2.1.0
 
-- NEW: Add the ability to set headers and pass extra connection params in each API method (GH-64) 
+- NEW: Add the ability to set headers and pass extra connection params in each API method (GH-64)
 
 #### 2.0.0
 

data/README.md

@@ -18,16 +18,16 @@ This library is currently in beta version, the methods and the implementation sh
 
 ## Installation
 
-During the initial beta period, releases of this gem are flagged as [prerelease](http://guides.rubygems.org/patterns/#prerelease-gems). You will need to append `--pre` in order to install the beta client.
+You can install the gem manually:
 
 ```
-$ gem install dnsimple --pre
+$ gem install dnsimple
 ```
 
-Also note that Bundler ignores pre-releases by default. To use a pre-release gem, make sure to explicitly add the release version.
+Or use Bundler and define it as a dependency in your Gemfile:
 
 ```
-gem 'dnsimple', '~> 3.0', '>= 3.0.0.pre.beta1'
+gem 'dnsimple', '~> 3.0'
 ```
 
 ## Usage
@@ -48,6 +48,7 @@ client.identity.whoami.data         # execute the call and get the data in one l
 account_id = 1010
 
 # You can also fetch it from the whoami response
+# as long as you authenticate with an Account access token
 whoami = client.identity.whoami.data
 account_id = whoami.account.id
 

data/dnsimple.gemspec

@@ -5,8 +5,8 @@ require 'dnsimple/version'
 Gem::Specification.new do |s|
   s.name        = 'dnsimple'
   s.version     = Dnsimple::VERSION
-  s.authors     = ['Anthony Eden', 'Simone Carletti']
-  s.email       = ['anthony.eden@dnsimple.com', 'simone.carletti@dnsimple.com']
+  s.authors     = ['Anthony Eden', 'Simone Carletti', 'Javier Acero', 'Joseph Caudle', 'Luca Guidi']
+  s.email       = ['anthony.eden@dnsimple.com', 'simone.carletti@dnsimple.com', 'javier.acero@dnsimple.com', 'joseph.caudle@dnsimple.com', 'luca.guidi@dnsimple.com']
   s.homepage    = 'https://github.com/aetrion/dnsimple-ruby'
   s.summary     = 'The DNSimple API client for Ruby'
   s.description = 'The DNSimple API client for Ruby.'
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.extra_rdoc_files = %w( LICENSE.txt )
 
-  s.add_dependency  'httparty'
+  s.add_dependency 'httparty'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

data/lib/dnsimple.rb

@@ -18,3 +18,4 @@ require 'dnsimple/version'
 require 'dnsimple/default'
 require 'dnsimple/client'
 require 'dnsimple/error'
+require 'dnsimple/options'

data/lib/dnsimple/client.rb

@@ -12,8 +12,6 @@ module Dnsimple
   class Client
 
     HEADER_AUTHORIZATION = "Authorization".freeze
-    WILDCARD_ACCOUNT = "_".freeze
-
 
     # @return [String] The current API version.
     API_VERSION = "v2".freeze
@@ -73,7 +71,7 @@ module Dnsimple
     # @param  [Hash] options The query and header params for the request
     # @return [HTTParty::Response]
     def get(path, options = {})
-      execute :get, path, nil, options
+      execute :get, path, nil, options.to_h
     end
 
     # Make a HTTP POST request.
@@ -155,7 +153,7 @@ module Dnsimple
     # @param  [Hash] options The query and header params for the request
     # @return [HTTParty::Response]
     def request(method, path, data = nil, options = {})
-      request_options = Extra.deep_merge!(base_options, options)
+      request_options = request_options(options)
 
       if data
         request_options[:headers]["Content-Type"] = content_type(request_options[:headers])
@@ -168,29 +166,57 @@ module Dnsimple
 
     private
 
+    def request_options(custom_options = {})
+      base_options.tap do |options|
+        Extra.deep_merge!(options, custom_options)
+        Extra.deep_merge!(options, headers: { "User-Agent" => format_user_agent })
+        add_auth_options!(options)
+        add_proxy_options!(options)
+      end
+    end
+
     def base_options
-      options = {
+      {
           format:   :json,
           headers:  {
-              'Accept' => 'application/json',
-              'User-Agent' => user_agent,
+              "Accept" => "application/json",
           },
       }
+    end
 
+    def add_proxy_options!(options)
       if proxy
         address, port = proxy.split(":")
-        options.merge!(http_proxyaddr: address, http_proxyport: port)
+        options[:http_proxyaddr] = address
+        options[:http_proxyport] = port
       end
+    end
 
+    def add_auth_options!(options)
       if password
         options[:basic_auth] = { username: username, password: password }
       elsif access_token
         options[:headers][HEADER_AUTHORIZATION] = "Bearer #{access_token}"
-      else
-        raise Error, 'A password, domain API token or access token is required for all API requests.'
       end
+    end
 
-      options
+    # Builds the final user agent to use for HTTP requests.
+    #
+    # If no custom user agent is provided, the default user agent is used.
+    #
+    #     dnsimple-ruby/1.0
+    #
+    # If a custom user agent is provided, the final user agent is the combination
+    # of the custom user agent prepended by the default user agent.
+    #
+    #     dnsimple-ruby/1.0 customAgentFlag
+    #
+    def format_user_agent
+      if user_agent.to_s.empty?
+        Dnsimple::Default::USER_AGENT
+      else
+        "#{Dnsimple::Default::USER_AGENT} #{user_agent}"
+      end
     end
 
     def content_type(headers)

data/lib/dnsimple/client/accounts.rb

@@ -0,0 +1,26 @@
+module Dnsimple
+  class Client
+    module Accounts
+
+      # Lists the accounts the authenticated entity has access to.
+      #
+      # @see https://developer.dnsimple.com/v2/accounts
+      #
+      # @example List the accounts:
+      #   client.accounts.list
+      #
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::Account>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def accounts(options = {})
+        response = client.get(Client.versioned("/accounts"), options)
+
+        Dnsimple::Response.new(response, response["data"].map { |r| Struct::Account.new(r) })
+      end
+      alias list accounts
+      alias list_accounts accounts
+
+    end
+  end
+end

data/lib/dnsimple/client/clients.rb

@@ -1,6 +1,11 @@
 module Dnsimple
   class Client
 
+    # @return [Dnsimple::Client::AccountsService] The account-related API proxy.
+    def accounts
+      @services[:accounts] ||= Client::AccountsService.new(self)
+    end
+
     # @return [Dnsimple::Client::ContactsService] The contact-related API proxy.
     def contacts
       @services[:contacts] ||= Client::ContactsService.new(self)
@@ -52,7 +57,7 @@ module Dnsimple
     end
 
 
-    # @!class Struct
+    # Struct
     class ClientService
 
       # @return [Dnsimple::Client]
@@ -91,6 +96,13 @@ module Dnsimple
     end
 
 
+    require_relative 'accounts'
+
+    class AccountsService < ClientService
+      include Client::Accounts
+    end
+
+
     require_relative 'contacts'
 
     class ContactsService < ClientService
@@ -142,9 +154,11 @@ module Dnsimple
 
 
     require_relative 'templates'
+    require_relative 'templates_records'
 
     class TemplatesService < ClientService
       include Client::Templates
+      include Client::TemplatesRecords
     end
 
 

data/lib/dnsimple/client/contacts.rb

@@ -11,15 +11,21 @@ module Dnsimple
       #   client.contacts.list(1010)
       #
       # @example List contacts, provide a specific page
-      #   client.contacts.list(1010, query: { page: 2 })
+      #   client.contacts.list(1010, page: 2)
+      #
+      # @example List contacts, provide a sorting policy
+      #   client.contacts.list(1010, sort: "email:asc")
       #
       # @param  [Fixnum] account_id the account ID
-      # @param  [Hash] options the filtering and sorting option
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Contact>]
       #
       # @raise  [Dnsimple::RequestError]
       def contacts(account_id, options = {})
-        response = client.get(Client.versioned("/%s/contacts" % [account_id]), options)
+        response = client.get(Client.versioned("/%s/contacts" % [account_id]), Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Contact.new(r) })
       end
@@ -38,7 +44,10 @@ module Dnsimple
       # @see #contacts
       #
       # @param  [Fixnum] account_id the account ID
-      # @param  [Hash] options the filtering and sorting option
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
       # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Contact>]
       #
       # @raise  [Dnsimple::RequestError]
@@ -58,7 +67,7 @@ module Dnsimple
       #
       # @raise  [Dnsimple::RequestError]
       def create_contact(account_id, attributes, options = {})
-        Extra.validate_mandatory_attributes(attributes, [:first_name, :last_name, :address1, :city, :state_province, :postal_code, :country, :phone, :email_address])
+        Extra.validate_mandatory_attributes(attributes, [:first_name, :last_name, :address1, :city, :state_province, :postal_code, :country, :phone, :email])
         response = client.post(Client.versioned("/%s/contacts" % [account_id]), attributes, options)
 
         Dnsimple::Response.new(response, Struct::Contact.new(response["data"]))
@@ -69,7 +78,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/contacts/#get
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] contact_id the contact ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Contact>]
@@ -106,7 +115,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/contacts/#delete
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] contact_id the contact ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]

data/lib/dnsimple/client/domains.rb

@@ -11,15 +11,25 @@ module Dnsimple
       #   client.domains.list(1010)
       #
       # @example List domains, provide a specific page
-      #   client.domains.list(1010, query: { page: 2 })
+      #   client.domains.list(1010, page: 2)
+      #
+      # @example List domains, provide a sorting policy
+      #   client.domains.list(1010, sort: "expires_on:asc")
+      #
+      # @example List domains, provide a filtering policy
+      #   client.domains.list(1010, filter: { name_like: "example" })
       #
       # @param  [Fixnum] account_id the account ID
-      # @param  [Hash] options the filtering and sorting option
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
+      # @option options [Hash] :filter filtering policy
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Domain>]
       #
       # @raise  [Dnsimple::RequestError]
       def domains(account_id, options = {})
-        response = client.get(Client.versioned("/%s/domains" % [account_id]), options)
+        response = client.get(Client.versioned("/%s/domains" % [account_id]), Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Domain.new(r) })
       end
@@ -39,6 +49,10 @@ module Dnsimple
       #
       # @param  [Fixnum] account_id the account ID
       # @param  [Hash] options the filtering and sorting option
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
+      # @option options [Hash] :filter filtering policy
       # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Domain>]
       #
       # @raise  [Dnsimple::RequestError]
@@ -70,7 +84,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/#get
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Domain>]
@@ -89,7 +103,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/#delete
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]
@@ -107,7 +121,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/#reset-token
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]

data/lib/dnsimple/client/domains_email_forwards.rb

@@ -10,17 +10,23 @@ module Dnsimple
       #   client.domains.email_forwards(1010, "example.com")
       #
       # @example List email forwards, provide a specific page
-      #   client.domains.email_forwards(1010, "example.com", query: { page: 2 })
+      #   client.domains.email_forwards(1010, "example.com", page: 2)
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @example List email forwards, provide a sorting policy
+      #   client.domains.email_forwards(1010, "example.com", sort: "from:asc")
+      #
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
-      # @param  [Hash] options the filtering and sorting option
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::EmailForward>]
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
       def email_forwards(account_id, domain_id, options = {})
-        response = client.get(Client.versioned("/%s/domains/%s/email_forwards" % [account_id, domain_id]), options)
+        response = client.get(Client.versioned("/%s/domains/%s/email_forwards" % [account_id, domain_id]), Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::EmailForward.new(r) })
       end
@@ -36,9 +42,12 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/domains/email-forwards/#list
       # @see #email_forwards
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] options the filtering and sorting option
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
       # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::EmailForward>]
       #
       # @raise  [Dnsimple::RequestError]
@@ -50,7 +59,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/email-forwards/#create
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] attributes
       # @param  [Hash] options
@@ -68,7 +77,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/email-forwards/#get
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [#to_s] email_forward_id The email forward ID
       # @param  [Hash] options
@@ -88,7 +97,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/email-forwards/#delete
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [#to_s] email_forward_id The email forward ID
       # @param  [Hash] options