openstax_rescue_from 1.4.0 → 1.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YWRiNjg3NmVhNWU4ZGViMzRlZGRhMmIyYzVmZTZiOWY0ODRhODdiNQ==
+    NmZjZTU4YTYyNGM5MDQyYmQwYTJiMzIxZGM3MDRkNmM1M2RjZmM4ZQ==
   data.tar.gz: !binary |-
-    NzljMGY2Y2ViNjY2OTlkYjJlMjA4YmQ0NDY2YzUxNjFkOTdiY2E4YQ==
+    ZTdjZDk5YTAwMWY5YzU2NThjNjBiOWQ1YmM1ZWUwZDdjNzIxYjJkOQ==
 SHA512:
   metadata.gz: !binary |-
-    YTUyMWE3NGM4YThiZjQ3ZDk1MTJjNWU5NzgyZDkwMDQ0OGUxZWVkYWNhNWVk
-    ZTY0Y2NmMGVkNWI1NDk3YmYxYTE4YTgzYjgxMGFmMTJmNzUwYjk1NTdjNmI4
-    OWJhMDM1ZTkzYjlhNTU5OWVkNDE3NmI3NjJjY2Y1YzRhNTU0MWY=
+    Y2RmMGEwOWJkMjkyZjk4OGFmOGYxMGUyNDM5MjcwMDYwMWMyNTQyMzBkYWU2
+    YzcyZDRlYzJkNTNjNmI2ODFhZDRhOTQ1NjQ0N2MyZmJiOGM3ZWEzNTI0N2U2
+    MzIxMDNmMjczNjkxY2RkODY5YWI2ZTg5ZjZiNDQ0ODYzMTZkMGE=
   data.tar.gz: !binary |-
-    MGYyMjQ3MWNjOTNkY2ExMzgzNTg0OWQxN2JjYTgxZTExOTA3YjA5Y2Y2MzNj
-    NGQwZWNhZmJhZjIzZTQ4YmEzNmZhYjQzYWIxMGZjOTBjY2I0NTVkNzM5Mzk3
-    NzEzZDA0NWRmNjQwMzIyYmMzMTA2OTBmZjc3NDJlMTVmMWI1NDI=
+    ZDUyNGM4ZTZkMGZjYjFkNGM4NDNmNGVhMWZmYmVhMWExZjc3NmJlNjhlY2Q5
+    OWNjOTBiZjUwZmE4YTY5MDQ4NjdmNjgzNDVhNTBhNzEzOGRmMmQ4NmMzZjYx
+    NmJjMzBjZDhkOWRiY2E5YzEyMTlmMjMwZmRlZWM5MDdlYjhkYTI=

data/README.md

@@ -56,6 +56,36 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+## Registering Exceptions
+
+```ruby
+# Use OpenStax::RescueFrom.register_exception(exception_constant_or_string, options = {})
+# to register new exceptions or override the options of existing ones
+
+OpenStax::RescueFrom.register_exception(SecurityTransgression, status: 403,
+                                                               extras: -> (exception) {
+                                                                 { headers: exception.response.headers }
+                                                               })
+
+OpenStax::RescueFrom.register_exception('ActiveRecord::RecordNotFound', notify: false,
+                                                                        status: 404)
+
+# Use OpenStax::RescueFrom.register_unrecognized_exception(exception_constant_or_string, options = {})
+# to register ONLY unrecognized exceptions, to avoid accidental overwriting of options
+
+OpenStax::RescueFrom.register_unrecognized_exception(SecurityTransgression)
+
+# when used with example above, the above example's options will prevail
+
+# Default options:
+#
+# { notify: true,
+#   status: :internal_server_error,
+#   extras: ->(exception) { {} } }
+```
+
+**Note:** If you want to define `extras`, you **must** use a function that accepts `exception` as its argument
+
 ## Configuration
 
 This configuration, which is placed in `./config/initializers/rescue_from.rb` by the install generator, shows the defaults:
@@ -81,52 +111,6 @@ OpenStax::RescueFrom.configure do |config|
 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
 #
@@ -139,7 +123,7 @@ OpenStax::RescueFrom.translate_status_codes({
 # Params:
 #   exception_proxy - an OpenStax::RescueFrom::ExceptionProxy wrapper around
 #     the exception
-#   did_notify - true iff the exception was sent out to notification channels
+#   did_notify - true if the exception was sent out to notification channels
 #     such as email or the log file
 #
 
@@ -147,6 +131,7 @@ def openstax_exception_rescued(exception_proxy, did_notify)
   @message = exception_proxy.friendly_message
   @status = exception_proxy.status
   @error_id = exception_proxy.error_id
+  @did_notify = did_notify
 
   respond_to do |f|
     f.html { render template: openstax_rescue_config.html_error_template_path,

data/lib/openstax/rescue_from/default_exceptions.rb

@@ -40,6 +40,10 @@ module OpenStax
         RescueFrom.register_exception('Apipie::ParamMissing',
                                       notify: false,
                                       status: :unprocessable_entity)
+
+        RescueFrom.register_exception(ActionController::UnknownHttpMethod,
+                                      notify: false,
+                                      status: :bad_request)
       end
     end
   end

data/lib/openstax/rescue_from/logger.rb

@@ -18,7 +18,7 @@ module OpenStax
       private
       def record_system_error_recursively!
         if @proxy = proxy.cause
-          RescueFrom.register_exception(proxy.name)
+          RescueFrom.register_unrecognized_exception(proxy.name)
           record_system_error!("Exception cause")
         end
       end

data/lib/openstax/rescue_from/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module RescueFrom
-    VERSION = "1.4.0"
+    VERSION = "1.5.0"
   end
 end

data/lib/openstax/rescue_from.rb

@@ -7,11 +7,8 @@ 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)
+        register_unrecognized_exception(proxy.name)
         log_system_error(proxy)
         send_notifying_exceptions(proxy, listener)
         finish_exception_rescue(proxy, listener)
@@ -23,6 +20,12 @@ module OpenStax
         @@registered_exceptions[name] = ExceptionOptions.new(options)
       end
 
+      def register_unrecognized_exception(exception_class, options = {})
+        unless registered_exceptions.keys.include?(exception_class)
+          register_exception(exception_class, options)
+        end
+      end
+
       def translate_status_codes(map = {})
         map.each do |k, v|
           friendly_status_messages[k] = v

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstax_rescue_from
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - JP Slavinsky
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails