wavefront-sdk 1.3.0 → 1.3.1

data/Gemfile

@@ -1,2 +1,2 @@
-source 'https://rubygems.org'                                                                                                  
+source 'https://rubygems.org'
 gemspec

data/Rakefile

@@ -2,7 +2,7 @@ require 'yard'
 require 'rake/testtask'
 require 'rubocop/rake_task'
 
-task default: :test
+task default: %i[rubocop test]
 
 Rake::TestTask.new do |t|
   t.pattern = 'spec/wavefront-sdk/*_spec.rb'

data/lib/wavefront-sdk/alert.rb

@@ -7,8 +7,8 @@ module Wavefront
   #
   class Alert < Base
     def update_keys
-      %i(id name target condition displayExpression minutes
-         resolveAfterMinutes severity additionalInformation)
+      %i[id name target condition displayExpression minutes
+         resolveAfterMinutes severity additionalInformation]
     end
 
     # GET /api/v2/alert
@@ -19,7 +19,7 @@ module Wavefront
     # @return [Hash]
     #
     def list(offset = 0, limit = 100)
-      api_get('', { offset: offset, limit: limit })
+      api_get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/alert

data/lib/wavefront-sdk/base.rb

@@ -18,6 +18,7 @@ module Wavefront
   #
   # @return a Wavefront::Response object
   #
+  # rubocop:disable Metrics/ClassLength
   class Base
     include Wavefront::Validators
     include Wavefront::Mixins
@@ -60,10 +61,10 @@ module Wavefront
     # @param t [Integer] epoch timestamp
     # @return [Ingeter] epoch millisecond timestamp
     #
-    def time_to_ms(t)
-      return false unless t.is_a?(Integer)
-      return t if t.to_s.size == 13
-      (t.to_f * 1000).round
+    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
 
     # Derive the first part of the API path from the class name. You
@@ -119,8 +120,8 @@ module Wavefront
     #
     def api_post(path, body = nil, ctype = 'text/plain')
       body = body.to_json unless body.is_a?(String)
-      make_call(mk_conn(path, { 'Content-Type': ctype,
-                                       'Accept': 'application/json'}),
+      make_call(mk_conn(path,  'Content-Type': ctype,
+                               'Accept': 'application/json'),
                 :post, nil, body)
     end
 
@@ -136,8 +137,8 @@ module Wavefront
     # @return [Hash] API response
     #
     def api_put(path, body = nil, ctype = 'application/json')
-      make_call(mk_conn(path, { 'Content-Type': ctype,
-                                      'Accept': 'application/json' }),
+      make_call(mk_conn(path,  'Content-Type': ctype,
+                               'Accept': 'application/json'),
                 :put, nil, body.to_json)
     end
 
@@ -191,8 +192,8 @@ module Wavefront
     # Print it unless it's a debug and we're not in debug
     #
     def print_message(msg, level)
-      return if level == :debug && ! opts[:debug]
-      return if level == :info && ! opts[:verbose]
+      return if level == :debug && !opts[:debug]
+      return if level == :info && !opts[:verbose]
       puts msg
     end
 
@@ -201,9 +202,11 @@ module Wavefront
     # 'User'), a class can provide a {#response_shim} method.
     #
     def respond(resp)
-      body = respond_to?(:response_shim) ? response_shim(resp.body,
-                                                         resp.status) :
-                                           resp.body
+      body = if respond_to?(:response_shim)
+               response_shim(resp.body, resp.status)
+             else
+               resp.body
+             end
 
       Wavefront::Response.new(body, resp.status, debug)
     end
@@ -217,7 +220,7 @@ module Wavefront
         limit = 100
 
         loop do
-          resp = api_get('', { offset: offset, limit: limit }).response
+          resp = api_get('', offset: offset, limit: limit).response
           resp.items.map { |i| y.<< i }
           offset += limit
           raise StopIteration unless resp.moreItems == true
@@ -233,10 +236,9 @@ module Wavefront
     def verbosity(conn, method, *args)
       log "uri: #{method.upcase} #{conn.url_prefix}"
 
-      if args.last && ! args.last.empty?
-        puts log method == :get ? "params: #{args.last}" :
-                                  "body: #{args.last}"
-      end
+      return unless args.last && !args.last.empty?
+
+      puts log method == :get ? "params: #{args.last}" : "body: #{args.last}"
     end
 
     # Make the API call, or not, if noop is set.
@@ -256,7 +258,7 @@ module Wavefront
     end
 
     def setup_endpoint(creds)
-      %w(endpoint token).each do |k|
+      %w[endpoint token].each do |k|
         raise "creds must contain #{k}" unless creds.key?(k.to_sym)
       end
 
@@ -264,12 +266,10 @@ module Wavefront
         creds[:agent] = "wavefront-sdk #{WF_SDK_VERSION}"
       end
 
-      @net = {
-        headers:  { 'Authorization': "Bearer #{creds[:token]}",
-                    'user-agent':    creds[:agent] },
-        endpoint: creds[:endpoint],
-        api_base: ['', 'api', 'v2', api_base].uri_concat
-      }
+      @net = { headers:  { 'Authorization': "Bearer #{creds[:token]}",
+                           'user-agent':    creds[:agent] },
+               endpoint: creds[:endpoint],
+               api_base: ['', 'api', 'v2', api_base].uri_concat }
     end
   end
 end

data/lib/wavefront-sdk/cloudintegration.rb

@@ -6,7 +6,6 @@ module Wavefront
   # a UUID.
   #
   class CloudIntegration < Base
-
     # GET /api/v2/cloudintegration
     # Get all cloud integrations for a customer
     #
@@ -15,7 +14,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def list(offset = 0, limit = 100)
-      api_get('', { offset: offset, limit: limit })
+      api_get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/cloudintegration

data/lib/wavefront-sdk/constants.rb

@@ -1,3 +1,3 @@
 # Constants
 #
-DELTA = "\u2206" # "Increment" -- alt-J on a Mac
+DELTA = "\u2206".freeze # "Increment" -- alt-J on a Mac

data/lib/wavefront-sdk/credentials.rb

@@ -3,7 +3,6 @@ require 'inifile'
 require 'map'
 
 module Wavefront
-
   # Helper methods to get Wavefront credentials.
   #
   # @return [Wavefront::Credentials]
@@ -45,8 +44,7 @@ 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] }
+        proxy:    'WAVEFRONT_PROXY' }.each { |k, v| raw[k] = ENV[v] if ENV[v] }
       raw
     end
 
@@ -59,8 +57,8 @@ module Wavefront
     #
     def populate(raw)
       @config = Map(raw)
-      @creds = Map(raw.select { |k, _v| [:endpoint, :token].include?(k) })
-      @proxy = Map(raw.select { |k, _v| [:proxy, :port].include?(k) })
+      @creds = Map(raw.select { |k, _v| %i[endpoint token].include?(k) })
+      @proxy = Map(raw.select { |k, _v| %i[proxy port].include?(k) })
     end
 
     # @return [Array] a list of possible credential files
@@ -70,7 +68,7 @@ module Wavefront
         Array(Pathname.new(opts[:file]))
       else
         [Pathname.new('/etc/wavefront/credentials'),
-          Pathname.new(ENV['HOME']) + '.wavefront']
+         Pathname.new(ENV['HOME']) + '.wavefront']
       end
     end
 

data/lib/wavefront-sdk/dashboard.rb

@@ -6,7 +6,7 @@ module Wavefront
   #
   class Dashboard < Base
     def update_keys
-      %i(id name url description sections)
+      %i[id name url description sections]
     end
 
     # GET /api/v2/dashboard
@@ -17,7 +17,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def list(offset = 0, limit = 100)
-      api_get('', { offset: offset, limit: limit })
+      api_get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/dashboard
@@ -83,7 +83,6 @@ module Wavefront
               'application/json')
     end
 
-
     # GET /api/v2/dashboard/id/history
     # Get the version history of an dashboard.
     #

data/lib/wavefront-sdk/event.rb

@@ -7,7 +7,7 @@ module Wavefront
   #
   class Event < Base
     def update_keys
-      %i(startTime endTime name annotations)
+      %i[startTime endTime name annotations]
     end
 
     # GET /api/v2/event
@@ -34,8 +34,7 @@ module Wavefront
 
       api_get('', { earliestStartTimeEpochMillis: from,
                     latestStartTimeEpochMillis: to,
-                    cursor: cursor,
-                    limit: limit }.select { |_k, v| v })
+                    cursor: cursor, limit: limit }.select { |_k, v| v })
     end
 
     # POST /api/v2/event

data/lib/wavefront-sdk/exception.rb

@@ -3,41 +3,41 @@ module Wavefront
   # Simple exception classes
   #
   class Exception
-    class EmptyMetricName < ::Exception; end
-    class InvalidAlertId < ::Exception; end
-    class InvalidAlertSeverity < ::Exception; end
-    class InvalidCloudIntegrationId < ::Exception; end
-    class InvalidDashboardId < ::Exception; end
-    class InvalidEndpoint < ::Exception; end
-    class InvalidEventId < ::Exception; end
-    class InvalidExternalLinkId < ::Exception; end
-    class InvalidGranularity < ::Exception; end
-    class InvalidHostname < ::Exception; end
-    class InvalidIntegrationId < ::Exception; end
-    class InvalidRelativeTime < ::Exception; end
-    class InvalidTimeUnit < ::Exception; end
-    class InvalidMaintenanceWindowId < ::Exception; end
-    class InvalidMessageId < ::Exception; end
-    class InvalidMetricName < ::Exception; end
-    class InvalidMetricValue < ::Exception; end
-    class InvalidNotificantId < ::Exception; end
-    class InvalidName < ::Exception; end
-    class InvalidPoint < ::Exception; end
-    class InvalidPrefixLength < ::Exception; end
-    class InvalidProxyId < ::Exception; end
-    class InvalidSavedSearchId < ::Exception; end
-    class InvalidSavedSearchEntity < ::Exception; end
-    class InvalidSourceId < ::Exception; end
-    class InvalidString < ::Exception; end
-    class InvalidTag < ::Exception; end
-    class InvalidLinkTemplate < ::Exception; end
-    class InvalidTimeFormat < ::Exception; end
-    class InvalidTimestamp < ::Exception; end
-    class InvalidUserId < ::Exception; end
-    class InvalidWebhookId < ::Exception; end
-    class InvalidVersion < ::Exception; end
-    class NotImplemented < ::Exception; end
-    class UnparseableResponse < ::Exception; end
-    class ValueOutOfRange < ::Exception; end
+    class EmptyMetricName < RuntimeError; end
+    class InvalidAlertId < RuntimeError; end
+    class InvalidAlertSeverity < RuntimeError; end
+    class InvalidCloudIntegrationId < RuntimeError; end
+    class InvalidDashboardId < RuntimeError; end
+    class InvalidEndpoint < RuntimeError; end
+    class InvalidEventId < RuntimeError; end
+    class InvalidExternalLinkId < RuntimeError; end
+    class InvalidGranularity < RuntimeError; end
+    class InvalidHostname < RuntimeError; end
+    class InvalidIntegrationId < RuntimeError; end
+    class InvalidRelativeTime < RuntimeError; end
+    class InvalidTimeUnit < RuntimeError; end
+    class InvalidMaintenanceWindowId < RuntimeError; end
+    class InvalidMessageId < RuntimeError; end
+    class InvalidMetricName < RuntimeError; end
+    class InvalidMetricValue < RuntimeError; end
+    class InvalidNotificantId < RuntimeError; end
+    class InvalidName < RuntimeError; end
+    class InvalidPoint < RuntimeError; end
+    class InvalidPrefixLength < RuntimeError; end
+    class InvalidProxyId < RuntimeError; end
+    class InvalidSavedSearchId < RuntimeError; end
+    class InvalidSavedSearchEntity < RuntimeError; end
+    class InvalidSourceId < RuntimeError; end
+    class InvalidString < RuntimeError; end
+    class InvalidTag < RuntimeError; end
+    class InvalidLinkTemplate < RuntimeError; end
+    class InvalidTimeFormat < RuntimeError; end
+    class InvalidTimestamp < RuntimeError; end
+    class InvalidUserId < RuntimeError; end
+    class InvalidWebhookId < RuntimeError; end
+    class InvalidVersion < RuntimeError; end
+    class NotImplemented < RuntimeError; end
+    class UnparseableResponse < RuntimeError; end
+    class ValueOutOfRange < RuntimeError; end
   end
 end

data/lib/wavefront-sdk/externallink.rb

@@ -10,7 +10,7 @@ module Wavefront
     end
 
     def update_keys
-      %i(name template description)
+      %i[name template description]
     end
 
     # GET /api/v2/extlink
@@ -20,7 +20,7 @@ module Wavefront
     # @param limit [Int] the number of link to return
     #
     def list(offset = 0, limit = 100)
-      api_get('', { offset: offset, limit: limit })
+      api_get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/extlink

data/lib/wavefront-sdk/integration.rb

@@ -5,7 +5,6 @@ module Wavefront
   # Manage and query Wavefront integrations.
   #
   class Integration < Base
-
     # GET /api/v2/integration
     # Gets a flat list of all Wavefront integrations available,
     # along with their status
@@ -14,7 +13,7 @@ module Wavefront
     # @param limit [Int] the number of proxies to return
     #
     def list(offset = 0, limit = 100)
-      api_get('', { offset: offset, limit: limit })
+      api_get('', offset: offset, limit: limit)
     end
 
     # GET /api/v2/integration/id

data/lib/wavefront-sdk/maintenancewindow.rb

@@ -6,8 +6,8 @@ module Wavefront
   #
   class MaintenanceWindow < Base
     def update_keys
-      %i(reason title startTimeInSeconds endTimeInSeconds
-         relevantCustomerTags relevantHostTags relevantHostNames)
+      %i[reason title startTimeInSeconds endTimeInSeconds
+         relevantCustomerTags relevantHostTags relevantHostNames]
     end
 
     # GET /api/v2/maintenancewindow
@@ -17,7 +17,7 @@ module Wavefront
     # @param limit [Integer] the number of window to return
     #
     def list(offset = 0, limit = 100)
-      api_get('', { offset: offset, limit: limit })
+      api_get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/maintenancewindow

data/lib/wavefront-sdk/message.rb

@@ -5,7 +5,6 @@ module Wavefront
   # Manage and query Wavefront messages.
   #
   class Message < Base
-
     # GET /api/v2/message
     # Gets messages applicable to the current user, i.e. within time
     # range and distribution scope
@@ -14,7 +13,7 @@ module Wavefront
     # @param limit [Int] the number of agents to return
     #
     def list(offset = 0, limit = 100, unread_only = true)
-      api_get('', { offset: offset, limit: limit, unreadOnly: unread_only })
+      api_get('', offset: offset, limit: limit, unreadOnly: unread_only)
     end
 
     # POST /api/v2/message/id/read

data/lib/wavefront-sdk/mixins.rb

@@ -3,47 +3,54 @@ require_relative './exception'
 require_relative './parse_time'
 
 module Wavefront
+  #
+  # Methods which help out in the SDK, but may also be useful when
+  # coding against the SDK.
+  #
   module Mixins
     # Return a time as an integer, however it might come in.
     #
-    # @param t [Integer, String, Time] timestamp
-    # @param ms [Boolean] whether to return epoch milliseconds.
+    # @param time [Integer, String, Time] timestamp
+    # @param in_ms [Boolean] whether to return epoch milliseconds.
     #   Passing in an integer timestamp returns itself, regardless
     #   of this value
     # @return [Integer] epoch time in seconds
     # @raise Wavefront::InvalidTimestamp
     #
-    def parse_time(t, ms = false)
-      return relative_time(t, ms) if t =~ /^[\-+]/
-      ParseTime.new(t, ms).parse!
+    def parse_time(time, in_ms = false)
+      return relative_time(time, in_ms) if time =~ /^[\-+]/
+      ParseTime.new(time, in_ms).parse!
     end
 
-    # Return a timetamp described by the given string. That is,
+    # Return a timestamp described by the given string. That is,
     # '+5m' is five minutes in the future, and '-.1h' is half an
     # hour ago.
     #
-    # @param t [String] relative time string. Must begin with + or
+    # @param time [String] relative time string. Must begin with + or
     #   -, followed by a number, finished with a lower-case time
     #   unit identifier. See #time_multiplier
+    # @param in_ms [Boolean] whether to return epoch milliseconds.
+    #   Passing in an integer timestamp returns itself, regardless
+    #   of this value
     # @param ref [Time, DateTime] calculate time relative to this
     #   point. Primarily for easier testing. Defaults to "now".
     # @return [Integer] integer timestamp
     # @raise [InvalidRelativeTime] if t does not meet requirements
     #
-    def relative_time(t, ms = false, ref = DateTime.now)
-      ref = ms ? ref.to_datetime.strftime('%Q') : ref.to_time
-      ref.to_i + parse_relative_time(t, ms)
+    def relative_time(time, in_ms = false, ref = Time.now)
+      ref = in_ms ? ref.to_datetime.strftime('%Q') : ref.to_time
+      ref.to_i + parse_relative_time(time, in_ms)
     end
 
-    def parse_relative_time(t, ms = false)
-      unless t.start_with?('+') || t.start_with?('-')
+    def parse_relative_time(time, in_ms = false)
+      unless time.start_with?('+', '-')
         raise Wavefront::Exception::InvalidRelativeTime
       end
 
-      m = ms ? 1000 : 1
+      m = in_ms ? 1000 : 1
 
-      t = t[1..-1] if t.start_with?('+')
-      match = t.match(/^(-?\d*\.?\d*)([smhdwy])$/)
+      time = time[1..-1] if time.start_with?('+')
+      match = time.match(/^(-?\d*\.?\d*)([smhdwy])$/)
       (match[1].to_f * time_multiplier(match[2]) * m).to_i
     rescue NoMethodError
       raise Wavefront::Exception::InvalidRelativeTime
@@ -61,7 +68,7 @@ module Wavefront
     # @raise InvalidTimeUnit if the suffix is unknown
     #
     def time_multiplier(suffix)
-      u = { s: 1, m: 60, h: 3600, d: 86400, w: 604800, y: 31536000 }
+      u = { s: 1, m: 60, h: 3600, d: 86_400, w: 604_800, y: 31_536_000 }
 
       return u[suffix.to_sym] if u.key?(suffix.to_sym)
       raise Wavefront::Exception::InvalidTimeUnit
@@ -72,19 +79,17 @@ end
 # Extensions to stdlib Hash
 #
 class Hash
-
   # Convert a tag hash into a string. The quoting is recommended in
   # the WF wire-format guide. No validation is performed here.
   #
   def to_wf_tag
-    self.map { |k, v| "#{k}=\"#{v}\"" }.join(' ')
+    map { |k, v| "#{k}=\"#{v}\"" }.join(' ')
   end
 end
 
 # Extensions to stdlib Array
 #
 class Array
-
   # Join strings together to make a URI path in a way that is more
   # flexible than URI::Join.  Removes multiple and trailing
   # separators. Does not have to produce fully qualified paths. Has
@@ -93,6 +98,6 @@ class Array
   # @return [String] a URI path
   #
   def uri_concat
-    self.join('/').squeeze('/').sub(/\/$/, '').sub(/\/\?/, '?')
+    join('/').squeeze('/').sub(%r{\/$}, '').sub(%r{\/\?}, '?')
   end
 end