exceptionally 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba1c7c909a88df38b73db95b8b1b3a759491c055e2446663d5db20a9af8d8ae6
-  data.tar.gz: bbb135606b8f05a8fc110244343755bc8b910c6dd4e0924c6d67b705b86d9b0c
+  metadata.gz: f9d4a53e48cb1f26ccee7b4cfdff3c4f1fdef4f482860a24aa490e8e666e12c2
+  data.tar.gz: ca348946c50cc2248477db81ae54bac7ecb6c7697fbd3d3e1b45046478c9f92d
 SHA512:
-  metadata.gz: d50d1d914c77d037f46b288b801e0f25667c2f93cd418a0df3f074004f08b01db2588b452379af0cbcc601d997c5f812fbb4555c7b271e9fd178bce171b09af3
-  data.tar.gz: ec35da96178d510ccd80b634eccd8bed538c9d1bdb67a88b63a7aa560c95dcc0d64f000c206aee94cef26967265d1556ed8b1ceab2acb77fbcab1f0e0d14d340
+  metadata.gz: be4684bb91408431bb4678db6efa568387ba5cdb4447a8587282c2d7f3fc6d20e4fc41cbb800c663a3310959336ffac8574d9dc21133ed4aa286e36315a8c312
+  data.tar.gz: 5f8c5efbec8d42941a89cd368d98f85e3c0b4b4af7ba1b53e80e5f4c6ec454cbbda1b042c41a4f95596d279cc5a078d590d1dacf1df68bbdacdd2efd30fe1afb

data/README.md

@@ -38,19 +38,11 @@ In addition to seamlessly abstracting your exception logic and returning clean J
 
 If you raise a 500-level error, Exceptionally will log the error, backtrace, and relevant parameters to Rails.logger.
 
-### Error Reporting
-
-Exceptionally supports reporting 500-level errors to [Sentry](http://getsentry.com), [Airbrake](http://airbrake.io), and [New Relic](http://newrelic.com) out of the box, and will notify those services if you have their gems installed. By default, this is only enabled in your `production` environment, but you can control this by setting in `config/initializers/exceptionally.rb`:
-
-```ruby
-Exceptionally.report_errors = true
-```
-
 ### Customizable
 
 #### Add a custom error handler
 
-Need to add more logging, integrate a different service than those listed above, use [BacktraceCleaner](http://api.rubyonrails.org/classes/ActiveSupport/BacktraceCleaner.html), or do something else with the errors before they're returned to the user? Just add the following to `config/initializers/exceptionally.rb`:
+Need to add more logging, integrate with Sentry, use [BacktraceCleaner](http://api.rubyonrails.org/classes/ActiveSupport/BacktraceCleaner.html), or do something else with the errors before they're returned to the user? Just add the following to `config/initializers/exceptionally.rb`:
 
 ```ruby
 Exceptionally::Handler.before_render do |message, status, error, params|
@@ -90,8 +82,8 @@ Exceptionally will handle the following errors by default:
 * ArgumentErrors
 * ActiveRecord::RecordNotFound
 * ActiveRecord::RecordInvalid
-* Apipie::ParamMissing (if using [Apipie](https://github.com/Apipie/apipie-rails))
-* Apipie::ParamInvalid (if using [Apipie](https://github.com/Apipie/apipie-rails))
+* ActiveRecord::RecordNotSaved
+* ActionController::ParameterMissing
 * 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`:
@@ -102,11 +94,11 @@ rescue_from SomeGem::NotAuthorizedError, :with => :not_authorized_error
 
 # Tell Exceptionally you want this treated as a 401 error
 def not_authorized_error(error)
-  pass_to_error_handler(error, 401)
+  pass_to_error_handler(error, 401, {caught_you: true})
 end
 ```
 
-`pass_to_error_handler` takes a Ruby Exception object and a status code. If no status code is provided, it will default to 500.
+`pass_to_error_handler` takes a Ruby Exception object, a status code, and an optional hash that will be returned in the json by merging it with the error message. If no status code is provided, it will default to 500.
 
 ## Available Errors
 
@@ -144,16 +136,20 @@ You can also raise an error with just the HTTP status code by using `Exceptional
 
 ## Why use Exceptionally?
 
-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.
+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 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.
 
+## Development
+
+Run tests with `bundle exec rspec`
+
 ## Author
 
 Neil Gupta [https://neil.gg](https://neil.gg)
 
 ## License
 
-The MIT License (MIT) Copyright (c) 2015 Neil Gupta. See [MIT-LICENSE](https://raw.github.com/neilgupta/exceptionally/master/MIT-LICENSE)
+The MIT License (MIT) Copyright (c) 2023 Neil Gupta. See [MIT-LICENSE](https://raw.github.com/neilgupta/exceptionally/master/MIT-LICENSE)

data/lib/exceptionally/controller.rb

@@ -10,10 +10,8 @@ module Exceptionally
       rescue_from Exceptionally::Error, :with => :exceptionally_handler
       rescue_from ActiveRecord::RecordNotFound, :with => :missing_record_handler
       rescue_from ActiveRecord::RecordInvalid, :with => :record_invalid_handler
-      if defined?(Apipie)
-        rescue_from Apipie::ParamMissing, :with => :missing_param
-        rescue_from Apipie::ParamInvalid, :with => :invalid_param
-      end
+      rescue_from ActiveRecord::RecordNotSaved, :with => :record_not_saved
+      rescue_from ActionController::ParameterMissing, :with => :missing_param_handler
     end
 
     # Raise custom error
@@ -22,7 +20,7 @@ module Exceptionally
     end
 
     # Raise 400 error
-    def missing_param(error)
+    def missing_param_handler(error)
       pass_to_error_handler(error, 400)
     end
 
@@ -37,18 +35,18 @@ module Exceptionally
     end
 
     # Raise 422 error
-    def invalid_param(error)
-      pass_to_error_handler(error, 422)
+    def record_not_saved(error)
+      pass_to_error_handler(error, 422, {validations: error.record.try(:errors)})
     end
 
-    def pass_to_error_handler(error, status = nil)
+    def pass_to_error_handler(error, status = nil, extra = {})
       status ||= error.try(:status) || 500
       Exceptionally::Handler.new(error.message, status, error, params)
-      render_error(error, status)
+      render_error(error, status, extra)
     end
 
-    def render_error(error, status)
-      render json: {error: error.message}, status: status
+    def render_error(error, status = 500, extra = {})
+      render json: {error: error.message}.merge(extra || {}), status: status || 500
     end
 
   end

data/lib/exceptionally/handler.rb

@@ -23,13 +23,6 @@ module Exceptionally
     def log
       # Log 5xx errors
       if @status >= 500 && @error
-        # Support Sentry, Airbrake, and New Relic out of box, but only in production
-        if Exceptionally.report_errors
-          Raven.capture_exception(@error, {logger: 'Exceptionally', extra: {params: @params}}) if defined?(Raven) && Raven.respond_to?(:capture_exception)
-          Airbrake.notify(@error, :parameters => @params) if defined?(Airbrake) && Airbrake.respond_to?(:notify)
-          NewRelic::Agent.notice_error(@error) if defined?(NewRelic) && defined?(NewRelic::Agent) && NewRelic::Agent.respond_to?(:notice_error)
-        end
-
         Rails.logger.error(@error.to_s)
         Rails.logger.error("Parameters: #{@params.to_s}") unless @params.blank?
         Rails.logger.error(@error.backtrace.join("\n")) unless @error.backtrace.blank?

data/lib/exceptionally/version.rb

@@ -1,3 +1,3 @@
 module Exceptionally
-  VERSION = '1.4.4'.freeze
+  VERSION = '1.5.0'.freeze
 end

data/lib/exceptionally.rb

@@ -4,13 +4,4 @@ require 'exceptionally/handler'
 require 'exceptionally/railtie'
 
 module Exceptionally
-  @@report_errors = Rails.env.production?
-
-  def self.report_errors=(report_errors)
-    @@report_errors = report_errors
-  end
-
-  def self.report_errors
-    @@report_errors
-  end
 end

data/spec/dummy/config/initializers/assets.rb

@@ -1,7 +1,7 @@
 # Be sure to restart your server when you modify this file.
 
 # Version of your assets, change this if you want to expire all your assets.
-Rails.application.config.assets.version = '1.0'
+# Rails.application.config.assets.version = '1.0'
 
 # Precompile additional assets.
 # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.