wavefront-cli 3.3.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ce4081f6a736ace3019e5c4fc3cadcc91d04e028ea4f04a034250ccef7afc14
-  data.tar.gz: 3c00162398ae62804cde46e1cfc7e058d953f22566cd72d63df799e78f0cbf69
+  metadata.gz: 5ef777d9892feec5a1f016e2a1129826735181bd3ce15a6a83942743606be0e9
+  data.tar.gz: dd49d2872f08535cf2dfe5d0f3780b80cdeea956827acfd817445819de7dcb78
 SHA512:
-  metadata.gz: fc66b3ce0e7f6942516c79bbed8f93f97d57e4adc3b84f40770bf49a00d26f943e94007307edb5eb71542aaec023374acab623d0fbd712bcc5ed22cb7cf69501
-  data.tar.gz: c5263da338dc6472e6beb7d9c221fa30036e8fcbc825ec7d39b4f1688fb75f65a3dd6b68f022c82885a4f906727cd5cd06e4ca90516830218958669cae73b512
+  metadata.gz: 91ecc6b341a68759e76e5ec95f694873cd9f8b88cd1bae3a40b2a354c9dd9952550f185c43211475fe146f2ab00446c61e364cef02c4bb1921d56f1ff0c173b1
+  data.tar.gz: 881eba75e3660ae2a0550f946c0324337e410340693821f0ce581a62ef6d29ce7fbb6437d97d9ba427ba4fa27a754b61c5ef9d75369885e1be01d62bf2a47d64

data/HISTORY.md

@@ -1,16 +1,27 @@
 # Changelog
 
+## 4.0.1 (18/06/2019)
+* `update` subcommand has been changed to `set`. (Breaking change.)
+* `import` subcommand now accepts `--update` (`-u`) option, which
+  lets you overwrite an existing object with a JSON or YAML
+  description.
+* Fix `tag searchpath` bug.
+
+## 4.0.0 (18/06/2019)
+
+* Failed push to Gemfury. Does not exist.
+
 ## 3.3.0 (10/06/2019)
-* Support negation searches. Search for alerts with targets *not* containing
-  `str` with `wf alert search target!~str`.
-* Add `tag pathsearch` command. Searches for tags whose hierarchical names
-  begin with the given element(s).
-* Better printing of structured search results. For example `wf alert search
-  tags=X`.
-* Support freetext searches. Use `wf <object> search freetext=string` and you
-  will be given a list of the objects which match the search along with the
-  matching keys. (Not values!) Adding `-l` presents all matching objects in
-  full.
+* Support negation searches. Search for alerts with targets *not*
+  containing `str` with `wf alert search target!~str`.
+* Add `tag pathsearch` command. Searches for tags whose hierarchical
+  names begin with the given element(s).
+* Better printing of structured search results. For example `wf
+  alert search tags=X`.
+* Support freetext searches. Use `wf <object> search
+  freetext=string` and you will be given a list of the objects which
+  match the search along with the matching keys. (Not values!)
+  Adding `-l` presents all matching objects in full.
 
 ## 3.2.3 (24/05/2019)
 * Don't print erroneous pagination message when using `list --all`.

data/README.md

@@ -40,10 +40,10 @@ Commands:
   integration        view and manage Wavefront integrations
   link               view and manage external links
   message            read and mark user messages
-  metric             view metrics
+  metric             get metric details
   notificant         view and manage Wavefront alert targets
-  proxy              view and manage Wavefront proxies
-  query              query the Wavefront API
+  proxy              view and manage proxies
+  query              run Wavefront queries
   savedsearch        view and manage saved searches
   settings           view and manage system preferences
   source             view and manage source tags and descriptions
@@ -174,7 +174,8 @@ sysdef.limited@gmail.com
 ```
 
 You could, of course, modify certain aspects of the exported data before
-re-importing.
+re-importing. You can import an object over the top of an existing
+one with `import --update`.
 
 ### Time Windows
 
@@ -204,7 +205,7 @@ the last ten minutes.
 Use the `query` subcommand with any timeseries expression.
 
 ```
- ./wf query "ts(cpu.*.pc.user, source=cube)" | more
+$ wf query "ts(cpu.*.pc.user, source=cube)" | more
 name          ts(cpu.*.pc.user, source=cube)
 query         ts(cpu.*.pc.user, source=cube)
 timeseries

data/lib/wavefront-cli/base.rb

@@ -393,7 +393,15 @@ module WavefrontCli
         raise WavefrontCli::Exception::UnparseableInput
       end
 
-      wf.create(prepped)
+      if options[:update]
+        import_update(raw)
+      else
+        wf.create(prepped)
+      end
+    end
+
+    def import_update(raw)
+      wf.update(raw['id'], raw, false)
     end
 
     def do_delete
@@ -419,7 +427,7 @@ module WavefrontCli
       wf.undelete(options[:'<id>'])
     end
 
-    def do_update
+    def do_set
       cannot_noop!
       k, v = options[:'<key=value>'].split('=', 2)
       wf.update(options[:'<id>'], k => v)

data/lib/wavefront-cli/command_mixins/tag.rb

@@ -28,7 +28,7 @@ module WavefrontCli
         require 'wavefront-sdk/search'
         wfs = Wavefront::Search.new(mk_creds, mk_opts)
 
-        query = { key: 'tags',
+        query = { key: 'tagpath',
                   value: options[:'<word>'],
                   matchingMethod: 'TAGPATH',
                   negated: false }

data/lib/wavefront-cli/commands/alert.rb

@@ -3,10 +3,6 @@ require_relative 'base'
 # Define the Alert command
 #
 class WavefrontCommandAlert < WavefrontCommandBase
-  def description
-    'view and manage alerts'
-  end
-
   def _commands
     ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
      "firing #{CMN} [-o offset] [-L limit]",
@@ -18,9 +14,9 @@ class WavefrontCommandAlert < WavefrontCommandBase
      "history #{CMN} [-o offset] [-L limit] <id>",
      "clone #{CMN} [-v version] <id>",
      "latest #{CMN} <id>",
-     "import #{CMN} <file>",
+     "import #{CMN} [-u] <file>",
      "snooze #{CMN} [-T time] <id>",
-     "update #{CMN} <key=value> <id>",
+     "set #{CMN} <key=value> <id>",
      "unsnooze #{CMN} <id>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>...",
      tag_commands,
@@ -34,14 +30,14 @@ class WavefrontCommandAlert < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-l, --long               list alerts in detail',
-     '-a, --all                list all alerts',
-     '-v, --version=INTEGER    describe only this version of alert',
-     '-o, --offset=n           start from nth alert',
-     '-L, --limit=COUNT        number of alerts to list',
+     "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
+     "-v, --version=INTEGER    describe only this version of #{thing}",
+     "-o, --offset=n           start from nth #{thing}",
+     "-L, --limit=COUNT        number of #{things} to list",
      '-O, --fields=F1,F2,...   only show given fields',
+     "-u, --update             update an existing #{thing}",
      '-T, --time=SECONDS       how long to snooze (default 3600)',
-     '-b, --brief              do not show alert names',
-     '-f, --format=STRING      output format']
+     "-b, --brief              do not show #{thing} names"]
   end
 end

data/lib/wavefront-cli/commands/apitoken.rb

@@ -3,8 +3,8 @@ require_relative 'base'
 # Define the apitoken command.
 #
 class WavefrontCommandApitoken < WavefrontCommandBase
-  def description
-    'view and manage API tokens'
+  def thing
+    'API token'
   end
 
   def sdk_file
@@ -25,7 +25,6 @@ class WavefrontCommandApitoken < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-O, --fields=F1,F2,...  only show given fields',
-     '-f, --format=STRING   output format']
+     '-O, --fields=F1,F2,...  only show given fields']
   end
 end

data/lib/wavefront-cli/commands/base.rb

@@ -6,6 +6,10 @@ CMN = '[-DnV] [-c file] [-P profile] [-E endpoint] [-t token] ' \
 # A base class which all command classes extend.
 #
 class WavefrontCommandBase
+  def description
+    "view and manage #{things}"
+  end
+
   # All commands have these options
   # @return [Array]
   #
@@ -15,6 +19,7 @@ class WavefrontCommandBase
      '-D, --debug          enable debug mode',
      '-n, --noop           do not perform API calls',
      '-V, --verbose        be verbose',
+     '-f, --format=STRING  output format',
      '-h, --help           show this message']
   end
 
@@ -68,6 +73,14 @@ class WavefrontCommandBase
     self.class.name.sub(/WavefrontCommand/, '').downcase
   end
 
+  def thing
+    word
+  end
+
+  def things
+    thing + 's'
+  end
+
   # @return [String] the name of the SDK class which does the work
   #   for this command.
   #

data/lib/wavefront-cli/commands/cloudintegration.rb

@@ -3,8 +3,8 @@ require_relative 'base'
 # Define the cloud integration command.
 #
 class WavefrontCommandCloudintegration < WavefrontCommandBase
-  def description
-    'view and manage cloud integrations'
+  def thing
+    'cloud integration'
   end
 
   def sdk_file
@@ -22,17 +22,17 @@ class WavefrontCommandCloudintegration < WavefrontCommandBase
      "undelete #{CMN} <id>",
      "enable #{CMN} <id>",
      "disable #{CMN} <id>",
-     "import #{CMN} <file>",
+     "import #{CMN} [-u] <file>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
-     '-l, --long              list cloud integrations in detail',
-     '-a, --all               list all cloud integrations',
-     '-o, --offset=n          start from nth cloud integration',
-     '-O, --fields=F1,F2,...  only show given fields',
-     '-L, --limit=COUNT       number of cloud integrations to list',
-     '-f, --format=STRING     output format']
+     "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
+     "-o, --offset=n           start from nth #{thing}",
+     '-O, --fields=F1,F2,...   only show given fields',
+     "-L, --limit=COUNT        number of #{things} to list",
+     "-u, --update             update an existing #{thing}"]
   end
 end

data/lib/wavefront-cli/commands/dashboard.rb

@@ -3,15 +3,11 @@ require_relative 'base'
 # Define the dashboard command.
 #
 class WavefrontCommandDashboard < WavefrontCommandBase
-  def description
-    'view and manage dashboards'
-  end
-
   def _commands
     ["list #{CMN} [-alN] [-O fields] [-o offset] [-L limit]",
      "describe #{CMN} [-v version] <id>",
-     "import #{CMN} <file>",
-     "update #{CMN} <key=value> <id>",
+     "import #{CMN} [-u] <file>",
+     "set #{CMN} <key=value> <id>",
      "delete #{CMN} <id>",
      "undelete #{CMN} <id>",
      "history #{CMN} [-o offset] [-L limit] <id>",
@@ -26,14 +22,15 @@ class WavefrontCommandDashboard < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-l, --long               list dashboards in detail',
-     '-a, --all                list all dashboards',
-     '-o, --offset=n           start list from nth dashboard or revision',
+     "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
+     "-o, --offset=n           start list from nth #{thing} or revision",
+     "-L, --limit=COUNT        number of #{things} or revisions to list",
      '-O, --fields=F1,F2,...   only show given fields',
-     '-L, --limit=COUNT        number of dashboards or revisions to list',
-     '-v, --version=INTEGER    version of dashboard',
-     '-b, --brief              do not show dashboard names',
-     '-N, --no-system          do not show system-owned dashboards',
-     '-f, --format=STRING      output format']
+     "-u, --update             update an existing #{thing}",
+     '-T, --time=SECONDS       how long to snooze (default 3600)',
+     "-v, --version=INTEGER    version of #{thing}",
+     "-b, --brief              do not show #{thing} names",
+     "-N, --no-system          do not show system-owned #{things}"]
   end
 end

data/lib/wavefront-cli/commands/derivedmetric.rb

@@ -3,8 +3,8 @@ require_relative 'base'
 # Define the derivedmetric command.
 #
 class WavefrontCommandDerivedmetric < WavefrontCommandBase
-  def description
-    'view and manage derived metrics'
+  def thing
+    'derived metric'
   end
 
   def sdk_file
@@ -20,8 +20,8 @@ class WavefrontCommandDerivedmetric < WavefrontCommandBase
      "describe #{CMN} [-v version] <id>",
      "create #{CMN} [-d description] [-T tag...] [-b] [-i interval] " \
      '[-r range] <name> <query>',
-     "import #{CMN} <file>",
-     "update #{CMN} <key=value> <id>",
+     "import #{CMN} [-u] <file>",
+     "set #{CMN} <key=value> <id>",
      "delete #{CMN} <id>",
      "undelete #{CMN} <id>",
      "history #{CMN} [-o offset] [-L limit] <id>",
@@ -31,20 +31,18 @@ class WavefrontCommandDerivedmetric < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-l, --long              list derived metrics in detail',
-     '-a, --all               list all derived metrics',
-     '-o, --offset=n          start list from nth derived metrics or ' \
-                              'revision',
+     "-l, --long              list #{things} in detail",
+     "-a, --all               list all #{things}",
+     "-v, --version=INTEGER   describe only this version of #{thing}",
+     "-o, --offset=n          start from nth #{thing} or revision",
+     "-L, --limit=COUNT       number of #{things} or revisions to list",
      '-O, --fields=F1,F2,...  only show given fields',
