openstax_rescue_from 0.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 8c0c0a01fc9e68148d1e6edee85fe7676c0a4378
-  data.tar.gz: 7d233b3e0bff69be9e33b708b48d8470941c5927
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWZjZTY5NGM1OGJiYmY4MzliNTgzMWZiZWU1NjMyMDU2Mzg3Y2Q2NA==
+  data.tar.gz: !binary |-
+    ODQ4NjFmMTMxNzJmMjk3ZjJiMjFlOWUzYmQxOWZmMjkzMTQzNTg2ZQ==
 SHA512:
-  metadata.gz: a51f638e3fd3d3defffd71833c798001b2486be1fd8f17090490357065eac39fc1f7542a1ad4100f1179c0e8cd95a14719232521eb7c5eae6950684047ac7c37
-  data.tar.gz: 688fbe57b528e091c95b8efe66ab59f8a0ea1c12650c818f481b9d3fa387d12d3bc68d7181944d626b445808520bcbeaa3e5d581101cad387cec0e74c1d6ea56
+  metadata.gz: !binary |-
+    YTAzMWVjZGM0ODJlZGM1NjZkMmMyN2MwNzU1OGUzNTU0N2EyYzVkMWYxNWZm
+    MmMyZDFiYzYwNTI4OTU2OTFmZTQ3MmYyOGNiOWNiZjZhM2NiYjYwZWMzZWYx
+    MWVkMWU3YTg4NmQ3NjllNjYwMjlkZDdlZWU3Yzc3MTFlZmJlYmE=
+  data.tar.gz: !binary |-
+    ZDE1ODgyNGUwZDRlNTkyZDY5NWM1M2NhY2VlZjZiMDFmM2M1YTMwZDMxZmJl
+    ZGU0YTE1YzY2YjU4ZWU5YmYyMTQxYzY4M2I2YWNhZDZkNWZjN2M0MWM5MmIz
+    MTc5YjJjNmM4OWUzOGNiM2M5MmM1ZmVhOGNjNDk2ZTcwYTVkODU=

data/.gitignore

@@ -6,8 +6,8 @@
 /doc/
 /pkg/
 /spec/reports/
-/tmp/
-log/*.log
+tmp/
+*.log
 .DS_Store
 *~
 

data/.ruby-gemset

@@ -0,0 +1 @@
+openstax-rescue-from

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

@@ -1,10 +1,20 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.3
+  - "1.9.3"
+  - "2.2.3"
 cache: bundler
 bundler_args: --retry=6
-before_install: gem install bundler -v 1.10.6
-branches:
-  only:
-    - master
+script:
+  - bundle exec rake
+notifications:
+  email: false
+addons:
+   postgresql: "9.3"
+before_install:
+  - gem install bundler
+before_script:
+  - export OXT_DB_USER=postgres
+  - export OXT_DB_PASS=
+  - export OXT_TEST_DB=travis_ci_test
+  - bundle exec rake db:create:all db:migrate

data/README.md

@@ -1,15 +1,13 @@
 # RescueFrom
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rescue_from`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is the gem that brings together disparate systems within OpenStax and abstracts consistent exception rescuing with html and json responses, and email notifying
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rescue_from'
+gem 'rescue_from', '~> 1.0.0'
 ```
 
 And then execute:
@@ -22,20 +20,170 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Run the install generator to get the config initializer
+
+```
+$ rails g open_stax:rescue_from:install
+```
+
+Declare that you want to use the openstax exception rescuer in your controller, preferably your `ApplicationController`
+
+```ruby
+class ApplicationController < ActionController::Base
+
+  # ...
+
+  use_openstax_exception_rescue
+
+  # ...
+
+  # Override the rescued hook which is called when configuration.raise_exceptions is false
+  # (See 'Controller hook')
+  #
+  # def openstax_exception_rescued(exception_proxy)
+  #   app_name = openstax_rescue_config.app_name
+  #     # RescueFrom.configuration private method available to you
+  #
+  #   respond_to do |f|
+  #     f.xml { render text: "I respond strangely to the XML format!",
+  #                    status: exception_proxy.status }
+  #   end
+  # end
+end
+```
+
+## Configuration
+
+This configuration, which is placed in `./config/initializers/rescue_from.rb` by the install generator, shows the defaults:
+
+```ruby
+OpenStax::RescueFrom.configure do |config|
+  config.raise_exceptions = ![false, 'false'].include?(ENV['RAISE_EXCEPTIONS']) ||
+                              Rails.application.config.consider_all_requests_local
+
+  config.app_name = ENV['APP_NAME']
+  config.app_env = ENV['APP_ENV']
+  config.contact_name = ENV['EXCEPTION_CONTACT_NAME']
+    # can be a name, or a web/email address. See 'View helper' below
+
+  config.notifier = ExceptionNotifier
+
+  config.html_error_template_path = 'errors/any'
+  config.html_error_template_layout_name = 'application'
+
+  config.email_prefix = "[#{app_name}] (#{app_env}) "
+  config.sender_address = ENV['EXCEPTION_SENDER']
+  config.exception_recipients = ENV['EXCEPTION_RECIPIENTS']
+end
+```
+
+## Registering exceptions
+
+In `./config/initializers/rescue_from.rb` it is recommended you register your exceptions
+
+Note that any unregistered exceptions rescued during run-time will be registered with the default options. See below.
+
+```ruby
+require 'openstax_rescue_from'
+
+OpenStax::RescueFrom.configure do |c|
+  # c.app_name ...
+end
+
+# OpenStax::RescueFrom#register_exception default options:
+#
+# { notify: true,
+#   status: :internal_server_error,
+#   extras: ->(exception) { {} } }
+#
+# Any unregistered exceptions rescued during run-time
+# will be registered during rescue with the options above
+
+OpenStax::RescueFrom.register_exception('SecurityTransgression',
+                                        notify: false,
+                                        status: :forbidden)
+
+OpenStax::RescueFrom.register_exception(ActiveRecord::NotFound,
+                                        notify: false,
+                                        status: :not_found)
+
+OpenStax::RescueFrom.register_exception('OAuth2::Error',
+                                        extras: ->(exception) {
+                                          { headers: exception.response.headers,
+                                            status: exception.response.status,
+                                            body: exception.response.body }
+                                        })
+
+OpenStax::RescueFrom.translate_status_codes({
+  forbidden: 'You are not allowed to access this.',
+  not_found: 'We couldn't find what you asked for.',
+})
+#
+# Default:
+#   internal_server_error: "Sorry, #{OpenStax::RescueFrom.configuration.app_name} had some unexpected trouble with your request."
+```
+
+## Controller hook
+```ruby
+#
+#             -- Mixed in Controller module instance method --
+#
+#       -- this method is ONLY called when Exceptions are not raised --
+#
+# -- check your OpenStax::RescueFrom.configuration.raise_exceptions setting --
+#
+
+def openstax_exception_rescued(exception_proxy)
+  @message = exception_proxy.friendly_message
+  @status = exception_proxy.status
+  @error_id = exception_proxy.error_id
+
+  respond_to do |f|
+    f.html { render template: openstax_rescue_config.html_error_template_path,
+                    layout: openstax_rescue_config.html_error_template_layout_name,
+                    status: exception_proxy.status }
+    f.json { render json: { error_id: exception_proxy.error_id }
+                    status: exception_proxy.status }
+    f.all { render nothing: true, status: exception_proxy.status }
+  end
+end
+
+# Just override this method in your own controller if you wish
+```
+
+You will readily note that for HTML response, there is an error template rendered from within the gem. See below for overriding these default views.
+
+## Override the views
+
+You can either declare your own template path variables:
+
+```ruby
+OpenStax::RescueFrom.configure do |config|
+  config.html_error_template_path = 'my/path'
+  config.html_error_template_layout_name = 'my_layout'
+end
+```
+
+or, you can generate the views into the default path:
+
+```
+$ rails g open_stax:rescue_from:views
+```
+
+## View helper
+
+The gem provides an `openstax_rescue_from_contact_info` view helper that uses `OpenStax::RescueFrom.configuration.contact_name` to provide either just the name, or to link web and email addresses automatically for you.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rescue_from.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/openstax/rescue_from.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -4,3 +4,7 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+Bundler::GemHelper.install_tasks
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'

data/app/views/errors/any.html.erb

@@ -0,0 +1,4 @@
+<h3><%= @message %></h3>
+
+<p>We're sorry this <%= @code %> error occurred. If you need help, please contact <%= openstax_rescue_from_contact_info %><%= " and reference error #{@error_id}" if @error_id %>.</p>
+

data/lib/generators/open_stax/rescue_from/install/install_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module OpenStax
+  module RescueFrom
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_initializer
+        copy_file "rescue_from.rb", "config/initializers/rescue_from.rb"
+      end
+    end
+  end
+end

data/lib/generators/open_stax/rescue_from/install/templates/rescue_from.rb

@@ -0,0 +1,51 @@
+require 'openstax_rescue_from'
+
+OpenStax::RescueFrom.configure do |config|
+  config.raise_exceptions = ![false, 'false'].include?(ENV['RAISE_EXCEPTIONS']) ||
+                              Rails.application.config.consider_all_requests_local
+
+  # config.app_name = ENV['APP_NAME']
+  # config.app_env = ENV['APP_ENV']
+  # config.contact_name = ENV['EXCEPTION_CONTACT_NAME']
+
+  # config.notifier = ExceptionNotifier
+
+  # config.html_error_template_path = 'errors/any'
+  # config.html_error_template_layout_name = 'application'
+
+  # config.email_prefix = "[#{app_name}] (#{app_env}) "
+  # config.sender_address = ENV['EXCEPTION_SENDER']
+  # config.exception_recipients = ENV['EXCEPTION_RECIPIENTS']
+end
+
+# OpenStax::RescueFrom#register_exception default options:
+#
+# { notify: true,
+#   status: :internal_server_error,
+#   extras: ->(exception) { {} } }
+#
+# NOTE: Any unregistered exceptions rescued during run-time
+# will be registered with RescueFrom with the above options
+
+# OpenStax::RescueFrom.register_exception('SecurityTransgression',
+#                                         notify: false,
+#                                         status: :forbidden)
+#
+# OpenStax::RescueFrom.register_exception(ActiveRecord::NotFound,
+#                                         notify: false,
+#                                         status: :not_found)
+#
+# OpenStax::RescueFrom.register_exception('OAuth2::Error',
+#                                         notify: true,
+#                                         extras: ->(exception) {
+#                                           { headers: exception.response.headers,
+#                                             status: exception.response.status,
+#                                             body: exception.response.body }
+#
+# OpenStax::RescueFrom.translate_status_codes({
+#   forbidden: "You are not allowed to access this.",
+#   :not_found => "We couldn't find what you asked for.",
+# })
+#
+# Default:
+#   - internal_server_error: "Sorry, #{OpenStax::RescueFrom.configuration.app_name} had some unexpected trouble with your request."

data/lib/generators/open_stax/rescue_from/views/views_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module OpenStax
+  module RescueFrom
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../../../app/views", __FILE__)
+
+      def copy_views
+        copy_file "errors/any.html.erb", "app/views/errors/any.html.erb"
+      end
+    end
+  end
+end

data/lib/openstax/rescue_from/configuration.rb

@@ -1,11 +1,36 @@
+require 'exception_notification'
+
 module OpenStax
   module RescueFrom
     class Configuration
 
-      # attr_accessor, attr_reader, attr_writers for variables
+      attr_accessor :raise_exceptions, :notifier, :html_error_template_path,
+        :html_error_template_layout_name, :app_name, :app_env, :contact_name,
+        :email_prefix, :sender_address, :exception_recipients
 
       def initialize
-        # set default values for variables
+        @raise_exceptions = ![false, 'false'].include?(ENV['RAISE_EXCEPTIONS'])
+
+        @app_name = ENV['APP_NAME']
+        @app_env = ENV['APP_ENV']
+        @contact_name = ENV['EXCEPTION_CONTACT_NAME']
+
+        @notifier = ExceptionNotifier
+
+        @html_error_template_path = 'errors/any'
+        @html_error_template_layout_name = 'application'
+
+        @sender_address = ENV['EXCEPTION_SENDER']
+        @exception_recipients = ENV['EXCEPTION_RECIPIENTS']
+      end
+
+      def email_prefix
+        return(@email_prefix) if defined?(@email_prefix) && !@email_prefix.blank?
+
+        name = app_name.blank? ? nil : "[#{app_name}]"
+        env = app_env.blank? ? nil : "(#{app_env}) "
+
+        @email_prefix = [name, env].compact.join(' ')
       end
     end
   end

data/lib/openstax/rescue_from/controller.rb

@@ -0,0 +1,38 @@
+module OpenStax
+  module RescueFrom
+    module Controller
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def use_openstax_exception_rescue
+          rescue_from Exception do |exception|
+            RescueFrom.perform_rescue(exception, self)
+          end
+        end
+      end
+
+      def openstax_exception_rescued(proxy)
+        @message = proxy.friendly_message
+        @code = proxy.status_code
+        @error_id = proxy.error_id
+
+        respond_to do |f|
+          f.html { render template: openstax_rescue_config.html_error_template_path,
+                          layout: openstax_rescue_config.html_error_template_layout_name,
+                          status: proxy.status }
+
+          f.json { render json: { error_id: proxy.error_id }, status: proxy.status }
+
+          f.all { render nothing: true, status: proxy.status }
+        end
+      end
+
+      private
+      def openstax_rescue_config
+        RescueFrom.configuration
+      end
+    end
+  end
+end

data/lib/openstax/rescue_from/default_exceptions.rb

@@ -0,0 +1,42 @@
+module OpenStax
+  module RescueFrom
+    class DefaultExceptions
+      def self.pre_register!
+        RescueFrom.register_exception(ActiveRecord::RecordNotFound,
+                                      notify: false,
+                                      status: :not_found)
+
+        RescueFrom.register_exception(ActionController::RoutingError,
+                                      notify: false,
+                                      status: :not_found)
+
+        RescueFrom.register_exception(ActionController::UnknownController,
+                                      notify: false,
+                                      status: :not_found)
+
+        RescueFrom.register_exception(ActionController::InvalidAuthenticityToken,
+                                      notify: false,
+                                      status: :unprocessable_entity)
+
+        RescueFrom.register_exception(AbstractController::ActionNotFound,
+                                      notify: false,
+                                      status: :not_found)
+
+        RescueFrom.register_exception(ActionView::MissingTemplate,
+                                      notify: false,
+                                      status: :bad_request)
+
+        RescueFrom.register_exception('SecurityTransgression',
+                                      notify: false,
+                                      status: :forbidden)
+
+        RescueFrom.register_exception('OAuth2::Error',
+                                      extras: ->(ex) {
+                                        { headers: ex.response.headers,
+                                          status: ex.response.status,
+                                          body: ex.response.body }
+                                      })
+      end
+    end
+  end
+end

data/lib/openstax/rescue_from/engine.rb

@@ -0,0 +1,33 @@
+require 'openstax/rescue_from/default_exceptions'
+
+module OpenStax
+  module RescueFrom
+    class Engine < ::Rails::Engine
+      initializer 'openstax.rescue_from.inflection' do
+        ActiveSupport::Inflector.inflections do |inflect|
+          inflect.acronym 'OpenStax'
+        end
+      end
+
+      initializer "openstax.rescue_from.action_controller" do
+        ActionController::Base.send :include, Controller
+      end
+
+      initializer "openstax.rescue_from.view_helpers" do
+        ActionView::Base.send :include, ViewHelpers
+      end
+
+      initializer "openstax.rescue_from.use_exception_notification_middleware" do
+        Rails.application.config.middleware.use ExceptionNotification::Rack, email: {
+          email_prefix: RescueFrom.configuration.email_prefix,
+          sender_address: RescueFrom.configuration.sender_address,
+          exception_recipients: RescueFrom.configuration.exception_recipients
+        }
+      end
+
+      initializer "openstax.rescue_from.pre_register_exceptions" do
+        OpenStax::RescueFrom::DefaultExceptions.pre_register!
+      end
+    end
+  end
+end

data/lib/openstax/rescue_from/exception_options.rb

@@ -0,0 +1,22 @@
+module OpenStax
+  module RescueFrom
+    class ExceptionOptions
+      attr_accessor :notify, :status_code, :extras
+
+      def initialize(options = {})
+        options.stringify_keys!
+        options = { 'notify' => true,
+                    'status' => :internal_server_error,
+                    'extras' => ->(exception) { {} } }.merge(options)
+
+        @notify = options['notify']
+        @status_code = options['status']
+        @extras = options['extras']
+      end
+
+      def notify?
+        @notify
+      end
+    end
+  end
+end

data/lib/openstax/rescue_from/exception_proxy.rb

@@ -0,0 +1,55 @@
+module OpenStax
+  module RescueFrom
+    class ExceptionProxy
+      attr_reader :exception
+
+      def initialize(exception)
+        @exception = exception
+      end
+
+      def name
+        @name ||= exception.class.name
+      end
+
+      def error_id
+        @error_id ||= RescueFrom.generate_id
+      end
+
+      def message
+        @message ||= exception.message
+      end
+
+      def friendly_message
+        RescueFrom.friendly_message(status)
+      end
+
+      def extras
+        @extras ||= RescueFrom.extras_proc(name).call(exception)
+      end
+
+      def cause
+        @cause ||= exception.respond_to?(:cause) ? exception.cause : nil
+      end
+
+      def backtrace
+        @backtrace ||= cause.blank? ? first_backtrace_line : all_backtrace_lines
+      end
+
+      def all_backtrace_lines
+        @all_backtrace_lines ||= exception.backtrace.join("\n")
+      end
+
+      def first_backtrace_line
+        @first_backtrace_line ||= exception.backtrace.first
+      end
+
+      def status
+        @status ||= RescueFrom.status(name)
+      end
+
+      def status_code
+        @status_code ||= RescueFrom.http_code(status)
+      end
+    end
+  end
+end

data/lib/openstax/rescue_from/logger.rb

@@ -0,0 +1,28 @@
+module OpenStax
+  module RescueFrom
+    class Logger
+      attr_reader :proxy
+
+      def initialize(proxy)
+        @proxy = proxy
+      end
+
+      def record_system_error!(prefix = "An exception occurred")
+        Rails.logger.error("#{prefix}: #{proxy.name} [#{proxy.error_id}] " +
+                           "<#{proxy.message}> #{proxy.extras}\n\n" +
+                           "#{proxy.backtrace}")
+
+        record_system_error_recursively!
+      end
+
+      private
+      def record_system_error_recursively!
+        if proxy.cause
+          RescueFrom.register_exception(proxy.cause.class)
+          @proxy = ExceptionProxy.new(proxy.cause)
+          record_system_error!("Exception cause")
+        end
+      end
+    end
+  end
+end

data/lib/openstax/rescue_from/mute_listener.rb

@@ -0,0 +1,14 @@
+module OpenStax
+  module RescueFrom
+    class MuteListener
+      def openstax_exception_rescued(proxy)
+        Rails.logger.warn("MuteListener does nothing after rescuing " +
+                          "ExceptionProxy#error_id #=> #{proxy.error_id}")
+      end
+
+      def request
+        OpenStruct.new(remote_ip: '0.0.0.0')
+      end
+    end
+  end
+end

data/lib/openstax/rescue_from/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module RescueFrom
-    VERSION = "0.0.1"
+    VERSION = "1.1.0"
   end
 end

data/lib/openstax/rescue_from/view_helpers.rb

@@ -0,0 +1,18 @@
+module OpenStax
+  module RescueFrom
+    module ViewHelpers
+      def openstax_rescue_from_contact_info
+        info = OpenStax::RescueFrom.configuration.contact_name
+
+        if info.match(/\S+@\S+\.\w{2,4}/)
+          mail_to info
+        elsif info.match(/\S+\.\w{2,4}\z/)
+          info = info.match(/\Ahttps?:\/\//) ? info : "http://#{info}"
+          link_to info, info
+        else
+          info
+        end
+      end
+    end
+  end
+end

data/lib/openstax/rescue_from.rb

@@ -0,0 +1,124 @@
+require 'openstax/rescue_from/exception_options'
+require 'openstax/rescue_from/controller'
+require 'openstax/rescue_from/view_helpers'
+require 'openstax/rescue_from/configuration'
+
+module OpenStax
+  module RescueFrom
+    class << self
+      def perform_rescue(exception, listener = MuteListener.new)
+        unless registered_exceptions.keys.include?(exception.class.name)
+          register_exception(exception.class)
+        end
+
+        proxy = ExceptionProxy.new(exception)
+        log_system_error(proxy)
+        send_notifying_exceptions(proxy, listener)
+        finish_exception_rescue(proxy, listener)
+      end
+
+      def register_exception(exception, options = {})
+        name = exception.is_a?(String) ? exception : exception.name
+        @@registered_exceptions ||= {}
+        @@registered_exceptions[name] = ExceptionOptions.new(options)
+      end
+
+      def translate_status_codes(map = {})
+        map.each do |k, v|
+          friendly_status_messages[k] = v
+        end
+      end
+
+      def registered_exceptions
+        @@registered_exceptions.dup
+      end
+
+      def non_notifying_exceptions
+        @@registered_exceptions.reject { |_, v| v.notify? }.keys
+      end
+
+      def notifying_exceptions
+        @@registered_exceptions.select { |_, v| v.notify? }.keys
+      end
+
+      def friendly_message(status)
+        friendly_status_messages[status] || default_friendly_message
+      end
+
+      def notifies_for?(exception_name)
+        notifying_exceptions.include?(exception_name)
+      end
+
+      def status(exception_name)
+        @@registered_exceptions[exception_name].status_code
+      end
+
+      def http_code(status)
+        Rack::Utils.status_code(status)
+      end
+
+      def extras_proc(exception_name)
+        @@registered_exceptions[exception_name].extras
+      end
+
+      def generate_id
+        "%06d#{SecureRandom.random_number(10**6)}"
+      end
+
+      def configure
+        yield configuration
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      private
+      def friendly_status_messages
+        @@friendly_status_messages ||= {
+          internal_server_error: default_friendly_message
+        }
+      end
+
+      def default_friendly_message
+        "Sorry, #{configuration.app_name} had some unexpected trouble with your request."
+      end
+
+      def resolve_ip(ip)
+        Resolv.getname(ip) rescue 'unknown'
+      end
+
+      def log_system_error(proxy)
+        logger = Logger.new(proxy)
+        logger.record_system_error!
+      end
+
+      def send_notifying_exceptions(proxy, listener)
+        if notifies_for?(proxy.name)
+          configuration.notifier.notify_exception(
+            proxy.exception,
+            env: listener.request.env,
+            data: {
+              error_id: proxy.error_id,
+              :class => proxy.name,
+              message: proxy.message,
+              first_line_of_backtrace: proxy.first_backtrace_line,
+              cause: proxy.cause,
+              dns_name: resolve_ip(listener.request.remote_ip),
+              extras: proxy.extras
+            },
+            sections: %w(data request session environment backtrace)
+          )
+        end
+      end
+
+      def finish_exception_rescue(proxy, listener)
+        if configuration.raise_exceptions
+          raise proxy.exception
+        else
+          listener.openstax_exception_rescued(proxy)
+        end
+      end
+    end
+  end
+end

data/lib/openstax_rescue_from.rb

@@ -1,37 +1,11 @@
-ActiveSupport::Inflector.inflections do |inflect|
-  inflect.acronym 'OpenStax'
-end
-
-require "openstax/rescue_from/configuration"
-require "openstax/rescue_from/version"
-
-module OpenStax
-  module RescueFrom
+require 'openstax/rescue_from'
+require 'openstax/rescue_from/version'
+require 'openstax/rescue_from/engine'
 
-      class << self
+require 'openstax/rescue_from/mute_listener'
+require 'openstax/rescue_from/logger'
 
-      ###########################################################################
-      #
-      # Configuration machinery.
-      #
-      # To configure OpenStax RescueFrom, put the following code in your
-      # application's initialization logic
-      # (eg. in the config/initializers in a Rails app)
-      #
-      #   OpenStax::RescueFrom.configure do |config|
-      #     config.<parameter name> = <parameter value>
-      #     ...
-      #   end
-      #
+require 'openstax/rescue_from/exception_proxy'
 
-      def configure
-        yield configuration
-      end
-
-      def configuration
-        @configuration ||= Configuration.new
-      end
-
-    end
-  end
+module OpenStax
 end

data/{rescue_from.gemspec → openstax_rescue_from.gemspec}

@@ -6,8 +6,8 @@ require 'openstax/rescue_from/version'
 Gem::Specification.new do |spec|
   spec.name          = "openstax_rescue_from"
   spec.version       = OpenStax::RescueFrom::VERSION
-  spec.authors       = ["JP Slavinsky"]
-  spec.email         = ["jps@kindlinglabs.com"]
+  spec.authors       = ["JP Slavinsky", "Joe Sak"]
+  spec.email         = ["jps@kindlinglabs.com", "joe@avant-gardelabs.com"]
 
   spec.summary       = %q{Common exception `rescue_from` handling for OpenStax sites.}
   spec.homepage      = "https://github.com/openstax/rescue_from"
@@ -18,7 +18,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rails", '>= 3.1', '< 5.0'
+  spec.add_dependency "exception_notification", '>= 4.1', '< 5.0'
+
+  spec.add_development_dependency "pg", '~> 0.18.3'
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails", '~> 3.3.3'
+  spec.add_development_dependency "pry-nav", '~> 0.2.4'
+  spec.add_development_dependency "pry-rails", '~> 0.3.4'
+  spec.add_development_dependency "database_cleaner", '~> 1.5.0'
 end

metadata

@@ -1,77 +1,190 @@
 --- !ruby/object:Gem::Specification
 name: openstax_rescue_from
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - JP Slavinsky
+- Joe Sak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-17 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: exception_notification
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
 description: 
 email:
 - jps@kindlinglabs.com
+- joe@avant-gardelabs.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/views/errors/any.html.erb
 - bin/console
 - bin/setup
+- lib/generators/open_stax/rescue_from/install/install_generator.rb
+- lib/generators/open_stax/rescue_from/install/templates/rescue_from.rb
+- lib/generators/open_stax/rescue_from/views/views_generator.rb
+- lib/openstax/rescue_from.rb
 - lib/openstax/rescue_from/configuration.rb
+- lib/openstax/rescue_from/controller.rb
+- lib/openstax/rescue_from/default_exceptions.rb
+- lib/openstax/rescue_from/engine.rb
+- lib/openstax/rescue_from/exception_options.rb
+- lib/openstax/rescue_from/exception_proxy.rb
+- lib/openstax/rescue_from/logger.rb
+- lib/openstax/rescue_from/mute_listener.rb
 - lib/openstax/rescue_from/version.rb
+- lib/openstax/rescue_from/view_helpers.rb
 - lib/openstax_rescue_from.rb
-- rescue_from.gemspec
+- openstax_rescue_from.gemspec
 homepage: https://github.com/openstax/rescue_from
 licenses:
 - MIT
@@ -82,17 +195,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Common exception `rescue_from` handling for OpenStax sites.