wavefront-sdk 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 778b77017e311667e540cdfc613ac815f1486946a7765cd6d6a02a8859c8808e
-  data.tar.gz: b56b31e97198d16f2b637170527aafc18366597ad58dce4186312681ce8cb4a1
+  metadata.gz: e68e0e9c6233a7fb449408c84111beaf522c023370188d155c234aa3387c411c
+  data.tar.gz: 0a3575ed176110827a011b6793b1d6f3cf8eb64e96dba1ce4b2f129ef1234219
 SHA512:
-  metadata.gz: 8bd597ebef72aeb412b557d25585b247c8e09e18c6ed35b5d0296bffa640dcece36150f22449bbf47ee630fd104a8502b9d3c4d16e9f9e937c0c0c4a21349415
-  data.tar.gz: 38bd84a2693d9a61d3d16b4576990c0cbd7696f2b6499086d7e4725239bc5d949aac008f02ccc8603a5af95139e42fc7222be84a3df889cbedb300033c3e41ef
+  metadata.gz: 47af2cca2a5ca29d545aefb936e3850234e117d53d6ee46580b931e505fda6fdb446004680102631b1b19d463889cf601d6578de27b0e7358094b498a24174ee
+  data.tar.gz: 736e992312831e5c1b2f37558c70cfec883950eab7f82777baa1c9a2ba3848b0adc0abc20972d27f70e34fbe77ce027b850b65bc6781c55e78cc50a6edbfa294

data/README.md

@@ -2,9 +2,14 @@
 [![Build Status](https://travis-ci.org/snltd/wavefront-sdk.svg?branch=master)](https://travis-ci.org/snltd/wavefront-sdk) [![Code Climate](https://codeclimate.com/github/snltd/wavefront-sdk/badges/gpa.svg)](https://codeclimate.com/github/snltd/wavefront-sdk) [![Issue Count](https://codeclimate.com/github/snltd/wavefront-sdk/badges/issue_count.svg)](https://codeclimate.com/github/snltd/wavefront-sdk) [![Gem Version](https://badge.fury.io/rb/wavefront-sdk.svg)](https://badge.fury.io/rb/wavefront-sdk) ![](http://ruby-gem-downloads-badge.herokuapp.com/wavefront-sdk?type=total)
 
 This is a Ruby SDK for v2 of
-[Wavefront](https://www.wavefront.com/)'s public API. It supports
-Ruby >= 2.2. It aims to be more lightweight, consistent, simple, and
-convenient than an auto-generated SDK.
+[Wavefront](https://www.wavefront.com/)'s public API. It aims to be
+more lightweight, consistent, simple, and convenient than an
+auto-generated SDK.
+
+As well as complete API coverage, `wavefront-sdk` includes methods
+which facilitate various common tasks, and provides non-API
+features such as credential management, and writing points through a
+proxy.
 
 ## Installation
 
@@ -18,6 +23,10 @@ or to build locally,
 $ gem build wavefront-sdk.gemspec
 ```
 
+`wavefront-sdk` requires Ruby >= 2.2. All its dependencies are pure
+Ruby, right the way down, so a compiler should never be required to
+install it.
+
 ## Documentation
 
 The code is documented with [YARD](http://yardoc.org/) and
@@ -121,7 +130,7 @@ path with a delta symbol, or by using the `write_delta()` method
 
 The SDK also provides a helper class for extracting credentials from a
 configuration file. If you don't supply a file, defaults will be
-used.
+used. You can even override things with environment variables.
 
 ```ruby
 require 'wavefront-sdk/credentials'
@@ -142,5 +151,4 @@ wf = Wavefront::Write.new(c.proxy)
 ## Contributing
 
 Fork it, fix it, send me a PR. Please supply tests, and try to keep
-[Rubocop](https://github.com/bbatsov/rubocop)
-happy.
+[Rubocop](https://github.com/bbatsov/rubocop) happy.

data/lib/wavefront-sdk/mixins.rb

@@ -1,6 +1,7 @@
 require 'date'
 require_relative 'exception'
 require_relative 'parse_time'
+require_relative 'stdlib'
 
 module Wavefront
   #
@@ -75,29 +76,3 @@ module Wavefront
     end
   end
 end
-
-# Extensions to stdlib Hash
-#
-class Hash
-  # Convert a tag hash into a string. The quoting is recommended in
-  # the WF wire-format guide. No validation is performed here.
-  #
-  def to_wf_tag
-    map { |k, v| "#{k}=\"#{v}\"" }.join(' ')
-  end
-end
-
-# Extensions to stdlib Array
-#
-class Array
-  # Join strings together to make a URI path in a way that is more
-  # flexible than URI::Join.  Removes multiple and trailing
-  # separators. Does not have to produce fully qualified paths. Has
-  # no concept of protocols, hostnames, or query strings.
-  #
-  # @return [String] a URI path
-  #
-  def uri_concat
-    join('/').squeeze('/').sub(%r{\/$}, '').sub(%r{\/\?}, '?')
-  end
-end

data/lib/wavefront-sdk/stdlib.rb

@@ -0,0 +1,5 @@
+require 'pathname'
+
+(Pathname.new(__FILE__).dirname + 'stdlib').realpath.children.each do |f|
+  require f if f.extname == '.rb'
+end

data/lib/wavefront-sdk/stdlib/array.rb

@@ -0,0 +1,14 @@
+# Extensions to stdlib Array
+#
+class Array
+  # Join strings together to make a URI path in a way that is more
+  # flexible than URI::Join.  Removes multiple and trailing
+  # separators. Does not have to produce fully qualified paths. Has
+  # no concept of protocols, hostnames, or query strings.
+  #
+  # @return [String] a URI path
+  #
+  def uri_concat
+    join('/').squeeze('/').sub(%r{\/$}, '').sub(%r{\/\?}, '?')
+  end
+end

data/lib/wavefront-sdk/stdlib/hash.rb

@@ -0,0 +1,13 @@
+require_relative 'string'
+
+# Extensions to stdlib Hash
+#
+class Hash
+  # Convert a tag hash into a string. The quoting is recommended in
+  # the WF wire-format guide. No validation is performed here.
+  #
+  # rubocop:disable Style/FormatStringToken
+  def to_wf_tag
+    map { |k, v| format('%s="%s"', k, v.tagescape) }.join(' ')
+  end
+end

data/lib/wavefront-sdk/stdlib/string.rb

@@ -0,0 +1,14 @@
+# Extensions to stdlib String
+#
+class String
+  # Join strings together to make a URI path in a way that is more
+  # flexible than URI::Join.  Removes multiple and trailing
+  # separators. Does not have to produce fully qualified paths. Has
+  # no concept of protocols, hostnames, or query strings.
+  #
+  # @return [String] a URI path
+  #
+  def tagescape
+    gsub(/"/, '\"')
+  end
+end

data/lib/wavefront-sdk/validators.rb

@@ -175,7 +175,8 @@ module Wavefront
     # @return nil
     #
     def wf_point_tag?(k, v)
-      return if k && v && (k.size + v.size < 254) && k =~ /^[\w\-\.:]+$/
+      return if k && v && (k.size + v.size < 254) && k =~ /^[\w\-\.:]+$/ &&
+                v !~ /\\$/
       raise Wavefront::Exception::InvalidTag
     end
 

data/lib/wavefront-sdk/version.rb

@@ -1 +1 @@
-WF_SDK_VERSION = '1.5.0'.freeze
+WF_SDK_VERSION = '1.6.0'.freeze

data/spec/wavefront-sdk/stdlib/array_spec.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require_relative '../../spec_helper'
+require_relative '../../../lib/wavefront-sdk/stdlib/array'
+require 'spy/integration'
+
+class ArrayTest < MiniTest::Test
+  def test_uri_concat
+    assert_equal %w[a b].uri_concat, 'a/b'
+    assert_equal ['', 'a', 'b'].uri_concat, '/a/b'
+    assert_equal %w[a /b].uri_concat, 'a/b'
+    assert_equal ['', 'a', 'b/'].uri_concat, '/a/b'
+    assert_equal %w[/a /b/ /c].uri_concat, '/a/b/c'
+    assert_equal ['/a', '/b c'].uri_concat, '/a/b c'
+  end
+end

data/spec/wavefront-sdk/stdlib/hash_spec.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require_relative '../../spec_helper'
+require_relative '../../../lib/wavefront-sdk/stdlib/hash'
+require 'spy/integration'
+
+# Test extensions to stdlib hash class
+#
+class HashTest < MiniTest::Test
+  def test_to_wf_tag
+    assert_equal({}.to_wf_tag, '')
+    assert_equal({ gt1: 'gv1', gt2: 'gv2' }.to_wf_tag,
+                 'gt1="gv1" gt2="gv2"')
+    assert_equal({ tag: 'value' }.to_wf_tag, 'tag="value"')
+    assert_equal({ tag: 'two words' }.to_wf_tag, 'tag="two words"')
+    assert_equal('tag="say \"hi\""', { tag: 'say "hi"' }.to_wf_tag)
+    assert_equal('tag1="say \"hi\"" tag2="some stuff!"',
+                 { tag1: 'say "hi"', tag2: 'some stuff!' }.to_wf_tag)
+  end
+end

data/spec/wavefront-sdk/stdlib/string_spec.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require_relative '../../spec_helper'
+require_relative '../../../lib/wavefront-sdk/stdlib/string'
+
+class StringTest < MiniTest::Test
+  def test_tagescape
+    assert_equal('value', 'value'.tagescape)
+    assert_equal('two words', 'two words'.tagescape)
+    assert_equal('say \"hello\"', 'say "hello"'.tagescape)
+    assert_equal('\"\"\"\"', '""""'.tagescape)
+  end
+end

data/spec/wavefront-sdk/validators_spec.rb

@@ -91,6 +91,7 @@ class WavefrontValidatorsTest < MiniTest::Test
             { 'TAG-1': 'val 1', tag2: 'val 2' },
             { tag1: '(>_<)', tag2: '^_^' }]
     bad  = ['key=value',
+            { tag: 'badval\\' },
             { 'tag 1': 'val1', 'tag 2': 'val2' },
             { 'TAG*1': 'val 1', tag_2: 'val 2' },
             { '(>_<)': 'val1', '^_^': 'val2' },

data/spec/wavefront-sdk/write_spec.rb

@@ -151,11 +151,6 @@ class WavefrontWriteTest < MiniTest::Test
     end
   end
 
-  def test_to_wf_tag
-    assert_equal({}.to_wf_tag, '')
-    assert_equal(TAGS.to_wf_tag, 'gt1="gv1" gt2="gv2"')
-  end
-
   def test_send_point
     mocket = Mocket.new
     Spy.on(TCPSocket, :new).and_return(mocket)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -218,6 +218,10 @@ files:
 - lib/wavefront-sdk/savedsearch.rb
 - lib/wavefront-sdk/search.rb
 - lib/wavefront-sdk/source.rb
+- lib/wavefront-sdk/stdlib.rb
+- lib/wavefront-sdk/stdlib/array.rb
+- lib/wavefront-sdk/stdlib/hash.rb
+- lib/wavefront-sdk/stdlib/string.rb
 - lib/wavefront-sdk/user.rb
 - lib/wavefront-sdk/validators.rb
 - lib/wavefront-sdk/version.rb
@@ -250,6 +254,9 @@ files:
 - spec/wavefront-sdk/savedsearch_spec.rb
 - spec/wavefront-sdk/search_spec.rb
 - spec/wavefront-sdk/source_spec.rb
+- spec/wavefront-sdk/stdlib/array_spec.rb
+- spec/wavefront-sdk/stdlib/hash_spec.rb
+- spec/wavefront-sdk/stdlib/string_spec.rb
 - spec/wavefront-sdk/user_spec.rb
 - spec/wavefront-sdk/validators_spec.rb
 - spec/wavefront-sdk/webhook_spec.rb
@@ -306,6 +313,9 @@ test_files:
 - spec/wavefront-sdk/savedsearch_spec.rb
 - spec/wavefront-sdk/search_spec.rb
 - spec/wavefront-sdk/source_spec.rb
+- spec/wavefront-sdk/stdlib/array_spec.rb
+- spec/wavefront-sdk/stdlib/hash_spec.rb
+- spec/wavefront-sdk/stdlib/string_spec.rb
 - spec/wavefront-sdk/user_spec.rb
 - spec/wavefront-sdk/validators_spec.rb
 - spec/wavefront-sdk/webhook_spec.rb