openstax_rescue_from 1.2.0 → 1.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDA1Mzg0OTJkMDhiMDFmOTk0NDExNGJiZmQ5ZDU4ZWE1NzYyY2E2Yw==
+    ZjY0Mjk0YjIwNjgwNjE4ZDQ5MTFhNDdmNzIwNGRkNzc5MDFlOWRlMw==
   data.tar.gz: !binary |-
-    ZDIyNjBlZmFhNDY3MDNhMGVkYzllMDk1OWZkOGQwNTI0NWMwMTQ0Zg==
+    NzJlZDRmNjMwNjdmMzUwMzgyNTIwMGYzN2NmNWZhZTM1Njg5MjU4Nw==
 SHA512:
   metadata.gz: !binary |-
-    MmJmODJmNjk5OTg0NTRlNTE1YTVjNzJmNWEwOTczNmNjNDMzYWJhNWUxMDkw
-    ZmI4MjdhMWM4NDkwMzNmNGIxNDgxOWE2ODFiZTg1NDhmNzU1OTlkNDA5Nzcy
-    NTA4ZjUxYTdhYWU2MGUzNzhlNGE3NjI0N2Y2MzFiNjMwYjJiZDI=
+    NDBmMTJiOTg1ZGQwODhjZTM4NWZjY2ZhMTNhMTc2MGYzODdkZGRmZWRlMGYy
+    MmNmMTA1M2VmMTcyNjE0NGIzNzZlN2UxNzhmM2QyMzhlODY3MWY2ZDg3OGU4
+    OGRiZWU1MDRhY2I0NGQ0Mjc5NDk5ZGE5MTZkMGNhMzk5YzNiMjg=
   data.tar.gz: !binary |-
-    ZDllNDEzY2FlMTgwMjI1ZjliYTNhNWY1MzU4NzM3NmM2OTJiMjI1Mjg3MmFi
-    MDcxY2QxNmVlZTFmM2YyYmMwMmVhNjVhNjZjZjhiMzFlYmRhOTU3NjA5MjZh
-    ZTk0YTg5MTk0OGM2ZmNmZjJmZGU0MTk2YjQ0YmZiMTM2M2ZjMDk=
+    YzczZDMwZGVhN2I1ODg1NGY0NGY3ODg0ZmMxMzgxNDgwODliMzFlMTAyNzk1
+    YzZmYjQ5MGVhY2Q3MmJmYzhiNjhmNjIzYmZjNWIyYzA3NjZlNDAzOWU4OWIw
+    N2Y1MGZhZDNiMDY3MGUxYjhhNWIzYmI3MzkwZTJlM2Q5M2JhYzI=

data/README.md

@@ -44,7 +44,7 @@ class ApplicationController < ActionController::Base
   # Override the rescued hook which is called when configuration.raise_exceptions is false
   # (See 'Controller hook')
   #
-  # def openstax_exception_rescued(exception_proxy)
+  # def openstax_exception_rescued(exception_proxy, did_notify)
   #   app_name = openstax_rescue_config.app_name
   #     # RescueFrom.configuration private method available to you
   #
@@ -136,8 +136,14 @@ OpenStax::RescueFrom.translate_status_codes({
 #
 # -- check your OpenStax::RescueFrom.configuration.raise_exceptions setting --
 #
+# Params:
+#   exception_proxy - an OpenStax::RescueFrom::ExceptionProxy wrapper around
+#     the exception
+#   did_notify - true iff the exception was sent out to notification channels
+#     such as email or the log file
+#
 
-def openstax_exception_rescued(exception_proxy)
+def openstax_exception_rescued(exception_proxy, did_notify)
   @message = exception_proxy.friendly_message
   @status = exception_proxy.status
   @error_id = exception_proxy.error_id

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

@@ -1,4 +1,4 @@
-<h3><%= @message %></h3>
+<h3 class='rescue-from'><%= @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>
+<p class='rescue-from'>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 && @did_notify %>.</p>
 

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

@@ -49,7 +49,7 @@ end
 #
 # Default:
 #   - internal_server_error: "Sorry, #{OpenStax::RescueFrom.configuration.app_name} had some unexpected trouble with your request."
-#   - not_found: 'Sorry, we could not find that resource.',
+#   - not_found: 'We could not find the requested information.',
 #   - bad_request: 'The request was unrecognized.',
 #   - forbidden: 'You are not allowed to do that.'
-#   - unprocessable_entity: 'The entity could not be processed.'
+#   - unprocessable_entity: 'Your browser asked for something that we cannot do.'

data/lib/openstax/rescue_from/configuration.rb

@@ -5,9 +5,15 @@ module OpenStax
     class Configuration
 
       attr_accessor :raise_exceptions, :notifier, :html_error_template_path,
-        :html_error_template_layout_name, :app_name, :app_env, :contact_name,
+        :html_error_template_layout_name, :app_name, :app_env,
         :email_prefix, :sender_address, :exception_recipients
 
+      attr_writer :contact_name
+
+      def contact_name
+        @contact_name || "us"
+      end
+
       def initialize
         @raise_exceptions = ![false, 'false'].include?(ENV['RAISE_EXCEPTIONS'])
 

data/lib/openstax/rescue_from/controller.rb

@@ -13,17 +13,19 @@ module OpenStax
         end
       end
 
-      def openstax_exception_rescued(proxy)
+      def openstax_exception_rescued(proxy, did_notify)
         @message = proxy.friendly_message
         @code = proxy.status_code
         @error_id = proxy.error_id
+        @did_notify = did_notify
 
         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.json { render json: { error_id: did_notify ? proxy.error_id : nil },
+                          status: proxy.status }
 
           f.all { render nothing: true, status: proxy.status }
         end

data/lib/openstax/rescue_from/mute_listener.rb

@@ -1,7 +1,7 @@
 module OpenStax
   module RescueFrom
     class MuteListener
-      def openstax_exception_rescued(proxy)
+      def openstax_exception_rescued(proxy, _)
         Rails.logger.warn("MuteListener does nothing after rescuing " +
                           "ExceptionProxy#error_id #=> #{proxy.error_id}")
       end

data/lib/openstax/rescue_from/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module RescueFrom
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

data/lib/openstax/rescue_from.rb

@@ -62,7 +62,7 @@ module OpenStax
       end
 
       def generate_id
-        "%06d#{SecureRandom.random_number(10**6)}"
+        sprintf "%06d", "#{SecureRandom.random_number(10**6)}"
       end
 
       def configure
@@ -77,10 +77,10 @@ module OpenStax
       def friendly_status_messages
         @@friendly_status_messages ||= {
           internal_server_error: default_friendly_message,
-          :not_found => 'Sorry, we could not find that resource.',
+          :not_found => 'We could not find the requested information.',
           bad_request: 'The request was unrecognized.',
           forbidden: 'You are not allowed to do that.',
-          unprocessable_entity: 'The entity could not be processed.'
+          unprocessable_entity: 'Your browser asked for something that we cannot do.'
         }
       end
 
@@ -93,8 +93,10 @@ module OpenStax
       end
 
       def log_system_error(proxy)
-        logger = Logger.new(proxy)
-        logger.record_system_error!
+        if notifies_for?(proxy.name)
+          logger = Logger.new(proxy)
+          logger.record_system_error!
+        end
       end
 
       def send_notifying_exceptions(proxy, listener)
@@ -120,7 +122,7 @@ module OpenStax
         if configuration.raise_exceptions
           raise proxy.exception
         else
-          listener.openstax_exception_rescued(proxy)
+          listener.openstax_exception_rescued(proxy, notifies_for?(proxy.name))
         end
       end
     end

metadata

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