-     '-L, --limit=COUNT       number of derived metrics or revisions to ' \
-                              'list',
-     '-v, --version=INTEGER   version of derived metrics',
      '-b, --obsolete          include obsolete metrics',
      '-T, --ctag=STRING       add customer tag',
      '-d, --desc=STRING       additional information about query',
      '-i, --interval=INTEGER  execute query every n minutes [default: 1]',
      '-r, --range=INTEGER     include results in the last n minutes ' \
                               '[default: 5]',
-     '-f, --format=STRING   output format']
+     "-u, --update             update an existing #{thing}"]
   end
 end

data/lib/wavefront-cli/commands/event.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 #
 class WavefrontCommandEvent < WavefrontCommandBase
   def description
-    'open, close, view, and manage events'
+    "open, close, view, and manage #{things}"
   end
 
   def _commands
@@ -15,7 +15,7 @@ class WavefrontCommandEvent < WavefrontCommandBase
      '[-S severity] [-T type] [-H host...] [-g tag...] [-N] <event>',
      "close #{CMN} [<id>]",
      "delete #{CMN} <id>",
-     "update #{CMN} <key=value> <id>",
+     "set #{CMN} <key=value> <id>",
      "search #{CMN} [-o offset] [-L limit] [-l] <condition>...",
      "wrap #{CMN} [-C command] [-d description] [-S severity] [-T type] " \
      '[-H host...] [-g tag...] <event>',
@@ -25,26 +25,25 @@ class WavefrontCommandEvent < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-l, --long                list events in detail',
-     '-o, --cursor=EVENT        start listing from given event',
+     "-l, --long                list #{things} in detail",
+     "-o, --cursor=EVENT        start listing from given #{thing}",
      '-O, --fields=F1,F2,...    only show given fields',
-     '-L, --limit=COUNT         number of events to list',
-     '-s, --start=TIME          time at which event begins',
-     '-e, --end=TIME            time at which event ends',
-     '-S, --severity=SEVERITY   severity of event',
-     '-i, --instant             create an instantaneous event',
-     '-T, --type=TYPE           type of event',
-     '-d, --desc=STRING         description of event',
-     '-H, --host=STRING         source to which event applies',
+     "-L, --limit=COUNT         number of #{things} to list",
+     "-s, --start=TIME          time at which #{thing} begins",
+     "-e, --end=TIME            time at which #{thing} ends",
+     "-S, --severity=SEVERITY   severity of #{thing}",
+     "-i, --instant             create an instantaneous #{thing}",
+     "-T, --type=TYPE           type of #{thing}",
+     "-d, --desc=STRING         description of #{thing}",
+     "-H, --host=STRING         source to which #{thing} applies",
      '-N, --nostate             do not create a local file recording ' \
-     'the event',
-     '-g, --evtag=TAG           event tag',
-     '-C, --command=COMMAND     command to run',
-     '-f, --format=STRING       output format']
+     "the #{thing}",
+     "-g, --evtag=TAG           #{thing} tag",
+     '-C, --command=COMMAND     command to run']
   end
 
   def postscript
-    "View events in detail using the 'query' command with the " \
+    "View #{things} in detail using the 'query' command with the " \
       "'events()' function."
   end
 end

data/lib/wavefront-cli/commands/integration.rb

@@ -1,10 +1,10 @@
 require_relative 'base'
 
-# Define the cloud integration command.
+# Define the integration command.
 #
 class WavefrontCommandIntegration < WavefrontCommandBase
   def description
-    'view and manage Wavefront integrations'
+    "view and manage Wavefront #{things}"
   end
 
   def _commands
@@ -24,11 +24,10 @@ class WavefrontCommandIntegration < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-l, --long               list cloud integrations in detail',
-     '-a, --all                list all cloud integrations',
-     '-o, --offset=n           start from nth cloud integration',
+     "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
+     "-o, --offset=n           start from nth #{thing}",
      '-O, --fields=F1,F2,...   only show given fields',
-     '-L, --limit=COUNT        number of cloud integrations to list',
-     '-f, --format=STRING      output format']
+     "-L, --limit=COUNT        number of #{things} to list"]
   end
 end

data/lib/wavefront-cli/commands/link.rb

@@ -3,8 +3,8 @@ require_relative 'base'
 # Define the external link command.
 #
 class WavefrontCommandLink < WavefrontCommandBase
-  def description
-    'view and manage external links'
+  def thing
+    'external link'
   end
 
   def sdk_file
