exceptionally 1.2.0 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e77886643295e91bf4a2e09856348134c3c92963
-  data.tar.gz: c11a2627249286059b11cefa7e4136ad593f254a
+SHA256:
+  metadata.gz: e2a92e4f0938ce4c7f74f4f52afeb6d3c59ccf79e31f8b8c6bfab7b6b471c6bf
+  data.tar.gz: 154055e1a6a6db7fc4a890f000540d58cae02f4f358857fe514a4e6326e58c7e
 SHA512:
-  metadata.gz: 42680626c27ea7700f6328df15ae10508e27d113c370282e903361eb185785dacb1f18c2fb7edd717f3724f7dbc7879ac315f90caf8ee135ffe561d6ffe766a2
-  data.tar.gz: 0923b8cae35d726ac76d671aa32061e3bd1c87e7a3c4fdf06821f0f13a06da445d9b5a137f7b04f6489e54a8a5c1a9c950a1407bfc51d6a585728e7fc7553857
+  metadata.gz: debbfc6ed9668bc19f3267f62b8f15c4d2eda7e892f3c15a128ca11e4639d13db4bdfdad9d3558bb5a0fab3a32741b79cd6f0b7d3e95c7505c16fd62e6b5bc8e
+  data.tar.gz: 5a7272c52c64b6dfced6ce8f5a80867fece96bdb9c5d366439fd8714970439fe5e6d42991c54e8778b81779f099ac72feccc0b07694ddbe320ab57d14f8c6f41

data/README.md

@@ -73,14 +73,14 @@ end
 You can also override the returned response by adding a `render_error` method to your controller. For example, if you want to include the HTTP status code in the returned JSON, you can do:
 
 ```ruby
-def render_error(message, status)
-  render json: {error_message: message, error_status: status}, status: status
+def render_error(error, status)
+  render json: {error_message: error.message, error_status: status}, status: status
 end
 ```
 
 You could also return HTML, XML, or whatever other format is relevant to your application.
 
-`render_error` must accept `message`, a string description of the error, and `status`, an integer HTTP status code.
+`render_error` must accept `error`, the StandardError object that was raised, and `status`, an integer HTTP status code.
 
 #### Add custom errors
 
