RubyGems - exception_notification - Versions diffs - 2.6.1 → 3.0.0.rc1 - Mend

exception_notification 2.6.1 → 3.0.0.rc1

Files changed (30) hide show

data/lib/exception_notifier/views/exception_notifier/_backtrace.html.erb ADDED

	@@ -0,0 +1 @@
1	+ <%= raw @backtrace.join("\n") %>

data/lib/exception_notifier/views/exception_notifier/_data.html.erb ADDED

	@@ -0,0 +1 @@
1	+ * data: <%= raw PP.pp(@data, "") %>

data/lib/exception_notifier/views/exception_notifier/_environment.html.erb ADDED

@@ -0,0 +1,8 @@
+<% filtered_env = @request.filtered_env -%>
+<% max = filtered_env.keys.map(&:to_s).max { |a, b| a.length <=> b.length } -%>
+<% filtered_env.keys.map(&:to_s).sort.each do |key| -%>
+* <%= raw("%-*s: %s" % [max.length, key, inspect_object(filtered_env[key])]) %>
+<% end -%>
+* Process: <%= raw $$ %>
+* Server : <%= raw `hostname`.chomp %>

data/lib/exception_notifier/views/exception_notifier/_request.html.erb ADDED

@@ -0,0 +1,5 @@
+* URL       : <%= raw @request.url %>
+* IP address: <%= raw @request.remote_ip %>
+* Parameters: <%= raw @request.filtered_parameters.inspect %>
+* Rails root: <%= raw Rails.root %>
+* Timestamp : <%= raw Time.current %>

data/lib/exception_notifier/views/exception_notifier/_session.html.erb ADDED

	@@ -0,0 +1,2 @@
1	+ * session id: <%= @request.ssl? ? "[FILTERED]" : (raw (@request.session['session_id'] \|\| @request.env["rack.session.options"][:id]).inspect.html_safe) %>
2	+ * data: <%= raw PP.pp(@request.session, "") %>

data/lib/exception_notifier/views/exception_notifier/_title.html.erb ADDED

@@ -0,0 +1,3 @@
+-------------------------------
+<%= raw title.to_s.humanize %>:
+-------------------------------

data/lib/exception_notifier/views/exception_notifier/background_exception_notification.html.erb ADDED

@@ -0,0 +1,26 @@
+<!DOCTYPE HTML>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Exception</title>
+  </head>
+  <body>
+    <pre style="font-size: 12px">
+<%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in background at <%= raw Time.current %> :
+<%= @exception.message %>
+<%= @backtrace.first %>
+<%
+    sections = @sections.map do |section|
+      summary = render(section).strip
+      unless summary.blank?
+        title = render("title", :title => section).strip
+        "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
+      end
+    end.join
+    sections = sections.force_encoding('UTF-8').encode('UTF-16', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
+%>
+<%= raw sections %>
+    </pre>
+  </body>
+</html>

data/lib/exception_notifier/views/exception_notifier/background_exception_notification.text.erb CHANGED

@@ -1,4 +1,4 @@
-A <%= @exception.class %> occurred in background at <%= raw Time.current %> :
+<%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in background at <%= raw Time.current %> :
   <%= @exception.message %>
   <%= @backtrace.first %>
@@ -9,5 +9,7 @@ A <%= @exception.class %> occurred in background at <%= raw Time.current %> :
           title = render("title", :title => section).strip
           "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
         end
-      end %>
-  <%= raw sections.join %>
+      end.join
+      sections = sections.force_encoding('UTF-8').encode('UTF-16', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
+  %>
+  <%= raw sections %>

data/lib/exception_notifier/views/exception_notifier/exception_notification.html.erb ADDED

@@ -0,0 +1,36 @@
+<!DOCTYPE HTML>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Exception</title>
+  </head>
+  <body>
+    <pre style="font-size: 12px">
+<%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in <%= @kontroller.controller_name %>#<%= @kontroller.action_name %>:
+<%= raw @exception.message %>
+<%= raw @backtrace.first %>
+<%
+    sections = @sections.map do |section|
+      begin
+        summary = render(section).strip
+        unless summary.blank?
+          title = render("title", :title => section).strip
+          "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
+        end
+      rescue Exception => e
+        title = render("title", :title => section).strip
+        summary = ["ERROR: Failed to generate exception summary:", [e.class.to_s, e.message].join(": "), e.backtrace && e.backtrace.join("\n")].compact.join("\n\n")
+        [title, summary.gsub(/^/, "  "), nil].join("\n\n")
+      end
+    end.join
+    sections = sections.force_encoding('UTF-8').encode('UTF-16', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
+%>
+<%= raw sections %>
+  </pre>
+  </body>
+</html>

data/lib/exception_notifier/views/exception_notifier/exception_notification.text.erb CHANGED

@@ -1,4 +1,4 @@
-A <%= @exception.class %> occurred in <%= @kontroller.controller_name %>#<%= @kontroller.action_name %>:
+<%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in <%= @kontroller.controller_name %>#<%= @kontroller.action_name %>:
   <%= raw @exception.message %>
   <%= raw @backtrace.first %>
@@ -18,7 +18,8 @@ A <%= @exception.class %> occurred in <%= @kontroller.controller_name %>#<%= @ko
         [title, summary.gsub(/^/, "  "), nil].join("\n\n")
       end
-    end
+    end.join
+    sections = sections.force_encoding('UTF-8').encode('UTF-16', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
 %>
-<%= raw sections.join %>
+<%= raw sections %>

data/test/background_exception_notification_test.rb CHANGED

@@ -12,6 +12,10 @@ class BackgroundExceptionNotificationTest < ActiveSupport::TestCase
     end
   end
+  test "mail should be plain text and UTF-8 enconded by default" do
+    assert @mail.content_type == "text/plain; charset=UTF-8"
+  end
   test "should have raised an exception" do
     assert_not_nil @exception
   end
@@ -33,18 +37,29 @@ class BackgroundExceptionNotificationTest < ActiveSupport::TestCase
   end
   test "mail should say exception was raised in background at show timestamp" do
-    assert @mail.body.include? "A ZeroDivisionError occurred in background at #{@time}"
+    assert @mail.encoded.include? "A ZeroDivisionError occurred in background at #{@time}"
+  end
+  test "mail should prefix exception class with 'an' instead of 'a' when it starts with a vowel" do
+    begin
+      raise ActiveRecord::RecordNotFound
+    rescue => e
+      @vowel_exception = e
+      @vowel_mail = ExceptionNotifier::Notifier.background_exception_notification(@vowel_exception)
+    end
+    assert @vowel_mail.encoded.include? "An ActiveRecord::RecordNotFound occurred in background at #{@time}"
   end
   test "mail should contain backtrace in body" do
-    assert @mail.body.include? "test/background_exception_notification_test.rb:6"
+    assert @mail.encoded.include?("test/background_exception_notification_test.rb:6"), "\n#{@mail.inspect}"
   end
   test "mail should contain data in body" do
-    assert @mail.body.include? '* data:'
-    assert @mail.body.include? ':payload=>"1/0"'
-    assert @mail.body.include? ':job=>"DivideWorkerJob"'
-    assert @mail.body.include? "My Custom Message"
+    assert @mail.encoded.include? '* data:'
+    assert @mail.encoded.include? ':payload=>"1/0"'
+    assert @mail.encoded.include? ':job=>"DivideWorkerJob"'
+    assert @mail.encoded.include? "My Custom Message"
   end
   test "mail should not contain any attachments" do

data/test/campfire_test.rb ADDED

@@ -0,0 +1,52 @@
+require 'test_helper'
+class CampfireNotifierTest < ActiveSupport::TestCase
+  test "should send campfire notification if properly configured" do
+    ExceptionNotifier::CampfireNotifier.stubs(:new).returns(Object.new)
+    campfire = ExceptionNotifier::CampfireNotifier.new({:subdomain => 'test', :token => 'test_token', :room_name => 'test_room'})
+    campfire.stubs(:exception_notification).returns(fake_notification)
+    notif = campfire.exception_notification(fake_exception)
+    assert !notif[:message].empty?
+    assert_equal notif[:message][:type], 'PasteMessage'
+    assert notif[:message][:body].include? "A new exception occurred:"
+    assert notif[:message][:body].include? "divided by 0"
+    assert notif[:message][:body].include? "/exception_notification/test/campfire_test.rb:45"
+  end
+  test "should not send campfire notification if badly configured" do
+    wrong_params = {:subdomain => 'test', :token => 'bad_token', :room_name => 'test_room'}
+    Tinder::Campfire.stubs(:new).with('test', {:token => 'bad_token'}).returns(nil)
+    campfire = ExceptionNotifier::CampfireNotifier.new(wrong_params)
+    assert_nil campfire.room
+    assert_nil campfire.exception_notification(fake_exception)
+  end
+  test "should not send campfire notification if config attr missing" do
+    wrong_params  = {:subdomain => 'test', :room_name => 'test_room'}
+    Tinder::Campfire.stubs(:new).with('test', {}).returns(nil)
+    campfire = ExceptionNotifier::CampfireNotifier.new(wrong_params)
+    assert_nil campfire.room
+    assert_nil campfire.exception_notification(fake_exception)
+  end
+  private
+  def fake_notification
+    {:message => {:type => 'PasteMessage',
+                  :body => "A new exception occurred: 'divided by 0' on '/Users/sebastian/exception_notification/test/campfire_test.rb:45:in `/'"
+                 }
+    }
+  end
+  def fake_exception
+    exception = begin
+      5/0
+    rescue Exception => e
+      e
+    end
+  end
+end

data/test/dummy/Gemfile CHANGED

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
-gem 'rails', '3.0.9'
+gem 'rails', '3.2.8'
 # Bundle edge Rails instead:
 # gem 'rails', :git => 'git://github.com/rails/rails.git'

data/test/dummy/Gemfile.lock CHANGED

@@ -1,83 +1,118 @@
 PATH
   remote: ../../..
   specs:
-    exception_notification (2.5.2)
+    exception_notification (2.6.1)
       actionmailer (>= 3.0.4)
+      tinder (~> 1.8)
 GEM
   remote: http://rubygems.org/
   specs:
-    abstract (1.0.0)
-    actionmailer (3.0.9)
-      actionpack (= 3.0.9)
-      mail (~> 2.2.19)
-    actionpack (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-      arel (~> 2.0.10)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-    activesupport (3.0.9)
-    arel (2.0.10)
-    builder (2.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    i18n (0.5.0)
-    mail (2.2.19)
-      activesupport (>= 2.3.6)
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.2)
+    erubis (2.7.0)
+    eventmachine (1.0.0)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.8.8)
+      faraday (>= 0.7.4, < 0.9)
+    hashie (1.2.0)
+    hike (1.2.1)
+    http_parser.rb (0.5.3)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.5)
+    mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
-    polyglot (0.3.2)
-    rack (1.2.3)
-    rack-mount (0.6.14)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    multipart-post (1.1.5)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.0.9)
-      actionmailer (= 3.0.9)
-      actionpack (= 3.0.9)
-      activerecord (= 3.0.9)
-      activeresource (= 3.0.9)
-      activesupport (= 3.0.9)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
       bundler (~> 1.0)
-      railties (= 3.0.9)
-    railties (3.0.9)
-      actionpack (= 3.0.9)
-      activesupport (= 3.0.9)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
-      thor (~> 0.14.4)
-    rake (0.9.2)
-    rdoc (3.8)
-    sqlite3 (1.3.4)
-    thor (0.14.6)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    simple_oauth (0.1.9)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.16.0)
+    tilt (1.3.3)
+    tinder (1.9.1)
+      eventmachine (>= 0.12.0, < 2)
+      faraday (~> 0.8)
+      faraday_middleware (~> 0.8)
+      hashie (~> 1.0)
+      json (~> 1.6)
+      mime-types (~> 1.16)
+      multi_json (~> 1.0)
+      multipart-post (~> 1.1)
+      twitter-stream (~> 0.1)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.29)
+    twitter-stream (0.1.16)
+      eventmachine (>= 0.12.8)
+      http_parser.rb (~> 0.5.1)
+      simple_oauth (~> 0.1.4)
+    tzinfo (0.3.33)
 PLATFORMS
   ruby
 DEPENDENCIES
   exception_notification!
-  rails (= 3.0.9)
+  rails (= 3.2.8)
   sqlite3

data/test/dummy/app/controllers/posts_controller.rb CHANGED

@@ -13,6 +13,7 @@ class PostsController < ApplicationController
   # POST /posts
   # POST /posts.xml
   def create
+    @sections = Object.new
     # Have this line raise an exception
     @post = Post.nw(params[:post])

data/test/dummy/app/views/exception_notifier/_new_bkg_section.html.erb ADDED

	@@ -0,0 +1 @@
1	+ * New background section for testing

data/test/dummy/app/views/exception_notifier/_new_section.html.erb ADDED

	@@ -0,0 +1 @@
1	+ * New html section for testing

data/test/dummy/app/views/exception_notifier/_new_section.text.erb CHANGED

	@@ -1 +1 @@
1	- * New section for testing
1	+ * New text section for testing

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

@@ -19,6 +19,10 @@ class PostsControllerTest < ActionController::TestCase
     assert_not_nil @mail
   end
+  test "mail should be plain text and UTF-8 enconded by default" do
+    assert @mail.content_type == "text/plain; charset=UTF-8"
+  end
   test "mail should have a from address set" do
     assert @mail.from == ["dummynotifier@example.com"]
   end
@@ -27,28 +31,32 @@ class PostsControllerTest < ActionController::TestCase
     assert @mail.to == ["dummyexceptions@example.com"]
   end
-  test "mail should have a descriptive subject" do
-    assert @mail.subject.include? "[Dummy ERROR] # (NoMethodError) \"undefined method `nw'"
+  test "mail subject should have the proper prefix" do
+    assert @mail.subject.include? "[Dummy ERROR]"
+  end
+  test "mail subject should include descriptive error message" do
+    assert @mail.subject.include? "(NoMethodError) \"undefined method `nw'"
   end
   test "mail should contain backtrace in body" do
-    assert @mail.body.include? "`method_missing'\n  app/controllers/posts_controller.rb:17:in `create'\n"
+    assert @mail.encoded.include? "`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 @mail.body.include? "Timestamp : #{Time.current}"
+    assert @mail.encoded.include? "Timestamp : #{Time.current}"
   end
   test "mail should contain the newly defined section" do
-    assert @mail.body.include? "* New section for testing"
+    assert @mail.encoded.include? "* New text section for testing"
   end
   test "mail should contain the custom message" do
-    assert @mail.body.include? "My Custom Message"
+    assert @mail.encoded.include? "My Custom Message"
   end
   test "should filter sensible data" do
-    assert @mail.body.include? "secret\"=>\"[FILTERED]"
+    assert @mail.encoded.include? "secret\"=>\"[FILTERED]"
   end
   test "mail should not contain any attachments" do
@@ -79,7 +87,7 @@ class PostsControllerTest < ActionController::TestCase
     end
     assert request.ssl?
-    assert @secured_mail.body.include? "* session id: [FILTERED]\n  *"
+    assert @secured_mail.encoded.include? "* session id: [FILTERED]\r\n  *"
   end
   test "should ignore exception if from unwanted cralwer" do
@@ -119,6 +127,21 @@ class PostsControllerTest < ActionController::TestCase
     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 = ExceptionNotifier::Notifier.exception_notification(custom_env, @exception)
+    end
+    assert @mail.content_type.include? "multipart/alternative"
+  end
 end
 class PostsControllerTestWithoutVerboseSubject < ActionController::TestCase
@@ -139,6 +162,35 @@ class PostsControllerTestWithoutVerboseSubject < ActionController::TestCase
   end
 end
+class PostsControllerTestWithSmtpSettings < ActionController::TestCase
+  tests PostsController
+  setup do
+    ExceptionNotifier::Notifier.default_smtp_settings = {
+      :user_name => "Dummy user_name",
+      :password => "Dummy password"
+    }
+    begin
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @exception = e
+      @mail = ExceptionNotifier::Notifier.exception_notification(request.env, @exception)
+    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 = ExceptionNotifier::Notifier.background_exception_notification(@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
@@ -162,7 +214,7 @@ class PostsControllerTestBadRequestData < ActionController::TestCase
   end
   test "should include error message in body" do
-    assert_match /ERROR: Failed to generate exception summary/, @mail.body.to_s
+    assert_match /ERROR: Failed to generate exception summary/, @mail.encoded.to_s
   end
 end
@@ -178,6 +230,6 @@ class PostsControllerTestBackgroundNotification < ActionController::TestCase
   end
   test "mail should contain the specified section" do
-    assert @mail.body.include? "* New background section for testing"
+    assert @mail.encoded.include? "* New background section for testing"
   end
 end