wavefront-sdk 3.3.2 → 3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e6718d9f3e031c2fa1483886a56af0ab13a497d3f8af778d426176d00f3ebde
-  data.tar.gz: 31c8f31a4e0e12bbdf5000d342411a56ca623f66dbe577650f11986f807b8c81
+  metadata.gz: a664693c583158575cad85b45877d407b0d319e1d6d540b2cc253d3d65907c0c
+  data.tar.gz: f0407b9b17cd69e79a7206c6224e749f3ad60027410d03e997fb5dd60aa1276c
 SHA512:
-  metadata.gz: 1fa4b966047249113c4271263fe0f5f6b59637e8b9823df56373f4992c3c56a2b648b272e81c5eb110c5b69d650ae3950b2794908d1a698cc468d57eedc86757
-  data.tar.gz: de8c2c6d0edca705eaed18041d6118315809de5bc2d2c7560fdc66a097200905c62d35278eca6e48069979322e61e1da6b0215397e75ade9518ad0d8b501fa7f
+  metadata.gz: ff1bd8a1f5d9a7e57bf04d74ad42e9a168ca285e5eb58e4048089768f88ed44e88814744295bbc63541a27f945d99b246fa063f69f2e0495a1bf8bac9dbf28b9
+  data.tar.gz: f0f18d99096549065b6eaa1b1c410d62d011fdb81f1c07756076c0aaca6b6261621a0cd9403ab76d1e655dcab1ef44bdb9e3edbae23d8bade01ce02868a7ac42

data/HISTORY.md

@@ -1,35 +1,42 @@
 # Changelog
 
-## 3.3.2 (24/05/2019)
-* Don't report `moreItems` as `true` at the end of a recursive `GET`.
+## 3.3.3 (2019-09-10)
+* Fix slightly misleading verbose message when using recursive or
+  lazy calls
+* Fix bug where `Alert#versions` would fault on a noop.
+* Make `Search` work correctly with API classes which use cursors.
+* Improve user response shim, and its tests.
 
-## 3.3.1 (10/05/2019)
+## 3.3.2 (2019-05-24)
+* Don't report `moreItems` as true at the end of a recursive GET.
+
+## 3.3.1 (2019-05-10)
 * Better handling of query errors.
 
-## 3.3.0 (09/05/2019)
+## 3.3.0 (2019-05-09)
 * Reflect the way the API ACL format has changed.
 
-## 3.2.0 (01/05/2019)
+## 3.2.0 (2019-05-01)
 * Add support for new `apitoken` path.
 * Add support for alert ACLs
 * Tag and ACL methods have been broken out into mixins which are
   automatically included by classes which support them
 
-## 3.1.0 (23/04/2019)
+## 3.1.0 (2019-04-23)
 * When using `Wavefront::Write`, large numbers of points are written
   in chunks, rather than all at once. The chunk size can be set by
   the user when instantiating the class.
 
-## 3.0.2 (06/04/2019)
+## 3.0.2 (2019-04-06)
 * Better handling of non-existent or malformed config files.
 * Look for `~/.wavefront.conf` as well as `~/.wavefront`. Both these
   fixes are related to finding out that other Wavefront tooling
   creates `~/.wavefront` as a directory.
 
-## 3.0.1 (05/04/2019)
+## 3.0.1 (2019-04-05)
 * User IDs do not have to be e-mail addresses.
 
-## 3.0.0 (23/03/2019)
+## 3.0.0 (2019-03-23)
 * Drop support for Ruby 2.2. (Potentially breaking change.)
 * Add `Wavefront::Settings` class to cover new `settings` API
   endpoint.
@@ -39,14 +46,14 @@
 * Add `sort_field` to `Wavefront::Search` options. Lets user select
   the field on which to sort results.
 
-## 2.5.1 (06/03/2019)
+## 2.5.1 (2019-03-06)
 * Fix messy handling of raw query errors.
 
-## 2.5.0 (21/02/2019)
+## 2.5.0 (2019-02-21)
 * New `Wavefront::UserGroup` class, for new API `UserGroup` feature.
 * Extended `Wavefront::User` to cover new API methods.
 
-## 2.4.0 (28/01/2019)
+## 2.4.0 (2019-01-28)
 * New `Wavefront::MetricHelper` class creates and in-memory buffer
   to which you can instantaneously add metrics, flushing it to
   Wavefront when appropriate. All `Writer` types are supported.
@@ -60,16 +67,16 @@
 * Improve `README` instructions on writing metrics.
 * Support Ruby 2.6.
 
-## 2.3.0 (06/01/2019)
+## 2.3.0 (2019-01-06)
 * When sending points via the API, send bundles of up to 100 points
   with each `POST`, rather than a call per point.
 
-## 2.2.1 (20/12/2018)
+## 2.2.1 (2018-12-20)
 * Fix typo in `Wavefront::Alert#affected_by_maintenance` method
   name.
 * Full `Wavefront::Alert` test coverage.
 
-## 2.2.0 (15/12/2018)
+## 2.2.0 (2018-12-15)
 * New methods to cover new API paths.
  * `Wavefront::Alert#install`,
  * `Wavefront::Alert#uninstall`,
@@ -81,20 +88,20 @@
  * `Wavefront::Integration#uninstall_all_alerts`
  * `Wavefront::Integration#installed`
 
-## 2.1.0 (25/11/2018)
+## 2.1.0 (2018-11-25)
 * New `unix` writer lets you write points to a local Unix datagram
   socket.
 
-## 2.0.3 (23/10/2018)
+## 2.0.3 (2018-10-23)
 * Remove unnecessarily strict argument check on `event#list`.
 
-## 2.0.2 (22/10/2018)
+## 2.0.2 (2018-10-22)
 * Bugfix
 
-## 2.0.1 (22/10/2018)
+## 2.0.1 (2018-10-22)
 * Bugfix on response types.
 
-## 2.0.0 (20/10/2018)
+## 2.0.0 (2018-10-20)
 * Remove `#everything` method from all classes. (Breaking change.)
 * Calling any method which takes the `limit` argument with  `limit`
   set to `:all` will automatically handle pagination, fetching all
@@ -137,36 +144,36 @@
 * Make `Wavefront::User` return a response object containing an
   `items` element, like every other class.
 
-## 1.6.2 (22/08/2018)
+## 1.6.2 (2018-08-22)
 * Drop log priority of write class messages.
 
-## 1.6.1 (22/08/2018)
+## 1.6.1 (2018-08-22)
 * Fix Ruby 2.2 bugs
 * Improve unit test separation
 * Allow updating of all external link parameters
 
-## 1.6.0 (07/08/2018)
+## 1.6.0 (2018-08-07)
 * Improve validation of point tags.
 * Break extensions to standard library out into their own files.
 * Improve README.
 
-## 1.5.0 (25/06/2018)
+## 1.5.0 (2018-06-25)
 * Add [derived
   metric](https://docs.wavefront.com/derived_metrics.html) support.
 * Add this changelog.
 
-## 1.4.0 (10/04/2018)
+## 1.4.0 (2018-04-10)
 * Add support for [direct
   ingestion](https://docs.wavefront.com/direct_ingestion.html).
 
-## 1.3.2 (03/04/2018)
+## 1.3.2 (2018-04-03)
 * Fix regression in write class.
 
-## 1.3.1 (03/04/2018)
+## 1.3.1 (2018-04-03)
 * Fix Ruby 2.2 support.
 * Code tidy and linting improvements.
 
-## 1.3.0 (29/03/2018)
+## 1.3.0 (2018-03-29)
 * Add support for delta metrics.
 * Add automatic pagination support for long lists of objects.
   Such lists can be treated as Ruby enumerables.
@@ -176,27 +183,27 @@
 * Update dependencies.
 * Support Ruby 2.5.
 
-## 1.2.1 (12/10/2017)
+## 1.2.1 (2017-10-12)
 * Fix bug in relative time support.
 * Fix Ruby 2.4 support.
 
-## 1.2.0 (12/10/2017)
+## 1.2.0 (2017-10-12)
 * Support relative times through mixin methods.
 
-## 1.1.0 (09/10/2017)
+## 1.1.0 (2017-10-09)
 * Add support for notificant (alert target) API path.
 * Add support for integration API path.
 * Support new source description set/delete API endpoint.
 
-## 1.0.3 (20/09/2017)
+## 1.0.3 (2017-09-20)
 * Gracefully handle tags with `nil` values.
 * Bump dependencies.
 
-## 1.0.2 (04/08/2017)
+## 1.0.2 (2017-08-04)
 * Maintenance window bugfixes.
 
-## 1.0.1 (31/07/2017)
+## 1.0.1 (2017-07-31)
 * Fix message ID validator.
 
-## 1.0.0 (11/06/2017)
+## 1.0.0 (2017-06-11)
 First official release.

data/README.md

@@ -116,11 +116,6 @@ wf.list(99, :lazy).each { |alert| puts alert.name }
 # ...
 ```
 
-We can easily write queries. Let's retrieve a timeseries over the
-last 10 minutes, with one minute bucket granularity. We will
-describe the time as a Ruby object, but could also use an epoch
-timestamp. The SDK happily converts between the two.
-
 ### Credentials
 
 The SDK provides a helper class for extracting credentials from a
@@ -148,6 +143,11 @@ wf = Wavefront::Write.new(c.all)
 
 ### Queries
 
+We can easily write queries. Let's retrieve a timeseries over the
+last 10 minutes, with one minute bucket granularity. We will
+describe the time as a Ruby object, but could also use an epoch
+timestamp. The SDK happily converts between the two.
+
 ```ruby
 require 'wavefront-sdk/query'
 

data/lib/wavefront-sdk/alert.rb

@@ -81,6 +81,8 @@ module Wavefront
       wf_alert_id?(id)
       resp = api.get([id, 'history'].uri_concat)
 
+      return if opts[:noop]
+
       versions = resp.response.items.map(&:version)
       resp.response[:items] = versions
       resp

data/lib/wavefront-sdk/core/api_caller.rb

@@ -130,6 +130,8 @@ module Wavefront
     # If we need to massage a raw response to fit what the
     # Wavefront::Response class expects (I'm looking at you,
     # 'User'), a class can provide a {#response_shim} method.
+    # @param resp [Faraday::Response]
+    # @return [String] body of response (JSON)
     #
     def respond(resp)
       body = if calling_class.respond_to?(:response_shim)
@@ -146,6 +148,7 @@ module Wavefront
     #
     def verbosity(conn, method, *args)
       return unless noop || verbose
+
       log format('uri: %s %s', method.upcase, conn.url_prefix)
 
       return unless args.last && !args.last.empty?
@@ -168,9 +171,6 @@ module Wavefront
     #   endpoint
     #
     def make_call(conn, method, *args)
-      verbosity(conn, method, *args)
-      return if noop
-
       paginator = paginator_class(method).new(self, conn, method, *args)
 
       case paginator.initial_limit
@@ -184,6 +184,9 @@ module Wavefront
     end
 
     def make_single_call(conn, method, *args)
+      verbosity(conn, method, *args)
+      return if noop
+
       pp args if debug
 
       resp = conn.public_send(method, *args)

data/lib/wavefront-sdk/defs/version.rb

@@ -1,4 +1,4 @@
 require 'pathname'
 
-WF_SDK_VERSION = '3.3.2'.freeze
-WF_SDK_LOCATION = Pathname.new(__FILE__).dirname.parent.parent.parent
+WF_SDK_VERSION = '3.3.3'.freeze
+WF_SDK_LOCATION = Pathname.new(__dir__).parent.parent.parent

data/lib/wavefront-sdk/derivedmetric.rb

@@ -108,5 +108,12 @@ module Wavefront
     def valid_id?(id)
       wf_derivedmetric_id?(id)
     end
+
+    private
+
+    def update_keys
+      %i[id name query tags additionalInformation
+         includeObsoleteMetrics processRateMinutes minutes]
+    end
   end
 end

data/lib/wavefront-sdk/externallink.rb

@@ -10,8 +10,8 @@ module Wavefront
     end
 
     def update_keys
-      %i[name template description metricFilterRegex sourceFilterRegex
-         pointTagFilterRegexes]
+      %i[id name template description metricFilterRegex
+         sourceFilterRegex pointTagFilterRegexes]
     end
 
     # GET /api/v2/extlink

data/lib/wavefront-sdk/maintenancewindow.rb

@@ -6,7 +6,7 @@ module Wavefront
   #
   class MaintenanceWindow < CoreApi
     def update_keys
-      %i[reason title startTimeInSeconds endTimeInSeconds
+      %i[id reason title startTimeInSeconds endTimeInSeconds
          relevantCustomerTags relevantHostTags relevantHostNames]
     end
 
@@ -92,7 +92,11 @@ module Wavefront
     def pending(hours = 24)
       cutoff = Time.now.to_i + hours * 3600
 
-      windows_in_state(:pending).tap do |r|
+      ret = windows_in_state(:pending)
+
+      return if opts[:noop]
+
+      ret.tap do |r|
         r.response.items.delete_if { |w| w.startTimeInSeconds > cutoff }
       end
     end

data/lib/wavefront-sdk/notificant.rb

@@ -79,5 +79,12 @@ module Wavefront
       wf_notificant_id?(id)
       api.post(['test', id].uri_concat, nil)
     end
+
+    private
+
+    def update_keys
+      %i[id contentType method description title template triggers
+         recipient customHttpHeaders emailSubject isHtmlContent]
+    end
   end
 end

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

@@ -100,6 +100,10 @@ module Wavefront
       def make_recursive_call
         offset = 0
         p_args = set_pagination(offset, page_size, args)
+        api_caller.verbosity(conn, method, *p_args)
+
+        return if api_caller.opts[:noop]
+
         ret = api_caller.respond(conn.public_send(method, *p_args))
 
         return ret unless ret.more_items?
@@ -138,6 +142,10 @@ module Wavefront
         offset = 0
         p_args = set_pagination(offset, page_size, args)
 
+        api_caller.verbosity(conn, method, *p_args)
+
+        return if api_caller.opts[:noop]
+
         Enumerator.new do |y|
           loop do
             offset += page_size

data/lib/wavefront-sdk/search.rb

@@ -45,8 +45,7 @@ module Wavefront
     # Build a query body
     #
     def body(query, options)
-      ret = { limit:  options[:limit]  || 10,
-              offset: options[:offset] || 0 }
+      ret = query_limits(options)
 
       if query && !query.empty?
         ret[:query] = [query].flatten.map do |q|
@@ -59,6 +58,16 @@ module Wavefront
       ret
     end
 
+    def query_limits(options)
+      { limit: options[:limit] || 10 }.tap do |ret|
+        if options[:cursor]
+          ret[:cursor] = options[:cursor]
+        else
+          ret[:offset] = options[:offset] || 0
+        end
+      end
+    end
+
     def sort_field(options, query)
       field = options[:sort_field] || [query].flatten.first[:key]
 

data/lib/wavefront-sdk/user.rb

@@ -196,18 +196,38 @@ module Wavefront
     # Fake a response which looks like we get from all the other
     # paths. I'm expecting the user response model to be made
     # consistent with others in the future.
+    # @return [String] of JSON
     #
     def response_shim(body, status)
-      items = JSON.parse(body, symbolize_names: true)
+      body_obj = JSON.parse(body, symbolize_names: true)
 
-      { response: { items:      items,
+      if body_obj.is_a?(Hash) && body_obj.key?(:status)
+        if response_looks_right?(body_obj)
+          body
+        else
+          itemize_response(body_obj)
+        end
+      else
+        construct_response(body_obj, status)
+      end
+    end
+
+    def itemize_response(body_obj)
+      { status:   body_obj[:status],
+        response: { items: [body_obj[:response]].flatten } }.to_json
+    end
+
+    # Construct a response almost from scratch. Used for 'list', among others.
+    #
+    def construct_response(body_obj, status)
+      { status:   { result:     status.to_s.start_with?('2') ? 'OK' : 'ERROR',
+                    message:    extract_api_message(status, body_obj),
+                    code:       status },
+        response: { items:      [body_obj].flatten,
                     offset:     0,
-                    limit:      items.size,
-                    totalItems: items.size,
-                    modeItems:  false },
-        status:   { result:     status == 200 ? 'OK' : 'ERROR',
-                    message:    extract_api_message(status, items),
-                    code:       status } }.to_json
+                    limit:      body_obj.size,
+                    totalItems: body_obj.size,
+                    moreItems:  false } }.to_json
     end
 
     # the user API class does not support pagination. Be up-front
@@ -219,9 +239,20 @@ module Wavefront
 
     private
 
+    def response_looks_right?(body_obj)
+      body_obj.key?(:response) &&
+        body_obj[:response].is_a?(Hash) &&
+        body_obj[:response].key?(:items) &&
+        body_obj[:response][:items].is_a?(Array)
+    end
+
     def extract_api_message(status, items)
       return '' if status < 300
       items.fetch(:message, 'no message from API')
     end
+
+    def update_keys
+      %i[identifier groups userGroups]
+    end
   end
 end