dnsimple 11.1.0 → 12.0.0

data/lib/dnsimple/client/webhooks.rb

@@ -3,7 +3,6 @@
 module Dnsimple
   class Client
     module Webhooks
-
       # Lists ALL the webhooks in the account.
       #
       # @see https://developer.dnsimple.com/v2/webhooks/#list
@@ -17,8 +16,8 @@ module Dnsimple
       # @example List all webhooks, provide sorting policy
       #   client.webhooks.list(1010, sort: "id:asc")
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [Hash] options the filtering and sorting options
+      # @param  account_id [Integer] the account ID
+      # @param  options [Hash] 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
@@ -36,9 +35,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/webhooks/#create
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [Hash] attributes
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  attributes [Hash]
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::Webhook>]
       #
       # @raise  [Dnsimple::RequestError]
@@ -53,9 +52,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/webhooks/#get
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] webhook_id The webhook ID
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  webhook_id [#to_s] The webhook ID
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::Webhook>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -72,9 +71,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/webooks/#delete
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] webhook_id The webhook ID
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  webhook_id [#to_s] The webhook ID
+      # @param  options [Hash]
       # @return [Dnsimple::Response<nil>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -84,7 +83,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
-
     end
   end
 end

data/lib/dnsimple/client/zones.rb

@@ -3,7 +3,6 @@
 module Dnsimple
   class Client
     module Zones
-
       # Lists the zones in the account.
       #
       # @see https://developer.dnsimple.com/v2/zones/#list
@@ -21,8 +20,8 @@ module Dnsimple
       # @example List zones, provide filtering policy
       #   client.zones.list(1010, "example.com", filter: { name_like: "example" })
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [Hash] options the filtering and sorting options
+      # @param  account_id [Integer] the account ID
+      # @param  options [Hash] 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
@@ -48,8 +47,8 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/zones/#list
       # @see #zones
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [Hash] options the filtering and sorting options
+      # @param  account_id [Integer] the account ID
+      # @param  options [Hash] 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
@@ -65,9 +64,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/zones/#get
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] zone_id the zone name
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  zone_id [#to_s] the zone name
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::Zone>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -82,9 +81,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/zones/#get-file
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] zone_name the zone name
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  zone_name [#to_s] the zone name
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::ZoneFile>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -99,9 +98,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/zones/#activateZoneService
       #
-      # @param  [#to_s] account_id the account ID
-      # @param  [#to_s] zone_id the zone name
-      # @param  [Hash] options
+      # @param  account_id [#to_s] the account ID
+      # @param  zone_id [#to_s] the zone name
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::Zone>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -116,9 +115,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/zones/#deactivateZoneService
       #
-      # @param  [#to_s] account_id the account ID
-      # @param  [#to_s] zone_id the zone name
-      # @param  [Hash] options
+      # @param  account_id [#to_s] the account ID
+      # @param  zone_id [#to_s] the zone name
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::Zone>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -128,7 +127,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Zone.new(response["data"]))
       end
-
     end
   end
 end

data/lib/dnsimple/client/zones_distributions.rb

@@ -3,7 +3,6 @@
 module Dnsimple
   class Client
     module ZonesDistributions
-
       # Checks if a zone change is fully distributed to all DNSimple name
       # servers across the globe.
       #
@@ -30,10 +29,10 @@ module Dnsimple
       # @example Get record 123 in zone "example.com"
       #   client.zones.zone_record_distribution(1010, "example.com", 123)
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [String] zone_id the zone name
-      # @param  [Integer] record_id the record ID
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  zone_id [String] the zone name
+      # @param  record_id [Integer] the record ID
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::ZoneDistribution>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -43,7 +42,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::ZoneDistribution.new(response["data"]))
       end
-
     end
   end
 end

data/lib/dnsimple/client/zones_records.rb

@@ -3,7 +3,6 @@
 module Dnsimple
   class Client
     module ZonesRecords
-
       # Lists the zone records in the account.
       #
       # @see https://developer.dnsimple.com/v2/zones/records/#listZoneRecords
@@ -21,9 +20,9 @@ module Dnsimple
       # @example List records for the zone "example.com", filtering by 'A' record type
       #   client.zones.list_zone_records(1010, "example.com", filter: { type: 'A' })
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [String] zone_id the zone name
-      # @param  [Hash] options the filtering and sorting options
+      # @param  account_id [Integer] the account ID
+      # @param  zone_id [String] the zone name
+      # @param  options [Hash] 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
@@ -41,21 +40,21 @@ module Dnsimple
 
       # Lists ALL the zone records in the account.
       #
-      # This method is similar to {#records}, but instead of returning the results of a specific page
+      # This method is similar to {#zone_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/zones/records/#listZoneRecords
-      # @see #records
+      # @see #zone_records
       #
       # @example List all records for the zone "example.com"
       #   client.zones.all_zone_records(1010, "example.com")
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [String] zone_id the zone name
-      # @param  [Hash] options the filtering and sorting options
+      # @param  account_id [Integer] the account ID
+      # @param  zone_id [String] the zone name
+      # @param  options [Hash] 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
@@ -75,10 +74,10 @@ module Dnsimple
       # @example Create a URL record in zone "example.com"
       #   client.zones.create_zone_record(1010, "example.com", name: "www", type: "url", content: "example.com")
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [String] zone_id the zone name
-      # @param  [Hash] attributes
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  zone_id [String] the zone name
+      # @param  attributes [Hash]
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::ZoneRecord>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -97,10 +96,10 @@ module Dnsimple
       # @example Get record 123 in zone "example.com"
       #   client.zones.zone_record(1010, "example.com", 123)
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [String] zone_id the zone name
-      # @param  [Integer] record_id the record ID
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  zone_id [String] the zone name
+      # @param  record_id [Integer] the record ID
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::ZoneRecord>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -118,11 +117,11 @@ module Dnsimple
       # @example Update the TTL to 600 of record 123 in zone "example.com"
       #   client.zones.update_zone_record(1010, "example.com", 123, ttl: 600)
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [String] zone_id the zone name
-      # @param  [Integer] record_id the record ID
-      # @param  [Hash] attributes
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  zone_id [String] the zone name
+      # @param  record_id [Integer] the record ID
+      # @param  attributes [Hash]
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::ZoneRecord>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -142,10 +141,10 @@ module Dnsimple
       # @example Delete record 123 in zone "example.com"
       #   client.zones.delete_zone_record(1010, "example.com", 123)
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [String] zone_id the zone name
-      # @param  [Integer] record_id the record ID
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  zone_id [String] the zone name
+      # @param  record_id [Integer] the record ID
+      # @param  options [Hash]
       # @return [Dnsimple::Response<nil>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -163,13 +162,13 @@ module Dnsimple
       # @example Create 2 A records in zone "example.com", update 1 record and delete 1 record.
       #   client.zones.batch_change_zone_records(1010, "example.com", { creates: [{ type: "A", content: "1.2.3.4", name: "ab" }, { type: "A", content: "2.3.4.5", name: "ab" }], updates: [{ id: 67622534, content: "3.2.3.40", name: "www" } }, deletes: [{ id: 67622509 })
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [String] zone_id the zone name
+      # @param  account_id [Integer] the account ID
+      # @param  zone_id [String] the zone name
       # @param  attributes [Hash] Specifies the record creations and/or updates and/or deletions that should be performed as an atomic batch operation in the zone
       # @option attributes [Array<Hash>] :creates (optional)
       # @option attributes [Array<Hash>] :updates (optional)
       # @option attributes [Array<Hash>] :deletes (optional)
-      # @param  [Hash] options
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::ZoneRecordsBatchChange>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -186,9 +185,8 @@ module Dnsimple
           deletes_data = response["data"]["deletes"] || []
           deletes = deletes_data.map { |r| Struct::ZoneRecordId.new(r) }
         end
-        Dnsimple::Response.new(response, Struct::ZoneRecordsBatchChange.new({ creates: creates, updates: updates, deletes: deletes }))
+        Dnsimple::Response.new(response, Struct::ZoneRecordsBatchChange.new({ creates:, updates:, deletes: }))
       end
-
     end
   end
 end

data/lib/dnsimple/client.rb

@@ -23,7 +23,6 @@ module Dnsimple
   #
   #   client = Dnsimple::Client.new(base_url: "https://api.sandbox.dnsimple.com", access_token: "abc")
   class Client
-
     HEADER_AUTHORIZATION = "Authorization"
 
     # @return [String] The current API version.
@@ -103,8 +102,8 @@ module Dnsimple
 
     # Make a HTTP GET request.
     #
-    # @param  [String] path The path, relative to {#base_url}
-    # @param  [Hash] options The query and header params for the request
+    # @param  path [String] The path, relative to {#base_url}
+    # @param  options [Hash] The query and header params for the request
     # @return [HTTParty::Response]
     def get(path, options = {})
       execute :get, path, nil, options.to_h
@@ -112,9 +111,9 @@ module Dnsimple
 
     # Make a HTTP POST request.
     #
-    # @param  [String] path The path, relative to {#base_url}
-    # @param  [Hash] data The body for the request
-    # @param  [Hash] options The query and header params for the request
+    # @param  path [String] The path, relative to {#base_url}
+    # @param  data [Hash] The body for the request
+    # @param  options [Hash] The query and header params for the request
     # @return [HTTParty::Response]
     def post(path, data = nil, options = {})
       execute :post, path, data, options
@@ -122,9 +121,9 @@ module Dnsimple
 
     # Make a HTTP PUT request.
     #
-    # @param  [String] path The path, relative to {#base_url}
-    # @param  [Hash] data The body for the request
-    # @param  [Hash] options The query and header params for the request
+    # @param  path [String] The path, relative to {#base_url}
+    # @param  data [Hash] The body for the request
+    # @param  options [Hash] The query and header params for the request
     # @return [HTTParty::Response]
     def put(path, data = nil, options = {})
       execute :put, path, data, options
@@ -132,9 +131,9 @@ module Dnsimple
 
     # Make a HTTP PATCH request.
     #
-    # @param  [String] path The path, relative to {#base_url}
-    # @param  [Hash] data The body for the request
-    # @param  [Hash] options The query and header params for the request
+    # @param  path [String] The path, relative to {#base_url}
+    # @param  data [Hash] The body for the request
+    # @param  options [Hash] The query and header params for the request
     # @return [HTTParty::Response]
     def patch(path, data = nil, options = {})
       execute :patch, path, data, options
@@ -142,8 +141,8 @@ module Dnsimple
 
     # Make a HTTP DELETE request.
     #
-    # @param  [String] path The path, relative to {#base_url}
-    # @param  [Hash] options The query and header params for the request
+    # @param  path [String] The path, relative to {#base_url}
+    # @param  options [Hash] The query and header params for the request
     # @return [HTTParty::Response]
     def delete(path, data = nil, options = {})
       execute :delete, path, data, options
@@ -151,10 +150,10 @@ module Dnsimple
 
     # Executes a request, validates and returns the response.
     #
-    # @param  [String] method The HTTP method
-    # @param  [String] path The path, relative to {#base_url}
-    # @param  [Hash] data The body for the request
-    # @param  [Hash] options The query and header params for the request
+    # @param  method [String] The HTTP method
+    # @param  path [String] The path, relative to {#base_url}
+    # @param  data [Hash] The body for the request
+    # @param  options [Hash] The query and header params for the request
     # @return [HTTParty::Response]
     # @raise  [RequestError]
     # @raise  [NotFoundError]
@@ -183,10 +182,10 @@ module Dnsimple
     #
     # Therefore, it's up to the caller to properly handle and validate the response.
     #
-    # @param  [String] method The HTTP method
-    # @param  [String] path The path, relative to {#base_url}
-    # @param  [Hash] data The body for the request
-    # @param  [Hash] options The query and header params for the request
+    # @param  method [String] The HTTP method
+    # @param  path [String] The path, relative to {#base_url}
+    # @param  data [Hash] The body for the request
+    # @param  options [Hash] The query and header params for the request
     # @return [HTTParty::Response]
     def request(method, path, data = nil, options = {})
       request_options = request_options(options)
@@ -230,7 +229,7 @@ module Dnsimple
 
     def add_auth_options!(options)
       if password
-        options[:basic_auth] = { username: username, password: password }
+        options[:basic_auth] = { username:, password: }
       elsif access_token
         options[:headers][HEADER_AUTHORIZATION] = "Bearer #{access_token}"
       end
@@ -262,6 +261,5 @@ module Dnsimple
     def content_data(headers, data)
       headers["Content-Type"] == "application/json" ? JSON.dump(data) : data
     end
-
   end
 end

data/lib/dnsimple/default.rb

@@ -3,7 +3,6 @@
 module Dnsimple
   # Default configuration options for {Client}
   module Default
-
     # Default API endpoint
     BASE_URL = "https://api.dnsimple.com/"
 
@@ -11,7 +10,6 @@ module Dnsimple
     USER_AGENT = "dnsimple-ruby/#{VERSION}".freeze
 
     class << self
-
       # List of configurable keys for {Client}
       # @return [Array] of option keys
       def keys
@@ -73,8 +71,6 @@ module Dnsimple
       def proxy
         ENV.fetch("DNSIMPLE_PROXY", nil)
       end
-
     end
-
   end
 end

data/lib/dnsimple/error.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 module Dnsimple
-
   class Error < StandardError
   end
 
   # RequestError is raised when an API request fails for an client, a server error or invalid request information.
   class RequestError < Error
-
     attr_reader :http_response
     attr_reader :attribute_errors
 
@@ -38,7 +36,6 @@ module Dnsimple
       content_type = http_response.headers["Content-Type"]
       content_type&.start_with?("application/json")
     end
-
   end
 
   class NotFoundError < RequestError
@@ -51,7 +48,6 @@ module Dnsimple
   end
 
   class OAuthInvalidRequestError < Error
-
     attr_reader :http_response
     attr_reader :error
     attr_reader :error_description
@@ -68,7 +64,5 @@ module Dnsimple
     def message
       "#{error}: #{error_description}"
     end
-
   end
-
 end

data/lib/dnsimple/extra.rb

@@ -2,7 +2,6 @@
 
 module Dnsimple
   module Extra
-
     # Joins two pieces of URI with a /.
     #
     # @return [String] The joined string.
@@ -24,8 +23,8 @@ module Dnsimple
     #   h2 = { b: 250, c: { c1: 200 } }
     #   Extra.deep_merge(h1, h2) { |key, this_val, other_val| this_val + other_val }
     #   # => { a: 100, b: 450, c: { c1: 300 } }
-    def self.deep_merge(this, other, &block)
-      deep_merge!(this.dup, other, &block)
+    def self.deep_merge(this, other, &)
+      deep_merge!(this.dup, other, &)
     end
 
     # Same as +deep_merge+, but modifies +this+ instead of returning a new hash.
@@ -49,8 +48,8 @@ module Dnsimple
 
     # Validates the presence of mandatory attributes.
     #
-    # @param  [Hash] attributes
-    # @param  [Array<Symbol>] required
+    # @param  attributes [Hash]
+    # @param  required [Array<Symbol>]
     # @return [void]
     # @raise  [ArgumentError]
     def self.validate_mandatory_attributes(attributes, required)
@@ -58,6 +57,5 @@ module Dnsimple
         attributes&.key?(name) or raise(ArgumentError, ":#{name} is required")
       end
     end
-
   end
 end

data/lib/dnsimple/options.rb

@@ -2,9 +2,7 @@
 
 module Dnsimple
   module Options
-
     class Base
-
       def initialize(options)
         @options = (options || {}).dup
       end
@@ -12,11 +10,9 @@ module Dnsimple
       def to_h
         @options
       end
-
     end
 
     class ListOptions < Base
-
       def initialize(options)
         super
         _prepare_query
@@ -52,14 +48,12 @@ module Dnsimple
 
       def _prepare_groupings
         groupings = @options.delete(:groupings)
-        _merge({ groupings: groupings }) unless groupings.nil?
+        _merge({ groupings: }) unless groupings.nil?
       end
 
       def _merge(hash)
         @options[:query].merge!(hash)
       end
-
     end
-
   end
 end

data/lib/dnsimple/response.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
 module Dnsimple
-
   # The Response represents a response returned by a client request.
   #
   # It wraps the content of the response data, as well other response metadata such as rate-limiting information.
   class Response
-
     # @return [HTTParty::Response]
     attr_reader :http_response
 
@@ -26,8 +24,8 @@ module Dnsimple
     attr_reader :rate_limit_reset
 
 
-    # @param  [HTTParty::Response] http_response the HTTP response
-    # @param  [Object] data the response data
+    # @param  http_response [HTTParty::Response] the HTTP response
+    # @param  data [Object] the response data
     def initialize(http_response, data)
       @http_response = http_response
       @data = data
@@ -36,17 +34,14 @@ module Dnsimple
       @rate_limit_remaining = http_response.headers["X-RateLimit-Remaining"].to_i
       @rate_limit_reset = Time.at(http_response.headers["X-RateLimit-Reset"].to_i)
     end
-
   end
 
   # The CollectionResponse is a specific type of Response where the data is a collection of enumerable objects.
   class CollectionResponse < Response
-
   end
 
   # The PaginatedResponse is a specific type of Response that also exposes pagination metadata.
   class PaginatedResponse < CollectionResponse
-
     # @return [Integer] The current page.
     attr_reader :page
 
@@ -63,8 +58,8 @@ module Dnsimple
     # Initializes a new paginated response from the response metadata,
     # and with given collection.
     #
-    # @param  [Hash] http_response the HTTP response
-    # @param  [Array] collection the enumerable collection of records returned in the response data
+    # @param  http_response [Hash] the HTTP response
+    # @param  collection [Array] the enumerable collection of records returned in the response data
     def initialize(http_response, collection)
       super
 
@@ -74,11 +69,9 @@ module Dnsimple
       @total_entries = pagination["total_entries"]
       @total_pages = pagination["total_pages"]
     end
-
   end
 
   class PaginatedResponseWithQuery < PaginatedResponse
-
     # @return [Hash] A hash containing the query parameters that produced the results in this response
     attr_reader :query
 
@@ -86,7 +79,5 @@ module Dnsimple
       super
       @query = http_response["query"]
     end
-
   end
-
 end

data/lib/dnsimple/struct/account.rb

@@ -3,7 +3,6 @@
 module Dnsimple
   module Struct
     class Account < Base
-
       # @return [Integer] The account ID in DNSimple.
       attr_accessor :id
 
@@ -12,7 +11,6 @@ module Dnsimple
 
       # @return [String] The identifier of the plan the account is subscribed to.
       attr_accessor :plan_identifier
-
     end
   end
 end

data/lib/dnsimple/struct/certificate.rb

@@ -3,7 +3,6 @@
 module Dnsimple
   module Struct
     class Certificate < Base
-
       # @return [Integer] The certificate ID in DNSimple.
       attr_accessor :id
 
@@ -42,7 +41,6 @@ module Dnsimple
 
       # @return [String] The timestamp when the certificate will expire.
       attr_accessor :expires_at
-
     end
   end
 end