wavefront-cli 2.3.1 → 2.4.0

data/lib/wavefront-cli/output/yaml.rb

@@ -0,0 +1,15 @@
+require_relative 'base'
+
+module WavefrontOutput
+  #
+  # Display as YAML
+  #
+  class Yaml < Base
+    # We don't want the YAML keys to be symbols, so we load it as
+    # JSON and turn *that* into YAML.
+    #
+    def run
+      puts JSON.parse(resp.to_json).to_yaml
+    end
+  end
+end

data/lib/wavefront-cli/report.rb

@@ -0,0 +1,15 @@
+require_relative 'base_write'
+
+module WavefrontCli
+  class Report < BaseWrite
+    def send_point(p)
+      wf.write(p)
+    rescue Wavefront::Exception::InvalidEndpoint
+      abort 'could not speak to API'
+    end
+
+    def open_connection; end
+
+    def close_connection; end
+  end
+end

data/lib/wavefront-cli/string.rb

@@ -34,7 +34,6 @@ class String
   #
   def fold(tw = TW, indent = 10, prefix = '')
     chunks = scan_line(tw - 8)
-
     first_line = format("%s%s\n", prefix, chunks.shift)
 
     return first_line if chunks.empty?
@@ -65,8 +64,20 @@ class String
     number.to_i * unit_factor(unit.to_sym)
   end
 
+  # How many seconds in the given unit
+  # @param unit [Symbol]
+  # @return [Integer]
+  #
   def unit_factor(unit)
     factors = { s: 1, m: 60, h: 3600, d: 86_400, w: 604_800 }
     factors[unit] || 1
   end
+
+  # Make a camelCase string be snake_case
+  # @return [String]
+  #
+  def to_snake
+    self.gsub(/(.)([A-Z])/) { Regexp.last_match[1] + '_' +
+                              Regexp.last_match[2].downcase }
+  end
 end

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '2.3.1'.freeze
+WF_CLI_VERSION = '2.4.0'.freeze

data/lib/wavefront-cli/write.rb

@@ -1,224 +1,15 @@
-require 'wavefront-sdk/mixins'
-require_relative './base'
+require_relative 'base_write'
 
 module WavefrontCli
   #
-  # Send points to a proxy.
+  # Send points via a proxy. This inherits from the same base class
+  # as Report, but has to do a couple of things differently, as it
+  # speaks to a proxy rather than to the API.
   #
-  class Write < Base
-    attr_reader :fmt
-    include Wavefront::Mixins
-
+  class Write < BaseWrite
     def mk_creds
       { proxy: options[:proxy], port: options[:port] || 2878 }
     end
