RubyGems - smoke_detector - Versions diffs - 0.0.1 - Mend

smoke_detector 0.0.1

Files changed (72) hide show

checksums.yaml +15 -0
data/MIT-LICENSE +20 -0
data/README.md +50 -0
data/Rakefile +30 -0
data/lib/smoke_detector.rb +37 -0
data/lib/smoke_detector/controller_methods.rb +11 -0
data/lib/smoke_detector/engine.rb +16 -0
data/lib/smoke_detector/exceptions.rb +3 -0
data/lib/smoke_detector/providers.rb +37 -0
data/lib/smoke_detector/providers/airbrake.rb +30 -0
data/lib/smoke_detector/providers/provider.rb +15 -0
data/lib/smoke_detector/providers/rollbar.rb +41 -0
data/lib/smoke_detector/version.rb +3 -0
data/lib/tasks/smoke_detector_tasks.rake +4 -0
data/spec/dummy/README.rdoc +261 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/assets/javascripts/application.js +15 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/controllers/widgets_controller.rb +26 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/models/widget.rb +13 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/app/views/widgets/index.html.erb +1 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +69 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +67 -0
data/spec/dummy/config/environments/test.rb +37 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/watch_tower.rb +24 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +6 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/schema.rb +16 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/development.log +8618 -0
data/spec/dummy/log/test.log +11306 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +25 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/dummy/tmp/cache/assets/C5F/270/sprockets%2F32a6d17723de2976b8456753922862fc +0 -0
data/spec/dummy/tmp/cache/assets/CA3/870/sprockets%2F703bc6444d2a153516ad9804dc24b467 +0 -0
data/spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
data/spec/dummy/tmp/cache/assets/D2F/510/sprockets%2F42e50ab0277768533b1cad2237fb5ade +0 -0
data/spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
data/spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
data/spec/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
data/spec/dummy/tmp/cache/assets/DAE/CC0/sprockets%2Fcf340221edaaed61b5821abd28052dbb +0 -0
data/spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
data/spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
data/spec/models/providers/airbrake_spec.rb +63 -0
data/spec/models/providers/provider_spec.rb +22 -0
data/spec/models/providers/rollbar_spec.rb +75 -0
data/spec/models/providers_spec.rb +83 -0
data/spec/models/smoke_detector_spec.rb +35 -0
data/spec/requests/aibrake_config_spec.rb +11 -0
data/spec/requests/multi_provider_config_spec.rb +16 -0
data/spec/requests/rollbar_config_spec.rb +13 -0
data/spec/spec_helper.rb +26 -0
data/spec/support/shared_examples_for_providers.rb +63 -0
metadata +326 -0

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED

File without changes

data/spec/dummy/script/rails ADDED

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/dummy/tmp/cache/assets/C5F/270/sprockets%2F32a6d17723de2976b8456753922862fc ADDED

Binary file

data/spec/dummy/tmp/cache/assets/CA3/870/sprockets%2F703bc6444d2a153516ad9804dc24b467 ADDED

Binary file

data/spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 ADDED

Binary file

data/spec/dummy/tmp/cache/assets/D2F/510/sprockets%2F42e50ab0277768533b1cad2237fb5ade ADDED

Binary file

data/spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 ADDED

Binary file

data/spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 ADDED

Binary file

data/spec/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 ADDED

Binary file

data/spec/dummy/tmp/cache/assets/DAE/CC0/sprockets%2Fcf340221edaaed61b5821abd28052dbb ADDED

Binary file

data/spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 ADDED

Binary file

data/spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af ADDED

Binary file

data/spec/models/providers/airbrake_spec.rb ADDED

@@ -0,0 +1,63 @@
+require 'spec_helper'
+describe SmokeDetector::Providers::Airbrake do
+  let(:provider) { SmokeDetector::Providers::Airbrake.new('api_key', settings) }
+  let(:settings) { {} }
+  let(:err) { mock('error', backtrace: [], message: 'bad news') }
+  let(:data) { {custom: :data} }
+  describe '#alert' do
+    it 'notifies Airbrake of the exception' do
+      Airbrake.should_receive(:notify).with(err)
+      provider.alert(err)
+    end
+    context 'when passed a controller option' do
+      it 'ignores the option' do
+        Airbrake.should_receive(:notify).with(err)
+        provider.alert(err, controller: mock('controller'))
+      end
+    end
+    context 'when passed a data option' do
+      it 'includes the data in the Airbrake parameters' do
+        Airbrake.should_receive(:notify).with(err, parameters: data)
+        provider.alert(err, data: data)
+      end
+    end
+  end
+  describe '#message' do
+    let(:message) { 'hello airbrake' }
+    it 'notifies Airbrake of the message' do
+      Airbrake.should_receive(:notify).with(message)
+      provider.message(message)
+    end
+    context 'when passed options' do
+      it 'includes the options in the Airbrake parameters' do
+        Airbrake.should_receive(:notify).with(message, parameters: data)
+        provider.message(message, data: data)
+      end
+    end
+  end
+  describe 'ControllerMethods' do
+    let(:controller) do
+      ActionController::Base.new.tap do |c|
+        c.class.send(:include, SmokeDetector::Providers::Airbrake::ControllerMethods)
+        c.stub(:rollbar_request_data)
+        c.stub(:rollbar_person_data)
+      end
+    end
+    describe '#alert_smoke_detector' do
+      it 'notifies Airbrake of the exception' do
+        controller.should_receive(:notify_airbrake)
+        controller.alert_smoke_detector(err)
+      end
+    end
+  end
+end

data/spec/models/providers/provider_spec.rb ADDED

@@ -0,0 +1,22 @@
+require 'spec_helper'
+describe SmokeDetector::Providers::Provider do
+  let(:provider) { SmokeDetector::Providers::Provider.new }
+  describe '#alert' do
+    subject { provider.alert(Exception.new) }
+    it 'raises an error' do
+      expect { subject }.to raise_error NotImplementedError
+    end
+  end
+  describe '#message' do
+    subject { provider.message(Exception.new) }
+    it 'raises an error' do
+      expect { subject }.to raise_error NotImplementedError
+    end
+  end
+end

data/spec/models/providers/rollbar_spec.rb ADDED

@@ -0,0 +1,75 @@
+require 'spec_helper'
+describe SmokeDetector::Providers::Rollbar do
+  let(:provider) { SmokeDetector::Providers::Rollbar.new('api_key', settings) }
+  let(:settings) { {} }
+  let(:err) { StandardError.new('error') }
+  let(:data) { {custom: :data} }
+  describe '#alert' do
+    it 'reports the exception to Rollbar' do
+      Rollbar.should_receive(:report_exception).with(err)
+      provider.alert(err)
+    end
+    context 'when passed a data option' do
+      it 'includes the data in the exception message' do
+        err.message.should_receive(:<<).with(data.to_s)
+        provider.alert(err, data: data)
+      end
+    end
+  end
+  describe '#message' do
+    let(:message) { 'Hello Rollbar' }
+    let(:level) { 'info' }
+    let(:options) { {} }
+    it 'reports the message to Rollbar' do
+      Rollbar.should_receive(:report_message).with(message, level, options)
+      provider.message(message)
+    end
+    context 'when passed options' do
+      let(:options) { {custom: :data} }
+      it 'passes the options along as the data param' do
+        Rollbar.should_receive(:report_message).with(message, level, options)
+        provider.message(message, options)
+      end
+      context 'including the level' do
+        let(:level) { 'debug' }
+        let(:options) { {custom: :data, level: level} }
+        it 'sets the message level' do
+          Rollbar.should_receive(:report_message).with(message, level, options)
+          provider.message(message, options)
+        end
+        it 'does not include the level in the data param' do
+          Rollbar.should_receive(:report_message).with(message, level, options)
+          provider.message(message, options)
+        end
+      end
+    end
+  end
+  describe 'ControllerMethods' do
+    let(:controller) do
+      ActionController::Base.new.tap do |c|
+        c.class.send(:include, SmokeDetector::Providers::Rollbar::ControllerMethods)
+      end
+    end
+    describe '#alert_smoke_detector' do
+      it 'notifies Rollbar of the exception' do
+        Rollbar.should_receive(:report_exception)
+        controller.should_receive(:rollbar_request_data)
+        controller.should_receive(:rollbar_person_data)
+        controller.alert_smoke_detector(err)
+      end
+    end
+  end
+end

data/spec/models/providers_spec.rb ADDED

@@ -0,0 +1,83 @@
+require 'spec_helper'
+describe SmokeDetector do
+  let(:provider) { :rollbar }
+  let(:api_key) { 'some_key' }
+  let(:provider_class) { SmokeDetector::Providers::Rollbar }
+  describe '.register_provider' do
+    context 'with a supported provider' do
+      context 'that is unregistered' do
+        before do
+          SmokeDetector.stub(:registered_provider?).with(provider).and_return(false)
+        end
+        it 'adds the provider to the SmokeDetector providers' do
+          SmokeDetector.register_provider(provider, api_key)
+          SmokeDetector.providers.last.should be_a provider_class
+        end
+      end
+      context 'that is registered' do
+        before do
+          SmokeDetector.stub(:registered_provider?).with(provider).and_return(true)
+        end
+        it 'raises an error' do
+          expect { SmokeDetector.register_provider(provider, api_key) }.to raise_error SmokeDetector::ProviderRegistrationError
+        end
+      end
+    end
+    context 'with an unsupported provider' do
+      let(:provider) { :not_a_provider }
+      it 'raises an error' do
+        expect { SmokeDetector.register_provider(provider, api_key) }.to raise_error SmokeDetector::ProviderRegistrationError
+      end
+    end
+  end
+  describe '.registered_provider?' do
+    subject { SmokeDetector.registered_provider?(provider) }
+    context "with a supported provider" do
+      context 'that is registered' do
+        before do
+          SmokeDetector.register_provider(provider, api_key)
+        end
+        it { should == true }
+      end
+      context 'that is unregistered' do
+        it { should == false }
+      end
+    end
+    context "with an unsupported provider" do
+      let(:provider) { :not_a_provider }
+      it 'raises an error' do
+        expect { subject }.to raise_error SmokeDetector::ProviderRegistrationError
+      end
+    end
+  end
+  describe '.classify_provider' do
+    subject { SmokeDetector.classify_provider(provider) }
+    context "with a supported provider" do
+      it { should == provider_class }
+    end
+    context "with an unsupported provider" do
+      let(:provider) { :not_a_provider }
+      it 'raises an error' do
+        expect { subject }.to raise_error SmokeDetector::ProviderRegistrationError
+      end
+    end
+  end
+end

data/spec/models/smoke_detector_spec.rb ADDED

@@ -0,0 +1,35 @@
+require 'spec_helper'
+describe SmokeDetector do
+  describe '.alert' do
+    let(:err) { Exception.new }
+    before do
+      SmokeDetector.register_provider(:airbrake, 'key')
+      SmokeDetector.register_provider(:rollbar, 'key')
+      SmokeDetector.providers.size.should > 1
+    end
+    context 'given an exception' do
+      it 'notifies the provider of the exception' do
+        SmokeDetector.providers.each do |provider|
+          provider.should_receive(:alert).once.with(err, {})
+        end
+        SmokeDetector.alert(err)
+      end
+    end
+  end
+  describe '.message' do
+    context 'given a message' do
+      let(:message) { "holy crap!" }
+      it 'notifies the provider of the message' do
+        SmokeDetector.providers.each do |provider|
+          provider.should_receive(:message).once.with(message, {})
+        end
+        SmokeDetector.message(message)
+      end
+    end
+  end
+end

data/spec/requests/aibrake_config_spec.rb ADDED

@@ -0,0 +1,11 @@
+require 'spec_helper'
+describe 'Airbrake config: An exception' do
+  before do
+    SmokeDetector.instance_variable_set(:@providers, [])
+    SmokeDetector.register_provider(:airbrake, 'key')
+  end
+  it_behaves_like 'Airbrake integrated error handler'
+end

data/spec/requests/multi_provider_config_spec.rb ADDED

@@ -0,0 +1,16 @@
+require 'spec_helper'
+describe 'Multi-provider config: An exception' do
+  before do
+    SmokeDetector.instance_variable_set(:@providers, [])
+    SmokeDetector.register_provider(:rollbar, 'key')
+    SmokeDetector.register_provider(:airbrake, 'key')
+    SmokeDetector.providers.size.should == 2
+  end
+  it_behaves_like 'Rollbar integrated error handler'
+  it_behaves_like 'Airbrake integrated error handler'
+end

data/spec/requests/rollbar_config_spec.rb ADDED

@@ -0,0 +1,13 @@
+require 'spec_helper'
+describe 'Rollbar config: An exception' do
+  before do
+    SmokeDetector.instance_variable_set(:@providers, [])
+    SmokeDetector.register_provider(:rollbar, 'key')
+  end
+  it_behaves_like 'Rollbar integrated error handler'
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,26 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+Rails.backtrace_cleaner.remove_silencers!
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+  config.before(:each) do
+    SmokeDetector.instance_variable_set(:@providers, [])
+    # sandbox services
+    Airbrake.stub(:send_notice)
+    Rollbar.stub(:schedule_payload)
+  end
+end