hoptoad_notifier 2.4.0 → 2.4.10

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/notice.rb

@@ -226,14 +226,16 @@ module HoptoadNotifier
     # Removes non-serializable data. Allowed data types are strings, arrays,
     # and hashes. All other types are converted to strings.
     # TODO: move this onto Hash
-    def clean_unserializable_data(data)
+    def clean_unserializable_data(data, stack = [])
+      return "[possible infinite recursion halted]" if stack.any?{|item| item == data.object_id }
+
       if data.respond_to?(:to_hash)
         data.to_hash.inject({}) do |result, (key, value)|
-          result.merge(key => clean_unserializable_data(value))
+          result.merge(key => clean_unserializable_data(value, stack + [data.object_id]))
         end
       elsif data.respond_to?(:to_ary)
         data.collect do |value|
-          clean_unserializable_data(value)
+          clean_unserializable_data(value, stack + [data.object_id])
         end
       else
         data.to_s

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,41 +2,41 @@ 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 = response.body.gsub(/<(head.*?)>/i, "<\1>\n" + javascript)
-        end
       end
+
     end
   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 0, "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/shared_tasks.rb

@@ -6,7 +6,13 @@ namespace :hoptoad do
                         :scm_revision   => ENV['REVISION'],
                         :scm_repository => ENV['REPO'],
                         :local_username => ENV['USER'],
-                        :api_key        => ENV['API_KEY'])
+                        :api_key        => ENV['API_KEY'],
+                        :dry_run        => ENV['DRY_RUN'])
+  end
+
+  task :log_stdout do
+    require 'logger'
+    RAILS_DEFAULT_LOGGER = Logger.new(STDOUT)
   end
 
   namespace :heroku do

data/lib/hoptoad_notifier/tasks.rb

@@ -8,7 +8,7 @@ namespace :hoptoad do
 
     require 'action_controller/test_process'
 
-    Dir["app/controllers/application*.rb"].each { |file| require(file) }
+    Dir["app/controllers/application*.rb"].each { |file| require(File.expand_path(file)) } 
 
     class HoptoadTestingException < RuntimeError; end
 
@@ -63,9 +63,9 @@ namespace :hoptoad do
 
       def exception_class
         exception_name = ENV['EXCEPTION'] || "HoptoadTestingException"
-        Object.const_get(exception_name)
+        exception_name.split("::").inject(Object){|klass, name| klass.const_get(name)}
       rescue
-        Object.const_set(exception_name, Class.new(Exception))
+        Object.const_set(exception_name.gsub(/:+/, "_"), Class.new(Exception))
       end
 
       def logger

data/lib/hoptoad_notifier/user_informer.rb

@@ -0,0 +1,25 @@
+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)
+      status, headers, body = @app.call(env)
+      if env['hoptoad.error_id'] && HoptoadNotifier.configuration.user_information
+        new_body = []
+        body.each do |chunk|
+          new_body << chunk.gsub("<!-- HOPTOAD ERROR -->", replacement(env['hoptoad.error_id']))
+        end
+        headers['Content-Length'] = new_body.sum(&:length).to_s
+        body = new_body
+      end
+      [status, headers, body]
+    end
+  end
+end
+

data/lib/hoptoad_notifier/version.rb

@@ -1,3 +1,3 @@
 module HoptoadNotifier
-  VERSION = "2.4.0".freeze
+  VERSION = "2.4.9".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/hoptoad_tasks.rb

@@ -24,6 +24,7 @@ module HoptoadTasks
       return false
     end
 
+    dry_run = opts.delete(:dry_run)
     params = {'api_key' => opts.delete(:api_key) ||
                              HoptoadNotifier.configuration.api_key}
     opts.each {|k,v| params["deploy[#{k}]"] = v }
@@ -35,10 +36,15 @@ module HoptoadTasks
                             HoptoadNotifier.configuration.proxy_user,
                             HoptoadNotifier.configuration.proxy_pass)
 
-    response = proxy.post_form(url, params)
+    if dry_run
+      puts url, params.inspect
+      return true
+    else
+      response = proxy.post_form(url, params)
 
-    puts response.body
-    return Net::HTTPSuccess === response
+      puts response.body
+      return Net::HTTPSuccess === response
+    end
   end
 end
 

data/lib/rails/generators/hoptoad/hoptoad_generator.rb

@@ -38,7 +38,7 @@ class HoptoadGenerator < Rails::Generators::Base
     if File.exists?('config/deploy.rb') && File.exists?('Capfile')
       append_file('config/deploy.rb', <<-HOOK)
 
-        require 'config/boot'
+        require './config/boot'
         require 'hoptoad_notifier/capistrano'
       HOOK
     end

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/backtrace_test.rb

@@ -20,6 +20,25 @@ class BacktraceTest < Test::Unit::TestCase
     assert_equal 'app/controllers/users_controller.rb', line.file
     assert_equal 'index', line.method
   end
+  
+  should "parse a windows backtrace into lines" do
+    array = [
+      "C:/Program Files/Server/app/models/user.rb:13:in `magic'",
+      "C:/Program Files/Server/app/controllers/users_controller.rb:8:in `index'"
+    ]
+
+    backtrace = HoptoadNotifier::Backtrace.parse(array)
+
+    line = backtrace.lines.first
+    assert_equal '13', line.number
+    assert_equal 'C:/Program Files/Server/app/models/user.rb', line.file
+    assert_equal 'magic', line.method
+
+    line = backtrace.lines.last
+    assert_equal '8', line.number
+    assert_equal 'C:/Program Files/Server/app/controllers/users_controller.rb', line.file
+    assert_equal 'index', line.method
+  end
 
   should "be equal with equal lines" do
     one = build_backtrace_array

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,10 +7,12 @@ 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"))
 
+require 'thread'
 require 'shoulda'
 require 'mocha'
 
@@ -25,6 +27,7 @@ require 'active_support'
 require 'nokogiri'
 require 'rack'
 require 'bourne'
+require 'sham_rack'
 
 require "hoptoad_notifier"
 

data/test/hoptoad_tasks_test.rb

@@ -49,7 +49,18 @@ class HoptoadTasksTest < Test::Unit::TestCase
                  HoptoadNotifier.configuration.proxy_pass).
             returns(@http_proxy)
 
-          @options    = { :rails_env => "staging" }
+          @options    = { :rails_env => "staging", :dry_run => false }
+        end
+        
+        context "performing a dry run" do
+          setup { @output = HoptoadTasks.deploy(@options.merge(:dry_run => true)) }
+
+          should "return true without performing any actual request" do
+            assert_equal true, @output
+            assert_received(@http_proxy, :post_form) do|expects|
+              expects.never
+            end
+          end
         end
 
         context "on deploy(options)" do

data/test/javascript_notifier_test.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/helper'
+require 'hoptoad_notifier/rails/javascript_notifier'
+require 'ostruct'
+
+class JavascriptNotifierTest < Test::Unit::TestCase
+  module FakeRenderer
+    def javascript_tag(text)
+      "<script>#{text}</script>"
+    end
+    def escape_javascript(text)
+      "ESC#{text}ESC"
+    end
+  end
+
+  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/recursion_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/helper'
+
+class RecursionTest < Test::Unit::TestCase
+  should "not allow infinite recursion" do
+    hash = {:a => :a}
+    hash[:hash] = hash
+    notice = HoptoadNotifier::Notice.new(:parameters => hash)
+    assert_equal "[possible infinite recursion halted]", notice.parameters[:hash]
+  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