opentsdb 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: b9c05b82d4390fd75cad12cf522d8d85a4ad3120
-  data.tar.gz: 9d7453a648b67f73f0086c992f4f7e8c6b77e247
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWNlYzdmNjdmN2MyZWZhNWFmMzkxZTI0ZTU5NWJhZmJiNGU5ODI4OQ==
+  data.tar.gz: !binary |-
+    MTYwYmQ5ZTU1NmVjMWQyNzgwOTc4Y2EyNzU4OTEwNGIwMGEyMzU3Mg==
 SHA512:
-  metadata.gz: 80126de66e433fa14a7cf4474fc2f042978b870c0f95811c214e4c359b3ab289167cc832e8de37f3cb9de2782e34a20f1782e6abcbb658f186cf2d4e6823ea00
-  data.tar.gz: b80ebfbd5e83730c3aa4074828bf7da05861fc8a54ffac2436d5bce5bc9621cc6846e17e24e56d994f1f5934dd26e2e956511865dbe97cbd7bd4e4128c1e1607
+  metadata.gz: !binary |-
+    MDliZGY5NTNlZmNhY2FhYmY1MDE5Yjg1ZTUwYjkzNDUxOThmYTNjNTkwNWIz
+    N2I0MGYwZDNiZDA3NTY5YzdmZDAyNjEzYTNlZWY1NTIzMmI3ZTg3MjA1YjEw
+    ZjE3MDk5ZjUzNTQzY2ViMGZmZjA5YjI5ZmQyNmE0NTdjMTcwZDI=
+  data.tar.gz: !binary |-
+    N2VlYzJlYjI4M2M0MjgzY2QyYzk2MTgyODlkYWM4MWQ3MmQxMzA4ZDBkOGFj
+    ZmQ2MGRhODAxMzQ2ZDgzNWE0NDk0Nzg2MjAyZDJhZjBlNGFlZDdiYjc4NThk
+    M2I5N2FkNzJiZjI1MzQ2YTQwOTdkZjJjMzk2ZGVhM2Q1ZTQ3ODc=

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format doc

data/.travis.yml

@@ -1,5 +1,14 @@
+before_install:
+- gem install bundler
 language: ruby
 rvm:
- - 1.9.3
- - 2.0
- - 2.1
+- 1.9.3
+- 2.0
+- 2.1
+deploy:
+  provider: rubygems
+  gem: opentsdb
+  api_key:
+    secure: c/2n2sHe7gba+OqBrH5YKxWFJ1klbOW5LRT67oIPnYBChRpdpzAx7CNFgpzXu3TQ77LbY0WChKAai4exvM4E752vj41r3Xdrk0xPAfUY/y51szexDLk9mT1s7VdXCCmPr+Y1e5eV9VZxK+heJyy4gejPsgStNS8qgua+859Xpz4=
+  on:
+    branch: master

data/README.md

