wavefront-sdk 1.3.0 → 1.3.1

data/lib/wavefront-sdk/notificant.rb

@@ -5,7 +5,6 @@ module Wavefront
   # Manage and query Wavefront notification targets.
   #
   class Notificant < Base
-
     # GET /api/v2/notificant
     # Get all notification targets for a customer
     #
@@ -13,7 +12,7 @@ module Wavefront
     # @param limit [Int] the number of notification targets to return
     #
     def list(offset = 0, limit = 100)
-      api_get('', { offset: offset, limit: limit })
+      api_get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/notificant

data/lib/wavefront-sdk/parse_time.rb

@@ -1,4 +1,5 @@
 module Wavefront
+  #
   # Parse various times into integers. This class is not for direct
   # consumption: it's used by the mixins parse_time method, which
   # does all the type sanity stuff.
@@ -9,34 +10,34 @@ module Wavefront
     # param t [Numeric] a timestamp
     # param ms [Bool] whether the timestamp is in milliseconds
     #
-    def initialize(t, ms = false)
-      @t = t
-      @ms = ms
+    def initialize(time, in_ms = false)
+      @t = time
+      @ms = in_ms
     end
 
     # @return [Fixnum] timestamp
     #
-    def parse_time_Fixnum
+    def parse_time_fixnum
       t
     end
 
     # @return [Integer] timestamp
     #
-    def parse_time_Integer
+    def parse_time_integer
       t
     end
 
     # @return [Fixnum] timestamp
     #
-    def parse_time_String
+    def parse_time_string
       return t.to_i if t =~ /^\d+$/
-      @t = DateTime.parse("#{t} #{Time.now.getlocal.zone}")
-      parse_time_Time
+      @t = Time.parse("#{t} #{Time.now.getlocal.zone}")
+      parse_time_time
     end
 
     # @return [Integer] timestamp
     #
-    def parse_time_Time
+    def parse_time_time
       if ms
         t.to_datetime.strftime('%Q').to_i
       else
@@ -44,14 +45,14 @@ module Wavefront
       end
     end
 
-    def parse_time_DateTime
-      parse_time_Time
+    def parse_time_datetime
+      parse_time_time
     end
 
     def parse!
-      method = ('parse_time_' + t.class.name).to_sym
+      method = ('parse_time_' + t.class.name.downcase).to_sym
       send(method)
-    rescue
+    rescue StandardError
       raise Wavefront::Exception::InvalidTimestamp
     end
   end

data/lib/wavefront-sdk/proxy.rb

@@ -5,7 +5,6 @@ module Wavefront
   # Manage and query Wavefront proxies.
   #
   class Proxy < Base
-
     # GET /api/v2/proxy
     # Get all proxies for a customer
     #
@@ -13,7 +12,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
 
     # DELETE /api/v2/proxy/id
@@ -68,7 +67,7 @@ module Wavefront
     def rename(id, name)
       wf_proxy_id?(id)
       wf_string?(name)
-      update(id, {name: name})
+      update(id, name: name)
     end
 
     # A generic function to change properties of an proxy. So far as I

data/lib/wavefront-sdk/query.rb

@@ -29,7 +29,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def query(query, granularity = nil, t_start = nil, t_end = nil,
-               options = {})
+              options = {})
 
       raise ArgumentError unless query.is_a?(String)
       wf_granularity?(granularity)
@@ -40,10 +40,7 @@ module Wavefront
       options[:s] = parse_time(t_start, true)
       options[:e] = parse_time(t_end, true) if t_end
 
-      options.delete_if do |k, v|
-        v == false && k != :i
-      end
-
+      options.delete_if { |k, v| v == false && k != :i }
       api_get('api', options)
     end
 
@@ -63,7 +60,7 @@ module Wavefront
     def raw(metric, source = nil, t_start = nil, t_end = nil)
       raise ArgumentError unless metric.is_a?(String)
 
-      options = { metric: metric, }
+      options = { metric: metric }
 
       if source
         wf_source_id?(source)
@@ -83,8 +80,7 @@ module Wavefront
       { response: JSON.parse(body),
         status:   { result:  status == 200 ? 'OK' : 'ERROR',
                     message: '',
-                    code:    status },
-      }.to_json
+                    code:    status } }.to_json
     end
   end
 end

data/lib/wavefront-sdk/response.rb

@@ -3,7 +3,6 @@ require 'map'
 require_relative './exception'
 
 module Wavefront
