dnsimple 4.3.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ebcde22a916ca2575f93426b277d8fb2000da824
-  data.tar.gz: d26271208dcf497b132004385a800ff229432287
+SHA256:
+  metadata.gz: 740c15a07bacc12086f2c0c3282e78150735247a9e85b6be0c84019a9a1a4de3
+  data.tar.gz: 4caef1a3ce2d61bcb59f882f5195990e64eeef2fe17294afe68ec31922460c23
 SHA512:
-  metadata.gz: 68991131ad17ff8d9a7bf14ddf3fed6a2f298668074e39945537478eff76bad1f921db9e90c8b34aa311fda12e19f8267fb208bb7605001f965bb9f65bd73c1e
-  data.tar.gz: 2993c7d50cd5a8eaf44a0d15276dc7b0ce6e1374f20be04f62ccac9bd650a7b43d7acfaf8ee7102ac66dc2b91be8baee72a2a297211b2b13039aae3e5ab6b267
+  metadata.gz: 365c3a046910052fdc92c0c7a9f014f8dee87766097fcb00a182fe15b87916de86fe9649c9ec491cb9095237ee5e91cdda660142a1dccc72777b3f017ceb1351
+  data.tar.gz: a55e3f6c772e4667086d4b007c2af15618f8555564fca8a548d3eafcfd5fe8067e06f47057c19b981aeaf55086f32019f7a9055d4b7ae51eb11715e015e3d58c

data/.dependabot/config.yml

@@ -0,0 +1,9 @@
+version: 1
+update_configs:
+  - package_manager: "ruby:bundler"
+    directory: "/"
+    update_schedule: "daily"
+    default_labels:
+      - "task"
+      - "dependencies"
+      - "backlog-dependencies"

data/.rubocop.yml

@@ -2,6 +2,13 @@ inherit_from:
   - .rubocop_todo.yml
   - .rubocop_dnsimple.yml
 
+require: rubocop-performance
+
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'Rakefile'
+
 # [codesmell]
 # It's irrelevant here, but it could be a code smell.
 # Hence keep it disabled, but don't include it in the DNSimple suite.

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,15 @@ 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
+
+# It causes weird aligments, especially for specs.
+Layout/BlockEndNewline:
+  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,11 +33,19 @@ Bundler/OrderedGems:
 #                             do_else
 #                           end
 #
-Lint/EndAlignment:
+Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
 
 # [codesmell]
-Lint/HandleExceptions:
+Layout/LineLength:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+  Max: 100
+
+# [codesmell]
+Lint/SuppressedException:
   Enabled: false
 
 # [codesmell]
@@ -52,14 +73,6 @@ Metrics/ClassLength:
     - 'spec/**/*_spec.rb'
     - 'test/**/*_test.rb'
 
-# [codesmell]
-Metrics/LineLength:
-  Enabled: false
-  Exclude:
-    - 'spec/**/*_spec.rb'
-    - 'test/**/*_test.rb'
-  Max: 100
-
 # [codesmell]
 Metrics/MethodLength:
   Enabled: false
@@ -84,9 +97,33 @@ Metrics/ParameterLists:
 Metrics/PerceivedComplexity:
   Enabled: false
 
-# [codesmell]
-# I don't really get the point of this cop.
-Performance/RedundantMerge:
+# 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:
+# https://github.com/bbatsov/rubocop/issues/3633
+Naming/PredicateName:
+  Enabled: false
+
+# The team agreed decided to use exception
+Naming/RescuedExceptionsVariableName:
+  PreferredName: 'exception'
+
+# 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/MethodParameterName:
+  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
@@ -104,12 +141,6 @@ Style/BlockDelimiters:
   IgnoredMethods:
     - expect
 
-# I'm not sure we should enforce a style,
-# but if we do, context_dependent offers a good compromise on readability.
-Style/BracesAroundHashParameters:
-  Enabled: false
-  EnforcedStyle: context_dependent
-
 # Warn on empty else.
 Style/EmptyElse:
   EnforcedStyle: empty
@@ -119,26 +150,37 @@ Style/EmptyElse:
 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
+# We don't care about the format style.
+# In most cases we use %, but not at the point we want to enforce it
 # as a convention in the entire code.
 Style/FormatString:
   Enabled: false
 
-# We don't support frozen strings.
-# This is an experimental feature and we don't know if it will be shipped with
-# Ruby 3.0 or not.
-Style/FrozenStringLiteralComment:
+# Annotated tokens (like %<foo>s) are a good thing, but in most cases we don't need them.
+# %s is a simpler and straightforward version that works in almost all cases. So don't complain.
+Style/FormatStringToken:
   Enabled: false
 
 # Prefer the latest Hash syntax
 Style/HashSyntax:
   Exclude:
-    # But Rakefiles generally have some definition like
+    # Rakefiles generally have definitions like
     #   :default => :test
     # that looks nicer with the old rocket syntax.
     - 'Rakefile'
 
