wavefront-client 0.5.2

data/lib/wavefront/writer.rb

@@ -0,0 +1,55 @@
+=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 "wavefront/client/version"
+require "wavefront/exception"
+require 'uri'
+require 'socket'
+
+module Wavefront
+  class Writer
+    DEFAULT_AGENT_HOST = 'localhost'
+    DEFAULT_PORT = 2878
+    DEFAULT_HOSTNAME = %x{hostname -f}.chomp
+
+    def initialize(options = {})
+      options[:agent_host] ||= DEFAULT_AGENT_HOST
+      options[:agent_port] ||= DEFAULT_PORT
+      options[:host_name] ||= DEFAULT_HOSTNAME
+      options[:metric_name] ||= ''
+      options[:point_tags] ||= {}
+      
+      @host_name = options[:host_name]
+      @metric_name = options[:metric_name]
+      @point_tags = options[:point_tags]
+      
+      @socket = get_socket(options[:agent_host], options[:agent_port])
+    end
+    
+    def write(metric_value, metric_name=@metric_name, host=@host_name, point_tags=@point_tags, timestamp=Time.now)
+      raise Wavefront::Exception::EmptyMetricName if metric_name.empty?
+      tags = point_tags.empty? ? '' : point_tags.map{|k,v| "#{k}=\"#{v}\""}.join(' ')
+      append = tags.empty? ? "host=#{host}" : "host=#{host} #{tags}"
+      @socket.puts "#{metric_name} #{metric_value} #{timestamp.to_i} #{append}"
+    end
+
+    private
+    def get_socket(host,port)
+      TCPSocket.new(host, port)
+    end
+
+  end
+end

data/spec/example_response.json

@@ -0,0 +1 @@
+{"query":"ts(\"collectd.memory.memory.cached\", host=\"test.server\")","name":"Unknown","timeseries":[{"label":"collectd.memory.memory.cached","host":"test.server","data":[[1436487780,4.625565013333333E8],[1436487840,4.625646933333333E8],[1436487900,4.625728853333333E8],[1436487960,4.625810773333333E8],[1436488020,4.625926826666667E8],[1436488080,4.626015573333333E8],[1436488140,4.626097493333333E8],[1436488200,4.626179413333333E8],[1436488260,4.626261333333333E8],[1436488320,4.626343253333333E8],[1436488380,4.626425173333333E8],[1436488440,4.626507093333333E8],[1436488500,4.626589013333333E8],[1436488560,4.626670933333333E8],[1436488620,4.626752853333333E8],[1436488680,4.626868906666667E8],[1436488740,4.626957653333333E8],[1436488800,4.627039573333333E8],[1436488860,4.627121493333333E8],[1436488920,4.627203413333333E8],[1436488980,4.6272512E8]]}],"granularity":60,"stats":{"keys":24,"points":1336,"summaries":1314,"summarized_points":0,"summarized_summaries":0,"buffer_keys":24,"compacted_keys":2,"compacted_points":1314,"latency":78,"queries":2,"s3_keys":0,"cpu_ns":5412921}}

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+=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
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'wavefront/client'
+require 'wavefront/writer'
+require 'wavefront/metadata'
+
+TEST_TOKEN = "test"
+TEST_HOST = "metrics.wavefront.com"

data/spec/wavefront/client_spec.rb

@@ -0,0 +1,47 @@
+=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::Client do
+  it 'has a version number' do
+    expect(Wavefront::Client::VERSION).to_not be_nil
+  end
+
+  it 'has some defaults' do
+    expect(Wavefront::Client::DEFAULT_PERIOD_SECONDS).to_not be_nil
+    expect(Wavefront::Client::DEFAULT_PERIOD_SECONDS).to be_a_kind_of Fixnum
+    expect(Wavefront::Client::DEFAULT_HOST).to_not be_nil
+    expect(Wavefront::Client::DEFAULT_HOST).to be_a_kind_of String
+    expect(Wavefront::Client::DEFAULT_PATH).to_not be_nil
+    expect(Wavefront::Client::DEFAULT_PATH).to be_a_kind_of String
+    expect(Wavefront::Client::DEFAULT_FORMAT).to_not be_nil
+    expect(Wavefront::Client::DEFAULT_FORMAT).to be_a_kind_of Symbol
+    expect(Wavefront::Client::GRANULARITIES).to_not be_nil
+    expect(Wavefront::Client::GRANULARITIES).to be_a_kind_of Array
+  end
+
+
+  describe "#initialize" do
+    it 'accepts a token when initialized and expose it for reading' do
+      wave = Wavefront::Client.new(TEST_TOKEN)
+      headers = {'X-AUTH-TOKEN' => TEST_TOKEN}
+      expect(wave.headers).to eq headers
+    end
+  end
+
+end

