wavefront-cli 0.0.2

data/lib/wavefront-cli/cloudintegration.rb

@@ -0,0 +1,12 @@
+require_relative './base'
+
+module WavefrontCli
+  #
+  # CLI coverage for the v2 'cloudintegration' API.
+  #
+  class CloudIntegration < WavefrontCli::Base
+    def validator_exception
+      Wavefront::Exception::InvalidCloudIntegrationId
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require_relative './base'
+
+# Define the Alert command
+#
+class WavefrontCommandAlert < WavefrontCommandBase
+  def description
+    'view and manage alerts'
+  end
+
+  def _commands
+    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+     "describe #{CMN} [-f format] [-v version] <id>",
+     "delete #{CMN} <id>",
+     "undelete #{CMN} <id>",
+     "history #{CMN} [-f format] [-o offset] [-L limit] <id>",
+     "import #{CMN} <file>",
+     "snooze #{CMN} [-T time] <id>",
+     "update #{CMN} <key=value> <id>",
+     "unsnooze #{CMN} <id>",
+     "tags #{CMN} [-f format] <id>",
+     "tag set #{CMN} <id> <tag>...",
+     "tag clear #{CMN} <id>",
+     "tag add #{CMN} <id> <tag>",
+     "tag delete #{CMN} <id> <tag>",
+     "summary #{CMN} [-a]"]
+  end
+
+  def _options
+    [common_options,
+     '-l, --long               list alerts in detail',
+     '-v, --version=INTEGER    describe only this version of alert',
+     '-o, --offset=n           start from nth alert',
+     '-L, --limit=COUNT        number of alerts to list',
+     '-T, --time=SECONDS       how long to snooze (default 3600)',
+     '-a, --all                list all alerts',
+     '-f, --format=STRING      output format']
+  end
+end

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

@@ -0,0 +1,105 @@
+CMN = '[-DnV] [-c file] [-P profile] [-E endpoint] [-t token]'.freeze
+
+# A base class which all command classes extend.
+#
+class WavefrontCommandBase
+  # All commands have these options
+  #
+  def global_options
+    ['-c, --config=FILE    path to configuration file',
+     '-P, --profile=NAME   profile in configuration file',
+     '-D, --debug          enable debug mode',
+     '-n, --noop           do not perform API calls',
+     '-V, --verbose        be verbose',
+     '-h, --help           show this message']
+  end
+
+  # Many commands have these options
+  #
+  def common_options
+    ['-E, --endpoint=URI       cluster endpoint',
+     '-t, --token=TOKEN        Wavefront authentication token']
+  end
+
+  # Anything which takes tags provides the same interface
+  #
+  def tag_commands
+    ["tags #{CMN} [-f format] <id>",
+     "tag set #{CMN} <id> <tag>...",
+     "tag clear #{CMN} <id>",
+     "tag add #{CMN} <id> <tag>",
+     "tag delete #{CMN} <id> <tag>"]
+  end
+
+  # The command keyword
+  #
+  def word
+    self.class.name.sub(/WavefrontCommand/, '').downcase
+  end
+
+  # Returns the name of the SDK class which does the work for this
+  # command.
+  #
+  def sdk_class
+    word.capitalize
+  end
+
+  def sdk_file
+    word
+  end
+
+  # Returns a string describing the subcommands the command offers.
+  #
+  def commands
+    _commands.flatten.each_with_object("Usage:\n") do |cmd, ret|
+      ret.<< '  ' + "#{CMD} #{word} #{cmd}\n".cmd_fold + "\n"
+    end + "  #{CMD} #{word} --help"
+  end
+
+  # Returns a string describing the options the command understands.
+  #
+  def options
+    width = column_widths
+    ret = "Global options:\n"
+    global_options.each { |o| ret.<< opt_row(o, width) }
+    ret.<< "\nOptions:\n"
+    _options.flatten.each { |o| ret.<< opt_row(o, width) }
+    ret
+  end
+
+  def opt_row(opt, width)
+    format("  %s %-#{width}s %s\n", *opt.split(/\s+/, 3))
+  end
+
+  def column_widths
+    (global_options + _options).flatten.map do |o|
+      o.split(/\s+/, 3)[0..1].join(' ').size
+    end.max
+  end
+
+  # Returns a string which will be printed underneath the options.
+  #
+  def postscript
+    ''
+  end
+
+  # Returns a full options string which docopt understands
+  #
+  def docopt
+    commands + "\n\n" + options + "\n" + postscript
+  end
+end
+
+# Extensions to the String class to help with formatting.
+#
+class String
+
+  # Fold long command lines. We can't break on a space inside
+  # [square brackets] or it confuses docopt.
+  #
+  def cmd_fold(width = TW, indent = 10)
+    gsub(/\s(?=\w+\])/, '^').
+    scan(/\S.{0,#{width - 8}}\S(?=\s|$)|\S+/).join("\n" + ' ' * indent).
+    gsub('^', ' ')
+  end
+end

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

@@ -0,0 +1,29 @@
+require_relative './base'
+
+# Define the dashboard command.
+#
+class WavefrontCommandDashboard < WavefrontCommandBase
+  def description
+    'view and manage dashboards'
+  end
+
+  def _commands
+    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+     "describe #{CMN} [-f format] [-v version] <id>",
+     "import #{CMN} [-f format] [-F] <file>",
+     "update #{CMN} <key=value> <id>",
+     "delete #{CMN} <id>",
+     "undelete #{CMN} <id>",
+     "history #{CMN} [-b] [-f format] [-o offset] [-L limit] <id>",
+     tag_commands]
+  end
+
+  def _options
+    [common_options,
+     '-l, --long               list dashboards in detail',
+     '-o, --offset=n           start list from nth dashboard or revision',
+     '-L, --limit=COUNT        number of dashboards or revisions to list',
+     '-v, --version=INTEGER    version of dashboard',
+     '-f, --format=STRING      output format']
+  end
+end

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

@@ -0,0 +1,44 @@
+require_relative './base'
+
+# Define the event command.
+#
+class WavefrontCommandEvent < WavefrontCommandBase
+  def description
+    'open, close, view, and manage events'
+  end
+
+  def _commands
+    ["list #{CMN} [-l] [-f format] [-s start] [-e end] [-L limit] " \
+      '[-o offset]',
+     "describe #{CMN} [-f format] <id>",
+     "create #{CMN} [-d description] [-s time] [-i | -e time] " \
+     '[-S severity] [-T type] [-H host...] [-N] <event>',
+     "close #{CMN} [<id>]",
+     "delete #{CMN} <id>",
+     "update #{CMN} <key=value> <id>",
+     tag_commands,
+     'show [-D]']
+  end
+
+  def _options
+    [common_options,
+     '-l, --long                list events in detail',
+     '-o, --offset=n            start list from nth event',
+     '-L, --limit=COUNT         number of events to list',
+     '-s, --start=TIME          time at which event/window begins',
+     '-e, --end=TIME            time at which even/window  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',
+     '-N, --nostate             do not create a local file recording ' \
+     'the event',
+     '-f, --format=STRING        output format']
+  end
+
+  def postscript
+    "View events in detail using the 'query' command with the " \
+      "'events()' function."
+  end
+end

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

@@ -0,0 +1,33 @@
+require_relative './base'
+
+# Define the cloud integration command.
+#
+class WavefrontCommandIntegration < WavefrontCommandBase
+  def description
+    'view and manage cloud integrations'
+  end
+
+  def sdk_file
+    'cloudintegration'
+  end
+
+  def sdk_class
+    'CloudIntegration'
+  end
+
+  def _commands
+    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+     "describe #{CMN} [-f format] <id>",
+     "delete #{CMN} <id>",
+     "undelete #{CMN} <id>",
+     "import #{CMN} <file>"]
+  end
+
+  def _options
+    [common_options,
+     '-l, --long                     list integrations in detail',
+     '-o, --offset=n                 start from nth integration',
+     '-L, --limit=COUNT              number of integrations to list',
+     '-f, --format=STRING            output format']
+  end
+end

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

@@ -0,0 +1,34 @@
+require_relative './base'
+
+# Define the external link command.
+#
+class WavefrontCommandLink < WavefrontCommandBase
+  def description
+    'view and manage external links'
+  end
+
+  def sdk_file
+    'externallink'
+  end
+
+  def sdk_class
+    'ExternalLink'
+  end
+
+  def _commands
+    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+     "describe #{CMN} [-f format] <id>",
+     "delete #{CMN} <id>",
+     "import #{CMN} <file>",
+     "update #{CMN} <key=value> <id>"
+    ]
+  end
+
+  def _options
+    [common_options,
+     '-l, --long               list external links in detail',
+     '-o, --offset=n           start from nth external link',
+     '-L, --limit=COUNT        number of external link to list',
+     '-f, --format=STRING      output format']
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative './base'
+
+# Define the message command.
+#
+class WavefrontCommandMessage < WavefrontCommandBase
+  def description
+    'read and mark user messages'
+  end
+
+  def _commands
+    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit] [-a]",
+     "mark #{CMN} [-f format] <id>"]
+  end
+
+  def _options
+    [common_options,
+     '-l, --long              list messages in detail',
+     '-o, --offset=n          start from nth message',
+     '-L, --limit=COUNT       number of messages to list',
+     '-a, --all               list all messages, not just unread',
+     '-f, --format=STRING     output format']
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative './base'
+
+# Define the metric command.
+#
+class WavefrontCommandMetric < WavefrontCommandBase
+  def description
+    'view metrics'
+  end
+
+  def _commands
+    ["describe #{CMN} [-f format] [-o offset] [-g glob...] <metric>"]
+  end
+
+  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']
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative './base'
+
+# Define the proxy command.
+#
+class WavefrontCommandProxy < WavefrontCommandBase
+  def description
+    'view and manage Wavefront proxies'
+  end
+
+  def _commands
+    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+     "describe #{CMN} [-f format] <id>",
+     "delete #{CMN} <id>",
+     "undelete #{CMN} <id>",
+     "rename #{CMN} <id> <name>"]
+  end
+
+  def _options
+    [common_options,
+     '-l, --long                list proxies in detail',
+     '-o, --offset=n            start from nth proxy',
+     '-f, --format=STRING       output format',
+     '-L, --limit=COUNT         number of proxies to list']
+  end
+end

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

@@ -0,0 +1,32 @@
+require_relative './base'
+
+# Define the query command.
+#
+class WavefrontCommandQuery < WavefrontCommandBase
+  def description
+    'query the Wavefront API'
+  end
+
+  def _commands
+    ["#{CMN} [-g granularity] [-s time] [-e time] [-f format] " \
+           '[-ivO] [-S mode] [-N name] [-p points] <query>',
+     "raw #{CMN} [-H host] [-s time] [-e time] [-f format] <metric>"]
+  end
+
+  def _options
+    [common_options,
+     '-g, --granularity=STRING  query granularity (d, h, m, or s)',
+     '-s, --start=TIME          start of query window',
+     '-e, --end=TIME            end of query window',
+     '-N, --name=STRING         name identifying query',
+     '-p, --points=INTEGER      maximum number of points to return',
+     '-i, --inclusive           include matching series with no ' \
+     'points inside the query window',
+     '-v, --events              include events for matching series',
+     '-S, --summarize=STRING    summarization strategy for bucketing ' \
+     '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']
+  end
+end

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

@@ -0,0 +1,32 @@
+require_relative './base'
+
+# Define the saved search command.
+#
+class WavefrontCommandSavedsearch < WavefrontCommandBase
+  def description
+    'view and manage saved searches'
+  end
+
+  def sdk_file
+    'savedsearch'
+  end
+
+  def sdk_class
+    'SavedSearch'
+  end
+
+  def _commands
+    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+     "describe #{CMN} [-f format] <id>",
+     "delete #{CMN} <id>",
+     "import #{CMN} <file>"]
+  end
+
+  def _options
+    [common_options,
+     '-l, --long                list saved searches in detail',
+     '-o, --offset=n            start from nth saved search',
+     '-L, --limit=COUNT         number of saved searches to list',
+     '-f, --format=STRING       output format']
+  end
+end