super_exception_notifier 3.0.13 → 3.0.14

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  data.tar.gz: 33fcc250ec9acc3acd3862d48e412e88790118af
+  metadata.gz: 0cf3c1a7f30e4c604bfa87fa2d69fefaa1b4875a
+SHA512: 
+  data.tar.gz: a229c57c4b248277c082220909fbd1782539299836a90469b21af76a7ad79e83f049fbb80d57a7331fa98fa8d47e6908767243947ed071205a0bd440c317942c
+  metadata.gz: 67b28b872173b7c3658796651251266fe75ab72f220ed862914d29e342ee403ddf462ada880b294583ca028832531ee0ccc441f17f1a670d31fe2f277dc09cdf

data/CHANGELOG.txt

@@ -1,3 +1,12 @@
+2014-01-18 v3.0.14
+- Fixed Notifiable class by Peter Boling
+- Fixed ExceptionNotifiable class by Bradford Folkens
+- Modernized lots of bits and pieces by Peter Boling
+- All tests now pass in Rails 2.3.18 and Ruby 1.8.7-p374 by Peter Boling
+- Fixes typos
+- Switched to Bundler; Removed Jeweler
+- Readme makeover
+
 2010-06-30 v3.0.13
 - Fixed homepage in Rakefile, noted Rails 3 incompatibility in README.
 

data/README.md

@@ -0,0 +1,189 @@
+# Super Exception Notifier
+
+**NOTE: This is a legacy gem, for rails 2.x**
+
+The Super Exception Notifier (SEN) gem provides a mailer object and a default set of templates for sending email notifications when errors occur in a Rails application, as well as a default set of error page templates to render based on the status code assigned to an error.
+
+| Project                 |  Super Exception Notifier   |
+|------------------------ | ----------------- |
+| gem name                |  super_exception_notifier   |
+| license                 |  MIT              |
+| moldiness               |  [![Maintainer Status](http://stillmaintained.com/pboling/super_exception_notifier.png)](http://stillmaintained.com/pboling/super_exception_notifier) |
+| version                 |  [![Gem Version](https://badge.fury.io/rb/super_exception_notifier.png)](http://badge.fury.io/rb/super_exception_notifier) |
+| dependencies            |  [![Dependency Status](https://gemnasium.com/pboling/super_exception_notifier.png)](https://gemnasium.com/pboling/super_exception_notifier) |
+| code quality            |  [![Code Climate](https://codeclimate.com/github/pboling/super_exception_notifier.png)](https://codeclimate.com/github/pboling/super_exception_notifier) |
+| continuous integration  |  [![Build Status](https://secure.travis-ci.org/pboling/super_exception_notifier.png?branch=master)](https://travis-ci.org/pboling/super_exception_notifier) |
+| test coverage           |  [![Coverage Status](https://coveralls.io/repos/pboling/super_exception_notifier/badge.png)](https://coveralls.io/r/pboling/super_exception_notifier) |
+| homepage                |  [https://github.com/pboling/super_exception_notifier][homepage] |
+| documentation           |  [http://rdoc.info/github/pboling/super_exception_notifier/frames][documentation] |
+| author                  |  [Peter Boling](https://coderbits.com/pboling) |
+| Spread ~♡ⓛⓞⓥⓔ♡~      |  [![Endorse Me](https://api.coderwall.com/pboling/endorsecount.png)](http://coderwall.com/pboling) |
+
+## Summary
+
+The gem is configurable, allowing programmers to customize (settings are per environment or per class):
+
+* the sender address of the email
+* the recipient addresses
+* text used to prepend and append the subject line
+* the HTTP status codes to send emails for
+* the error classes to send emails for
+* alternatively, the error classes to not send emails for
+* whether to send error emails or just render without sending anything
+* the HTTP status and status code that gets rendered with specific errors
+* the view path to the error page templates
+* custom errors, with custom error templates
+* fine-grained customization of error layouts (or no layout)
+* get error notification for errors that occur in the console, using notifiable method
+* Hooks into `git blame` output so you can get an idea of who (may) have introduced the bug
+* Hooks into other website services (e.g. you can send exceptions to to Switchub.com)
+* Specify which level of notification you would like with an array of optional styles of notification:
+ [:render, :email, :web_hooks]
+* Can notify of errors occurring in any method in any class in Ruby by wrapping the method call like this:
+ notifiable { method }
+* Can notify of errors in Rake tasks using 'NotifiedTask.new' instead of 'task' when writing tasks
+* Works with Hoptoad Notifier, so you can notify via SEN and/or Hoptoad for any particular errors.
+* Tested with Rails 2.3.x, should work with Rails 2.2.x, and is apparently **not compatible with Rails 3 or 4**.
+
+The email includes information about the current request, session, and environment, and also gives a backtrace of the exception.
+
+This gem is based on the wonderful exception_notification plugin created by Jamis Buck. I have modified it extensively and merged many of the improvements from a dozen or so other forks.  It remains a (mostly) drop in replacement with greatly extended functionality and customization options.  I keep it up to date with the work on the core team's
+branch.
+
+The venerable [original is here](http://github.com/rails/exception_notification)
+
+The current version of this gem is a git fork of the original and has been updated to include the latest improvements from the original, and many improvements from the other forks on github.  I merge them in when I have time, and when the changes fit nicely with the enhancements I have already made.
+
+This fork of Exception Notifier is (or was at some point) in production use on several large websites (top 5000).
+
+## Installation as RubyGem
+
+    [sudo] gem install super_exception_notifier
+
+More Installation Options are here: http://wiki.github.com/pboling/exception_notification/installation
+
+## Configuration as RubyGem in Rails 2.x
+
+(UPGRADE NOTE: The name of the lib changed from SEN version 2.x to 3.x)
+
+    config.gem 'super_exception_notifier', :lib => "exception_notification"
+
+More Configuration Options are here: http://wiki.github.com/pboling/exception_notification/configuration
+
+## Configuration In Environment (Initializer)
+
+(UPGRADE NOTE: The class invoked here changed from SEN version 2.x to 3.x)
+
+    ExceptionNotification::Notifier.configure_exception_notifier do |config|
+      config[:app_name]                 = "[MYAPP]"
+      config[:sender_address]           = "super.exception.notifier@example.com"
+      config[:exception_recipients]     = [] # You need to set at least one recipient if you want to get the notifications
+      # In a local environment only use this gem to render, never email
+      #defaults to false - meaning by default it sends email.  Setting true will cause it to only render the error pages, and NOT email.
+      config[:skip_local_notification]  = true
+      # Error Notification will be sent if the HTTP response code for the error matches one of the following error codes
+      config[:notify_error_codes]   = %W( 405 500 503 )
+      # Error Notification will be sent if the error class matches one of the following error classes
+      config[:notify_error_classes] = %W( )
+      # What should we do for errors not listed?
+      config[:notify_other_errors]  = true
+      # If you set this SEN will attempt to use git blame to discover the person who made the last change to the problem code
+      config[:git_repo_path]            = nil # ssh://git@blah.example.com/repo/webapp.git
+    end
+
+More Configuration Options: [http://wiki.github.com/pboling/exception_notification/advanced-environment-configuration](http://wiki.github.com/pboling/exception_notification/advanced-environment-configuration)
+
+## Handling Errors in Request Cycle
+
+1. Include the ExceptionNotification::ExceptionNotifiable mixin in whichever controller you want to generate error emails (typically ApplicationController) as below.
+
+2. Specify the email recipients in your environment as above. (You may have already done this in the "Configuration in Environment (Initializer)" section above):
+
+3. Make sure you have your ActionMailer server settings correct if you are using the e-mail features.
+
+4. That’s it! The defaults take care of the rest.
+
+Code:
+
+    class ApplicationController < ActionController::Base
+      ############################################################
+      # ERROR HANDLING et Foo
+      include ExceptionNotification::ExceptionNotifiable
+      #Comment out the line below if you want to see the normal rails errors in normal development.
+      alias :rescue_action_locally :rescue_action_in_public if Rails.env == 'development'
+      #self.error_layout = 'errors'
+      self.exception_notifiable_verbose = true #SEN uses logger.info, so won't be verbose in production
+      self.exception_notifiable_pass_through = :hoptoad # requires the standard hoptoad gem to be installed, and setup normally
+      self.exception_notifiable_silent_exceptions = [Acl9::AccessDenied, MethodDisabled, ActionController::RoutingError ]
+      #specific errors can be handled by something else:
+      rescue_from 'Acl9::AccessDenied', :with => :access_denied
+      # END ERROR HANDLING
+      ############################################################
+      ...
+    end
+
+    ExceptionNotification::Notifier.configure_exception_notifier do |config|
+      config[:exception_recipients] = %w(joe@example.com bill@example.com)
+    end
+
+[http://wiki.github.com/pboling/exception_notification/exceptions-inside-request-cycle](http://wiki.github.com/pboling/exception_notification/exceptions-inside-request-cycle)
+
+## Advanced Configuration
+
+There is a lot more you can configure, and do:
+
+[http://wiki.github.com/pboling/exception_notification/](http://wiki.github.com/pboling/exception_notification/)
+
+
+## Authors
+
+[Peter Boling][peterboling] is the original author of the code, and current maintainer.
+
+## Contributors
+
+See the [Network View](https://github.com/pboling/super_exception_notifier/network) and the [CHANGELOG](https://github.com/pboling/super_exception_notifier/blob/master/CHANGELOG.txt)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+6. Create new Pull Request
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver].
+Violations of this scheme should be reported as bugs. Specifically,
+if a minor or patch version is released that breaks backward
+compatibility, a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will
+only be introduced with new major versions.
+
+As a result of this policy, you can (and should) specify a
+dependency on this gem using the [Pessimistic Version Constraint][pvc] with two digits of precision.
+
+For example:
+
+    spec.add_dependency 'super_exception_notifier', '~> 3.0.14'
+
+## References
+
+* [Source Code](http://github.com/pboling/super_exception_notifier)
+* [A fork from the my original source on Google Code](https://github.com/vitaliel/super_exception_notifier)
+* [The Original Source on Google Code](http://super-exception-notifier.googlecode.com/svn/trunk/super_exception_notifier/)
+* [Getting it to work on Stack Overflow & my response](http://stackoverflow.com/questions/1738017/getting-super-exception-notifier-to-work)
+* [Getting it to work on PasteBin](http://pastebin.com/pyHQjN84)
+
+## Legal
+
+* MIT License - See LICENSE file in this project
+* Copyright (c) 2008-2014 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+[railsbling]: http://www.railsbling.com
+[peterboling]: http://www.peterboling.com
+[documentation]: http://rdoc.info/github/pboling/super_exception_notifier/frames
+[homepage]: https://github.com/pboling/super_exception_notifier

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test exception_notifiable gem.'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+desc 'Generate documentation for exception_notifiable gem.'
+require File.expand_path('../lib/exception_notification/version', __FILE__)
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "exception_notifiable #{ExceptionNotification::VERSION}"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/lib/exception_notification.rb

@@ -1,5 +1,8 @@
 require "action_mailer"
+
 module ExceptionNotification
+  require 'exception_notification/version'
+
   autoload :ExceptionNotifiable, 'exception_notification/exception_notifiable'
   autoload :Notifiable, 'exception_notification/notifiable'
   autoload :Notifier, 'exception_notification/notifier'

data/lib/exception_notification/exception_notifiable.rb

@@ -132,7 +132,7 @@ module ExceptionNotification::ExceptionNotifiable
         perform_exception_notify_mailing(exception, data, nil, the_blamed, verbose, rejected_sections) if send_email
         # Send Web Hook requests
         ExceptionNotification::HooksNotifier.deliver_exception_to_web_hooks(ExceptionNotification::Notifier.config, exception, self, request, data, the_blamed) if send_web_hooks
-        pass_it_on(exception, ENV)
+        pass_it_on(exception, ENV, verbose)
       end
       to_return
     end
@@ -152,7 +152,7 @@ module ExceptionNotification::ExceptionNotifiable
       else
         notify_and_render_error_template(status_code, request, exception, ExceptionNotification::Notifier.get_view_path_for_status_code(status_code, verbose), verbose)
       end
-      pass_it_on(exception, ENV, request, params, session)
+      pass_it_on(exception, ENV, request, params, session, verbose)
     end
 
     def notify_and_render_error_template(status_cd, request, exception, file_path, verbose = false)
@@ -182,7 +182,7 @@ module ExceptionNotification::ExceptionNotifiable
     # some integration with hoptoad or other exception handler
     # is done by tha alias method chain on:
     #    rescue_action_locally
-    def pass_it_on(exception, env, request = {:params => {}}, params = {}, session = {})
+    def pass_it_on(exception, env, request = {:params => {}}, params = {}, session = {}, verbose = false)
       begin
         case self.class.exception_notifiable_pass_through
           when :hoptoad then

data/lib/exception_notification/notifiable.rb

@@ -55,7 +55,7 @@ module ExceptionNotification::Notifiable
   private
 
   def environment_is_noisy?
-    !self.notifiable_noisy_environments.include?(Rails.env)
+    self.notifiable_noisy_environments.include?(Rails.env)
   end
 
   def notification_level_sends_email?
@@ -72,11 +72,12 @@ module ExceptionNotification::Notifiable
     data = get_exception_data
     # With ExceptionNotifiable you have an inherent request, and using a status code makes sense.
     # With Notifiable class to wrap around everything that doesn't have a request,
+    request = nil
     #   the errors you want to be notified of need to be specified either positively or negatively
-    # 1. positive eg. set ExceptionNotifier.config[:notify_error_classes] to an array of classes
-    #               set ExceptionNotifier.config[:notify_other_errors] to false
+    # 1. positive eg. set ExceptionNotification::Notifier.config[:notify_error_classes] to an array of classes
+    #               set ExceptionNotification::Notifier.config[:notify_other_errors] to false
     # 1. negative eg. set Klass.silent_exceptions to the ones to keep quiet
-    #               set ExceptionNotifier.config[:notify_other_errors] to true
+    #               set ExceptionNotification::Notifier.config[:notify_other_errors] to true
     status_code = nil
     #We only send email if it has been configured in environment
     send_email = should_email_on_exception?(exception, status_code, verbose)
@@ -89,10 +90,10 @@ module ExceptionNotification::Notifiable
     perform_exception_notify_mailing(exception, data, nil, the_blamed, verbose, rejected_sections) if send_email
     # Send Web Hook requests
     ExceptionNotification::HooksNotifier.deliver_exception_to_web_hooks(ExceptionNotification::Notifier.config, exception, self, request, data, the_blamed) if send_web_hooks
-    pass_it_on(exception)
+    pass_it_on(exception, request, verbose)
   end
 
-  def pass_it_on(exception, request = nil)
+  def pass_it_on(exception, request = nil, verbose = false)
     begin
       request ||= {:params => {}}
       case self.class.notifiable_pass_through
@@ -110,7 +111,7 @@ module ExceptionNotification::Notifiable
   end
 
   def is_local? #like asking is_silent?
-    self.notifiable_noisy_environments.include?(Rails.env)
+    !self.notifiable_noisy_environments.include?(Rails.env)
   end
 
 end

data/lib/exception_notification/version.rb

@@ -0,0 +1,5 @@
+module ExceptionNotification
+
+  VERSION = '3.0.14'
+
+end

data/rails/init.rb

@@ -2,9 +2,12 @@ require 'rake'
 require 'rake/tasklib'
 require "action_mailer"
 
-require "exception_notification/notified_task" unless defined?(NotifiedTask)
+require "exception_notification/notified_task"
 
-require "exception_notification" unless defined?(ExceptionNotification)
+require "exception_notification"
+
+# To load the autoloads.
+ExceptionNotification
 
 Object.class_eval do
   include ExceptionNotification::Notifiable

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: super_exception_notifier
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 3
-  - 0
-  - 13
-  version: 3.0.13
+  version: 3.0.14
 platform: ruby
 authors: 
 - Peter Boling
@@ -19,37 +13,88 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-30 00:00:00 -04:00
-default_executable: 
+date: 2014-01-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionmailer
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
-    - - ">="
+    - &id008 
+      - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
+    - - <
+      - !ruby/object:Gem::Version 
+        version: "4"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: rbx-require-relative
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
+        version: 0.0.9
+  type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.3"
+    - - <
+      - !ruby/object:Gem::Version 
+        version: "3"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.12"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.8"
+    - - <
+      - !ruby/object:Gem::Version 
+        version: "0.9"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.13
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: roodi
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.0
+  type: :development
+  version_requirements: *id007
 description: |-
   Allows customization of:
   * Specify which level of notification you would like with an array of optional styles of notification (email, webhooks)
@@ -78,14 +123,10 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
-files: 
 - CHANGELOG.txt
-- MIT-LICENSE
-- README
-- VERSION.yml
-- init.rb
-- lib/exception_notification.rb
+- LICENSE
+- README.md
+files: 
 - lib/exception_notification/consider_local.rb
 - lib/exception_notification/custom_exception_classes.rb
 - lib/exception_notification/custom_exception_methods.rb
@@ -99,6 +140,8 @@ files:
 - lib/exception_notification/notified_task.rb
 - lib/exception_notification/notifier.rb
 - lib/exception_notification/notifier_helper.rb
+- lib/exception_notification/version.rb
+- lib/exception_notification.rb
 - lib/views/exception_notification/notifier/_backtrace.html.erb
 - lib/views/exception_notification/notifier/_environment.html.erb
 - lib/views/exception_notification/notifier/_inspect_model.html.erb
@@ -121,17 +164,14 @@ files:
 - rails/app/views/exception_notifiable/503.html
 - rails/app/views/exception_notifiable/method_disabled.html.erb
 - rails/init.rb
-- super_exception_notifier.gemspec
-- test/exception_notifiable_test.rb
-- test/exception_notifier_helper_test.rb
-- test/exception_notifier_test.rb
-- test/exception_notify_functional_test.rb
-- test/mocks/controllers.rb
-- test/notifiable_test.rb
-- test/test_helper.rb
-has_rdoc: true
+- LICENSE
+- README.md
+- CHANGELOG.txt
+- Rakefile
 homepage: http://github.com/pboling/exception_notification
-licenses: []
+licenses: 
+- MIT
+metadata: {}
 
 post_install_message: 
 rdoc_options: 
@@ -139,35 +179,17 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  - *id008
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  - *id008
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Allows unhandled (and handled!) exceptions to be captured and sent via email
-test_files: 
-- test/exception_notifiable_test.rb
-- test/exception_notifier_helper_test.rb
-- test/exception_notifier_test.rb
-- test/exception_notify_functional_test.rb
-- test/mocks/controllers.rb
-- test/notifiable_test.rb
-- test/test_helper.rb
+test_files: []
+