-
   # Every API path has its own response class, which allows us to
   # provide a stable interface. If the API changes underneath us,
   # the SDK will break in a predictable way, throwing a
@@ -36,7 +35,7 @@ module Wavefront
       @response = build_response(raw)
 
       p self if debug
-    rescue => e
+    rescue StandardError => e
       puts "could not parse:\n#{json}" if debug
       puts e.message if debug
       raise Wavefront::Exception::UnparseableResponse
@@ -44,7 +43,7 @@ module Wavefront
 
     def raw_response(json, status)
       json.empty? ? {} : JSON.parse(json, symbolize_names: true)
-    rescue
+    rescue StandardError
       { message: json, code: status }
     end
 
@@ -53,22 +52,15 @@ module Wavefront
     end
 
     def build_response(raw)
-      if raw.is_a?(Hash)
-        if raw.key?(:response)
-          if raw[:response].is_a?(Hash)
-            Map(raw[:response])
-          else
-            raw[:response]
-          end
-        else
-          Map.new(raw)
-        end
-      else
-        Map.new
-      end
+      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
   end
 
+  # Status tests
+  #
   class Type
     #
     # An object which provides information about whether the request

data/lib/wavefront-sdk/savedsearch.rb

@@ -6,7 +6,6 @@ module Wavefront
   # a UUID.
   #
   class SavedSearch < Base
-
     # GET /api/v2/savedsearch
     # Get all saved searches for a user.
     #
@@ -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/savedsearch
@@ -74,9 +73,8 @@ module Wavefront
     #
     def entity(entitytype, offset = 0, limit = 100)
       wf_savedsearch_entity?(entitytype)
-      api_get(['type', entitytype].uri_concat, { offset: offset,
-                                                 limit: limit })
-
+      api_get(['type', entitytype].uri_concat, offset: offset,
+                                               limit: limit)
     end
   end
 end

data/lib/wavefront-sdk/search.rb

@@ -8,7 +8,6 @@ module Wavefront
   # lot up to the user. It may grow, with convenience methods.
   #
   class Search < Base
-
     # POST /api/v2/search/entity
     # POST /api/v2/search/entity/deleted
     # Run a search query. This single method maps to many API paths.
@@ -73,7 +72,7 @@ module Wavefront
     #
     def raw_search(entity = nil, body = nil, deleted = false)
       unless (entity.is_a?(String) || entity.is_a?(Symbol)) &&
-        body.is_a?(Hash)
+             body.is_a?(Hash)
         raise ArgumentError
       end
 
@@ -94,7 +93,7 @@ module Wavefront
     #   information.
     #
     def raw_facet_search(entity = nil, body = nil, deleted = false,
-                     facet = false)
+                         facet = false)
       raise ArgumentError unless entity.is_a?(String)
       raise ArgumentError unless body.is_a?(Hash)
       path = [entity]

data/lib/wavefront-sdk/source.rb

@@ -6,7 +6,7 @@ module Wavefront
   #
   class Source < Base
     def update_keys
-      %i(sourceName tags description)
+      %i[sourceName tags description]
     end
 
     # GET /api/v2/source

data/lib/wavefront-sdk/user.rb

@@ -5,7 +5,6 @@ module Wavefront
   # Manage and query Wavefront users
   #
   class User < Base
-
     # GET /api/v2/user
     # Get all users.
     #
@@ -92,8 +91,7 @@ module Wavefront
       { response: JSON.parse(body),
         status:   { result:  status == 200 ? 'OK' : 'ERROR',
                     message: '',
-                    code:    status },
-      }.to_json
+                    code:    status } }.to_json
     end
 
     # the user API class does not support pagination. Be up-front

data/lib/wavefront-sdk/validators.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Naming/UncommunicativeMethodParamName
 require_relative './constants'
 require_relative './exception'
 
@@ -10,18 +11,15 @@ module Wavefront
   # Some comes from the Swagger API documentation, some has come
   # directly from Wavefront engineers.
   #
+  # rubocop:disable Metrics/ModuleLength
   module Validators
-
     # Ensure the given argument is a valid external link template
     #
     # @return true if it is valid
     # @raise Wavefront::Exception::InvalidTemplate if not
     #
     def wf_link_template?(v)
-      if v.is_a?(String) && (v.start_with?('http://') ||
-                             v.start_with?('https://'))
-        return true
-      end
+      return true if v.is_a?(String) && v.start_with?('http://', 'https://')
 
       raise Wavefront::Exception::InvalidLinkTemplate
     end
@@ -148,11 +146,13 @@ module Wavefront
     # @raise Wavefront::Exception::InvalidVersion if the alert ID is
     #   not valid
     #
+    # rubocop:disable Style/NumericPredicate
     def wf_version?(v)
       v = v.to_i if v.is_a?(String) && v =~ /^\d+$/
       return true if v.is_a?(Integer) && v > 0
       raise Wavefront::Exception::InvalidVersion
     end
+    # rubocop:enable Style/NumericPredicate
 
     # Ensure a hash of key:value point tags are value. Not to be
     # confused with source tags.
@@ -175,7 +175,7 @@ module Wavefront
     # @return nil
     #
     def wf_point_tag?(k, v)
-      return if  k && v && (k.size + v.size < 254) && k =~ /^[\w\-\.:]+$/
+      return if k && v && (k.size + v.size < 254) && k =~ /^[\w\-\.:]+$/
       raise Wavefront::Exception::InvalidTag
     end
 
@@ -292,7 +292,7 @@ module Wavefront
     #   valid
     #
     def wf_alert_severity?(v)
-      return true if %w(INFO SMOKE WARN SEVERE).include?(v)
+      return true if %w[INFO SMOKE WARN SEVERE].include?(v)
       raise Wavefront::Exception::InvalidAlertSeverity
     end
 
@@ -316,7 +316,7 @@ module Wavefront
     #   valid
     #
     def wf_granularity?(v)
-      return true if %w(d h m s).include?(v.to_s)
+      return true if %w[d h m s].include?(v.to_s)
       raise Wavefront::Exception::InvalidGranularity
     end
 
@@ -339,9 +339,9 @@ module Wavefront
     #   valid
     #
     def wf_savedsearch_entity?(v)
-      return true if %w(DASHBOARD ALERT MAINTENANCE_WINDOW
+      return true if %w[DASHBOARD ALERT MAINTENANCE_WINDOW
                         NOTIFICANT EVENT SOURCE EXTERNAL_LINK AGENT
-                        CLOUD_INTEGRATION).include?(v)
+                        CLOUD_INTEGRATION].include?(v)
       raise Wavefront::Exception::InvalidSavedSearchEntity
     end
 
@@ -353,9 +353,7 @@ module Wavefront
     #   is not valid
     #
     def wf_source_id?(v)
-      if v.is_a?(String) && v.match(/^[\w\.\-]+$/) && v.size < 1024
-        return true
-      end
+      return true if v.is_a?(String) && v.match(/^[\w\.\-]+$/) && v.size < 1024
 
       raise Wavefront::Exception::InvalidSourceId
     end
@@ -368,7 +366,7 @@ module Wavefront
     #
     def wf_user_id?(v)
       return true if v.is_a?(String) &&
-         v =~ /\A([\w+\-].?)+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i
+                     v =~ /\A([\w+\-].?)+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i
       raise Wavefront::Exception::InvalidUserId
     end
 

data/lib/wavefront-sdk/version.rb

@@ -1 +1 @@
-WF_SDK_VERSION = '1.3.0'.freeze
+WF_SDK_VERSION = '1.3.1'.freeze

data/lib/wavefront-sdk/webhook.rb

@@ -6,7 +6,7 @@ module Wavefront
   #
   class Webhook < Base
     def update_keys
-      %i(title description template title triggers recipient)
+      %i[title description template title triggers recipient]
     end
 
     # GET /api/v2/webhook
@@ -16,7 +16,7 @@ module Wavefront
     # @param limit [Integer] the number of webhooks to return
     #
     def list(offset = 0, limit = 100)
-      api_get('', { offset: offset, limit: limit })
+      api_get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/webhook

data/lib/wavefront-sdk/write.rb

@@ -9,6 +9,7 @@ module Wavefront
   # This class helps you send points to a Wavefront proxy in native
   # format. Usually this is done on port 2878.
   #
+  # rubocop:disable Metrics/ClassLength
   class Write < Base
     attr_reader :sock, :summary
 
@@ -62,7 +63,7 @@ module Wavefront
       open if openclose
 
       begin
-        [points].flatten.each{ |p| send_point(p) }
+        [points].flatten.each { |p| send_point(p) }
       ensure
         close if openclose
       end
@@ -84,24 +85,21 @@ module Wavefront
     # @param openclose [Bool] if this is false, you must have
     #   already opened a socket to the proxy. If it is true, a
     #   connection will be opened for you, used, and closed.