data/spec/wavefront/metadata_spec.rb

@@ -0,0 +1,38 @@
+=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::Metadata do
+
+  it 'has some defaults' do
+    expect(Wavefront::Metadata::DEFAULT_HOST).to_not be_nil
+    expect(Wavefront::Metadata::DEFAULT_HOST).to be_a_kind_of String
+    expect(Wavefront::Metadata::DEFAULT_PATH).to_not be_nil
+    expect(Wavefront::Metadata::DEFAULT_PATH).to be_a_kind_of String
+  end
+
+
+  describe "#initialize" do
+    it 'accepts a token option initialized and exposes request header for reading' do
+      wave = Wavefront::Metadata.new(TEST_TOKEN)
+      headers = {'X-AUTH-TOKEN' => TEST_TOKEN}
+      expect(wave.headers).to eq headers
+    end
+  end
+  
+end

data/spec/wavefront/response_spec.rb

@@ -0,0 +1,74 @@
+=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'
+
+RESPONSE = 'test'
+
+describe Wavefront::Response::Raw do
+  it 'exposes the response' do
+    response = Wavefront::Response::Raw.new(RESPONSE)
+    expect(response).to respond_to(:response)
+    expect(response.response).to eq RESPONSE
+  end
+
+  it 'overloads to_s and returns the response' do
+    response = Wavefront::Response::Raw.new(RESPONSE)
+    expect(response).to respond_to(:to_s)
+    expect(response.to_s).to eq RESPONSE
+  end
+end
+
+describe Wavefront::Response::Ruby do
+  it 'exposes the response' do
+    example_response = File.read(Pathname.new(__FILE__).parent.parent.join('example_response.json'))
+    response = Wavefront::Response::Ruby.new(example_response)
+    expect(response).to respond_to(:response)
+    expect(response.response).to eq example_response
+  end
+
+  it 'dynamically sets accessors for each part of the response' do
+    example_response = File.read(Pathname.new(__FILE__).parent.parent.join('example_response.json'))
+    response = Wavefront::Response::Ruby.new(example_response)
+
+    %w(response query name timeseries stats).each do |part|
+      expect(response).to respond_to(part)
+    end
+  end
+end
+
+describe Wavefront::Response::Graphite do
+  it 'returns something that resembles some graphite output' do
+    example_response = File.read(Pathname.new(__FILE__).parent.parent.join('example_response.json'))
+    response = Wavefront::Response::Graphite.new(example_response)
+
+    expect(response.graphite.size).to eq(1)
+    expect(response.graphite[0].keys.size).to eq(2)
+    expect(response.graphite[0]['target']).to eq(response.query)
+    expect(response.graphite[0]['datapoints'].size).to eq(21)
+  end
+end
+
+describe Wavefront::Response::Highcharts do
+  it 'returns something that resembles highcharts output' do
+    example_response = File.read(Pathname.new(__FILE__).parent.parent.join('example_response.json'))
+    response = Wavefront::Response::Highcharts.new(example_response)
+    
+    expect(JSON.parse(response.to_json).size).to eq(response.timeseries.size)
+    JSON.parse(response.to_json).each { |m| expect(m.keys.size).to eq(2) }
+  end
+end

data/spec/wavefront/writer_spec.rb

