hoptoad_notifier 2.4.0 → 2.4.10

data/CHANGELOG

@@ -1,3 +1,64 @@
+Version 2.4.9 - Wed Mar 30 09:04:53 -0400 2011
+===============================================================================
+
+Jonathan Yurek(1):
+      The User Informer should adhere to only the Rack spec.
+
+Version 2.4.8 - Mon Mar 21 11:11:16 -0400 2011
+===============================================================================
+
+Jonathan Yurek(1):
+      Prevent infinite loops from recursive data structures.
+
+Version 2.4.7 - Thu Mar 10 16:21:31 -0500 2011
+===============================================================================
+
+Jonathan Yurek(1):
+      Rails generator requires './config/boot' for 1.9.2 compatibility.
+
+Version 2.4.6 - Tue Feb 15 15:51:17 -0500 2011
+===============================================================================
+
+Jonathan Yurek(1):
+      Modify the error page's body in-place.
+
+Version 2.4.5 - Wed Feb 02 13:24:29 -0500 2011
+===============================================================================
+
+Jonathan Yurek (1):
+      Don't require Rack::Lock's presence in the middleware for UserInformer
+
+
+Version 2.4.4 - Fri Jan 28 13:50:10 -0500 2011
+===============================================================================
+
+Matt Jankowski (1):
+      Change the javascript notifier from a config option to a helper method
+
+Jonathan Yurek (1):
+      Show the javascript notifier prevents XSS attempts from request.url
+
+Version 2.4.3 - Wed Jan 26 11:35:15 -0500 2011
+===============================================================================
+
+Jon Yurek (1):
+      Allow the application to present the Hoptoad error number to the user
+
+
+Version 2.4.2 - Sun Jan 09 09:37:31 -0500 2011
+===============================================================================
+
+Matt Jankowski (1):
+      fix issue where the gsub to replace the html head with javascript was removing the head element entirely
+
+
+Version 2.4.1 - Sat Jan 08 12:17:15 -0500 2011
+===============================================================================
+
+Matt Jankowski (1):
+      restore method which may have been accidentally removed?
+
+
 Version 2.4.0 - Thu Jan 06 15:03:58 -0500 2011
 ===============================================================================
 
@@ -352,6 +413,15 @@ Nick Quaranto (3):
 
 
 
+
+
+
+
+
+
+
+
+
 
 
 

data/{README.rdoc → README.md}

@@ -1,96 +1,100 @@
-= HoptoadNotifier
+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
+Help
+----
 
-* {IRC}[irc://irc.freenode.net/thoughtbot]
-* {mailing list}[http://groups.google.com/group/hoptoad-notifier-dev]
+For help with using Hoptoad and the Hoptoad notifier visit [our support site](http://help.hoptoadapp.com)
 
-== Rails Installation
+For discussion of Hoptoad notifier development check out the [mailing list](http://groups.google.com/group/hoptoad-notifier-dev)
 
-=== Remove exception_notifier
+Rails Installation
+------------------
+
+### Remove exception_notifier
 
 in your ApplicationController, REMOVE this line:
 
-  include ExceptionNotifiable
+    include ExceptionNotifiable
 
 In your config/environment* files, remove all references to ExceptionNotifier
 
 Remove the vendor/plugins/exception_notifier directory.
 
-=== Remove hoptoad_notifier plugin
+### Remove hoptoad_notifier plugin
 
 Remove the vendor/plugins/hoptoad_notifier directory before installing the gem, or run:
 
-  script/plugin remove hoptoad_notifier
+    script/plugin remove hoptoad_notifier
 
-=== Rails 3.x
+### Rails 3.x
 
 Add the hoptoad_notifier gem to your Gemfile.  In Gemfile:
 
-  gem "hoptoad_notifier", "~> 2.3"
+    gem "hoptoad_notifier", "~> 2.3"
 
 Then from your project's RAILS_ROOT, run:
 
-  bundle install
-  script/rails generate hoptoad --api-key your_key_here
+    bundle install
+    script/rails generate hoptoad --api-key your_key_here
 
 That's it!
 
-=== Rails 2.x
+### Rails 2.x
 
 Add the hoptoad_notifier gem to your app. In config/environment.rb:
 
-  config.gem 'hoptoad_notifier'
+    config.gem 'hoptoad_notifier'
 
 Then from your project's RAILS_ROOT, run:
 
-  rake gems:install
-  rake gems:unpack GEM=hoptoad_notifier
-  script/generate hoptoad --api-key your_key_here
+    rake gems:install
+    rake gems:unpack GEM=hoptoad_notifier
+    script/generate hoptoad --api-key your_key_here
 
 As always, if you choose not to vendor the hoptoad_notifier gem, make sure
 every server you deploy to has the gem installed or your application won't start.
 
-=== Rails 1.2.6
+### Rails 1.2.6
 
 Install the hoptoad_notifier gem:
 
-  gem install hoptoad_notifier
+    gem install hoptoad_notifier
 
 Once installed, you should vendor the hoptoad_notifier gem:
 
-  mkdir vendor/gems
-  cd vendor/gems
-  gem unpack hoptoad_notifier
+    mkdir vendor/gems
+    cd vendor/gems
+    gem unpack hoptoad_notifier
 
 And then add the following to the Rails::Initializer.run do |config|
 block in environment.rb so that the vendored gem is loaded.
 
-  # Add the vendor/gems/*/lib directories to the LOAD_PATH
-  config.load_paths += Dir.glob(File.join(RAILS_ROOT, 'vendor', 'gems', '*', 'lib'))
+    # Add the vendor/gems/*/lib directories to the LOAD_PATH
+    config.load_paths += Dir.glob(File.join(RAILS_ROOT, 'vendor', 'gems', '*', 'lib'))
 
 Next add something like this at the bottom of your config/environment.rb:
 
-  require 'hoptoad_notifier'
-  require 'hoptoad_notifier/rails'
-  HoptoadNotifier.configure do |config|
-    config.api_key = 'your_key_here'
-  end
+    require 'hoptoad_notifier'
+    require 'hoptoad_notifier/rails'
+    HoptoadNotifier.configure do |config|
+      config.api_key = 'your_key_here'
+    end
 
 You will also 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:
 
-  cp vendor/gems/hoptoad_notifier-*/generators/hoptoad/templates/hoptoad_notifier_tasks.rake lib/tasks
+    cp vendor/gems/hoptoad_notifier-*/generators/hoptoad/templates/hoptoad_notifier_tasks.rake lib/tasks
 
 As always, if you choose not to vendor the hoptoad_notifier gem, make sure
 every server you deploy to has the gem installed or your application won't start.
 
-=== Upgrading From Earlier Versions of Hoptoad
+### Upgrading From Earlier Versions of Hoptoad
 
 If you're currently using the plugin version (if you have a
 vendor/plugins/hoptoad_notifier directory, you are), you'll need to perform a
@@ -131,7 +135,7 @@ As always, if you choose not to vendor the hoptoad_notifier gem, make sure
 every server you deploy to has the gem installed or your application won't
 start.
 
-== Upgrading from Earlier Versions of the Hoptoad Gem (with config.gem)
+### Upgrading from Earlier Versions of the Hoptoad Gem (with config.gem)
 
 If you're currently using the gem version of the hoptoad_notifier and have
 a version of Rails that uses config.gem (in the 2.x series), there is
@@ -148,56 +152,59 @@ You can them continue to install normally. If you don't remove the rake file,
 you will be unable to unpack this gem (Rails will think it's part of the
 framework).
 
-=== Testing it out
+### 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
+    rake hoptoad:test
 
 If everything is configured properly, that task will send a notice to Hoptoad
 which will be visible immediately.
 
-== Rack
+Rack
+----
 
 In order to use hoptoad_notifier in a non-Rails rack app, just load the
 hoptoad_notifier, configure your API key, and use the HoptoadNotifier::Rack
 middleware:
 
-  require 'rack'
-  require 'hoptoad_notifier'
+    require 'rack'
+    require 'hoptoad_notifier'
 
-  HoptoadNotifier.configure do |config|
-    config.api_key = 'my_api_key'
-  end
+    HoptoadNotifier.configure do |config|
+      config.api_key = 'my_api_key'
+    end
 
-  app = Rack::Builder.app do
-    use HoptoadNotifier::Rack
-    run lambda { |env| raise "Rack down" }
-  end
+    app = Rack::Builder.app do
+      use HoptoadNotifier::Rack
+      run lambda { |env| raise "Rack down" }
+    end
 
-== Sinatra
+Sinatra
+-------
 
 Using hoptoad_notifier in a Sinatra app is just like a Rack app, but you have
 to disable Sinatra's error rescuing functionality:
 
-  require 'sinatra/base'
-  require 'hoptoad_notifier'
-
-  HoptoadNotifier.configure do |config|
-    config.api_key = 'my_api_key'
-  end
-
-  class MyApp < Sinatra::Default
-    use HoptoadNotifier::Rack
-    enable :raise_errors
-
-    get "/" do
-      raise "Sinatra has left the building"
+    require 'sinatra/base'
+    require 'hoptoad_notifier'
+  
+    HoptoadNotifier.configure do |config|
+      config.api_key = 'my_api_key'
+    end
+  
+    class MyApp < Sinatra::Default
+      use HoptoadNotifier::Rack
+      enable :raise_errors
+  
+      get "/" do
+        raise "Sinatra has left the building"
+      end
     end
-  end
 
-== Usage
+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),
@@ -206,12 +213,12 @@ 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
-  ...
+    ...
+    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
@@ -221,7 +228,28 @@ 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
+Informing the User
+------------------
+
+The Notifier gem is capable of telling the user information about the error that just happened
+via the user_information option. They can give this error number in bug resports, for example.
+By default, if your 500.html contains the text
+
+    <!-- HOPTOAD ERROR -->
+
+then that comment will be replaced with the text "Hoptoad Error [errnum]". You can modify the text
+of the informer by setting config.user_information. The Notifier will replace "{{ error_id }}" with the
+ID of the error that is returned from Hoptoad.
+
+  HoptoadNotifier.configure do |config|
+    ...
+    config.user_information = "<p>Tell the devs that it was <strong>{{ error_id }}</strong>'s fault.</p>"
+  end
+
+You can also turn the middleware completely off by setting config.user_information to false.
+
+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,
@@ -231,7 +259,7 @@ Additionally, it's possible to review the errors in Hoptoad that occurred before
 
 When Hoptoad is installed as a gem, you need to add
 
-  require 'hoptoad_notifier/capistrano'
+    require 'hoptoad_notifier/capistrano'
 
 to your deploy.rb
 
@@ -240,24 +268,25 @@ deployment process to notify Hoptoad:
 
     rake hoptoad:deploy TO=#{rails_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}
 
-== Going beyond exceptions
+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
+    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
@@ -269,17 +298,17 @@ about the error itself. As for a hash, these are the keys you should pass:
 
 Hoptoad merges the hash you pass with these default options:
 
-  {
-    :api_key       => HoptoadNotifier.api_key,
-    :error_message => 'Notification',
-    :backtrace     => caller,
-    :parameters    => {},
-    :session       => {}
-  }
+    {
+      :api_key       => HoptoadNotifier.api_key,
+      :error_message => 'Notification',
+      :backtrace     => caller,
+      :parameters    => {},
+      :session       => {}
+    }
 
 You can override any of those parameters.
 
-=== Sending shell environment variables when "Going beyond exceptions"
+### Sending shell environment variables when "Going beyond exceptions"
 
 One common request we see is to send shell environment variables along with
 manual exception notification.  We recommend sending them along with CGI data
@@ -288,7 +317,8 @@ or Rack environment (:cgi_data or :rack_env keys, respectively.)
 See HoptoadNotifier::Notice#initialize in lib/hoptoad_notifier/notice.rb for
 more details.
 
-== Filtering
+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
@@ -299,81 +329,84 @@ notifications (when #notify is called directly).
 
 Hoptoad ignores the following exceptions by default:
 
-  AbstractController::ActionNotFound
-  ActiveRecord::RecordNotFound
-  ActionController::RoutingError
-  ActionController::InvalidAuthenticityToken
-  ActionController::UnknownAction
-  CGI::Session::CookieStore::TamperedWithCookie
+    AbstractController::ActionNotFound
+    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
+    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
+    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
+    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"
+    HoptoadNotifier.configure do |config|
+      config.api_key      = '1234567890abcdef'
+      config.ignore_by_filter do |exception_data|
+        true if exception_data[:error_class] == "RuntimeError"
+      end
     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
+    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_parameter_logging.
 
-== Testing
+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.
+    module HoptoadNotifier
+      def self.notify(thing)
+        # do nothing.
+      end
     end
-  end
 
-== Proxy Support
+Proxy Support
+-------------
 
 The notifier supports using a proxy, if your server is not able to directly reach the Hoptoad servers.  To configure the proxy settings, added the following information to your Hoptoad configuration block.
 
-  HoptoadNotifier.configure do |config|
-    config.proxy_host = ...
-    config.proxy_port = ...
-    config.proxy_user = ...
-    config.proxy_pass = ...
+    HoptoadNotifier.configure do |config|
+      config.proxy_host = ...
+      config.proxy_port = ...
+      config.proxy_user = ...
+      config.proxy_pass = ...
 
-== Supported Rails versions
+Supported Rails versions
+------------------------
 
 See SUPPORTED_RAILS_VERSIONS for a list of official supported versions of
 Rails.
@@ -382,19 +415,41 @@ 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.
 
-== Javascript Notifer
+Javascript Notifer
+------------------
 
-To automatically include the Javascript node on every page, set the
-:js_notifier to true:
+To automatically include the Javascript node on every page, use this helper method from your layouts:
 
-  HoptoadNotifier.configure do |config|
-    config.js_notifier = true
-  end
+    <%= hoptoad_javascript_notifier %>
+
+It's important to insert this very high in the markup, above all other javascript.  Example:
+
+    <!DOCTYPE html>
+    <html>
+      <head>
+        <meta charset="utf8">
+        <%= hoptoad_javascript_notifier %>
+        <!-- more javascript -->
+      </head>
+      <body>
+        ...
+      </body>
+    </html>
+
+This helper will automatically use the API key, host, and port specified in the configuration.
+
+Credits
+-------
+
+![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+
+HoptoadNotifier is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
+
+Thank you to all [the contributors](https://github.com/thoughtbot/hoptoad_notifier/contributors)!
 
-It automatically uses the API key, host, and port specified in the
-configuration.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 
-== Thanks
+License
+-------
 
-Thanks to Eugene Bolshakov for the excellent write-up on GOING BEYOND
-EXCEPTIONS, which we have included above.
+HoptoadNotifier is Copyright © 2008-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -123,10 +123,6 @@ gemspec = Gem::Specification.new do |s|
   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.add_runtime_dependency("builder")
   s.add_runtime_dependency("activesupport")
   s.add_development_dependency("activerecord")
@@ -162,6 +158,7 @@ RAILS_VERSIONS = IO.read('SUPPORTED_RAILS_VERSIONS').strip.split("\n")
 LOCAL_GEMS = [['sham_rack', nil], ['capistrano', nil], ['sqlite3-ruby', nil], ['sinatra', nil]] +
   RAILS_VERSIONS.collect { |version| ['rails', version] }
 
+desc "Vendor test gems: Run this once to prepare your test environment"
 task :vendor_test_gems do
   old_gem_path = ENV['GEM_PATH']
   old_gem_home = ENV['GEM_HOME']

data/SUPPORTED_RAILS_VERSIONS

@@ -8,3 +8,5 @@
 3.0.1
 3.0.2
 3.0.3
+3.0.4
+3.0.5

data/lib/hoptoad_notifier/backtrace.rb

@@ -5,7 +5,8 @@ module HoptoadNotifier
     # Handles backtrace parsing line by line
     class Line
 
-      INPUT_FORMAT = %r{^([^:]+):(\d+)(?::in `([^']+)')?$}.freeze
+      # regexp (optionnally allowing leading X: for windows support)
+      INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$}.freeze
 
       # The file portion of the line (such as app/models/user.rb)
       attr_reader :file

data/lib/hoptoad_notifier/capistrano.rb

@@ -9,8 +9,9 @@ Capistrano::Configuration.instance(:must_exist).load do
     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'
+      executable = RUBY_PLATFORM.downcase.include?('mswin') ? fetch(:rake, 'rake.bat') : fetch(:rake, 'rake')
       notify_command = "#{executable} hoptoad:deploy TO=#{rails_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}"
+      notify_command << " DRY_RUN=true" if dry_run
       notify_command << " API_KEY=#{ENV['API_KEY']}" if ENV['API_KEY']
       puts "Notifying Hoptoad of Deploy (#{notify_command})"
       `#{notify_command}`