wavefront-sdk 1.6.2 → 2.0.0

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

@@ -0,0 +1,11 @@
+require_relative 'base'
+
+module Wavefront
+  module Paginator
+    #
+    # As far as I know, there are no DELETE methods with paginated
+    # output.
+    #
+    class Delete < Base; end
+  end
+end

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

@@ -0,0 +1,11 @@
+require_relative 'base'
+
+module Wavefront
+  module Paginator
+    #
+    # GET pagination is handled in the Base class without further
+    # modification.
+    #
+    class Get < Base; end
+  end
+end

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

@@ -0,0 +1,64 @@
+require 'json'
+require_relative 'base'
+
+module Wavefront
+  module Paginator
+    #
+    # We need to monkey-patch the Base class to pre-process data for
+    # a couple of methods.
+    #
+    class Post < Base
+      #
+      # super#setpagination requires that the args are an array, and
+      # that one of the args is a hash containing limit and offset
+      # keys.
+      #
+      def set_pagination(offset, limit, args)
+        super(offset, limit, body_as(Hash, args))
+        body_as(String, args)
+      end
+
+      # super#limit_and_offset requires a hash containing the limit
+      # and offset values. In a POST that's in the body of the
+      # request, which at this point has been turned into a JSON
+      # string. We have to temporarily turn it back into an object
+      # and pass it up to the superclass.
+      #
+      # The body is the second argument. We'll allow for it already
+      # being an object, just in case.
+      #
+      def limit_and_offset(args)
+        super(body_as(Hash, args))
+      end
+
+      # Faraday needs the body of the POST to be described as a JSON
+      # string, but our methods which modify the body for recursive
+      # calls need it as a hash. This method takes an array of args
+      # and ensures the body element is either a string or an
+      # object. If the body cannot be turned into JSON, which some
+      # bodies can't, return an empty array.
+      #
+      # @param desired [Class] String or Hash, what you want the
+      #   class of the body element to be
+      # @param args [Array] the arguments to the Faraday call method
+      # @params index [Integer] the index of the body element.
+      #   Always 1, AFAIK.
+      # @return [Array] of args
+      #
+      def body_as(desired, args, index = 1)
+        body = args[index]
+
+        return args if body.class == desired
+
+        args[index] = if body.is_a?(String)
+                        JSON.parse(body, symbolize_names: true)
+                      else
+                        body.to_json
+                      end
+        args
+      rescue JSON::ParserError
+        []
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+require_relative 'base'
+
+module Wavefront
+  module Paginator
+    #
+    # As far as I know, there are no PUT methods with paginated
+    # output.
+    #
+    class Put < Base; end
+  end
+end

data/lib/wavefront-sdk/proxy.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # Manage and query Wavefront proxies.
   #
-  class Proxy < Base
+  class Proxy < CoreApi
     # GET /api/v2/proxy
     # Get all proxies for a customer
     #
@@ -12,7 +12,7 @@ module Wavefront
     # @param limit [Int] the number of proxies to return
     #
     def list(offset = 0, limit = 100)
-      api_get('', offset: offset, limit: limit)
+      api.get('', offset: offset, limit: limit)
     end
 
     # DELETE /api/v2/proxy/id
@@ -27,7 +27,7 @@ module Wavefront
     #
     def delete(id)
       wf_proxy_id?(id)
-      api_delete(id)
+      api.delete(id)
     end
 
     # GET /api/v2/proxy/id
@@ -38,7 +38,7 @@ module Wavefront
     #
     def describe(id)
       wf_proxy_id?(id)
-      api_get(id)
+      api.get(id)
     end
 
     # POST /api/v2/proxy/id/undelete
@@ -51,7 +51,7 @@ module Wavefront
     #
     def undelete(id)
       wf_proxy_id?(id)
-      api_post([id, 'undelete'].uri_concat)
+      api.post([id, 'undelete'].uri_concat)
     end
 
     # PUT /api/v2/proxy/id
@@ -82,7 +82,7 @@ module Wavefront
     #
     def update(id, payload)
       wf_proxy_id?(id)
-      api_put(id, payload)
+      api.put(id, payload)
     end
   end
 end

data/lib/wavefront-sdk/query.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # Query Wavefront metrics.
   #
-  class Query < Base
+  class Query < CoreApi
     def api_base
       'chart'
     end
@@ -41,7 +41,7 @@ module Wavefront
       options[:e] = parse_time(t_end, true) if t_end
 
       options.delete_if { |k, v| v == false && k != :i }
-      api_get('api', options)
+      api.get('api', options)
     end
 
     # GET /api/v2/chart/raw
@@ -70,7 +70,7 @@ module Wavefront
       options[:startTime] = parse_time(t_start, true) if t_start
       options[:endTime] = parse_time(t_end, true) if t_end
 
-      api_get('raw', options)
+      api.get('raw', options)
     end
 
     # Fake a response which looks like we get from all the other

data/lib/wavefront-sdk/report.rb

@@ -1,32 +1,16 @@
-require_relative 'base_write'
+require_relative 'write'
 
 module Wavefront
   #
-  # This class helps you send points direct to the Wavefront API.
+  # This class is now a shim around Wavefront::Write, which forces
+  # the use of the Wavefront::Writer::Api writer. It is probably
+  # better to use Wavefront::Write directly. This class has been
+  # left in for backward-compatability.
   #
-  # The points are prepped in the BaseWrite class, which this
-  # extends. This class provides the transport mechanism.
-  #
-  class Report < BaseWrite
-    def api_path
-      '/report'
-    end
-
-    def write(points = [], _openclose = true, prefix = nil)
-      _write_loop(prepped_points(points, prefix))
-    end
-
-    def really_send_point(point)
-      api_post('/?f=graphite_v2', point, 'application/octet-stream')
-    end
-
-    private
-
-    # Because API calls are expensive (compared to hitting a local
-    # proxy) we will bundle up points into a single call.
-    #
-    def _write_loop(points)
-      send_point(points.map { |p| hash_to_wf(p) }.join("\n"))
+  class Report < Write
+    def initialize(creds = {}, opts = {})
+      opts[:writer] = :api
+      super(creds, opts)
     end
   end
 end

data/lib/wavefront-sdk/savedsearch.rb

@@ -1,11 +1,11 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # View and manage Cloud Integrations. These are identified by
   # a UUID.
   #
-  class SavedSearch < Base
+  class SavedSearch < CoreApi
     # GET /api/v2/savedsearch
     # Get all saved searches for a user.
     #
@@ -14,7 +14,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def list(offset = 0, limit = 100)
-      api_get('', offset: offset, limit: limit)
+      api.get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/savedsearch
@@ -26,7 +26,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
-      api_post('', body, 'application/json')
+      api.post('', body, 'application/json')
     end
 
     # DELETE /api/v2/savedsearch/id
@@ -37,7 +37,7 @@ module Wavefront
     #
     def delete(id)
       wf_savedsearch_id?(id)
-      api_delete(id)
+      api.delete(id)
     end
 
     # GET /api/v2/savedsearch/id
@@ -48,7 +48,7 @@ module Wavefront
     #
     def describe(id)
       wf_savedsearch_id?(id)
-      api_get(id)
+      api.get(id)
     end
 
     # PUT /api/v2/savedsearch/id
@@ -60,7 +60,7 @@ module Wavefront
     def update(id, body)
       wf_savedsearch_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
-      api_put(id, body)
+      api.put(id, body)
     end
 
     # GET /api/v2/savedsearch/type/entitytype
@@ -73,7 +73,7 @@ module Wavefront
     #
     def entity(entitytype, offset = 0, limit = 100)
       wf_savedsearch_entity?(entitytype)
-      api_get(['type', entitytype].uri_concat, offset: offset,
+      api.get(['type', entitytype].uri_concat, offset: offset,
                                                limit: limit)
     end
   end

data/lib/wavefront-sdk/search.rb

@@ -1,4 +1,4 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
@@ -7,7 +7,7 @@ module Wavefront
   # this class covers the whole API with two methods, but leaves a
   # lot up to the user. It may grow, with convenience methods.
   #
-  class Search < Base
+  class Search < CoreApi
     # POST /api/v2/search/entity
     # POST /api/v2/search/entity/deleted
     # Run a search query. This single method maps to many API paths.
@@ -45,15 +45,18 @@ module Wavefront
     # Build a query body
     #
     def body(query, options)
-      ret = {
-        limit:  options[:limit] || 10,
-        offset: options[:offset] || 0,
-        query:  [query].flatten,
-        sort:   { field:     [query].flatten.first[:key],
-                  ascending: !options[:desc] || true }
-      }
+      ret = { limit:  options[:limit]  || 10,
+              offset: options[:offset] || 0 }
+
+      if query && !query.empty?
+        ret[:query] = [query].flatten.map do |q|
+          q.tap { |iq| iq[:matchingMethod] ||= 'CONTAINS' }
+        end
+
+        ret[:sort] = { field:     [query].flatten.first[:key],
+                       ascending: !options[:desc] || true }
+      end
 
-      ret[:query].map { |q| q[:matchingMethod] ||= 'CONTAINS' }
       ret
     end
 
@@ -78,7 +81,7 @@ module Wavefront
 
       path = [entity]
       path.<< 'deleted' if deleted
-      api_post(path, body.to_json, 'application/json')
+      api.post(path, body, 'application/json')
     end
 
     # @param entity [String] the type of Wavefront object you wish
@@ -98,8 +101,8 @@ module Wavefront
 
       path = [entity]
       path.<< 'deleted' if deleted
-      path.<< facet ? facet : 'facets'
-      api_post(path, body, 'application/json')
+      path.<< facet || 'facets'
+      api.post(path, body, 'application/json')
     end
   end
 end

data/lib/wavefront-sdk/source.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # View and manage source metadata.
   #
-  class Source < Base
+  class Source < CoreApi
     def update_keys
       %i[sourceName tags description]
     end
@@ -21,7 +21,7 @@ module Wavefront
       qs[:limit] = limit if limit
       qs[:cursor] = cursor if cursor
 
-      api_get('', qs)
+      api.get('', qs)
     end
 
     # POST /api/v2/source
@@ -34,7 +34,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
-      api_post('', body, 'application/json')
+      api.post('', body, 'application/json')
     end
 
     # DELETE /api/v2/source/id
@@ -45,7 +45,7 @@ module Wavefront
     #
     def delete(id)
       wf_source_id?(id)
-      api_delete(id)
+      api.delete(id)
     end
 
     # POST /api/v2/source/id/description
@@ -53,7 +53,7 @@ module Wavefront
 
     def description_set(id, description)
       wf_source_id?(id)
-      api_post([id, 'description'].uri_concat, description,
+      api.post([id, 'description'].uri_concat, description,
                'application/json')
     end
 
@@ -62,7 +62,7 @@ module Wavefront
 
     def description_delete(id)
       wf_source_id?(id)
-      api_delete([id, 'description'].uri_concat)
+      api.delete([id, 'description'].uri_concat)
     end
 
     # GET /api/v2/source/id
@@ -76,7 +76,7 @@ module Wavefront
       wf_version?(version) if version
       fragments = [id]
       fragments += ['history', version] if version
-      api_get(fragments.uri_concat)
+      api.get(fragments.uri_concat)
     end
 
     # PUT /api/v2/source/id
@@ -94,9 +94,9 @@ module Wavefront
       wf_source_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
 
-      return api_put(id, body, 'application/json') unless modify
+      return api.put(id, body, 'application/json') unless modify
 
-      api_put(id, hash_for_update(describe(id).response, body),
+      api.put(id, hash_for_update(describe(id).response, body),
               'application/json')
     end
 
@@ -108,7 +108,7 @@ module Wavefront
     #
     def tags(id)
       wf_source_id?(id)
-      api_get([id, 'tag'].uri_concat)
+      api.get([id, 'tag'].uri_concat)
     end
 
     # POST /api/v2/source/id/tag
@@ -122,7 +122,7 @@ module Wavefront
       wf_source_id?(id)
       tags = Array(tags)
       tags.each { |t| wf_string?(t) }
-      api_post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
+      api.post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
     end
 
     # DELETE /api/v2/source/id/tag/tagValue
@@ -135,7 +135,7 @@ module Wavefront
     def tag_delete(id, tag)
       wf_source_id?(id)
       wf_string?(tag)
-      api_delete([id, 'tag', tag].uri_concat)
+      api.delete([id, 'tag', tag].uri_concat)
     end
 
     # PUT /api/v2/source/id/tag/tagValue
@@ -148,7 +148,7 @@ module Wavefront
     def tag_add(id, tag)
       wf_source_id?(id)
       wf_string?(tag)
-      api_put([id, 'tag', tag].uri_concat)
+      api.put([id, 'tag', tag].uri_concat)
     end
   end
 end