wavefront-sdk 6.0.0 → 8.0.0

data/lib/wavefront-sdk/derivedmetric.rb

@@ -34,7 +34,7 @@ module Wavefront
       api.post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/derivedmetric/id
+    # DELETE /api/v2/derivedmetric/{id}
     # Delete a specific derived metric definition.
     # Deleting an active derived metric moves it to 'trash', from
     # where it can be restored with an #undelete operation. Deleting
@@ -48,7 +48,8 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/derivedmetric/id
+    # GET /api/v2/derivedmetric/{id}
+    # GET /api/v2/derivedmetric/{id}/history/{version}
     # Get a specific derived metric definition / Get a specific
     # historical version of a specific derived metric definition.
     #
@@ -64,10 +65,10 @@ module Wavefront
       api.get(fragments.uri_concat)
     end
 
-    # PUT /api/v2/derivedmetric/id
+    # PUT /api/v2/derivedmetric/{id}
     # Update a specific derived metric definition.
     #
-    # @param id [String] a Wavefront alert ID
+    # @param id [String] a Wavefront derived metric ID
     # @param body [Hash] key-value hash of the parameters you wish
     #   to change
     # @param modify [true, false] if true, use {#describe()} to get
@@ -85,7 +86,7 @@ module Wavefront
               'application/json')
     end
 
-    # GET /api/v2/derivedmetric/id/history
+    # GET /api/v2/derivedmetric/{id}/history
     # Get the version history of a derived metric definition.
     #
     # @param id [String] ID of the derived metric
@@ -96,7 +97,7 @@ module Wavefront
       api.get([id, 'history'].uri_concat)
     end
 
-    # POST /api/v2/derivedmetric/id/undelete
+    # POST /api/v2/derivedmetric/{id}/undelete
     # Move a derived metric definition from 'trash' back into active
     # service.
     #

data/lib/wavefront-sdk/event.rb

@@ -56,10 +56,10 @@ module Wavefront
       api.post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/event/id
+    # DELETE /api/v2/event/{id}
     # Delete a specific event.
     #
-    # @param id [String] ID of the alert
+    # @param id [String] ID of the event
     # @return [Wavefront::Response]
     #
     def delete(id)
@@ -67,7 +67,7 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/event/id
+    # GET /api/v2/event/{id}
     # Get a specific event / Get a specific historical version of a
     # specific event.
     #
@@ -83,7 +83,7 @@ module Wavefront
       api.get(fragments.uri_concat)
     end
 
-    # PUT /api/v2/event/id
+    # PUT /api/v2/event/{id}
     # Update a specific event
     #
     # This method helps you update one or more properties of an event.
@@ -107,7 +107,7 @@ module Wavefront
               'application/json')
     end
 
-    # POST /api/v2/event/id/close
+    # POST /api/v2/event/{id}/close
     # Close a specific event.
     #
     # @param id [String] the ID of the event

data/lib/wavefront-sdk/externallink.rb

@@ -38,7 +38,7 @@ module Wavefront
       api.post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/extlink/id
+    # DELETE /api/v2/extlink/{id}
     # Delete a specific external link.
     #
     # @param id [String] ID of the link
@@ -49,7 +49,7 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/extlink/id
+    # GET /api/v2/extlink/{id}
     # Get a specific external link.
     #
     # @param id [String] ID of the limnk
@@ -60,7 +60,7 @@ module Wavefront
       api.get(id)
     end
 
-    # PUT /api/v2/extlink/id
+    # PUT /api/v2/extlink/{id}
     # Update a specific external link.
     #
     # @param id [String] a Wavefront external link ID

data/lib/wavefront-sdk/ingestionpolicy.rb

@@ -41,7 +41,7 @@ module Wavefront
     # DELETE /api/v2/usage/ingestionpolicy/{id}
     # Delete a specific ingestion policy
     #
-    # @param id [String] ID of the alert
+    # @param id [String] ID of the ingestion policy
     # @return [Wavefront::Response]
     #
     def delete(id)
@@ -50,21 +50,26 @@ module Wavefront
     end
 
     # GET /api/v2/usage/ingestionpolicy/{id}
+    # GET /api/v2/usage/ingestionpolicy/{id}/history/{version}
     # Get a specific ingestion policy
     #
     # @return [Wavefront::Response]
-    # @param id [String] ID of the proxy
+    # @param id [String] ID of the ingestion policy
+    # @param version [Integer] version of ingestion policy
     # @return [Wavefront::Response]
     #
