dnsimple 8.7.1 → 8.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cce6708be83ba43b6fdf2a1ce120b7b28fda094be88b6ef343d2abcb99ae1d3
-  data.tar.gz: ea60f222bb97f0f3a6c699aea0ba46bb0cf5be9dec717cbf39b7cc8f2969dea7
+  metadata.gz: 874a1e978f9845bb7a50c9f596fb30b22186730498972ed4c538664939c9e3d6
+  data.tar.gz: 1a1ec6d73ca64499a9e9462529d18f9e8643a619a349310c5e3b4e6f0c3d8050
 SHA512:
-  metadata.gz: 948abbbf7c8a1da2fa915228d1d21edeb11405956e1a281b607c5d1ba54c919bae996e287dc3ef3748c4a81478bdd4e3c408dc47e939f9b4e28396de5ea3a7fb
-  data.tar.gz: 3ad4039b036f5e817ea4fdb15e4c7fc2908ac8935c01dd9130b3fefb6727aa020372f1fdd523a82181c07751415a91a2aee683b78193e754075f9b730ac6391d
+  metadata.gz: d28ef3ce63861291b5b95bb7d373685367c25bb33e3ddf42ee403e8d8c3963d8e0bf377280ca97560ac142855ee4b1d6de74cdad6241a534a3978c5aa6c17085
+  data.tar.gz: a0bef36ed74defb05757c8ed9e21d90198c5fee95530da0c77212f4fa303c5bb6ce4773989d5ed8ac2e8f78068e2d3d92044593fb53d2c14ea7a9f1c1a5fbe49

data/.github/workflows/auto-merge.yml

@@ -16,7 +16,7 @@ jobs:
     if: github.event.pull_request.user.login == 'dependabot[bot]' && contains(github.event.pull_request.labels.*.name, 'automerge')
     steps:
       - name: Wait for tests to succeed
-        uses: lewagon/wait-on-check-action@v1.3.1
+        uses: lewagon/wait-on-check-action@v1.3.3
         timeout-minutes: 15
         with:
           ref: ${{ github.ref }}

data/.github/workflows/ci.yml

@@ -34,6 +34,7 @@ jobs:
           - '3.0'
           - '3.1'
           - '3.2'
+          - '3.3'
           - 'ruby-head'
           - 'truffleruby-head'
     steps:
@@ -44,16 +45,3 @@ jobs:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
       - run: bundle exec rake
-
-  slack-workflow-status:
-    if: always()
-    name: Post Workflow Status To Slack
-    needs:
-      - test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Slack Workflow Notification
-        uses: Gamesight/slack-workflow-status@master
-        with:
-          repo_token: ${{secrets.GITHUB_TOKEN}}
-          slack_webhook_url: ${{secrets.SLACK_WEBHOOK_URL_DEVELOPMENT}}

data/.github/workflows/release.yml

@@ -7,11 +7,11 @@ on:
 jobs:
   publish:
     name: Release to RubyGems
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
       - name: Wait for tests to succeed
-        uses: lewagon/wait-on-check-action@v1.3.1
+        uses: lewagon/wait-on-check-action@v1.3.3
         with:
           ref: 'refs/heads/main'
           running-workflow-name: 'Release to RubyGems'

data/.rubocop_dnsimple.yml

@@ -1,4 +1,3 @@
----
 # Defaults https://github.com/bbatsov/rubocop/blob/master/config/default.yml
 #
 # References:
@@ -25,8 +24,8 @@ Layout/AccessModifierIndentation:
 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.
+# 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.
 #
 #   invoice_error_message = case error
 #                           when 1 == 1
@@ -123,10 +122,9 @@ Naming/RescuedExceptionsVariableName:
 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
+Style/AccessorGrouping:
+  Enabled: true
+  EnforcedStyle: separated
 
 # Do not use "and" or "or" in conditionals, but for readability we can use it
 # to chain executions. Just beware of operator order.
@@ -137,7 +135,7 @@ Style/AndOr:
 Style/BarePercentLiterals:
   EnforcedStyle: percent_q
 
-# braces_for_chaining seems a good fit of what we've been doing so far.
+# Pick one option for consistency.
 Style/BlockDelimiters:
   EnforcedStyle: braces_for_chaining
   AllowedMethods:
@@ -147,11 +145,9 @@ Style/BlockDelimiters:
 Style/EmptyElse:
   EnforcedStyle: empty
 
-# There is no specific preference for empty methods.
-# One-line methods are not exceptionally nice in Ruby.
-# Just ignore this cop for now.
+# Pick one option for consistency.
 Style/EmptyMethod:
-  Enabled: false
+  EnforcedStyle: expanded
 
 # We don't care about the format style.
 # In most cases we use %, but not at the point we want to enforce it
@@ -159,10 +155,8 @@ Style/EmptyMethod:
 Style/FormatString:
   Enabled: false
 
-# 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.
+# 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
 
@@ -174,21 +168,6 @@ Style/HashSyntax:
     # 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
@@ -220,11 +199,6 @@ Style/NumericLiterals:
     - 'spec/**/*_spec.rb'
     - 'test/**/*_test.rb'
 
-# For years, %w() has been the de-facto standard.
-# A lot of libraries are using (). Switching to [] would be a nightmare.
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
 # Enable but only for multiple returns value.
 #
 #   return foo, bar
@@ -236,17 +210,7 @@ Style/PercentLiteralDelimiters:
 Style/RedundantReturn:
   AllowMultipleReturnValues: true
 
-# Do we care?
-Style/RegexpLiteral:
-  Enabled: false
-
-# There are cases were the inline rescue is ok. We can either downgrade
-# the severity, or rely on the developer judgement on a case-by-case basis.
-Style/RescueModifier:
-  Enabled: false
-
-# This is quite annoying, especially in cases where we don't control it
-# (e.g. schema.rb).
+# This is quite annoying, especially in cases where we don't control it (e.g. schema.rb).
 Style/SymbolArray:
   Enabled: false
 
@@ -261,9 +225,8 @@ Style/StringLiterals:
   Enabled: false
   EnforcedStyle: double_quotes
 
-# As before.
+# Pick one option for consistency.
 Style/StringLiteralsInInterpolation:
-  Enabled: false
   EnforcedStyle: double_quotes
 
 # It's nice to be consistent. The trailing comma also allows easy reordering,
@@ -290,20 +253,8 @@ Style/WordArray:
   EnforcedStyle: percent
   MinSize: 3
 
-# Forces the order of comparison arguments.
-#
-# According to this cop, the following statement is bad:
-#
-#   "https" == uri.scheme
-#
-# Whereas the following is considered good:
-#
-#   uri.scheme == "https"
-Style/YodaCondition:
-  Enabled: false
-
-# For the same reason of EndAlignment, aligning with the case may have
-# a bad impact on a case after a very long variable.
+# For the same reason of EndAlignment, aligning with the case may have a bad impact
+# on a case after a very long variable.
 #
 #   invoice_error_message = case error
 #                           when 1 == 1
@@ -325,32 +276,24 @@ 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
-    # to be consistent with EmptyLinesAroundClassBody
-    # and EmptyLinesAroundModuleBody
+    # to be consistent with EmptyLinesAroundClassBody and EmptyLinesAroundModuleBody
     - 'spec/**/*_spec.rb'
     - 'test/**/*_test.rb'
 
-# In most cases, a space is nice. Sometimes, it's not.
-# Just be consistent with the rest of the surrounding code.
+# Pick one option for consistency. beginning+ending is the most used approach.
 Layout/EmptyLinesAroundClassBody:
-  Enabled: false
+  EnforcedStyle: empty_lines_except_namespace
 
 # We're ok with it. We use it quite often for method-level rescue statements.
 Layout/EmptyLinesAroundExceptionHandlingKeywords:
   Enabled: false
 
-# In most cases, a space is nice. Sometimes, it's not.
-# Just be consistent with the rest of the surrounding code.
+# Pick one option for consistency. beginning+ending is the most used approach.
 Layout/EmptyLinesAroundModuleBody:
-  Enabled: false
+  EnforcedStyle: empty_lines_except_namespace
 
 # This is quite buggy, as it doesn't recognize double lines.
 Layout/EmptyLineBetweenDefs:

data/CHANGELOG.md

@@ -4,6 +4,10 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 ## main
 
+## 8.8.0
+
+- NEW: Added `Dnsimple::Client::DnsAnalytics#query` to query and pull data from the DNS Analytics API endpoint(dnsimple/dnsimple-ruby#375)
+
 ## 8.7.1
 
 ENHANCEMENTS:

data/Gemfile

@@ -5,7 +5,10 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
-gem 'rubocop', '1.57.2', require: false
-gem 'rubocop-performance', '1.19.1', require: false
+gem 'rubocop', '1.59.0', require: false
+gem 'rubocop-performance', '1.20.1', require: false
 gem 'rubocop-rake', '0.6.0', require: false
 gem 'rubocop-rspec', '2.25.0', require: false
+gem "base64", "~> 0.2.0"
+gem "bigdecimal", "~> 3.1"
+gem "csv", "~> 3.2"

data/lib/dnsimple/client/billing.rb

@@ -3,6 +3,7 @@
 module Dnsimple
   class Client
     module Billing
+
       # List the billing charges for the account.
       #
       # @see https://developer.dnsimple.com/v2/billing/#listCharges
@@ -30,6 +31,7 @@ module Dnsimple
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Charge.new(r) })
       end
       alias list_charges charges
+
     end
   end
 end

data/lib/dnsimple/client/clients.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dnsimple
+
   class Client
 
     # @return [Dnsimple::Client::AccountsService] The account-related API proxy.
@@ -28,6 +29,11 @@ module Dnsimple
       @services[:domains] ||= Client::DomainsService.new(self)
     end
 
+    # @return [Dnsimple::Client::DnsAnalyticsService] The DNS Analytics API proxy.
+    def dns_analytics
+      @services[:dns_analytics] ||= Client::DnsAnalyticsService.new(self)
+    end
+
     # @return [Dnsimple::Client::IdentityService] The identity-related API proxy.
     def identity
       @services[:auth] ||= Client::IdentityService.new(self)
@@ -117,26 +123,34 @@ module Dnsimple
     require_relative 'accounts'
 
     class AccountsService < ClientService
+
       include Client::Accounts
+
     end
 
     require_relative 'billing'
 
     class BillingService < ClientService
+
       include Client::Billing
+
     end
 
     require_relative 'certificates'
 
     class CertificatesService < ClientService
+
       include Client::Certificates
+
     end
 
 
     require_relative 'contacts'
 
     class ContactsService < ClientService
+
       include Client::Contacts
+
     end
 
 
@@ -148,26 +162,40 @@ module Dnsimple
     require_relative 'domains_collaborators'
 
     class DomainsService < ClientService
+
       include Client::Domains
       include Client::DomainsDelegationSignerRecords
       include Client::DomainsDnssec
       include Client::DomainsEmailForwards
       include Client::DomainsPushes
       include Client::DomainsCollaborators
+
+    end
+
+    require_relative 'dns_analytics'
+
+    class DnsAnalyticsService < ClientService
+
+      include Client::DnsAnalytics
+
     end
 
 
     require_relative 'identity'
 
     class IdentityService < ClientService
+
       include Client::Identity
+
     end
 
 
     require_relative 'oauth'
 
     class OauthService < ClientService
+
       include Client::Oauth
+
     end
 
     require_relative 'registrar'
@@ -178,12 +206,14 @@ module Dnsimple
     require_relative 'registrar_delegation'
 
     class RegistrarService < ClientService
+
       include Client::Registrar
       include Client::RegistrarAutoRenewal
       include Client::RegistrarDelegation
       include Client::RegistrarRegistrantChanges
       include Client::RegistrarTransferLock
       include Client::RegistrarWhoisPrivacy
+
     end
 
 
@@ -191,8 +221,10 @@ module Dnsimple
     require_relative 'services_domains'
 
     class ServicesService < ClientService
+
       include Client::Services
       include Client::ServicesDomains
+
     end
 
 
@@ -201,23 +233,29 @@ module Dnsimple
     require_relative 'templates_records'
 
     class TemplatesService < ClientService
+
       include Client::Templates
       include Client::TemplatesDomains
       include Client::TemplatesRecords
+
     end
 
 
     require_relative 'tlds'
 
     class TldsService < ClientService
+
       include Client::Tlds
+
     end
 
 
     require_relative 'vanity_name_servers'
 
     class VanityNameServersService < ClientService
+
       include Client::VanityNameServers
+
     end
 
 
@@ -226,16 +264,20 @@ module Dnsimple
     require_relative 'zones_distributions'
 
     class ZonesService < ClientService
+
       include Client::Zones
       include Client::ZonesRecords
       include Client::ZonesDistributions
+
     end
 
 
     require_relative 'webhooks'
 
     class WebhooksService < ClientService
+
       include Client::Webhooks
+
     end
 
   end
@@ -246,6 +288,9 @@ module Dnsimple
   # these static methods return directly the underlying data objects.
   # Therefore, it's not possible to access response metadata such as throttling or pagination info.
   module V2
+
     extend Client::Identity::StaticHelpers
+
   end
+
 end

data/lib/dnsimple/client/dns_analytics.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  class Client
+    module DnsAnalytics
+
+      # Queries DNS Analytics data for the provided account
+      #
+      # @see https://developer.dnsimple.com/v2/dns-analytics#query
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [Hash] options the filtering, sorting, and grouping 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
+      # @option options [Hash] :filter filtering policy
+      # @option options [String] :groupings groupings policy
+      # @return [Dnsimple::PaginatedResponseWithQuery<Dnsimple::Struct::DnsAnalytics>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def query(account_id, options = {})
+        list_options = Options::ListOptions.new(options)
+        response = client.get(Client.versioned("/%s/dns_analytics" % [account_id]), list_options)
+
+        Dnsimple::PaginatedResponseWithQuery.new(response, response["data"]["rows"].map { |row| Struct::DnsAnalytics.new(response["data"]["headers"].zip(row)) })
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/domains.rb

@@ -128,6 +128,7 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
+
     end
   end
 end

data/lib/dnsimple/client/domains_dnssec.rb

@@ -54,6 +54,7 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Dnssec.new(response["data"]))
       end
+
     end
   end
 end

data/lib/dnsimple/client/domains_pushes.rb

@@ -94,6 +94,5 @@ module Dnsimple
       end
 
     end
-
   end
 end

data/lib/dnsimple/client/identity.rb

@@ -19,6 +19,7 @@ module Dnsimple
 
 
       module StaticHelpers
+
         # Calls {Identity#whoami} and directly returns the response data.
         #
         # @see https://developer.dnsimple.com/v2/identity/#whoami
@@ -30,6 +31,7 @@ module Dnsimple
         def whoami(client, *args)
           client.identity.whoami(*args).data
         end
+
       end
 
     end

data/lib/dnsimple/client/registrar.rb

@@ -217,6 +217,7 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
+
     end
   end
 end

data/lib/dnsimple/client/registrar_registrant_changes.rb

@@ -104,6 +104,7 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
+
     end
   end
 end

data/lib/dnsimple/client/services.rb

@@ -75,6 +75,7 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Service.new(response["data"]))
       end
+
     end
   end
 end

data/lib/dnsimple/client/templates_records.rb

@@ -132,6 +132,7 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
+
     end
   end
 end

data/lib/dnsimple/client/tlds.rb

@@ -3,6 +3,7 @@
 module Dnsimple
   class Client
     module Tlds
+
       # Lists the TLDs available for registration
       #
       # @see https://developer.dnsimple.com/v2/tlds/#listTlds
@@ -91,6 +92,7 @@ module Dnsimple
 
         Dnsimple::CollectionResponse.new(response, response["data"].map { |r| Struct::ExtendedAttribute.new(r) })
       end
+
     end
   end
 end

data/lib/dnsimple/client.rb

@@ -7,7 +7,6 @@ require 'dnsimple/response'
 require 'dnsimple/client/clients'
 
 module Dnsimple
-
   # Client for the DNSimple API
   #
   # @see https://developer.dnsimple.com/

data/lib/dnsimple/default.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Dnsimple
-
   # Default configuration options for {Client}
   module Default
 
@@ -76,6 +75,6 @@ module Dnsimple
       end
 
     end
-  end
 
+  end
 end

data/lib/dnsimple/error.rb

@@ -7,7 +7,9 @@ module Dnsimple
 
   # 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, :attribute_errors
+
+    attr_reader :http_response
+    attr_reader :attribute_errors
 
     def initialize(http_response)
       @http_response = http_response
@@ -49,7 +51,10 @@ module Dnsimple
   end
 
   class OAuthInvalidRequestError < Error
-    attr_reader :http_response, :error, :error_description
+
+    attr_reader :http_response
+    attr_reader :error
+    attr_reader :error_description
 
     def initialize(http_response)
       @http_response = http_response
@@ -63,6 +68,7 @@ module Dnsimple
     def message
       "#{error}: #{error_description}"
     end
+
   end
 
 end