exception_notification 3.0.0 → 3.0.1.rc1

data/CHANGELOG.rdoc

@@ -1,8 +1,17 @@
+== 3.0.1
+
+* enhancements
+  * Custom Headers (by @DouweM)
+  * Make Tinder a soft-dependency (by @fgrehm)
+
+* bug fixes
+  * Fix `code converter not found` (by @alanjds)
+
 == 3.0.0
 
 * enhancements
   * Campfire integration
-  * Support fot HTML notifications (by @Xenofex)
+  * Support for HTML notifications (by @Xenofex)
   * Be able to override SMTP settings (by @piglop and @Macint)
 
 * bug fixes

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    exception_notification (3.0.0)
+    exception_notification (3.0.1.rc1)
       actionmailer (>= 3.0.4)
-      tinder (~> 1.8)
 
 GEM
   remote: http://rubygems.org/
@@ -120,3 +119,4 @@ DEPENDENCIES
   mocha (>= 0.11.3)
   rails (>= 3.0.4)
   sqlite3 (>= 1.3.4)
+  tinder (~> 1.8)

data/README.md

@@ -40,8 +40,16 @@ Campfire Integration
 
 Additionally, ExceptionNotification supports sending notifications to
 your Campfire room.
+
+First you'll need to add [tinder](https://github.com/collectiveidea/tinder)
+to your `Gemfile`:
+
+```ruby
+gem 'tinder'
+```
+
 To configure it, you need to set the subdomain, token and room name,
-like this
+like this:
 
 ```ruby
 Whatever::Application.config.middleware.use ExceptionNotifier,
@@ -90,7 +98,7 @@ Whatever::Application.config.middleware.use ExceptionNotifier,
  :sections => %w{my_section1 my_section2} + ExceptionNotifier::Notifier.default_sections
 ```
 
-Place your custom sections under `./app/views/exception_notifier/` with the suffix `.text.erb`, e.g. 
+Place your custom sections under `./app/views/exception_notifier/` with the suffix `.text.erb`, e.g.
 `./app/views/exception_notifier/_my_section1.text.erb`.
 
 If your new section requires information that isn't available by default, make sure
@@ -192,6 +200,20 @@ Whatever::Application.config.middleware.use ExceptionNotifier,
 You can make use of both the environment and the exception inside the lambda to decide wether to
 avoid or not sending the notification.
 
+### Headers
+
+Additionally, you may want to set customized headers on the outcoming
+emails. To do so, simply use the _:email_headers_ option:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotifier,
+  :email_prefix         => "[Whatever] ",
+  :sender_address       => %{"notifier" <notifier@example.com>},
+  :exception_recipients => %w{exceptions@example.com},
+  :ignore_if            => lambda { |env, e| e.message =~ /^Couldn't find Page with ID=/ },
+  :email_headers        => { "X-Custom-Header" => "foobar" }
+```
+
 ### Verbose
 
 You can also choose to exclude the exception message from the subject, which is included by default.

data/Rakefile

@@ -3,8 +3,12 @@ Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 
-unless File.exists? "test/dummy/db/test.sqlite3"
-  sh "cd test/dummy; rake db:migrate; rake db:test:prepare; cd ../../;"
+task 'setup_dummy_app' do
+  unless File.exists? "test/dummy/db/test.sqlite3"
+    Bundler.with_clean_env do
+      sh "cd test/dummy; bundle; rake db:migrate; rake db:test:prepare; cd ../../;"
+    end
+  end
 end
 
 Rake::TestTask.new(:test) do |t|
@@ -14,4 +18,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
-task :default => :test
+task :default => [:setup_dummy_app, :test]

data/exception_notification.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = 'exception_notification'
-  s.version = '3.0.0'
+  s.version = '3.0.1.rc1'
   s.authors = ["Jamis Buck", "Josh Peek"]
-  s.date = %q{2012-10-15}
+  s.date = %q{2013-01-19}
   s.summary = "Exception notification for Rails apps"
   s.homepage = "http://smartinez87.github.com/exception_notification"
   s.email = "smartinez87@gmail.com"
@@ -12,7 +12,8 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
 
   s.add_dependency("actionmailer", ">= 3.0.4")
-  s.add_dependency("tinder", "~> 1.8")
+
+  s.add_development_dependency "tinder", "~> 1.8"
   s.add_development_dependency "rails", ">= 3.0.4"
   s.add_development_dependency "mocha", ">= 0.11.3"
   s.add_development_dependency "sqlite3", ">= 1.3.4"

data/lib/exception_notifier.rb

@@ -28,6 +28,7 @@ class ExceptionNotifier
     Notifier.default_verbose_subject      = @options[:verbose_subject]
     Notifier.default_normalize_subject    = @options[:normalize_subject]
     Notifier.default_smtp_settings        = @options[:smtp_settings]
+    Notifier.default_email_headers        = @options[:email_headers]
 
     @campfire = CampfireNotifier.new @options[:campfire]
 

data/lib/exception_notifier/campfire_notifier.rb

@@ -1,6 +1,6 @@
 class ExceptionNotifier
   class CampfireNotifier
-    require 'tinder'
+    cattr_accessor :tinder_available, true
 
     attr_accessor :subdomain
     attr_accessor :token
@@ -8,6 +8,8 @@ class ExceptionNotifier
 
     def initialize(options)
       begin
+        return unless tinder_available
+
         subdomain = options.delete(:subdomain)
         room_name = options.delete(:room_name)
         @campfire = Tinder::Campfire.new subdomain, options
@@ -28,3 +30,5 @@ class ExceptionNotifier
     end
   end
 end
+
+ExceptionNotifier::CampfireNotifier.tinder_available = Gem.loaded_specs.keys.include? 'tinder'

data/lib/exception_notifier/notifier.rb

@@ -18,6 +18,7 @@ class ExceptionNotifier
       attr_writer :default_verbose_subject
       attr_writer :default_normalize_subject
       attr_writer :default_smtp_settings
+      attr_writer :default_email_headers
 
       def default_sender_address
         @default_sender_address || %("Exception Notifier" <exception.notifier@default.com>)
@@ -55,6 +56,10 @@ class ExceptionNotifier
         @default_smtp_settings || nil
       end
 
+      def default_email_headers
+        @default_email_headers || {}
+      end
+
       def default_options
         { :sender_address => default_sender_address,
           :exception_recipients => default_exception_recipients,
@@ -65,7 +70,8 @@ class ExceptionNotifier
           :verbose_subject => default_verbose_subject,
           :normalize_subject => default_normalize_subject,
           :template_path => mailer_name,
-          :smtp_settings => default_smtp_settings }
+          :smtp_settings => default_smtp_settings,
+          :email_headers => default_email_headers }
       end
 
       def normalize_digits(string)
@@ -155,8 +161,14 @@ class ExceptionNotifier
       subject = compose_subject
       name = @env.nil? ? 'background_exception_notification' : 'exception_notification'
 
-      mail = mail(:to => @options[:exception_recipients], :from => @options[:sender_address],
-           :subject => subject, :template_name => name) do |format|
+      headers = {
+        :to => @options[:exception_recipients], 
+        :from => @options[:sender_address],
+        :subject => subject, 
+        :template_name => name
+      }.merge(@options[:email_headers])
+
+      mail = mail(headers) do |format|
         format.text
         format.html if html_mail?
       end

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

@@ -18,7 +18,7 @@
         "#{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)
+    sections = sections.force_encoding('UTF-8').encode('UTF-16LE', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
 %>
 <%= raw sections %>
     </pre>

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

@@ -10,6 +10,6 @@
           "#{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)
+      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

@@ -27,7 +27,7 @@
         [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)
+    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.text.erb

@@ -19,7 +19,7 @@
         [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)
+    sections = sections.force_encoding('UTF-8').encode('UTF-16LE', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
 %>
 
 <%= raw sections %>

data/test/campfire_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'tinder'
 
 class CampfireNotifierTest < ActiveSupport::TestCase
 

data/test/dummy/Gemfile

@@ -7,6 +7,7 @@ gem 'rails', '3.2.8'
 
 gem 'sqlite3'
 
+gem 'tinder'
 gem 'exception_notification', :path => "../../.."
 # Use unicorn as the web server
 # gem 'unicorn'

data/test/dummy/Gemfile.lock

@@ -3,7 +3,6 @@ PATH
   specs:
     exception_notification (3.0.0)
       actionmailer (>= 3.0.4)
-      tinder (~> 1.8)
 
 GEM
   remote: http://rubygems.org/
@@ -116,3 +115,4 @@ DEPENDENCIES
   exception_notification!
   rails (= 3.2.8)
   sqlite3
+  tinder

data/test/dummy/config/environment.rb

@@ -5,6 +5,7 @@ Dummy::Application.config.middleware.use ExceptionNotifier,
   :email_prefix => "[Dummy ERROR] ",
   :sender_address => %{"Dummy Notifier" <dummynotifier@example.com>},
   :exception_recipients => %w{dummyexceptions@example.com},
+  :email_headers => { "X-Custom-Header" => "foobar" },
   :sections => ['new_section', 'request', 'session', 'environment', 'backtrace'],
   :background_sections => %w(new_bkg_section) + ExceptionNotifier::Notifier.default_background_sections
 

data/test/dummy/config/environments/development.rb

@@ -11,7 +11,6 @@ Dummy::Application.configure do
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
-  config.action_view.debug_rjs             = true
   config.action_controller.perform_caching = false
 
   # Don't care if the mailer can't send
@@ -23,4 +22,3 @@ Dummy::Application.configure do
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
 end
-

data/test/dummy/db/schema.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -16,8 +17,8 @@ ActiveRecord::Schema.define(:version => 20110729022608) do
     t.string   "title"
     t.text     "body"
     t.string   "secret"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
   end
 
 end

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

@@ -59,6 +59,10 @@ class PostsControllerTest < ActionController::TestCase
     assert @mail.encoded.include? "secret\"=>\"[FILTERED]"
   end
 
+  test "mail should contain the custom header" do
+    assert @mail.encoded.include? 'X-Custom-Header: foobar'
+  end
+
   test "mail should not contain any attachments" do
     assert @mail.attachments == []
   end

data/test/exception_notification_test.rb

@@ -17,6 +17,10 @@ class ExceptionNotificationTest < ActiveSupport::TestCase
     assert ExceptionNotifier::Notifier.default_email_format == :text
   end
 
+  test "should have default email headers overridden" do
+    assert ExceptionNotifier::Notifier.default_email_headers == { "X-Custom-Header" => "foobar"}
+  end
+
   test "should have default sections" do
     for section in %w(request session environment backtrace)
       assert ExceptionNotifier::Notifier.default_sections.include? section

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification
 version: !ruby/object:Gem::Version
-  version: 3.0.0
-  prerelease: 
+  version: 3.0.1.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Jamis Buck
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-15 00:00:00.000000000 Z
+date: 2013-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -36,7 +36,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -200,9 +200,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23