smoke_detector 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Zjc5NmRhZDU4Nzg0NDc1NDYxMTYyZTk2Yzg0MzRmZDI5ODEyMGNhYQ==
+  data.tar.gz: !binary |-
+    ZDdiNTU0OTM1YTYzZDQ0NDlhYmE0ZTNhZWVlMjk3ZWIxNDdkY2MyZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODQzZDBjNmUwMzc2ZmQ3YThlNDY0ODk4NTZmYjJjOWYwNWYwMDNiOTZkOWI1
+    MWY4ZjZkNmJhN2I4MjEwOWY3ZTExMTc4YTBhMGZmMTNmY2E2ZTI4ZWI0MTJm
+    NDk4NjkwOTRlMWQwODcxNTg0MzY3MjdiNGQ4NzgxN2U3NjdmYTk=
+  data.tar.gz: !binary |-
+    NmExZTJkNzVhMWQ5ODMwMjUzYjcxMzgzMWJmNmI0Mzc2NzNkM2UxYzZjZTky
+    NjJhOTFhOWM4Yzg0Y2YzNmI1N2M1MjM5YjIxNTA0N2M3NmRiZDZiNWNlMjdi
+    NGY4M2I4N2MwODIwYjYyYWJlNTc4ZDBjMmYwZTgzY2Q1YmVlYzg=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,50 @@
+[![Build Status](https://travis-ci.org/lumoslabs/smoke_detector.png)](https://travis-ci.org/lumoslabs/smoke_detector)
+
+Smoke Detector
+=============
+
+Error Reporting Gem
+
+
+Installation
+-------------
+
+Add the following to your `Gemfile`:
+```
+gem 'smoke_detector'
+```
+This assumes you're using Lumos Labs' gemfury account.
+
+Then add the provider's gem to your gemfile. Smoke Detector currently supports Rollbar and Airbrake. For example,
+```
+gem 'airbrake'
+gem 'rollbar'
+```
+
+Finally, create an initializer file `config/initializers/smoke_detector.rb`:
+```
+module SmokeDetector
+
+  class Engine < Rails::Engine
+
+    config.providers = [
+      {provider: :airbrake,
+        api_key: ENV['AIRBRAKE_KEY']
+      },
+      {provider: :rollbar,
+        api_key: ENV['ROLLBAR_KEY']
+      }
+    ]
+
+  end
+end
+```
+Note: Only a subset of configuration parameters are currently available.
+
+
+TODO
+----
+
+1. Add support for JS reporting snippets
+2. Add support for all configuration settings
+3. Only allow one provider at a time similar to fog's config (necessary for gem publication)

data/Rakefile

@@ -0,0 +1,30 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Fubar'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/smoke_detector.rb

@@ -0,0 +1,37 @@
+require 'smoke_detector/exceptions'
+require 'smoke_detector/providers'
+require 'smoke_detector/controller_methods'
+require 'smoke_detector/engine'
+
+module SmokeDetector
+
+  # Reports an exception through SmokeDetector. Returns nil.
+  #
+  # @example
+  #   begin
+  #     foo = bar
+  #   rescue => e
+  #     SmokeDetector.alert(e)
+  #   end
+  #
+  # @param exception [Exception] The exception object to report
+  # @option options [Hash] :data Additional data to include alongside the exception
+  def self.alert(exception, options = {})
+    self.providers.each {|provider| provider.alert(exception, options) }
+    nil
+  end
+
+  # Records a message through SmokeDetector. Returns nil.
+  #
+  # @example
+  #   SmokeDetector.message('Look out!')
+  #
+  # @param message [String] The message to be recorded
+  # @option options [Hash] Additional data to include alongside the message
+  # @option options [Hash] :level The level at which to report the message
+  def self.message(message, options = {})
+    self.providers.each {|provider| provider.message(message, options) }
+    nil
+  end
+
+end

data/lib/smoke_detector/controller_methods.rb

@@ -0,0 +1,11 @@
+module SmokeDetector
+  module ControllerMethods
+
+    def self.included(base)
+      SmokeDetector.providers.each do |provider|
+        base.send(:include, provider.class::ControllerMethods)
+      end
+    end
+
+  end
+end

data/lib/smoke_detector/engine.rb

@@ -0,0 +1,16 @@
+module SmokeDetector
+  class Engine < ::Rails::Engine
+
+    config.providers = nil
+
+    initializer 'smoke_detector.init_error_handler' do
+      config.providers.each do |provider|
+        SmokeDetector.register_provider provider[:provider], provider[:api_key], provider[:settings] || {}
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        include SmokeDetector::ControllerMethods
+      end
+    end
+  end
+end

data/lib/smoke_detector/exceptions.rb

@@ -0,0 +1,3 @@
+module SmokeDetector
+  class ProviderRegistrationError < StandardError; end
+end

data/lib/smoke_detector/providers.rb

@@ -0,0 +1,37 @@
+require 'active_support/inflector'
+
+module SmokeDetector
+  PROVIDERS = [
+    :airbrake,
+    :rollbar
+  ]
+
+  def self.register_provider(provider_name, api_key, settings = {})
+    @providers ||= []
+    raise ProviderRegistrationError, 'Unsupported Provider' unless PROVIDERS.include?(provider_name)
+    raise ProviderRegistrationError, 'Provider is already registered' if registered_provider?(provider_name)
+    @providers << classify_provider(provider_name).new(api_key, settings)
+  end
+
+  def self.providers
+    @providers || []
+  end
+
+  def self.registered_provider?(provider_name)
+    raise ProviderRegistrationError, 'Unsupported Provider' unless PROVIDERS.include?(provider_name)
+    klass = classify_provider(provider_name)
+    !!SmokeDetector.providers.detect { |provider| provider.is_a?(klass) }
+  end
+
+  private
+
+  def self.classify_provider(provider_name)
+    raise ProviderRegistrationError, 'Unsupported Provider' unless PROVIDERS.include?(provider_name)
+    ::ActiveSupport::Inflector.constantize("SmokeDetector::Providers::#{provider_name.capitalize}")
+  end
+end
+
+require 'smoke_detector/providers/provider'
+SmokeDetector::PROVIDERS.each do |provider|
+  require "smoke_detector/providers/#{provider}"
+end

data/lib/smoke_detector/providers/airbrake.rb

@@ -0,0 +1,30 @@
+module SmokeDetector::Providers
+  class Airbrake < Provider
+
+    def initialize(api_key, settings = {})
+      ::Airbrake.configure do |c|
+        c.api_key = api_key
+        c.development_environments = settings[:development_environments] if settings[:development_environments]
+      end
+    end
+
+    def alert(exception, options = {})
+      options.delete(:controller)
+      message(exception, options)
+    end
+
+    def message(message, options = {})
+      args = [message]
+      args << {parameters: options[:data]} if options[:data].present?
+      ::Airbrake.notify(*args)
+    end
+
+    module ControllerMethods
+      def alert_smoke_detector(exception, options = {})
+        super if defined?(super)
+
+        notify_airbrake(exception)
+      end
+    end
+  end
+end

data/lib/smoke_detector/providers/provider.rb

@@ -0,0 +1,15 @@
+module SmokeDetector::Providers
+
+  class Provider
+    attr_accessor :controller_proc
+
+    def alert(exception, options = {})
+      raise NotImplementedError
+    end
+
+    def message(message, options = {})
+      raise NotImplementedError
+    end
+  end
+
+end

data/lib/smoke_detector/providers/rollbar.rb

@@ -0,0 +1,41 @@
+module SmokeDetector::Providers
+
+  class Rollbar < Provider
+
+    def initialize(api_key, settings = {})
+      ::Rollbar.configure do |c|
+        c.access_token = api_key
+        c.person_username_method = settings[:person_username_method] if settings[:person_username_method].present?
+        c.person_email_method = settings[:person_email_method] if settings[:person_email_method].present?
+        c.project_gems = settings[:project_gems] if settings[:project_gems]
+        c.use_async = !!settings[:use_async]
+      end
+    end
+
+
+    def alert(exception, options = {})
+      if data = options.delete(:data)
+        exception.message << data.to_s
+      end
+
+      ::Rollbar.report_exception(exception)
+    end
+
+    def message(message, options = {})
+      level = options.delete(:level) || 'info'
+      ::Rollbar.report_message(message, level, options)
+    end
+
+    module ControllerMethods
+      def alert_smoke_detector(exception, options = {})
+        super if defined?(super)
+
+        if data = options.delete(:data)
+          exception.message << data.to_s
+        end
+
+        ::Rollbar.report_exception(exception, rollbar_request_data, rollbar_person_data)
+      end
+    end
+  end
+end

data/lib/smoke_detector/version.rb

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

data/lib/tasks/smoke_detector_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :smoke_detector do
+#   # Task goes here
+# end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.