wavefront-cli 2.17.0 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 409c2cb417bfe4b580a2d140a4088c030ddeaa676c7467372df205b3e9082ba5
-  data.tar.gz: 74392fb743bfdd8673eeaecf46f2997be75fa4296d7ad4625e7014e312654f2b
+  metadata.gz: 4880abc13df515eb2e0446b72e0988c99d21cc8e28e7c1adfa532f063c58e1f3
+  data.tar.gz: fa812c04d90125e2a53161b13a52b0978e9e43bcdf949e8ab089f40152e261f9
 SHA512:
-  metadata.gz: 555129158af2721bf4ebda76ebf3254e3aa1c1b6a2785c3a5e558a1a183bc36fa6591bd14447fa008d4f9a3b66e3ab5db9b6b0ad4388dd43a46c03a4bfb3ffc0
-  data.tar.gz: 16df485a8d0706ec14bf2be94c94ab898e5c69bfa36ad950fefb6fac9134cfc6fe10343c15be1e88ac4431a52fd968c6a19d3ae71f3ee99585658d2359621595
+  metadata.gz: 92c1347338ecc3fa32995ada2d922fe40192730ffcc51eedb13f03f8efe87593c0f8e2bca3191575f2251033cc6792ff5218cd67c7af412288febb589e7f5509
+  data.tar.gz: c6500c4047b9b3565facc8a3bdbba78a536aefa0d66280dceb568712055ee5c3ecb18e1bcac7d7cd175a28b9241a8535dfe4bc196da98fa4a93b9a6d7245d405