+# Enforces usage of Hash#each_key and Hash#each_value (vs. Hash#keys.each and Hash#values.each).
+Style/HashEachMethods:
+  Enabled: true
+
+# Enforce the use of Hash#TransformKeys introduced in Ruby 2.5 to transform Hash keys.
+Style/HashTransformKeys:
+  Enabled: true
+
+# Enforce the use of Hash#TransformValues introduced in Ruby 2.5 to transform Hash values.
+Style/HashTransformValues:
+  Enabled: true
+
 # We want to be able to decide when to use one-line if/unless modifiers.
 Style/IfUnlessModifier:
   Enabled: false
@@ -149,7 +191,7 @@ 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.
+# and doesn't work well when the module contains both public/private methods.
 Style/ModuleFunction:
   Enabled: false
 
@@ -175,12 +217,16 @@ Style/NumericLiterals:
 Style/PercentLiteralDelimiters:
   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:
-# https://github.com/bbatsov/rubocop/issues/3633
-Style/PredicateName:
-  Enabled: false
+# Enable but only for multiple returns value.
+#
+#   return foo, bar
+#
+# reads much better than
+#
+#   [foo, bar]
+#
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
 
 # Do we care?
 Style/RegexpLiteral:
@@ -213,7 +259,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:
@@ -265,6 +316,10 @@ Layout/DotPosition:
 Layout/EmptyLines:
   Enabled: false
 
+# This is buggy. It detects as a style violation a few `class` and `module` definitions
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
 Layout/EmptyLinesAroundBlockBody:
   Exclude:
     # RSpec is all made of blocks. Disable this config in RSpec
@@ -291,18 +346,16 @@ Layout/EmptyLineBetweenDefs:
   Enabled: false
 
 # Multi-line differs from standard indentation, they are indented twice.
-Layout/FirstParameterIndentation:
+Layout/FirstArgumentIndentation:
   IndentationWidth: 4
 
-# Array indentation should be considered like MultilineMethodCallIndentation indentation
-# and use 4 spaces instead of 2.
-Layout/IndentArray:
-  IndentationWidth: 4
+# Array indentation should be consistent with method/variable definition.
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
 
-# Hash indentation should be considered like MultilineMethodCallIndentation indentation
-# and use 4 spaces instead of 2.
-Layout/IndentHash:
-  IndentationWidth: 4
+# Hash indentation should be consistent with method/variable definition.
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
 
 # Multi-line differs from standard indentation, they are indented twice.
 Layout/MultilineMethodCallIndentation:
@@ -318,9 +371,47 @@ Layout/MultilineOperationIndentation:
 #
 #   %w( foo bar )
 #
-# looks better to me than
+# looks better than:
 #
-#   %w( foo bar )
+#   %w(foo bar)
 #
 Layout/SpaceInsidePercentLiteralDelimiters:
   Enabled: false
+
+
+# New cops
+# We'll remove them once they become defaults.
+# See https://docs.rubocop.org/en/latest/versioning/
+
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+# Introduced in rubocop 0.84.0
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+# Introduced in rubocop 0.85.0
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true

data/.travis.yml

@@ -1,13 +1,17 @@
-sudo: false
 language: ruby
+
 rvm:
-- 2.0
-- 2.1
-- 2.2
-- 2.3.4
-- 2.4.1
-env: COVERALL=1
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+
+env:
+  - COVERALL=1
 
 before_install:
-  - gem update --system
-  - gem install bundler
+  - gem install bundler -v 1.17.3
+
+notifications:
+  slack:
+    secure: "N9zPR5jnF1TBiqvb3mCV6Wem3TIvqu4tXiob2P66vBMwmj1ewWvyUzNLwAEOCDc3mRfsI50IYXHewckAUpCWW7XEJlT/pv8llMsoiHqArb7SGJyDdy3ZRr35L7glixs/ikod+xhRKXMM3jML/2MgSa+Culzhl42tMUFDk+bBBQU="

data/CHANGELOG.md

@@ -2,20 +2,54 @@
 
 This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
+## 5.1.0
 