-    def describe(id)
+    def describe(id, version = nil)
       wf_ingestionpolicy_id?(id)
-      api.get(id)
+      wf_version?(version) if version
+      fragments = [id]
+      fragments += ['history', version] if version
+      api.get(fragments.uri_concat)
     end
 
     # PUT /api/v2/usage/ingestionpolicy/{id}
     # Update a specific ingestion policy
     #
-    # @param id [String] a Wavefront alert ID
+    # @param id [String] ID of the ingestion policy
     # @param body [Hash] key-value hash of the parameters you wish
     #   to change
     # @param modify [true, false] if true, use {#describe()} to get
@@ -82,6 +87,28 @@ module Wavefront
               'application/json')
     end
 
+    # GET /api/v2/usage/ingestionpolicy/{id}/history
+    # Get the version history of ingestion policy
+    # @param id [String] ID of the ingestion policy
+    # @return [Wavefront::Response]
+    #
+    def history(id)
+      wf_ingestionpolicy_id?(id)
+      api.get([id, 'history'].uri_concat)
+    end
+
+    # POST /api/v2/usage/ingestionpolicy/{id}/revert/{version}
+    # Revert to a specific historical version of a ingestion policy
+    # @param id [String] ID of the ingestion policy
+    # @param version [Integer] version to revert to
+    # @return [Wavefront::Response]
+    #
+    def revert(id, version)
+      wf_ingestionpolicy_id?(id)
+      wf_version?(version)
+      api.post([id, 'revert', version].uri_concat, nil, 'application/json')
+    end
+
     def update_keys
       %i[name]
     end

data/lib/wavefront-sdk/integration.rb

@@ -19,7 +19,7 @@ module Wavefront
       api.get('', offset: offset, limit: limit)
     end
 
-    # GET /api/v2/integration/id
+    # GET /api/v2/integration/{id}
     # Gets a single Wavefront integration by its id, along with its
     # status
     #
@@ -31,7 +31,7 @@ module Wavefront
       api.get(id)
     end
 
-    # POST /api/v2/integration/id/install
+    # POST /api/v2/integration/{id}/install
     # Installs a Wavefront integration
     #
     # @param id [String] ID of the integration
@@ -53,7 +53,7 @@ module Wavefront
       api.post([id, 'install-all-alerts'].uri_concat, nil)
     end
 
-    # GET /api/v2/integration/id/status
+    # GET /api/v2/integration/{id}/status
     # Gets the status of a single Wavefront integration
     #
     # @param id [String] ID of the integration
@@ -64,7 +64,7 @@ module Wavefront
       api.get([id, 'status'].uri_concat)
     end
 
-    # POST /api/v2/integration/id/uninstall
+    # POST /api/v2/integration/{id}/uninstall
     # Uninstalls a Wavefront integration
     #
     # @param id [String] ID of the integration
@@ -114,5 +114,15 @@ module Wavefront
     def statuses
       api.get('status')
     end
+
+    # GET /api/v2/integration/manifests/min
+    # Gets all Wavefront integrations as structured in their integration
+    # manifests.
+    #
+    # @return [Wavefront::Response]
+    #
+    def manifests_min
+      api.get('manifests/min')
+    end
   end
 end

data/lib/wavefront-sdk/internals.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'pathname'
+
+module Wavefront
+  #
+  # Methods to inspect the SDK itselr.
+  #
+  class Internals
+    API_REGEX = %r{^\s+ # (GET|POST|PUT|DELETE|PATCH) /}
+
+    # @return [Array[Pathname]] SDK API files
+    #
+    def sdk_files
+      Pathname.glob("#{__dir__}/**/*")
+              .select { |f| f.file? && f.extname == '.rb' }
+              .reject { |f| f == Pathname.new(__FILE__) }
+    end
+
+    # @return [Array[String]] list of all the remote API paths the SDK covers.
+    # Depends on the code being commented correctly, so not 100% bulletproof.
+    #
+    # rubocop:disable Metrics/AbcSize
+    def supported_api_paths
+      mix = { acl: [], tag: [], user: [] }
+      searches = []
+
+      paths = sdk_files.map do |f|
+        lines = File.readlines(f)
+        searches << f if lines.grep('CoreApi')
+        mix.each_key { |m| mix[m] << f if lines.grep(%r{"api_mixins/#{m}"}) }
+        lines.grep(API_REGEX)
+      end
+
+      clean = paths_struct(clean_paths(paths))
+      clean + mixin_paths(clean, mix) + search_paths(clean, searches)
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def clean_paths(paths)
+      paths.flatten.compact.map { |s| s.strip.sub(/^# /, '') }
+    end
+
+    def search_paths(paths, files)
+      search_paths = paths.select { |_v, x| x.include?('/search/') }
+
+      search_paths.each_with_object([]) do |(verb, path), ret|
+        files.each { |f| ret << [verb, path.sub('{entity}', api_word(f))] }
+      end
+    end
+
+    def remote_api_paths(spec = swagger_spec)
+      paths = JSON.parse(spec)['paths'].map do |path, data|
+        data.keys.map { |verb| [verb.upcase, path].join(' ') }
+      end
+
+      paths_struct(paths.flatten)
+    end
+
+    def missing_api_paths
+      # We don't have an explicit method for the many search paths: they're
+      # all bundled together under a generic Wavefront::Search.
+      (remote_api_paths - supported_api_paths).reject do |_method, path|
+        path.start_with?('/api/v2/search/')
+      end
+    end
+
+    private
+
+    def mixin_paths(paths, mixins)
+      mixins.each_with_object([]) do |(mixin, files), ret|
+        files.each do |file|
+          paths.select { |_v, x| x.include?(mixin.to_s) }.each do |verb, path|
+            ret << [verb, path.sub('{entity}', api_word(file))]
+          end
+        end
+      end
+    end
+
+    def api_word(file)
+      file.basename.to_s.sub(/\.rb$/, '')
+    end
+
+    def swagger_spec
+      Faraday.get('https://metrics.wavefront.com/api/v2/swagger.json').body
+    end
+
+    def paths_struct(paths)
+      paths.map(&:split).sort_by { |_k, v| v }
+    end
+  end
+end

data/lib/wavefront-sdk/maintenancewindow.rb

@@ -38,7 +38,7 @@ module Wavefront
       api.post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/maintenancewindow/id
+    # DELETE /api/v2/maintenancewindow/{id}
     # Delete a specific maintenance window.
     #
     # @param id [String, Integer] ID of the maintenance window
@@ -49,7 +49,7 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/maintenancewindow/id
+    # GET /api/v2/maintenancewindow/{id}
     # Get a specific maintenance window.
     #
     # @param id [String, Integer] ID of the maintenance window
@@ -60,7 +60,7 @@ module Wavefront
       api.get(id)
     end
 
-    # PUT /api/v2/maintenancewindow/id
+    # PUT /api/v2/maintenancewindow/{id}
     # Update a specific maintenance window.
     #
     # @param id [String] a Wavefront maintenance window ID
@@ -93,7 +93,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def pending(hours = 24)
-      cutoff = Time.now.to_i + hours * 3600
+      cutoff = Time.now.to_i + (hours * 3600)
 
       ret = windows_in_state(:pending)
 

data/lib/wavefront-sdk/message.rb

@@ -18,7 +18,7 @@ module Wavefront
       api.get('', offset: offset, limit: limit, unreadOnly: unread_only)
     end
 
-    # POST /api/v2/message/id/read
+    # POST /api/v2/message/{id}/read
     # Mark a specific message as read
     #
     # @param id [String] message ID to mark as read

data/lib/wavefront-sdk/metric.rb

@@ -27,10 +27,10 @@ module Wavefront
       if cursor
         raise ArgumentError unless cursor.is_a?(String)
 
-        query.<< [:c, cursor]
+        query << [:c, cursor]
       end
 
-      sources.each { |source| query.<< [:h, source] }
+      sources.each { |source| query << [:h, source] }
 
       api.get('detail', query)
     end

data/lib/wavefront-sdk/metric_helper.rb

@@ -37,7 +37,7 @@ module Wavefront
     def gauge(path, value, tags = nil)
       gauge = { path: path, ts: Time.now.to_i, value: value }
       gauge[:tags] = tags if tags
-      @buf[:gauges].<< gauge
+      @buf[:gauges] << gauge
     end
 
     # These counters are internal, and specific to the SDK. When

data/lib/wavefront-sdk/metricspolicy.rb

@@ -30,17 +30,17 @@ module Wavefront
     # @param limit [Integer] the number of versions to return
     #
     def history(offset = 0, limit = 100)
-      api.get('', offset: offset, limit: limit)
+      api.get('history', offset: offset, limit: limit)
     end
 
     # POST /api/v2/metricspolicy/revert/{version}
     # Revert to a specific historical version of a metrics policy
-    # @param version [Integer] specify version to describe
+    # @param version [Integer] version to revert to
     # @return [Wavefront::Response]
     #
     def revert(version)
       wf_version?(version)
-      api.post(['revert', version].uri_concat)
+      api.post(['revert', version].uri_concat, nil, 'application/json')
     end
 
     # PUT /api/v2/metricspolicy

data/lib/wavefront-sdk/monitoredapplication.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'core/api'
+
+module Wavefront
+  #
+  # Manage and query Wavefront monitored applications
+  #
+  class MonitoredApplication < CoreApi
+    def update_keys
+      %i[hidden application satisfiedLatencyMillis]
+    end
+
+    # GET /api/v2/monitoredapplication
+    # Get all monitored services
+    #
+    # @param offset [Integer] application at which the list begins
+    # @param limit [Integer] the number of application to return
+    #
+    def list(offset = 0, limit = 100)
+      api.get('', offset: offset, limit: limit)
+    end
+
+    # GET /api/v2/monitoredapplication/{application}
+    # Get a specific application
+    #
+    # @param id [String, Integer] ID of the application
+    # @return [Wavefront::Response]
+    #
+    def describe(id)
+      wf_monitoredapplication_id?(id)
+      api.get(id)
+    end
+
+    # PUT /api/v2/monitoredapplication/{application}
+    # Update a specific service
+    #
+    # @param id [String] a Wavefront monitored application ID
+    # @param body [Hash] key-value hash of the parameters you wish to change
+    # @param modify [true, false] if true, use {#describe()} to get a hash
+    #   describing the existing object, and modify that with the new body. If
+    #   false, pass the new body straight through.
+    # @return [Wavefront::Response]
+
+    def update(id, body, modify = true)
+      wf_monitoredapplication_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).response, body),
+              'application/json')
+    end
+  end
+end