@@ -21,21 +21,21 @@ class WavefrontCommandLink < WavefrontCommandBase
      "create #{CMN} [-m regex] [-s regex] [-p str=regex...] <name> " \
      '<description> <template>',
      "delete #{CMN} <id>",
-     "import #{CMN} <file>",
-     "update #{CMN} <key=value> <id>",
+     "import #{CMN} [-u] <file>",
+     "set #{CMN} <key=value> <id>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
-     '-l, --long               list external links in detail',
-     '-a, --all                list all external links',
-     '-o, --offset=n           start from nth external link',
+     "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
+     "-o, --offset=n           start from nth #{thing}",
      '-O, --fields=F1,F2,...   only show given fields',
-     '-L, --limit=COUNT        number of external link to list',
+     "-L, --limit=COUNT        number of #{thing} to list",
      '-m, --metric-regex=REGEX metric filter regular expression',
      '-s, --source-regex=REGEX source filter regular expression',
      '-p, --point-regex=REGEX  point filter regular expression',
-     '-f, --format=STRING      output format']
+     "-u, --update             update an existing #{thing}"]
   end
 end

data/lib/wavefront-cli/commands/message.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 #
 class WavefrontCommandMessage < WavefrontCommandBase
   def description
-    'read and mark user messages'
+    "read and mark user #{things}"
   end
 
   def _commands
@@ -15,11 +15,10 @@ class WavefrontCommandMessage < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-l, --long              list messages in detail',
-     '-o, --offset=n          start from nth message',
+     "-l, --long              list #{things} in detail",
+     "-o, --offset=n          start from nth #{thing}",
      '-O, --fields=F1,F2,...  only show given fields',
-     '-L, --limit=COUNT       number of messages to list',
-     '-a, --all               list all messages, not just unread',
-     '-f, --format=STRING     output format']
+     "-L, --limit=COUNT       number of #{things} to list",
+     "-a, --all               list all #{things}, not just unread"]
   end
 end

data/lib/wavefront-cli/commands/metric.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 #
 class WavefrontCommandMetric < WavefrontCommandBase
   def description
-    'view metrics'
+    "get #{thing} details"
   end
 
   def _commands
@@ -14,7 +14,6 @@ class WavefrontCommandMetric < WavefrontCommandBase
   def _options
     [common_options,
      '-o, --offset=STRING      value to start from if results > 1000',
-     '-g, --glob=STRING        return sources matching this pattern',
-     '-f, --format=STRING      output format']
+     '-g, --glob=STRING        return sources matching this pattern']
   end
 end

data/lib/wavefront-cli/commands/notificant.rb

@@ -3,27 +3,31 @@ require_relative 'base'
 # Define the notificant command.
 #
 class WavefrontCommandNotificant < WavefrontCommandBase
+  def thing
+    'alert target'
+  end
+
   def description
-    'view and manage Wavefront alert targets'
+    "view and manage Wavefront #{things}"
   end
 
   def _commands
     ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
      "describe #{CMN} <id>",
-     "import #{CMN} <file>",
+     "import #{CMN} [-u] <file>",
      "delete #{CMN} <id>",
      "test #{CMN} <id>",
-     "update #{CMN} <key=value> <id>",
+     "set #{CMN} <key=value> <id>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
-     '-l, --long                list alert targets in detail',
-     '-a, --all                 list all alert targets',
-     '-o, --offset=n            start from nth alert target',
-     '-O, --fields=F1,F2,...    only show given fields',
-     '-f, --format=STRING       output format',
-     '-L, --limit=COUNT         number of alert targets to list']
+     "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
+     "-o, --offset=n           start from nth #{thing}",
+     '-O, --fields=F1,F2,...   only show given fields',
+     "-L, --limit=COUNT        number of #{things} to list",
+     "-u, --update             update an existing #{thing}"]
   end
 end

data/lib/wavefront-cli/commands/proxy.rb

@@ -3,8 +3,8 @@ require_relative 'base'
 # Define the proxy command.
 #
 class WavefrontCommandProxy < WavefrontCommandBase
-  def description
-    'view and manage Wavefront proxies'
+  def things
+    'proxies'
   end
 
   def _commands
@@ -19,11 +19,10 @@ class WavefrontCommandProxy < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-l, --long                list proxies in detail',
-     '-a, --all                 list all proxies',
-     '-o, --offset=n            start from nth proxy',
+     "-l, --long                list #{things} in detail",
+     "-a, --all                 list all #{things}",
+     "-o, --offset=n            start from nth #{thing}",
      '-O, --fields=F1,F2,...    only show given fields',
-     '-f, --format=STRING       output format',
-     '-L, --limit=COUNT         number of proxies to list']
+     "-L, --limit=COUNT         number of #{things} to list"]
   end
 end

data/lib/wavefront-cli/commands/query.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 #
 class WavefrontCommandQuery < WavefrontCommandBase
   def description
-    'query the Wavefront API'
+    'run Wavefront queries'
   end
 
   def _commands
@@ -31,7 +31,6 @@ class WavefrontCommandQuery < WavefrontCommandBase
      'points (mean, median, min, max, sum, count, last, first)',
      '-O, --obsolete            include metrics unreported for > 4 weeks',
      '-H, --host=STRING         host or source to query on',
-     '-f, --format=STRING       output format',
      '-F, --format-opts=STRING  comma-separated options to pass to ' \
                                 'output formatter',
      '-k, --nospark             do not show sparkline',

data/lib/wavefront-cli/commands/savedsearch.rb

@@ -3,8 +3,12 @@ require_relative 'base'
 # Define the saved search command.
 #
 class WavefrontCommandSavedsearch < WavefrontCommandBase
-  def description
-    'view and manage saved searches'
+  def thing
+    'saved search'
+  end
+
+  def things
+    'saved searches'
   end
 
   def sdk_file
@@ -19,17 +23,17 @@ class WavefrontCommandSavedsearch < WavefrontCommandBase
     ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
      "describe #{CMN} <id>",
      "delete #{CMN} <id>",
-     "import #{CMN} <file>",
+     "import #{CMN} [-u] <file>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
-     '-l, --long                list saved searches in detail',
-     '-a, --all                 list all saved searches',
-     '-o, --offset=n            start from nth saved search',
-     '-O, --fields=F1,F2,...    only show given fields',
-     '-L, --limit=COUNT         number of saved searches to list',
-     '-f, --format=STRING       output format']
+     "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
+     "-o, --offset=n           start from nth #{thing}",
+     '-O, --fields=F1,F2,...   only show given fields',
+     "-L, --limit=COUNT        number of #{things} to list",
+     "-u, --update             update an existing #{thing}"]
   end
 end

data/lib/wavefront-cli/commands/settings.rb

@@ -3,20 +3,20 @@ require_relative 'base'
 # Define the settings command.
 #
 class WavefrontCommandSettings < WavefrontCommandBase
-  def description
-    'view and manage system preferences'
+  def thing
+    'system preference'
   end
 
   def _commands
     ["list permissions #{CMN} [-l] [-O fields]",
      "show preferences #{CMN} [-l] [-O fields]",
-     "update #{CMN} <key=value>...",
+     "set #{CMN} <key=value>...",
      "default usergroups #{CMN} [-l] [-O fields]"]
   end
 
   def _options
     [common_options,
-     '-l, --long              list derived metrics in detail',
+     "-l, --long              list #{things} in detail",
      '-O, --fields=F1,F2,...  only show given fields']
   end
 end

data/lib/wavefront-cli/commands/source.rb

@@ -19,11 +19,10 @@ class WavefrontCommandSource < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-l, --long               list sources in detail',
-     '-o, --cursor=SOURCE      start list given source',
+     "-l, --long               list #{things} in detail",
+     "-o, --cursor=SOURCE      start list given #{thing}",
      '-O, --fields=F1,F2,...   only show given fields',
-     '-L, --limit=COUNT        number of sources to list',
-     '-a, --all                list all sources, including cluster',
-     '-f, --format=STRING      output format']
+     "-L, --limit=COUNT        number of #{things} to list",
+     "-a, --all                list all #{things}, including cluster"]
   end
 end

data/lib/wavefront-cli/commands/user.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 #
 class WavefrontCommandUser < WavefrontCommandBase
   def description
-    'view and manage Wavefront users'
+    "view and manage Wavefront #{things}"
   end
 
   # delete uses a different string because it accepts multiples.
@@ -16,9 +16,9 @@ class WavefrontCommandUser < WavefrontCommandBase
      "describe #{CMN} <id>",
      "create #{CMN} [-e] [-m permission...] [-g group...] <id>",
      "invite #{CMN} [-m permission...] [-g group...] <id>",
-     "update #{CMN} <key=value> <id>",
+     "set #{CMN} <key=value> <id>",
      "delete #{CMN} <user>...",
-     "import #{CMN} <file>",
+     "import #{CMN} [-u] <file>",
      "groups #{CMN} <id>",
      "join #{CMN} <id> <group>...",
      "leave #{CMN} <id> <group>...",
@@ -29,14 +29,14 @@ class WavefrontCommandUser < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-l, --long                list users in detail',
-     '-o, --offset=n            start from nth user',
-     '-L, --limit=COUNT         number of users to list',
-     '-O, --fields=F1,F2,...    only show given fields',
-     '-e, --email               send e-mail to user on account creation',
-     '-m, --permission=STRING   give user this permission',
-     '-g, --group=STRING        add user to this user group',
-     '-f, --format=STRING       output format']
+     "-l, --long               list #{things} in detail",
+     "-o, --offset=n           start from nth #{thing}",
+     "-L, --limit=COUNT        number of #{things} to list",
+     '-O, --fields=F1,F2,...   only show given fields',
+     "-u, --update             update an existing #{thing}",
+     "-e, --email              send e-mail to #{thing} on account creation",
+     "-m, --permission=STRING  give #{thing} this permission",
+     "-g, --group=STRING       add #{thing} to this user group"]
   end
 
   def postscript

data/lib/wavefront-cli/commands/usergroup.rb

@@ -3,8 +3,12 @@ require_relative 'base'
 # Define the usergroup command.
 #
 class WavefrontCommandUsergroup < WavefrontCommandBase
+  def thing
+    'user group'
+  end
+
   def description
-    'view and manage Wavefront user groups'
+    "view and manage Wavefront #{things}"
   end
 
   def sdk_class
@@ -20,8 +24,8 @@ class WavefrontCommandUsergroup < WavefrontCommandBase
      "describe #{CMN} <id>",
      "create #{CMN} [-p permission...] <name>",
      "delete #{CMN} <id>",
-     "import #{CMN} <file>",
-     "update #{CMN} <key=value> <id>",
+     "import #{CMN} [-u] <file>",
+     "set #{CMN} <key=value> <id>",
      "users #{CMN} <id>",
      "permissions #{CMN} <id>",
      "add user #{CMN} <id> <user>...",
@@ -33,13 +37,12 @@ class WavefrontCommandUsergroup < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-l, --long                list users in detail',
-     '-o, --offset=n            start from nth user group',
-     '-L, --limit=COUNT         number of user group to list',
-     '-O, --fields=F1,F2,...    only show given fields',
-     '-p, --permission=STRING   Wavefront permission',
-     '-u, --user=STRING         user name',
-     '-f, --format=STRING       output format']
+     "-l, --long               list #{things} in detail",
+     "-o, --offset=n           start from nth #{thing}",
+     "-L, --limit=COUNT        number of #{things} to list",
+     '-O, --fields=F1,F2,...   only show given fields',
+     "-u, --update             update an existing #{thing}",
+     '-p, --permission=STRING  Wavefront permission']
   end
 
   def postscript

data/lib/wavefront-cli/commands/webhook.rb

@@ -3,26 +3,22 @@ require_relative 'base'
 # Define the webhook command.
 #
 class WavefrontCommandWebhook < WavefrontCommandBase
-  def description
-    'view and manage webhooks'
-  end
-
   def _commands
     ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
      "describe #{CMN} <id>",
      "delete #{CMN} <id>",
-     "import #{CMN} <file>",
-     "update #{CMN} <key=value> <id>",
+     "import #{CMN} [-u] <file>",
+     "set #{CMN} <key=value> <id>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
-     '-l, --long                list webhooks in detail',
-     '-a, --all                 list all webhooks',
-     '-o, --offset=n            start list from nth webhook',
-     '-O, --fields=F1,F2,...    only show given fields',
-     '-L, --limit=COUNT         number of webhooks to list',
-     '-f, --format=STRING       output format']
+     "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
+     "-o, --offset=n           start list from nth #{thing}",
+     '-O, --fields=F1,F2,...   only show given fields',
+     "-L, --limit=COUNT        number of #{things} to list",
+     "-u, --update             update an existing #{thing}"]
   end
 end

data/lib/wavefront-cli/commands/window.rb

@@ -3,8 +3,8 @@ require_relative 'base'
 # Define the maintenance window command.
 #
 class WavefrontCommandWindow < WavefrontCommandBase
-  def description
-    'view and manage maintenance windows'
+  def thing
+    'maintenance window'
   end
 
   def sdk_file
@@ -23,8 +23,8 @@ class WavefrontCommandWindow < WavefrontCommandBase
      "close #{CMN} <id>",
      "extend #{CMN} (by|to) <time> <id>",
      "delete #{CMN} <id>",
-     "import #{CMN} <file>",
-     "update #{CMN} <key=value> <id>",
+     "import #{CMN} [-u] <file>",
+     "set #{CMN} <key=value> <id>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>...",
      "ongoing #{CMN}",
      "pending #{CMN} [<hours>]"]
@@ -32,17 +32,17 @@ class WavefrontCommandWindow < WavefrontCommandBase
 
   def _options
     [common_options,
-     '-l, --long              list maintenance windows in detail',
-     '-a, --all               list all maintenance windows',
-     '-o, --offset=n          start from nth maintenance window',
+     "-l, --long              list #{things} in detail",
+     "-a, --all               list all #{things}",
+     "-o, --offset=n          start from nth #{thing}",
      '-O, --fields=F1,F2,...  only show given fields',
-     '-L, --limit=COUNT       number of maintenance windows to list',
-     '-d, --desc=STRING       reason for maintenance window',
-     '-s, --start=TIME        time at which window begins',
-     '-e, --end=TIME          time at which window ends',
-     '-A, --atag=STRING       alert tag to which window applies',
-     '-H, --host=STRING       host to which window applies',
-     '-T, --htag=STRING       host tag to which window applies',
-     '-f, --format=STRING     output format']
+     "-L, --limit=COUNT       number of #{things} to list",
+     "-u, --update            update an existing #{thing}",
+     "-d, --desc=STRING       reason for #{thing}",
+     "-s, --start=TIME        time at which #{thing} begins",
+     "-e, --end=TIME          time at which #{thing} ends",
+     "-A, --atag=STRING       alert tag to which #{thing} applies",
+     "-H, --host=STRING       host to which #{thing} applies",
+     "-T, --htag=STRING       host tag to which #{thing} applies"]
   end
 end

data/lib/wavefront-cli/event.rb

@@ -27,7 +27,7 @@ module WavefrontCli
               options[:cursor] || nil)
     end
 
-    def do_update
+    def do_set
       k, v = options[:'<key=value>'].split('=')
       wf.update(options[:'<id>'], k => v)
     end

data/lib/wavefront-cli/settings.rb

@@ -17,7 +17,7 @@ module WavefrontCli
       wf.default_user_groups
     end
 
-    def do_update
+    def do_set
       body = options[:'<key=value>'].each_with_object({}) do |o, a|
         k, v = o.split('=', 2)
         next unless v && !v.empty?

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '3.3.0'.freeze
+WF_CLI_VERSION = '4.0.1'.freeze

data/spec/wavefront-cli/commands/base_spec.rb

@@ -13,7 +13,7 @@ class WavefrontCommmandBaseTest < MiniTest::Test
 
   def setup
     @wf = WavefrontCommandBase.new
-    @col_width = 18 # has to be manually set for each class
+    @col_width = 19 # has to be manually set for each class
   end
 
   def word

data/spec/wavefront-cli/notificant_spec.rb

@@ -17,7 +17,8 @@ describe "#{word} command" do
   invalid_ids(word, ["describe #{bad_id}",
                      "delete #{bad_id}",
                      "test #{bad_id}",
-                     "update #{bad_id} key=value"])
+                     "set #{bad_id} key=value"])
+  list_tests(word)
   cmd_to_call(word, "describe #{id}", path: "/api/v2/#{word}/#{id}")
   list_tests(word)
   search_tests(word, id)

data/spec/wavefront-cli/user_spec.rb

@@ -20,7 +20,7 @@ describe "#{word} command" do
                        "delete #{id}",
                        "create #{id}",
                        "invite #{id}",
-                       "update key=val #{id}",
+                       "set key=val #{id}",
                        'import file',
                        "groups #{id}",
                        "join #{id} #{gid1}",

data/spec/wavefront-cli/usergroup_spec.rb

@@ -20,7 +20,7 @@ describe "#{word} command" do
                        "create #{name}",
                        "delete #{gid1}",
                        'import file',
-                       "update key=val #{gid1}",
+                       "set key=val #{gid1}",
                        "users #{gid1}",
                        "permissions #{gid1}",
                        "add user #{gid1} #{uid1} #{uid2}",
@@ -88,7 +88,7 @@ describe "#{word} command" do
 
   invalid_ids(word, ["describe #{bad_id}",
                      "delete #{bad_id}",
-                     "update key=val #{bad_id}",
+                     "set key=val #{bad_id}",
                      "users #{bad_id}",
                      "permissions #{bad_id}",
                      "add user #{bad_id} #{uid1} #{uid2}",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-11 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -373,7 +373,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: CLI for Wavefront API v2