@@ -4,21 +4,32 @@ Status](https://travis-ci.org/johnewart/ruby-opentsdb.svg?branch=master)](https:
 
 ## What is this?
 
-This is a Ruby client for simplifying interactions with OpenTSDB
+This is a Ruby client for simplifying interactions with OpenTSDB.
 
 ## What does it do?
 
-As of this instant, not a whole lot except wrap the "put" method in a 
-quick-and-dirty style. This will eventually grow to be much more useful 
-as I expand functionality. 
+As of this instant, not a whole lot except wrap the "put" method in a
+quick-and-dirty style. This will eventually grow to be much more useful
+as I expand functionality.
+
+## Requirements
+
+ruby 1.9.3+
 
 ## Quick example
 
-    @client = OpenTSDB::Client.new({:hostname => 'localhost', :port => 4242})
+```ruby
+  @client = OpenTSDB::Client.new(hostname: 'localhost', port: 4242)
 
-    sample = { :metric => 'double_rainbow.count', :value => 42, :timestamp => Time.now.to_i, :tags => {:factor => 'awesome', :host => 'ponies' } }
-    @client.put(sample)
+  sample = {
+    metric: 'double_rainbow.count',
+    value: 42,
+    timestamp: Time.now.to_i,
+    tags: { factor: 'awesome', host: 'ponies' }
+  }
 
+  @client.put(sample)
+```
 
 ## License
 

data/examples/client.rb

@@ -1,8 +1,12 @@
 require 'rubygems'
-$:.unshift File.dirname(__FILE__) + "/../lib"
+$:.unshift File.dirname(__FILE__) + '/../lib'
 require 'opentsdb'
 
-@client = OpenTSDB::Client.new({:hostname => 'localhost', :port => 4242})
+@client = OpenTSDB::Client.new(hostname: 'localhost', port: 4242)
+
+sample = {
+  metric: 'double_rainbow.count', value: 42, timestamp: Time.now.to_i,
+  tags: { factor: 'awesome', host: 'ponies' }
+}
 
-sample = { :metric => 'double_rainbow.count', :value => 42, :timestamp => Time.now.to_i, :tags => {:factor => 'awesome', :host => 'ponies' } }
 @client.put(sample)

data/lib/opentsdb/client.rb

@@ -8,25 +8,24 @@ module OpenTSDB
     attr_reader :connection
 
     def initialize(options = {})
-      begin
-        hostname = options[:hostname] || 'localhost'
-        port = options[:port] || 4242
-        @connection = TCPSocket.new(hostname, port)
-      rescue
-        raise "Unable to connect or invalid connection data"
-      end
+      hostname    = options[:hostname] || 'localhost'
+      port        = options[:port] || 4242
+      @connection = TCPSocket.new(hostname, port)
+    rescue
+      raise Errors::UnableToConnectError
     end
 
-    def to_command( options )
-      timestamp = options[:timestamp].to_i
+    def to_command(options)
+      timestamp   = options[:timestamp].to_i
       metric_name = options[:metric]
-      value = options[:value].to_f
-      tags = options[:tags].map{|k,v| "#{k}=#{v}"}.join(" ")
+      value       = options[:value].to_f
+      tags        = options[:tags].map { |k, v| "#{k}=#{v}" }.join(' ')
+
       "put #{metric_name} #{timestamp} #{value} #{tags}"
     end
 
-    def build_command(input) 
-      if input.kind_of?(Array)
+    def build_command(input)
+      if input.is_a?(Array)
         input.collect { |unit| to_command(unit) }.join("\n")
       else
         to_command(input)

data/lib/opentsdb/errors.rb

@@ -0,0 +1,9 @@
+module OpenTSDB
+  module Errors
+    class UnableToConnectError < StandardError
+      def to_s
+        'Unable to connect or invalid connection data'
+      end
+    end
+  end
+end

data/lib/opentsdb/version.rb

@@ -1,3 +1,3 @@
 module OpenTSDB
-  VERSION = "0.2.0"
+  VERSION = '1.0.0'
 end

data/lib/opentsdb.rb

@@ -12,4 +12,5 @@ module OpenTSDB
   end
 end
 
+require 'opentsdb/errors'
 require 'opentsdb/client'

data/opentsdb.gemspec

@@ -1,25 +1,27 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "opentsdb/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'opentsdb/version'
 
 Gem::Specification.new do |s|
-  s.name        = "opentsdb"
+  s.name        = 'opentsdb'
   s.version     = OpenTSDB::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["John Ewart"]
-  s.email       = ["john@johnewart.net"]
-  s.homepage    = "https://github.com/johnewart/ruby-opentsdb"
-  s.summary     = %q{Ruby client for OpenTSDB}
-  s.description = %q{A Ruby implementation of a client library for sending data points to OpenTSDB}
+  s.authors     = ['John Ewart']
+  s.email       = ['john@johnewart.net']
+  s.homepage    = 'https://github.com/johnewart/ruby-opentsdb'
+  s.summary     = 'Ruby client for OpenTSDB'
+  s.description = 'A Ruby implementation of a client library for sending data points to OpenTSDB'
   s.license     = 'MIT'
 
-  s.rubyforge_project = "opentsdb"
+  s.rubyforge_project = 'opentsdb'
 
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "simplecov", [">= 0.3.8"] #, :require => false
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov', ['>= 0.3.8']
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 end

data/spec/client_spec.rb

@@ -1,45 +1,60 @@
 require 'spec_helper.rb'
 
 describe OpenTSDB::Client do
-  before :each do 
-    @socket = double('socket').as_null_object
-    expect(TCPSocket).to receive(:new).and_return(@socket)
-    @client = OpenTSDB::Client.new
+  let(:socket) { double('socket').as_null_object }
+  let(:client) { described_class.new }
+
+  before(:each) do
+    allow(TCPSocket).to receive(:new).and_return(socket)
   end
-  
-  it "should create a new client" do  
+
+  describe 'error handling' do
+    subject { described_class.new }
+
+    it 'raises a custom error if the connection failed' do
+      expect(TCPSocket).to receive(:new).and_raise('connection error')
+
+      expect { subject }.to raise_error(OpenTSDB::Errors::UnableToConnectError)
+    end
   end
 
-  it "should write a single metric to the socket" do 
-    expect(@socket).to receive(:puts).with("put users 1411104988 100.0 foo=bar")
+  it 'creates a new client' do
+    expect { client }.to_not raise_error
+  end
+
+  it 'writes a single metric to the socket' do
+    expect(socket).to receive(:puts).with('put users 1411104988 100.0 foo=bar')
+
     metric = {
-      :timestamp => 1411104988,
-      :metric => "users",
-      :value => 100,
-      :tags => { :foo => "bar" }
+      timestamp: 1411104988,
+      metric: 'users',
+      value: 100,
+      tags: { foo: 'bar' },
     }
-    @client.put(metric)
+
+    client.put(metric)
   end
 
-  it "should write multiple metrics to the socket" do
-    expect(@socket).to receive(:puts).with("put users 1411104988 100.0 foo=bar\nput users 1411104999 150.0 bar=baz")
-    metrics = []
-    metrics << {
-      :timestamp => 1411104988,
-      :metric => "users",
-      :value => 100,
-      :tags => { :foo => "bar" }
-    }
+  it 'writes multiple metrics to the socket' do
+    expect(socket).to receive(:puts).with(
+      "put users 1411104988 100.0 foo=bar\nput users 1411104999 150.0 bar=baz"
+    )
 
-    metrics << {
-      :timestamp => 1411104999,
-      :metric => "users",
-      :value => 150,
-      :tags => { :bar => "baz" }
-     }
+    metrics = [
+      {
+        timestamp: 1411104988,
+        metric: 'users',
+        value: 100,
+        tags: { foo: 'bar' },
+      },
+      {
+        timestamp: 1411104999,
+        metric: 'users',
+        value: 150,
+        tags: { bar: 'baz' },
+      },
+    ]
 
-    @client.put(metrics)
-  
+    client.put(metrics)
   end
-  
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: opentsdb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - John Ewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2016-06-09 00:00:00.000000000 Z
 dependencies:
 - !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: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.3.8
 description: A Ruby implementation of a client library for sending data points to
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
@@ -57,6 +58,7 @@ files:
 - examples/client.rb
 - lib/opentsdb.rb
 - lib/opentsdb/client.rb
+- lib/opentsdb/errors.rb
 - lib/opentsdb/logging.rb
 - lib/opentsdb/version.rb
 - opentsdb.gemspec
@@ -72,20 +74,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: opentsdb
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for OpenTSDB
-test_files:
-- spec/client_spec.rb
-- spec/spec_helper.rb
+test_files: []