jsonapi_errors_handler 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba2a86c74563398a7436e21ceea674a26a9672bbfba6c8fadc125df8eed70615
-  data.tar.gz: f56a1281368f6ef3ab4c3a2a38afd1c80affd3997c32acca0f5cfe0784b4ba95
+  metadata.gz: df8269ff040273b0368d86c043bf1cd50fb29503be3d4b5207ffba0aa89d27b8
+  data.tar.gz: 7d85f4979969cf3e914145633c11abc0c6d3ff325671bbe788c614ebb5292d59
 SHA512:
-  metadata.gz: 3661da30d706ed7cdc762136424326c0bca8d749afee213f80479e420d7f639bc1be1ef39954fced7ebf01c2a7a25aa8358dfe9ef5cc38ffb63f2f2984e4da86
-  data.tar.gz: 62f72aa1e1ea8df5b8b68733a14cd3df02705fa47bd4b5c2f1dc5bdc66ef9f3ceb376473608d3927a9eb0669f569aa43e290e7cdc3011635eee35f038510933c
+  metadata.gz: 0d18a2f65e6a93525ec2c45a04714efd01fc8894a87f4d54ffce2652e73c6320ae5ed5447db4499c085a4e335a9162186c1a757d8a6ef6fb8c96bf0c7e6fc625
+  data.tar.gz: 2a3491ecaa2b1c1fcffdbc4d6bcaa430fb80c77c6daa9af55121b4d2ff5532b14781fb07c9a174aeec0e17599700fd50f3629988f99501c1ff0d0f23773186dd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jsonapi_errors_handler (0.1.5)
+    jsonapi_errors_handler (0.1.6)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -40,6 +40,18 @@ From this point you'll have default html errors being serialized. JsonapiErrorsH
 
 If you rise any of errors above in any place of your application, client gets the nicely formatted error message instead of 500
 
+### Handling unexpected errors
+
+If you want to handle all the errors in your API application to deliver nicely formatted JSON response about 500 instead crashing the server, add this when your application loads:
+
+```ruby
+require 'jsonapi_errors_handler'
+
+JsonapiErrorsHandler.configure do |config|
+  config.handle_unexpected = true
+end
+```
+
 ### Custom errors mapping
 
 If you want your custom errors being handled by default, just add them to the mapper
@@ -47,13 +59,28 @@ If you want your custom errors being handled by default, just add them to the ma
 ```ruby
   include JsonapiErrorsHandler
   ErrorMapper.map_errors!({
-      'ActiveRecord::RecordNotFound' => 'JsonapiErrorsHandler::Errors::NotFound',
-      'ActiveRecord::RecordInvalid' => 'JsonapiErrorsHandler::Errors::Invalid',
+      'ActiveRecord::RecordNotFound' => 'JsonapiErrorsHandler::Errors::NotFound'
   })
   rescue_from ::StandardError, with: lambda { |e| handle_error(e) }
 ```
 
-###Custom error logging
+### Handling rails-specific validation errors
+
+To handle validation errors from ActiveRecord or ActiveModel, you need to write custom
+error handler:
+
+```ruby
+rescue_from ActiveRecord::RecordInvalid, with: lambda { |e| handle_validation_error(e) }
+rescue_from ActiveModel::ValidationError, with: lambda { |e| handle_validation_error(e) }
+
+def handle_validation_error(error)
+  error_model = error.try(:model) || error.try(:record)
+  mapped = JsonapiErrorsHandler::Errors::Invalid.new(errors: error_model.errors)
+  render_error(mapped)
+end
+```
+
+### Custom error logging
 
 When you'll include the `jsonapi_errors_handler` to your controller, all errors will be handled and delivered to the client in the nice, formatted
 way.

data/lib/jsonapi_errors_handler.rb

@@ -39,7 +39,7 @@ module JsonapiErrorsHandler
     config.configure(&block)
   end
 
-  def self.config
+  def config
     Configuration.instance
   end
 end

data/lib/jsonapi_errors_handler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonapiErrorsHandler
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_errors_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Sebastian Wilgosz