hoptoad_notifier 2.4.2 → 2.4.4

data/CHANGELOG

@@ -1,3 +1,19 @@
+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
 ===============================================================================
 
@@ -375,6 +391,8 @@ 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,8 @@ 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
+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 +239,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 +248,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 +278,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 +297,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 +309,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 +395,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, use this helper method from your layouts:
+
+    <%= 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)
 
-To automatically include the Javascript node on every page, set the
-:js_notifier to true:
+HoptoadNotifier is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
 
-  HoptoadNotifier.configure do |config|
-    config.js_notifier = true
-  end
+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")

data/lib/hoptoad_notifier/configuration.rb

@@ -7,7 +7,8 @@ module HoptoadNotifier
         :http_open_timeout, :http_read_timeout, :ignore, :ignore_by_filters,
         :ignore_user_agent, :notifier_name, :notifier_url, :notifier_version,
         :params_filters, :project_root, :port, :protocol, :proxy_host,
-        :proxy_pass, :proxy_port, :proxy_user, :secure, :framework, :js_notifier].freeze
+        :proxy_pass, :proxy_port, :proxy_user, :secure, :framework,
+        :user_information].freeze
 
     # The API key for your project, found on the project edit form.
     attr_accessor :api_key
@@ -62,9 +63,6 @@ module HoptoadNotifier
     # +true+ if you want to check for production errors matching development errors, +false+ otherwise.
     attr_accessor :development_lookup
 
-    # +true+ if you want to enable the JavaScript notifier in production environments
-    attr_accessor :js_notifier
-
     # The name of the environment the application is running in
     attr_accessor :environment_name
 
@@ -83,6 +81,9 @@ module HoptoadNotifier
     # The logger used by HoptoadNotifier
     attr_accessor :logger
 
+    # The text that the placeholder is replaced with. {{error_id}} is the actual error number.
+    attr_accessor :user_information
+
     # The framework HoptoadNotifier is configured to use
     attr_accessor :framework
 
@@ -128,11 +129,11 @@ module HoptoadNotifier
       @ignore_user_agent        = []
       @development_environments = %w(development test cucumber)
       @development_lookup       = true
-      @js_notifier              = false
       @notifier_name            = 'Hoptoad Notifier'
       @notifier_version         = VERSION
       @notifier_url             = 'http://hoptoadapp.com'
       @framework                = 'Standalone'
+      @user_information         = 'Hoptoad Error {{error_id}}'
     end
 
     # Takes a block and adds it to the list of backtrace filters. When the filters
@@ -217,6 +218,10 @@ module HoptoadNotifier
       end
     end
 
+    def js_notifier=(*args)
+      warn '[HOPTOAD] config.js_notifier has been deprecated and has no effect.  You should use <%= hoptoad_javascript_notifier %> directly at the top of your layouts.  Be sure to place it before all other javascript.'
+    end
+
     def environment_filters
       warn 'config.environment_filters has been deprecated and has no effect.'
       []

data/lib/hoptoad_notifier/rack.rb

@@ -26,12 +26,14 @@ module HoptoadNotifier
       begin
         response = @app.call(env)
       rescue Exception => raised
-        HoptoadNotifier.notify_or_ignore(raised, :rack_env => env)
+        error_id = HoptoadNotifier.notify_or_ignore(raised, :rack_env => env)
+        env['hoptoad.error_id'] = error_id
         raise
       end
 
       if env['rack.exception']
-        HoptoadNotifier.notify_or_ignore(env['rack.exception'], :rack_env => env)
+        error_id = HoptoadNotifier.notify_or_ignore(env['rack.exception'], :rack_env => env)
+        env['hoptoad.error_id'] = error_id
       end
 
       response

data/lib/hoptoad_notifier/rails/action_controller_catcher.rb

@@ -14,7 +14,8 @@ module HoptoadNotifier
       # any custom processing that is defined with Rails 2's exception helpers.
       def rescue_action_in_public_with_hoptoad(exception)
         unless hoptoad_ignore_user_agent?
-          HoptoadNotifier.notify_or_ignore(exception, hoptoad_request_data)
+          error_id = HoptoadNotifier.notify_or_ignore(exception, hoptoad_request_data)
+          request.env['hoptoad.error_id'] = error_id
         end
         rescue_action_in_public_without_hoptoad(exception)
       end

data/lib/hoptoad_notifier/rails/javascript_notifier.rb

@@ -2,44 +2,39 @@ module HoptoadNotifier
   module Rails
     module JavascriptNotifier
       def self.included(base) #:nodoc:
-        base.send(:after_filter, :insert_hoptoad_javascript_notifier)
+        base.send :helper_method, :hoptoad_javascript_notifier
       end
 
       private
 
-      def insert_hoptoad_javascript_notifier
+      def hoptoad_javascript_notifier
         return unless HoptoadNotifier.configuration.public?
-        return unless HoptoadNotifier.configuration.js_notifier
 
-        path = File.join(File.dirname(__FILE__), '..', '..', 'templates', 'javascript_notifier.erb')
+        path = File.join File.dirname(__FILE__), '..', '..', 'templates', 'javascript_notifier.erb'
         host = HoptoadNotifier.configuration.host.dup
         port = HoptoadNotifier.configuration.port
         host << ":#{port}" unless [80, 443].include?(port)
 
-        options = {
-          :file          => path,
-          :layout        => false,
-          :use_full_path => false,
-          :locals        => {
-            :host        => host,
-            :api_key     => HoptoadNotifier.configuration.api_key,
-            :environment => HoptoadNotifier.configuration.environment_name
+        options              = {
+          :file              => path,
+          :layout            => false,
+          :use_full_path     => false,
+          :locals            => {
+            :host            => host,
+            :api_key         => HoptoadNotifier.configuration.api_key,
+            :environment     => HoptoadNotifier.configuration.environment_name,
+            :action_name     => action_name,
+            :controller_name => controller_name,
+            :url             => request.url
           }
         }
 
         if @template
-          javascript = @template.render(options)
+          @template.render(options)
         else
-          javascript = render_to_string(options)
+          render_to_string(options)
         end
 
-        if response.body.respond_to?(:gsub)
-          response.body = insert_javascript_after_head response.body, javascript
-        end
-      end
-
-      def insert_javascript_after_head(body, javascript)
-        body.gsub /<(head.*?)>/i, "<\\1>\n#{javascript}\n"
       end
 
     end

data/lib/hoptoad_notifier/rails.rb

@@ -23,6 +23,8 @@ module HoptoadNotifier
       if defined?(::Rails.configuration) && ::Rails.configuration.respond_to?(:middleware)
         ::Rails.configuration.middleware.insert_after 'ActionController::Failsafe',
                                                       HoptoadNotifier::Rack
+        ::Rails.configuration.middleware.insert_after 'Rack::Lock',
+                                                      HoptoadNotifier::UserInformer
       end
 
       HoptoadNotifier.configure(true) do |config|

data/lib/hoptoad_notifier/railtie.rb

@@ -9,6 +9,7 @@ module HoptoadNotifier
 
     initializer "hoptoad.use_rack_middleware" do |app|
       app.config.middleware.use "HoptoadNotifier::Rack"
+      app.config.middleware.insert_after "Rack::Lock", "HoptoadNotifier::UserInformer"
     end
 
     config.after_initialize do

data/lib/hoptoad_notifier/sender.rb

@@ -46,6 +46,11 @@ module HoptoadNotifier
       else
         log :error, "Failure: #{response.class}", response
       end
+
+      if response && response.respond_to?(:body)
+        error_id = response.body.match(%r{<error-id[^>]*>(.*?)</error-id>})
+        error_id[1] if error_id
+      end
     end
 
     private

data/lib/hoptoad_notifier/user_informer.rb

@@ -0,0 +1,29 @@
+module HoptoadNotifier
+  class UserInformer
+    def initialize(app)
+      @app = app
+    end
+
+    def replacement(with)
+      @replacement ||= HoptoadNotifier.configuration.user_information.gsub(/\{\{\s*error_id\s*\}\}/, with.to_s)
+    end
+
+    def call(env)
+      response = @app.call(env)
+      if env['hoptoad.error_id']
+        new_response = []
+        original_content_length = 0
+        modified_content_length = 0
+        response[2].each do |chunk|
+          original_content_length += chunk.length
+          new_response << chunk.to_s.gsub("<!-- HOPTOAD ERROR -->", replacement(env['hoptoad.error_id']))
+          modified_content_length += new_response.last.length
+        end
+        response[1]['Content-Length'] = modified_content_length.to_s
+        response[2] = new_response
+      end
+      response
+    end
+  end
+end
+

data/lib/hoptoad_notifier/version.rb

@@ -1,3 +1,3 @@
 module HoptoadNotifier
-  VERSION = "2.4.2".freeze
+  VERSION = "2.4.4".freeze
 end

data/lib/hoptoad_notifier.rb

@@ -12,6 +12,7 @@ require 'hoptoad_notifier/notice'
 require 'hoptoad_notifier/sender'
 require 'hoptoad_notifier/backtrace'
 require 'hoptoad_notifier/rack'
+require 'hoptoad_notifier/user_informer'
 
 require 'hoptoad_notifier/railtie' if defined?(Rails::Railtie)
 

data/lib/templates/javascript_notifier.erb

@@ -1,17 +1,13 @@
-<script type="text/javascript"> 
-//<![CDATA[
-var notifierJsScheme = (("https:" == document.location.protocol) ? "https://" : "http://");
-document.write(unescape("%3Cscript src='" + notifierJsScheme + "<%= host %>/javascripts/notifier.js' type='text/javascript'%3E%3C/script%3E"));
-//]]>
-</script> 
+<%= javascript_tag %Q{
+    var notifierJsScheme = (("https:" == document.location.protocol) ? "https://" : "http://");
+    document.write(unescape("%3Cscript src='" + notifierJsScheme + "#{host}/javascripts/notifier.js' type='text/javascript'%3E%3C/script%3E"));
+  }
+%>
 
-<script type="text/javascript">
-  Hoptoad.setKey('<%= api_key %>');
-  Hoptoad.setHost('<%= host %>');
-  Hoptoad.setEnvironment('<%= environment %>');
-    Hoptoad.setErrorDefaults({
-      url: "<%= a = "#{controller.request.protocol}#{controller.request.host_with_port}#{controller.request.request_uri}"; p a; a %>",
-      component: "<%= controller.controller_name %>",
-      action: "<%= controller.action_name %>"
-  });
-</script>
+<%= javascript_tag %Q{
+    Hoptoad.setKey('#{api_key}');
+    Hoptoad.setHost('#{host}');
+    Hoptoad.setEnvironment('#{environment}');
+    Hoptoad.setErrorDefaults({ url: "#{escape_javascript url}", component: "#{controller_name}", action: "#{action_name}" });
+  } 
+%>

data/test/catcher_test.rb

@@ -25,6 +25,8 @@ class ActionControllerCatcherTest < Test::Unit::TestCase
 
   def assert_sent_hash(hash, xpath)
     hash.each do |key, value|
+      next if key.match(/^hoptoad\./) # We added this key.
+
       element_xpath = "#{xpath}/var[@key = '#{key}']"
       if value.respond_to?(:to_hash)
         assert_sent_hash value.to_hash, element_xpath

data/test/configuration_test.rb

@@ -29,7 +29,6 @@ class ConfigurationTest < Test::Unit::TestCase
                           HoptoadNotifier::Configuration::IGNORE_DEFAULT
     assert_config_default :development_lookup, true
     assert_config_default :framework, 'Standalone'
-    assert_config_default :js_notifier, false
   end
 
   should "provide default values for secure connections" do
@@ -85,7 +84,7 @@ class ConfigurationTest < Test::Unit::TestCase
      :http_read_timeout, :ignore, :ignore_by_filters, :ignore_user_agent,
      :notifier_name, :notifier_url, :notifier_version, :params_filters,
      :project_root, :port, :protocol, :proxy_host, :proxy_pass, :proxy_port,
-     :proxy_user, :secure, :development_lookup, :js_notifier].each do |option|
+     :proxy_user, :secure, :development_lookup].each do |option|
       assert_equal config[option], hash[option], "Wrong value for #{option}"
     end
   end
@@ -108,6 +107,14 @@ class ConfigurationTest < Test::Unit::TestCase
     assert_equal [], config.environment_filters
   end
 
+  should "warn when attempting to write js_notifier" do
+    config = HoptoadNotifier::Configuration.new
+    config.
+      expects(:warn).
+      with(regexp_matches(/deprecated/i))
+    config.js_notifier = true
+  end
+
   should "allow ignored user agents to be appended" do
     assert_appends_value :ignore_user_agent
   end

data/test/helper.rb

@@ -7,6 +7,7 @@ gem "actionpack",    "= 2.3.8"
 gem "nokogiri",      "= 1.4.3.1"
 gem "shoulda",       "= 2.11.3"
 gem 'bourne', '>= 1.0'
+gem "sham_rack",     "~> 1.3.0"
 
 $LOAD_PATH << File.join(File.dirname(__FILE__), *%w[.. vendor ginger lib])
 $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
@@ -25,6 +26,7 @@ require 'active_support'
 require 'nokogiri'
 require 'rack'
 require 'bourne'
+require 'sham_rack'
 
 require "hoptoad_notifier"
 

data/test/javascript_notifier_test.rb

@@ -1,38 +1,52 @@
 require File.dirname(__FILE__) + '/helper'
-
 require 'hoptoad_notifier/rails/javascript_notifier'
+require 'ostruct'
 
 class JavascriptNotifierTest < Test::Unit::TestCase
-  
-  def self.after_filter(arg); end
-  include ::HoptoadNotifier::Rails::JavascriptNotifier
-
-  should "insert javascript after head" do
-    input_body =<<-EOS
-<html><head><title></title></head><body></body></html>
-    EOS
-    javascript = "js-code"
-    expected =<<-EOS
-<html><head>
-js-code
-<title></title></head><body></body></html>
-    EOS
-    output = send :insert_javascript_after_head, input_body, javascript
-    assert_equal expected, output
+  module FakeRenderer
+    def javascript_tag(text)
+      "<script>#{text}</script>"
+    end
+    def escape_javascript(text)
+      "ESC#{text}ESC"
+    end
   end
 
-  should "insert javascript after head when head has attributes" do
-    input_body =<<-EOS
-<html><head lang="en"><title></title></head><body></body></html>
-    EOS
-    javascript = "js-code"
-    expected =<<-EOS
-<html><head lang="en">
-js-code
-<title></title></head><body></body></html>
-    EOS
-    output = send :insert_javascript_after_head, input_body, javascript
-    assert_equal expected, output
+  class FakeController
+    def self.helper_method(*args)
+    end
+
+    include HoptoadNotifier::Rails::JavascriptNotifier
+
+    def action_name
+      "action"
+    end
+
+    def controller_name
+      "controller"
+    end
+
+    def request
+      @request ||= OpenStruct.new
+    end
+
+    def render_to_string(options)
+      context = OpenStruct.new(options[:locals])
+      context.extend(FakeRenderer)
+      context.instance_eval do
+        erb = ERB.new(IO.read(options[:file]))
+        erb.result(binding)
+      end
+    end
   end
 
+  should "make sure escape_javacript is called on the request.url" do
+    HoptoadNotifier.configure do
+    end
+    controller = FakeController.new
+    controller.request.url = "bad_javascript"
+    assert controller.send(:hoptoad_javascript_notifier)['"ESCbad_javascriptESC"']
+    assert ! controller.send(:hoptoad_javascript_notifier)['"bad_javascript"']
+  end
 end
+

data/test/sender_test.rb

@@ -16,11 +16,10 @@ class SenderTest < Test::Unit::TestCase
     notice = args.delete(:notice) || build_notice_data
     sender = args.delete(:sender) || build_sender(args)
     sender.send_to_hoptoad(notice)
-    sender
   end
 
-  def stub_http
-    response = stub(:body => 'body')
+  def stub_http(options = {})
+    response = stub(:body => options[:body] || 'body')
     http = stub(:post          => response,
                 :read_timeout= => nil,
                 :open_timeout= => nil,
@@ -58,6 +57,17 @@ class SenderTest < Test::Unit::TestCase
     end
   end
 
+  should "return the created group's id on successful posting" do
+    http = stub_http(:body => '<error-id type="integer">3799307</error-id>')
+    assert_equal "3799307", send_exception(:secure => false)
+  end
+
+  should "return nil on failed posting" do
+    http = stub_http
+    http.stubs(:post).raises(Errno::ECONNREFUSED)
+    assert_equal nil, send_exception(:secure => false)
+  end
+
   should "not fail when posting and a timeout exception occurs" do
     http = stub_http
     http.stubs(:post).raises(TimeoutError)

data/test/user_informer_test.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/helper'
+
+class UserInformerTest < Test::Unit::TestCase
+  should "modify output if there is a hoptoad id" do
+    main_app = lambda do |env|
+      env['hoptoad.error_id'] = 1
+      [200, {}, "<!-- HOPTOAD ERROR -->"]
+    end
+    informer_app = HoptoadNotifier::UserInformer.new(main_app)
+
+    ShamRack.mount(informer_app, "example.com")
+
+    response = Net::HTTP.get_response(URI.parse("http://example.com/"))
+    assert_equal "Hoptoad Error 1", response.body
+    assert_equal 15, response["Content-Length"].to_i
+  end
+
+  should "not modify output if there is no hoptoad id" do
+    main_app = lambda do |env|
+      [200, {}, "<!-- HOPTOAD ERROR -->"]
+    end
+    informer_app = HoptoadNotifier::UserInformer.new(main_app)
+
+    ShamRack.mount(informer_app, "example.com")
+
+    response = Net::HTTP.get_response(URI.parse("http://example.com/"))
+    assert_equal "<!-- HOPTOAD ERROR -->", response.body
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hoptoad_notifier
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 2
   - 4
-  - 2
-  version: 2.4.2
+  - 4
+  version: 2.4.4
 platform: ruby
 authors: 
 - thoughtbot, inc
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-09 00:00:00 -05:00
+date: 2011-01-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -122,14 +122,14 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - CHANGELOG
 - INSTALL
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 - README_FOR_HEROKU_ADDON.md
 - SUPPORTED_RAILS_VERSIONS
 - TESTING.rdoc
@@ -154,6 +154,7 @@ files:
 - lib/hoptoad_notifier/sender.rb
 - lib/hoptoad_notifier/shared_tasks.rb
 - lib/hoptoad_notifier/tasks.rb
+- lib/hoptoad_notifier/user_informer.rb
 - lib/hoptoad_notifier/version.rb
 - lib/hoptoad_notifier.rb
 - lib/hoptoad_tasks.rb
@@ -170,6 +171,7 @@ files:
 - test/rack_test.rb
 - test/rails_initializer_test.rb
 - test/sender_test.rb
+- test/user_informer_test.rb
 - rails/init.rb
 - script/integration_test.rb
 - lib/templates/javascript_notifier.erb
@@ -179,10 +181,8 @@ homepage: http://www.hoptoadapp.com
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --main
-- README.rdoc
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -222,3 +222,4 @@ test_files:
 - test/rack_test.rb
 - test/rails_initializer_test.rb
 - test/sender_test.rb
+- test/user_informer_test.rb