wavefront-cli 5.1.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2500c3c1046355e74eaa41f1e612a2f05054ffc54f752f79cac8f4c8f47dfd07
-  data.tar.gz: 9676df59ed6592399703de971ea8b2f691fe09443c74147d60096b3789d83ae5
+  metadata.gz: 44f481275247e98780e57065df2166e93158382c03dea0d9dbc627b2d1756777
+  data.tar.gz: b225b2ba3668cc00c6e3e873064bcf54b79c1dbc6638009cba09cfb6de7874c8
 SHA512:
-  metadata.gz: 441cf573c9c17603679bd39d3b1f9d0dcf15ca0fc68f8f0b72fa2969fc9384931d9b549e54b0659e5103f0f09f04d50b45987758ddcd54115ceb450bda832366
-  data.tar.gz: d4236668320cc4167100784cc7c265c22a5d6bddf5e1a44da54c4b20c8b657e782582046551989800b0c4548f611c06aa900f5eb5ed3daaa46e1472d62f0f35a
+  metadata.gz: 42c775a15f3a74a7ffbaa45ebff0d38755996c64afeca494496c4707a26734733e6f18f7469be9ac3b82786697e1d773748057c96789ea470e8a7d8022c851f1
+  data.tar.gz: 1945c8a72ce0cc6fb6c4cdda8a8f8baabad6f020175d25f8109fb240f58c3cf175cd1b846c9fc7830c6bba31356f83975e69eac8736b3cf7aa0fbf7c88d8d7fb

data/HISTORY.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 5.2.1 (2020-02-20)
+* Say whether `--upsert` did and update or an import.
+
 ## 5.1.0 (2020-02-20)
 * Add `-U` (`--upsert`) option to `import` sub-commands.
 

data/lib/wavefront-cli/base.rb

@@ -46,7 +46,7 @@ module WavefrontCli
     end
 
     # Normally we map the class name to a similar one in the SDK.
-    # Overriding his method lets you map to something else.
+    # Overriding this method lets you map to something else.
     #
     def _sdk_class
       self.class.name.sub(/Cli/, '')
@@ -349,60 +349,6 @@ module WavefrontCli
       raise(WavefrontCli::Exception::CredentialError, 'Missing API endpoint.')
     end
 
-    # Give it a path to a file (as a string) and it will return the
-    # contents of that file as a Ruby object. Automatically detects
-    # JSON and YAML. Raises an exception if it doesn't look like
-    # either. If path is '-' then it will read STDIN.
-    #
-    # @param path [String] the file to load
-    # @return [Hash] a Ruby object of the loaded file
-    # @raise WavefrontCli::Exception::UnsupportedFileFormat if the
-    #   filetype is unknown.
-    # @raise pass through any error loading or parsing the file
-    #
-    def load_file(path)
-      return load_from_stdin if path == '-'
-
-      file = Pathname.new(path)
-      extname = file.extname.downcase
-
-      raise WavefrontCli::Exception::FileNotFound unless file.exist?
-
-      return load_json(file) if extname == '.json'
-      return load_yaml(file) if %w[.yaml .yml].include?(extname)
-
-      raise WavefrontCli::Exception::UnsupportedFileFormat
-    end
-
-    def load_json(file)
-      read_json(IO.read(file))
-    end
-
-    def load_yaml(file)
-      read_yaml(IO.read(file))
-    end
-
-    # Read STDIN and return a Ruby object, assuming that STDIN is
-    # valid JSON or YAML. This is a dumb method, it does no
-    # buffering, so STDIN must be a single block of data. This
-    # appears to be a valid assumption for use-cases of this CLI.
-    #
-    # @return [Object]
-    # @raise Wavefront::Exception::UnparseableInput if the input
-    #   does not parse
-    #
-    def load_from_stdin
-      raw = STDIN.read
-
-      if raw.start_with?('---')
-        read_yaml(raw)
-      else
-        read_json(raw)
-      end
-    rescue RuntimeError
-      raise Wavefront::Exception::UnparseableInput
-    end
-
     # Below here are common methods. Most are used by most classes,
     # but if they don't match a command described in the docopt
     # text, the dispatcher will never call them. So, there's no
@@ -451,50 +397,8 @@ module WavefrontCli
     end
 
     def do_import
-      raw = load_file(options[:'<file>'])
-      errs = 0
-
-      [raw].flatten.each do |obj|
-        resp = import_object(obj)
-        next if options[:noop]
-
-        errs += 1 unless resp.ok?
-        puts import_message(obj, resp)
-      end
-
-      exit errs
-    end
-
-    def import_message(obj, resp)
-      format('%-15<id>s %-10<status>s %<message>s',
-             id: obj[:id] || obj[:url],
-             status: resp.ok? ? 'IMPORTED' : 'FAILED',
-             message: resp.status.message)
-    end
-
-    def import_object(raw)
-      raw = preprocess_rawfile(raw) if respond_to?(:preprocess_rawfile)
-      prepped = import_to_create(raw)
-
-      if options[:upsert]
-        import_upsert(raw, prepped)
-      elsif options[:update]
-        import_update(raw)
-      else
-        wf.create(prepped)
-      end
-    end
-
-    def import_upsert(raw, prepped)
-      update_call = import_update(raw)
-      return update_call if update_call.ok?
-
-      puts 'update failed, inserting' if options[:verbose] || options[:debug]
-      wf.create(prepped)
-    end
-
-    def import_update(raw)
-      wf.update(raw[:id], raw, false)
+      require_relative 'subcommands/import'
+      WavefrontCli::Subcommand::Import.new(self, options).run!
     end
 
     def do_delete
@@ -604,18 +508,6 @@ module WavefrontCli
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/CyclomaticComplexity
 
-    # Most things will re-import with the POST method if you remove
-    # the ID.
-    #
-    def import_to_create(raw)
-      raw.each_with_object({}) do |(k, v), a|
-        a[k.to_sym] = v unless k == :id
-      end
-    rescue StandardError => e
-      puts e if options[:debug]
-      raise WavefrontCli::Exception::UnparseableInput
-    end
-
     # Return a detailed description of one item, if an ID has been
     # given, or all items if it has not.
     #
@@ -665,14 +557,16 @@ module WavefrontCli
     end
     # rubocop:enable Metrics/MethodLength
 
-    private
-
-    def read_json(io)
-      JSON.parse(io, symbolize_names: true)
-    end
-
-    def read_yaml(io)
-      YAML.safe_load(io, symbolize_names: true)
+    # Most things will re-import with the POST method if you remove
+    # the ID.
+    #
+    def import_to_create(raw)
+      raw.each_with_object({}) do |(k, v), a|
+        a[k.to_sym] = v unless k == :id
+      end
+    rescue StandardError => e
+      puts e if options[:debug]
+      raise WavefrontCli::Exception::UnparseableInput
     end
   end
 end

data/lib/wavefront-cli/helpers/load_file.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative '../exception'
+
+module WavefrontCli
+  module Helper
+    #
+    # Give it a path to a file (as a string) and it will return the
+    # contents of that file as a Ruby object. Automatically detects
+    # JSON and YAML. Raises an exception if it doesn't look like
+    # either. If path is '-' then it will read STDIN.
+    #
+    # @param path [String] the file to load
+    # @return [Hash] a Ruby object of the loaded file
+    # @raise WavefrontCli::Exception::UnsupportedFileFormat if the
+    #   filetype is unknown.
+    # @raise pass through any error loading or parsing the file
+    #
+    class LoadFile
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+      end
+
+      def load
+        return load_from_stdin if path == '-'
+
+        file = Pathname.new(path)
+        extname = file.extname.downcase
+
+        raise WavefrontCli::Exception::FileNotFound unless file.exist?
+
+        return load_json(file) if extname == '.json'
+        return load_yaml(file) if %w[.yaml .yml].include?(extname)
+
+        raise WavefrontCli::Exception::UnsupportedFileFormat
+      end
+
+      private
+
+      def load_json(file)
+        read_json(IO.read(file))
+      end
+
+      def load_yaml(file)
+        read_yaml(IO.read(file))
+      end
+
+      # Read STDIN and return a Ruby object, assuming that STDIN is
+      # valid JSON or YAML. This is a dumb method, it does no
+      # buffering, so STDIN must be a single block of data. This
+      # appears to be a valid assumption for use-cases of this CLI.
+      #
+      # @return [Object]
+      # @raise Wavefront::Exception::UnparseableInput if the input
+      #   does not parse
+      #
+      def load_from_stdin
+        raw = STDIN.read
+
+        if raw.start_with?('---')
+          read_yaml(raw)
+        else
+          read_json(raw)
+        end
+      rescue RuntimeError
+        raise Wavefront::Exception::UnparseableInput
+      end
+
+      def read_json(io)
+        JSON.parse(io, symbolize_names: true)
+      end
+
+      def read_yaml(io)
+        YAML.safe_load(io, symbolize_names: true)
+      end
+    end
+  end
+end

data/lib/wavefront-cli/subcommands/import.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/load_file'
+
+module WavefrontCli
+  module Subcommand
+    #
+    # Stuff to import an object
+    #
+    class Import
+      attr_reader :wf, :options
+
+      def initialize(calling_class, options)
+        @calling_class = calling_class
+        @wf = calling_class.wf
+        @options = options
+        @message = 'IMPORTED'
+      end
+
+      def run!
+        errs = 0
+
+        [raw_input].flatten.each do |obj|
+          resp = import_object(obj)
+          next if options[:noop]
+
+          errs += 1 unless resp.ok?
+          puts import_message(obj, resp)
+        end
+
+        exit errs
+      end
+
+      private
+
+      def raw_input
+        WavefrontCli::Helper::LoadFile.new(options[:'<file>']).load
+      end
+
+      def import_message(obj, resp)
+        format('%-15<id>s %-10<status>s %<message>s',
+               id: obj[:id] || obj[:url],
+               status: resp.ok? ? @message : 'FAILED',
+               message: resp.status.message)
+      end
+
+      def import_object(raw)
+        raw = preprocess_rawfile(raw) if respond_to?(:preprocess_rawfile)
+        prepped = @calling_class.import_to_create(raw)
+
+        if options[:upsert]
+          import_upsert(raw, prepped)
+        elsif options[:update]
+          @message = 'UPDATED'
+          import_update(raw)
+        else
+          wf.create(prepped)
+        end
+      end
+
+      def import_upsert(raw, prepped)
+        update_call = import_update(raw)
+
+        if update_call.ok?
+          @message = 'UPDATED'
+          return update_call
+        end
+
+        puts 'update failed, inserting' if options[:verbose] || options[:debug]
+        wf.create(prepped)
+      end
+
+      def import_update(raw)
+        wf.update(raw[:id], raw, false)
+      end
+    end
+  end
+end

data/lib/wavefront-cli/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-WF_CLI_VERSION = '5.1.0'
+WF_CLI_VERSION = '5.1.1'

data/spec/test_mixins/import.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../../lib/wavefront-cli/helpers/load_file'
+
 module WavefrontCliTest
   #
   # Mixin to test standard 'import' commands
@@ -25,7 +27,7 @@ module WavefrontCliTest
       assert_abort_on_missing_creds("import #{import_file}")
     end
 
-    def test_import_update
+    def _test_import_update
       Spy.teardown
 
       out, err = capture_io do
@@ -38,15 +40,19 @@ module WavefrontCliTest
       end
 
       assert_empty(err)
-      assert_equal('1556812163465   IMPORTED', out.strip)
+      assert_equal('1556812163465   UPDATED', out.strip)
 
       assert_exits_with('File not found.', 'import /no/such/file')
       assert_usage('import -u')
       assert_abort_on_missing_creds("import -u #{import_file}")
     end
 
+    def load_file(file)
+      WavefrontCli::Helper::LoadFile.new(file).load
+    end
+
     def test_import_fields
-      x = cmd_instance.import_to_create(cmd_instance.load_file(import_file))
+      x = cmd_instance.import_to_create(load_file(import_file))
       assert_instance_of(Hash, x)
       import_fields.each { |f| assert_includes(x.keys, f) }
       blocked_import_fields.each { |f| refute_includes(x.keys, f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.1
 platform: ruby
 authors:
 - Robert Fisher
@@ -239,6 +239,7 @@ files:
 - lib/wavefront-cli/event.rb
 - lib/wavefront-cli/exception.rb
 - lib/wavefront-cli/externallink.rb
+- lib/wavefront-cli/helpers/load_file.rb
 - lib/wavefront-cli/ingestionpolicy.rb
 - lib/wavefront-cli/integration.rb
 - lib/wavefront-cli/maintenancewindow.rb
@@ -272,6 +273,7 @@ files:
 - lib/wavefront-cli/spy.rb
 - lib/wavefront-cli/stdlib/array.rb
 - lib/wavefront-cli/stdlib/string.rb
+- lib/wavefront-cli/subcommands/import.rb
 - lib/wavefront-cli/usage.rb
 - lib/wavefront-cli/user.rb
 - lib/wavefront-cli/usergroup.rb