wavefront-sdk 3.3.3 → 3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a664693c583158575cad85b45877d407b0d319e1d6d540b2cc253d3d65907c0c
-  data.tar.gz: f0407b9b17cd69e79a7206c6224e749f3ad60027410d03e997fb5dd60aa1276c
+  metadata.gz: 69e5b7ef712204907db606287f0d84d3c89a2784e9d8edbc53415b2277311081
+  data.tar.gz: e1f7e4c28c8c1d42194cff7c5ce6a5ec55b25dd838883159fba2b8e2a0faa6ee
 SHA512:
-  metadata.gz: ff1bd8a1f5d9a7e57bf04d74ad42e9a168ca285e5eb58e4048089768f88ed44e88814744295bbc63541a27f945d99b246fa063f69f2e0495a1bf8bac9dbf28b9
-  data.tar.gz: f0f18d99096549065b6eaa1b1c410d62d011fdb81f1c07756076c0aaca6b6261621a0cd9403ab76d1e655dcab1ef44bdb9e3edbae23d8bade01ce02868a7ac42
+  metadata.gz: 9c55603c0db5ad279802221f3f7eb945e04f861743fb9599c4bbd97e03d51ca6902956ac9aa35202ef1271a6a0d13ee9d96d8cd26b0f89eb81192d2b65772b33
+  data.tar.gz: 2e922eb985d685075076ad3da8100296ae891fb645f00211b8ddb4a03b05f16708ed3f8a5a45761277cebec2394a3bc00cbf63b76b70291e94e456f10cb442cb

data/.rubocop.yml

@@ -1,22 +1,7 @@
 ---
+
 AllCops:
-  DisplayStyleGuide: true
   TargetRubyVersion: 2.3
 
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/FormatStringToken:
-  Enabled: false
-
 Metrics/ClassLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 13
-
-Style/DoubleNegation:
-  Enabled: false
-
-Style/NumericLiterals:
-  Enabled: false
+  Max: 124

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/HISTORY.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.3.4 (2019-09-18)
+* Upgrade Rubocop dev dependency to 0.74.0, and make codebase compliant with
+  those standards. No interfaces are changed.
+
 ## 3.3.3 (2019-09-10)
 * Fix slightly misleading verbose message when using recursive or
   lazy calls

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yard'
 require 'rake/testtask'
 require 'bundler/gem_tasks'

data/lib/wavefront-sdk/alert.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'defs/constants'
 require_relative 'core/api'
 require_relative 'api_mixins/acl'
@@ -38,6 +40,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
+
       api.post('', body, 'application/json')
     end
 
@@ -120,9 +123,9 @@ module Wavefront
       wf_version?(version) if version
 
       api.post([id, 'clone'].uri_concat,
-               { id:   id,
+               { id: id,
                  name: nil,
-                 v:    version }, 'application/json')
+                 v: version }, 'application/json')
     end
 
     # GET /api/v2/alert/id/history

data/lib/wavefront-sdk/api_mixins/acl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Wavefront
   module Mixin
     #
@@ -79,6 +81,7 @@ module Wavefront
 
       def valid_acl_body?(list)
         return true if list.is_a?(Array) && list.all? { |h| h.is_a?(String) }
+
         raise ArgumentError
       end
     end

data/lib/wavefront-sdk/api_mixins/tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Wavefront
   module Mixin
     #

data/lib/wavefront-sdk/api_mixins/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Wavefront
   module Mixin
     #
@@ -10,6 +12,7 @@ module Wavefront
       #
       def validate_user_list(list)
         raise ArgumentError unless list.is_a?(Array)
+
         list.each { |id| wf_user_id?(id) }
       end
 
@@ -19,6 +22,7 @@ module Wavefront
       #
       def validate_usergroup_list(list)
         raise ArgumentError unless list.is_a?(Array)
+
         list.each { |id| wf_usergroup_id?(id) }
       end
     end

data/lib/wavefront-sdk/apitoken.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'core/api'
 
 module Wavefront

data/lib/wavefront-sdk/cloudintegration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'core/api'
 
 module Wavefront
@@ -26,6 +28,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
+
       api.post('', body, 'application/json')
     end
 
@@ -64,6 +67,7 @@ module Wavefront
     def update(id, body)
       wf_cloudintegration_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
+
       api.put(id, body)
     end
 

data/lib/wavefront-sdk/core/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'logger'
 require_relative 'api_caller'
 require_relative 'exception'
@@ -75,6 +77,7 @@ module Wavefront
     def time_to_ms(time)
       return false unless time.is_a?(Integer)
       return time if time.to_s.size == 13
+
       (time.to_f * 1000).round
     end
 

data/lib/wavefront-sdk/core/api_caller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'faraday'
 require 'addressable'
@@ -45,9 +47,11 @@ module Wavefront
     # @return [URI::HTTPS]
     #
     def mk_conn(path, headers = {}, opts = {})
-      url = format('%s://%s%s', net[:scheme], net[:endpoint],
-                   [net[:api_base], path].uri_concat)
-      set_opts = { url:     Addressable::URI.encode(url),
+      url = format('%<scheme>s://%<endpoint>s%<path>s',
+                   scheme: net[:scheme],
+                   endpoint: net[:endpoint],
+                   path: [net[:api_base], path].uri_concat)
+      set_opts = { url: Addressable::URI.encode(url),
                    headers: net[:headers].merge(headers) }
       Faraday.new(set_opts.merge(opts))
     end
@@ -79,7 +83,7 @@ module Wavefront
                      request: {
                        params_encoder: Faraday::FlatParamsEncoder
                      },
-                     params:  query)
+                     params: query)
 
       make_call(conn, :get)
     end
@@ -149,7 +153,9 @@ module Wavefront
     def verbosity(conn, method, *args)
       return unless noop || verbose
 
-      log format('uri: %s %s', method.upcase, conn.url_prefix)
+      log format('uri: %<method>s %<path>s',
+                 method: method.upcase,
+                 path: conn.url_prefix)
 
       return unless args.last && !args.last.empty?
 
@@ -160,8 +166,8 @@ module Wavefront
 
     def paginator_class(method)
       require_relative File.join('..', 'paginator', method.to_s)
-      Object.const_get(format('Wavefront::Paginator::%s',
-                              method.to_s.capitalize))
+      Object.const_get(format('Wavefront::Paginator::%<method>s',
+                              method: method.to_s.capitalize))
     end
 
     # A dispatcher for making API calls. We now have three methods
@@ -206,8 +212,8 @@ module Wavefront
         creds[:agent] = "wavefront-sdk #{WF_SDK_VERSION}"
       end
 
-      @net = { headers:  headers(creds),
-               scheme:   opts[:scheme] || 'https',
+      @net = { headers: headers(creds),
+               scheme: opts[:scheme] || 'https',
                endpoint: creds[:endpoint],
                api_base: calling_class.api_path }
     end
@@ -230,7 +236,7 @@ module Wavefront
       %w[endpoint token].each do |k|
         unless creds.key?(k.to_sym)
           raise(Wavefront::Exception::CredentialError,
-                format('credentials must contain %s', k))
+                format('credentials must contain %<key>s', key: k))
         end
       end
     end

data/lib/wavefront-sdk/core/exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Wavefront
   #
   # Simple exception classes

data/lib/wavefront-sdk/core/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Wavefront
   #
   # Log to a user-supplied Ruby logger, or to standard output.
@@ -30,19 +32,20 @@ module Wavefront
     end
 
     def print_message(level, msg)
-      method = format('print_%s_message', level).to_sym
+      method = format('print_%<level>s_message', level: level).to_sym
       msg = format_message(level, msg)
 
       if respond_to?(:method)
         send(method, msg)
       else
-        print_warn_message(format('undefined message level:%s', level))
+        print_warn_message(format('undefined message level:%<level>s',
+                                  level: level))
         print_warn_message(msg)
       end
     end
 
     def format_message(level, msg)
-      format('SDK %s: %s', level.to_s.upcase, msg)
+      format('SDK %<level>s: %<msg>s', level: level.to_s.upcase, msg: msg)
     end
 
     def print_debug_message(msg)

data/lib/wavefront-sdk/core/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'map'
 require_relative 'logger'
@@ -40,7 +42,7 @@ module Wavefront
       @response = build_response(raw)
       logger.log(self, :debug)
     rescue StandardError => e
-      logger.log(format("could not parse:\n%s", json), :debug)
+      logger.log(format("could not parse:\n%<str>s", str: json), :debug)
       logger.log(e.message.to_s, :debug)
       raise Wavefront::Exception::UnparseableResponse
     end
@@ -64,8 +66,7 @@ module Wavefront
     # @return [Bool]
     #
     def more_items?
-      return false unless response.key?(:moreItems)
-      !!response.moreItems
+      response.moreItems ? true : false
     rescue StandardError
       false
     end
@@ -78,6 +79,7 @@ module Wavefront
     def next_item
       return nil unless more_items?
       return response.cursor if response.respond_to?(:cursor)
+
       response.offset + response.limit
     rescue StandardError
       nil
@@ -116,6 +118,7 @@ module Wavefront
       return Map.new unless raw.is_a?(Hash)
       return Map.new(raw) unless raw.key?(:response)
       return raw[:response] unless raw[:response].is_a?(Hash)
+
       Map(raw[:response])
     end
 

data/lib/wavefront-sdk/credentials.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'inifile'
 require 'map'
@@ -45,8 +47,8 @@ module Wavefront
     #
     def env_override(raw)
       { endpoint: 'WAVEFRONT_ENDPOINT',
-        token:    'WAVEFRONT_TOKEN',
-        proxy:    'WAVEFRONT_PROXY' }.each { |k, v| raw[k] = ENV[v] if ENV[v] }
+        token: 'WAVEFRONT_TOKEN',
+        proxy: 'WAVEFRONT_PROXY' }.each { |k, v| raw[k] = ENV[v] if ENV[v] }
       raw
     end
 
@@ -88,6 +90,7 @@ module Wavefront
 
       files.each do |f|
         next unless f.exist? && f.file?
+
         ret = load_profile(f, profile)
         ret[:file] = f
       end

data/lib/wavefront-sdk/dashboard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'core/api'
 require_relative 'api_mixins/acl'
 require_relative 'api_mixins/tag'
@@ -34,6 +36,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
+
       api.post('', body, 'application/json')
     end
 

data/lib/wavefront-sdk/defs/constants.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # Constants
 #
-DELTA = "\u2206".freeze # "Increment" -- alt-J on a Mac
+DELTA = "\u2206" # "Increment" -- alt-J on a Mac
 PAGE_SIZE = 999

data/lib/wavefront-sdk/defs/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
-WF_SDK_VERSION = '3.3.3'.freeze
+WF_SDK_VERSION = '3.3.4'
 WF_SDK_LOCATION = Pathname.new(__dir__).parent.parent.parent

data/lib/wavefront-sdk/derivedmetric.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'core/api'
 require_relative 'api_mixins/tag'
 
@@ -28,6 +30,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
+
       api.post('', body, 'application/json')
     end
 

data/lib/wavefront-sdk/distribution.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'write'
 require_relative 'support/mixins'
 
@@ -38,39 +40,57 @@ module Wavefront
     end
 
     def default_port
-      40000
+      40_000
+    end
+
+    def data_format
+      :histogram
     end
 
     # Convert a validated point to a string conforming to
     # https://docs.wavefront.com/proxies_histograms.html. No
     # validation is done here.
     #
-    # @param point [Hash] a hash describing a distribution. See
+    # @param dist [Hash] a hash describing a distribution. See
     #   #write() for the format.
     #
-    # rubocop:disable Metrics/AbcSize
     def hash_to_wf(dist)
       logger.log("writer subclass #{writer}", :debug)
-      raise unless dist.key?(:interval)
-
-      format('!%s %i %s %s source=%s %s %s',
-             dist[:interval].to_s.upcase,
-             parse_time(dist.fetch(:ts, Time.now)),
-             array2dist(dist[:value]),
-             dist[:path] || raise,
-             dist.fetch(:source, HOSTNAME),
-             dist[:tags]&.to_wf_tag,
-             opts[:tags]&.to_wf_tag).squeeze(' ').strip
-    rescue StandardError
+
+      raise unless dist.key?(:interval) && dist.key?(:path)
+
+      format('!%<interval>s %<ts>i %<value>s %<path>s source=%<source>s ' \
+             '%<tags>s %<opttags>s', dist_hash(dist)).squeeze(' ').strip
+    rescue RuntimeError
       raise Wavefront::Exception::InvalidDistribution
     end
-    # rubocop:enable Metrics/AbcSize
+
+    def dist_hash(dist)
+      dist.dup.tap do |d|
+        d[:interval] = distribution_interval(dist)
+        d[:ts] = distribution_timestamp(dist)
+        d[:value] = array2dist(dist[:value])
+        d[:source] ||= HOSTNAME
+        d[:tags] = tags_or_nothing(d[:tags])
+        d[:opttags] = tags_or_nothing(opts[:tags])
+      end
+    end
+
+    def distribution_timestamp(dist)
+      parse_time(dist.fetch(:ts, Time.now))
+    end
+
+    def distribution_interval(dist)
+      dist[:interval].to_s.upcase
+    end
 
     # Turn an array of arrays into a the values part of a distribution
     # @return [String]
     #
     def array2dist(values)
-      values.map { |x, v| format('#%i %s', x, v) }.join(' ')
+      values.map do |x, v|
+        format('#%<count>i %<value>s', count: x, value: v)
+      end.join(' ')
     end
   end
 end