RubyGems - exception_notification - Versions diffs - 3.0.1 → 4.0.0.rc1 - Mend

exception_notification 3.0.1 → 4.0.0.rc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (55) hide show

data/.gitignore +2 -0
data/.travis.yml +9 -0
data/Appraisals +11 -0
data/CHANGELOG.rdoc +21 -0
data/Gemfile +1 -1
data/Gemfile.lock +49 -7
data/README.md +417 -184
data/Rakefile +4 -2
data/examples/sinatra/Gemfile +8 -0
data/examples/sinatra/Gemfile.lock +95 -0
data/examples/sinatra/Procfile +2 -0
data/examples/sinatra/README.md +11 -0
data/examples/sinatra/config.ru +3 -0
data/examples/sinatra/sinatra_app.rb +28 -0
data/exception_notification.gemspec +10 -4
data/gemfiles/rails3_1.gemfile +7 -0
data/gemfiles/rails3_2.gemfile +7 -0
data/gemfiles/rails4_0.gemfile +7 -0
data/lib/exception_notification.rb +10 -0
data/lib/exception_notification/rack.rb +45 -0
data/lib/exception_notification/rails.rb +8 -0
data/lib/exception_notification/resque.rb +24 -0
data/lib/exception_notification/sidekiq.rb +22 -0
data/lib/exception_notifier.rb +89 -61
data/lib/exception_notifier/campfire_notifier.rb +2 -7
data/lib/exception_notifier/email_notifier.rb +181 -0
data/lib/exception_notifier/notifier.rb +9 -178
data/lib/exception_notifier/views/exception_notifier/_backtrace.html.erb +3 -1
data/lib/exception_notifier/views/exception_notifier/_data.html.erb +6 -1
data/lib/exception_notifier/views/exception_notifier/_environment.html.erb +16 -6
data/lib/exception_notifier/views/exception_notifier/_environment.text.erb +1 -1
data/lib/exception_notifier/views/exception_notifier/_request.html.erb +24 -5
data/lib/exception_notifier/views/exception_notifier/_request.text.erb +2 -0
data/lib/exception_notifier/views/exception_notifier/_session.html.erb +10 -2
data/lib/exception_notifier/views/exception_notifier/_session.text.erb +1 -1
data/lib/exception_notifier/views/exception_notifier/_title.html.erb +3 -3
data/lib/exception_notifier/views/exception_notifier/background_exception_notification.html.erb +38 -11
data/lib/exception_notifier/views/exception_notifier/background_exception_notification.text.erb +0 -1
data/lib/exception_notifier/views/exception_notifier/exception_notification.html.erb +39 -21
data/lib/exception_notifier/views/exception_notifier/exception_notification.text.erb +0 -1
data/lib/exception_notifier/webhook_notifier.rb +21 -0
data/lib/generators/exception_notification/install_generator.rb +15 -0
data/lib/generators/exception_notification/templates/exception_notification.rb +47 -0
data/test/dummy/Gemfile +2 -1
data/test/dummy/Gemfile.lock +79 -78
data/test/dummy/config/environment.rb +9 -7
data/test/dummy/test/functional/posts_controller_test.rb +22 -37
data/test/{campfire_test.rb → exception_notifier/campfire_notifier_test.rb} +4 -4
data/test/exception_notifier/email_notifier_test.rb +144 -0
data/test/exception_notifier/webhook_notifier_test.rb +41 -0
data/test/exception_notifier_test.rb +101 -0
data/test/test_helper.rb +4 -1
metadata +136 -18
data/test/background_exception_notification_test.rb +0 -82
data/test/exception_notification_test.rb +0 -73

data/lib/exception_notifier/views/exception_notifier/_request.html.erb CHANGED Viewed

@@ -1,5 +1,24 @@
-* 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 %>
+<ul style="list-style: none">
+  <li>
+    <strong>URL:</strong>
+    <span><%= raw @request.url %></span>
+  </li>
+  <li>
+    <strong>IP Address:</strong>
+    <span><%= raw @request.remote_ip %></span>
+  </li>
+  <li>
+    <strong>Parameters:</strong>
+    <span><%= raw @request.filtered_parameters.inspect %></span>
+  </li>
+  <% if defined?(Rails) %>
+    <li>
+      <strong>Rails root:</strong>
+      <span><%= raw Rails.root %></span>
+    </li>
+  <% end %>
+  <li>
+    <strong>Timestamp:</strong>
+    <span><%= raw Time.current %></span>
+  </li>
+</ul>

data/lib/exception_notifier/views/exception_notifier/_request.text.erb CHANGED Viewed

@@ -1,5 +1,7 @@
 * URL       : <%= raw @request.url %>
 * IP address: <%= raw @request.remote_ip %>
 * Parameters: <%= raw @request.filtered_parameters.inspect %>
+<% if defined?(Rails) %>
 * Rails root: <%= raw Rails.root %>
+<% end %>
 * Timestamp : <%= raw Time.current %>

data/lib/exception_notifier/views/exception_notifier/_session.html.erb CHANGED Viewed

@@ -1,2 +1,10 @@
-* session id: <%= @request.ssl? ? "[FILTERED]" : (raw (@request.session['session_id'] || @request.env["rack.session.options"][:id]).inspect.html_safe) %>
-* data: <%= raw PP.pp(@request.session, "") %>
+<ul style="list-style: none">
+  <li>
+    <strong>session_id: </strong>
+    <span><%= @request.ssl? ? "[FILTERED]" : (raw (@request.session['session_id'] || (@request.env["rack.session.options"] and @request.env["rack.session.options"][:id])).inspect.html_safe) %></span>
+  </li>
+  <li>
+    <strong>data: </strong>
+    <span><%= raw PP.pp(@request.session, "") %></span>
+  </li>
+</ul>

data/lib/exception_notifier/views/exception_notifier/_session.text.erb CHANGED Viewed

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

data/lib/exception_notifier/views/exception_notifier/_title.html.erb CHANGED Viewed

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

data/lib/exception_notifier/views/exception_notifier/background_exception_notification.html.erb CHANGED Viewed

@@ -5,22 +5,49 @@
     <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|
+<%
+  sections_content = @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"
+        [title, summary]
       end
-    end.join
-    sections = sections.force_encoding('UTF-8').encode('UTF-16LE', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
+    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]
+    end
+  end
 %>
-<%= raw sections %>
-    </pre>
+<table width="100%" border="0" cellpadding="0" cellspacing="0">
+  <tr><td align="center" valign="top">
+    <table width="650" border="0" cellpadding="0" cellspacing="20">
+      <tr>
+        <td style="padding: 10px; border: 1px solid #eed3d7; background-color: #f2dede">
+          <h3 style="color: #b94a48">
+            <%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in background at <%= raw Time.current %> :
+          </h3>
+          <p style="color: #b94a48"><%= raw @exception.message %></p>
+          <pre style="font-size: 12px; padding: 5px; background-color:#f5f5f5">
+            <%= raw @backtrace.first %>
+          </pre>
+        </td>
+      </tr>
+      <% sections_content.each do |title, summary| %>
+        <tr>
+          <td style="border-bottom: 1px solid #eeeeee;"><%= raw title %></td>
+        </tr>
+        <tr>
+          <td><%= raw summary %></td>
+        </tr>
+      <% end %>
+    </table>
+  </td></tr>
+</table>
   </body>
 </html>

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

@@ -10,6 +10,5 @@
           "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
         end
       end.join
-      sections = sections.force_encoding('UTF-8').encode('UTF-16LE', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
   %>
   <%= raw sections %>

data/lib/exception_notifier/views/exception_notifier/exception_notification.html.erb CHANGED Viewed

@@ -5,32 +5,50 @@
     <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
+  sections_content = @sections.map do |section|
+    begin
+      summary = render(section).strip
+      unless summary.blank?
         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")
+        [title, summary]
       end
-    end.join
-    sections = sections.force_encoding('UTF-8').encode('UTF-16LE', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
+    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]
+    end
+  end
 %>
-<%= raw sections %>
-  </pre>
+<table width="100%" border="0" cellpadding="0" cellspacing="0">
+  <tr><td align="center" valign="top">
+    <table width="650" border="0" cellpadding="0" cellspacing="20">
+      <tr>
+        <td style="padding: 10px; border: 1px solid #eed3d7; background-color: #f2dede">
+          <h3 style="color: #b94a48">
+            <%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in <%= @kontroller.controller_name %>#<%= @kontroller.action_name %>:
+          </h3>
+          <p style="color: #b94a48"><%= raw @exception.message %></p>
+          <pre style="font-size: 12px; padding: 5px; background-color:#f5f5f5">
+            <%= raw @backtrace.first %>
+          </pre>
+        </td>
+      </tr>
+      <% sections_content.each do |title, summary| %>
+        <tr>
+          <td style="border-bottom: 1px solid #eeeeee;"><%= raw title %></td>
+        </tr>
+        <tr>
+          <td><%= raw summary %></td>
+        </tr>
+      <% end %>
+    </table>
+  </td></tr>
+</table>
   </body>
 </html>

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

@@ -19,7 +19,6 @@
         [title, summary.gsub(/^/, "  "), nil].join("\n\n")
       end
     end.join
-    sections = sections.force_encoding('UTF-8').encode('UTF-16LE', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
 %>
 <%= raw sections %>

data/lib/exception_notifier/webhook_notifier.rb ADDED Viewed

@@ -0,0 +1,21 @@
+module ExceptionNotifier
+  class WebhookNotifier
+    def initialize(options)
+      @default_options = options
+    end
+    def call(exception, options={})
+      options = options.reverse_merge(@default_options)
+      url = options.delete(:url)
+      http_method = options.delete(:http_method) || :post
+      options[:body] ||= {}
+      options[:body][:exception] = {:error_class => exception.class.to_s,
+                                    :message => exception.message.inspect,
+                                    :backtrace => exception.backtrace}
+      HTTParty.send(http_method, url, options)
+    end
+  end
+end

data/lib/generators/exception_notification/install_generator.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module ExceptionNotification
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Creates a ExceptionNotification initializer."
+      source_root File.expand_path('../templates', __FILE__)
+      class_option :resque, :type => :boolean, :desc => 'Add support for sending notifications when errors occur in Resque jobs.'
+      class_option :sidekiq, :type => :boolean, :desc => 'Add support for sending notifications when errors occur in Sidekiq jobs.'
+      def copy_initializer
+        template 'exception_notification.rb', 'config/initializers/exception_notification.rb'
+      end
+    end
+  end
+end

data/lib/generators/exception_notification/templates/exception_notification.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require 'exception_notification/rails'
+<% if options.sidekiq? %>
+require 'exception_notification/sidekiq'
+<% end %>
+<% if options.resque? %>
+require 'resque/failure/multiple'
+require 'resque/failure/redis'
+require 'exception_notification/resque'
+Resque::Failure::Multiple.classes = [Resque::Failure::Redis, ExceptionNotification::Resque]
+Resque::Failure.backend = Resque::Failure::Multiple
+<% end %>
+ExceptionNotification.configure do |config|
+  # Ignore additional exception types.
+  # ActiveRecord::RecordNotFound, AbstractController::ActionNotFound and ActionController::RoutingError are already added.
+  # config.ignored_exceptions += %w{ActionView::TemplateError CustomError}
+  # Adds a condition to decide when an exception must be ignored or not.
+  # The ignore_if method can be invoked multiple times to add extra conditions.
+  # config.ignore_if do |exception, options|
+  #   not Rails.env.production?
+  # end
+  # Notifiers =================================================================
+  # Email notifier sends notifications by email.
+  config.add_notifier :email, {
+    :email_prefix         => "[ERROR] ",
+    :sender_address       => %{"Notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+  }
+  # Campfire notifier sends notifications to your Campfire room. Requires 'tinder' gem.
+  # config.add_notifier :campfire, {
+  #   :subdomain => 'my_subdomain',
+  #   :token => 'my_token',
+  #   :room_name => 'my_room'
+  # }
+  # Webhook notifier sends notifications over HTTP protocol. Requires 'httparty' gem.
+  # config.add_notifier :webhook, {
+  #   :url => 'http://example.com:5555/hubot/path',
+  #   :http_method => :post
+  # }
+end

data/test/dummy/Gemfile CHANGED Viewed

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
-gem 'rails', '3.2.8'
+gem 'rails', '4.0.0.rc2'
 # Bundle edge Rails instead:
 # gem 'rails', :git => 'git://github.com/rails/rails.git'
@@ -8,6 +8,7 @@ gem 'rails', '3.2.8'
 gem 'sqlite3'
 gem 'tinder'
+gem 'httparty'
 gem 'exception_notification', :path => "../../.."
 # Use unicorn as the web server
 # gem 'unicorn'

data/test/dummy/Gemfile.lock CHANGED Viewed

@@ -1,118 +1,119 @@
 PATH
   remote: ../../..
   specs:
-    exception_notification (3.0.0)
+    exception_notification (3.0.1)
       actionmailer (>= 3.0.4)
+      activesupport (>= 3.0.4)
 GEM
   remote: http://rubygems.org/
   specs:
-    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)
+    actionmailer (4.0.0.rc2)
+      actionpack (= 4.0.0.rc2)
+      mail (~> 2.5.3)
+    actionpack (4.0.0.rc2)
+      activesupport (= 4.0.0.rc2)
+      builder (~> 3.1.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)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0.rc2)
+      activesupport (= 4.0.0.rc2)
+      builder (~> 3.1.0)
+    activerecord (4.0.0.rc2)
+      activemodel (= 4.0.0.rc2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0.rc2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0.rc2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.0)
+    atomic (1.1.9)
+    builder (3.1.4)
     erubis (2.7.0)
-    eventmachine (1.0.0)
-    faraday (0.8.4)
+    eventmachine (1.0.3)
+    faraday (0.8.7)
       multipart-post (~> 1.1)
-    faraday_middleware (0.8.8)
+    faraday_middleware (0.9.0)
       faraday (>= 0.7.4, < 0.9)
     hashie (1.2.0)
-    hike (1.2.1)
+    hike (1.2.3)
     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)
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.4)
+    json (1.7.7)
+    mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.3.6)
-    multipart-post (1.1.5)
+    mime-types (1.23)
+    minitest (4.7.4)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    multipart-post (1.2.0)
     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.5.2)
+    rack-test (0.6.2)
       rack (>= 1.0)
-    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.2.8)
-    railties (3.2.8)
-      actionpack (= 3.2.8)
-      activesupport (= 3.2.8)
-      rack-ssl (~> 1.3.2)
+    rails (4.0.0.rc2)
+      actionmailer (= 4.0.0.rc2)
+      actionpack (= 4.0.0.rc2)
+      activerecord (= 4.0.0.rc2)
+      activesupport (= 4.0.0.rc2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0.rc2)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.0.rc2)
+      actionpack (= 4.0.0.rc2)
+      activesupport (= 4.0.0.rc2)
       rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.0.4)
     simple_oauth (0.1.9)
-    sprockets (2.1.3)
+    sprockets (2.10.0)
       hike (~> 1.2)
+      multi_json (~> 1.0)
       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)
+    sprockets-rails (2.0.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.7)
+    thor (0.18.1)
+    thread_safe (0.1.0)
+      atomic
+    tilt (1.4.1)
+    tinder (1.9.2)
+      eventmachine (~> 1.0)
       faraday (~> 0.8)
-      faraday_middleware (~> 0.8)
+      faraday_middleware (~> 0.9)
       hashie (~> 1.0)
-      json (~> 1.6)
-      mime-types (~> 1.16)
-      multi_json (~> 1.0)
-      multipart-post (~> 1.1)
+      json (~> 1.7.5)
+      mime-types (~> 1.19)
+      multi_json (~> 1.5)
       twitter-stream (~> 0.1)
-    treetop (1.4.10)
+    treetop (1.4.14)
       polyglot
       polyglot (>= 0.3.1)
     twitter-stream (0.1.16)
       eventmachine (>= 0.12.8)
       http_parser.rb (~> 0.5.1)
       simple_oauth (~> 0.1.4)
-    tzinfo (0.3.33)
+    tzinfo (0.3.37)
 PLATFORMS
   ruby
 DEPENDENCIES
   exception_notification!
-  rails (= 3.2.8)
+  httparty
+  rails (= 4.0.0.rc2)
   sqlite3
   tinder