graphite_client 0.3.0 → 0.4.1

data/README.md

@@ -1,5 +1,22 @@
+# graphite_client #
+
+## About ##
+
 Very simple ruby client for reporting metrics to [Graphite](http://graphite.wikidot.com/).
 
-Original code taken from a Gist created by [joakimk](https://github.com/joakimk).
-https://gist.github.com/1678399
+[Original code](https://gist.github.com/1678399) taken from a Gist by [joakimk](https://github.com/joakimk/).
+
+## Usage ##
+
+### Reporting the standard way, over TCP ###
+
+    graphite = GraphiteClient.new('graphite_host')
+    graphite.report('metric name', value, time)
+    graphite.report('another metric name', another_value, another_time)
+
+### Reporting [events](https://code.launchpad.net/~lucio.torre/graphite/add-events/+merge/69142) ###
+
+    graphite_event = GraphiteClient::EventReporter.new('http://graphite_host/events/')
+    graphite_event.report(:what => 'an event', :tags => ['some', 'tags'], :data => 'some info')
 
+* When reporting an event, you can (optionally) pass `:basic_auth => { :username => 'un', :password => 'pw' }` to the `GraphiteClient::EventReporter` constructor.

data/Rakefile

@@ -20,7 +20,8 @@ Jeweler::Tasks.new do |gem|
   gem.summary = %Q{Very simple ruby client for graphite.}
   gem.description = %Q{Original code by https://github.com/joakimk.}
   gem.email = "alex@crackpot.org"
-  gem.authors = ["Alex Dean"]
+  gem.authors = ["Alex Dean", "Matthew Trost"]
+  gem.require_paths = ["lib", "lib/graphite_client"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.1

data/graphite_client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "graphite_client"
-  s.version = "0.3.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Alex Dean"]
-  s.date = "2012-11-10"
+  s.authors = ["Alex Dean", "Matthew Trost"]
+  s.date = "2012-12-14"
   s.description = "Original code by https://github.com/joakimk."
   s.email = "alex@crackpot.org"
   s.extra_rdoc_files = [
@@ -27,12 +27,14 @@ Gem::Specification.new do |s|
     "VERSION",
     "graphite_client.gemspec",
     "lib/graphite_client.rb",
+    "lib/graphite_client/event_reporter.rb",
+    "spec/event_reporter_spec.rb",
     "spec/graphite_client_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/tedconf/graphite_client"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
+  s.require_paths = ["lib", "lib/graphite_client"]
   s.rubygems_version = "1.8.24"
   s.summary = "Very simple ruby client for graphite."
 

data/lib/graphite_client.rb

@@ -27,3 +27,5 @@ class GraphiteClient
     @socket = nil
   end
 end
+
+require 'graphite_client/event_reporter'

data/lib/graphite_client/event_reporter.rb

@@ -0,0 +1,27 @@
+require 'json'
+require 'net/http'
+require 'net/https'
+
+class GraphiteClient
+  class EventReporter
+    def initialize(graphite_server_events_url, opts={})
+      uri   = URI(graphite_server_events_url)
+      @http = Net::HTTP.new(uri.host, uri.port)
+      @req  = Net::HTTP::Post.new(uri.request_uri)
+
+      @http.use_ssl = true if uri.scheme == 'https'
+
+      if opts[:basic_auth]
+        username = opts[:basic_auth][:username]
+        password = opts[:basic_auth][:password]
+        @req.basic_auth(username, password)
+      end
+    end
+
+    def report(event={})
+      event[:tags] = Array(event[:tags]).join(',')
+      @req.body = event.to_json
+      @http.request(@req)
+    end
+  end
+end

data/spec/event_reporter_spec.rb

@@ -0,0 +1,67 @@
+require 'graphite_client'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "GraphiteClient::EventReporter" do
+  before do
+    @url         = 'http://example.com/path'
+    @uri         = URI(@url)
+    @https_url   = 'https://example.com/path'
+    @https_uri   = URI(@https_url)
+    @event       = {:what => 'test', :tags => 'test', :data => 'test'}
+    @basic_auth  = {:username => 'test', :password => 'test'}
+  end
+
+  it "should create an HTTP connection and POST to it" do
+    Net::HTTP.should_receive(:new).with(@uri.host, @uri.port).and_return(http = mock())
+    Net::HTTP::Post.should_receive(:new).with(@uri.request_uri).and_return(req = mock())
+    req.should_receive(:body=).with(@event.to_json)
+    http.should_receive(:request).with(req)
+    event_reporter = GraphiteClient::EventReporter.new(@url)
+    event_reporter.report(@event)
+  end
+
+  it "should reuse the same HTTP connection" do
+    Net::HTTP.should_receive(:new).with(@uri.host, @uri.port).and_return(http = mock())
+    Net::HTTP::Post.should_receive(:new).with(@uri.request_uri).and_return(req = mock())
+    req.should_receive(:body=).twice.with(@event.to_json)
+    http.should_receive(:request).twice.with(req)
+    event_reporter = GraphiteClient::EventReporter.new(@url)
+    event_reporter.report(@event)
+    event_reporter.report(@event)
+  end
+
+  context "with basic auth" do
+    it "should create an HTTP connection and POST to it, using basic auth" do
+      Net::HTTP.should_receive(:new).with(@uri.host, @uri.port).and_return(http = mock())
+      Net::HTTP::Post.should_receive(:new).with(@uri.request_uri).and_return(req = mock())
+      req.should_receive(:basic_auth).with(@basic_auth[:username], @basic_auth[:password])
+      req.should_receive(:body=).with(@event.to_json)
+      http.should_receive(:request).with(req)
+      event_reporter = GraphiteClient::EventReporter.new(@url, basic_auth: @basic_auth)
+      event_reporter.report(@event)
+    end
+  end
+
+  context "over SSL" do
+    it "should create an HTTPS connection and POST to it" do
+      Net::HTTP.should_receive(:new).with(@https_uri.host, @https_uri.port).and_return(http = mock())
+      Net::HTTP::Post.should_receive(:new).with(@https_uri.request_uri).and_return(req = mock())
+      http.should_receive(:use_ssl=).with(true)
+      req.should_receive(:body=).with(@event.to_json)
+      http.should_receive(:request).with(req)
+      event_reporter = GraphiteClient::EventReporter.new(@https_url)
+      event_reporter.report(@event)
+    end
+
+    it "should create an HTTPS connection and POST to it, using basic auth" do
+      Net::HTTP.should_receive(:new).with(@https_uri.host, @https_uri.port).and_return(http = mock())
+      Net::HTTP::Post.should_receive(:new).with(@https_uri.request_uri).and_return(req = mock())
+      http.should_receive(:use_ssl=).with(true)
+      req.should_receive(:basic_auth).with(@basic_auth[:username], @basic_auth[:password])
+      req.should_receive(:body=).with(@event.to_json)
+      http.should_receive(:request).with(req)
+      event_reporter = GraphiteClient::EventReporter.new(@https_url, basic_auth: @basic_auth)
+      event_reporter.report(@event)
+    end
+  end
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: graphite_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
 - Alex Dean
+- Matthew Trost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-10 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -93,6 +94,8 @@ files:
 - VERSION
 - graphite_client.gemspec
 - lib/graphite_client.rb
+- lib/graphite_client/event_reporter.rb
+- spec/event_reporter_spec.rb
 - spec/graphite_client_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/tedconf/graphite_client
@@ -102,6 +105,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- lib/graphite_client
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -110,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2039767072647927840
+      hash: 654855312543279234
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: