wavefront-client 3.4.0 → 3.5.1

data/spec/wavefront/events_spec.rb

@@ -98,14 +98,4 @@ describe Wavefront::Events do
         'key1=val1&key2=val2&h=host1&h=host2&h=host3')
     end
   end
-
-  describe '#hash_to_qs' do
-    it 'makes a proper query string' do
-      k = Wavefront::Events.new(TEST_TOKEN)
-        expect(k.hash_to_qs({
-        key1: 'val1',
-        key2: 'value 2'
-      })).to eq('key1=val1&key2=value%202')
-    end
-  end
 end

data/spec/wavefront/metadata_spec.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.
@@ -18,6 +18,16 @@ require 'spec_helper'
 require 'pathname'
 
 describe Wavefront::Metadata do
+  attr_reader :wf, :host, :path, :post_headers
+
+  before do
+    @wf = Wavefront::Metadata.new(TEST_TOKEN)
+    @host = Wavefront::Metadata::DEFAULT_HOST
+    @path = Wavefront::Metadata::DEFAULT_PATH
+    @post_headers = wf.headers.merge(
+      { :'Content-Type' => 'text/plain', :Accept => 'application/json' })
+
+  end
 
   it 'has some defaults' do
     expect(Wavefront::Metadata::DEFAULT_HOST).to_not be_nil
@@ -34,5 +44,143 @@ describe Wavefront::Metadata do
       expect(wave.headers).to eq headers
     end
   end
-  
+
+  describe "#initialize" do
+    it 'enables rest-client debugging if instructed to do so' do
+      wf = Wavefront::Metadata.new(TEST_TOKEN, 'somehost', true)
+      expect RestClient.log == 'stdout'
+    end
+  end
+
+  describe '#delete_tags' do
+    it 'makes API request with default options' do
+      expect(RestClient).to receive(:delete).with(
+        concat_url(host, path, 'mysource', 'tags'), wf.headers
+      )
+      wf.delete_tags('mysource')
+    end
+
+    it 'raises an exception on an invalid source' do
+      expect{wf.delete_tags('!INVALID!')}.
+        to raise_exception(Wavefront::Exception::InvalidSource)
+    end
+  end
+
+  describe '#delete_tag' do
+    it 'makes API request with default options' do
+      expect(RestClient).to receive(:delete).with(
+        concat_url(host, path, 'mysource', 'tags', 'mytag'), wf.headers
+      )
+      wf.delete_tag('mysource', 'mytag')
+    end
+
+    it 'raises an exception on an invalid source' do
+      expect{wf.delete_tag('INVALID!', 'mytag')}.
+        to raise_exception(Wavefront::Exception::InvalidSource)
+    end
+
+    it 'raises an exception on an invalid tag' do
+      expect{wf.delete_tag('mysource', 'INVALID!')}.
+        to raise_exception(Wavefront::Exception::InvalidString)
+    end
+  end
+
+  describe '#show_sources' do
+    it 'makes API request with default options' do
+      expect(RestClient).to receive(:get).with(
+        concat_url(host, path, '?'), wf.headers
+      )
+      wf.show_sources
+    end
+
+    it 'makes API request with options' do
+      expect(RestClient).to receive(:get).with(
+        concat_url(host, path, '?limit=100&pattern=test-*'), wf.headers
+      )
+      wf.show_sources({ limit: 100, pattern: 'test-*' })
+    end
+
+    it 'raises an exception on an invalid lastEntityId' do
+      expect{wf.show_sources({lastEntityId: nil})}.
+        to raise_exception(TypeError)
+    end
+
+    it 'raises an exception on an invalid desc' do
+      expect{wf.show_sources({desc: 1234})}.
+        to raise_exception(TypeError)
+    end
+
+    it 'raises an exception on an invalid limit' do
+      expect{wf.show_sources({limit: 'abcdef'})}.
+        to raise_exception(TypeError)
+
+      expect{wf.show_sources({limit: 10000})}.
+        to raise_exception(Wavefront::Exception::ValueOutOfRange)
+
+      expect{wf.show_sources({limit: -1})}.
+        to raise_exception(Wavefront::Exception::ValueOutOfRange)
+    end
+
+    it 'raises an exception on an invalid pattern' do
+      expect{wf.show_sources({pattern: [1, 2, 3]})}.
+        to raise_exception(TypeError)
+    end
+  end
+
+  describe '#show_source' do
+    it 'makes API request with default options' do
+      expect(RestClient).to receive(:get).with(
+        concat_url(host, path, 'mysource'), wf.headers
+      )
+      wf.show_source('mysource')
+    end
+
+    it 'raises an exception on an invalid source' do
+      expect{wf.show_source('!INVALID!')}.
+        to raise_exception(Wavefront::Exception::InvalidSource)
+    end
+  end
+
+  describe '#set_description' do
+    it 'makes API request with default options' do
+      expect(RestClient).to receive(:post).with(
+        concat_url(host, path, 'mysource', 'description'),
+        'my description', post_headers)
+      wf.set_description('mysource', 'my description')
+    end
+
+    it 'raises an exception on an invalid source' do
+      expect{wf.set_description('!INVALID!', 'my description')}.
+        to raise_exception(Wavefront::Exception::InvalidSource)
+    end
+
+    it 'raises an exception on an invalid description' do
+      expect{wf.set_description('my_source', '!INVALID!')}.
+        to raise_exception(Wavefront::Exception::InvalidString)
+    end
+  end
+
+  describe '#set_tag' do
+    it 'makes API request with default options' do
+      expect(RestClient).to receive(:post).with(
+        concat_url(host, path, 'my_source', 'tags', 'my_tag'),
+        nil, post_headers)
+      wf.set_tag('my_source', 'my_tag')
+    end
+
+    it 'raises an exception on an invalid source' do
+      expect{wf.set_tag('!INVALID!', 'my_tag')}.
+        to raise_exception(Wavefront::Exception::InvalidSource)
+    end
+
+    it 'raises an exception on an invalid description' do
+      expect{wf.set_tag('my_source', '!INVALID!')}.
+        to raise_exception(Wavefront::Exception::InvalidString)
+    end
+
+    it 'raises an exception on an invalid tag' do
+      expect{wf.set_tag('my_source', '!INVALID!')}.
+        to raise_exception(Wavefront::Exception::InvalidString)
+    end
+  end
 end

data/spec/wavefront/mixins_spec.rb

@@ -41,4 +41,11 @@ describe Wavefront::Mixins do
     expect(time_to_ms(1469711187)).to eq(1469711187000)
     expect(time_to_ms('1469711187')).to be(false)
   end
+
+  it 'makes a proper query string' do
+    expect(hash_to_qs({
+      key1: 'val1',
+      key2: 'value 2'
+    })).to eq('key1=val1&key2=value%202')
+  end
 end

data/spec/wavefront/validators_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe Wavefront::Validators do
+  include Wavefront::Validators
+
+  describe '#valid_path?' do
+    it 'accepts a-z, 0-9, _ and -' do
+      expect(valid_path?('a.l33t.metric_path-passes')).to be(true)
+    end
+
+    it 'accepts nearly very long paths' do
+      expect(valid_path?('a' * 1023)).to be(true)
+    end
+
+    it 'rejects very long paths' do
+      expect{valid_path?('a' * 1024)}.to raise_exception(
+        Wavefront::Exception::InvalidMetricName)
+    end
+
+    it 'rejects upper-case letters' do
+      expect{valid_path?('NO.NEED.TO.SHOUT')}.to raise_exception(
+        Wavefront::Exception::InvalidMetricName)
+    end
+
+    it 'rejects odd characters' do
+      expect{valid_path?('metric.is.(>_<)')}.to raise_exception(
+        Wavefront::Exception::InvalidMetricName)
+    end
+  end
+
+  describe '#valid_value?' do
+    it 'accepts integers' do
+      expect(valid_value?(123456)).to be(true)
+    end
+
+    it 'accepts 0' do
+      expect(valid_value?(0)).to be(true)
+    end
+
+    it 'accepts negative integers' do
+      expect(valid_value?(-10)).to be(true)
+    end
+
+    it 'accepts decimals' do
+      expect(valid_value?(1.2345678)).to be(true)
+    end
+
+    it 'accepts exponential notation' do
+      expect(valid_value?(1.23e04)).to be(true)
+    end
+
+    it 'rejects strings which look like numbers' do
+      expect { valid_value?('1.23')}.to raise_exception(
+        Wavefront::Exception::InvalidMetricValue)
+    end
+  end
+
+  describe '#valid_ts?' do
+    it 'rejects integers' do
+      expect { valid_ts?(Time.now.to_i) }.to raise_exception(
+        Wavefront::Exception::InvalidTimestamp)
+    end
+
+    it 'accepts Times' do
+      expect(valid_ts?(Time.now)).to be(true)
+    end
+
+    it 'accepts DateTimes' do
+      expect(valid_ts?(DateTime.now)).to be(true)
+    end
+
+    it 'accepts Dates' do
+      expect(valid_ts?(Date.today)).to be(true)
+    end
+  end
+
+  describe '#valid_tags?' do
+    it 'accepts zero tags' do
+      expect(valid_tags?({})).to be(true)
+    end
+
+    it 'accepts nice sensible tags' do
+      expect(valid_tags?({tag1: 'val1', tag2: 'val2'})).to be(true)
+    end
+
+    it 'accepts spaces and symbols in values' do
+      expect(valid_tags?({tag1: 'val 1', tag2: 'val 2'})).to be(true)
+      expect(valid_tags?({tag1: '(>_<)', tag2: '^_^'})).to be(true)
+    end
+
+    it 'rejects spaces and symbols in keys' do
+      expect { valid_tags?({'tag 1' => 'val1',
+                              'tag 2' => 'val2'}) }.to raise_exception(
+        Wavefront::Exception::InvalidTag)
+      expect { valid_tags?({'(>_<)' => 'val1',
+                              '^_^'   => 'val2'}) }.to raise_exception(
+        Wavefront::Exception::InvalidTag)
+    end
+
+    it 'rejects long keys and/or values' do
+      expect { valid_tags?({tag1: 'v' * 255}) }.to raise_exception(
+        Wavefront::Exception::InvalidTag)
+      expect { valid_tags?({'k' * 255 => 'val1'}) }.to raise_exception(
+        Wavefront::Exception::InvalidTag)
+      expect { valid_tags?({'k' * 130 => 'v' * 130}) }.to raise_exception(
+        Wavefront::Exception::InvalidTag)
+    end
+  end
+end

data/wavefront-client.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency 'yard',  '~> 0.9.5'
 
   spec.add_dependency "rest-client", ">= 1.6.7", "< 1.8"
   spec.add_dependency "docopt", "~> 0.5.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-client
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.1
 platform: ruby
 authors:
 - Sam Pointer
@@ -13,82 +13,96 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2016-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.7
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.7
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: docopt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
@@ -114,9 +128,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - NOTICE
@@ -130,6 +144,7 @@ files:
 - lib/wavefront/cli/alerts.rb
 - lib/wavefront/cli/batch_write.rb
 - lib/wavefront/cli/events.rb
+- lib/wavefront/cli/sources.rb
 - lib/wavefront/cli/ts.rb
 - lib/wavefront/cli/write.rb
 - lib/wavefront/client.rb
@@ -140,6 +155,7 @@ files:
 - lib/wavefront/metadata.rb
 - lib/wavefront/mixins.rb
 - lib/wavefront/response.rb
+- lib/wavefront/validators.rb
 - lib/wavefront/writer.rb
 - spec/example_response.json
 - spec/spec_helper.rb
@@ -154,6 +170,7 @@ files:
 - spec/wavefront/cli/resources/alert.raw
 - spec/wavefront/cli/resources/alert.ruby
 - spec/wavefront/cli/resources/write.parabola
+- spec/wavefront/cli/sources_spec.rb
 - spec/wavefront/cli/write_spec.rb
 - spec/wavefront/cli_spec.rb
 - spec/wavefront/client_spec.rb
@@ -161,6 +178,7 @@ files:
 - spec/wavefront/metadata_spec.rb
 - spec/wavefront/mixins_spec.rb
 - spec/wavefront/response_spec.rb
+- spec/wavefront/validators_spec.rb
 - spec/wavefront/writer_spec.rb
 - wavefront-client.gemspec
 homepage: https://github.com/wavefrontHQ/ruby-client
@@ -173,12 +191,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -201,6 +219,7 @@ test_files:
 - spec/wavefront/cli/resources/alert.raw
 - spec/wavefront/cli/resources/alert.ruby
 - spec/wavefront/cli/resources/write.parabola
+- spec/wavefront/cli/sources_spec.rb
 - spec/wavefront/cli/write_spec.rb
 - spec/wavefront/cli_spec.rb
 - spec/wavefront/client_spec.rb
@@ -208,4 +227,5 @@ test_files:
 - spec/wavefront/metadata_spec.rb
 - spec/wavefront/mixins_spec.rb
 - spec/wavefront/response_spec.rb
+- spec/wavefront/validators_spec.rb
 - spec/wavefront/writer_spec.rb