wavefront-sdk 0.0.1

data/lib/wavefront-sdk/cloudintegration.rb

@@ -0,0 +1,88 @@
+require_relative './base'
+
+module Wavefront
+  #
+  # View and manage Cloud Integrations. These are identified by
+  # a UUID.
+  #
+  class CloudIntegration < Wavefront::Base
+
+    # GET /api/v2/cloudintegration
+    # Get all cloud integrations for a customer
+    #
+    # @param offset [Int] integration at which the list begins
+    # @param limit [Int] the number of integration to return
+    # @return [Hash]
+    #
+    def list(offset = 0, limit = 100)
+      api_get('', { offset: offset, limit: limit })
+    end
+
+    # POST /api/v2/cloudintegration
+    # Create a cloud integration.  Refer to the Swagger API docs for
+    # valid keys.
+    #
+    # @param body [Hash] description of integration
+    # @return [Hash]
+    #
+    def create(body)
+      raise ArgumentError unless body.is_a?(Hash)
+      api_post('', body, 'application/json')
+    end
+
+    # DELETE /api/v2/cloudintegration/{id}
+    # Delete a specific cloud integration
+    #
+    # Deleting an active integration moves it to 'trash', from where
+    # it can be restored with an #undelete operation. Deleting an
+    # integration in 'trash' removes it for ever.
+    #
+    # @param id [String] ID of the integration
+    # @return [Hash]
+    #
+    def delete(id)
+      wf_cloudintegration_id?(id)
+      api_delete(id)
+    end
+
+    # GET /api/v2/cloudintegration/{id}
+    # Get a specific cloud integration
+    #
+    # @param id [String] ID of the integration
+    # @return [Hash]
+    #
+    def describe(id)
+      wf_cloudintegration_id?(id)
+      api_get(id)
+    end
+
+    # PUT /api/v2/cloudintegration/{id}
+    # Update a specific cloud integration
+    #
+    # @param id [String] ID of the integration
+    # @param body [Hash] description of integration
+    #
+    def update(id, body)
+      wf_cloudintegration_id?(id)
+      raise ArgumentError unless body.is_a?(Hash)
+      api_put(id, body)
+    end
+
+    # POST /api/v2/cloudintegration/{id}/undelete
+    # Undelete a specific cloud integration
+    #
+    # @param id [String] ID of the integration
+    # @return [Hash]
+    #
+    def undelete(id)
+      wf_cloudintegration_id?(id)
+      api_post([id, 'undelete'].uri_concat)
+    end
+  end
+
+  # A standard response.
+  #
+  class Response
+    class CloudIntegration < Base; end
+  end
+end

data/lib/wavefront-sdk/credentials.rb

@@ -0,0 +1,79 @@
+require 'pathname'
+require 'inifile'
+
+module Wavefront
+
+  # Helper methods to get Wavefront credentials
+  #
+  class Credentials
+    attr_reader :opts, :config, :creds, :proxy
+
+    # Gives you an object of credentials and options for speaking to
+    # Wavefront. It will look in the following places:
+    #
+    # ~/.wavefront
+    # /etc/wavefront/credentials
+    # WAVEFRONT_ENDPOINT and WAVEFRONT_TOKEN environment variables
+    #
+    # @param options [Hash] keys may be 'file', which
+    #   specifies a config file which will be loaded and parsed. If
+    #   no file is supplied, those listed above will be used.;
+    #   and/or 'profile' which select a profile section from 'file'
+    #
+    def initialize(options = {})
+      raw = load_from_file(options)
+      raw = env_override(raw)
+      populate(raw)
+    end
+
+    def env_override(raw)
+      { endpoint: 'WAVEFRONT_ENDPOINT',
+        token:    'WAVEFRONT_TOKEN',
+        proxy:    'WAVEFRONT_PROXY'
+      }.each { |k, v| raw[k] = ENV[v] if ENV[v] }
+      raw
+    end
+
+    def populate(raw)
+      @config = raw
+      @creds = raw.select { |k, _v| [:endpoint, :token].include?(k) }
+      @proxy = raw.select { |k, _v| [:proxy, :port].include?(k) }
+    end
+
+    def load_from_file(opts)
+      ret = {}
+
+      profile = opts[:profile] || 'default'
+
+      c_file = if opts.key?(:file)
+                 Array(Pathname.new(opts[:file]))
+               else
+                 [Pathname.new('/etc/wavefront/credentials'),
+                  Pathname.new(ENV['HOME']) + '.wavefront']
+               end
+
+      c_file.each do |f|
+        next unless f.exist?
+        ret = load_profile(f, profile)
+        ret[:file] = f
+      end
+
+      ret
+    end
+
+    # Load in configuration (optionally) given section of an
+    # ini-style configuration file not there, we don't consider that
+    # an error.
+    #
+    # @param file [Pathname] the file to read
+    # @param profile [String] the section in the config to read
+    # @return [Hash] options loaded from file. Each key becomes a
+    #   symbol
+    #
+    def load_profile(file, profile = 'default')
+      IniFile.load(file)[profile].each_with_object({}) do |(k, v), memo|
+        memo[k.to_sym] = v
+      end
+    end
+  end
+end

data/lib/wavefront-sdk/dashboard.rb

@@ -0,0 +1,157 @@
+require_relative './base'
+
+module Wavefront
+  #
+  # View and manage dashboards.
+  #
+  class Dashboard < Wavefront::Base
+
+    # GET /api/v2/dashboard
+    # Get all dashboards for a customer.
+    #
+    # @param offset [Int] dashboard at which the list begins
+    # @param limit [Int] the number of dashboard to return
+    # @return [Hash]
+    #
+    def list(offset = 0, limit = 100)
+      api_get('', { offset: offset, limit: limit })
+    end
+
+    # POST /api/v2/dashboard
+    # Create a specific dashboard.
+    # Refer to the Swagger API docs for valid keys.
+    #
+    # @param body [Hash] description of dashboard
+    # @return [Hash]
+    #
+    def create(body)
+      raise ArgumentError unless body.is_a?(Hash)
+      api_post('', body, 'application/json')
+    end
+
+    # DELETE /api/v2/dashboard/{id}
+    # Delete a specific dashboard.
+    # Deleting an active dashboard moves it to 'trash', from where it can
+    # be restored with an #undelete operation. Deleting an dashboard in
+    # 'trash' removes it for ever.
+    #
+    # @param id [String] ID of the dashboard
+    # @return [Hash]
+    #
+    def delete(id)
+      wf_dashboard_id?(id)
+      api_delete(id)
+    end
+
+    # GET /api/v2/dashboard/{id}
+    # Get a specific dashboard / Get a specific historical version of a
+    # specific dashboard.
+    #
+    # @param id [String] ID of the dashboard
+    # @param version [Integer] version of dashboard
+    # @return [Hash]
+    #
+    def describe(id, version = nil)
+      wf_dashboard_id?(id)
+      wf_version?(version) if version
+      fragments = [id]
+      fragments += ['history', version] if version
+      api_get(fragments.uri_concat)
+    end
+
+    # PUT /api/v2/dashboard/{id}
+    # Update a specific dashboard.
+    #
+    # Refer to the Swagger API docs for valid keys.
+    #
+    # @param body [Hash] description of dashboard
+    # @return [Hash]
+    #
+    def update(id, body)
+      wf_dashboard_id?(id)
+      raise ArgumentError unless body.is_a?(Hash)
+      api_put(id, body)
+    end
+
+    # GET /api/v2/dashboard/{id}/history
+    # Get the version history of an dashboard.
+    #
+    # @param id [String] ID of the dashboard
+    # @return [Hash]
+    #
+    def history(id)
+      wf_dashboard_id?(id)
+      api_get([id, 'history'].uri_concat)
+    end
+
+    # GET /api/v2/dashboard/{id}/tag
+    # Get all tags associated with a specific dashboard.
+    #
+    # @param id [String] ID of the dashboard
+    # @returns [Hash] object describing the dashboard with status and
+    #   response keys
+    #
+    def tags(id)
+      wf_dashboard_id?(id)
+      api_get([id, 'tag'].uri_concat)
+    end
+
+    # POST /api/v2/dashboard/{id}/tag
+    # Set all tags associated with a specific dashboard.
+    #
+    # @param id [String] ID of the dashboard
+    # @param tags [Array] list of tags to set.
+    # @returns [Hash] object describing the dashboard with status and
+    #   response keys
+    #
+    def tag_set(id, tags)
+      wf_dashboard_id?(id)
+      tags = Array(tags)
+      tags.each { |t| wf_string?(t) }
+      api_post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
+    end
+
+    # DELETE /api/v2/dashboard/{id}/tag/{tagValue}
+    # Remove a tag from a specific dashboard.
+    #
+    # @param id [String] ID of the dashboard
+    # @param tag [String] tag to delete
+    # @returns [Hash] object with 'status' key and empty 'repsonse'
+    #
+    def tag_delete(id, tag)
+      wf_dashboard_id?(id)
+      wf_string?(tag)
+      api_delete([id, 'tag', tag].uri_concat)
+    end
+
+    # PUT /api/v2/dashboard/{id}/tag/{tagValue}
+    # Add a tag to a specific dashboard.
+    #
+    # @param id [String] ID of the dashboard
+    # @param tag [String] tag to set.
+    # @returns [Hash] object with 'status' key and empty 'repsonse'
+    #
+    def tag_add(id, tag)
+      wf_dashboard_id?(id)
+      wf_string?(tag)
+      api_put([id, 'tag', tag].uri_concat)
+    end
+
+    # POST /api/v2/dashboard/{id}/undelete
+    # Move an dashboard from 'trash' back into active service.
+    #
+    # @param id [String] ID of the dashboard
+    # @return [Hash]
+    #
+    def undelete(id)
+      wf_dashboard_id?(id)
+      api_post([id, 'undelete'].uri_concat)
+    end
+  end
+
+  # A standard response.
+  #
+  class Response
+    class Dashboard < Base; end
+  end
+end

