wavefront-client 1.0.1 → 1.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWYzOTdiOTVhYzhlMDhlNzYwMGQzZDMwZGU5ZWM5NGY1NGE4ODgxMQ==
+    YWVmNGM2NDQ4ZGQwNmMzZmIzN2JkZGJjMzllYTY2ZmE3NmY3MzkxMw==
   data.tar.gz: !binary |-
-    MDBhYzIwNDM5YmZmZjkzNTU2YTc1NzVkNWM1NWEzMjJhMDdlYTgxZQ==
+    MTFiMTczNWUxOWMzNTk3OTljNmMyMzg1YTUyZDJhMGQxN2ZkNzI5YQ==
 SHA512:
   metadata.gz: !binary |-
-    MTJkMDUxMmQyZTcxNTk4MTkyNzQyMDQ0Njk0MmFmNmQxMmYwYzQ4NGU0ODVm
-    NDMxNDZjNjNhNjAwNjk5YjMzNTMxNWE4NWY5ODI5ZjczYWNhMDgxMGU1MWZm
-    NjJkMWNiOWM3YjM0ZWRhMmMwYjViNmQzZDJiZDQzMzgzNTIwOTU=
+    ZDYwMzRiZTY0NjBhNjcyNzQwNWZmNDQ4NzI1OThlZmQyODhhMjYzNGExN2E2
+    YTY3NGNmN2RhYWIwYmVhMmQyN2ZhM2E0MTI1MDRkMjQ1NjhlYTYyYTFiOTkw
+    MTRlMjdiMjhkMjA3OWJhYTQ2YzU4OGUwYmQzZGU4NzczMzZiMDk=
   data.tar.gz: !binary |-
-    YTE4OTg4YTAwYWI3N2MzZWYwYzFhMmZhNjE3ZjFiOGRhZjkzYzc5MTBlYWY0
-    Njc4Y2Q1NzY0MDI4OWI1OWY2MGJhZGM2ZDAyZWYwYTAzNDgyNjU4YTMzNWU0
-    ZWE1MDAyYjcyNGZkZTVmYjc4NmEwZGZjNjFmZjY2NmE2ZDI3YmE=
+    YWE4ZmE0MWFlODcxZTg4NzE2YWY5MjFjYjc1MTRiM2E0YTJlZDE5NjYwY2Qx
+    Y2E4Nzg1MmY2ZjNjMWNmZjAzZWNiMzBhYzNjMTgyMmQxNDRhYzU3OTZkMzNj
+    MmMyNjAwYzQ4NDI2NTUzYTgwNjJjNTkzNTZhOWVkZjdiMzllZGM=

data/lib/wavefront/alerting.rb

@@ -27,22 +27,53 @@ module Wavefront
 
     attr_reader :token
 
-    def initialize(token)
+    def initialize(token, debug=false)
       @token = token
+      debug(debug)
     end
 
     def active(options={})
+      get_alerts('active', options)
+    end
+
+    def all(options={})
+      get_alerts('all', options)
+    end
+
+    def invalid(options={})
+      get_alerts('invalid', options)
+    end
+
+    def snoozed(options={})
+      get_alerts('snoozed', options)
+    end
 
+    def affected_by_maintenance(options={})
+      get_alerts('affected_by_maintenance', options)
+    end
+
+    def get_alerts(path, options={})
       options[:host] ||= DEFAULT_HOST
       options[:path] ||= DEFAULT_PATH
 
-      uri = URI::HTTPS.build(:host => options[:host], :path => options[:path])
-      uri = URI.join(uri.to_s,"active")
-      uri = URI.join(uri.to_s,"?t=#{@token}")
-      
-      response = RestClient.get(uri.to_s)
+      query = "t=#{@token}"
+
+      if options[:shared_tags]
+        tags = options[:shared_tags].class == Array ? options[:shared_tags] : [ options[:shared_tags] ] # Force an array, even if string given
+        query += "&#{tags.map{|t| "customerTag=#{t}"}.join('&')}"
+      end
+
+      if options[:private_tags]
+        tags = options[:private_tags].class == Array ? options[:private_tags] : [ options[:private_tags] ] # Force an array, even if string given
+        query += "&#{tags.map{|t| "userTag=#{t}"}.join('&')}"
+      end
 
-      return response
+      uri = URI::HTTPS.build(
+        host: options[:host],
+	path: File.join(options[:path], path),
+	query: query
+      )
+      RestClient.get(uri.to_s)
     end
 
     private

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.1"
+    VERSION = "1.0.2"
   end
 end

data/spec/spec_helper.rb

@@ -18,6 +18,7 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'wavefront/client'
 require 'wavefront/writer'
 require 'wavefront/metadata'
+require 'wavefront/alerting'
 
 TEST_TOKEN = "test"
 TEST_HOST = "metrics.wavefront.com"

data/spec/wavefront/alerting_spec.rb

@@ -0,0 +1,111 @@
+=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.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+   limitations under the License.
+
+=end
+
+require 'spec_helper'
+require 'pathname'
+
+describe Wavefront::Alerting do
+  before do
+    @wave = Wavefront::Alerting.new(TEST_TOKEN)
+  end
+
+  it 'has some defaults' do
+    expect(Wavefront::Alerting::DEFAULT_HOST).to_not be_nil
+    expect(Wavefront::Alerting::DEFAULT_HOST).to be_a_kind_of String
+    expect(Wavefront::Alerting::DEFAULT_PATH).to_not be_nil
+    expect(Wavefront::Alerting::DEFAULT_PATH).to be_a_kind_of String
+  end
+
+
+  describe "#initialize" do
+    it 'accepts a token option initialized and exposes token for reading' do
+      wave = Wavefront::Alerting.new(TEST_TOKEN)
+      expect(wave.token).to eq TEST_TOKEN
+    end
+
+    it 'enables rest-client debugging if instructed to do so' do
+      wave = Wavefront::Alerting.new(TEST_TOKEN, true)
+      expect RestClient.log == 'stdout'
+    end
+  end
+
+  describe '#get_alerts' do
+    it 'makes API request with default options' do
+      expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, Wavefront::Alerting::DEFAULT_PATH, "all?t=#{TEST_TOKEN}")}")
+      @wave.get_alerts('all')
+    end
+
+    it 'makes API request with specified host' do
+      host = 'madeup.wavefront.com'
+      expect(RestClient).to receive(:get).with("https://#{File.join(host, Wavefront::Alerting::DEFAULT_PATH, "all?t=#{TEST_TOKEN}")}")
+      @wave.get_alerts('all', { :host => host } )
+    end
+
+    it 'makes API request with specified path' do
+      path = '/api/new_alerts' 
+      expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, path, "all?t=#{TEST_TOKEN}")}")
+      @wave.get_alerts('all', { :path => path })
+    end
+
+    it 'makes API request with appended shared tags' do
+      tags = [ 'first', 'second' ]
+      expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, Wavefront::Alerting::DEFAULT_PATH, "all?t=#{TEST_TOKEN}&customerTag=first&customerTag=second")}")
+      @wave.get_alerts('all', { :shared_tags => tags })
+    end
+
+    it 'makes API request with appended private tags' do
+      tags = [ 'first', 'second' ]
+      expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, Wavefront::Alerting::DEFAULT_PATH, "all?t=#{TEST_TOKEN}&userTag=first&userTag=second")}")
+      @wave.get_alerts('all', { :private_tags => tags })
+    end
+
+    it 'makes API request with both appended private tags and shared tags' do
+      private_tag = 'first' 
+      shared_tag = 'second'
+      expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, Wavefront::Alerting::DEFAULT_PATH, "all?t=#{TEST_TOKEN}&customerTag=second&userTag=first")}")
+      @wave.get_alerts('all', { :private_tags => private_tag, :shared_tags => shared_tag })
+    end
+  end
+
+  describe '#active' do
+    it 'requests all active alerts' do
+      expect(@wave).to receive(:get_alerts).with("active", {}) 
+      @wave.active
+    end
+  end
+
+  describe '#snoozed' do
+    it 'requests all snoozed alerts' do
+      expect(@wave).to receive(:get_alerts).with("snoozed", {}) 
+      @wave.snoozed
+    end
+  end
+
+  describe '#invalid' do
+    it 'requests all invalid alerts' do
+      expect(@wave).to receive(:get_alerts).with("invalid", {}) 
+      @wave.invalid
+    end
+  end
+
+  describe '#affected_by_maintenance' do
+    it 'requests all affected_by_maintenance alerts' do
+      expect(@wave).to receive(:get_alerts).with("affected_by_maintenance", {}) 
+      @wave.affected_by_maintenance
+    end
+  end
+  
+end

data/wavefront-client.gemspec

@@ -38,8 +38,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 
-  spec.add_dependency "rest-client", "~> 1.6.7"
-  spec.add_dependency "slop", "= 3.4.7"
+  spec.add_dependency "rest-client", ">= 1.6.7", "<= 1.8"
+  spec.add_dependency "slop", ">= 3.4.7", "<= 3.6"
   spec.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Sam Pointer
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-13 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,30 +60,42 @@ dependencies:
   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: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.4.7
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.4.7
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: A simple abstraction for talking to wavefront in ruby
 email:
 - support@wavefront.com
@@ -113,6 +125,7 @@ files:
 - lib/wavefront/writer.rb
 - spec/example_response.json
 - spec/spec_helper.rb
+- spec/wavefront/alerting_spec.rb
 - spec/wavefront/client_spec.rb
 - spec/wavefront/metadata_spec.rb
 - spec/wavefront/mixins_spec.rb
@@ -146,6 +159,7 @@ summary: A simple abstraction for talking to wavefront in ruby
 test_files:
 - spec/example_response.json
 - spec/spec_helper.rb
+- spec/wavefront/alerting_spec.rb
 - spec/wavefront/client_spec.rb
 - spec/wavefront/metadata_spec.rb
 - spec/wavefront/mixins_spec.rb