wavefront-client 1.0.3 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTRlNTkwNWI5ODhjNTRiOWNjMTEyZGZiZGQ0Y2ZlZmRjNzM3NzMyNg==
+    OGE3NGYzMDI5YjZjZmY0NDM0ZDg4ZDViYjhkNGM1MzljNTMwOWM2ZA==
   data.tar.gz: !binary |-
-    NTZlODRjMDBmY2UzNTYwZTNmZDRlZmFmNmY4N2NhZTU5ZTg3ZmJjMw==
+    OGI1YjVhNjExY2JjNzM4NDg4ZmVjNzljNTEwNjU1ZWMxNmRhMTVlOQ==
 SHA512:
   metadata.gz: !binary |-
-    YTUxZjkzNjAwMDBlNTU4MmMwNTc4ZmMwM2E2N2MyMjk4MjRhYzRiZDNjZGM1
-    NmZkYmJiOTA3MTY0MDkxMDQ3ZmU2MjAxMDgyOTJhMmZiOTcwYjIwODQ2ZGM1
-    N2FiMTBhMWU1OGMxMjdhODNhZDNiYmVhZjE4OGY0ZjRmZTNmZjk=
+    ZmNhMDAxMGZkMTZiNjQ4ZmFlMDcyNTQyMTk4ZmEyYjNhMDhlYjFlZDcyNGNk
+    YWU0Y2Y2YTNjZThmZWQyMDg0MTQxZGI5MWUwMjVjN2U1NDllODgxZWQ1OWNj
+    Mzg5ZDQ3MDBhYmVjZWViNGM4ZTM0Nzg3ZGRlODdlZTRlZTgxNTE=
   data.tar.gz: !binary |-
-    ZGUyMDFhMzc3YjdkNzFhMmZiMGQxM2E2YmRlMGU4ZjUzMTM3MjFmNGU1NDM5
-    ZGU1OTUyNTU4NWM1MmNiOTdiZmU4OTU2MGE1ZjlhZjQxZjAzMWM3MTIyMjU2
-    NDk2OTcyNTU5ZjNkYjI3NjIwODM2NDNhOTcwMGE5MGYxZmNhMzg=
+    MTg3NTVlOGQzOTY4NTg3MDM5OTYzNzAyYWJkZGFiNDZlY2NkNTE3NTRmY2Fk
+    ODkxYmVmNTI0YWRhZDEwNTY1YmZhYjRjNzY3NjdmZWM2YmVhNTAyOWI3NjRm
+    MGY4YjBjYWZkMTYxOTg0ZGM5MTM2NmQ1NTdkNGYxMzM1YTY1NTA=

data/README.md

@@ -93,7 +93,21 @@ response = wave.query('<TS_EXPRESSION>', 'm', {:start_time => Time.now - 86400,
     * `:end_time` - And object of class `Time` that specifies the query end time. Default: `Time.now`.
     * `:response_format` `[ :raw, :ruby, :graphite, :highcharts ]` - See the section "Response Classes" below. Default: `:raw`.
     * `:prefix_length` - Used when performing schema manipulations. See the Graphite response format below. Default `1`.
-
+    * `:strict` - originally Wavefront would return data points
+      either side of the requested range. These extra points are
+      required by the UI, but when you use the API you almost
+      certainly don't want them. In Wavefront 2.4, an API parameter
+      `strict` was introduced, which removes this padding. By
+      default we set this to `true`, so you will get back exactly
+      the range you request with `:start_time` and `:end_time`. If
+      you wish to have the old behaviour, set this to `false`.
+    * `:passthru` - as Wavefront develops it is hard to keep pace with
+      the API changes and cover everything in the SDK. The `passthru`
+      hash lets you pass parameters directly to the Wavefront API.
+      Thus you can set things like `summarization`, or `listMode`
+      directly, without having to implement them explicity in the SDK.
+      Obviously no type-checking is done to the `passthru` hash, so
+      refer to the Wavefront API docs, and use it with caution.
 
 ### Response Classes
 The `query` method returns a sub-class of `Wavefront::Response`. By default this is `Wavefront::Response::Raw`, which is the raw String returned from the API. By including the `:response_format` key in the options hash when calling the query method you can receive responses as a number of other classes.

data/lib/wavefront/client/version.rb

@@ -16,6 +16,6 @@ See the License for the specific language governing permissions and
 
 module Wavefront
   class Client
-    VERSION = "1.0.3"
+    VERSION = "1.1.0"
   end
 end

data/lib/wavefront/client.rb

@@ -1,4 +1,4 @@
-=begin 
+=begin
     Copyright 2015 Wavefront Inc.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -28,6 +28,7 @@ module Wavefront
     DEFAULT_PATH = '/chart/api'
     DEFAULT_FORMAT = :raw
     DEFAULT_PREFIX_LENGTH = 1
+    DEFAULT_STRICT = true
     FORMATS = [ :raw, :ruby, :graphite, :highcharts ]
     GRANULARITIES = %w( s m h d )
 
@@ -45,6 +46,7 @@ module Wavefront
       options[:start_time] ||= options[:end_time] - DEFAULT_PERIOD_SECONDS
       options[:response_format] ||= DEFAULT_FORMAT
       options[:prefix_length] ||= DEFAULT_PREFIX_LENGTH
+      options[:strict] = DEFAULT_STRICT unless options.keys.include?(:strict)
 
       [ options[:start_time], options[:end_time] ].each { |o| raise Wavefront::Exception::InvalidTimeFormat unless o.is_a?(Time) }
       raise Wavefront::Exception::InvalidGranularity unless GRANULARITIES.include?(granularity)
@@ -53,7 +55,15 @@ module Wavefront
 
       args = {:params =>
               {:q => query, :g => granularity, :n => 'Unknown',
-               :s => options[:start_time].to_i, :e => options[:end_time].to_i}}.merge(@headers)
+               :s => options[:start_time].to_i,
+               :e => options[:end_time].to_i,
+               :strict => options[:strict],
+              }}.merge(@headers)
+
+      if options[:passthru]
+        args[:params].merge!(options[:passthru])
+      end
+
       response = RestClient.get @base_uri.to_s, args
 
       klass = Object.const_get('Wavefront').const_get('Response').const_get(options[:response_format].to_s.capitalize)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-client
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Sam Pointer
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler