exception_notification 4.0.0.rc1 → 4.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exception_notification (3.0.1)
+    exception_notification (4.0.0)
       actionmailer (>= 3.0.4)
       activesupport (>= 3.0.4)
 

data/README.md

@@ -53,18 +53,42 @@ Whatever::Application.config.middleware.use ExceptionNotification::Rack,
 In order to use ExceptionNotification with Sinatra, please take a look in the [example application](https://github.com/smartinez87/exception_notification/tree/master/examples/sinatra).
 
 
+### Upgrading to 4.x version
+
+As of 4.x version the configuration syntax has changed. All email related options MUST BE nested under the `:email` key. Thus, previous configuration like:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotifier,
+  :email_prefix => "[Whatever] ",
+  :sender_address => %{"notifier" <notifier@example.com>},
+  :exception_recipients => %w{exceptions@example.com}
+```
+
+becomes:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[Whatever] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+  }
+```
+
+Beside that, the rack middlware was renamed to `ExceptionNotification::Rack`.
+
 ## Notifiers
 
 ExceptionNotification relies on notifiers to deliver notifications when errors occur in your applications. By default, three notifiers are available: [email notifier](#email-notifier), [campfire notifier](#campfire-notifier) and [webhook notifier](#webhook-notifier). But, you also can easily implement your own [custom notifier](#custom-notifier).
 
 
-## Email notifier
+### Email notifier
 
 The Email notifier sends notifications by email. The notifications/emails sent includes information about the current request, session, and environment, and also gives a backtrace of the exception.
 
 After an exception notification has been delivered the rack environment variable 'exception_notifier.delivered' will be set to true.
 
-### ActionMailer configuration
+#### ActionMailer configuration
 
 For the email to be sent, there must be a default ActionMailer `delivery_method` setting configured. If you do not have one, you can use the following code (assuming your app server machine has `sendmail`). Depending on the environment you want ExceptionNotification to run in, put the following code in your `config/environments/production.rb` and/or `config/environments/development.rb`:
 
@@ -79,30 +103,30 @@ config.action_mailer.perform_deliveries = true
 config.action_mailer.raise_delivery_errors = true
 ```
 
-### Options
+#### Options
 
-#### sender_address
+##### sender_address
 
 *String, default: %("Exception Notifier" <exception.notifier@example.com>)*
 
 Who the message is from.
 
 
-#### exception_recipients
+##### exception_recipients
 
 *String/Array of strings, default: []*
 
 Who the message is destined for, can be a string of addresses, or an array of addresses.
 
 
-#### email_prefix
+##### email_prefix
 
 *String, default: [ERROR]*
 
 The subject's prefix of the message.
 
 
-#### sections
+##### sections
 
 *Array of strings, default: %w(request session environment backtrace)*
 
@@ -152,7 +176,7 @@ end
 In the above case, `@document` and `@person` would be made available to the email renderer, allowing your new section(s) to access and display them. See the existing sections defined by the plugin for examples of how to write your own.
 
 
-#### background_sections
+##### background_sections
 
 *Array of strings, default: %w(backtrace data)*
 
@@ -169,7 +193,7 @@ Whatever::Application.config.middleware.use ExceptionNotification::Rack,
 ```
 
 
-#### email_headers
+##### email_headers
 
 *Hash os strings, default: {}*
 
@@ -186,28 +210,28 @@ Whatever::Application.config.middleware.use ExceptionNotification::Rack,
 ```
 
 
-#### verbose_subject
+##### verbose_subject
 
 *Boolean, default: true*
 
 If enabled, include the exception message in the subject. Use `:verbose_subject => false` to exclude it.
 
 
-#### normalize_subject
+##### normalize_subject
 
 *Boolean, default: false*
 
 If enabled, remove numbers from subject so they thread as a single one. Use `:normalize_subject => true` to enable it.
 
 
-#### email_format
+##### email_format
 
 *Symbol, default: :text*
 
 By default, ExceptionNotification sends emails in plain text, in order to sends multipart notifications (aka HTML emails) use `:email_format => :html`.
 
 
-#### delivery_method
+##### delivery_method
 
 *Symbol, default: :smtp*
 
@@ -243,18 +267,18 @@ Whatever::Application.config.middleware.use ExceptionNotification::Rack,
 ```
 
 
-#### mailer_parent
+##### mailer_parent
 
 *String, default: ActionMailer::Base*
 
 The parent mailer which ExceptionNotification mailer inherit from.
 
 
-## Campfire notifier
+### Campfire notifier
 
 This notifier sends notifications to your Campfire room.
 
-### Usage
+#### Usage
 
 Just add the [tinder](https://github.com/collectiveidea/tinder) gem to your `Gemfile`:
 
@@ -278,21 +302,21 @@ Whatever::Application.config.middleware.use ExceptionNotification::Rack,
   }
 ```
 
-### Options
+#### Options
 
-#### subdomain
+##### subdomain
 
 *String, required*
 
 Your subdomain at Campfire.
 
-#### room_name
+##### room_name
 
 *String, required*
 
 The Campfire room where the notifications must be published to.
 
-#### token
+##### token
 
 *String, required*
 
@@ -302,11 +326,11 @@ The API token to allow access to your Campfire account.
 For more options to set Campfire, like _ssl_, check [here](https://github.com/collectiveidea/tinder/blob/master/lib/tinder/campfire.rb#L17).
 
 
-## Webhook notifier
+### Webhook notifier
 
 This notifier ships notifications over the HTTP protocol.
 
-### Usage
+#### Usage
 
 Just add the [HTTParty](https://github.com/jnunemaker/httparty) gem to your `Gemfile`:
 
@@ -364,7 +388,7 @@ Whatever::Application.config.middleware.use ExceptionNotification::Rack,
 For more HTTParty options, check out the [documentation](https://github.com/jnunemaker/httparty).
 
 
-## Custom notifier
+### Custom notifier
 
 Simply put, notifiers are objects which respond to `#call(exception, options)` method. Thus, a lambda can be used as a notifier as follow:
 
@@ -375,7 +399,7 @@ ExceptionNotifier.add_notifier :custom_notifier_name,
 
 More advanced users or third-party framework developers, also can create notifiers to be shipped in gems and take advantage of ExceptionNotification's Notifier API to standardize the [various](https://github.com/airbrake/airbrake) [solutions](https://www.honeybadger.io) [out](http://www.exceptional.io) [there](https://bugsnag.com). For this, beyond the `#call(exception, options)` method, the notifier class MUST BE defined under the ExceptionNotifier namespace and its name sufixed by `Notifier`, e.g: ExceptionNotifier::SimpleNotifier.
 
-### Example
+#### Example
 
 Define the custom notifier:
 

data/exception_notification.gemspec

@@ -1,11 +1,12 @@
 Gem::Specification.new do |s|
   s.name = 'exception_notification'
-  s.version = '4.0.0.rc1'
+  s.version = '4.0.0'
   s.authors = ["Jamis Buck", "Josh Peek"]
-  s.date = %q{2013-06-20}
+  s.date = %q{2013-07-06}
   s.summary = "Exception notification for Rails apps"
   s.homepage = "http://smartinez87.github.com/exception_notification"
   s.email = "smartinez87@gmail.com"
+  s.license = "MIT"
 
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- test`.split("\n")

data/test/dummy/Gemfile

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

data/test/dummy/Gemfile.lock

@@ -1,39 +1,39 @@
 PATH
   remote: ../../..
   specs:
-    exception_notification (3.0.1)
+    exception_notification (4.0.0)
       actionmailer (>= 3.0.4)
       activesupport (>= 3.0.4)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (4.0.0.rc2)
-      actionpack (= 4.0.0.rc2)
+    actionmailer (4.0.0)
+      actionpack (= 4.0.0)
       mail (~> 2.5.3)
-    actionpack (4.0.0.rc2)
-      activesupport (= 4.0.0.rc2)
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
       builder (~> 3.1.0)
       erubis (~> 2.7.0)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    activemodel (4.0.0.rc2)
-      activesupport (= 4.0.0.rc2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
       builder (~> 3.1.0)
-    activerecord (4.0.0.rc2)
-      activemodel (= 4.0.0.rc2)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
       activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.0.rc2)
+      activesupport (= 4.0.0)
       arel (~> 4.0.0)
     activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.0.rc2)
+    activesupport (4.0.0)
       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)
+    atomic (1.1.10)
     builder (3.1.4)
     erubis (2.7.0)
     eventmachine (1.0.3)
@@ -53,7 +53,7 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.23)
-    minitest (4.7.4)
+    minitest (4.7.5)
     multi_json (1.7.7)
     multi_xml (0.5.4)
     multipart-post (1.2.0)
@@ -61,20 +61,20 @@ GEM
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    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)
+    rails (4.0.0)
+      actionmailer (= 4.0.0)
+      actionpack (= 4.0.0)
+      activerecord (= 4.0.0)
+      activesupport (= 4.0.0)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.0.0.rc2)
+      railties (= 4.0.0)
       sprockets-rails (~> 2.0.0)
-    railties (4.0.0.rc2)
-      actionpack (= 4.0.0.rc2)
-      activesupport (= 4.0.0.rc2)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.0.4)
+    rake (10.1.0)
     simple_oauth (0.1.9)
     sprockets (2.10.0)
       hike (~> 1.2)
@@ -114,6 +114,6 @@ PLATFORMS
 DEPENDENCIES
   exception_notification!
   httparty
-  rails (= 4.0.0.rc2)
+  rails (= 4.0.0)
   sqlite3
   tinder

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification
 version: !ruby/object:Gem::Version
-  version: 4.0.0.rc1
-  prerelease: 6
+  version: 4.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Jamis Buck
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -303,7 +303,8 @@ files:
 - test/exception_notifier_test.rb
 - test/test_helper.rb
 homepage: http://smartinez87.github.com/exception_notification
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -314,12 +315,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2589511577649954983
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: -2589511577649954983
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23