errorkit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b3a8d7d3ae4c413ca53a1f7d0463e80ddae34db
+  data.tar.gz: e55ce216c6f4d957e29883a3fde546fa52bd22cf
+SHA512:
+  metadata.gz: db9a77577712658b5af7d04aa64bca059343191d465deecad12a3b017c223cf1c8760daf8cd2fb1d770ab57693a55170d223c72fdeabd8a9414590fc9e26ab6a
+  data.tar.gz: 417b54060cd71254cd200e5b01729e34ea260780b056352886f99cafb9e95045a128b9809f37e42515fdd28936c6396391e06b6e2906cb70de74bf7cbb7e4a54

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeff Rafter
+
+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,133 @@
+# Errorkit
+
+ErrorKit allows you to track errors within your application and generate a
+notification when they happen.
+
+ErrorKit is based on exception_notification and takes a similar approach. It allows
+you to install Rack middleware that catches exceptions and allows you to notify a
+list of recipients.
+
+ErrorKit also allows you to record the errors to your database and resolve them
+as necessary. This allows error handling to become an application concern and expects
+that you will attach application specific information to the errors when possible
+(such as the user that performed the action or the priority level of the error).
+
+ErrorKit provides a generator to build the default Error model.
+
+You can ignore specific exception classes and specific user agents. Additionally,
+ErrorKit can throttle error notifications to prevent overwhelming your inbox.
+
+Finally, ErrorKit keeps track of how many successful responses are made as well
+so that it can track your error rate per server and per release.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'errorkit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install errorkit
+
+## Usage
+
+Once you have installed the gem, you need to run the generator:
+
+    $ rails g errorkit:install
+
+After you run the generator you need to migrate the database:
+
+    $ rails db:migrate
+
+You can override the default configuration in config/initializers/errorkit.rb.
+
+## Custom Views
+
+From this point you can customize most things. Errorkit handles errors
+that occur within your application and displays a corresponding template.
+By default, it uses app/views/errors/error.html.erb which you should
+customize. If you want to have specific templates for specific pages
+you can create them by name:
+
+    bad_request.html.erb
+    forbidden.html.erb
+    internal_server_error.html.erb
+    method_not_allowed.html.erb
+    not_acceptable.html.erb
+    not_found.html.erb
+    not_implemented.html.erb
+    unauthorized.html.erb
+    unprocessable_entity.html.erb
+
+You can extend this list of defaults as well. See
+http://guides.rubyonrails.org/layouts_and_rendering.html for more information.
+
+It is also possible to customize the notification template found at
+app/views/errors/notification.html.erb.
+
+## Custom Errors Controller
+
+You can override the errors_controller by creating a new one in your application:
+
+    class MyController < Errorkit::ErrorsController
+    end
+
+You can even make this descend from your own application controller (though
+this may generate additional errors if there is a problem in your controller)
+
+    class MyController < ApplicationController
+      def show
+        # You must implement show
+      end
+    end
+
+Once created, you must tell Errorkit to use this controller in the initializer:
+
+    config.errors_controller = MyController
+
+## Custom Errors Mailer
+
+You can override the errors_mailer by creating a new one in your application:
+
+    class MyMailer < Errorkit::ErrorsMailer
+    end
+
+You can descend from ActionMailer::Base if you want to completely override the
+behavior. However you must implement error_notification:
+
+    class MyMailer < ActionMailer::Base
+      def error_notification(error_id)
+        # You must implement error_notification
+      end
+    end
+
+Once created, you must tell Errorkit to use this mailer in the initializer:
+
+    config.errors_mailer = MyMailer
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Acknowledgements
+
+http://geekmonkey.org/articles/29-exception-applications-in-rails-3-2
+https://github.com/sheerun/rails4-bootstrap/issues/26
+https://github.com/sheerun/rails4-bootstrap/commit/5c2df5a108ad204bc407183b959bb355ff5ed53d
+http://stackoverflow.com/questions/15459143/how-to-rescue-from-actiondispatchparamsparserparseerror-in-rails-4
+https://github.com/mirego/gaffe
+https://github.com/mirego/gaffe/blob/master/lib/gaffe/errors.rb
+
+
+https://github.com/rails/rails/blob/f886fe2d8ccc900cde2629577e5c0be8c7d4c67f/actionpack/lib/action_dispatch/middleware/exception_wrapper.rb
+https://github.com/rails/rails/blob/c2cb83b1447fee6cee496acd0816c0117b68b687/guides/source/layouts_and_rendering.md
+http://stackoverflow.com/questions/15459143/how-to-rescue-from-actiondispatchparamsparserparseerror-in-rails-4

