wavefront-sdk 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a834d2f501fb52ddaf2675e357d5a0ed285a12b9
-  data.tar.gz: 93635191aae83d66e6dde2ec1deaf564046269e3
+  metadata.gz: 19b69376bae0fb003a885f84caec73b642242144
+  data.tar.gz: 09c37865d29c17fb1fd9f8d98b79982dcae7491f
 SHA512:
-  metadata.gz: 8bc7656d0c303bfb6eb9bbb79229afac145331535014fdb852b7213f13ea477f14d26edf85ff04dfd169cb3384714fef7904b6623b2f3ce2e46b8bda0e742277
-  data.tar.gz: b19a17c7a2e6e2d52c6016f4bd3e1e6420b57dd6bf77361d6875fb0a1c3ea384570213a8460a5f81d58bd089a340ed06e41c957dc493bcb8a8e263f739d7347b
+  metadata.gz: eec85994ce6b03d2921b968d9f44e62372ab676117a5eb706c0f1d3b57e835889d2833366d035aa2539a66fe24a0cd59d790081a4147ac65ec3dd23503aa3e0e
+  data.tar.gz: ff10d6af734516be10162cd4dc900751563517b8b1841b76bc796b8510374c36c9b8f001b387a003135cf4efab05cb11e6f2d807baad44c67f6651424a5f4c76

data/README.md

@@ -4,10 +4,6 @@
 This is a Ruby SDK for v2 of
 [Wavefront](https://www.wavefront.com/)'s public API. It supports Ruby >= 2.2.
 
-Note that it currently has major version number `0`. This means *it
-is not finished*. Until version `1` comes out, I reserve the right
-to change, break, and befoul the code and the gem.
-
 ## Installation
 
 ```

data/lib/wavefront-sdk/search.rb

@@ -9,23 +9,74 @@ module Wavefront
   #
   class Search < Base
 
-    # POST /api/v2/search/agent
-    # POST /api/v2/search/agent/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,
+    # use #raw_search().
+    #
+    # @param entity [String, Symbol] the type of Wavefront object
+    #   you wish to search. e.g. :alert, :dashboard
+    # @param query [Array, Hash] A single hash, or array of hashes,
+    # containing the following keys:
+    #   key [String] the field on which to search
+    #   value [String] what to search for
+    #   matchingMethod [String] the method to match values. Defaults
+    #     to 'CONTAINS'. Must be one of CONTAINS, STARTSWITH, EXACT,
+    #     TAGPATH
+    #   If an array of hashes is supplied, Wavefront will apply a
+    #   logical AND to the given key-value pairs.
+    # @param value [String] the value to search for
+    # @param options [Hash] tune the query: keys are:
+    #   deleted [Boolean] whether to search deleted (true) or active
+    #     (false) entities
+    #   limit [Integer] how many results to return. Defaults to 0
+    #     (all of them)
+    #   offset [Integer] return results after this offset
+    #   desc: [Boolean] return results in descending order. Defaults
+    #     to false. Sorting is done on the 'key' of the first query
+    #     hash.
+    #
+    def search(entity, query, options = {})
+      raise ArgumentError unless options.is_a?(Hash)
+      raw_search(entity, body(query, options), options[:deleted] || false)
+    end
+
+    # 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[:query].map { |q| q[:matchingMethod] ||= 'CONTAINS' }
+      ret
+    end
+
+    # 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
     #   to search
     # @param body [Hash] the query to use for searching. Refer to
     #   the Wavefront Swagger docs for the correct format.
+    #   Specifying multiple key - value pairs performs a logical AND
+    #   on the constraints.
     # @param deleted [Boolean] whether to search deleted (true) or
     #   active (false) entities
     #
-    def search(entity = nil, body = nil, deleted = false)
-      raise ArgumentError unless entity.is_a?(String)
+    def raw_search(entity = nil, body = nil, deleted = false)
+      raise ArgumentError unless entity.is_a?(String) || entity.is_a?(Symbol)
       raise ArgumentError unless body.is_a?(Hash)
-      path = ['agent']
+      path = [entity]
       path.<< 'deleted' if deleted
-      api_post(path, body, 'application/json')
+      api_post(path, body.to_json, 'application/json')
     end
 
     # @param entity [String] the type of Wavefront object you wish
@@ -39,11 +90,11 @@ module Wavefront
     #   specified in the body. See the Swagger docs for more
     #   information.
     #
-    def facet_search(entity = nil, body = nil, deleted = false,
+    def raw_facet_search(entity = nil, body = nil, deleted = false,
                      facet = false)
       raise ArgumentError unless entity.is_a?(String)
       raise ArgumentError unless body.is_a?(Hash)
-      path = ['agent']
+      path = [entity]
       path.<< 'deleted' if deleted
       path.<< facet ? facet : 'facets'
       api_post(path, body, 'application/json')

data/lib/wavefront-sdk/version.rb

@@ -1 +1 @@
-WF_SDK_VERSION = '0.2.3'.freeze
+WF_SDK_VERSION = '1.0.0'.freeze

data/spec/wavefront-sdk/search_spec.rb

@@ -16,32 +16,32 @@ SEARCH_BODY = {
 #
 class WavefrontSearchTest < WavefrontTestBase
   def test_search
-    should_work(:search, ['agent', SEARCH_BODY], 'agent', :post,
+    should_work(:raw_search, ['agent', SEARCH_BODY], 'agent', :post,
                 JSON_POST_HEADERS, SEARCH_BODY.to_json)
-    should_work(:search, ['agent', SEARCH_BODY, true], 'agent/deleted',
+    should_work(:raw_search, ['agent', SEARCH_BODY, true], 'agent/deleted',
                 :post, JSON_POST_HEADERS, SEARCH_BODY.to_json)
-    assert_raises(ArgumentError) { wf.search }
-    assert_raises(ArgumentError) { wf.search('ALERT', 'junk') }
+    assert_raises(ArgumentError) { wf.raw_search }
+    assert_raises(ArgumentError) { wf.raw_search('ALERT', 'junk') }
   end
 
   def test_facet_search
-    should_work(:facet_search, ['agent', SEARCH_BODY],
+    should_work(:raw_facet_search, ['agent', SEARCH_BODY],
                 'agent/facets', :post, JSON_POST_HEADERS,
                 SEARCH_BODY.to_json)
 
-    should_work(:facet_search, ['agent', SEARCH_BODY, true],
+    should_work(:raw_facet_search, ['agent', SEARCH_BODY, true],
                 'agent/deleted/facets', :post, JSON_POST_HEADERS,
                 SEARCH_BODY.to_json)
 
-    should_work(:facet_search, ['agent', SEARCH_BODY, false, 'Tags'],
+    should_work(:raw_facet_search, ['agent', SEARCH_BODY, false, 'Tags'],
                 'agent/Tags', :post, JSON_POST_HEADERS,
                 SEARCH_BODY.to_json)
 
-    should_work(:facet_search, ['agent', SEARCH_BODY, true, 'Tags'],
+    should_work(:raw_facet_search, ['agent', SEARCH_BODY, true, 'Tags'],
                 'agent/deleted/Tags', :post, JSON_POST_HEADERS,
                 SEARCH_BODY.to_json)
 
-    assert_raises(ArgumentError) { wf.facet_search }
-    assert_raises(ArgumentError) { wf.facet_search('ALERT', 'junk') }
+    assert_raises(ArgumentError) { wf.raw_facet_search }
+    assert_raises(ArgumentError) { wf.raw_facet_search('ALERT', 'junk') }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday