exception_notification 4.0.0 → 4.0.1

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+== 4.0.1
+
+* enhancements
+  * Add HipChat notifier (by @j15e)
+  * Log backtrace when notification fails
+  * Send more info in Webhook notifier
+  * Add HTTP method to request section
+
 == 4.0.0
 
 * enhancements

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exception_notification (4.0.0)
+    exception_notification (4.0.1)
       actionmailer (>= 3.0.4)
       activesupport (>= 3.0.4)
 
@@ -58,6 +58,8 @@ GEM
       faraday (>= 0.7.4, < 0.9)
     hashie (1.2.0)
     hike (1.2.1)
+    hipchat (0.11.0)
+      httparty
     http_parser.rb (0.5.3)
     httparty (0.10.2)
       multi_json (~> 1.0)
@@ -155,6 +157,7 @@ DEPENDENCIES
   appraisal
   coveralls (~> 0.6.5)
   exception_notification!
+  hipchat (>= 0.11.0)
   httparty (~> 0.10.2)
   mocha (>= 0.13.0)
   rails (>= 3.0.4)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Jamis Buck
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -47,7 +47,7 @@ Whatever::Application.config.middleware.use ExceptionNotification::Rack,
   }
 ```
 
-> **Note**: In order delivery notifications by email make sure you have [ActionMailer configured](#actionmailer-configuration).
+> **Note**: In order to enable delivery notifications by email make sure you have [ActionMailer configured](#actionmailer-configuration).
 
 
 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).
@@ -75,7 +75,7 @@ Whatever::Application.config.middleware.use ExceptionNotification::Rack,
   }
 ```
 
-Beside that, the rack middlware was renamed to `ExceptionNotification::Rack`.
+Beside that, the rack middleware was renamed to `ExceptionNotification::Rack`.
 
 ## Notifiers
 
@@ -195,7 +195,7 @@ Whatever::Application.config.middleware.use ExceptionNotification::Rack,
 
 ##### email_headers
 
-*Hash os strings, default: {}*
+*Hash of strings, default: {}*
 
 Additionally, you may want to set customized headers on the outcoming emails. To do so, simply use the `:email_headers` option:
 
@@ -258,7 +258,7 @@ Whatever::Application.config.middleware.use ExceptionNotification::Rack,
     :email_prefix         => "[Whatever] ",
     :sender_address       => %{"notifier" <notifier@example.com>},
     :exception_recipients => %w{exceptions@example.com},
-    :delivery_method => :stmp,
+    :delivery_method => :smtp,
     :smtp_settings => {
       :user_name => "bob",
       :password => "password",
@@ -326,6 +326,67 @@ 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).
 
 
+### HipChat notifier
+
+This notifier sends notifications to your Hipchat room.
+
+#### Usage
+
+Just add the [hipchat](https://github.com/hipchat/hipchat) gem to your `Gemfile`:
+
+```ruby
+gem 'hipchat'
+```
+
+To configure it, you need to set the `token` and `room_name` options, like this:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[Whatever] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+  },
+  :hipchat => {
+    :api_token => 'my_token',
+    :room_name => 'my_room'
+  }
+```
+
+#### Options
+
+##### room_name
+
+*String, required*
+
+The HipChat room where the notifications must be published to.
+
+##### api_token
+
+*String, required*
+
+The API token to allow access to your HipChat account.
+
+##### announce
+
+*Boolean, optionnal*
+
+Notify users. Default : false.
+
+##### color
+
+*String, optionnal*
+
+Color of the message. Default : 'red'.
+
+##### from
+
+*String, optionnal*
+
+Message will appear from this nickname. Default : 'Exception'.
+
+For all options & possible values see [Hipchat API](https://www.hipchat.com/docs/api/method/rooms/message).
+
 ### Webhook notifier
 
 This notifier ships notifications over the HTTP protocol.
@@ -559,6 +620,10 @@ or
 
 ## Versions
 
+For v4.0.0, see this tag:
+
+http://github.com/smartinez87/exception_notification/tree/v4.0.0
+
 For v3.0.1, see this tag:
 
 http://github.com/smartinez87/exception_notification/tree/v3.0.1

data/exception_notification.gemspec

@@ -1,13 +1,16 @@
 Gem::Specification.new do |s|
   s.name = 'exception_notification'
-  s.version = '4.0.0'
+  s.version = '4.0.1'
   s.authors = ["Jamis Buck", "Josh Peek"]
-  s.date = %q{2013-07-06}
+  s.date = %q{2013-09-15}
   s.summary = "Exception notification for Rails apps"
   s.homepage = "http://smartinez87.github.com/exception_notification"
   s.email = "smartinez87@gmail.com"
   s.license = "MIT"
 
+  s.required_ruby_version     = '>= 1.9.3'
+  s.required_rubygems_version = '>= 1.8.11'
+
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- test`.split("\n")
   s.require_path = 'lib'
@@ -24,4 +27,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "sqlite3", ">= 1.3.4"
   s.add_development_dependency "coveralls", "~> 0.6.5"
   s.add_development_dependency "appraisal", ">= 0"
+  s.add_development_dependency "hipchat", ">= 0.11.0"
 end

data/lib/exception_notifier.rb

@@ -1,11 +1,13 @@
 require 'logger'
 require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/module/attribute_accessors'
 
 module ExceptionNotifier
 
   autoload :Notifier, 'exception_notifier/notifier'
   autoload :EmailNotifier, 'exception_notifier/email_notifier'
   autoload :CampfireNotifier, 'exception_notifier/campfire_notifier'
+  autoload :HipchatNotifier, 'exception_notifier/hipchat_notifier'
   autoload :WebhookNotifier, 'exception_notifier/webhook_notifier'
 
   class UndefinedNotifierError < StandardError; end
@@ -75,7 +77,7 @@ module ExceptionNotifier
     def ignored?(exception, options)
       @@ignores.any?{ |condition| condition.call(exception, options) }
     rescue Exception => e
-      logger.warn "An error occurred when evaluating an ignore condition. #{e.class}: #{e.message}"
+      logger.warn "An error occurred when evaluating an ignore condition. #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
       false
     end
 
@@ -87,7 +89,7 @@ module ExceptionNotifier
       notifier = registered_exception_notifier(notifier_name)
       notifier.call(exception, options)
     rescue Exception => e
-      logger.warn "An error occurred when sending a notification using '#{notifier_name}' notifier. #{e.class}: #{e.message}"
+      logger.warn "An error occurred when sending a notification using '#{notifier_name}' notifier. #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
       false
     end
 

data/lib/exception_notifier/hipchat_notifier.rb

@@ -0,0 +1,34 @@
+module ExceptionNotifier
+  class HipchatNotifier
+
+    attr_accessor :from
+    attr_accessor :room
+    attr_accessor :message_options
+
+    def initialize(options)
+      begin
+        api_token				  = options.delete(:api_token)
+        room_name 			  = options.delete(:room_name)
+        @from             = options.delete(:from) || 'Exception'
+        @room     			  = HipChat::Client.new(api_token)[room_name]
+        @message_options  = options
+        @message_options[:color] ||= 'red'
+      rescue
+        @room = nil
+      end
+    end
+
+    def call(exception, options={})
+      return if !active?
+
+      message = "A new exception occurred: '#{exception.message}' on '#{exception.backtrace.first}'"
+      @room.send(@from, message, @message_options)
+    end
+
+    private
+
+    def active?
+      !@room.nil?
+    end
+  end
+end

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

@@ -7,12 +7,4 @@
       <span><%= inspect_object(filtered_env[key]) %></span>
     </li>
   <% end -%>
-  <li>
-    <strong>Process:</strong>
-    <span><%= raw $$ %></span>
-  </li>
-  <li>
-    <strong>Server:</strong>
-    <span><%= raw Socket.gethostname %></span>
-  </li>
 </ul>

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

@@ -3,6 +3,3 @@
 <% 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 Socket.gethostname %>

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

@@ -3,6 +3,10 @@
     <strong>URL:</strong>
     <span><%= raw @request.url %></span>
   </li>
+  <li>
+    <strong>HTTP Method:</strong>
+    <span><%= raw @request.request_method %></span>
+  </li>
   <li>
     <strong>IP Address:</strong>
     <span><%= raw @request.remote_ip %></span>
@@ -11,6 +15,14 @@
     <strong>Parameters:</strong>
     <span><%= raw @request.filtered_parameters.inspect %></span>
   </li>
+  <li>
+    <strong>Timestamp:</strong>
+    <span><%= raw Time.current %></span>
+  </li>
+  <li>
+    <strong>Server:</strong>
+    <span><%= raw Socket.gethostname %></span>
+  </li>
   <% if defined?(Rails) %>
     <li>
       <strong>Rails root:</strong>
@@ -18,7 +30,7 @@
     </li>
   <% end %>
   <li>
-    <strong>Timestamp:</strong>
-    <span><%= raw Time.current %></span>
+    <strong>Process:</strong>
+    <span><%= raw $$ %></span>
   </li>
 </ul>

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

@@ -1,7 +1,10 @@
-* URL       : <%= raw @request.url %>
-* IP address: <%= raw @request.remote_ip %>
-* Parameters: <%= raw @request.filtered_parameters.inspect %>
+* URL        : <%= raw @request.url %>
+* HTTP Method: <%= raw @request.request_method %>
+* IP address : <%= raw @request.remote_ip %>
+* Parameters : <%= raw @request.filtered_parameters.inspect %>
+* Timestamp  : <%= raw Time.current %>
+* Server : <%= raw Socket.gethostname %>
 <% if defined?(Rails) %>
-* Rails root: <%= raw Rails.root %>
+* Rails root : <%= raw Rails.root %>
 <% end %>
-* Timestamp : <%= raw Time.current %>
+* Process: <%= raw $$ %>

data/lib/exception_notifier/webhook_notifier.rb

@@ -1,3 +1,5 @@
+require 'action_dispatch'
+
 module ExceptionNotifier
   class WebhookNotifier
 
@@ -6,14 +8,34 @@ module ExceptionNotifier
     end
 
     def call(exception, options={})
+      env = options[:env]
+
       options = options.reverse_merge(@default_options)
       url = options.delete(:url)
       http_method = options.delete(:http_method) || :post
 
       options[:body] ||= {}
+      options[:body][:server] = Socket.gethostname
+      options[:body][:process] = $$
+      options[:body][:rails_root] = Rails.root if defined?(Rails)
       options[:body][:exception] = {:error_class => exception.class.to_s,
                                     :message => exception.message.inspect,
                                     :backtrace => exception.backtrace}
+      options[:body][:data] = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
+
+      unless env.nil?
+        request = ActionDispatch::Request.new(env)
+
+        request_items = {:url => request.original_url,
+                         :http_method => request.http_method,
+                         :ip_address => request.remote_ip,
+                         :parameters => request.filtered_parameters,
+                         :timestamp => Time.current }
+
+        options[:body][:request] = request_items
+        options[:body][:session] = request.session
+        options[:body][:environment] = request.filtered_env
+      end
 
       HTTParty.send(http_method, url, options)
     end

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

@@ -38,6 +38,12 @@ ExceptionNotification.configure do |config|
   #   :room_name => 'my_room'
   # }
 
+  # HipChat notifier sends notifications to your HipChat room. Requires 'hipchat' gem.
+  # config.add_notifier :hipchat, {
+  #   :api_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',

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

@@ -46,7 +46,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   test "mail should contain timestamp of exception in body" do
-    assert @mail.encoded.include? "Timestamp : #{Time.current}"
+    assert @mail.encoded.include? "Timestamp  : #{Time.current}"
   end
 
   test "mail should contain the newly defined section" do

data/test/exception_notifier/hipchat_notifier_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+require 'hipchat'
+
+class HipchatNotifierTest < ActiveSupport::TestCase
+
+  test "should send hipchat notification if properly configured" do
+    options = {
+      :api_token => 'good_token',
+      :room_name => 'room_name',
+      :color     => 'yellow',
+    }
+
+    HipChat::Room.any_instance.expects(:send).with('Exception', fake_body, { :color => 'yellow' })
+
+    hipchat = ExceptionNotifier::HipchatNotifier.new(options)
+    hipchat.call(fake_exception)
+  end
+
+  test "should allow custom from value if set" do
+    options = {
+      :api_token => 'good_token',
+      :room_name => 'room_name',
+      :from      => 'TrollFace',
+    }
+
+    HipChat::Room.any_instance.expects(:send).with('TrollFace', fake_body, { :color => 'red' })
+
+    hipchat = ExceptionNotifier::HipchatNotifier.new(options)
+    hipchat.call(fake_exception)
+  end
+
+  test "should not send hipchat notification if badly configured" do
+    wrong_params = {
+      :api_token => 'bad_token',
+      :room_name => 'test_room'
+    }
+
+    HipChat::Client.stubs(:new).with('bad_token').returns(nil)
+
+    hipchat = ExceptionNotifier::HipchatNotifier.new(wrong_params)
+    assert_nil hipchat.room
+  end
+
+  test "should not send hipchat notification if api_key is missing" do
+    wrong_params  = {:room_name => 'test_room'}
+
+    HipChat::Client.stubs(:new).with(nil).returns(nil)
+
+    hipchat = ExceptionNotifier::HipchatNotifier.new(wrong_params)
+    assert_nil hipchat.room
+  end
+
+  test "should not send hipchat notification if room_name is missing" do
+    wrong_params  = {:api_token => 'good_token'}
+
+    HipChat::Client.stubs(:new).with('good_token').returns({})
+
+    hipchat = ExceptionNotifier::HipchatNotifier.new(wrong_params)
+    assert_nil hipchat.room
+  end
+
+  private
+
+  def fake_body
+    "A new exception occurred: '#{fake_exception.message}' on '#{fake_exception.backtrace.first}'"
+  end
+
+  def fake_exception
+    exception = begin
+      5/0
+    rescue Exception => e
+      e
+    end
+  end
+end

data/test/exception_notifier/webhook_notifier_test.rb

@@ -14,6 +14,15 @@ class WebhookNotifierTest < ActiveSupport::TestCase
     assert_equal response[:body][:exception][:error_class], "ZeroDivisionError"
     assert response[:body][:exception][:message].include? "divided by 0"
     assert response[:body][:exception][:backtrace].include? "/exception_notification/test/webhook_notifier_test.rb:48"
+    
+    assert response[:body][:request][:cookies].has_key?(:cookie_item1)
+    assert_equal response[:body][:request][:url], "http://example.com/example"
+    assert_equal response[:body][:request][:ip_address], "192.168.1.1"
+    assert response[:body][:request][:environment].has_key?(:env_item1)
+    assert_equal response[:body][:request][:controller], "#<ControllerName:0x007f9642a04d00>"
+    assert response[:body][:request][:session].has_key?(:session_item1)
+    assert response[:body][:request][:parameters].has_key?(:controller)
+    assert response[:body][:data][:extra_data].has_key?(:data_item1)
   end
 
   private
@@ -26,6 +35,18 @@ class WebhookNotifierTest < ActiveSupport::TestCase
           :error_class => 'ZeroDivisionError',
           :message => 'divided by 0',
           :backtrace => '/exception_notification/test/webhook_notifier_test.rb:48:in `/'
+        },
+        :data => {
+          :extra_data => {:data_item1 => "datavalue1", :data_item2 => "datavalue2"}
+        },
+        :request => {
+          :cookies => {:cookie_item1 => 'cookieitemvalue1', :cookie_item2 => 'cookieitemvalue2'},
+          :url => 'http://example.com/example',
+          :ip_address => '192.168.1.1',
+          :environment => {:env_item1 => "envitem1", :env_item2 => "envitem2"},
+          :controller => '#<ControllerName:0x007f9642a04d00>',
+          :session => {:session_item1 => "sessionitem1", :session_item2 => "sessionitem2"},
+          :parameters => {:action =>"index", :controller =>"projects"}
         }
       }
     }

data/test/test_helper.rb

@@ -1,8 +1,12 @@
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 
-require "coveralls"
-Coveralls.wear!
+begin
+  require "coveralls"
+  Coveralls.wear!
+rescue LoadError
+  warn "warning: coveralls gem not found; skipping Coveralls"
+end
 
 require File.expand_path("../dummy/config/environment.rb", __FILE__)
 require "rails/test_help"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-06 00:00:00.000000000 Z
+date: 2013-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -188,6 +188,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hipchat
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 description: 
 email: smartinez87@gmail.com
 executables: []
@@ -202,6 +218,7 @@ files:
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
+- MIT-LICENSE
 - README.md
 - Rakefile
 - examples/sinatra/Gemfile
@@ -222,6 +239,7 @@ files:
 - lib/exception_notifier.rb
 - lib/exception_notifier/campfire_notifier.rb
 - lib/exception_notifier/email_notifier.rb
+- lib/exception_notifier/hipchat_notifier.rb
 - lib/exception_notifier/notifier.rb
 - lib/exception_notifier/views/exception_notifier/_backtrace.html.erb
 - lib/exception_notifier/views/exception_notifier/_backtrace.text.erb
@@ -299,6 +317,7 @@ files:
 - test/dummy/test/test_helper.rb
 - test/exception_notifier/campfire_notifier_test.rb
 - test/exception_notifier/email_notifier_test.rb
+- test/exception_notifier/hipchat_notifier_test.rb
 - test/exception_notifier/webhook_notifier_test.rb
 - test/exception_notifier_test.rb
 - test/test_helper.rb
@@ -314,19 +333,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -2589511577649954983
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -2589511577649954983
+      version: 1.8.11
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -391,6 +404,7 @@ test_files:
 - test/dummy/test/test_helper.rb
 - test/exception_notifier/campfire_notifier_test.rb
 - test/exception_notifier/email_notifier_test.rb
+- test/exception_notifier/hipchat_notifier_test.rb
 - test/exception_notifier/webhook_notifier_test.rb
 - test/exception_notifier_test.rb
 - test/test_helper.rb