kinetic_cafe_error 1.7 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e2c0e4bf3c54e900432944fabebcc48c1d8960b
-  data.tar.gz: c54cb33eaf01dd5620e22c85a8b6a1f66c224b97
+  metadata.gz: dc17826f6f7567f2438621fac02064e64fae64ba
+  data.tar.gz: 8ee581bf23ad9bbedcb42638e01d159773f02c35
 SHA512:
-  metadata.gz: 5451adec280190d619f7fc85ae9055aae91b5a0de05676e3395b586c225b71b4ac7e22a3e763c44b78f66449403b92bafd7cac0700038d336e9f5b3f669bbdde
-  data.tar.gz: 38169cedbb31a0391c0f425d5c024eb5bd92aab4193bbd18aabe4b961a8a65181aa12b2072846cf2b9ece3a6343d9b001a76bdc1bc5c746a5b7fe06ff42e5f14
+  metadata.gz: 3398f8cefdabc226f3851a6b4ecf7e9a3dc0db0c135a66699341e71367ab53852745b09cf8856043ba79223a9e096c13ba83ff2405c008effe35979ae494e038
+  data.tar.gz: da175a041e62246c34e837723e0f631b9150f96891aec8271396464aaa3c09dcd456381aa689019bf9b17f04aa3b9b8110fe99874e21c9c143947fc60e1029f7

data/History.rdoc

@@ -1,3 +1,14 @@
+=== 1.8.1 / 2015-10-26
+
+* Re-release because 1.8 was yanked
+
+=== 1.8 / 2015-10-26
+
+* 1 minor enhancement:
+
+  * Add +kinetic_cafe_error_handle_post_error+ to allow for capturing or
+    post-processing of errors after logging and handling.
+
 === 1.7 / 2015-08-05
 
 * 1 minor enhancement:

data/README.rdoc

@@ -65,6 +65,19 @@ automatically injected, which enables the following functionality:
   that can be provided with the kinetic_cafe_error_handler_log_locale helper
   method.
 
+  The error can be then captured for processing by providing the
+  kinetic_cafe_error_handle_post_error method.
+
+  Example for capturing KineticCafe::Errors with raven-ruby for Sentry:
+
+    ExampleController < ActionController
+      include KineticCafe::ErrorHandler
+
+      def kinetic_cafe_error_handle_post_error(error)
+        Raven.capture_exception(error)
+      end
+    end
+
 === Using with Minitest
 
 KineticCafe::Error provides a number of assertions that can help testing that
@@ -110,7 +123,7 @@ KineticCafe::Error provides four experimental matchers:
 
 Add kinetic_cafe_error to your Gemfile:
 
-  gem 'kinetic_cafe_error', '~> 1.7'
+  gem 'kinetic_cafe_error', '~> 1.8'
 
 If not using Rails, install with RubyGems:
 

data/Rakefile

@@ -13,6 +13,7 @@ Hoe.plugin :email unless ENV['CI'] || ENV['TRAVIS']
 
 spec = Hoe.spec 'kinetic_cafe_error' do
   developer('Austin Ziegler', 'aziegler@kineticcafe.com')
+  developer('Jero Sutlovic', 'jsutlovic@kineticcafe.com')
 
   require_ruby_version '>= 1.9.2'
 

data/app/controllers/concerns/kinetic_cafe/error_handler.rb

@@ -35,12 +35,19 @@ module KineticCafe::ErrorHandler
   # This method is called with +error+ when Rails catches a KineticCafe::Error
   # descendant. It logs the message and its cause as severity error. After
   # logging as +error+, it will render to HTML or JSON. The received error is
-  # logged using the value of #kinetic_cafe_error_handler_log_locale.
+  # logged using the value of #kinetic_cafe_error_handler_log_locale. After
+  # rendering to HTML or JSON, +error+ will be passed to a post-processing
+  # handler.
   #
   # HTML is rendered with #kinetic_cafe_error_render_html. JSON is rendered
   # with #kinetic_cafe_error_render_json. Either of these can be overridden in
   # controllers for different behaviour.
   #
+  # The +error+ is passed to #kinetic_cafe_error_handle_post_error to be
+  # handled for post-processing. This should be overridden to implement
+  # post-processing, for example passing the error to an external error
+  # capturing/tracking service such as Airbrake or Sentry.
+  #
   # As an option, +kinetic_cafe_error_handler+ can also be used in a
   # +rescue_from+ block with an error class and parameters, and it will
   # construct the error for handling. The following example assumes that there
@@ -72,6 +79,8 @@ module KineticCafe::ErrorHandler
         kinetic_cafe_error_render_json(error)
       end
     end
+
+    kinetic_cafe_error_handle_post_error(error)
   end
 
   # Render the +error+ as HTML. Uses the template +kinetic_cafe_error/page+
@@ -101,16 +110,24 @@ module KineticCafe::ErrorHandler
     end
   end
 
+  def kinetic_cafe_error_handle_post_error(_error)
+  end
+
   # Write the provided error to the Rails log using the value of
   # #kinetic_cafe_error_handler_log_locale. If the error has a cause, log
-  # that as well.
+  # that as well. Rails.logger.class is expected to have constants matching
+  # error.severity.upcase, which is used to determine the numeric severity
+  # to log the error at.
   def kinetic_cafe_error_log_error(error)
     locale = self.class.kinetic_cafe_error_handler_log_locale
-    Rails.logger.error(error.message(locale))
+    severity = Rails.logger.class.const_get(error.severity.upcase)
+    Rails.logger.add(severity, nil, error.message(locale))
 
     return unless error.cause
 
-    Rails.logger.error(
+    Rails.logger.add(
+      severity,
+      nil,
       t(
         'kinetic_cafe_error.cause',
         message: error.cause.message,

data/lib/kinetic_cafe/error.rb

@@ -25,7 +25,7 @@ module KineticCafe # :nodoc:
   # rescue clause and handled there, as is shown in the included
   # KineticCafe::ErrorHandler controller concern for Rails.
   class Error < ::StandardError
-    VERSION = '1.7' # :nodoc:
+    VERSION = '1.8.1' # :nodoc:
 
     # Get the KineticCafe::Error functionality.
     include KineticCafe::ErrorModule
@@ -176,6 +176,10 @@ module KineticCafe # :nodoc:
       defined?(Rack::Utils) && :bad_request || 400
     end
 
+    def default_severity
+      :error
+    end
+
     def stringify(object, namespace = nil)
       case object
       when Hash

data/lib/kinetic_cafe/error_dsl.rb

@@ -53,22 +53,25 @@ module KineticCafe
     # Define a new error as a subclass of the exception hosting ErrorDSL.
     # Options is a Hash supporting the following values:
     #
-    # +status+:: A number or Ruby symbol representing the HTTP status code
-    #            associated with this error. If not provided, defaults to
-    #            :bad_request. Must be provided if +class+ is provided. HTTP
-    #            status codes are defined in Rack::Utils.
-    # +key+::    The name of the error class to be created. Provide as a
-    #            snake_case value that will be turned into a camelized class
-    #            name. Mutually exclusive with +class+.
-    # +class+::  The name of the class the error is for. If present, +status+
-    #            must be provided to create a complete error class. That is,
+    # +status+::   A number or Ruby symbol representing the HTTP status code
+    #              associated with this error. If not provided, defaults to
+    #              :bad_request. Must be provided if +class+ is provided. HTTP
+    #              status codes are defined in Rack::Utils.
+    # +severity+:: A Ruby symbol representing the severity level associated
+    #              with this error. If not provided, defaults to :error. Error
+    #              severity levels are defined in Logger::Severity.
+    # +key+::      The name of the error class to be created. Provide as a
+    #              snake_case value that will be turned into a camelized class
+    #              name. Mutually exclusive with +class+.
+    # +class+::    The name of the class the error is for. If present, +status+
+    #              must be provided to create a complete error class. That is,
     #
-    #              define_error class: :object, status: :not_found
+    #                define_error class: :object, status: :not_found
     #
-    #            will create an +ObjectNotFound+ error class.
-    # +header+:: Indicates that when this is caught, it should not be returned
-    #            with full details, but should instead be treated as a
-    #            header-only API response. Also available as +header_only+.
+    #              will create an +ObjectNotFound+ error class.
+    # +header+::   Indicates that when this is caught, it should not be
+    #              returned with full details, but should instead be treated as
+    #              a header-only API response. Also available as +header_only+.
     # +internal+:: Generates a response that indicates to clients that the
     #              error should not be shown to users.
     # +i18n_params+:: An array of parameter names that are expected to be
@@ -80,6 +83,7 @@ module KineticCafe
 
       options = options.dup
       status = options[:status]
+      severity = options[:severity]
 
       klass = options.delete(:class)
       if klass
@@ -137,7 +141,11 @@ module KineticCafe
       status ||= defined?(Rack::Utils) && :bad_request || 400
       status.freeze
 
+      severity ||= :error
+      severity.freeze
+
       error.send :define_method, :default_status, -> { status } if status
+      error.send :define_method, :default_severity, -> { severity } if severity
       error.send :private, :default_status
 
       const_set(error_name, error)

data/lib/kinetic_cafe/error_module.rb

@@ -6,6 +6,9 @@ module KineticCafe # :nodoc:
     # The HTTP status to be returned. If not provided in the constructor, uses
     # #default_status.
     attr_reader :status
+    # The severity to be returned. If not provided in the constructor, uses
+    # #default_severity
+    attr_reader :severity
     # Extra data relevant to recipients of the exception, provided on
     # construction.
     attr_reader :extra
@@ -39,6 +42,8 @@ module KineticCafe # :nodoc:
     #             value.
     # +status+::  An override to the HTTP status code to be returned by this
     #             error by default.
+    # +severity+:: An override to the default severity to be returned by this
+    #              error.
     # +i18n_params+:: The parameters to be sent to I18n.translate with the
     #                 #i18n_key.
     # +cause+:: The exception that caused this error. Used to wrap an earlier
@@ -69,6 +74,7 @@ module KineticCafe # :nodoc:
       @message && @message.freeze
 
       @status      = options.delete(:status) || default_status
+      @severity    = options.delete(:severity) || default_severity
       @i18n_params = options.delete(:i18n_params) || {}
       @extra       = options.delete(:extra)
 
@@ -147,6 +153,7 @@ module KineticCafe # :nodoc:
       {
         message:      @message,
         status:       status,
+        severity:     severity,
         name:         name,
         internal:     internal?,
         i18n_message: i18n_message,
@@ -174,9 +181,9 @@ module KineticCafe # :nodoc:
     # Nice debugging version of a KineticCafe::Error
     def inspect
       "#<#{self.class}: name=#{name} status=#{status} " \
-        "message=#{message.inspect} i18n_key=#{i18n_key} " \
-        "i18n_params=#{@i18n_params.inspect} extra=#{extra.inspect} " \
-        "cause=#{cause}>"
+        "severity=#{severity} message=#{message.inspect} " \
+        "i18n_key=#{i18n_key} i18n_params=#{@i18n_params.inspect} " \
+        "extra=#{extra.inspect} cause=#{cause}>"
     end
 
     private

data/test/test_kinetic_cafe_error.rb

@@ -7,7 +7,7 @@ describe KineticCafe::Error do
     it 'defaults correctly' do
       stub I18n, :translate, 'Untranslatable error' do
         expected = '#<KineticCafe::Error: name=error ' \
-          "status=bad_request message=\"Untranslatable error\" " \
+          'status=bad_request severity=error message="Untranslatable error" ' \
           'i18n_key=kcerrors.error i18n_params={} extra=nil cause=>'
         assert_equal expected, exception.inspect
       end
@@ -91,6 +91,7 @@ describe KineticCafe::Error do
       assert_equal(
         {
           status: :bad_request,
+          severity: :error,
           name: 'error',
           internal: false,
           i18n_key: 'kcerrors.error'
@@ -104,6 +105,7 @@ describe KineticCafe::Error do
         {
           error: {
             status: :bad_request,
+            severity: :error,
             name: 'error',
             internal: false,
             i18n_key: 'kcerrors.error'
@@ -121,6 +123,7 @@ describe KineticCafe::Error do
           json: {
             error: {
               status: :bad_request,
+              severity: :error,
               name: 'error',
               internal: false,
               i18n_key: 'kcerrors.error'

data/test/test_kinetic_cafe_error_dsl.rb

@@ -99,6 +99,11 @@ describe KineticCafe::ErrorDSL do
             assert_equal 400, instance.send(:default_status)
           end
         end
+
+        it 'returns :error for #default_severity (private)' do
+          refute base.private_instance_methods.include?(:default_severity)
+          assert_equal :error, instance.send(:default_severity)
+        end
       end
 
       describe 'class-based definition' do
@@ -138,6 +143,22 @@ describe KineticCafe::ErrorDSL do
               assert_equal 400, instance.send(:default_status)
             end
           end
+
+          it 'returns :error for #default_severity (private)' do
+            refute base.private_instance_methods.include?(:default_severity)
+            assert_equal :error, instance.send(:default_severity)
+          end
+        end
+
+        describe 'with severity' do
+          let(:child) {
+            base.define_error class: :child, severity: :fatal
+          }
+
+          it 'returns :fatal for #default_severity (private)' do
+            refute base.private_instance_methods.include?(:default_severity)
+            assert_equal :fatal, instance.send(:default_severity)
+          end
         end
 
         describe 'with symbol status' do

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_cafe_error
 version: !ruby/object:Gem::Version
-  version: '1.7'
+  version: 1.8.1
 platform: ruby
 authors:
 - Austin Ziegler
+- Jero Sutlovic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -16,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.7'
+        version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.7'
+        version: '5.8'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -302,6 +303,7 @@ description: |-
   representations across both clients and servers.
 email:
 - aziegler@kineticcafe.com
+- jsutlovic@kineticcafe.com
 executables: []
 extensions: []
 extra_rdoc_files: