rspec-statsd 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - 1.8.7
+  - ree

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-statsd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Grzesiek Kolodziejczyk
+
+MIT License
+
+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.md

@@ -0,0 +1,39 @@
+# RSpec::Statsd
+
+[![Build Status](https://secure.travis-ci.org/grk/rspec-statsd.png)](http://travis-ci.org/grk/rspec-statsd)
+
+
+RSpec::Statsd provides a way to measure rspec runs in statsd. It uses the
+[http_statsd](https://github.com/grk/http_statsd/) gem to send the results
+over HTTP to a http statsd proxy.
+
+## Usage
+
+Add the gem to your Gemfile, and add the following lines to your spec_helper.rb:
+
+```ruby
+RSpec::Statsd.base_uri = "http://statsd.example.com"
+RSpec::Statsd.username = "api1"
+RSpec::Statsd.password = "pass1"
+RSpec::Statsd.metric = "some-test"
+
+RSpec.configure do |config|
+  config.add_formatter("progress")
+  config.add_formatter(RSpec::Statsd::Formatter)
+end
+```
+
+The Formatter will send the following metrics to statsd when a suite is ran:
+
+  * `some-test.duration` - timing with the duration of the rspec run
+  * `some-test.count` - counter will be incremented
+
+Additionally, when the suite has no errors:
+
+  * `some-test.success.duration` - timing with the duration of the rspec run
+  * `some-test.success.count` - counter will be incremented
+
+And when the suite has errors:
+
+  * `some-test.failure.duration` - timing with the duration of the rspec run
+  * `some-test.failute.count` - counter will be incremented

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "run specs"
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]

data/lib/rspec-statsd.rb

@@ -0,0 +1,16 @@
+require "rspec-statsd/version"
+require "rspec-statsd/formatter"
+require "http_statsd"
+
+module RSpec
+  module Statsd
+    extend self
+
+    attr_accessor :base_uri, :username, :password, :metric
+
+    def client
+      @client ||= HttpStatsd::Client.new(:base_uri => base_uri,
+        :username => username, :password => password)
+    end
+  end
+end

data/lib/rspec-statsd/formatter.rb

@@ -0,0 +1,25 @@
+require 'rspec/core/formatters/base_formatter'
+
+module RSpec
+  module Statsd
+    class Formatter < RSpec::Core::Formatters::BaseFormatter
+      def dump_summary(duration, example_count, failure_count, pending_count)
+        result = failure_count == 0 ? "success" : "failure"
+
+        client.gauge("#{metric}.duration", duration)
+        client.increment("#{metric}.count")
+        client.gauge("#{metric}.#{result}.duration", duration)
+        client.increment("#{metric}.#{result}.count")
+      end
+
+      private
+      def client
+        RSpec::Statsd.client
+      end
+
+      def metric
+        RSpec::Statsd.metric
+      end
+    end
+  end
+end

data/lib/rspec-statsd/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Statsd
+    VERSION = "0.0.1"
+  end
+end

data/rspec-statsd.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec-statsd/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rspec-statsd"
+  gem.version       = RSpec::Statsd::VERSION
+  gem.authors       = ["Grzesiek Kołodziejczyk"]
+  gem.email         = ["gk@code-fu.pl"]
+  gem.summary       = "Report status and duration of RSpec runs to statsd"
+  gem.homepage      = "https://github.com/grk/rspec-statsd/"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "rspec-core", "~> 2.0"
+  gem.add_runtime_dependency "http_statsd"
+
+  gem.add_development_dependency "rspec", "~> 2.11"
+  gem.add_development_dependency "rake"
+end

data/spec/formatter_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe RSpec::Statsd::Formatter do
+  let(:formatter) { RSpec::Statsd::Formatter.new(nil) }
+  let(:client) { mock(HttpStatsd::Client).as_null_object }
+
+  before do
+    formatter.stub(:client => client)
+  end
+
+  describe "dump_summary" do
+    it "should measure duration" do
+      client.should_receive(:gauge).with("sample-test.duration", 12.3)
+      formatter.dump_summary(12.3, 10, 0, 0)
+    end
+
+    it "should count runs" do
+      client.should_receive(:increment).with("sample-test.count")
+      formatter.dump_summary(12.3, 10, 0, 0)
+    end
+
+    context "when suite is successful" do
+      it "should measure successful duration" do
+        client.should_receive(:gauge).with("sample-test.success.duration", 12.3)
+        formatter.dump_summary(12.3, 10, 0, 0)
+      end
+
+      it "should count successful runs" do
+        client.should_receive(:increment).with("sample-test.success.count")
+        formatter.dump_summary(12.3, 10, 0, 0)
+      end
+    end
+
+    context "when suite has failures" do
+      it "should measure failed duration" do
+        client.should_receive(:gauge).with("sample-test.failure.duration", 12.3)
+        formatter.dump_summary(12.3, 9, 1, 0)
+      end
+
+      it "should count failed runs" do
+        client.should_receive(:increment).with("sample-test.failure.count")
+        formatter.dump_summary(12.3, 9, 1, 0)
+      end
+    end
+  end
+end

data/spec/rspec-statsd_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe RSpec::Statsd do
+  describe "client" do
+    it "should return a HttpStatsd::Client" do
+      client = mock
+      HttpStatsd::Client.should_receive(:new).with(:username => "api1",
+        :password => "pass1", :base_uri => "http://statsd.example.com").
+        and_return(client)
+
+      RSpec::Statsd.client.should eql(client)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec-statsd'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.before(:suite) do
+    RSpec::Statsd.base_uri = "http://statsd.example.com"
+    RSpec::Statsd.username = "api1"
+    RSpec::Statsd.password = "pass1"
+    RSpec::Statsd.metric = "sample-test"
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: rspec-statsd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Grzesiek Kołodziejczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: http_statsd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- gk@code-fu.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-statsd.rb
+- lib/rspec-statsd/formatter.rb
+- lib/rspec-statsd/version.rb
+- rspec-statsd.gemspec
+- spec/formatter_spec.rb
+- spec/rspec-statsd_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/grk/rspec-statsd/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1491068059829848855
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1491068059829848855
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Report status and duration of RSpec runs to statsd
+test_files:
+- spec/formatter_spec.rb
+- spec/rspec-statsd_spec.rb
+- spec/spec_helper.rb