data/lib/wavefront-sdk/event.rb

@@ -0,0 +1,173 @@
+require_relative './base'
+
+module Wavefront
+  #
+  # View and manage events. Events are identified by their millisecond
+  # epoch timestamp.
+  #
+  class Event < Wavefront::Base
+    @update_keys = [:startTime, :endTime, :name, :annotations]
+
+    # GET /api/v2/event
+    # List all the events for a customer within a time range.
+    #
+    # @param from [Time, Integer] start of time range. The API
+    #   requires this time as epoch milliseconds, but we will also
+    #   accept it as a Ruby Time object.
+    # @param to [Time, Integer] end ot time range. Can be epoch
+    #   millisecods or a Ruby time. If not supplied, defaults to the
+    #   current time.
+    # @cursor [String] I think this is the 
+    #   must start with a timestamp.
+    # @limit [Integer] the number of events to return
+    # @return [Hash]
+    #
+    def list(from = nil, to = nil, limit = 100, cursor = nil)
+      raise ArgumentError unless from && to
+      from = parse_time(from, true)
+      to = parse_time(to, true)
+      wf_ms_ts?(from)
+      wf_ms_ts?(to)
+      wf_event_id?(cursor) if cursor
+      raise ArgumentError unless limit.is_a?(Integer)
+
+      api_get('', { earliestStartTimeEpochMillis: from,
+                    latestStartTimeEpochMillis: to,
+                    cursor: cursor,
+                    limit: limit }.select { |_k, v| v })
+    end
+
+    # POST /api/v2/event
+    # Create a specific event.
+    #
+    # We used to validate keys and provide helpers for time fields.
+    # Now ensuring a valid hash is entirely left up to the user.
+    # Refer to the Swagger docs for more information.
+    #
+    # @param body [Hash] description of event
+    # @return [Hash]
+    #
+    def create(body)
+      raise ArgumentError unless body.is_a?(Hash)
+      api_post('', body, 'application/json')
+    end
+
+    # DELETE /api/v2/event/{id}
+    # Delete a specific event.
+    #
+    # @param id [String] ID of the alert
+    # @return [Hash]
+    #
+    def delete(id)
+      wf_event_id?(id)
+      api_delete(id)
+    end
+
+    # GET /api/v2/event/{id}
+    # Get a specific event / Get a specific historical version of a
+    # specific event.
+    #
+    # @param id [String] ID of the event
+    # @param version [Integer] version of event
+    # @return [Hash]
+    #
+    def describe(id, version = nil)
+      wf_event_id?(id)
+      wf_version?(version) if version
+      fragments = [id]
+      fragments += ['history', version] if version
+      api_get(fragments.uri_concat)
+    end
+
+    # PUT /api/v2/event/{id}
+    # Update a specific event
+    #
+    # This method helps you update one or more properties of an event.
+    #
+    # @param id [String] a Wavefront Event ID
+    # @param body [Hash] description of event.
+    # @param modify [Bool] if this is true, then the existing event
+    #   object will be fetched and merged with the user-supplied body.
+    #   The resulting object will be passed to the API. If this is
+    #   false, the body will be passed through unmodified.
+    # @return [Hash]
+    #
+    def update(id, body, modify = true)
+      wf_event_id?(id)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      return api_put(id, body, 'application/json') unless modify
+
+      api_put(id, hash_for_update(describe(id), body), 'application/json')
+    end
+
+    # POST /api/v2/event/{id}/close
+    # Close a specific event.
+    #
+    # @param id [String] the ID of the event
+    #
+    def close(id)
+      wf_event_id?(id)
+      api_post([id, 'close'].uri_concat)
+    end
+
+    # GET /api/v2/event/{id}/tag
+    # Get all tags associated with a specific event
+    #
+    # @param id [String] ID of the event
+    # @returns [Hash] object describing the event with status and
+    #   response keys
+    #
+    def tags(id)
+      wf_event_id?(id)
+      api_get([id, 'tag'].uri_concat)
+    end
+
+    # POST /api/v2/event/{id}/tag
+    # Set all tags associated with a specific event.
+    #
+    # @param id [String] ID of the event
+    # @param tags [Array] list of tags to set.
+    # @returns [Hash] object describing the event with status and
+    #   response keys
+    #
+    def tag_set(id, tags)
+      wf_event_id?(id)
+      tags = Array(tags)
+      tags.each { |t| wf_string?(t) }
+      api_post([id, 'tag'].uri_concat, tags, 'application/json')
+    end
+
+    # DELETE /api/v2/event/{id}/tag/{tagValue}
+    # Remove a tag from a specific event.
+    #
+    # @param id [String] ID of the event
+    # @param tag [String] tag to delete
+    # @returns [Hash] object with 'status' key and empty 'repsonse'
+    #
+    def tag_delete(id, tag)
+      wf_event_id?(id)
+      wf_string?(tag)
+      api_delete([id, 'tag', tag].uri_concat)
+    end
+
+    # PUT /api/v2/event/{id}/tag/{tagValue}
+    # Add a tag to a specific event.
+    #
+    # @param id [String] ID of the event
+    # @param tag [String] tag to set.
+    # @returns [Hash] object with 'status' key and empty 'repsonse'
+    #
+    def tag_add(id, tag)
+      wf_event_id?(id)
+      wf_string?(tag)
+      api_put([id, 'tag', tag].uri_concat)
+    end
+  end
+
+  # A standard response.
+  #
+  class Response
+    class Event < Base; end
+  end
+end