data/lib/wavefront-sdk/notificant.rb

@@ -29,7 +29,7 @@ module Wavefront
       api.post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/notificant/id
+    # DELETE /api/v2/notificant/{id}
     # Delete a specific notificant
     #
     # @param id [String] ID of the notification target
@@ -40,7 +40,7 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/notificant/id
+    # GET /api/v2/notificant/{id}
     # Get a specific notification target
     #
     # @param id [String] ID of the notification target
@@ -51,7 +51,7 @@ module Wavefront
       api.get(id)
     end
 
-    # PUT /api/v2/notificant/id
+    # PUT /api/v2/notificant/{id}
     # Update a specific notification target
     #
     # @param id [String] a Wavefront notification target ID
@@ -72,7 +72,7 @@ module Wavefront
               'application/json')
     end
 
-    # POST /api/v2/notificant/test/id
+    # POST /api/v2/notificant/test/{id}
     # Create a notification target.
     #
     # @param body [Hash] description of notification target

data/lib/wavefront-sdk/paginator/base.rb

@@ -166,7 +166,7 @@ module Wavefront
             end
 
             p_args = set_pagination(offset, page_size, p_args)
-            resp.response.items.map { |i| y.<< i }
+            resp.response.items.map { |i| y << i }
             raise StopIteration unless resp.more_items?
           end
         end.lazy

data/lib/wavefront-sdk/proxy.rb

@@ -17,7 +17,7 @@ module Wavefront
       api.get('', offset: offset, limit: limit)
     end
 
-    # DELETE /api/v2/proxy/id
+    # DELETE /api/v2/proxy/{id}
     # Delete a specific proxy
     #
     # Deleting an active proxy moves it to 'trash', from where it
@@ -32,7 +32,7 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/proxy/id
+    # GET /api/v2/proxy/{id}
     # Get a specific proxy
     #
     # @param id [String] ID of the proxy
@@ -43,7 +43,7 @@ module Wavefront
       api.get(id)
     end
 
-    # POST /api/v2/proxy/id/undelete
+    # POST /api/v2/proxy/{id}/undelete
     # Undelete a specific proxy
     #
     # Move a proxy from 'trash' back into active service.
@@ -56,7 +56,7 @@ module Wavefront
       api.post([id, 'undelete'].uri_concat)
     end
 
-    # PUT /api/v2/proxy/id
+    # PUT /api/v2/proxy/{id}
     # Update the name of a specific proxy
     #
     # Rename a proxy. This changes the human-readable name, not the
@@ -96,5 +96,27 @@ module Wavefront
       wf_proxy_id?(id)
       api.put(id, { shutdown: true }, 'application/json')
     end
+
+    # GET /api/v2/proxy/{id}/config
+    # Get a specific proxy config
+    #
+    # @param id [String] ID of the proxy
+    # @return [Wavefront::Response]
+    #
+    def config(id)
+      wf_proxy_id?(id)
+      api.get([id, 'config'].uri_concat)
+    end
+
+    # GET /api/v2/proxy/{id}/preprocessorRules
+    # Get a specific proxy preprocessor rules
+    #
+    # @param id [String] ID of the proxy
+    # @return [Wavefront::Response]
+    #
+    def preprocessor_rules(id)
+      wf_proxy_id?(id)
+      api.get([id, 'preprocessorRules'].uri_concat)
+    end
   end
 end

data/lib/wavefront-sdk/role.rb

@@ -16,8 +16,8 @@ module Wavefront
 
     # GET /api/v2/role
     # Get all roles for a customer
-    # @param offset [Int] alert at which the list begins
-    # @param limit [Int] the number of alerts to return
+    # @param offset [Int] item at which the list begins
+    # @param limit [Int] the number of items to return
     # @return [Wavefront::Response]
     #
     def list(offset = 0, limit = 100)

data/lib/wavefront-sdk/savedsearch.rb

@@ -32,7 +32,7 @@ module Wavefront
       api.post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/savedsearch/id
+    # DELETE /api/v2/savedsearch/{id}
     # Delete a specific saved search.
     #
     # @param id [String] ID of the saved search
@@ -43,7 +43,7 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/savedsearch/id
+    # GET /api/v2/savedsearch/{id}
     # Get a specific saved search.
     #
     # @param id [String] ID of the saved search
@@ -54,7 +54,7 @@ module Wavefront
       api.get(id)
     end
 
-    # PUT /api/v2/savedsearch/id
+    # PUT /api/v2/savedsearch/{id}
     # Update a specific saved search.
     #
     # @param id [String] ID of the saved search
@@ -67,7 +67,7 @@ module Wavefront
       api.put(id, body)
     end
 
-    # GET /api/v2/savedsearch/type/entitytype
+    # GET /api/v2/savedsearch/type/{entitytype}
     # Get all saved searches for a specific entity type for a user.
     #
     # @param entitytype [String] type of entity to retrieve

data/lib/wavefront-sdk/search.rb

@@ -10,8 +10,8 @@ module Wavefront
   # lot up to the user. It may grow, with convenience methods.
   #
   class Search < CoreApi
-    # POST /api/v2/search/entity
-    # POST /api/v2/search/entity/deleted
+    # POST /api/v2/search/{entity}
+    # POST /api/v2/search/{entity}/deleted
     # Run a search query. This single method maps to many API paths.
     # It is a wrapper around #raw_search() for common, single
     # key-value searches. If you need to do more complicated things,
@@ -78,8 +78,8 @@ module Wavefront
         ascending: !options[:desc] || true }
     end
 
-    # POST /api/v2/search/entity
-    # POST /api/v2/search/entity/deleted
+    # POST /api/v2/search/{entity}
+    # POST /api/v2/search/{entity}/deleted
     # Run a search query. This single method maps to many API paths.
     #
     # @param entity [String] the type of Wavefront object you wish
@@ -98,10 +98,12 @@ module Wavefront
       end
 
       path = [entity]
-      path.<< 'deleted' if deleted
+      path << 'deleted' if deleted
       api.post(path, body, 'application/json')
     end
 
+    # POST /api/v2/search/{entity}/facets
+    # POST /api/v2/search/{entity}/{facet}
     # @param entity [String] the type of Wavefront object you wish
     #   to search
     # @param body [Hash] the query to use for searching. Refer to
@@ -119,8 +121,8 @@ module Wavefront
       raise ArgumentError unless entity.is_a?(String) && body.is_a?(Hash)
 
       path = [entity]
-      path.<< 'deleted' if deleted
-      path.<< facet || 'facets'
+      path << 'deleted' if deleted
+      path << (facet || 'facets')
       api.post(path, body, 'application/json')
     end
     # rubocop:enable Metrics/ParameterLists