dnsimple 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5798dd92561074094a81017acdd5337d2497e6b0
-  data.tar.gz: cde903898b98b7d316d0542f7e9257de64f5196a
+SHA256:
+  metadata.gz: 49d2f2a2d0892e3ae7e31b563035cd668200f164a05fcde6b59b5fb497a123ee
+  data.tar.gz: 572cf3a3277efb2cb55cd5f9a0fc644bfe4a356a2853846e6f3af37a3964e28e
 SHA512:
-  metadata.gz: dc7c8c73aa1deace9034c3d5e4f8a392c0dbd966b73ff28c1771f581614f6efbe74e331b01225552513c63d006637f24d3df07ac68b44940aa9ada62d0a99c99
-  data.tar.gz: 6c1cc1d2121ccbbc316bcd55a99d3c4fca2a00410298c56f69bbc22b925ce0cee1b46bc30ed97467d202183a690982b61c49ad3d84fefecbb1800b91394fe924
+  metadata.gz: 90c025c122e88a6408f57abf2ff564ea309e10af4e85c16c2e1d8b513b58cfb726514634abd00e746e98a966827df7082d16ec333d32cb5290c0711a2ac94bd4
+  data.tar.gz: ba8db8d64adddf8d7aa04f66527eaa0fb00a6ed00be88c52c0a23d21b616ef0ef03a7850e83b0571f6be7d2e227915a4b755b58064136d199adce9b3b2ccf117

data/.rubocop_dnsimple.yml

@@ -1,4 +1,8 @@
 # Defaults https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+#
+# References:
+#  * https://github.com/bbatsov/ruby-style-guide
+#  * https://rubocop.readthedocs.io/
 
 AllCops:
   Exclude:
@@ -10,6 +14,11 @@ AllCops:
 Bundler/OrderedGems:
   Enabled: false
 
+# This cop requires odd code indentations (as of rubocop 0.57.0)
+# https://github.com/rubocop-hq/rubocop/issues/5956
+Layout/AccessModifierIndentation:
+  Enabled: false
+
 # Generally, the keyword style uses a lot of space. This is particularly true when
 # you use case/if statements, in combination with a long-name variable.
 #
@@ -20,7 +29,7 @@ Bundler/OrderedGems:
 #                             do_else
 #                           end
 #
-Lint/EndAlignment:
+Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
 
 # [codesmell]
@@ -84,6 +93,11 @@ Metrics/ParameterLists:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+# We tend to use @_name to represent a variable that is memoized,
+# but it should not be accessed directly and kept as private.
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
 # We use it from time to time, as it's not always possible (or maintainable)
 # to use simple ? methods.
 # Moreover, it's actually more efficient to not-use predicates:
@@ -91,11 +105,24 @@ Metrics/PerceivedComplexity:
 Naming/PredicateName:
   Enabled: false
 
+# This cop triggers several false positives that make sense in our domain model.
+# For instance, ip is considered an uncommunicative parameter name:
+#
+#   ipv4_to_arpa_name(ip)
+#
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
 # [codesmell]
 # I don't really get the point of this cop.
 Performance/RedundantMerge:
   Enabled: false
 
+# This cop returns false positive violations (as of rubocop 0.57.0)
+# https://github.com/rubocop-hq/rubocop/issues/5953
+Style/AccessModifierDeclarations:
+  Enabled: false
+
 # Do not use "and" or "or" in conditionals, but for readability we can use it
 # to chain executions. Just beware of operator order.
 Style/AndOr:
@@ -229,7 +256,12 @@ Style/StringLiteralsInInterpolation:
 
 # It's nice to be consistent. The trailing comma also allows easy reordering,
 # and doesn't cause a diff in Git when you add a line to the bottom.
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+# It's nice to be consistent. The trailing comma also allows easy reordering,
+# and doesn't cause a diff in Git when you add a line to the bottom.
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 
 Style/TrivialAccessors:

data/.travis.yml

@@ -3,11 +3,11 @@ language: ruby
 sudo: false
 
 rvm:
-  - 2.0
   - 2.1
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
 
 env:
   - COVERALL=1
@@ -16,3 +16,7 @@ before_install:
   - rvm get latest
   - gem update --system
   - gem install bundler
+
+notifications:
+  slack:
+    secure: "N9zPR5jnF1TBiqvb3mCV6Wem3TIvqu4tXiob2P66vBMwmj1ewWvyUzNLwAEOCDc3mRfsI50IYXHewckAUpCWW7XEJlT/pv8llMsoiHqArb7SGJyDdy3ZRr35L7glixs/ikod+xhRKXMM3jML/2MgSa+Culzhl42tMUFDk+bBBQU="

data/CHANGELOG.md

@@ -3,6 +3,17 @@
 This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 
+### 4.5.0
+
+- NEW: Added zone distribution and zone record distribution (GH-160)
+
+- CHANGED: Bump minimum Ruby requirement to 2.1
+- CHANGED: Introduce Dnsimple::Struct::VanityNameServer (GH-144)
+- CHANGED: Fix name inconsistency of the Collaborator module (GH-154)
+
+- REMOVED: Removed extra alias (GH-168). You should use `dnsimple.foo.list_foo` instead of `dnsimple.foo.list`. Same for create/update. The change ensures consistency across the various clients. We prefer fully qualified methods.
+
+
 #### 4.4.0
 
 - NEW: Added Let's Encrypt certificate methods (GH-159)

data/CONTRIBUTING.md

@@ -2,19 +2,25 @@
 
 ## Getting started
 
+#### 1. Clone the repository
+
 Clone the repository and move into it:
 
+```shell
+git clone git@github.com:dnsimple/dnsimple-ruby.git
+cd dnsimple-ruby
 ```
-$ git clone git@github.com:dnsimple/dnsimple-ruby.git
-$ cd dnsimple-ruby
-```
+
+#### 2. Install the dependencies
 
 Install the dependencies using [Bundler](http://bundler.io/):
 
 ```
-$ bundle
+bundle
 ```
 
+#### 3. Build and test
+
 [Run the test suite](#testing) to check everything works as expected.
 
 
@@ -23,7 +29,7 @@ $ bundle
 To run the test suite:
 
 ```
-$ rake
+rake
 ```
 
 
@@ -31,5 +37,4 @@ $ rake
 
 Submit unit tests for your changes. You can test your changes on your machine by [running the test suite](#testing).
 
-When you submit a PR, tests will also be run on the continuous integration environment [through Travis](https://travis-ci.org/dnsimple/dnsimple-ruby).
-
+When you submit a PR, tests will also be run on the [continuous integration environment via Travis](https://travis-ci.org/dnsimple/dnsimple-ruby).

data/README.md

@@ -14,7 +14,7 @@ We provide a full API and an easy-to-use web interface so you can get your domai
 You can install the gem manually:
 
 ```
-$ gem install dnsimple
+gem install dnsimple
 ```
 
 Or use Bundler and define it as a dependency in your Gemfile:
@@ -85,7 +85,6 @@ 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-2018 Aetrion LLC. This is Free Software distributed under the MIT license.

data/dnsimple.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.summary     = 'The DNSimple API client for Ruby'
   s.description = 'The DNSimple API client for Ruby.'
 
-  s.required_ruby_version = ">= 2.0"
+  s.required_ruby_version = ">= 2.1"
 
   s.require_paths    = ['lib']
   s.files            = `git ls-files`.split("\n")

data/lib/dnsimple/client.rb

@@ -61,7 +61,7 @@ module Dnsimple
     def initialize(options = {})
       defaults = Dnsimple::Default.options
 
-      Dnsimple::Default.keys.each do |key| # rubocop:disable Performance/HashEachMethods
+      Dnsimple::Default.keys.each do |key|
         instance_variable_set(:"@#{key}", options[key] || defaults[key])
       end
 

data/lib/dnsimple/client/accounts.rb

@@ -18,7 +18,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, response["data"].map { |r| Struct::Account.new(r) })
       end
-      alias list accounts
       alias list_accounts accounts
 
     end

data/lib/dnsimple/client/certificates.rb

@@ -29,6 +29,7 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Certificate.new(r) })
       end
+      alias list_certificates certificates
 
       # List ALL the certificates for the domain in the account.
       #

data/lib/dnsimple/client/clients.rb

@@ -137,7 +137,7 @@ module Dnsimple
     require_relative 'domains_dnssec'
     require_relative 'domains_email_forwards'
     require_relative 'domains_pushes'
-    require_relative 'collaborators'
+    require_relative 'domains_collaborators'
 
     class DomainsService < ClientService
       include Client::Domains
@@ -145,7 +145,7 @@ module Dnsimple
       include Client::DomainsDnssec
       include Client::DomainsEmailForwards
       include Client::DomainsPushes
-      include Client::Collaborators
+      include Client::DomainsCollaborators
     end
 
 
@@ -212,10 +212,12 @@ module Dnsimple
 
     require_relative 'zones'
     require_relative 'zones_records'
+    require_relative 'zones_distributions'
 
     class ZonesService < ClientService
       include Client::Zones
       include Client::ZonesRecords
+      include Client::ZonesDistributions
     end
 
 

data/lib/dnsimple/client/contacts.rb

@@ -29,7 +29,6 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Contact.new(r) })
       end
-      alias list contacts
       alias list_contacts contacts
 
       # Lists ALL the contacts in the account.
@@ -54,7 +53,6 @@ module Dnsimple
       def all_contacts(account_id, options = {})
         paginate(:contacts, account_id, options)
       end
-      alias all all_contacts
 
       # Creates a contact in the account.
       #
@@ -72,7 +70,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Contact.new(response["data"]))
       end
-      alias create create_contact
 
       # Gets a contact from the account.
       #
@@ -107,7 +104,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Contact.new(response["data"]))
       end
-      alias update update_contact
 
       # Deletes a contact from the account.
       #
@@ -127,7 +123,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
-      alias delete delete_contact
 
     end
   end

data/lib/dnsimple/client/domains.rb

@@ -33,7 +33,6 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Domain.new(r) })
       end
-      alias list domains
       alias list_domains domains
 
       # Lists ALL the domains in the account.
@@ -59,7 +58,6 @@ module Dnsimple
       def all_domains(account_id, options = {})
         paginate(:domains, account_id, options)
       end
-      alias all all_domains
 
       # Creates a domain in the account.
       #
@@ -78,7 +76,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Domain.new(response["data"]))
       end
-      alias create create_domain
 
       # Gets a domain from the account.
       #
@@ -115,7 +112,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
-      alias delete delete_domain
 
       # Resets the domain token.
       #

data/lib/dnsimple/client/{collaborators.rb → domains_collaborators.rb}

@@ -1,6 +1,6 @@
 module Dnsimple
   class Client
-    module Collaborators
+    module DomainsCollaborators
 
       # Lists the collaborators for a domain.
       #

data/lib/dnsimple/client/registrar_delegation.rb

@@ -56,19 +56,19 @@ module Dnsimple
       # @param  [#to_s] domain_name the domain name to check
       # @param  [Array] attributes
       # @param  [Hash] options
-      # @return [Dnsimple::Response<Array>]
+      # @return [Dnsimple::Response<Array<Dnsimple::Struct::VanityNameServer>>]
       #
       # @raise  [RequestError] When the request fails.
       def change_domain_delegation_to_vanity(account_id, domain_name, attributes, options = {})
         endpoint = Client.versioned("/%s/registrar/domains/%s/delegation/vanity" % [account_id, domain_name])
         response = client.put(endpoint, attributes, options)
 
-        Dnsimple::Response.new(response, response["data"])
+        Dnsimple::Response.new(response, response["data"].map { |r| Struct::VanityNameServer.new(r) })
       end
 
       # Disable vanity name servers for the domain.
       #
-      # @see https://developer.dnsimple.com/v2/registrar/delegation/#delegateFromVanity
+      # @see https://developer.dnsimple.com/v2/registrar/delegation/#dedelegateFromVanity
       #
       # @example Disable vanity name servers for example.com:
       #   client.registrar.change_domain_delegation_from_vanity(1010, "example.com")
@@ -83,7 +83,7 @@ module Dnsimple
         endpoint = Client.versioned("/%s/registrar/domains/%s/delegation/vanity" % [account_id, domain_name])
         response = client.delete(endpoint, options)
 
-        Dnsimple::Response.new(response, response["data"])
+        Dnsimple::Response.new(response, nil)
       end
 
     end

data/lib/dnsimple/client/services.rb

@@ -28,7 +28,6 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Service.new(r) })
       end
-      alias list services
       alias list_services services
 
       # Lists ALL the available one-click services.
@@ -55,7 +54,6 @@ module Dnsimple
       def all_services(options = {})
         paginate(:services, options)
       end
-      alias all all_services
 
       # Gets the service with specified ID.
       #

data/lib/dnsimple/client/tlds.rb

@@ -1,18 +1,18 @@
 module Dnsimple
   class Client
     module Tlds
-      # Lists the tlds available for registration
+      # Lists the TLDs available for registration
       #
-      # @see https://developer.dnsimple.com/v2/tlds/#list
+      # @see https://developer.dnsimple.com/v2/tlds/#listTlds
       #
       # @example List TLDs in the first page
-      #   client.tlds.list
+      #   client.tlds.list_tlds
       #
       # @example List TLDs, providing a specific page
-      #   client.tlds.list(page: 2)
+      #   client.tlds.list_tlds(page: 2)
       #
       # @example List TLDs, providing sorting policy
-      #   client.tlds.list(sort: "tld:asc")
+      #   client.tlds.list_tlds(sort: "tld:asc")
       #
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
@@ -21,13 +21,11 @@ module Dnsimple
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Tld>]
       #
       # @raise [Dnsimple::RequestError]
-      def tlds(options = {})
+      def list_tlds(options = {})
         response = client.get(Client.versioned("/tlds"), Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Tld.new(r) })
       end
-      alias list tlds
-      alias list_tlds tlds
 
       # Lists ALL the TLDs in DNSimple.
       #
@@ -37,8 +35,8 @@ module Dnsimple
       # 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/tlds/#list
-      # @see #tlds
+      # @see https://developer.dnsimple.com/v2/tlds/#listTlds
+      # @see #list_tlds
       #
       # @example List all TLDs in DNSimple
       #     client.tlds.all
@@ -51,13 +49,12 @@ module Dnsimple
       #
       # @raise [Dnsimple::RequestError]
       def all_tlds(options = {})
-        paginate(:tlds, options)
+        paginate(:list_tlds, options)
       end
-      alias all all_tlds
 
-      # Gets a TLD's details
+      # Gets a TLD details
       #
-      # @see https://developer.dnsimple.com/v2/tlds/#get
+      # @see https://developer.dnsimple.com/v2/tlds/#getTld
       #
       # @example Get information on a specific TLD
       #     client.tlds.tld('com')
@@ -76,10 +73,10 @@ module Dnsimple
 
       # Gets the extended attributes for a TLD.
       #
-      # @see https://developer.dnsimple.com/v2/tlds/#extended-attributes
+      # @see https://developer.dnsimple.com/v2/tlds/#getTldExtendedAttributes
       #
       # @example Get extended attributes for a specific TLD
-      #     client.tlds.extended_attributes('uk')
+      #     client.tlds.tld_extended_attributes('uk')
       #
       # @param  [#to_s] tld The TLD name.
       # @param  [Hash] options
@@ -87,7 +84,7 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def extended_attributes(tld, options = {})
+      def tld_extended_attributes(tld, options = {})
         response = client.get(Client.versioned("/tlds/%s/extended_attributes" % tld), options)
 
         Dnsimple::CollectionResponse.new(response, response["data"].map { |r| Struct::ExtendedAttribute.new(r) })