+    # @param prefix [String] prefix all metrics with this string. No
+    #   trailing dot is required.
     # @raise any unhandled point validation error is passed through
     # @return true if no points are rejected, otherwise false
     #
-    def write(points = [], openclose = true)
+    def write(points = [], openclose = true, prefix = nil)
       open if openclose
 
       begin
-        [points].flatten.each do |p|
-          p[:ts] = p[:ts].to_i if p[:ts].is_a?(Time)
-          valid_point?(p)
-          send_point(hash_to_wf(p))
-        end
+        _write_loop(prepped_points(points, prefix))
       ensure
         close if openclose
       end
 
-      s_str = summary[:unsent] == 0 && summary[:rejected] == 0 ? 'OK' :
-                                                                 'ERROR'
+      s_str = summary_string(summary)
 
       resp = { status:   { result: s_str, message: nil, code: nil },
                response: summary }.to_json
@@ -109,10 +107,27 @@ module Wavefront
       Wavefront::Response.new(resp, nil)
     end
 
+    def summary_string(summary)
+      summary[:unsent].zero? && summary[:rejected].zero? ? 'OK' : 'ERROR'
+    end
+
+    # @return [Array] of points
+    #
+    def prepped_points(points, prefix = nil)
+      ret = [points].flatten
+
+      if prefix
+        ret.map! { |pt| pt.tap { |p| p[:path] = prefix + '.' + p[:path] } }
+      end
+
+      ret
+    end
+
     # A wrapper method around #write() which guarantees all points
     # will be sent as deltas. You can still manually prefix any
-    # metric with a Δ and use #write(), but depending on your
-    # use-case, this method may be safer. It's easy to forget the Δ.
+    # metric with a delta symbol and use #write(), but depending on
+    # your use-case, this method may be safer. It's easy to forget
+    # the delta.
     #
     # @param points [Array[Hash]] see #write()
     # @param openclose [Bool] see #write()
@@ -131,11 +146,12 @@ module Wavefront
       [points].flatten.map { |p| p.tap { p[:path] = DELTA + p[:path] } }
     end
 
-    def valid_point?(p)
+    # rubocop:disable Metrics/MethodLength
+    def valid_point?(point)
       return true if opts[:novalidate]
 
       begin
-        wf_point?(p)
+        wf_point?(point)
         return true
       rescue Wavefront::Exception::InvalidMetricName,
              Wavefront::Exception::InvalidMetricValue,
@@ -143,7 +159,7 @@ module Wavefront
              Wavefront::Exception::InvalidSourceId,
              Wavefront::Exception::InvalidTag => e
         log('Invalid point, skipping.', :info)
-        log("Invalid point: #{p}. (#{e})", :debug)
+        log("Invalid point: #{point}. (#{e})", :debug)
         summary[:rejected] += 1
         return false
       end
@@ -153,21 +169,22 @@ module Wavefront
     # https://community.wavefront.com/docs/DOC-1031.  No validation
     # is done here.
     #
-    # @param p [Hash] a hash describing a point. See #write() for
+    # @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(p)
-      unless p.key?(:path) && p.key?(:value)
+    def hash_to_wf(point)
+      unless point.key?(:path) && point.key?(:value)
         raise Wavefront::Exception::InvalidPoint
       end
 
-      p[:source] = HOSTNAME unless p.key?(:source)
+      p[:source] = HOSTNAME unless point.key?(:source)
 
-      m = [p[:path], p[:value]]
-      m.<< p[:ts] if p[:ts]
-      m.<< 'source=' + p[:source]
-      m.<< p[:tags].to_wf_tag if p[:tags]
+      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(' ')
     end
@@ -187,7 +204,7 @@ module Wavefront
 
       begin
         sock.puts(point)
-      rescue => e
+      rescue StandardError => e
         summary[:unsent] += 1
         log('WARNING: failed to send point.')
         log(e.to_s, :debug)
@@ -213,7 +230,7 @@ module Wavefront
 
       begin
         @sock = TCPSocket.new(net[:proxy], port)
-      rescue => e
+      rescue StandardError => e
         log(e, :error)
         raise Wavefront::Exception::InvalidEndpoint
       end
@@ -229,6 +246,13 @@ module Wavefront
 
     private
 
+    def _write_loop(points)
+      points.each do |p|
+        p[:ts] = p[:ts].to_i if p[:ts].is_a?(Time)
+        send_point(hash_to_wf(p))
+      end
+    end
+
     # Overload the method which sets an API endpoint. A proxy
     # endpoint has an address and a port, rather than an address and
     # a token.