hoptoad_notifier 2.1.0

data/INSTALL

@@ -0,0 +1,25 @@
+=== Configuration
+
+You should have something like this in config/initializers/hoptoad.rb.
+
+  HoptoadNotifier.configure do |config|
+    config.api_key = '1234567890abcdef'
+  end
+
+(Please note that this configuration should be in a global configuration, and
+is *not* environment-specific. Hoptoad is smart enough to know what errors are
+caused by what environments, so your staging errors don't get mixed in with
+your production errors.)
+
+You can test that Hoptoad is working in your production environment by using 
+this rake task (from RAILS_ROOT):
+
+  rake hoptoad:test
+
+If everything is configured properly, that task will send a notice to Hoptoad 
+which will be visible immediately.
+
+NOTE FOR RAILS 1.2.* USERS:
+
+You will need to copy the hoptoad_notifier_tasks.rake file into your
+RAILS_ROOT/lib/tasks directory in order for the rake hoptoad:test task to work.

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2007, Tammer Saleh, Thoughtbot, Inc.
+
+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.rdoc

@@ -0,0 +1,221 @@
+= HoptoadNotifier
+
+This is the notifier gem for integrating apps with Hoptoad.
+
+When an uncaught exception occurs, HoptoadNotifier will POST the relevant data 
+to the Hoptoad server specified in your environment.
+
+== Help
+
+* {IRC}[irc://irc.freenode.net/thoughtbot]
+* {mailing list}[http://groups.google.com/group/hoptoad-notifier-dev]
+
+== Installation
+
+=== Remove exception_notifier
+
+in your ApplicationController, REMOVE this line:
+
+  include ExceptionNotifiable
+
+In your config/environment* files, remove all references to ExceptionNotifier
+
+Remove the vendor/plugins/exception_notifier directory.
+
+=== Rails 2.x
+
+Add the hoptoad_notifier gem to your app. In config/environment.rb:
+
+  config.gem 'hoptoad_notifier'
+
+Then from your project's RAILS_ROOT, run:
+
+  rake gems:install
+  script/generate hoptoad --api-key your_key_here
+
+=== Rails 1.2.6
+
+Install the hoptoad_notifier Gem, and then add something like this at the
+bottom of your config/environment.rb:
+
+  HoptoadNotifier.configure do |config|
+    config.api_key = 'your_key_here'
+  end
+
+You will need to copy the hoptoad_notifier_tasks.rake file into your
+RAILS_ROOT/lib/tasks directory in order for the rake hoptoad:test task to work.
+
+=== Testing it out
+
+You can test that Hoptoad is working in your production environment by using 
+this rake task (from RAILS_ROOT):
+
+  rake hoptoad:test
+
+If everything is configured properly, that task will send a notice to Hoptoad 
+which will be visible immediately.
+
+== Usage
+
+For the most part, Hoptoad works for itself.  Once you've included the notifier 
+in your ApplicationController (which is now done automatically by the gem), 
+all errors will be rescued by the #rescue_action_in_public provided by the gem.
+
+If you want to log arbitrary things which you've rescued yourself from a 
+controller, you can do something like this:
+
+  ...
+  rescue => ex
+    notify_hoptoad(ex)
+    flash[:failure] = 'Encryptions could not be rerouted, try again.'
+  end
+  ...
+
+The #notify_hoptoad call will send the notice over to Hoptoad for later
+analysis. While in your controllers you use the notify_hoptoad method, anywhere
+else in your code, use HoptoadNotifier.notify.
+
+To perform custom error processing after Hoptoad has been notified, define the
+instance method #rescue_action_in_public_without_hoptoad(exception) in your
+controller.
+
+== Tracking deployments in Hoptoad
+
+Paying Hoptoad plans support the ability to track deployments of your application in Hoptoad.
+By notifying Hoptoad of your application deployments, all errors are resolved when a deploy occurs,
+so that you'll be notified again about any errors that reoccur after a deployment.
+
+Additionally, it's possible to review the errors in Hoptoad that occurred before and after a deploy.
+
+When Hoptoad is installed as a gem, you need to add
+
+  require 'hoptoad_notifier/recipes/hoptoad'
+
+to your deploy.rb
+
+== Going beyond exceptions
+
+You can also pass a hash to notify_hoptoad method and store whatever you want,
+not just an exception. And you can also use it anywhere, not just in
+controllers:
+
+  begin
+    params = {
+      # params that you pass to a method that can throw an exception 
+    }
+    my_unpredicable_method(params)
+  rescue => e
+    HoptoadNotifier.notify(
+      :error_class   => "Special Error",
+      :error_message => "Special Error: #{e.message}",
+      :parameters    => params
+    )
+  end
+
+While in your controllers you use the notify_hoptoad method, anywhere else in
+your code, use HoptoadNotifier.notify. Hoptoad will get all the information
+about the error itself. As for a hash, these are the keys you should pass:
+
+* :error_class - Use this to group similar errors together. When Hoptoad catches an exception it sends the class name of that exception object.
+* :error_message - This is the title of the error you see in the errors list. For exceptions it is "#{exception.class.name}: #{exception.message}"
+* :parameters - While there are several ways to send additional data to Hoptoad, passing a Hash as :parameters as in the example above is the most common use case. When Hoptoad catches an exception in a controller, the actual HTTP client request parameters are sent using this key.
+
+Hoptoad merges the hash you pass with these default options:
+
+  {
+    :api_key       => HoptoadNotifier.api_key,
+    :error_message => 'Notification',
+    :backtrace     => caller,
+    :parameters    => {},
+    :session       => {}
+  }
+
+You can override any of those parameters.
+
+== Filtering
+
+You can specify a whitelist of errors, that Hoptoad will not report on.  Use 
+this feature when you are so apathetic to certain errors that you don't want 
+them even logged.
+
+This filter will only be applied to automatic notifications, not manual 
+notifications (when #notify is called directly).
+
+Hoptoad ignores the following exceptions by default:
+
+  ActiveRecord::RecordNotFound
+  ActionController::RoutingError
+  ActionController::InvalidAuthenticityToken
+  ActionController::UnknownAction
+  CGI::Session::CookieStore::TamperedWithCookie
+
+To ignore errors in addition to those, specify their names in your Hoptoad 
+configuration block.
+
+  HoptoadNotifier.configure do |config|
+    config.api_key      = '1234567890abcdef'
+    config.ignore       << ActiveRecord::IgnoreThisError
+  end
+
+To ignore *only* certain errors (and override the defaults), use the 
+#ignore_only attribute.
+
+  HoptoadNotifier.configure do |config|
+    config.api_key      = '1234567890abcdef'
+    config.ignore_only  = [ActiveRecord::IgnoreThisError]
+  end
+
+To ignore certain user agents, add in the #ignore_user_agent attribute as a
+string or regexp:
+
+  HoptoadNotifier.configure do |config|
+    config.api_key      = '1234567890abcdef'
+    config.ignore_user_agent  << /Ignored/
+    config.ignore_user_agent << 'IgnoredUserAgent'
+  end
+
+To ignore exceptions based on other conditions, use #ignore_by_filter:
+
+  HoptoadNotifier.configure do |config|
+    config.api_key      = '1234567890abcdef'
+    config.ignore_by_filter do |exception_data|
+      true if exception_data[:error_class] == "RuntimeError"
+    end
+  end
+
+To replace sensitive information sent to the Hoptoad service with [FILTERED] use #params_filters:
+
+  HoptoadNotifier.configure do |config|
+    config.api_key      = '1234567890abcdef'
+    config.params_filters << "credit_card_number"
+  end
+
+Note that, when rescuing exceptions within an ActionController method,
+hoptoad_notifier will reuse filters specified by #filter_params_logging.
+
+== Testing
+
+When you run your tests, you might notice that the Hoptoad service is recording
+notices generated using #notify when you don't expect it to.  You can 
+use code like this in your test_helper.rb to redefine that method so those 
+errors are not reported while running tests.
+
+  module HoptoadNotifier
+    def self.notify(thing)
+      # do nothing.
+    end
+  end
+
+== Supported Rails versions
+
+See SUPPORTED_RAILS_VERSIONS for a list of official supported versions of
+Rails.
+
+Please open up a support ticket on Tender ( http://help.hoptoadapp.com ) if
+you're using a version of Rails that is not listed above and the notifier is
+not working properly.
+
+== Thanks
+
+Thanks to Eugene Bolshakov for the excellent write-up on GOING BEYOND
+EXCEPTIONS, which we have included above.

data/Rakefile

@@ -0,0 +1,117 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'cucumber/rake/task'
+
+desc 'Default: run unit tests.'
+task :default => [:test, :cucumber]
+
+desc 'Test the hoptoad_notifier gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Run ginger tests'
+task :ginger do
+  $LOAD_PATH << File.join(*%w[vendor ginger lib])
+  ARGV.clear
+  ARGV << 'test'
+  load File.join(*%w[vendor ginger bin ginger])
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb', 'TESTING.rdoc']
+  end
+rescue LoadError
+end
+
+GEM_ROOT     = File.dirname(__FILE__).freeze
+VERSION_FILE = File.join(GEM_ROOT, 'lib', 'hoptoad_notifier', 'version')
+
+require VERSION_FILE
+
+gemspec = Gem::Specification.new do |s|
+  s.name        = %q{hoptoad_notifier}
+  s.version     = HoptoadNotifier::VERSION
+  s.summary     = %q{Send your application errors to our hosted service and reclaim your inbox.}
+
+  s.files        = FileList['[A-Z]*', 'generators/**/*.*', 'lib/**/*.rb',
+                            'test/**/*.rb', 'rails/**/*.rb', 'tasks/**/*.rake']
+  s.require_path = 'lib'
+  s.test_files   = Dir[*['test/**/*_test.rb']]
+
+  s.has_rdoc         = true
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.rdoc_options = ['--line-numbers', "--main", "README.rdoc"]
+
+  s.authors = ["thoughtbot, inc"]
+  s.email   = %q{support@hoptoadapp.com}
+  s.homepage = "http://www.hoptoadapp.com"
+
+  s.platform = Gem::Platform::RUBY
+end
+
+Rake::GemPackageTask.new gemspec do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc, :clobber_package]
+
+desc "Generate a gemspec file"
+task :gemspec do
+  File.open("#{gemspec.name}.gemspec", 'w') do |f|
+    f.write gemspec.to_ruby
+  end
+end
+
+LOCAL_GEM_ROOT = File.join(GEM_ROOT, 'tmp', 'local_gems').freeze
+RAILS_VERSIONS = IO.read('SUPPORTED_RAILS_VERSIONS').strip.split("\n")
+LOCAL_GEMS = [['sham_rack', nil], ['capistrano', nil], ['sqlite3-ruby', nil]] +
+  RAILS_VERSIONS.collect { |version| ['rails', version] }
+
+task :vendor_test_gems do
+  LOCAL_GEMS.each do |gem_name, version|
+    gem_file_pattern = [gem_name, version || '*'].compact.join('-')
+    version_option = version ? "-v #{version}" : ''
+    pattern = File.join(LOCAL_GEM_ROOT, 'gems', "#{gem_file_pattern}")
+    existing = Dir.glob(pattern).first
+    unless existing
+      command = "gem install -i #{LOCAL_GEM_ROOT} --no-ri --no-rdoc #{version_option} #{gem_name}"
+      puts "Vendoring #{gem_file_pattern}..."
+      unless system(command)
+        $stderr.puts "Command failed: #{command}"
+      end
+    end
+  end
+end
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.fork = true
+  t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+end
+
+task :cucumber => [:gemspec, :vendor_test_gems]
+
+OLD_RAILS_VERSIONS = RAILS_VERSIONS[0...-1]
+
+namespace :cucumber do
+  namespace :rails do
+    OLD_RAILS_VERSIONS.each do |version|
+      desc "Test integration of the gem with Rails #{version}"
+      task version do
+        ENV['RAILS_VERSION'] = version
+        system("cucumber --format progress features/rails.feature")
+      end
+    end
+
+    desc "Test integration of the gem with all Rails versions"
+    task :all => [:cucumber, *OLD_RAILS_VERSIONS]
+  end
+end

data/SUPPORTED_RAILS_VERSIONS

@@ -0,0 +1,8 @@
+1.2.6
+2.0.2
+2.1.0
+2.1.2
+2.2.2
+2.3.2
+2.3.3
+2.3.4

data/TESTING.rdoc

@@ -0,0 +1,8 @@
+= For Maintainers:
+
+When developing the Hoptoad Notifier, be sure to use the integration test
+against an existing project on staging before pushing to master.
+
++./script/integration_test.rb <test project's api key> <staging server hostname>+
+
++./script/integration_test.rb <test project's api key> <staging server hostname> secure+

data/generators/hoptoad/hoptoad_generator.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+require File.expand_path(File.dirname(__FILE__) + "/lib/rake_commands.rb")
+
+class HoptoadGenerator < Rails::Generator::Base
+  def add_options!(opt)
+    opt.on('-k', '--api-key=key', String, "Your Hoptoad API key") {|v| options[:api_key] = v}
+  end
+
+  def manifest
+    if !api_key_configured? && !options[:api_key]
+      puts "Must pass --api-key or create config/initializers/hoptoad.rb"
+      exit
+    end
+    record do |m|
+      m.directory 'lib/tasks'
+      m.file 'hoptoad_notifier_tasks.rake', 'lib/tasks/hoptoad_notifier_tasks.rake'
+      if File.exists?('config/deploy.rb')
+        m.append_to 'config/deploy.rb', "require 'hoptoad_notifier/capistrano'"
+      end
+      if options[:api_key]
+        if use_initializer?
+          m.template 'initializer.rb', 'config/initializers/hoptoad.rb',
+            :assigns => {:api_key => options[:api_key]}
+        else
+          m.template 'initializer.rb', 'config/hoptoad.rb',
+            :assigns => {:api_key => options[:api_key]}
+          m.append_to 'config/environment.rb', "require 'config/hoptoad'"
+        end
+      end
+      m.rake "hoptoad:test", :generate_only => true
+    end
+  end
+
+  def use_initializer?
+    Rails::VERSION::MAJOR > 1
+  end
+
+  def api_key_configured?
+    File.exists?('config/initializers/hoptoad.rb') ||
+      system("grep HoptoadNotifier config/environment.rb")
+  end
+end

data/generators/hoptoad/lib/insert_commands.rb

@@ -0,0 +1,34 @@
+# Mostly pinched from http://github.com/ryanb/nifty-generators/tree/master
+
+Rails::Generator::Commands::Base.class_eval do
+  def file_contains?(relative_destination, line)
+    File.read(destination_path(relative_destination)).include?(line)
+  end
+end
+
+Rails::Generator::Commands::Create.class_eval do
+  def append_to(file, line)
+    logger.insert "#{line} appended to #{file}"
+    unless options[:pretend] || file_contains?(file, line)
+      File.open(file, "a") do |file|
+        file.puts
+        file.puts line
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def append_to(file, line)
+    logger.remove "#{line} removed from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n#{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def append_to(file, line)
+    logger.insert "#{line} appended to #{file}"
+  end
+end

data/generators/hoptoad/lib/rake_commands.rb

@@ -0,0 +1,24 @@
+Rails::Generator::Commands::Create.class_eval do
+  def rake(cmd, opts = {})
+    logger.rake "rake #{cmd}"
+    unless system("rake #{cmd}")
+      logger.rake "#{cmd} failed. Rolling back"      
+      command(:destroy).invoke!
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def rake(cmd, opts = {})
+    unless opts[:generate_only]
+      logger.rake "rake #{cmd}"
+      system "rake #{cmd}"
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def rake(cmd, opts = {})
+    logger.rake "rake #{cmd}"
+  end
+end

data/generators/hoptoad/templates/hoptoad_notifier_tasks.rake

@@ -0,0 +1,5 @@
+Dir[File.join(RAILS_ROOT, 'vendor', 'gems', 'hoptoad_notifier-*')].each do |vendored_notifier|
+  $: << File.join(vendored_notifier, 'lib')
+end
+
+require 'hoptoad_notifier/tasks'

data/generators/hoptoad/templates/initializer.rb

@@ -0,0 +1,6 @@
+<% if Rails::VERSION::MINOR < 2 -%>
+require 'hoptoad_notifier/rails'
+<% end -%>
+HoptoadNotifier.configure do |config|
+  config.api_key = '<%= api_key %>'
+end

data/lib/hoptoad_notifier/backtrace.rb

@@ -0,0 +1,99 @@
+module HoptoadNotifier
+  # Front end to parsing the backtrace for each notice
+  class Backtrace
+
+    # Handles backtrace parsing line by line
+    class Line
+
+      INPUT_FORMAT = %r{^([^:]+):(\d+)(?::in `([^']+)')?$}.freeze
+
+      # The file portion of the line (such as app/models/user.rb)
+      attr_reader :file
+
+      # The line number portion of the line
+      attr_reader :number
+
+      # The method of the line (such as index)
+      attr_reader :method
+
+      # Parses a single line of a given backtrace
+      # @param [String] unparsed_line The raw line from +caller+ or some backtrace
+      # @return [Line] The parsed backtrace line
+      def self.parse(unparsed_line)
+        _, file, number, method = unparsed_line.match(INPUT_FORMAT).to_a
+        new(file, number, method)
+      end
+
+      def initialize(file, number, method)
+        self.file   = file
+        self.number = number
+        self.method = method
+      end
+
+      # Reconstructs the line in a readable fashion
+      def to_s
+        "#{file}:#{number}:in `#{method}'"
+      end
+
+      def ==(other)
+        to_s == other.to_s
+      end
+
+      def inspect
+        "<Line:#{to_s}>"
+      end
+
+      private
+
+      attr_writer :file, :number, :method
+    end
+
+    # holder for an Array of Backtrace::Line instances
+    attr_reader :lines
+
+    def self.parse(ruby_backtrace, opts = {})
+      ruby_lines = split_multiline_backtrace(ruby_backtrace)
+
+      filters = opts[:filters] || []
+      filtered_lines = ruby_lines.to_a.map do |line|
+        filters.inject(line) do |line, proc|
+          proc.call(line)
+        end
+      end.compact
+
+      lines = filtered_lines.collect do |unparsed_line|
+        Line.parse(unparsed_line)
+      end
+
+      instance = new(lines)
+    end
+
+    def initialize(lines)
+      self.lines = lines
+    end
+
+    def inspect
+      "<Backtrace: " + lines.collect { |line| line.inspect }.join(", ") + ">"
+    end
+
+    def ==(other)
+      if other.respond_to?(:lines)
+        lines == other.lines
+      else
+        false
+      end
+    end
+
+    private
+
+    attr_writer :lines
+
+    def self.split_multiline_backtrace(backtrace)
+      if backtrace.to_a.size == 1
+        backtrace.to_a.first.split(/\n\s*/)
+      else
+        backtrace
+      end
+    end
+  end
+end

data/lib/hoptoad_notifier/capistrano.rb

@@ -0,0 +1,20 @@
+# Defines deploy:notify_hoptoad which will send information about the deploy to Hoptoad.
+
+Capistrano::Configuration.instance(:must_exist).load do
+  after "deploy",            "deploy:notify_hoptoad"
+  after "deploy:migrations", "deploy:notify_hoptoad"
+
+  namespace :deploy do
+    desc "Notify Hoptoad of the deployment"
+    task :notify_hoptoad, :except => { :no_release => true } do
+      rails_env = fetch(:hoptoad_env, fetch(:rails_env, "production"))
+      local_user = ENV['USER'] || ENV['USERNAME']
+      executable = RUBY_PLATFORM.downcase.include?('mswin') ? 'rake.bat' : 'rake'
+      notify_command = "#{executable} hoptoad:deploy TO=#{rails_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}"
+      notify_command << " API_KEY=#{ENV['API_KEY']}" if ENV['API_KEY']
+      puts "Notifying Hoptoad of Deploy (#{notify_command})"
+      `#{notify_command}`
+      puts "Hoptoad Notification Complete."
+    end
+  end
+end