data/Rakefile

@@ -0,0 +1,60 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+gem_name = :errorkit
+
+RSpec::Core::RakeTask.new(spec: ["generator:cleanup", "generator:prepare", "generator:#{gem_name}"]) do |task|
+  task.pattern = "spec/**/*_spec.rb"
+  task.rspec_opts = "--color --drb"
+  task.verbose = true
+end
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(database: ["generator:cleanup", "generator:prepare", "generator:database", "generator:#{gem_name}"]) do |task|
+    task.pattern = "spec/**/*_spec.rb"
+    task.verbose = true
+  end
+end
+
+namespace :generator do
+  desc "Cleans up the sample app before running the generator"
+  task :cleanup do
+    FileUtils.rm_rf("spec/tmp/sample") if Dir.exist?("spec/tmp/sample") if ENV['SKIP_CLEANUP'].nil?
+  end
+
+  desc "Prepare the sample app before running the generator"
+  task :prepare do
+    next if Dir.exist?("spec/tmp/sample")
+
+    FileUtils.mkdir_p("spec/tmp")
+
+    system "cd spec/tmp && rails new sample"
+
+    # bundle
+    gem_root = File.expand_path(File.dirname(__FILE__))
+    system "echo \"gem 'rspec-rails'\" >> spec/tmp/sample/Gemfile"
+    system "echo \"gem '#{gem_name}', :path => '#{gem_root}'\" >> spec/tmp/sample/Gemfile"
+    system "cd spec/tmp/sample && bundle install"
+    system "cd spec/tmp/sample && rails g rspec:install"
+
+    # Make a thing
+    system "cd spec/tmp/sample && rails g scaffold thing name:string mood:string"
+  end
+
+  # This task is not used unless you need to test the generator with an alternate database
+  # such as mysql or postgres. By default the sample application utilize sqlite3
+  desc "Prepares the application with an alternate database"
+  task :database do
+    puts "==  Configuring the database =================================================="
+    system "cp config/database.yml.example spec/tmp/sample/config/database.yml"
+    system "cd spec/tmp/sample && rake db:migrate:reset"
+  end
+
+  desc "Run the #{gem_name} generator"
+  task gem_name do
+    system "cd spec/tmp/sample && rails g #{gem_name}:install --force && rake db:migrate db:test:prepare"
+  end
+
+end
+
+task :default => :spec

data/config/database.yml.example

@@ -0,0 +1,19 @@
+# This file is not copied to or used by your Rails environment. The only time
+# these settings are used is when you have executed rake test:database while
+# running the tests for the gem (not from within Rails). This file makes
+# it easy to test alternate database drivers with the gem. The
+# default testing environment uses the rails default (sqlite3).
+
+development:
+  adapter: mysql
+  database: errorkit_development
+  username: root
+  password:
+  host: localhost
+
+test:
+  adapter: mysql
+  database: errorkit_test
+  username: root
+  password:
+  host: localhost

data/errorkit.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'errorkit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "errorkit"
+  spec.version       = Errorkit::VERSION
+  spec.authors       = ["Jeff Rafter"]
+  spec.email         = ["jeffrafter@gmail.com"]
+  spec.description   = %q{ErrorKit allows you to track errors within your application and generate a notification when they happen.}
+  spec.summary       = %q{ErrorKit allows you to track errors within your application and generate a notification when they happen.}
+  spec.homepage      = "http://github.com/jeffrafter/errorkit"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "factory_girl_rails"
+end

data/lib/errorkit/config.rb

@@ -0,0 +1,46 @@
+module Errorkit
+  class Config
+    attr_accessor \
+      :ignore_agents,
+      :ignore_exceptions,
+      :errors_class,
+      :errors_mailer,
+      :errors_controller,
+      :errors_layout,
+      :mailer_recipients,
+      :mailer_sender,
+      :max_notifications_per_minute,
+      :max_notifications_per_quarter_hour,
+      :alert_threshold
+
+
+    def initialize
+      @errors_mailer = Errorkit::ErrorsMailer
+      @errors_controller = Errorkit::ErrorsController
+      @errors_layout = false
+      @ignore_exceptions = []
+      @ignore_exceptions << ::ActiveRecord::RecordNotFound if defined? ::ActiveRecord::RecordNotFound
+      @ignore_exceptions << ::AbstractController::ActionNotFound if defined? ::AbstractController::ActionNotFound
+      @ignore_exceptions << ::ActionController::RoutingError if defined? ::ActionController::RoutingError
+      @ignore_agents = %w{Googlebot MSNBot Baiduspider Bing Inktomi Yahoo AskJeeves FastCrawler InfoSeek Lycos YandexBot NewRelicPinger Pingdom}
+      @max_notifications_per_minute = 5
+      @max_notifications_per_quarter_hour = 10
+      @alert_threshold = 0.4
+    end
+
+    def config
+      self
+    end
+
+    def ignore_exception?(exception)
+      return false if @ignore_exceptions.nil? || @ignore_exceptions.length == 0
+      @ignore_exceptions.include?(exception.class)
+    end
+
+    def ignore_agent?(agent)
+      return false if @ignore_agents.nil? || @ignore_agents.length == 0
+      @ignore_agent_re ||= /(#{@ignore_agents.join('|')})/i
+      !!(agent =~ @ignore_agents_re)
+    end
+  end
+end

data/lib/errorkit/engine.rb

@@ -0,0 +1,7 @@
+require 'rails'
+
+module Errorkit
+  class Engine < Rails::Engine
+  end
+end
+

data/lib/errorkit/errors_controller.rb

@@ -0,0 +1,49 @@
+module Errorkit
+  class ErrorsController < ActionController::Base
+    before_filter :append_view_paths
+
+    helper_method :error, :exception, :status_code, :status_text
+
+    layout :error_layout
+
+    def show
+      begin
+        render "errors/#{rescue_response}", status: status_code
+      rescue ActionView::MissingTemplate
+        render "errors/show", status: status_code
+      end
+    end
+
+    protected
+
+    def error
+      @error ||= env['errorkit.error']
+    end
+
+    def exception
+      @exception ||= env['action_dispatch.exception']
+    end
+
+    def status_code
+      @status_code ||= ActionDispatch::ExceptionWrapper.new(env, exception).status_code
+    end
+
+    def status_text
+      Rack::Utils::HTTP_STATUS_CODES.fetch(status_code, "Internal Server Error")
+    end
+
+    def rescue_response
+      @rescue_response ||= ActionDispatch::ExceptionWrapper.rescue_responses[exception.class.name]
+    end
+
+    private
+
+    def append_view_paths
+      append_view_path Pathname.new(File.expand_path('../../../', __FILE__)).join('lib', 'generators', 'errorkit', 'templates', 'app', 'views')
+    end
+
+    def error_layout
+      Errorkit.config.errors_layout
+    end
+  end
+end

data/lib/errorkit/errors_mailer.rb

@@ -0,0 +1,43 @@
+require 'action_mailer'
+
+module Errorkit
+  class ErrorsMailer < ActionMailer::Base
+    before_filter :append_view_paths
+
+    helper_method :error
+
+    self.mailer_name = 'errors'
+
+    def error_notification(error_id)
+      @error = Error.find(error_id)
+
+      mail(:to => mailer_recipients,
+           :from => mailer_sender,
+           :subject => mailer_subject) do |format|
+        format.html { render "#{mailer_name}/error_notification" }
+      end
+    end
+
+    protected
+
+    def error
+      @error
+    end
+
+    def mailer_recipients
+      Errorkit.config.mailer_recipients
+    end
+
+    def mailer_sender
+      Errorkit.config.mailer_sender
+    end
+
+    def mailer_subject
+      "[#{error.environment || 'Error'}] #{error.exception}: #{error.message}"
+    end
+
+    def append_view_paths
+      append_view_path Pathname.new(File.expand_path('../../../', __FILE__)).join('lib', 'generators', 'errorkit', 'templates', 'app', 'views')
+    end
+  end
+end

data/lib/errorkit/ignorable_error.rb

@@ -0,0 +1,3 @@
+module Errorkit
+  class IgnorableError < RuntimeError; end
+end

data/lib/errorkit/version.rb

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

data/lib/errorkit.rb

@@ -0,0 +1,86 @@
+require "errorkit/version"
+require 'errorkit/config'
+require 'errorkit/ignorable_error'
+require 'errorkit/errors_controller'
+require 'errorkit/errors_mailer'
+
+module Errorkit
+  require 'errorkit/engine' if defined?(Rails)
+
+  def self.configure(&block)
+    config.instance_eval(&block)
+
+    if defined?(Rails)
+      Rails.application.config.exceptions_app = lambda do |env|
+        Errorkit.server_error(env)
+      end
+    end
+  end
+
+  def self.config
+    @config ||= Errorkit::Config.new
+  end
+
+  def self.server_error(env)
+    exception = env['action_dispatch.exception']
+    unless config.errors_class.nil? || config.ignore_exception?(exception) || config.ignore_agent?(env['HTTP_USER_AGENT'])
+      begin
+        request = ActionDispatch::Request.new(env)
+        error = config.errors_class.create(
+          server: server,
+          environment: environment,
+          version: application_version,
+          exception: exception.class.to_s,
+          message: exception.message,
+          backtrace: clean_backtrace(exception),
+          params: filtered_parameters(request).to_json,
+          session: filtered_session(request).to_json,
+          remote_ip: request.remote_ip.to_s,
+          controller: (env['action_controller.instance'].controller_name rescue nil),
+          action: (env['action_controller.instance'].action_name rescue nil))
+
+        env['errorkit.notified'] = send_notification(error)
+        env['errorkit.error'] = error
+      rescue Errorkit::IgnorableError
+        # noop
+      end
+    end
+    config.errors_controller.action(:show).call(env)
+  end
+
+  def self.environment
+    Rails.env.to_s if defined?(Rails)
+  end
+
+  def self.server
+    @server ||= `hostname`.chomp rescue nil
+  end
+
+  def self.application_version
+    @version ||= `cd #{Rails.root.to_s} && git rev-parse HEAD`.chomp rescue nil
+  end
+
+  def self.filtered_parameters(request)
+    request.filtered_parameters
+  end
+
+  def self.filtered_session(request)
+    session = request.session.dup
+    session.delete(:session_id)
+    session
+  end
+
+  def self.clean_backtrace(exception)
+    backtrace = Rails.backtrace_cleaner.send(:filter, exception.backtrace) if defined?(Rails) && Rails.respond_to?(:backtrace_cleaner)
+    backtrace ||= exception.backtrace
+    backtrace ||= []
+    backtrace.join("\n")
+  end
+
+  def self.send_notification(error)
+    return if config.mailer_recipients.blank? || config.mailer_sender.blank?
+
+    # TODO, throttle
+    config.errors_mailer.error_notification(error.id).deliver
+  end
+end

data/lib/generators/errorkit/USAGE

@@ -0,0 +1,19 @@
+Usage:
+  rails generate errorkit:install [options]
+
+Runtime options:
+  -f, [--force]    # Overwrite files that already exist
+  -p, [--pretend]  # Run but do not make any changes
+  -s, [--skip]     # Skip files that already exist
+  -q, [--quiet]    # Supress status output
+
+Description:
+    ErrorKit allows you to track errors within your application and generate a
+    notification when they happen.
+
+Example:
+    rails generate errorkit:install
+
+    This generator will create an error
+    model and corresponding migration. It will also install view templates
+    for the error notifier.

data/lib/generators/errorkit/install_generator.rb

@@ -0,0 +1,60 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Errorkit
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "An error system for your Rails app"
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def generate_errorkit
+      generate_migration("create_errors")
+
+      # Ensure the destination structure
+      empty_directory "config"
+      empty_directory "initializers"
+      empty_directory "app"
+      empty_directory "app/models"
+      empty_directory "app/views"
+      empty_directory "app/views/errors"
+      empty_directory "spec"
+      empty_directory "spec/models"
+      empty_directory "spec/mailers"
+      empty_directory "lib"
+
+      # Fill out some templates (for now, this is just straight copy)
+      template "config/initializers/errorkit.rb", "config/initializers/errorkit.rb"
+      template "app/models/error.rb", "app/models/error.rb"
+      template "spec/models/error_spec.rb", "spec/models/error_spec.rb"
+
+      # Don't treat these like templates
+      copy_file "app/views/errors/error_notification.html.erb", "app/views/errors/error_notification.html.erb"
+      copy_file "app/views/errors/show.html.erb", "app/views/errors/show.html.erb"
+
+      # RSpec needs to be in the development group to be used in generators
+      gem_group :test, :development do
+        gem "rspec-rails"
+        gem "shoulda-matchers"
+        gem 'factory_girl_rails'
+      end
+    end
+
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    protected
+
+    def generate_migration(filename)
+      if self.class.migration_exists?("db/migrate", "#{filename}")
+        say_status "skipped", "Migration #{filename}.rb already exists"
+      else
+        migration_template "db/migrate/#{filename}.rb", "db/migrate/#{filename}.rb"
+      end
+    end
+  end
+end

data/lib/generators/errorkit/templates/app/models/error.rb

@@ -0,0 +1,9 @@
+class Error < ActiveRecord::Base
+  scope :unresolved, -> { where("resolved_at IS NULL") }
+
+  def resolve!
+    return true if self.resolved_at.present?
+
+    self.update_attribute(:resolved_at, Time.now)
+  end
+end

data/lib/generators/errorkit/templates/app/views/errors/error_notification.html.erb

@@ -0,0 +1,7 @@
+There was an error:
+
+<%= error.exception %>
+
+<p>
+<%= error.message %>
+</p>

data/lib/generators/errorkit/templates/app/views/errors/show.html.erb

@@ -0,0 +1,13 @@
+<!doctype html>
+<!--[if IE 8]>         <html lang="en" class="ie ie8 lt-ie9"> <![endif]-->
+<!--[if IE 9]>         <html lang="en" class="ie ie9">        <![endif]-->
+<!--[if gt IE 9]><!--> <html lang="en">                       <!--<![endif]-->
+  <head>
+    <title><%= status_code %> Error</title>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
+  </head>
+  <body>
+    The server encountered an error: <%= status_code %> (<%= status_text %>)
+  </body>
+</html>

data/lib/generators/errorkit/templates/config/initializers/errorkit.rb

@@ -0,0 +1,84 @@
+# Configure Errorkit to display custom error pages and deliver error notifications.
+#
+# To view the errors in development you must change config/environments/development.rb:
+#
+#     config.consider_all_requests_local = false
+#
+Errorkit.configure do
+  # Many bots create errors spidering your site. You may want to ignore those. By
+  # default the following bots are ignored:
+  #
+  #    config.ignore_agents = %w{
+  #      Googlebot MSNBot Baiduspider Bing Inktomi Yahoo AskJeeves FastCrawler
+  #      InfoSeek Lycos YandexBot NewRelicPinger Pingdom
+  #    }
+  #
+  # If you do not want to ignore bots set the ignore_agents to an empty array
+  #
+  #    config,ignore_agents = []
+
+
+  # Some exceptions should be expected and you don't want to be notified when they
+  # occur. By default the following exceptions are ignored:
+  #
+  #    config.ignore_exceptions = [
+  #      ActiveRecord::RecordNotFound,
+  #      AbstractController::ActionNotFound,
+  #      ActionController::RoutingError
+  #    ]
+  #
+  # If you want to be notified of all errors set ignore_exceptions to an empty
+  # array:
+  #
+  #    config.ignore_exceptions = []
+
+  # The recipients you want to notify when there is an error. If you leave this
+  # blank then notifications will not be sent.
+  config.mailer_recipients = ["you@example.com"]
+
+  # The sender of the error notifications. If you leave this blank then
+  # notifications will not be sent.
+  config.mailer_sender = ["errors@example.com"]
+
+  # Overriding the default error pages allows you to customize their look
+  # and feel but still have them served through your application. You can
+  # override the view templates by creating new template within you
+  # app/views/errors folder. If you want to change the layout used when
+  # rendering the views, set:
+  #
+  #   config.errors_layout = 'application'
+  #
+  # By default, no layout is used (layout is false).
+
+  # By default, Errorkit sends notifications with its own mailer. To override
+  # this, set:
+  #
+  #    config.errors_mailer = MyMailer
+
+  # By default, Errorkit responds to errors with its own controller. To override
+  # this, set:
+  #
+  #    config.errors_controller = MyController
+
+
+  # To persist errors, you must specify a class that acts like an ActiveRecord
+  # model. If errors_class is not set, errors will not be persisted.
+  config.errors_class = Error
+
+  # Getting hundreds or thousands of error notifications is not fun. You
+  # can set a max number of notifiactions per minute and per fifteen
+  # minutes:
+  #
+  #    config.max_notifications_per_minute = 5
+  #    config.max_notifications_per_quarter_hour = 10
+  #
+  # To turn off throttling set these values to nil
+
+
+  # It is possible to create alerts that occur only when the number of
+  # errors per request exceeds a specific percentage.
+  #
+  #    config.alert_threshold = 0.4
+  #
+  # To turn off error rate alerts, set this to nil
+end

data/lib/generators/errorkit/templates/db/migrate/create_errors.rb

@@ -0,0 +1,38 @@
+# Generated by Errorkit.
+#
+# Create an errors table for managing errors.
+class CreateErrors < ActiveRecord::Migration
+  def self.up
+    create_table :errors do |t|
+      t.string :environment
+      t.string :server
+      t.string :version
+      t.string :exception
+      t.string :message
+      t.text   :backtrace
+      t.string :controller
+      t.string :action
+      t.string :remote_ip
+      t.text :session
+      t.text :params
+      t.string :worker
+      t.string :queue
+      t.string :payload
+      t.string :url
+      t.integer :user_id
+      t.integer :subject_id
+      t.string :subject_type
+      t.datetime :resolved_at
+
+      t.timestamps
+    end
+
+    add_index :errors, :exception
+    add_index :errors, :created_at
+    add_index :errors, :resolved_at
+  end
+
+  def self.down
+    drop_table :errors
+  end
+end

data/lib/generators/errorkit/templates/spec/models/error_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Error do
+  let(:error) { Error.new }
+
+  it "resolves errors" do
+    now = Time.now
+    Time.stub(:now).and_return(now)
+    error.should_receive(:update_attribute).with(:resolved_at, now)
+    error.resolve!
+  end
+
+  it "does not resolve already resolved errors" do
+    error.should_not_receive(:update_attribute)
+    error.resolved_at = Time.now
+    error.resolve!
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path('../tmp/sample/config/environment', __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+  # Because we are not running things in Rails we need to stub some secrets
+  config.before(:each) { Rails.application.config.stub(:secret_token).and_return("SECRET") }
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: errorkit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeff Rafter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ErrorKit allows you to track errors within your application and generate
+  a notification when they happen.
+email:
+- jeffrafter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/database.yml.example
+- errorkit.gemspec
+- lib/errorkit.rb
+- lib/errorkit/config.rb
+- lib/errorkit/engine.rb
+- lib/errorkit/errors_controller.rb
+- lib/errorkit/errors_mailer.rb
+- lib/errorkit/ignorable_error.rb
+- lib/errorkit/version.rb
+- lib/generators/errorkit/USAGE
+- lib/generators/errorkit/install_generator.rb
+- lib/generators/errorkit/templates/app/models/error.rb
+- lib/generators/errorkit/templates/app/views/errors/error_notification.html.erb
+- lib/generators/errorkit/templates/app/views/errors/show.html.erb
+- lib/generators/errorkit/templates/config/initializers/errorkit.rb
+- lib/generators/errorkit/templates/db/migrate/create_errors.rb
+- lib/generators/errorkit/templates/spec/models/error_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jeffrafter/errorkit
+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: ErrorKit allows you to track errors within your application and generate
+  a notification when they happen.
+test_files:
+- spec/spec_helper.rb