@@ -0,0 +1,94 @@
+=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'
+require 'socket'
+
+class Mocket
+  def puts(str)
+    return true
+  end
+end
+
+describe Wavefront::Writer do
+
+  it 'has some defaults' do
+    expect(Wavefront::Writer::DEFAULT_HOST).to_not be_nil
+    expect(Wavefront::Writer::DEFAULT_HOST).to be_a_kind_of String 
+    expect(Wavefront::Writer::DEFAULT_PORT).to_not be_nil
+    expect(Wavefront::Writer::DEFAULT_PORT).to be_a_kind_of Fixnum 
+    expect(Wavefront::Writer::DEFAULT_HOSTNAME).to_not be_nil
+    expect(Wavefront::Writer::DEFAULT_HOSTNAME).to be_a_kind_of String 
+  end
+
+
+  describe "#initialize" do
+    it 'creates a socket object with the default parameters' do
+      allow(TCPSocket).to receive(:new)
+      expect(TCPSocket).to receive(:new).with('localhost', Wavefront::Writer::DEFAULT_PORT)
+      writer = Wavefront::Writer.new
+    end
+
+    it 'creates a socket object with parameters if specified' do
+      host = 'somehost'
+      port = '8566'
+      allow(TCPSocket).to receive(:new)
+      expect(TCPSocket).to receive(:new).with(host, port)
+      writer = Wavefront::Writer.new({:agent_host => host, :agent_port => port})
+    end
+  end
+
+  describe "#write" do
+    it 'should write a metric to a socket object' do
+      host = 'somehost'
+      port = '8566'
+      delay = 0
+      socket = Mocket.new
+      allow(TCPSocket).to receive(:new).and_return(socket)
+      allow(Time).to receive(:now).and_return(123456789)
+      expect(socket).to receive(:puts).with("metric 50 123456789 host=somehost")
+      writer = Wavefront::Writer.new
+      writer.write(50, "metric", host, {}, 123456789)
+    end
+    
+    it 'should accept a single tag and append it correctly' do
+      host = 'somehost'
+      port = '8566'
+      tags = {'tag_key_one' => 'tag_val_one'}
+      socket = Mocket.new
+      allow(TCPSocket).to receive(:new).and_return(socket)
+      allow(Time).to receive(:now).and_return(123456789)
+      expect(socket).to receive(:puts).with("metric 50 123456789 host=somehost tag_key_one=\"tag_val_one\"")
+      writer = Wavefront::Writer.new
+      writer.write(50, "metric", host, tags, 123456789)
+    end
+
+   it 'should accept multiple tags and append them correctly' do
+      host = 'somehost'
+      port = '8566'
+      tags = {'tag_key_one' => 'tag_val_one', 'k2' => 'v2'}
+      socket = Mocket.new
+      allow(TCPSocket).to receive(:new).and_return(socket)
+      allow(Time).to receive(:now).and_return(123456789)
+      expect(socket).to receive(:puts).with("metric 50 123456789 host=somehost tag_key_one=\"tag_val_one\" k2=\"v2\"")
+      writer = Wavefront::Writer.new
+      writer.write(50, "metric", host, tags, 123456789)
+
+   end
+  end
+
+end

data/wavefront-client.gemspec

@@ -0,0 +1,46 @@
+=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
+
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wavefront/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wavefront-client"
+  spec.version       = Wavefront::Client::VERSION
+  spec.authors       = ["Sam Pointer", "Louis McCormack", "Joshua McGhee", "Conor Beverland", "Salil Deshmukh"]
+  spec.email         = ["support@wavefront.com"]
+  spec.description   = %q{A simple abstraction for talking to wavefront in ruby}
+  spec.summary       = %q{A simple abstraction for talking to wavefront in ruby}
+  spec.homepage      = "https://github.com/wavefrontHQ/ruby-client"
+  spec.license       = "Apache License 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  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.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
+
+end
+

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: wavefront-client
+version: !ruby/object:Gem::Version
+  version: 0.5.2
+platform: ruby
+authors:
+- Sam Pointer
+- Louis McCormack
+- Joshua McGhee
+- Conor Beverland
+- Salil Deshmukh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.7
+description: A simple abstraction for talking to wavefront in ruby
+email:
+- support@wavefront.com
+executables:
+- wavefront-client
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE
+- NOTICE
+- README.md
+- Rakefile
+- bin/wavefront-client
+- lib/wavefront/alerting.rb
+- lib/wavefront/client.rb
+- lib/wavefront/client/constants.rb
+- lib/wavefront/client/version.rb
+- lib/wavefront/events.rb
+- lib/wavefront/exception.rb
+- lib/wavefront/metadata.rb
+- lib/wavefront/response.rb
+- lib/wavefront/writer.rb
+- spec/example_response.json
+- spec/spec_helper.rb
+- spec/wavefront/client_spec.rb
+- spec/wavefront/metadata_spec.rb
+- spec/wavefront/response_spec.rb
+- spec/wavefront/writer_spec.rb
+- wavefront-client.gemspec
+homepage: https://github.com/wavefrontHQ/ruby-client
+licenses:
+- Apache License 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A simple abstraction for talking to wavefront in ruby
+test_files:
+- spec/example_response.json
+- spec/spec_helper.rb
+- spec/wavefront/client_spec.rb
+- spec/wavefront/metadata_spec.rb
+- spec/wavefront/response_spec.rb
+- spec/wavefront/writer_spec.rb