data/HISTORY.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.18.0 (22/02/2019)
+* Add `usergroup` command, and extend `user` command to cover new
+  RBAC features.
+* Require 2.5.0 of [the SDK](https://github.com/snltd/wavefront-sdk).
+
 ## 2.17.0 (19/02/2019)
 * Add `-O field,field` to all `list` commands. This lets you select
   the fields displayed in the output.
@@ -27,7 +32,6 @@
   query outputs tried to process an empty data set.
 
 ## 2.15.1 (20/12/2018)
-
 * Fix bug where `alert snoozed` and `alert firing` did the same
   thing.
 

data/README.md

@@ -32,6 +32,7 @@ Usage:
 Commands:
   alert              view and manage alerts
   cloudintegration   view and manage cloud integrations
+  config             create and manage local configuration
   dashboard          view and manage dashboards
   derivedmetric      view and manage derived metrics
   event              open, close, view, and manage events
@@ -39,16 +40,17 @@ Commands:
   link               view and manage external links
   message            read and mark user messages
   metric             view metrics
-  notificant         view and manage Wavefront notification targets
+  notificant         view and manage Wavefront alert targets
   proxy              view and manage Wavefront proxies
   query              query the Wavefront API
   report             send data directly to Wavefront
   savedsearch        view and manage saved searches
   source             view and manage source tags and descriptions
   user               view and manage Wavefront users
+  usergroup          view and manage Wavefront user groups
   webhook            view and manage webhooks
   window             view and manage maintenance windows
-  write              send data to a Wavefront proxy
+  write              send data to Wavefront
 
 Use 'wf <command> --help' for further information.
 ```

data/lib/wavefront-cli/base.rb

@@ -108,7 +108,11 @@ module WavefrontCli
     def validate_id
       send(validator_method, options[:'<id>'])
     rescue validator_exception
-      abort "'#{options[:'<id>']}' is not a valid #{klass_word} ID."
+      abort failed_validation_message(options[:'<id>'])
+    end
+
+    def failed_validation_message(input)
+      format("'%s' is not a valid %s ID.", input, klass_word)
     end
 
     # Make a wavefront-sdk credentials object from standard
@@ -175,7 +179,7 @@ module WavefrontCli
       # matches. The order will ensure we match "do_delete_tags" before
       # we match "do_delete".
       #
-      m_list.sort_by(&:length).reverse.each do |m|
+      m_list.sort_by(&:length).reverse_each do |m|
         if m.reject { |w| options[w.to_sym] }.empty?
           method = (%w[do] + m).join('_')
           return display(public_send(method), method)
@@ -229,7 +233,7 @@ module WavefrontCli
     #
     def display_api_error(status)
       msg = status.message || 'No further information'
-      abort format('ERROR: API code %s: %s.', status.code, msg)
+      abort format('ERROR: API code %s: %s.', status.code, msg.chomp('.'))
     end
 
     def display_no_api_response(data, method)

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

@@ -38,8 +38,8 @@ class WavefrontCommandAlert < WavefrontCommandBase
      '-a, --all                list all alerts',
      '-v, --version=INTEGER    describe only this version of alert',
      '-o, --offset=n           start from nth alert',
-     '-O, --fields=F1,F2,...   only show given fields',
      '-L, --limit=COUNT        number of alerts to list',
+     '-O, --fields=F1,F2,...   only show given fields',
      '-T, --time=SECONDS       how long to snooze (default 3600)',
      '-b, --brief              do not show alert names',
      '-f, --format=STRING      output format']

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

@@ -7,19 +7,41 @@ class WavefrontCommandUser < WavefrontCommandBase
     'view and manage Wavefront users'
   end
 
+  # delete uses a different string because it accepts multiples.
+  # Adding ellipsis to <id> causes everything else to expect an
+  # array.
+  #
   def _commands
     ["list #{CMN} [-l] [-O fields]",
      "describe #{CMN} [-f format] <id>",
-     "delete #{CMN} <id>",
+     "create #{CMN} [-e] [-m permission...] [-g group...] [-f format] <id>",
+     "invite #{CMN} [-m permission...] [-g group...] [-f format] <id>",
+     "update #{CMN} <key=value> <id>",
+     "delete #{CMN} <user>...",
      "import #{CMN} <file>",
+     "groups #{CMN} <id>",
+     "join #{CMN} <id> <group>...",
+     "leave #{CMN} <id> <group>...",
      "grant #{CMN} <privilege> to <id>",
-     "revoke #{CMN} <privilege> from <id>"]
+     "revoke #{CMN} <privilege> from <id>",
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
   end
 
   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']
   end
+
+  def postscript
+    'If your account does not have RBAC enabled, you must grant user ' \
+    "permissions with '-m'. For a list of permissions, see " \
+    "'wf usergroup --help'.".fold(TW, 0)
+  end
 end

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

@@ -0,0 +1,52 @@
+require_relative 'base'
+
+# Define the usergroup command.
+#
+class WavefrontCommandUsergroup < WavefrontCommandBase
+  def description
+    'view and manage Wavefront user groups'
+  end
+
+  def sdk_class
+    'UserGroup'
+  end
+
+  def sdk_file
+    'usergroup'
+  end
+
+  def _commands
+    ["list #{CMN} [-al] [-O fields] [-f format] [-o offset] [-L limit]",
+     "describe #{CMN} [-f format] <id>",
+     "create #{CMN} [-p permission...] <name>",
+     "delete #{CMN} <id>",
+     "import #{CMN} <file>",
+     "update #{CMN} <key=value> <id>",
+     "users #{CMN} <id>",
+     "permissions #{CMN} <id>",
+     "add user #{CMN} <id> <user>...",
+     "remove user #{CMN} <id> <user>...",
+     "grant #{CMN} <permission> to <id>",
+     "revoke #{CMN} <permission> from <id>",
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
+  end
+
+  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']
+  end
+
+  def postscript
+    'Valid permissions at the time of writing are: agent_management, ' \
+    'alerts_management, dashboard_management, embedded_charts, ' \
+    'events_management, external_links_management, host_tag_management, ' \
+    'metrics_management, and user_management. Check the API docs for ' \
+    'an up-to-date list.'.fold(TW, 0)
+  end
+end

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

@@ -4,7 +4,7 @@ require_relative 'base'
 #
 class WavefrontCommandWrite < WavefrontCommandBase
   def description
-    'send data to a Wavefront proxy'
+    'send data to Wavefront'
   end
 
   def _commands

data/lib/wavefront-cli/controller.rb

@@ -67,7 +67,7 @@ class WavefrontCliController
   rescue Docopt::Exit => e
     cmd = args.empty? ? nil : args.first.to_sym
 
-    abort e.message unless usage.keys.include?(cmd)
+    abort e.message unless usage.key?(cmd)
 
     begin
       [cmd, sanitize_keys(Docopt.docopt(usage[cmd], argv: args))]

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

@@ -9,8 +9,34 @@ module WavefrontDisplay
       data.each { |user| puts user[:identifier] }
     end
 
+    def do_groups
+      if data.userGroups.empty?
+        puts 'User does not belong to any groups.'
+      else
+        data.userGroups.each { |u| puts format('%s (%s)', u[:id], u[:name]) }
+      end
+    end
+
+    def do_create
+      puts format("Created user '%s'.\nPermission groups\n%s\n" \
+                  "User groups\n%s",
+                  data.response[:identifier],
+                  groups_as_string(data.response.groups),
+                  user_groups_as_string(data.response.userGroups))
+    end
+
+    def groups_as_string(groups)
+      return '  <none>' if groups.empty?
+      data.response.groups.map { |g| format('  %s', g) }.join("\n  ")
+    end
+
+    def user_groups_as_string(groups)
+      return '  <none>' if groups.empty?
+      groups.map { |g| format('  %s (%s)', g[:name], g[:id]) }.join("\n")
+    end
+
     def do_delete
-      puts "Deleted user '#{options[:'<id>']}."
+      puts format('Deleted %s', options[:'<user>'].join(', '))
     end
   end
 end

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

@@ -0,0 +1,52 @@
+require_relative 'base'
+
+module WavefrontDisplay
+  #
+  # Format human-readable output for user management.
+  #
+  class UserGroup < Base
+    def do_list_brief
+      multicolumn(:id, :name, :userCount)
+    end
+
+    def do_delete
+      puts "Deleted user group '#{options[:'<id>']}."
+    end
+
+    def do_add_user
+      puts format('Added %s to %s.', options[:'<user>'].join(', '),
+                  options[:'<id>']).fold(TW, 0)
+    end
+
+    def do_remove_user
+      puts format("Removed '%s' from %s.", options[:'<user>'].join(', '),
+                  options[:'<id>']).fold(TW, 0)
+    end
+
+    def do_grant
+      puts format("Granted '%s' permission to %s.",
+                  options[:'<permission>'], options[:'<id>'])
+    end
+
+    def do_revoke
+      puts format("Revoked '%s' permission from %s.",
+                  options[:'<permission>'], options[:'<id>'])
+    end
+
+    def do_users
+      if data.users.empty?
+        puts 'No users in group.'
+      else
+        data.users.each { |u| puts u }
+      end
+    end
+
+    def do_permissions
+      if data.permissions.empty?
+        puts 'Group has no permissions.'
+      else
+        data.permissions.each { |u| puts u }
+      end
+    end
+  end
+end

data/lib/wavefront-cli/event.rb

@@ -79,7 +79,7 @@ module WavefrontCli
       if events.size.zero?
         puts 'No open events.'
       else
-        events.sort.reverse.each { |e| puts e.basename }
+        events.sort.reverse_each { |e| puts e.basename }
       end
 
       exit
@@ -208,7 +208,7 @@ module WavefrontCli
       list = local_events_with_name(name)
       return false if list.empty?
 
-      ev_file = list.sort.last
+      ev_file = list.max
       File.unlink(ev_file)
       ev_file.basename.to_s
     end

data/lib/wavefront-cli/user.rb

@@ -9,6 +9,25 @@ module WavefrontCli
       wf.list
     end
 
+    def do_delete
+      wf.delete_users(options[:'<user>'])
+    end
+
+    def do_create
+      wf_user_id?(options[:'<id>'])
+      wf.create(user_body, options[:email])
+    end
+
+    alias do_groups do_describe
+
+    def do_join
+      wf.add_groups_to_user(options[:'<id>'], options[:'<group>'])
+    end
+
+    def do_leave
+      wf.remove_groups_from_user(options[:'<id>'], options[:'<group>'])
+    end
+
     def do_grant
       wf.grant(options[:'<id>'], options[:'<privilege>'])
     end
@@ -17,9 +36,42 @@ module WavefrontCli
       wf.revoke(options[:'<id>'], options[:'<privilege>'])
     end
 
+    def do_invite
+      wf_user_id?(options[:'<id>'])
+      wf.invite([user_body])
+    end
+
     def import_to_create(raw)
-      raw['emailAddress'] = raw['identifier']
-      raw.delete_if { |k, _v| k == 'customer' || k == 'identifier' }
+      { emailAddress: raw['items']['identifier'],
+        groups:       raw['items']['groups'] }.tap do |r|
+
+        if raw['items'].key?('userGroups')
+          r['userGroups'] = raw['items']['userGroups'].map { |g| g['id'] }
+        end
+      end
+    end
+
+    # Object used to create and invite users.
+    #
+    def user_body
+      { emailAddress: options[:'<id>'],
+        groups:       options[:permission],
+        userGroups:   options[:group] }
+    end
+
+    # Because of the way docopt works, we have to call the user ID
+    # parameter something else on the delete command. This means the
+    # automatic validtion doesn't work, and we have to do it
+    # ourselves.
+    #
+    def extra_validation
+      options[:'<user>'].each { |u| validate_user(u) }
+    end
+
+    def validate_user(user)
+      wf_user_id?(user)
+    rescue Wavefront::Exception::InvalidUserId
+      abort failed_validation_message(user)
     end
   end
 end

data/lib/wavefront-cli/usergroup.rb

@@ -0,0 +1,41 @@
+require_relative 'base'
+
+module WavefrontCli
+  #
+  # CLI coverage for the v2 'usergroup' API.
+  #
+  class UserGroup < WavefrontCli::Base
+    def validator_exception
+      Wavefront::Exception::InvalidUserGroupId
+    end
+
+    alias do_users do_describe
+    alias do_permissions do_describe
+
+    def do_create
+      wf.create(name:        options[:'<name>'],
+                permissions: options[:permission])
+    end
+
+    def do_add_user
+      wf.add_users_to_group(options[:'<id>'], options[:'<user>'])
+    end
+
+    def do_remove_user
+      wf.remove_users_from_group(options[:'<id>'], options[:'<user>'])
+    end
+
+    def do_grant
+      wf.grant(options[:'<permission>'], Array(options[:'<id>']))
+    end
+
+    def do_revoke
+      wf.revoke(options[:'<permission>'], Array(options[:'<id>']))
+    end
+
+    def import_to_create(raw)
+      raw['emailAddress'] = raw['identifier']
+      raw.delete_if { |k, _v| k == 'customer' || k == 'identifier' }
+    end
+  end
+end

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '2.17.0'.freeze
+WF_CLI_VERSION = '2.18.0'.freeze

data/spec/wavefront-cli/query_spec.rb

@@ -10,9 +10,20 @@ include Wavefront::Mixins
 # rubocop:enable Style/MixinUsage
 
 q = 'ts("dev.cli.test")'
-t1 = parse_time('12:00', true)
-t2 = parse_time('12:10', true)
-o = '-g m -s 12:00'
+#
+# The SDK has got smarter about calculating granularity options, so
+# we can't use any kind of absolute time any more. We round time
+# down to the nearest minute, because that's how users will most
+# likely specify it.
+#
+t1_t = Time.now - (30 * 60)
+t1_t = Time.at(t1_t.to_i - t1_t.sec)
+t2_t = Time.at(t1_t + (10 * 60))
+
+t1 = parse_time(t1_t, true)
+t2 = parse_time(t2_t, true)
+o = "-g m -s #{t1_t.strftime('%H:%M')}"
+s_and_e_opts = "-s #{t1_t.strftime('%H:%M')} -e #{t2_t.strftime('%H:%M')}"
 
 describe "#{word} command" do
   cmd_to_call(word, "-s -2h #{q}",
@@ -21,12 +32,12 @@ describe "#{word} command" do
                     '&s=[0-9]{13}&sorted=true&strict=true&summarization=mean',
               regex: true)
 
-  missing_creds(word, ["-g m -s 12:00 '#{q}'", "raw #{q}"])
+  missing_creds(word, ["#{o} '#{q}'", "raw #{q}"])
 
   cmd_noop(word, "-s #{t1} #{q}",
            ['GET https://metrics.wavefront.com/api/v2/chart/api',
             i: false, summarization: 'mean', listMode: true, strict: true,
-            sorted: true, q: q, g: :h, s: t1])
+            sorted: true, q: q, g: :m, s: t1])
 
   cmd_noop(word, 'raw dev.cli.test',
            ['GET https://metrics.wavefront.com/api/v2/chart/raw',
@@ -36,29 +47,30 @@ describe "#{word} command" do
               path: '/api/v2/chart/api?g=m&i=false&listMode=true' \
                     "&q=ts(%22dev.cli.test%22)&s=#{t1}&sorted=true" \
                     '&strict=true&summarization=mean')
-  cmd_to_call(word, "#{o} -e 12:10 #{q}",
+
+  cmd_to_call(word, "#{s_and_e_opts} #{q}",
               path: "/api/v2/chart/api?e=#{t2}&g=m&i=false" \
                     '&listMode=true&q=ts(%22dev.cli.test%22)' \
                     "&s=#{t1}&sorted=true&strict=true&summarization=mean")
 
-  cmd_to_call(word, "-g s -s 12:00 -e 12:10 -S max #{q}",
+  cmd_to_call(word, "-g s #{s_and_e_opts} -S max #{q}",
               path: "/api/v2/chart/api?e=#{t2}&g=s&i=false" \
                     '&listMode=true&q=ts(%22dev.cli.test%22)' \
                     "&s=#{t1}&sorted=true&strict=true&summarization=max")
 
-  cmd_to_call(word, "-g s -s 12:00 -e 12:10 -p 100 #{q}",
+  cmd_to_call(word, "-g s #{s_and_e_opts} -p 100 #{q}",
               path: "/api/v2/chart/api?e=#{t2}&g=s&i=false" \
                     '&listMode=true&q=ts(%22dev.cli.test%22)' \
                     "&s=#{t1}&sorted=true&summarization=mean&strict=true" \
                     '&p=100')
 
-  cmd_to_call(word, "-iO -g h -s 12:00 -e 12:10 -p 100 #{q}",
+  cmd_to_call(word, "-iO -g h #{s_and_e_opts} -p 100 #{q}",
               path: "/api/v2/chart/api?e=#{t2}&g=h&i=true" \
                     '&listMode=true&q=ts(%22dev.cli.test%22)' \
                     "&s=#{t1}&sorted=true&summarization=mean" \
                     '&strict=true&p=100&includeObsoleteMetrics=true')
 
-  cmd_to_call(word, "-N query -g h -s 12:00 -e 12:10 -p 100 #{q}",
+  cmd_to_call(word, "-N query -g h #{s_and_e_opts} -p 100 #{q}",
               path: "/api/v2/chart/api?e=#{t2}&g=h&i=false" \
                     '&listMode=true&q=ts(%22dev.cli.test%22)' \
                     "&s=#{t1}&sorted=true&summarization=mean" \
@@ -70,11 +82,11 @@ describe "#{word} command" do
   cmd_to_call(word, 'raw -H h1 dev.cli.test',
               path: '/api/v2/chart/raw?metric=dev.cli.test&source=h1')
 
-  cmd_to_call(word, 'raw -s 12:00 -H h1 dev.cli.test',
+  cmd_to_call(word, "raw -s #{t1_t.strftime('%H:%M')} -H h1 dev.cli.test",
               path: '/api/v2/chart/raw?metric=dev.cli.test&source=h1' \
                     "&startTime=#{t1}")
 
-  cmd_to_call(word, 'raw -s 12:00 -e 12:10 -H h1 dev.cli.test',
+  cmd_to_call(word, "raw #{s_and_e_opts} -H h1 dev.cli.test",
               path: '/api/v2/chart/raw?metric=dev.cli.test&source=h1' \
                     "&startTime=#{t1}&endTime=#{t2}")
 end

data/spec/wavefront-cli/user_spec.rb

@@ -3,6 +3,9 @@
 id = 'someone@somewhere.com'
 bad_id = '__BAD__'
 word = 'user'
+gid1 = '2659191e-aad4-4302-a94e-9667e1517127'
+gid2 = 'abcdef12-1234-abcd-1234-abcdef012345'
+priv = 'alerts_management'
 
 require_relative '../spec_helper'
 require_relative "../../lib/wavefront-cli/#{word}"
@@ -12,22 +15,102 @@ describe "#{word} command" do
     'Content-Type': 'application/x-www-form-urlencoded'
   )
 
-  missing_creds(word, ['list', "describe #{id}", "delete #{id}"])
+  missing_creds(word, ['list',
+                       "describe #{id}",
+                       "delete #{id}",
+                       "create #{id}",
+                       "invite #{id}",
+                       "update key=val #{id}",
+                       'import file',
+                       "groups #{id}",
+                       "join #{id} #{gid1}",
+                       "leave #{id} #{gid1}",
+                       "grant #{priv} to #{id}",
+                       "revoke #{priv} from #{id}"])
+
   cmd_to_call(word, 'list', path: "/api/v2/#{word}")
+
   cmd_to_call(word, "describe #{id}", path: "/api/v2/#{word}/#{id}")
-  cmd_to_call(word, "delete #{id}", method: :delete,
-                                    path:   "/api/v2/#{word}/#{id}")
+
+  cmd_to_call(word, "create #{id}",
+              method: :post,
+              path:   "/api/v2/#{word}?sendEmail=false",
+              body:   { emailAddress: id,
+                        groups:       [],
+                        userGroups:   [] }.to_json)
+
+  cmd_to_call(word, "create -e #{id} -m #{priv}",
+              method: :post,
+              path:   "/api/v2/#{word}?sendEmail=true",
+              body:   { emailAddress: id,
+                        groups:       [priv],
+                        userGroups:   [] }.to_json)
+
+  cmd_to_call(word, "create #{id} -g #{gid1} -g #{gid2}",
+              method: :post,
+              path:   "/api/v2/#{word}?sendEmail=false",
+              body:   { emailAddress: id,
+                        groups:       [],
+                        userGroups:   [gid1, gid2] }.to_json)
+
+  cmd_to_call(word, "invite -m #{priv} -g #{gid2} #{id}",
+              method: :post,
+              path:   "/api/v2/#{word}/invite",
+              body:   [{ emailAddress: id,
+                         groups:       [priv],
+                         userGroups:   [gid2] }].to_json)
+
+  cmd_to_call(word, "delete #{id}",
+              method: :post,
+              path:   "/api/v2/#{word}/deleteUsers",
+              body:   [id].to_json)
+
+  cmd_to_call(word, "groups #{id}", path: "/api/v2/#{word}/#{id}")
+
+  cmd_to_call(word, "join #{id} #{gid1}",
+              method: :post,
+              path:   "/api/v2/#{word}/#{id}/addUserGroups",
+              body:   [gid1].to_json)
+
+  cmd_to_call(word, "leave #{id} #{gid2} #{gid1}",
+              method: :post,
+              path:   "/api/v2/#{word}/#{id}/removeUserGroups",
+              body:   [gid2, gid1].to_json)
+
   cmd_to_call(word, "grant agent_management to #{id}",
-              method: :post, path: "/api/v2/#{word}/#{id}/grant",
+              method: :post,
+              path: "/api/v2/#{word}/#{id}/grant",
               body:   'group=agent_management',
               headers: hdrs)
 
   cmd_to_call(word, "revoke agent_management from #{id}",
-              method: :post, path: "/api/v2/#{word}/#{id}/revoke",
+              method: :post,
+              path: "/api/v2/#{word}/#{id}/revoke",
               body:   'group=agent_management',
               headers: hdrs)
 
-  invalid_ids(word, ["describe #{bad_id}", "delete #{bad_id}"])
+  cmd_to_call(word, "search -L 40 id=#{id}",
+              { method: :post, path: "/api/v2/search/#{word}",
+                body:   { limit:  '40',
+                          offset: 0,
+                          query: [{ key: 'id',
+                                    value: id,
+                                    matchingMethod: 'EXACT' }],
+                          sort: { field: 'id', ascending: true } },
+                headers: JSON_POST_HEADERS }, WavefrontCli::User)
+
+  invalid_ids(word, ["describe #{bad_id}",
+                     "delete #{bad_id}",
+                     "delete #{id} #{bad_id}",
+                     "delete #{bad_id}",
+                     "invite #{bad_id}",
+                     "create -e #{bad_id}",
+                     "groups #{bad_id}",
+                     "join #{bad_id} #{gid1}",
+                     "leave #{bad_id} #{gid1}",
+                     "grant #{priv} to #{bad_id}",
+                     "revoke #{priv} from #{bad_id}"])
+
   cmd_noop(word, 'list',
            ["GET https://metrics.wavefront.com/api/v2/#{word}"])
   cmd_noop(word, 'describe rob@a.com',

data/spec/wavefront-cli/usergroup_spec.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+
+uid1 = 'someone@somewhere.com'
+uid2 = 'other@elsewhere.com'
+name = 'testgroup'
+bad_id = '__BAD__'
+word = 'usergroup'
+gid1 = '2659191e-aad4-4302-a94e-9667e1517127'
+priv1 = 'alerts_management'
+priv2 = 'events_management'
+
+require_relative '../spec_helper'
+require_relative "../../lib/wavefront-cli/#{word}"
+
+k = WavefrontCli::UserGroup
+
+describe "#{word} command" do
+  missing_creds(word, ['list',
+                       "describe #{gid1}",
+                       "create #{name}",
+                       "delete #{gid1}",
+                       'import file',
+                       "update key=val #{gid1}",
+                       "users #{gid1}",
+                       "permissions #{gid1}",
+                       "add user #{gid1} #{uid1} #{uid2}",
+                       "remove user #{gid1} #{uid1} #{uid2}",
+                       "grant #{priv1} to #{gid1}",
+                       "revoke #{priv2} from #{gid1}",
+                       'search key=value'])
+
+  list_tests(word, 'usergroup', k)
+
+  cmd_to_call(word, "describe #{gid1}",
+              { path: "/api/v2/#{word}/#{gid1}" }, k)
+
+  cmd_to_call(word, "create #{name}",
+              { method: :post,
+                path:   "/api/v2/#{word}",
+                body:   { name: name, permissions: [] }.to_json }, k)
+
+  cmd_to_call(word, "create -p #{priv1} -p #{priv2} #{name}",
+              { method: :post,
+                path:   "/api/v2/#{word}",
+                body:   { name: name,
+                          permissions: [priv1, priv2] }.to_json }, k)
+
+  cmd_to_call(word, "delete #{gid1}",
+              { method: :delete, path: "/api/v2/#{word}/#{gid1}" }, k)
+
+  cmd_to_call(word, "users #{gid1}",
+              { path: "/api/v2/#{word}/#{gid1}" }, k)
+
+  cmd_to_call(word, "permissions #{gid1}",
+              { path: "/api/v2/#{word}/#{gid1}" }, k)
+
+  cmd_to_call(word, "add user #{gid1} #{uid1}",
+              { method: :post,
+                path:   "/api/v2/#{word}/#{gid1}/addUsers",
+                body:   [uid1].to_json }, k)
+
+  cmd_to_call(word, "add user #{gid1} #{uid1} #{uid2}",
+              { method: :post,
+                path:   "/api/v2/#{word}/#{gid1}/addUsers",
+                body:   [uid1, uid2].to_json }, k)
+
+  cmd_to_call(word, "remove user #{gid1} #{uid1}",
+              { method: :post,
+                path:   "/api/v2/#{word}/#{gid1}/removeUsers",
+                body:   [uid1].to_json }, k)
+
+  cmd_to_call(word, "remove user #{gid1} #{uid1} #{uid2}",
+              { method: :post,
+                path:   "/api/v2/#{word}/#{gid1}/removeUsers",
+                body:   [uid1, uid2].to_json }, k)
+
+  cmd_to_call(word, "grant #{priv1} to #{gid1}",
+              { method: :post,
+                path: "/api/v2/#{word}/grant/#{priv1}",
+                body:   [gid1].to_json }, k)
+
+  cmd_to_call(word, "revoke #{priv1} from #{gid1}",
+              { method: :post,
+                path: "/api/v2/#{word}/revoke/#{priv1}",
+                body:   [gid1].to_json }, k)
+
+  cmd_to_call(word, 'search -L 40 id=string',
+              { method: :post, path: "/api/v2/search/#{word}",
+                body:   { limit:  '40',
+                          offset: 0,
+                          query: [{ key: 'id',
+                                    value: 'string',
+                                    matchingMethod: 'EXACT' }],
+                          sort: { field: 'id', ascending: true } } }, k)
+
+  invalid_ids(word, ["describe #{bad_id}",
+                     "delete #{bad_id}",
+                     "update key=val #{bad_id}",
+                     "users #{bad_id}",
+                     "permissions #{bad_id}",
+                     "add user #{bad_id} #{uid1} #{uid2}",
+                     "remove user #{bad_id} #{uid1} #{uid2}",
+                     "grant #{priv1} to #{bad_id}",
+                     "revoke #{priv2} from #{bad_id}"])
+
+  cmd_noop(word, 'list',
+           ["GET https://metrics.wavefront.com/api/v2/#{word}"], k)
+  cmd_noop(word, "describe #{gid1}",
+           ["GET https://metrics.wavefront.com/api/v2/#{word}/#{gid1}"], k)
+end

data/wavefront-cli.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'docopt', '~> 0.6.0'
   gem.add_runtime_dependency 'inifile', '~> 3.0'
-  gem.add_runtime_dependency 'wavefront-sdk', '~> 2.2', '>= 2.2.1'
+  gem.add_runtime_dependency 'wavefront-sdk', '~> 2.5', '>= 2.5.0'
 
   gem.add_development_dependency 'bundler', '~> 1.3'
   gem.add_development_dependency 'minitest', '~> 5.11', '>= 5.11.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 2.17.0
+  version: 2.18.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-19 00:00:00.000000000 Z
+date: 2019-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -42,22 +42,22 @@ dependencies:
   name: wavefront-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +203,7 @@ files:
 - lib/wavefront-cli/commands/savedsearch.rb
 - lib/wavefront-cli/commands/source.rb
 - lib/wavefront-cli/commands/user.rb
+- lib/wavefront-cli/commands/usergroup.rb
 - lib/wavefront-cli/commands/webhook.rb
 - lib/wavefront-cli/commands/window.rb
 - lib/wavefront-cli/commands/write.rb
@@ -234,6 +235,7 @@ files:
 - lib/wavefront-cli/display/savedsearch.rb
 - lib/wavefront-cli/display/source.rb
 - lib/wavefront-cli/display/user.rb
+- lib/wavefront-cli/display/usergroup.rb
 - lib/wavefront-cli/display/webhook.rb
 - lib/wavefront-cli/display/write.rb
 - lib/wavefront-cli/event.rb
@@ -268,6 +270,7 @@ files:
 - lib/wavefront-cli/source.rb
 - lib/wavefront-cli/stdlib/string.rb
 - lib/wavefront-cli/user.rb
+- lib/wavefront-cli/usergroup.rb
 - lib/wavefront-cli/version.rb
 - lib/wavefront-cli/webhook.rb
 - lib/wavefront-cli/write.rb
@@ -325,6 +328,7 @@ files:
 - spec/wavefront-cli/source_spec.rb
 - spec/wavefront-cli/stdlib/string_spec.rb
 - spec/wavefront-cli/user_spec.rb
+- spec/wavefront-cli/usergroup_spec.rb
 - spec/wavefront-cli/webhook_spec.rb
 - spec/wavefront-cli/write_spec.rb
 - wavefront-cli.gemspec
@@ -406,5 +410,6 @@ test_files:
 - spec/wavefront-cli/source_spec.rb
 - spec/wavefront-cli/stdlib/string_spec.rb
 - spec/wavefront-cli/user_spec.rb
+- spec/wavefront-cli/usergroup_spec.rb
 - spec/wavefront-cli/webhook_spec.rb
 - spec/wavefront-cli/write_spec.rb