dnsimple 4.6.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ccd26ac738f667185d2005071eb215045dcce8bdcaaf48ba5b1b31f9187bdcf
-  data.tar.gz: a8474bcd18275b39465931d06230fd07434a839a39dbfeead1e130289929f7a6
+  metadata.gz: ab6c994d5800e178144ce47b8be27dfb7b7e9414457b133fda7ad76eebac7236
+  data.tar.gz: '08f39ba56093182666f5bf838c9cc5e2c3337971de7691c2e34670bbdba6f91d'
 SHA512:
-  metadata.gz: bb079ccceb1587b61ce3d0660a9963dad812d01da3634d0581dc80095fb2157fc86a191d711590bfb8d85c48c9c47e47a6a30b7e6e14c107b50195894e552c67
-  data.tar.gz: e7a5735a36b36dca5dee66104d90c0bbdb83afa878a9e5423bcac5b46b965a5324e16ad6380cb9f8a51ee91d3df8baa3bff47633c750b9ce529d0a9ed62c0e78
+  metadata.gz: a77416c5e9a16f301f0819bed9e15e7555ab85a1461fa35a7b761f803a68c362a44da42cffa50cd29ae720cbec6d7be045c45cda2438cbfb71131cf7ea3ba858
+  data.tar.gz: 7180a39ea3751190263096a7ac0bf845b04f5518cc768a2debc4f4d054c6a0310f1aef82aebfd13f8d23761b93d56ff01b16bf9df24f1c0265a73741970cb820

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,8 @@ inherit_from:
   - .rubocop_todo.yml
   - .rubocop_dnsimple.yml
 
+require: rubocop-performance
+
 AllCops:
   Exclude:
     - '*.gemspec'

data/.rubocop_dnsimple.yml

@@ -19,6 +19,10 @@ Bundler/OrderedGems:
 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.
 #
@@ -33,7 +37,15 @@ 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]
@@ -61,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
@@ -105,17 +109,16 @@ Naming/MemoizedInstanceVariableName:
 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/UncommunicativeMethodParamName:
-  Enabled: false
-
-# [codesmell]
-# I don't really get the point of this cop.
-Performance/RedundantMerge:
+Naming/MethodParameterName:
   Enabled: false
 
 # This cop returns false positive violations (as of rubocop 0.57.0)
@@ -138,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
@@ -164,20 +161,26 @@ Style/FormatString:
 Style/FormatStringToken:
   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:
-  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
@@ -188,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
 
@@ -343,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:
@@ -370,9 +371,32 @@ 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

data/.travis.yml

@@ -1,12 +1,10 @@
 language: ruby
 
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
 
 env:
   - COVERALL=1

data/CHANGELOG.md

@@ -3,12 +3,20 @@
 This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 
-### 4.6.0
+## 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
+## 4.5.0
 
 - NEW: Added zone distribution and zone record distribution (GH-160)
 
@@ -19,26 +27,26 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 - 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
+## 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
+## 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)
 
@@ -46,7 +54,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).
@@ -63,7 +71,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).
@@ -77,9 +85,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.
 
@@ -93,13 +101,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
 
@@ -109,15 +117,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**
 
@@ -129,7 +137,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).
 
@@ -141,23 +149,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
 
@@ -167,23 +175,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

data/CONTRIBUTING.md

@@ -24,6 +24,43 @@ bundle
 [Run the test suite](#testing) to check everything works as expected.
 
 
+## Releasing
+
+The following instructions uses `$VERSION` as a placeholder, where `$VERSION` is a `MAJOR.MINOR.BUGFIX` release such as `1.2.0`.
+
+1. Set the version in `version.rb`:
+
+    ```ruby
+    VERSION = "$VERSION"
+    ```
+
+1. Run the test suite and ensure all the tests pass.
+
+1. Finalize the `## master` section in `CHANGELOG.md` assigning the version.
+
+1. Commit and push the changes
+
+    ```shell
+    git commit -a -m "Release $VERSION"
+    git push origin master
+    ```
+
+1. Wait for CI to complete.
+
+1. Create a signed tag.
+
+    ```shell
+    git tag -a v$VERSION -s -m "Release $VERSION"
+    git push origin --tags
+    ```
+
+1. Release to RubyGems.
+
+    ```shell
+    gem push pkg/<filename>
+    ```
+
+
 ## Testing
 
 To run the test suite: