airbadger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5f8337fbc0d35047075ac0ca52de375b9e8d3f7
+  data.tar.gz: 1e8bb7c714e5e74837e8b38243d8789762c503ea
+SHA512:
+  metadata.gz: 9c76835f923d0f1851571c7064c42e688f962c0ccd2c12b774007edb87c972b500a8c35f813ccc8f8b3420ad6989b961ec7ca0737328e93cc8289a9c42f1ec8d
+  data.tar.gz: 86c7370648a93fe141c9ebc0095b704b42a1447722664d79d3f9c1d0174d6c0254ff31135c9f052678071783832ebbb028e95a43cf5fc13b93e4dd8459e8867a

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/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Josh Jordan
+
+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,41 @@
+airbadger
+=========
+
+Report errors to multiple Airbrake-compatible APIs simultaneously. Useful for comparing services such as Airbrake, Honeybadger, Errbit, etc. side by side with the same data.
+
+Installation
+============
+
+Add this line to your application's Gemfile:
+
+    gem 'airbadger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install airbadger
+
+Usage
+=====
+
+TODO: Write usage instructions here
+
+Contributing to airbadger
+=========================
+
+* 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.
+
+Copyright
+=========
+
+Copyright (c) 2013 Josh Jordan. See LICENSE for further details.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+desc 'Open an irb session preloaded with Airbadger'
+task :console do
+  sh 'irb -rubygems -I lib -r airbadger.rb -I spec -r spec_helper.rb'
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/airbadger.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'airbadger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "airbadger"
+  spec.version       = Airbadger::VERSION
+  spec.authors       = ["Josh Jordan"]
+  spec.email         = ["josh.jordan@gmail.com"]
+  spec.description   = %q{To ease the transition when trying out a new error monitoring service, Airbadger can report errors to multiple Airbrake API-compatible endpoints, such as Errbit and Raygun. Honeybadger is also supported.}
+  spec.summary       = %q{Reports errors to multiple Airbrake-compatible endpoints}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'airbrake', '< 3.2'
+  spec.add_dependency 'honeybadger', '< 1.9'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

data/lib/airbadger.rb

@@ -0,0 +1,30 @@
+require 'airbadger/warning_suppression'
+require 'airbadger/airbrake_loader'
+require 'airbadger/configuration'
+
+require 'airbadger/version'
+
+module Airbadger
+  def self.configure(&block)
+    configuration.instance_eval(&block)
+    configuration.setup_proxy!
+  end
+
+  def self.method_missing(method_name, *args, &block)
+    if PROXIED_METHODS.include? method_name
+      configuration.loaded_endpoints.each do |endpoint|
+        endpoint.send(method_name, *args, &block)
+      end
+      return nil
+    end
+    super
+  end
+
+  private
+
+  PROXIED_METHODS = [:notify, :notify_or_ignore]
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/airbadger/airbrake_loader.rb

@@ -0,0 +1,40 @@
+class Airbadger::AirbrakeLoader
+  def self.load_as(airbrake_alias)
+    new(airbrake_alias).load_aliased
+  end
+
+  def load_aliased
+    without_recording_loaded_features { require 'airbrake' }
+    aliased_module.tap do |loaded_module|
+      preserve_namespaced_calls!
+      remove_airbrake_from_global_namespace!
+    end
+  end
+
+  private
+
+  attr_reader :endpoint_alias
+
+  def initialize(endpoint_alias)
+    @endpoint_alias = endpoint_alias.sub(/^Airbrake$/, 'AirbrakeProxied')
+  end
+
+  def aliased_module
+    @aliased_module ||= Object.const_set(endpoint_alias, Airbrake)
+  end
+
+  def preserve_namespaced_calls!
+    aliased_module.const_set('Airbrake', aliased_module)
+  end
+
+  def remove_airbrake_from_global_namespace!
+    Object.send(:remove_const, 'Airbrake')
+  end
+
+  def without_recording_loaded_features
+    feature_count = $LOADED_FEATURES.count
+    yield
+  ensure
+    $LOADED_FEATURES.pop while feature_count < $LOADED_FEATURES.count
+  end
+end

data/lib/airbadger/configuration.rb

@@ -0,0 +1,35 @@
+class Airbadger::Configuration
+  include Airbadger::WarningSuppression
+
+  def endpoint(service_name, &block)
+    load_endpoint(service_name).configure(&block)
+  end
+
+  def setup_proxy!
+    Object.const_set('Airbrake', Airbadger)
+  end
+
+  def loaded_endpoints
+    @loaded_modules ||= []
+  end
+
+  private
+
+  ENDPOINT_LOADERS = Hash.new(::Airbadger::AirbrakeLoader.method(:load_as)).merge({
+    'Honeybadger' => Proc.new do
+      require 'honeybadger'
+      Honeybadger
+    end
+  })
+
+  def load_endpoint(service_name)
+    service_name = ghetto_classify(service_name)
+    without_warnings do
+      ENDPOINT_LOADERS[service_name].call(service_name)
+    end.tap(&loaded_endpoints.method(:push))
+  end
+
+  def ghetto_classify(snake_cased)
+    snake_cased.to_s.split('_').collect{ |str| str[0] = str[0].upcase; str }.join
+  end
+end

data/lib/airbadger/version.rb

@@ -0,0 +1,3 @@
+module Airbadger
+  VERSION = "0.0.1"
+end

data/lib/airbadger/warning_suppression.rb

@@ -0,0 +1,9 @@
+module Airbadger::WarningSuppression
+  def without_warnings
+    #TODO: a better approach would be to log this to an Airbadger logger
+    old_verbose, $VERBOSE = $VERBOSE, nil
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+end

data/spec/airbadger_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Airbadger do
+  ['#notify', '#notify_or_ignore'].each do |proxied_method|
+    describe proxied_method do
+      it 'proxies calls to all configured modules' do
+        proxied_method.sub!('#', '')
+
+        Airbadger.configure do
+          endpoint :raygun do |config|
+            config.test_mode = true
+          end
+          endpoint :errbit do |config|
+            config.test_mode = true
+          end
+        end
+
+        error = Exception.new('Some serious shit went down')
+
+        Raygun.should_receive(proxied_method).with(error)
+        Errbit.should_receive(proxied_method).with(error)
+
+        Airbadger.send(proxied_method, error)
+      end
+    end
+  end
+
+  it 'proxies calls to Airbrake to all loaded modules' do
+    Airbadger.configure do
+      endpoint :raygun do |config|
+        config.test_mode = true
+      end
+      endpoint :airbrake do |config|
+        config.test_mode = true
+      end
+    end
+
+    error = Exception.new('Some serious shit went down')
+
+    Raygun.should_receive(:notify).with(error)
+    AirbrakeProxied.should_receive(:notify).with(error)
+
+    Airbrake.notify(error)
+  end
+
+  it 'proxies calls to Honeybadger' do
+    Airbadger.configure do 
+      endpoint :raygun do |config|
+        config.test_mode = true
+      end
+      endpoint :honeybadger do |config|
+        config.ignore_only = []
+      end
+    end
+
+    error = Exception.new('Some serious shit went down')
+
+    Raygun.should_receive(:notify).with(error)
+    Honeybadger.should_receive(:notify).with(error)
+
+    Airbadger.notify(error)
+  end
+end

data/spec/airbrake_loader_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Airbadger::AirbrakeLoader do
+  include Airbadger::WarningSuppression
+
+  describe '.load_as' do
+    it 'loads a new Airbrake singleton with the given name' do
+      without_warnings do
+        described_class.load_as('Errbit')
+        described_class.load_as('Raygun')
+      end
+
+      Errbit.should respond_to :notify
+      Raygun.should respond_to :notify
+      Errbit.should_not eq Raygun
+    end
+
+    it 'produces endpoints singletons capable of receiving error data' do
+      without_warnings do
+        described_class.load_as('Errbit')
+      end
+      Errbit.configure do |config|
+        config.test_mode = true
+      end
+
+      now = DateTime.now.to_s
+      Errbit.notify(Exception.new(now))
+
+      Errbit.sender.last_notice.should include(now)
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Airbadger::Configuration do
+  describe '#endpoint' do
+    it 'proxies the configuration block to a named Airbrake singleton' do
+      subject.endpoint :BasicAirbrake do |config|
+        config.test_mode = true
+      end
+
+      subject.endpoint :Errbit do |config|
+        config.test_mode = true
+        config.host = 'errbit.example.com'
+      end
+
+      BasicAirbrake.configuration.host.should eq 'api.airbrake.io'
+      Errbit.configuration.host.should eq 'errbit.example.com'
+    end
+
+    it 'accepts snake-cased service names and produces constants with proper class names' do
+      subject.endpoint :basic_airbrake do |config|
+        config.test_mode = true
+      end
+
+      defined?(BasicAirbrake).should be_true
+    end
+
+    it 'rewrites the name "Airbrake" to "AirbrakeProxied" to avoid collisions' do
+      subject.endpoint :airbrake do |config|
+        config.test_mode = true
+      end
+
+      defined?(Airbrake).should be_false
+      defined?(AirbrakeProxied).should be_true
+    end
+
+    it 'supports Honeybadger configuration from the Honeybadger gem rather than the Airbrake gem' do
+      Airbadger::AirbrakeLoader.should_receive(:load_as).never
+
+      subject.endpoint :honeybadger do |config|
+        config.ignore_only = []
+      end
+
+      defined?(Honeybadger).should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.require(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'airbadger'
+
+EXAMPLE_SERVICE_NAMES = [
+  'Airbrake',
+  'AirbrakeProxied',
+  'BasicAirbrake',
+  'Errbit',
+  'Raygun'
+]
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before :each do
+    EXAMPLE_SERVICE_NAMES.each do |service_name|
+      Object.send(:remove_const, service_name) if Object.const_defined?(service_name)
+    end
+  end
+
+  config.before :each do
+    Airbadger.instance_variable_set('@configuration', nil)
+  end
+end

data/spec/warning_suppression_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Airbadger::WarningSuppression do
+  include Airbadger::WarningSuppression
+
+  describe '#without_warnings' do
+    before :each do
+      @old_version = Airbadger::VERSION
+    end
+
+    let! :error_stream do
+      $stderr = StringIO.new
+    end
+    
+    it 'executes the block and does not emit warnings into the stderr stream' do
+      without_warnings do
+        Airbadger::VERSION = 42
+      end
+
+      Airbadger::VERSION.should eq 42
+      error_stream.string.should be_empty
+    end
+
+    it 'resumes emitting warnings into the stderr stream after the block' do
+      without_warnings do
+        Airbadger::VERSION = 42
+      end
+
+      Airbadger::VERSION = 43
+
+      error_stream.string.should_not be_empty
+    end
+
+    after :each do
+      Airbadger::VERSION = @old_version
+      $stderr = STDERR
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: airbadger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Jordan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: honeybadger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: To ease the transition when trying out a new error monitoring service,
+  Airbadger can report errors to multiple Airbrake API-compatible endpoints, such
+  as Errbit and Raygun. Honeybadger is also supported.
+email:
+- josh.jordan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- airbadger.gemspec
+- lib/airbadger.rb
+- lib/airbadger/airbrake_loader.rb
+- lib/airbadger/configuration.rb
+- lib/airbadger/version.rb
+- lib/airbadger/warning_suppression.rb
+- spec/airbadger_spec.rb
+- spec/airbrake_loader_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/warning_suppression_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Reports errors to multiple Airbrake-compatible endpoints
+test_files:
+- spec/airbadger_spec.rb
+- spec/airbrake_loader_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/warning_suppression_spec.rb