rescue_registry 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4da895627d12dfeacc18cfc33b78f12ba7e2cfd0c1731aa7381e6514cea7e060
-  data.tar.gz: '0782f17a88a32cc3c67273671b3863d2bb54dc4d18e05df1a3c490562cdd798e'
+  metadata.gz: a1680176387616a079a616679ca436f7e1a81ff266c1a6d8d574caa71e6ccab7
+  data.tar.gz: 329c59744d4fc5eddb2a1d91fc3049df660966a54b13625b667e4085b59daeb8
 SHA512:
-  metadata.gz: 20c12e26d6cc417581612e50375a0a8e0de1197ef68d1c28cd96a25392384d72c597582ab72f2e5a62eec3f3fffb223d899552c1b84d1c20f7f526700916877c
-  data.tar.gz: e74c56f15650b175ed028720c4bec65aae5ef39b71bfd668baef3a83d996bc927b60f9257d6bb14723ac2b4f11c489b0bf9cef047b494092d55e8e6bf24573a7
+  metadata.gz: f174ee373dc0352d366bb4e4ad6deedd95185600e904db85fe472622765e0726e6c07678de7f28c002cf5e39279725bc3400f5db105acb81254a20acb0945acb
+  data.tar.gz: a3f82a0a1b907baf038cb274a0fb8d7fbb4198e49dc9f5d6b49aee417b782c22dedd03cb17bf8d314f6507f6faf40cb7dc0928871d1a44d3af81f9692b9305e2

data/CHANGELOG.md

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## [0.3.0] - 2021-05-11
+### Changed
+- For better JSONAPI spec compliance, errors payloads will not include the `details` key when value is `null`.
+- Error payloads will not include the `meta` key when value is an empty object.
+
+## [0.2.5] - 2021-03-09
+### Added
+- `code` can now be provided as an argument to `register_exception` - #29 (thanks @amaierhofer)
+
+## [0.2.4] - 2021-01-22
+### Fixed
+- Support Ruby 3 (thanks @zvkemp and @ef4)
+
+## [0.2.3] - 2020-09-01
+### Fixed
+- Properly handle exceptions for invalid format types - #25 (thanks @shanet)
+
+### Changed
+- Lower minimum Ruby requirement to 2.3 (thanks @elDub)
+
+## [0.2.2] - 2019-06-13
+### Changed
+- Lower minimum Ruby requirement to 2.3 (thanks @elDub)
+
 ## [0.2.1] - 2019-05-22
 ### Added
 - RescueRegistry::RailsTestingHelpers provides some helpers for easier testing in Rails applications.

data/README.md

@@ -58,6 +58,7 @@ class MyController < ActionController::Base
   register_exception MetaProcError, meta: -> (e) { { class_name: e.class.name.upcase } }
   register_exception CustomHandlerError, handler: CustomErrorHandler
   register_exception RailsError, status: 403, handler: RescueRegistry::RailsExceptionHandler
+  register_exception CustomStatusError, status: 422, code: :name_invalid
 end
 ```
 

data/lib/rescue_registry.rb

@@ -46,6 +46,18 @@ module RescueRegistry
       context.rescue_registry.public_send(method, *args)
     end
   end
+
+  # the Module#ruby2_keywords is added starting at ruby 2.7. It lets us mark
+  # these methods as using ruby2-style keyword argument semantics. This will
+  # keep them working correctly on ruby3, and clears a deprecation that
+  # otherwise fires in 2.7+.
+  if respond_to?(:ruby2_keywords, true)
+    class << self
+      REGISTRY_METHODS.each do |method|
+        ruby2_keywords(method)
+      end
+    end
+  end
 end
 
 ActiveSupport.on_load(:before_initialize) do

data/lib/rescue_registry/exception_handler.rb

@@ -21,6 +21,7 @@ module RescueRegistry
       end
 
       @meta = options[:meta]
+      @code = options[:code]
 
       # TODO: Warn about unrecognized options
     end
@@ -29,7 +30,7 @@ module RescueRegistry
     alias_method :status_code, :status
 
     def error_code
-      error_code_from_status
+      @code.presence || error_code_from_status
     end
 
     def title
@@ -74,14 +75,20 @@ module RescueRegistry
         )
       end
 
+      error_payload = {
+        code: error_code,
+        status: status_code.to_s,
+        title: title
+      }
+
+      if (d = detail)
+        error_payload[:detail] = d
+      end
+
+      error_payload[:meta] = payload_meta if payload_meta.any?
+
       {
-        errors: [
-          code: error_code,
-          status: status_code.to_s,
-          title: title,
-          detail: detail,
-          meta: payload_meta
-        ]
+        errors: [error_payload]
       }
     end
 

data/lib/rescue_registry/exceptions_app.rb

@@ -9,12 +9,7 @@ module RescueRegistry
       exception = request.get_header "action_dispatch.exception"
 
       if RescueRegistry.handles_exception?(exception)
-        begin
-          content_type = request.formats.first
-        rescue Mime::Type::InvalidMimeType
-          content_type = Mime[:text]
-        end
-
+        content_type = request.formats.first || Mime[:text]
         response = RescueRegistry.response_for_public(content_type, exception)
       end
 

data/lib/rescue_registry/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RescueRegistry
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rescue_registry
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Wagenet
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
+description:
 email:
 - peter.wagenet@gmail.com
 executables: []
@@ -114,23 +114,26 @@ metadata:
   bug_tracker_uri: https://github.com/wagenet/rescue_registry/issues
   changelog_uri: https://github.com/wagenet/rescue_registry/CHANGELOG.md
   source_code_uri: https://github.com/wagenet/rescue_registry
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Registry for Rails Exceptions
 test_files: []