-    def do_point
-      p = { path:  options[:'<metric>'],
-            value: options[:'<value>'].delete('\\').to_f,
-            tags:  tags_to_hash(options[:tag]) }
-
-      p[:source] = options[:host] if options[:host]
-      p[:ts] = parse_time(options[:time]) if options[:time]
-
-      begin
-        wf.write(p)
-      rescue Wavefront::Exception::InvalidEndpoint
-        abort 'could not speak to proxy ' \
-              "'#{options[:proxy]}:#{options[:port]}'."
-      end
-    end
-
-    def do_file
-      valid_format?(options[:infileformat])
-      setup_fmt(options[:infileformat] || 'tmv')
-      process_input(options[:'<file>'])
-    end
-
-    # Read the input, from a file or from STDIN, and turn each line
-    # into Wavefront points.
-    #
-    def process_input(file)
-      if file == '-'
-        read_stdin
-      else
-        data = load_data(Pathname.new(file)).split("\n").map do |l|
-          process_line(l)
-        end
-
-        wf.write(data)
-      end
-    end
-
-    # Read from standard in and stream points through an open
-    # socket. If the user hits ctrl-c, close the socket and exit
-    # politely.
-    #
-    def read_stdin
-      wf.open
-      STDIN.each_line { |l| wf.write(process_line(l.strip), false) }
-      wf.close
-    rescue SystemExit, Interrupt
-      puts 'ctrl-c. Exiting.'
-      wf.close
-      exit 0
-    end
-
-    # Find and return the value in a chunked line of input
-    #
-    # param chunks [Array] a chunked line of input from #process_line
-    # return [Float] the value
-    # raise TypeError if field does not exist
-    # raise Wavefront::Exception::InvalidValue if it's not a value
-    #
-    def extract_value(chunks)
-      v = chunks[fmt.index('v')]
-      v.to_f
-    end
-
-    # Find and return the source in a chunked line of input.
-    #
-    # param chunks [Array] a chunked line of input from #process_line
-    # return [Float] the timestamp, if it is there, or the current
-    #   UTC time if it is not.
-    # raise TypeError if field does not exist
-    #
-    def extract_ts(chunks)
-      ts = chunks[fmt.index('t')]
-      return parse_time(ts) if valid_timestamp?(ts)
-    rescue TypeError
-      Time.now.utc.to_i
-    end
-
-    def extract_tags(chunks)
-      tags_to_hash(chunks.last.split(/\s(?=(?:[^"]|"[^"]*")*$)/))
-    end
-
-    # Find and return the metric path in a chunked line of input.
-    # The path can be in the data, or passed as an option, or both.
-    # If the latter, then we assume the option is a prefix, and
-    # concatenate the value in the data.
-    #
-    # param chunks [Array] a chunked line of input from #process_line
-    # return [String] the metric path
-    # raise TypeError if field does not exist
-    #
-    def extract_path(chunks)
-      m = chunks[fmt.index('m')]
-      return options[:metric] ? [options[:metric], m].join('.') : m
-    rescue TypeError
-      return options[:metric] if options[:metric]
-      raise
-    end
-
-    # Find and return the source in a chunked line of input.
-    #
-    # param chunks [Array] a chunked line of input from #process_line
-    # return [String] the source, if it is there, or if not, the
-    #   value passed through by -H, or the local hostname.
-    #
-    def extract_source(chunks)
-      return chunks[fmt.index('s')]
-    rescue TypeError
-      options[:source] || Socket.gethostname
-    end
-
-    # Process a line of input, as described by the format string
-    # held in @fmt. Produces a hash suitable for the SDK to send on.
-    #
-    # We let the user define most of the fields, but anything beyond
-    # what they define is always assumed to be point tags.  This is
-    # because you can have arbitrarily many of those for each point.
-    #
-    def process_line(l)
-      return true if l.empty?
-      chunks = l.split(/\s+/, fmt.length)
-      raise 'wrong number of fields' unless enough_fields?(l)
-
-      begin
-        point = { path:  extract_path(chunks),
-                  value: extract_value(chunks) }
-        point[:ts] = extract_ts(chunks) if fmt.include?('t')
-        point[:source] = extract_source(chunks) if fmt.include?('s')
-        point[:tags] = line_tags(chunks)
-      rescue TypeError
-        raise "could not process #{l}"
-      end
-
-      point
-    end
-
-    # We can get tags from the file, from the -T option, or both.
-    # Merge them, making the -T win if there is a collision.
-    #
-    def line_tags(chunks)
-      file_tags = fmt.last == 'T' ? extract_tags(chunks) : {}
-      opt_tags = tags_to_hash(options[:tag])
-      file_tags.merge(opt_tags)
-    end
-
-    # Takes an array of key=value tags (as produced by docopt) and
-    # turns it into a hash of key: value tags.  Anything not of the
-    # form key=val is dropped.  If key or value are quoted, we
-    # remove the quotes.
-    #
-    # @param tags [Array]
-    # return Hash
-    #
-    def tags_to_hash(tags)
-      return nil unless tags
-
-      [tags].flatten.each_with_object({}) do |t, ret|
-        k, v = t.split('=', 2)
-        k.gsub!(/^["']|["']$/, '')
-        ret[k] = v.to_s.gsub(/^["']|["']$/, '') if v
-      end
-    end
-
-    # The format string must contain a 'v'. It must not contain
-    # anything other than 'm', 't', 'T', 's', or 'v', and the 'T',
-    # if there, must be at the end. No letter must appear more than
-    # once.
-    #
-    # @param fmt [String] format of input file
-    #
-    def valid_format?(fmt)
-      if fmt.include?('v') && fmt.match(/^[mstv]+T?$/) &&
-         fmt == fmt.split('').uniq.join
-        return true
-      end
-
-      raise 'Invalid format string.'
-    end
-
-    # Make sure we have the right number of columns, according to
-    # the format string. We want to take every precaution we can to
-    # stop users accidentally polluting their metric namespace with
-    # junk.
-    #
-    # If the format string says we are expecting point tags, we
-    # may have more columns than the length of the format string.
-    #
-    def enough_fields?(l)
-      ncols = l.split.length
-
-      if fmt.include?('T')
-        return false unless ncols >= fmt.length
-      else
-        return false unless ncols == fmt.length
-      end
-
-      true
-    end
-
-    # Although the SDK does value checking, we'll add another layer
-    # of input checing here.  See if the time looks valid. We'll
-    # assume anything before 2000/01/01 or after a year from now is
-    # wrong.  Arbitrary, but there has to be a cut-off somewhere.
-    #
-    def valid_timestamp?(ts)
-      (ts.is_a?(Integer) || ts.match(/^\d+$/)) &&
-        ts.to_i > 946_684_800 && ts.to_i < (Time.now.to_i + 31_557_600)
-    end
 
     def validate_opts
       unless options[:metric] || options[:format].include?('m')
@@ -228,15 +19,12 @@ module WavefrontCli
       raise 'Please supply a proxy address.' unless options[:proxy]
     end
 
-    private
-
-    def setup_fmt(fmt)
-      @fmt = fmt.split('')
+    def open_connection
+      wf.open
     end
 
-    def load_data(file)
-      raise "Cannot open file '#{file}'." unless file.exist?
-      IO.read(file)
+    def close_connection
+      wf.close
     end
   end
 end

data/spec/wavefront-cli/string_spec.rb

@@ -20,6 +20,17 @@ class StringTest < MiniTest::Test
                  'alpha] [-b beta] [-c gamma] <id>')
   end
 
+  def test_opt_fold
+    assert_equal('short string'.opt_fold, "  short string\n")
+
+    str = '-o, --option PARAMETER a rather pointless option with a ' \
+          'needlessly wordy description string'
+    pad = "\n" + ' ' * 12
+    assert_equal("  -o, --option PARAMETER a#{pad}rather pointless" \
+                 "#{pad}option with a#{pad}needlessly wordy#{pad}" \
+                 "description#{pad}string\n",str.opt_fold(30, 10))
+  end
+
   def test_fold_options
     str = '-l, --longoption    a long option with a quite long ' \
           'description which needs folding'
@@ -42,4 +53,17 @@ class StringTest < MiniTest::Test
     assert_raises(ArgumentError) { 'm'.to_seconds }
     assert_raises(ArgumentError) { '3m5s'.to_seconds }
   end
+
+  def test_unit_factor
+    assert_equal(60, '1'.unit_factor(:m))
+    assert_equal(1, '1'.unit_factor('m'))
+    assert_equal(1, '1'.unit_factor(:t))
+  end
+
+  def test_to_snake
+    assert_equal('snake_case', 'snakeCase'.to_snake)
+    assert_equal('lots_and_lots_of_words', 'lotsAndLotsOfWords'.to_snake)
+    assert_equal('unchanged', 'unchanged'.to_snake)
+    assert_equal('Unchanged', 'Unchanged'.to_snake)
+  end
 end

data/wavefront-cli.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = %w(lib)
 
   gem.add_dependency 'docopt', '~> 0.6.0'
-  gem.add_runtime_dependency 'wavefront-sdk', '~> 1.2', '>= 1.2.1'
+  gem.add_runtime_dependency 'wavefront-sdk', '~> 1.4', '>= 1.4.0'
 
   gem.add_development_dependency 'bundler', '~> 1.3'
   gem.add_development_dependency 'rake', '~> 12.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-24 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -30,20 +30,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +166,7 @@ files:
 - bin/wf
 - lib/wavefront-cli/alert.rb
 - lib/wavefront-cli/base.rb
+- lib/wavefront-cli/base_write.rb
 - lib/wavefront-cli/cloudintegration.rb
 - lib/wavefront-cli/commands/alert.rb
 - lib/wavefront-cli/commands/base.rb
@@ -179,6 +180,7 @@ files:
 - lib/wavefront-cli/commands/notificant.rb
 - lib/wavefront-cli/commands/proxy.rb
 - lib/wavefront-cli/commands/query.rb
+- lib/wavefront-cli/commands/report.rb
 - lib/wavefront-cli/commands/savedsearch.rb
 - lib/wavefront-cli/commands/source.rb
 - lib/wavefront-cli/commands/user.rb
@@ -204,6 +206,7 @@ files:
 - lib/wavefront-cli/display/printer/terse.rb
 - lib/wavefront-cli/display/proxy.rb
 - lib/wavefront-cli/display/query.rb
+- lib/wavefront-cli/display/report.rb
 - lib/wavefront-cli/display/savedsearch.rb
 - lib/wavefront-cli/display/source.rb
 - lib/wavefront-cli/display/user.rb
@@ -218,8 +221,19 @@ files:
 - lib/wavefront-cli/metric.rb
 - lib/wavefront-cli/notificant.rb
 - lib/wavefront-cli/opt_handler.rb
+- lib/wavefront-cli/output/base.rb
+- lib/wavefront-cli/output/hcl.rb
+- lib/wavefront-cli/output/hcl/alert.rb
+- lib/wavefront-cli/output/hcl/base.rb
+- lib/wavefront-cli/output/hcl/dashboard.rb
+- lib/wavefront-cli/output/hcl/notificant.rb
+- lib/wavefront-cli/output/json.rb
+- lib/wavefront-cli/output/ruby.rb
+- lib/wavefront-cli/output/wavefront.tf
+- lib/wavefront-cli/output/yaml.rb
 - lib/wavefront-cli/proxy.rb
 - lib/wavefront-cli/query.rb
+- lib/wavefront-cli/report.rb
 - lib/wavefront-cli/savedsearch.rb
 - lib/wavefront-cli/source.rb
 - lib/wavefront-cli/string.rb