exception_notification_more_info 1.0.0

data/test/dummy/public/javascripts/rails.js

@@ -0,0 +1,191 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+
+  Ajax.Responders.register({
+    onCreate: function(request) {
+      var csrf_meta_tag = $$('meta[name=csrf-token]')[0];
+
+      if (csrf_meta_tag) {
+        var header = 'X-CSRF-Token',
+            token = csrf_meta_tag.readAttribute('content');
+
+        if (!request.options.requestHeaders) {
+          request.options.requestHeaders = {};
+        }
+        request.options.requestHeaders[header] = token;
+      }
+    }
+  });
+})();

data/test/dummy/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/test/dummy/public/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/test/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/dummy/test/fixtures/posts.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+one:
+  title: MyString
+  body: MyText
+  secret: MySecret
+
+two:
+  title: MyString
+  body: MyText
+  secret: MySecret

data/test/dummy/test/functional/posts_controller_test.rb

@@ -0,0 +1,224 @@
+require 'test_helper'
+
+class PostsControllerTest < ActionController::TestCase
+  setup do
+    Time.stubs(:current).returns('Sat, 20 Apr 2013 20:58:55 UTC +00:00')
+    @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
+    begin
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @exception = e
+      @mail = @email_notifier.create_email(@exception, {:env => request.env, :data => {:message => 'My Custom Message'}})
+    end
+  end
+
+  test "should have raised an exception" do
+    refute_nil @exception
+  end
+
+  test "should have generated a notification email" do
+    refute_nil @mail
+  end
+
+  test "mail should be plain text and UTF-8 enconded by default" do
+    assert_equal @mail.content_type, "text/plain; charset=UTF-8"
+  end
+
+  test "mail should have a from address set" do
+    assert_equal @mail.from, ["dummynotifier@example.com"]
+  end
+
+  test "mail should have a to address set" do
+    assert_equal @mail.to, ["dummyexceptions@example.com"]
+  end
+
+  test "mail subject should have the proper prefix" do
+    assert_includes @mail.subject, "[Dummy ERROR]"
+  end
+
+  test "mail subject should include descriptive error message" do
+    assert_includes @mail.subject, "(NoMethodError) \"undefined method `nw'"
+  end
+
+  test "mail should contain backtrace in body" do
+    assert_includes @mail.encoded, "`method_missing'\r\n  app/controllers/posts_controller.rb:18:in `create'\r\n"
+  end
+
+  test "mail should contain timestamp of exception in body" do
+    assert_includes @mail.encoded, "Timestamp  : #{Time.current}"
+  end
+
+  test "mail should contain the newly defined section" do
+    assert_includes @mail.encoded, "* New text section for testing"
+  end
+
+  test "mail should contain the custom message" do
+    assert_includes @mail.encoded, "My Custom Message"
+  end
+
+  test "should filter sensible data" do
+    assert_includes @mail.encoded, "secret\"=>\"[FILTERED]"
+  end
+
+  test "mail should contain the custom header" do
+    assert_includes @mail.encoded, 'X-Custom-Header: foobar'
+  end
+
+  test "mail should not contain any attachments" do
+    assert_equal @mail.attachments, []
+  end
+
+  test "should not send notification if one of ignored exceptions" do
+    begin
+      get :show, :id => @post.to_param + "10"
+    rescue => e
+      @ignored_exception = e
+      unless ExceptionNotifier.ignored_exceptions.include?(@ignored_exception.class.name)
+        @ignored_mail = @email_notifier.create_email(@ignored_exception, {:env => request.env})
+      end
+    end
+
+    assert_equal @ignored_exception.class.inspect, "ActiveRecord::RecordNotFound"
+    assert_nil @ignored_mail
+  end
+
+  test "should filter session_id on secure requests" do
+    request.env['HTTPS'] = 'on'
+    begin
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @secured_mail = @email_notifier.create_email(e, {:env => request.env})
+    end
+
+    assert request.ssl?
+    assert_includes @secured_mail.encoded, "* session id: [FILTERED]\r\n  *"
+  end
+
+  test "should ignore exception if from unwanted crawler" do
+    request.env['HTTP_USER_AGENT'] = "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)"
+    begin
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @exception = e
+      custom_env = request.env
+      custom_env['exception_notifier.options'] ||= {}
+      custom_env['exception_notifier.options'].merge!(:ignore_crawlers => %w(Googlebot))
+      ignore_array = custom_env['exception_notifier.options'][:ignore_crawlers]
+      unless ExceptionNotification::Rack.new(Dummy::Application, custom_env['exception_notifier.options']).send(:from_crawler, custom_env, ignore_array)
+        @ignored_mail = @email_notifier.create_email(@exception, {:env => custom_env})
+      end
+    end
+
+    assert_nil @ignored_mail
+  end
+
+  test "should send html email when selected html format" do
+    begin
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @exception = e
+      custom_env = request.env
+      custom_env['exception_notifier.options'] ||= {}
+      custom_env['exception_notifier.options'].merge!({:email_format => :html})
+      @mail = @email_notifier.create_email(@exception, {:env => custom_env})
+    end
+
+    assert_includes @mail.content_type, "multipart/alternative"
+  end
+end
+
+class PostsControllerTestWithoutVerboseSubject < ActionController::TestCase
+  tests PostsController
+  setup do
+    @email_notifier = ExceptionNotifier::EmailNotifier.new(:verbose_subject => false)
+    begin
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @exception = e
+      @mail = @email_notifier.create_email(@exception, {:env => request.env})
+    end
+  end
+
+  test "should not include exception message in subject" do
+    assert_equal "[ERROR] # (NoMethodError)", @mail.subject
+  end
+end
+
+class PostsControllerTestWithSmtpSettings < ActionController::TestCase
+  tests PostsController
+  setup do
+    @email_notifier = ExceptionNotifier::EmailNotifier.new(:smtp_settings => {
+      :user_name => "Dummy user_name",
+      :password => "Dummy password"
+    })
+
+    begin
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @exception = e
+      @mail = @email_notifier.create_email(@exception, {:env => request.env})
+    end
+  end
+
+  test "should have overridden smtp settings" do
+    assert_equal "Dummy user_name", @mail.delivery_method.settings[:user_name]
+    assert_equal "Dummy password", @mail.delivery_method.settings[:password]
+  end
+
+  test "should have overridden smtp settings with background notification" do
+    @mail = @email_notifier.create_email(@exception)
+    assert_equal "Dummy user_name", @mail.delivery_method.settings[:user_name]
+    assert_equal "Dummy password", @mail.delivery_method.settings[:password]
+  end
+end
+
+class PostsControllerTestBadRequestData < ActionController::TestCase
+  tests PostsController
+  setup do
+    @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
+    begin
+      # This might seem synthetic, but the point is that the data used by
+      # ExceptionNotification could be rendered "invalid" by e.g. a badly
+      # behaving middleware, and we want to test that ExceptionNotification
+      # still manages to send off an email in those cases.
+      #
+      # The trick here is to trigger an exception in the template used by
+      # ExceptionNotification. (The original test stuffed request.env with
+      # badly encoded strings, but that only works in Ruby 1.9+.)
+      request.send :instance_variable_set, :@env, {}
+
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @exception = e
+      @mail = @email_notifier.create_email(@exception, {:env => request.env})
+    end
+  end
+
+  test "should include error message in body" do
+    assert_match /ERROR: Failed to generate exception summary/, @mail.encoded.to_s
+  end
+end
+
+class PostsControllerTestBackgroundNotification < ActionController::TestCase
+  tests PostsController
+  setup do
+    @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
+    begin
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => exception
+      @mail = @email_notifier.create_email(exception)
+    end
+  end
+
+  test "mail should contain the specified section" do
+    assert_includes @mail.encoded, "* New background section for testing"
+  end
+end