airbrake-statsd 0.1.0

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,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - ree

data/Gemfile

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

data/README.md

@@ -0,0 +1,64 @@
+# Airbrake-Statsd
+
+[![Build Status](https://secure.travis-ci.org/jimeh/airbrake-statsd.png)](http://travis-ci.org/jimeh/airbrake-statsd)
+
+Extends the [Airbrake][] gem to also report exceptions Esty's [Statsd][]
+statistics aggregator.
+
+## Installation
+
+    gem install airbrake-statsd
+
+## Usage
+
+It's assumed you know what both Airbrake and StatsD are before attempting to
+use this gem. If you don't, come back when you do know :)
+
+All that's needed is to require `airbrake-statsd` and call
+`Airbrake::Statsd.configure` and Airbrake notifications will automatically be
+sent to StatsD and Airbrake.
+
+```ruby
+require 'airbrake'
+require 'airbrake-statsd'
+
+Airbrake::Statsd.configure do |config|
+  config.host = 'my-statsd-server'
+  config.port = 8125
+  config.namespace = 'my_awesome_app'
+end
+
+Airbrake.notify({})
+```
+
+## Credit & Thanks
+
+* [Global Personals][gp] for hosting a hack day.
+
+## License and Copyright
+
+Copyright (c) 2012 Jim Myhrberg & Global Personals, Ltd.
+
+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.
+
+
+[airbrake]: http://airbrake.io/
+[statsd]: https://github.com/etsy/statsd
+[gp]: http://globalpersonals.co.uk/

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+# Default task
+task :default => 'spec'
+
+# Rspec
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:integration) do |spec|
+    spec.pattern = 'spec/integration/**/*_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:unit) do |spec|
+    spec.pattern = 'spec/unit/**/*_spec.rb'
+  end
+end

data/airbrake-statsd.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/airbrake-statsd/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Jim Myhrberg']
+  gem.email         = ['contact@jimeh.me']
+  gem.description   = 'Increment an exception counter in StatsD whenever ' +
+    'the Airbrake gem reports and exception.'
+  gem.summary       = 'Increment an exception counter in StatsD whenever ' +
+    'the Airbrake gem reports and exception.'
+  gem.homepage      = 'http://github.com/jimeh/airbrake-statsd'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'airbrake-statsd'
+  gem.require_paths = ['lib']
+  gem.version       = Airbrake::Statsd::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+
+  gem.add_runtime_dependency 'airbrake'
+  gem.add_runtime_dependency 'statsd-ruby'
+end

data/lib/airbrake-statsd/airbrake_ext.rb

@@ -0,0 +1,21 @@
+module Airbrake
+  class << self
+
+    def notify_with_statds(*args)
+      Airbrake::Statsd.increment
+      notify_without_statsd(*args)
+    end
+
+    alias :notify_without_statsd :notify
+    alias :notify :notify_with_statds
+
+    def notify_or_ignore_with_statsd(*args)
+      Airbrake::Statsd.increment
+      notify_or_ignore_without_statsd(*args)
+    end
+
+    alias :notify_or_ignore_without_statsd :notify_or_ignore
+    alias :notify_or_ignore :notify_or_ignore_with_statsd
+
+  end
+end

data/lib/airbrake-statsd/configuration.rb

@@ -0,0 +1,19 @@
+module Airbrake
+  module Statsd
+    class Configuration
+
+      attr_accessor :namespace
+
+      def host
+        @host ||= 'localhost'
+      end
+      attr_writer :host
+
+      def port
+        @port ||= 8125
+      end
+      attr_writer :port
+
+    end # Configuration
+  end # Statsd
+end # Airbrake

data/lib/airbrake-statsd/version.rb

@@ -0,0 +1,5 @@
+module Airbrake
+  module Statsd
+    VERSION = '0.1.0'
+  end
+end

data/lib/airbrake-statsd.rb

@@ -0,0 +1,40 @@
+require 'airbrake'
+require 'statsd'
+
+require 'airbrake-statsd/version'
+require 'airbrake-statsd/configuration'
+require 'airbrake-statsd/airbrake_ext'
+
+module Airbrake
+  module Statsd
+    class << self
+
+      def configure(&block)
+        @configured = true
+        block.call(config) if block_given?
+      end
+
+      def configured?
+        !!@configured
+      end
+
+      def config
+        @config ||= Configuration.new
+      end
+
+      def client
+        @client ||= begin
+          client = ::Statsd.new(config.host, config.port)
+          client.namespace = config.namespace if config.namespace
+          client
+        end
+      end
+
+      def increment
+        return unless configured?
+        client.increment('exceptions')
+      end
+
+    end # << self
+  end # Statsd
+end # Airbrake

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'rspec/autorun'
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec'
+  add_filter 'vendor'
+end
+
+require 'airbrake-statsd'

data/spec/unit/airbrake-statsd/airbrake_ext_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Airbrake do
+
+  subject { Airbrake }
+
+  it '#notify is an alias to #notify_with_statsd' do
+    subject.method(:notify).should == subject.method(:notify_with_statds)
+  end
+
+  it '#notify_or_ignore is an alias to #notify_or_ignore_with_statsd' do
+    subject.method(:notify_or_ignore).
+      should == subject.method(:notify_or_ignore_with_statsd)
+  end
+
+  describe '#notify_without_statsd' do
+    it 'does not call Airbrake::Statsd.increment' do
+      Airbrake.stub(:send_notice).and_return(nil)
+
+      Airbrake.should_receive(:build_notice_for).with('oops', {})
+      Airbrake::Statsd.should_not_receive(:increment)
+
+      Airbrake.notify_without_statsd('oops', {})
+    end
+  end
+
+  describe '#notify' do
+    it 'calls Airbrake::Statsd.increment' do
+      Airbrake.stub(:send_notice).and_return(nil)
+
+      Airbrake.should_receive(:build_notice_for).with('oops', {})
+      Airbrake::Statsd.should_receive(:increment)
+
+      Airbrake.notify('oops', {})
+    end
+  end
+
+  describe '#notify_or_ignore_without_statsd' do
+    it 'does not call Airbrake::Statsd.increment' do
+      Airbrake.stub(:send_notice).and_return(nil)
+
+      Airbrake.should_receive(:build_notice_for).with('oops', {}).
+        and_return(mock('Notice', :ignore? => false))
+      Airbrake::Statsd.should_not_receive(:increment)
+
+      Airbrake.notify_or_ignore_without_statsd('oops', {})
+    end
+  end
+
+  describe '#notify_or_ignore' do
+    it 'calls Airbrake::Statsd.increment' do
+      Airbrake.stub(:send_notice).and_return(nil)
+
+      Airbrake.should_receive(:build_notice_for).with('oops', {}).
+        and_return(mock('Notice', :ignore? => false))
+      Airbrake::Statsd.should_receive(:increment)
+
+      Airbrake.notify_or_ignore('oops', {})
+    end
+  end
+
+end

data/spec/unit/airbrake-statsd/configuration_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Airbrake
+  module Statsd
+    describe Configuration do
+
+      describe '`host` option' do
+        it 'defaults to "localhost"' do
+          subject.host.should == 'localhost'
+        end
+
+        it 'can be set' do
+          subject.host = 'not-default.com'
+          subject.host.should == 'not-default.com'
+        end
+      end
+
+      describe '`port` option' do
+        it 'defaults to 8125' do
+          subject.port.should == 8125
+        end
+
+        it 'can be set' do
+          subject.port = 88125
+          subject.port.should == 88125
+        end
+      end
+
+      describe '`namespace` option' do
+        it 'defaults to "nil"' do
+          subject.namespace.should be_nil
+        end
+
+        it 'can be set' do
+          subject.namespace = 'my_awesome_app'
+          subject.namespace.should == 'my_awesome_app'
+        end
+      end
+
+    end
+  end
+end

data/spec/unit/airbrake-statsd_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+module Airbrake
+  describe Statsd do
+
+    subject { Statsd }
+
+    before do
+      subject.instance_variable_set('@configured', nil)
+      subject.instance_variable_set('@config', nil)
+      subject.instance_variable_set('@client', nil)
+    end
+
+    describe '#configured?' do
+      context 'when #configure has been called' do
+        it 'returns true' do
+          subject.configure
+          subject.configured?.should be_true
+        end
+      end # configure called
+
+      context 'when #configure has not been called' do
+        it 'returns false' do
+          subject.configured?.should be_false
+        end
+      end # configure not called
+    end # configured?
+
+    describe '#config' do
+      it 'creates new Configuration instance if not set' do
+        subject.config.should be_a(Statsd::Configuration)
+      end
+    end
+
+    describe '#client' do
+      it 'creates a new ::Statsd client instance if not set' do
+        subject.config.should_receive(:host).once.and_return('testhost')
+        subject.config.should_receive(:port).once.and_return(1234)
+        ::Statsd.should_receive(:new).with('testhost', 1234)
+        subject.client
+      end
+
+      context 'when a namespace is set in #config instance' do
+        before do
+          subject.configure { |config| config.namespace = 'test' }
+        end
+
+        it 'sets namespace on client' do
+          ::Statsd.any_instance.should_receive(:namespace=).with('test').once
+          subject.client
+        end
+      end
+    end
+
+    describe '#increment' do
+      context 'when #configure has been called' do
+        before { subject.configure }
+
+        it 'calls #increment on #client instance' do
+          subject.client.should_receive(:increment).once
+          subject.increment
+        end
+
+        it 'default bucket name used is "exceptions"' do
+          subject.client.should_receive(:increment).with('exceptions').once
+          subject.increment
+        end
+      end # configure called
+    end # increment
+
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: airbrake-statsd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jim Myhrberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70264029721400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70264029721400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70264029719960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70264029719960
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70264029719260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70264029719260
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: &70264029718620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70264029718620
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  requirement: &70264029717780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70264029717780
+description: Increment an exception counter in StatsD whenever the Airbrake gem reports
+  and exception.
+email:
+- contact@jimeh.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- airbrake-statsd.gemspec
+- lib/airbrake-statsd.rb
+- lib/airbrake-statsd/airbrake_ext.rb
+- lib/airbrake-statsd/configuration.rb
+- lib/airbrake-statsd/version.rb
+- spec/spec_helper.rb
+- spec/unit/airbrake-statsd/airbrake_ext_spec.rb
+- spec/unit/airbrake-statsd/configuration_spec.rb
+- spec/unit/airbrake-statsd_spec.rb
+homepage: http://github.com/jimeh/airbrake-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: 2958165307938427188
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2958165307938427188
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Increment an exception counter in StatsD whenever the Airbrake gem reports
+  and exception.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/airbrake-statsd/airbrake_ext_spec.rb
+- spec/unit/airbrake-statsd/configuration_spec.rb
+- spec/unit/airbrake-statsd_spec.rb