@@ -92,22 +92,21 @@ Exceptionally will handle the following errors by default:
 * ActiveRecord::RecordInvalid
 * Apipie::ParamMissing (if using [Apipie](https://github.com/Apipie/apipie-rails))
 * Apipie::ParamInvalid (if using [Apipie](https://github.com/Apipie/apipie-rails))
-* Pundit::NotAuthorizedError (if using [Pundit](https://github.com/elabs/pundit))
 * Exceptionally errors (see below for available errors)
 
 If there are additional errors that you want to assign status codes to and pass to Exceptionally, you can add the following to the top of your `application_controller.rb`:
 
 ```ruby
-# Catch MyCustomModule::BadRequestException errors and pass them to Exceptionally
-rescue_from MyCustomModule::BadRequestException, :with => :custom_400_error
+# Catch SomeGem::NotAuthorizedError errors and pass them to Exceptionally
+rescue_from SomeGem::NotAuthorizedError, :with => :not_authorized_error
 
-# Tell Exceptionally you want this treated as a 400 error
-def custom_400_error(error)
-  pass_to_error_handler(error, 400)
+# Tell Exceptionally you want this treated as a 401 error
+def not_authorized_error(error)
+  pass_to_error_handler(error, 401)
 end
 ```
 
-`pass_to_error_handler` takes a Ruby Exception object and an optional status code. If no status code is provided, it will default to 500.
+`pass_to_error_handler` takes a Ruby Exception object and a status code. If no status code is provided, it will default to 500.
 
 ## Available Errors
 
@@ -147,6 +146,10 @@ You can also raise an error with just the HTTP status code by using `Exceptional
 
 By abstracting all of the exception handling logic, Exceptionally DRY's up your code and makes it easier to read. If you later decide to change the format of your error responses, you just need to edit `render_error` in one place. Exceptionally also transparently handles ActiveRecord, Apipie, and other generic exceptions for you, so that your app is less likely to crash. Additionally, you get a bunch of logging and error reporting functionality for free.
 
+## Changelog
+
+See [changelog](https://github.com/neilgupta/exceptionally/blob/master/CHANGELOG.md) to check for breaking changes between versions.
+
 ## Author
 
 Neil Gupta [http://metamorphium.com](http://metamorphium.com)

data/lib/exceptionally/controller.rb

@@ -14,9 +14,6 @@ module Exceptionally
         rescue_from Apipie::ParamMissing, :with => :missing_param
         rescue_from Apipie::ParamInvalid, :with => :invalid_param
       end
-      if defined?(Pundit)
-        rescue_from Pundit::NotAuthorizedError, with: :not_authorized_error
-      end
     end
 
     # Raise custom error
@@ -29,11 +26,6 @@ module Exceptionally
       pass_to_error_handler(error, 400)
     end
 
-    # Raise 401 error
-    def not_authorized_error(error)
-      pass_to_error_handler(error, 401)
-    end
-
     # Raise 404 error
     def missing_record_handler(error)
       pass_to_error_handler(error, 404)
@@ -43,7 +35,7 @@ module Exceptionally
     def record_invalid_handler(error)
       pass_to_error_handler(error, 409)
     end
-    
+
     # Raise 422 error
     def invalid_param(error)
       pass_to_error_handler(error, 422)
@@ -52,11 +44,11 @@ module Exceptionally
     def pass_to_error_handler(error, status = nil)
       status ||= error.try(:status) || 500
       Exceptionally::Handler.new(error.message, status, error, params)
-      render_error(error.message, status)
+      render_error(error, status)
     end
 
-    def render_error(message, status)
-      render json: {error: message}, status: status
+    def render_error(error, status)
+      render json: {error: error.message}, status: status
     end
 
   end

data/lib/exceptionally/handler.rb

@@ -6,8 +6,11 @@ module Exceptionally
       @error = e
       @params = params || {}
 
+      f = ActionDispatch::Http::ParameterFilter.new(Rails.application.config.filter_parameters)
+      @params = f.filter @params
+
       @@callback.call(@message, @status, @error, @params) if defined?(@@callback) && @@callback.respond_to?(:call)
-      
+
       log
     end
 

data/lib/exceptionally/version.rb

@@ -1,3 +1,3 @@
 module Exceptionally
-  VERSION = "1.2.0"
+  VERSION = '1.4.3'.freeze
 end

data/spec/exceptionally/handler_spec.rb

@@ -9,6 +9,18 @@ describe ActionController, :type => :controller do
 
   before do
     routes.draw { get 'index' => "anonymous#index" }
+    Rails.application.config.filter_parameters = [:password]
+  end
+
+  it 'filters password parameter' do
+    temp_params = nil
+    Exceptionally::Handler.before_render do |message, status, error, params|
+      temp_params = params
+    end
+
+    get :index, username: 'bob', password: '123456'
+    expect(temp_params['username']).to eq('bob')
+    expect(temp_params['password']).to eq('[FILTERED]')
   end
 
   it 'logs 5xx errors' do
@@ -33,20 +45,20 @@ describe ActionController, :type => :controller do
   end
 
   it 'calls handler before logging an error when set' do
-    temp_var = nil
+    temp_message = nil
     Exceptionally::Handler.before_render do |message, status, error, params|
-      temp_var = message
+      temp_message = message
     end
 
     get :index
-    expect(temp_var).to eq('Internal Server Error')
+    expect(temp_message).to eq('Internal Server Error')
   end
 
   it 'does not call handler before logging an error when none is proved' do
-    temp_var = nil
+    temp_message = nil
 
     get :index
-    expect(temp_var).to eq(nil)
+    expect(temp_message).to eq(nil)
   end
 
   describe 'when only Raven is defined' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exceptionally
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.3
 platform: ruby
 authors:
 - Neil Gupta
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2020-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +98,7 @@ homepage: https://github.com/neilgupta/exceptionally
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,45 +113,43 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Exceptionally simple Rails Exception library
 test_files:
+- spec/spec_helper.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/rake
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
-- spec/dummy/bin/rake
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/locales/en.yml
 - spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/cookies_serializer.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/config/secrets.yml
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config.ru
-- spec/dummy/public/404.html
+- spec/dummy/public/favicon.ico
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
+- spec/dummy/public/404.html
 - spec/dummy/version.rb
+- spec/exceptionally/handler_spec.rb
 - spec/exceptionally/config_spec.rb
 - spec/exceptionally/controller_spec.rb
-- spec/exceptionally/handler_spec.rb
-- spec/spec_helper.rb
-has_rdoc: