wavefront-sdk 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e68e0e9c6233a7fb449408c84111beaf522c023370188d155c234aa3387c411c
-  data.tar.gz: 0a3575ed176110827a011b6793b1d6f3cf8eb64e96dba1ce4b2f129ef1234219
+  metadata.gz: e599fd70e3a67cdc62c8ec942382db101850582e8bd98c11e8e56e18a1d1bfaf
+  data.tar.gz: 134f436ff650ba75a4cad1e93bcf229ea25787dbafa5fcf40aa93b067bed9402
 SHA512:
-  metadata.gz: 47af2cca2a5ca29d545aefb936e3850234e117d53d6ee46580b931e505fda6fdb446004680102631b1b19d463889cf601d6578de27b0e7358094b498a24174ee
-  data.tar.gz: 736e992312831e5c1b2f37558c70cfec883950eab7f82777baa1c9a2ba3848b0adc0abc20972d27f70e34fbe77ce027b850b65bc6781c55e78cc50a6edbfa294
+  metadata.gz: 3f051f1594d486c3b6c65ed964a0e2b822a034975a19ad9745926048e891ce5a8f89a063a17532ff8a90b3b1c89085ba448d57346dff33b6300765bd3f365b3e
+  data.tar.gz: 0a97bf0ed08c8ee08607b4e98f55cc5daeb7b30e6245df99407c0dddfb708ed093bbaeb3d9aaac805d09da12ca61cccdd94c96222458545bc7857d536d43002e

data/.rubocop.yml

@@ -1,8 +1,15 @@
+---
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.2
 
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-Lint/MissingCopEnableDirective:
+Style/FormatStringToken:
   Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 13

data/HISTORY.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 1.6.1 (22/08/2018)
+
+* Fix Ruby 2.2 bugs
+* Improve unit test separation
+* Allow updating of all external link parameters
+
+## 1.6.0 (07/08/2018)
+* Improve validation of point tags.
+* Break extensions to standard library out into their own files.
+* Improve README.
+
 ## 1.5.0 (25/06/2018)
 
 * Add [derived

data/lib/wavefront-sdk/base.rb

@@ -4,6 +4,7 @@ require 'faraday'
 require 'pp'
 require 'ostruct'
 require 'addressable'
+require_relative 'logger'
 require_relative 'exception'
 require_relative 'mixins'
 require_relative 'response'
@@ -18,12 +19,11 @@ module Wavefront
   #
   # @return a Wavefront::Response object
   #
-  # rubocop:disable Metrics/ClassLength
   class Base
     include Wavefront::Validators
     include Wavefront::Mixins
-    attr_reader :opts, :debug, :noop, :verbose, :net, :conn, :update_keys,
-                :logger
+    attr_reader :opts, :debug, :noop, :verbose, :net, :conn,
+                :update_keys, :logger
 
     # Create a new API object. This will always be called from a
     # class which inherits this one. If the inheriting class defines
@@ -44,16 +44,19 @@ module Wavefront
     # @return [Nil]
     #
     def initialize(creds = {}, opts = {})
-      @opts  = opts
-      @debug = opts[:debug] || false
-      @noop = opts[:noop] || false
+      @opts    = opts
+      @debug   = opts[:debug] || false
+      @noop    = opts[:noop] || false
       @verbose = opts[:verbose] || false
-      @logger = opts[:logger] || nil
+      @logger  = Wavefront::Logger.new(opts)
       setup_endpoint(creds)
-
       post_initialize(creds, opts) if respond_to?(:post_initialize)
     end
 
+    def log(message, severity = :info)
+      logger.log(message, severity)
+    end
+
     # Convert an epoch timestamp into epoch milliseconds. If the
     # timestamp looks like it's already epoch milliseconds, return
     # it as-is.
@@ -85,16 +88,15 @@ module Wavefront
     # @return [URI::HTTPS]
     #
     def mk_conn(path, headers = {})
-      Faraday.new(
-        url:     Addressable::URI.encode("https://#{net[:endpoint]}" +
-                 [net[:api_base], path].uri_concat),
-        headers: net[:headers].merge(headers)
-      )
+      url = format('https://%s%s', net[:endpoint], [net[:api_base],
+                                                    path].uri_concat)
+      Faraday.new(url:     Addressable::URI.encode(url),
+                  headers: net[:headers].merge(headers))
     end
 
     # Make a GET call to the Wavefront API and return the result as
     # a Ruby hash. Can optionally perform a verbose noop, if the
-    # #noop class variable is set. If #verbose is set, then prints
+    # @noop class variable is set. If @verbose is set, then prints
     # the information used to build the URI.
     #
     # @param path [String] path to be appended to the
@@ -109,7 +111,7 @@ module Wavefront
 
     # Make a POST call to the Wavefront API and return the result as
     # a Ruby hash. Can optionally perform a verbose noop, if the
-    # #noop class variable is set. If #verbose is set, then prints
+    # @noop class variable is set. If @verbose is set, then prints
     # the information used to build the URI.
     #
     # @param path [String] path to be appended to the
@@ -127,7 +129,7 @@ module Wavefront
 
     # Make a PUT call to the Wavefront API and return the result as
     # a Ruby hash. Can optionally perform a verbose noop, if the
-    # #noop class variable is set. If #verbose is set, then prints
+    # @noop class variable is set. If @verbose is set, then prints
     # the information used to build the URI.
     #
     # @param path [String] path to be appended to the
@@ -144,7 +146,7 @@ module Wavefront
 
     # Make a DELETE call to the Wavefront API and return the result
     # as a Ruby hash. Can optionally perform a verbose noop, if the
-    # #noop class variable is set. If #verbose is set, then prints
+    # @noop class variable is set. If @verbose is set, then prints
     # the information used to build the URI.
     #
     # @param path [String] path to be appended to the
@@ -173,30 +175,6 @@ module Wavefront
       end
     end
 
-    # Send a message to a Ruby logger object if the user supplied
-    # one, or print to standard out if not.
-    #
-    # @param msg [String] the string to print
-    # @param level [Symbol] the level of the message.
-    #   :verbose messages equate to a standard INFO log level and
-    #   :debug to DEBUG.
-    #
-    def log(msg, level = nil)
-      if logger
-        logger.send(level || :info, msg)
-      else
-        print_message(msg, level)
-      end
-    end
-
-    # 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]
-      puts msg
-    end
-
     # If we need to massage a raw response to fit what the
     # Wavefront::Response class expects (I'm looking at you,
     # 'User'), a class can provide a {#response_shim} method.
@@ -208,7 +186,7 @@ module Wavefront
                resp.body
              end
 
-      Wavefront::Response.new(body, resp.status, debug)
+      Wavefront::Response.new(body, resp.status, opts)
     end
 
     # Return all objects using a lazy enumerator
@@ -238,11 +216,11 @@ module Wavefront
     # of clumsy guesswork here
     #
     def verbosity(conn, method, *args)
-      log "uri: #{method.upcase} #{conn.url_prefix}"
+      log format('uri: %s %s', method.upcase, conn.url_prefix)
 
       return unless args.last && !args.last.empty?
 
-      puts log method == :get ? "params: #{args.last}" : "body: #{args.last}"
+      log method == :get ? "params: #{args.last}" : "body: #{args.last}"
     end
 
     # Make the API call, or not, if noop is set.
@@ -261,10 +239,17 @@ module Wavefront
       respond(resp)
     end
 
-    def setup_endpoint(creds)
+    def validate_credentials(creds)
       %w[endpoint token].each do |k|
-        raise "creds must contain #{k}" unless creds.key?(k.to_sym)
+        unless creds.key?(k.to_sym)
+          raise(Wavefront::Exception::CredentialError,
+                format('credentials must contain %s', k))
+        end
       end
+    end
+
+    def setup_endpoint(creds)
+      validate_credentials(creds)
 
       unless creds.key?(:agent) && creds[:agent]
         creds[:agent] = "wavefront-sdk #{WF_SDK_VERSION}"

data/lib/wavefront-sdk/base_write.rb

@@ -83,7 +83,7 @@ module Wavefront
       resp = { status:   { result: s_str, message: nil, code: nil },
                response: summary }.to_json
 
-      Wavefront::Response.new(resp, nil)
+      Wavefront::Response.new(resp, nil, opts)
     end
 
     def summary_string(summary)
@@ -125,23 +125,18 @@ module Wavefront
       [points].flatten.map { |p| p.tap { p[:path] = DELTA + p[:path] } }
     end
 
-    # rubocop:disable Metrics/MethodLength
     def valid_point?(point)
       return true if opts[:novalidate]
-
-      begin
-        wf_point?(point)
-        return true
-      rescue Wavefront::Exception::InvalidMetricName,
-             Wavefront::Exception::InvalidMetricValue,
-             Wavefront::Exception::InvalidTimestamp,
-             Wavefront::Exception::InvalidSourceId,
-             Wavefront::Exception::InvalidTag => e
-        log('Invalid point, skipping.', :info)
-        log("Invalid point: #{point}. (#{e})", :debug)
-        summary[:rejected] += 1
-        return false
-      end
+      wf_point?(point)
+    rescue Wavefront::Exception::InvalidMetricName,
+           Wavefront::Exception::InvalidMetricValue,
+           Wavefront::Exception::InvalidTimestamp,
+           Wavefront::Exception::InvalidSourceId,
+           Wavefront::Exception::InvalidTag => e
+      log('Invalid point, skipping.', :info)
+      log(format('Invalid point: %s (%s)', point, e.to_s), :debug)
+      summary[:rejected] += 1
+      false
     end
 
     # Convert a validated point to a string conforming to
@@ -151,21 +146,25 @@ module Wavefront
     # @param point [Hash] a hash describing a point. See #write() for
     #   the format.
     #
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
     def hash_to_wf(point)
-      unless point.key?(:path) && point.key?(:value)
-        raise Wavefront::Exception::InvalidPoint
-      end
-
-      point[:source] = HOSTNAME unless point.key?(:source)
+      format('%s %s %s source=%s %s %s',
+             *point_array(point)).squeeze(' ').strip
+    rescue StandardError
+      raise Wavefront::Exception::InvalidPoint
+    end
 
-      m = [point[:path], point[:value]]
-      m.<< point[:ts] if point[:ts]
-      m.<< 'source=' + point[:source]
-      m.<< point[:tags].to_wf_tag if point[:tags]
-      m.<< opts[:tags].to_wf_tag if opts[:tags]
-      m.join(' ')
+    # Make an array which can be used by #hash_to_wf.
+    # @param point [Hash] a hash describing a point. See #write() for
+    #   the format.
+    # @raise
+    #
+    def point_array(point)
+      [point[:path] || raise,
+       point[:value] || raise,
+       point.fetch(:ts, nil),
+       point.fetch(:source, HOSTNAME),
+       point[:tags] && point[:tags].to_wf_tag,
+       opts[:tags] && opts[:tags].to_wf_tag]
     end
 
     # Wrapper for #really_send_point(), which really sends points.

data/lib/wavefront-sdk/event.rb

@@ -24,17 +24,21 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def list(from = nil, to = nil, limit = 100, cursor = nil)
-      raise ArgumentError unless from && to
+      raise ArgumentError unless from && to && limit.is_a?(Integer)
+      wf_event_id?(cursor) if cursor
+
       from = parse_time(from, true)
-      to = parse_time(to, true)
+      to   = parse_time(to, true)
+
       wf_ms_ts?(from)
       wf_ms_ts?(to)
-      wf_event_id?(cursor) if cursor
-      raise ArgumentError unless limit.is_a?(Integer)
 
-      api_get('', { earliestStartTimeEpochMillis: from,
-                    latestStartTimeEpochMillis: to,
-                    cursor: cursor, limit: limit }.select { |_k, v| v })
+      body = { earliestStartTimeEpochMillis: from,
+               latestStartTimeEpochMillis:   to,
+               cursor:                       cursor,
+               limit:                        limit }
+
+      api_get('', body.cleanse)
     end
 
     # POST /api/v2/event

data/lib/wavefront-sdk/exception.rb

@@ -3,6 +3,7 @@ module Wavefront
   # Simple exception classes
   #
   class Exception
+    class CredentialError < RuntimeError; end
     class EmptyMetricName < RuntimeError; end
     class InvalidAlertId < RuntimeError; end
     class InvalidAlertSeverity < RuntimeError; end

data/lib/wavefront-sdk/externallink.rb

@@ -10,7 +10,8 @@ module Wavefront
     end
 
     def update_keys
-      %i[name template description]
+      %i[name template description metricFilterRegex sourceFilterRegex
+         pointTagFilterRegexes]
     end
 
     # GET /api/v2/extlink

data/lib/wavefront-sdk/logger.rb

@@ -0,0 +1,65 @@
+module Wavefront
+  #
+  # Log to a user-supplied Ruby logger, or to standard output.
+  #
+  class Logger
+    attr_reader :logger, :verbose, :debug
+
+    # @param opts [Hash] options hash from a child of Wavefront::Base
+    #
+    def initialize(opts = {})
+      @logger  = opts[:logger] || nil
+      @verbose = opts[:verbose] || nil
+      @debug   = opts[:debug] || nil
+    end
+
+    # Send a message to a Ruby logger object if the user supplied
+    # one, or print to standard out if not.
+    #
+    # @param msg [String] the string to print
+    # @param level [Symbol] the level of the message.
+    #   :verbose messages equate to a standard INFO log level and
+    #   :debug to DEBUG.
+    #
+    def log(msg, level = :info)
+      if logger
+        logger.send(level, msg)
+      else
+        print_message(level, msg)
+      end
+    end
+
+    def print_message(level, msg)
+      method = format('print_%s_message', 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(msg)
+      end
+    end
+
+    def format_message(level, msg)
+      format('SDK %s: %s', level.to_s.upcase, msg)
+    end
+
+    def print_debug_message(msg)
+      return unless debug
+      puts msg
+    end
+
+    def print_info_message(msg)
+      puts msg
+    end
+
+    def print_warn_message(msg)
+      warn msg
+    end
+
+    def print_error_message(msg)
+      warn msg
+    end
+  end
+end

data/lib/wavefront-sdk/metric.rb

@@ -18,19 +18,18 @@ module Wavefront
     # @param cursor [String] optionally begin from this result
     #
     def detail(metric, sources = [], cursor = nil)
-      raise ArgumentError unless metric.is_a?(String)
-      raise ArgumentError unless sources.is_a?(Array)
+      raise ArgumentError unless metric.is_a?(String) && sources.is_a?(Array)
 
-      q = [[:m, metric]]
+      query = [[:m, metric]]
 
       if cursor
         raise ArgumentError unless cursor.is_a?(String)
-        q.<< [:c, cursor]
+        query.<< [:c, cursor]
       end
 
-      sources.each { |s| q.<< [:h, s] }
+      sources.each { |source| query.<< [:h, source] }
 
-      api_get('detail', q)
+      api_get('detail', query)
     end
   end
 end

data/lib/wavefront-sdk/mixins.rb

@@ -43,18 +43,29 @@ module Wavefront
       ref.to_i + parse_relative_time(time, in_ms)
     end
 
+    # Do the real work for #relative_time
+    # @param time [String] as +1h, -3d etc
+    # @param in_ms [Bool] whether to return time differential in ms
+    #   rather than s
+    # @return [Integer] time differential
+    #
     def parse_relative_time(time, in_ms = false)
-      unless time.start_with?('+', '-')
+      unless valid_relative_time?(time)
         raise Wavefront::Exception::InvalidRelativeTime
       end
 
       m = in_ms ? 1000 : 1
-
-      time = time[1..-1] if time.start_with?('+')
+      time.delete!('+')
       match = time.match(/^(-?\d*\.?\d*)([smhdwy])$/)
       (match[1].to_f * time_multiplier(match[2]) * m).to_i
-    rescue NoMethodError
-      raise Wavefront::Exception::InvalidRelativeTime
+    end
+
+    # Is a relative time valid?
+    # @param time [String] time as +1d, -1h etc
+    # @return [Bool]
+    #
+    def valid_relative_time?(time)
+      time =~ /^[+-](-?\d*\.?\d*)[smhdwy]$/
     end
 
     # naively return the number of seconds from the given