-#### 4.3.0
+- CHANGED: `Domain#expires_on` (date only) is deprecated in favor of `Domain#expires_at` (timestamp). (dnsimple/dnsimple-ruby#186)
+
+## 5.0.0
+
+- CHANGED: Minimum Ruby version is now 2.4
+- CHANGED: User-agent format has been changed to prepend custom token before default token.
+- NEW: Added `registrar.get_domain_transfer` to retrieve a domain transfer. (dnsimple/dnsimple-ruby#180)
+- NEW: Added `registrar.cancel_domain_transfer` to cancel an in progress domain transfer. (dnsimple/dnsimple-ruby#180)
+- NEW: Added `DomainTransfer#status_description` attribute to identify the failure reason of a transfer. (dnsimple/dnsimple-ruby#180).
+
+## 4.6.0
+
+- NEW: Added WHOIS privacy renewal (GH-171)
+
+
+## 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)
+
+- REMOVED: Removed premium_price attribute from registrar order responses (GH-163). Please do not rely on that attribute, as it returned an incorrect value. The attribute is going to be removed, and the API now returns a null value.
+
+
+## 4.3.0
 
 - NEW: Added `certificates.all_certificates` (dnsimple/dnsimple-ruby#155)
 
 - CHANGED: Updated registrar URLs (dnsimple/dnsimple-ruby#153)
 
 
-#### 4.2.0
+## 4.2.0
 
 - NEW: Added DNSSEC support support (dnsimple/dnsimple-ruby#152)
 
 
-#### 4.1.0
+## 4.1.0
 
 - NEW: Added domain premium price support (dnsimple/dnsimple-ruby#143)
 
@@ -23,7 +57,7 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 - CHANGED: Normalize unique string identifiers to SID (dnsimple/dnsimple-ruby#141)
 
 
-#### 4.0.0
+## 4.0.0
 
 - NEW: Added domain collaborators support (GH-137).
 - NEW: Added regions support for zone records (GH-135, GH-139).
@@ -40,7 +74,7 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 - CHANGED: Renamed registrar `auth_info` into `auth_code` (GH-136).
 
 
-#### 3.1.0
+## 3.1.0
 
 - NEW: Added accounts support (GH-113).
 - NEW: Added sorting and filtering support (GH-112).
@@ -54,9 +88,9 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 - REMOVED: Removed support for wildcard accounts (GH-107).
 
 
-#### 3.0.0
+## 3.0.0
 
-##### stable
+### stable
 
 - FIXED: The client was using the wrong key to store the ContactsService which could cause conflicts with the DomainsService.
 
@@ -70,13 +104,13 @@ 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
+### 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).
 
 - FIXED: Request body is not properly serialized to JSON, and the "Content-Type" header was omissed (GH-91).
 
-##### beta1
+### beta1
 
 - CHANGED: Minimum Ruby version >= 2
 
@@ -86,15 +120,15 @@ The client has been completely redesigned to support the [API v2](https://develo
 
 Internal changes were made to match conventions adopted in other clients, such as the Go one and the Elixir one.
 
-#### 2.1.1
+## 2.1.1
 
 - FIXED: Paths may mistakenly be generated use \ on windows.
 
-#### 2.1.0
+## 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
 
 **2.0.0.alpha**
 
@@ -106,7 +140,7 @@ Internal changes were made to match conventions adopted in other clients, such a
 
 - CHANGED: Drop 1.8.7, 1.9.2 support. Required Ruby >= 1.9.3.
 
-- CHANGED: This package no longer provides a CLI. The CLI has been extracted to [aetrion/dnsimple-ruby-cli](https://github.com/aetrion/dnsimple-ruby-cli)
+- CHANGED: This package no longer provides a CLI. The CLI has been extracted to [dnsimple-ruby-cli](https://github.com/dnsimple/dnsimple-ruby-cli)
 
 - CHANGED: Renamed the Gem from "dnsimple-ruby" to "dnsimple" (GH-23).
 
@@ -118,23 +152,23 @@ Internal changes were made to match conventions adopted in other clients, such a
 
 - 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
+## Release 1.7.1
 
 - FIXED: Updated Certificate to match the serialized attributes (GH-53).
 
-#### Release 1.7.0
+## Release 1.7.0
 
 - NEW: Add support for Domain-based authentication (GH-40, GH-46). Thanks @dwradcliffe and @samsonasu.
 
-#### Release 1.6.0
+## Release 1.6.0
 
 - NEW: Add support for 2FA (GH-44)
 
-#### Release 1.5.5
+## Release 1.5.5
 
 - NEW: Add notice about the CLI moving to a new location
 
-#### Release 1.5.4
+## Release 1.5.4
 
 - NEW: Added domain#expires_on attribute (GH-34). Thanks @alkema
 
@@ -144,23 +178,23 @@ Internal changes were made to match conventions adopted in other clients, such a
 
 - CHANGED: User.me now uses the correct patch for API v1.
 
-#### Release 1.5.3
+## Release 1.5.3
 
 - FIXED: In some cases the client crashed with NoMethodError VERSION (GH-35).
 
-#### Release 1.5.2
+## Release 1.5.2
 
 - NEW: Provide a meaningful user-agent.
 
-#### Release 1.5.1
+## Release 1.5.1
 
 - FIXED: Invalid base URI.
 
-#### Release 1.5.0
+## Release 1.5.0
 
 - CHANGED: Added support for versioned API (GH-33)
 
-#### Release 1.4.0
+## Release 1.4.0
 
 - CHANGED: Normalized exception handling. No more RuntimeError.
   In case of request error, the client raises RequestError, RecordExists or RecodNotFound