Merge ab6b648 into b40e3a6

.gitignore

@@ -2,3 +2,4 @@
 *.gemfile.lock
 /Gemfile.lock
 /.idea/
+sample_app.log

CONTRIBUTING.md

@@ -18,6 +18,24 @@ need contributors to follow:
     like OS version, gem versions, etc...
   * Even better, provide a failing test case for it.
 
+To help you add information to an issue, you can use the sample_app.
+Steps to use sample_app:
+
+1) Add your configuration to (ex. with webhook):
+```ruby
+config.middleware.use ExceptionNotification::Rack,
+  # -----------------------------------
+  # Change this with your configuration
+  # https://github.com/smartinez87/exception_notification#notifiers
+                        webhook: {
+                          url: 'http://domain.com:5555/hubot/path'
+                        }
+  # -----------------------------------
+```
+
+2) Run `ruby examples/sample_app.rb`
+If exception notification is working OK, you'll see the message "'Raising exception!" and then "Working OK!" and should receive the notification as configured above. If it's not, you can copy the information printed on the terminal related to exception notification and report an issue with more info!
+
 ## Pull Requests
 
 If you've gone the extra mile and have a patch that fixes the issue, you

examples/sample_app.rb

@@ -0,0 +1,62 @@
+# -------------------------------------------
+# To run the application: ruby examples/sample_app.rb
+# -------------------------------------------
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'rails', '5.0.0'
+  gem 'exception_notification', '4.3.0'
+  gem 'httparty', '0.15.7'
+end
+
+class SampleApp < Rails::Application
+  config.middleware.use ExceptionNotification::Rack,
+  # -----------------------------------
+  # Change this with your configuration
+  # https://github.com/smartinez87/exception_notification#notifiers
+                        webhook: {
+                          url: 'http://domain.com:5555/hubot/path'
+                        }
+  # -----------------------------------
+
+  config.secret_key_base = 'my secret key base'
+  file = File.open('sample_app.log', 'w')
+  logger = Logger.new(file)
+  Rails.logger = logger
+
+  routes.draw do
+    get 'raise_sample_exception', to: 'exceptions#raise_sample_exception'
+  end
+end
+
+require 'action_controller/railtie'
+require 'active_support'
+
+class ExceptionsController < ActionController::Base
+  include Rails.application.routes.url_helpers
+
+  def raise_sample_exception
+    puts 'Raising exception!'
+    raise 'Sample exception raised, you should receive a notification!'
+  end
+end
+
+require 'minitest/autorun'
+
+class Test < Minitest::Test
+  include Rack::Test::Methods
+
+  def test_raise_exception
+    get '/raise_sample_exception'
+    puts "Working OK!"
+  end
+
+  private
+
+  def app
+    Rails.application
+  end
+end