statsd-ruby 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Rein Henrichs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,29 @@
+= statsd
+
+A Ruby statsd client (https://github.com/etsy/statsd)
+
+= Testing
+
+Run the specs with <tt>rake spec</tt>
+
+Run the specs and include live integration specs with <tt>LIVE=true rake spec</tt>. Note: This will test over a real UDP socket.
+
+== Contributing to statsd
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Contributors
+
+* Rein Henrichs
+* Ray Krueger
+
+== Copyright
+
+Copyright (c) 2011 Rein Henrichs. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "statsd-ruby"
+  gem.homepage = "http://github.com/reinh/statsd"
+  gem.license = "MIT"
+  gem.summary = %Q{A Statsd client in Ruby}
+  gem.description = %Q{A Statsd client in Ruby}
+  gem.email = "rein@phpfog.com"
+  gem.authors = ["Rein Henrichs"]
+  gem.add_development_dependency "minitest", ">= 0"
+  gem.add_development_dependency "yard", "~> 0.6.0"
+  gem.add_development_dependency "jeweler", "~> 1.5.2"
+  gem.add_development_dependency "rcov", ">= 0"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/statsd.rb

@@ -0,0 +1,66 @@
+require 'socket'
+
+# = Statsd: A Statsd client (https://github.com/etsy/statsd)
+#
+# Example:
+#
+#     statsd = Statsd.new 'localhost', 8125
+#
+#     statsd.increment 'garets'
+#     statsd.timing 'glork', 320
+class Statsd
+  attr_accessor :namespace
+
+  class << self
+    attr_accessor :logger
+  end
+  
+  # @param [String] host your statsd host
+  # @param [Integer] port your statsd port
+  def initialize(host, port=8125)
+    @host, @port = host, port
+  end
+
+  # @param [String] stat stat name
+  # @param [Integer] sample_rate sample rate, 1 for always
+  def increment(stat, sample_rate=1); count stat, 1, sample_rate end
+
+  # @param [String] stat stat name
+  # @param [Integer] sample_rate sample rate, 1 for always
+  def decrement(stat, sample_rate=1); count stat, -1, sample_rate end
+
+  # @param [String] stat stat name
+  # @param [Integer] count count
+  # @param [Integer] sample_rate sample rate, 1 for always
+  def count(stat, count, sample_rate=1); send stat, count, 'c', sample_rate end
+
+  # @param [String] stat stat name
+  # @param [Integer] ms timing in milliseconds
+  # @param [Integer] sample_rate sample rate, 1 for always
+  def timing(stat, ms, sample_rate=1); send stat, ms, 'ms', sample_rate end
+
+  def time(stat, sample_rate=1)
+    start = Time.now
+    result = yield
+    timing(stat, ((Time.now - start) * 1000).round, sample_rate)
+    result
+  end
+
+  private
+
+  def sampled(sample_rate)
+    yield unless sample_rate < 1 and rand > sample_rate
+  end
+
+  def send(stat, delta, type, sample_rate)
+    prefix = "#{@namespace}." unless @namespace.nil?
+    sampled(sample_rate) { send_to_socket("#{prefix}#{stat}:#{delta}|#{type}#{'|@' << sample_rate.to_s if sample_rate < 1}") }
+  end
+
+  def send_to_socket(message)
+    self.class.logger.debug {"Statsd: #{message}"} if self.class.logger
+    socket.send(message, 0, @host, @port)
+  end
+
+  def socket; @socket ||= UDPSocket.new end
+end

data/spec/helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'minitest/autorun'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'statsd'
+
+class FakeUDPSocket
+  def initialize
+    @buffer = []
+  end
+
+  def send(message, *rest)
+    @buffer.push [message]
+  end
+
+  def recv
+    res = @buffer.shift
+  end
+
+  def clear
+    @buffer = []
+  end
+
+  def to_s
+    inspect
+  end
+
+  def inspect
+    "<FakeUDPSocket: #{@buffer.inspect}>"
+  end
+end

data/spec/statsd_spec.rb

@@ -0,0 +1,154 @@
+require 'helper'
+
+describe Statsd do
+  before do
+    @statsd = Statsd.new('localhost', 1234)
+    class << @statsd
+      public :sampled # we need to test this
+      attr_reader :host, :port # we also need to test this
+      def socket; @socket ||= FakeUDPSocket.new end
+    end
+  end
+
+  after { @statsd.socket.clear }
+
+  describe "#initialize" do
+    it "should set the host and port" do
+      @statsd.host.must_equal 'localhost'
+      @statsd.port.must_equal 1234
+    end
+
+    it "should default the port to 8125" do
+      Statsd.new('localhost').instance_variable_get('@port').must_equal 8125
+    end
+  end
+
+  describe "#increment" do
+    it "should format the message according to the statsd spec" do
+      @statsd.increment('foobar')
+      @statsd.socket.recv.must_equal ['foobar:1|c']
+    end
+
+    describe "with a sample rate" do
+      before { class << @statsd; def rand; 0; end; end } # ensure delivery
+      it "should format the message according to the statsd spec" do
+        @statsd.increment('foobar', 0.5)
+        @statsd.socket.recv.must_equal ['foobar:1|c|@0.5']
+      end
+    end
+  end
+
+  describe "#decrement" do
+    it "should format the message according to the statsd spec" do
+      @statsd.decrement('foobar')
+      @statsd.socket.recv.must_equal ['foobar:-1|c']
+    end
+
+    describe "with a sample rate" do
+      before { class << @statsd; def rand; 0; end; end } # ensure delivery
+      it "should format the message according to the statsd spec" do
+        @statsd.decrement('foobar', 0.5)
+        @statsd.socket.recv.must_equal ['foobar:-1|c|@0.5']
+      end
+    end
+  end
+
+  describe "#timing" do
+    it "should format the message according to the statsd spec" do
+      @statsd.timing('foobar', 500)
+      @statsd.socket.recv.must_equal ['foobar:500|ms']
+    end
+
+    describe "with a sample rate" do
+      before { class << @statsd; def rand; 0; end; end } # ensure delivery
+      it "should format the message according to the statsd spec" do
+        @statsd.timing('foobar', 500, 0.5)
+        @statsd.socket.recv.must_equal ['foobar:500|ms|@0.5']
+      end
+    end
+  end
+
+  describe "#time" do
+    it "should format the message according to the statsd spec" do
+      @statsd.time('foobar') { sleep(0.001); 'test' }
+      @statsd.socket.recv.must_equal ['foobar:1|ms']
+    end
+
+    it "should return the result of the block" do
+      result = @statsd.time('foobar') { sleep(0.001); 'test' }
+      result.must_equal 'test'
+    end
+
+    describe "with a sample rate" do
+      before { class << @statsd; def rand; 0; end; end } # ensure delivery
+
+      it "should format the message according to the statsd spec" do
+        result = @statsd.time('foobar', 0.5) { sleep(0.001); 'test' }
+        @statsd.socket.recv.must_equal ['foobar:1|ms|@0.5']
+      end
+    end
+  end
+
+  describe "#sampled" do
+    describe "when the sample rate is 1" do
+      it "should yield" do
+        @statsd.sampled(1) { :yielded }.must_equal :yielded
+      end
+    end
+
+    describe "when the sample rate is greater than a random value [0,1]" do
+      before { class << @statsd; def rand; 0; end; end } # ensure delivery
+      it "should yield" do
+        @statsd.sampled(0.5) { :yielded }.must_equal :yielded
+      end
+    end
+
+    describe "when the sample rate is less than a random value [0,1]" do
+      before { class << @statsd; def rand; 1; end; end } # ensure no delivery
+      it "should not yield" do
+        @statsd.sampled(0.5) { :yielded }.must_equal nil
+      end
+    end
+
+    describe "when the sample rate is equal to a random value [0,1]" do
+      before { class << @statsd; def rand; 0.5; end; end } # ensure delivery
+      it "should yield" do
+        @statsd.sampled(0.5) { :yielded }.must_equal :yielded
+      end
+    end
+  end
+
+  describe "with namespace" do
+    before { @statsd.namespace = 'service' }
+
+    it "should add namespace to increment" do
+      @statsd.increment('foobar')
+      @statsd.socket.recv.must_equal ['service.foobar:1|c']
+    end
+
+    it "should add namespace to decrement" do
+      @statsd.decrement('foobar')
+      @statsd.socket.recv.must_equal ['service.foobar:-1|c']
+    end
+
+    it "should add namespace to timing" do
+      @statsd.timing('foobar', 500)
+      @statsd.socket.recv.must_equal ['service.foobar:500|ms']
+    end
+  end
+end
+
+describe Statsd do
+  describe "with a real UDP socket" do
+    it "should actually send stuff over the socket" do
+      socket = UDPSocket.new
+      host, port = 'localhost', 12345
+      socket.bind(host, port)
+
+      statsd = Statsd.new(host, port)
+      statsd.increment('foobar')
+      message = socket.recvfrom(16).first
+      message.must_equal 'foobar:1|c'
+    end
+  end
+end if ENV['LIVE']

data/statsd-ruby.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{statsd-ruby}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rein Henrichs"]
+  s.date = %q{2011-06-23}
+  s.description = %q{A Statsd client in Ruby}
+  s.email = %q{rein@phpfog.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/statsd.rb",
+    "spec/helper.rb",
+    "spec/statsd_spec.rb",
+    "statsd-ruby.gemspec"
+  ]
+  s.homepage = %q{http://github.com/reinh/statsd}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{A Statsd client in Ruby}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: statsd-ruby
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Rein Henrichs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: A Statsd client in Ruby
+email: rein@phpfog.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/statsd.rb
+- spec/helper.rb
+- spec/statsd_spec.rb
+- statsd-ruby.gemspec
+has_rdoc: true
+homepage: http://github.com/reinh/statsd
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A Statsd client in Ruby
+test_files: []
+