dnsimple 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0f3e109fc2b3c88b76f2f569764e32792a626f7
-  data.tar.gz: e092631aa456c81f5a77076fab26334f2c9f93a0
+  metadata.gz: af0c0df379377bed93734974abb9af0f682cd75e
+  data.tar.gz: 250b4394bf6b35d7ea80276ee6b92cc6d90b2d50
 SHA512:
-  metadata.gz: f6393c8b54b069a15bd4cdce2e259586f7dde2c979b50bcddbeae5aa40015b08e6c6429851eba324daabbb7e27d05aa42f333bc09244032bb22790967762b9a6
-  data.tar.gz: 6f403fdb0107e7f8e50bee41ce24244ee5a1ae398835670bbdf19b369b0116f8d70788dd72f07bf1fd61e82821b277acb798807ea605b00f2593391f060693ad
+  metadata.gz: 075b9ffc70204575a94aec17e36f2bf11c1ba57384162abcbcb6d3daafb3a14a09e429d7a5ee6d87ce5e3800a6bdb72c37fff33c10891b7c335012a8989aa9fd
+  data.tar.gz: 489c8662934bdb41307a69ca9c972d8534125b707cb51bbe35e13d8b29dc3159062a970400a4dafbf3ea456bd0d07f6709777fd383054eb318f68a58855da13a

data/.rubocop_dnsimple.yml

@@ -14,7 +14,7 @@ AllCops:
 #                           end
 #
 Lint/EndAlignment:
-  AlignWith: variable
+  EnforcedStyleAlignWith: variable
 
 # [codesmell]
 Metrics/AbcSize:
@@ -23,6 +23,17 @@ Metrics/AbcSize:
     - 'spec/**/*_spec.rb'
     - 'test/**/*_test.rb'
 
+# [codesmell]
+Metrics/BlockLength:
+  Enabled: false
+
+# [codesmell]
+Metrics/CyclomaticComplexity:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
 # [codesmell]
 Metrics/ClassLength:
   Enabled: false
@@ -53,6 +64,15 @@ Metrics/ModuleLength:
     - 'spec/**/*_spec.rb'
     - 'test/**/*_test.rb'
 
+# [codesmell]
+Metrics/ParameterLists:
+  Enabled: false
+  Max: 5
+
+# [codesmell]
+Metrics/PerceivedComplexity:
+  Enabled: false
+
 # [codesmell]
 # I don't really get the point of this cop.
 Performance/RedundantMerge:
@@ -88,7 +108,7 @@ Style/BracesAroundHashParameters:
 #                           end
 #
 Style/CaseIndentation:
-  IndentWhenRelativeTo: end
+  EnforcedStyle: end
 
 # I was a big fan of leading, but trailing seems to be more commonly adopted.
 # At least at the time being.
@@ -121,6 +141,11 @@ Style/EmptyLinesAroundClassBody:
 Style/EmptyLinesAroundModuleBody:
   Enabled: false
 
+# There is no specific preference for empty methods.
+# One-line methods are not exceptionally nice in Ruby. Just ignore this cop for now.
+Style/EmptyMethod:
+  Enabled: false
+
 # I personally don't care about the format style.
 # In most cases I like to use %, but not at the point I want to enforce it
 # as a convention in the entire code.
@@ -164,6 +189,16 @@ Style/IndentHash:
 Style/IfInsideElse:
   Enabled: false
 
+# module_function doesn't respect the visibility of the methods,
+# and doesn't work well when the module contain both public/private methods.
+Style/ModuleFunction:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Exclude:
+    # RSpec uses multi-line blocks for certain features
+    - 'spec/**/*_spec.rb'
+
 # Multi-line differs from standard indentation, they are indented twice.
 Style/MultilineMethodCallIndentation:
   EnforcedStyle: indented
@@ -195,6 +230,17 @@ Style/RegexpLiteral:
 Style/RescueModifier:
   Enabled: false
 
+# Sorry, but using trailing spaces helps readability.
+#
+#   %w( foo bar )
+#
+# looks better to me than
+#
+#   %w( foo bar )
+#
+Style/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false
+
 # We don't have a preference.
 Style/SpecialGlobalVars:
   Enabled: false
@@ -220,3 +266,7 @@ Style/TrivialAccessors:
   #    end
   #
   IgnoreClassMethods: true
+
+Style/WordArray:
+  EnforcedStyle: percent
+  MinSize: 3

data/.travis.yml

@@ -4,8 +4,10 @@ rvm:
 - 2.0
 - 2.1
 - 2.2
-- 2.3.0
+- 2.3.3
+- 2.4.0
 env: COVERALL=1
 
 before_install:
-- gem install bundler
+  - gem update --system
+  - gem install bundler

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
+#### 4.2.0
+
+- NEW: Added DNSSEC support support (dnsimple/dnsimple-ruby#152)
+
 #### 4.1.0
 
 - NEW: Added domain premium price support (dnsimple/dnsimple-ruby#143)
@@ -35,7 +39,7 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 - 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: Setting a custom user-agent no longer overrides the original user-agent (GH-105).
 - CHANGED: Updated client to use Contact#email (GH-108).
 
 - REMOVED: Removed support for wildcard accounts (GH-107).

data/README.md

@@ -61,18 +61,31 @@ puts response.data
 
 For the full library documentation visit http://rubydoc.info/gems/dnsimple
 
-## Sandbox Usage
 
-If you would like to test the [DNSimple sandbox environment](https://developer.dnsimple.com/sandbox/) then pass the `base_url` named argument when you construct the client. For example:
+## Sandbox Environment
 
-```ruby
-require 'dnsimple'
+We highly recommend testing against our [sandbox environment](https://developer.dnsimple.com/sandbox/) before using our production environment. This will allow you to avoid real purchases, live charges on your credit card, and reduce the chance of your running up against rate limits.
+
+The client supports both the production and sandbox environment. To switch to sandbox pass the sandbox API host using the `base_url` option when you construct the client:
 
+```ruby
 client = Dnsimple::Client.new(base_url: "https://api.sandbox.dnsimple.com", access_token: "a1b2c3")
 ```
 
 You will need to ensure that you are using an access token created in the sandbox environment. Production tokens will *not* work in the sandbox environment.
 
+
+## Setting a custom `User-Agent` header
+
+You customize the `User-Agent` header for the calls made to the DNSimple API:
+
+```ruby
+client = Dnsimple::Client.new(user_agent: "my-app")
+```
+
+The value you provide will be appended to the default `User-Agent` the client uses. For example, if you use `my-app`, the final header value will be `dnsimple-ruby/4.1.0 my-app` (note that it will vary depending on the client version).
+
+
 ## License
 
 Copyright (c) 2010-2016 Aetrion LLC. This is Free Software distributed under the MIT license.

data/lib/dnsimple/client.rb

@@ -9,6 +9,18 @@ module Dnsimple
   # Client for the DNSimple API
   #
   # @see https://developer.dnsimple.com/
+  # @see https://developer.dnsimple.com/sandbox/
+  # @see #base_url
+  #
+  # @example Default (Production)
+  #   require "dnsimple"
+  #
+  #   client = Dnsimple::Client.new(access_token: "abc")
+  #
+  # @example Custom Base URL (Sandbox)
+  #   require 'dnsimple'
+  #
+  #   client = Dnsimple::Client.new(base_url: "https://api.sandbox.dnsimple.com", access_token: "abc")
   class Client
 
     HEADER_AUTHORIZATION = "Authorization".freeze
@@ -37,15 +49,13 @@ module Dnsimple
     # @!attribute access_token
     #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] Domain API access token for authentication
-    # @!attribute base_url
-    #   @return [String] Base URL for API requests. (default: https://api.dnsimple.com/)
     # @!attribute user_agent
     #   @return [String] Configure User-Agent header for requests.
     # @!attribute proxy
     #   @return [String,nil] Configure address:port values for proxy server
 
     attr_accessor :username, :password, :domain_api_token, :access_token,
-                  :base_url, :user_agent, :proxy
+                  :user_agent, :proxy
 
 
     def initialize(options = {})
@@ -59,7 +69,24 @@ module Dnsimple
     end
 
 
-    # @return [String] Base URL for API requests.
+    # Base URL for API requests.
+    #
+    # It defaults to <tt>"https://api.dnsimple.com"</tt>.
+    # For testing purposes use <tt>"https://api.sandbox.dnsimple.com"</tt>.
+    #
+    # @return [String] Base URL
+    #
+    # @see https://developer.dnsimple.com/sandbox/
+    #
+    # @example Default (Production)
+    #   require "dnsimple"
+    #
+    #   client = Dnsimple::Client.new(access_token: "abc")
+    #
+    # @example Custom Base URL (Sandbox)
+    #   require 'dnsimple'
+    #
+    #   client = Dnsimple::Client.new(base_url: "https://api.sandbox.dnsimple.com", access_token: "abc")
     def base_url
       Extra.join_uri(@base_url, "")
     end

data/lib/dnsimple/client/clients.rb

@@ -133,12 +133,16 @@ module Dnsimple
 
 
     require_relative 'domains'
+    require_relative 'domains_delegation_signer_records'
+    require_relative 'domains_dnssec'
     require_relative 'domains_email_forwards'
     require_relative 'domains_pushes'
     require_relative 'collaborators'
 
     class DomainsService < ClientService
       include Client::Domains
+      include Client::DomainsDelegationSignerRecords
+      include Client::DomainsDnssec
       include Client::DomainsEmailForwards
       include Client::DomainsPushes
       include Client::Collaborators

data/lib/dnsimple/client/collaborators.rb

@@ -14,7 +14,7 @@ module Dnsimple
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id the domain ID or name
-      # @param  [Hash] request options
+      # @param  [Hash] options request options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Collaborator>]
@@ -35,9 +35,9 @@ module Dnsimple
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id the domain ID or name
-      # @param  [Hash] user attributes
-      # @param  attributes [String] :email user email (mandatory)
-      # @param  [Hash] request options
+      # @param  [Hash] attributes user attributes
+      # @option attributes [String] :email user email (mandatory)
+      # @param  [Hash] options request options
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Collaborator>]
       #
       # @raise  [Dnsimple::RequestError]
@@ -60,7 +60,7 @@ module Dnsimple
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id the domain ID or name
       # @param  [#to_s] contact_id the contact ID
-      # @param  [Hash] request options
+      # @param  [Hash] options request options
       # @return [Dnsimple::Response<nil>]
       #
       # @raise  [Dnsimple::NotFoundError]

data/lib/dnsimple/client/domains_delegation_signer_records.rb

@@ -0,0 +1,122 @@
+module Dnsimple
+  class Client
+    module DomainsDelegationSignerRecords
+
+      # Lists the delegation signer records for the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-list
+      #
+      # @example List delegation signer records in the first page
+      #   client.domains.delegation_signer_records(1010, "example.com")
+      #
+      # @example List delegation signer records, provide a specific page
+      #   client.domains.email_forwards(1010, "example.com", page: 2)
+      #
+      # @example List delegation signer records, provide a sorting policy
+      #   client.domains.delegation_signer_records(1010, "example.com", sort: "from:asc")
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_id The domain ID or domain name
+      # @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::DelegationSignerRecord>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def delegation_signer_records(account_id, domain_id, options = {})
+        response = client.get(Client.versioned("/%s/domains/%s/ds_records" % [account_id, domain_id]), Options::ListOptions.new(options))
+
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::DelegationSignerRecord.new(r) })
+      end
+
+      # Lists ALL the delegation signer records for the domain.
+      #
+      # This method is similar to {#delegation_signer_records}, but instead of returning the results of a specific page
+      # it iterates all the pages and returns the entire collection.
+      #
+      # Please use this method carefully, as fetching the entire collection will increase the number of requests
+      # you send to the API server and you may eventually risk to hit the throttle limit.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-list
+      # @see #email_forwards
+      #
+      # @param  [Integer] 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::DelegationSignerRecord>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def all_delegation_signer_records(account_id, domain_id, options = {})
+        paginate(:delegation_signer_records, account_id, domain_id, options)
+      end
+
+      # Creates a delegation signer record for the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-create
+      # @see http://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml
+      # @see http://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_id The domain ID or domain name
+      # @param  [Hash] attributes
+      # @option attributes [Integer] :algorithm DNSSEC algorithm as number (required)
+      # @option attributes [String] :digest The hexidecimal representation of the digest of the corresponding DNSKEY record (required)
+      # @option attributes [Integer] :digest_type DNSSEC digest type (required)
+      # @option attributes [String] :keytag A keytag that references the corresponding DNSKEY record (required)
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::DelegationSignerRecord>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def create_delegation_signer_record(account_id, domain_id, attributes, options = {})
+        Extra.validate_mandatory_attributes(attributes, [:algorithm, :digest, :digest_type, :keytag])
+        response = client.post(Client.versioned("/%s/domains/%s/ds_records" % [account_id, domain_id]), attributes, options)
+
+        Dnsimple::Response.new(response, Struct::DelegationSignerRecord.new(response["data"]))
+      end
+
+      # Gets a delegation signer record for the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-get
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_id The domain ID or domain name
+      # @param  [#to_s] ds_record_id The delegation signer record ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::DelegationSignerRecord>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def delegation_signer_record(account_id, domain_id, ds_record_id, options = {})
+        response = client.get(Client.versioned("/%s/domains/%s/ds_records/%s" % [account_id, domain_id, ds_record_id]), options)
+
+        Dnsimple::Response.new(response, Struct::DelegationSignerRecord.new(response["data"]))
+      end
+
+      # Deletes a delegation signer record for the domain.
+      #
+      # WARNING: this cannot be undone.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-delete
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_id The domain ID or domain name
+      # @param  [#to_s] ds_record_id The delegation signer record ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def delete_delegation_signer_record(account_id, domain_id, ds_record_id, options = {})
+        response = client.delete(Client.versioned("/%s/domains/%s/ds_records/%s" % [account_id, domain_id, ds_record_id]), nil, options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/domains_dnssec.rb

@@ -0,0 +1,57 @@
+module Dnsimple
+  class Client
+    module DomainsDnssec
+
+      # Enable DNSSEC for the domain in the account.
+      #
+      # @see https://developer.dnsimple.com/v2/dnssec/#enable
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::Dnssec>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def enable_dnssec(account_id, domain_name, options = {})
+        response = client.post(Client.versioned("/%s/domains/%s/dnssec" % [account_id, domain_name]), nil, options)
+
+        Dnsimple::Response.new(response, Struct::Dnssec.new(response["data"]))
+      end
+
+      # Disable DNSSEC for the domain in the account.
+      #
+      # @see https://developer.dnsimple.com/v2/dnssec/#disable
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def disable_dnssec(account_id, domain_name, options = {})
+        response = client.delete(Client.versioned("/%s/domains/%s/dnssec" % [account_id, domain_name]), nil, options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+
+      # Get the DNSSEC status for the domain in the account.
+      #
+      # @see https://developer.dnsimple.com/v2/dnssec/#get
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::Dnssec>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def get_dnssec(account_id, domain_name, options = {})
+        response = client.get(Client.versioned("/%s/domains/%s/dnssec" % [account_id, domain_name]), options)
+
+        Dnsimple::Response.new(response, Struct::Dnssec.new(response["data"]))
+      end
+    end
+  end
+end