jsonapi_errors_handler 0.1.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba2a86c74563398a7436e21ceea674a26a9672bbfba6c8fadc125df8eed70615
-  data.tar.gz: f56a1281368f6ef3ab4c3a2a38afd1c80affd3997c32acca0f5cfe0784b4ba95
+  metadata.gz: bc11d29415335097f13316a8d7131068d2fbae08555f2a41d4962373dc9df472
+  data.tar.gz: 872131e2bda801b17c18bf670f25fde7550d74a3f58b91d919ea74c803848bf3
 SHA512:
-  metadata.gz: 3661da30d706ed7cdc762136424326c0bca8d749afee213f80479e420d7f639bc1be1ef39954fced7ebf01c2a7a25aa8358dfe9ef5cc38ffb63f2f2984e4da86
-  data.tar.gz: 62f72aa1e1ea8df5b8b68733a14cd3df02705fa47bd4b5c2f1dc5bdc66ef9f3ceb376473608d3927a9eb0669f569aa43e290e7cdc3011635eee35f038510933c
+  metadata.gz: 4dcc44875ddf60f2ecfb5cb039fecafb9e1a60d86e94e3f23432f149d294c9a3b7d61ec1cd4f623cff2197b5a5757788a23e50ba0396543cc0f33a74227f876b
+  data.tar.gz: 93b589ff1d2cc44518c6f74a6438de1eb0d53440007bce1356c394219baa5bd50f77ea4d7ce56e076c98a836173080caeb68b46143bff3a83ff2f6e6252505c5

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Test & Release
+
+on:
+  push:
+    branches: [ release ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7.1
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Run tests
+      run: |
+        bundle install
+        bundle exec rspec
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/gem-test.yml

@@ -0,0 +1,29 @@
+name: Run tests
+
+on:
+  push:
+    branches-ignore: [ release ]
+  pull_request:
+    branches: [ master release ]
+
+jobs:
+  build:
+    name: Build + Test
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7.1
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Run tests
+      run: |
+        bundle install
+        CI=true bundle exec rspec
+    - name: Upload report
+      run: |
+        mv ./coverage/coverage.xml cobertura.xml
+        bash <(curl -Ls https://coverage.codacy.com/get.sh) report
+      env:
+        CODACY_PROJECT_TOKEN: ${{secrets.CODACY_PROJECT_TOKEN}}

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 2.4.0
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+    - "jsonapi_errors_handler.gemspec"
+
+Metrics/ModuleLength:
+  Exclude:
+    - "spec/**/*_spec.rb"

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.7.1

data/CONTRIBUTING.md

@@ -1,21 +1,29 @@
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/driggl/jsonapi_errors_handler.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/driggl/jsonapi_errors_handler>.
 
 **How to contribute:**
 
-1. Create Issue on Github.
-2. Fork repository
-3. Install [Rubocop](https://github.com/rubocop-hq/rubocop) - make sure you run it before commiting changes
-4. Commit changes
-  - Keep commits small and atomic
-  - Start commit message from keywords (Add/Remove/Change/Refactor/Move/Rename/Upgrade/Downgrade)
-  - Keep commits imperative style
-  - Mention issue number (i.e "Resolves: #3")
-5. Make sure you cover your change with tests.
-6. Create Pull Request
+1.  Create Issue on Github.
+
+2.  Fork repository
+
+3.  Install [Rubocop](https://github.com/rubocop-hq/rubocop) - make sure you run it before commiting changes
+
+4.  Commit changes
+    *   Keep commits small and atomic
+
+    *   Start commit message from keywords (Add/Remove/Change/Refactor/Move/Rename/Upgrade/Downgrade)
+
+    *   Keep commits imperative style
+
+    *   Mention issue number (i.e "Resolves: #3")
+
+5.  Make sure you cover your change with tests.
+
+6.  Create Pull Request
 
 **Coding Guidelines**
 
-- We use [Rubocop](https://github.com/rubocop-hq/rubocop) and Ruby style guides for linting `*.rb` files.
-- We use [Remark Lint](https://github.com/remarkjs/remark-lint) for linting `*.md` files.
+*   We use [Rubocop](https://github.com/rubocop*hq/rubocop) and Ruby style guides for linting `*.rb` files.
+*   We use [Remark Lint](https://github.com/remarkjs/remark-lint) for linting `*.md` files.

data/Gemfile.lock

@@ -1,35 +1,44 @@
 PATH
   remote: .
   specs:
-    jsonapi_errors_handler (0.1.5)
+    jsonapi_errors_handler (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-cobertura (1.4.0)
+      simplecov (~> 0.8)
+    simplecov-html (0.12.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler
   jsonapi_errors_handler!
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake
+  rspec
+  simplecov
+  simplecov-cobertura
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -1,6 +1,7 @@
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/542259a14a8f4b2894a39850c5031ffa)](https://app.codacy.com/app/swilgosz/jsonapi_errors_handler?utm_source=github.com&utm_medium=referral&utm_content=driggl/jsonapi_errors_handler&utm_campaign=Badge_Grade_Dashboard)
 [![Gem Version](https://badge.fury.io/rb/jsonapi_errors_handler.svg)](https://badge.fury.io/rb/jsonapi_errors_handler)
-[![CircleCI](https://circleci.com/gh/driggl/jsonapi_errors_handler/tree/master.svg?style=svg)](https://circleci.com/gh/driggl/jsonapi_errors_handler/tree/master)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/6dba6e4556354789809185e0decde4f8)](https://www.codacy.com/gh/driggl/jsonapi_errors_handler?utm_source=github.com&utm_medium=referral&utm_content=driggl/jsonapi_errors_handler&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/6dba6e4556354789809185e0decde4f8)](https://www.codacy.com/gh/driggl/jsonapi_errors_handler?utm_source=github.com&utm_medium=referral&utm_content=driggl/jsonapi_errors_handler&utm_campaign=Badge_Coverage)
+![Run tests](https://github.com/driggl/jsonapi_errors_handler/workflows/Run%20tests/badge.svg?branch=master)
 
 # JsonapiErrorsHandler
 
@@ -16,11 +17,15 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install jsonapi_errors_handler
+```shell
+$ gem install jsonapi_errors_handler
+```
 
 ## Usage
 
@@ -36,10 +41,22 @@ From this point you'll have default html errors being serialized. JsonapiErrorsH
 *   [JsonapiErrorsHandler::Errors::Invalid](https://github.com/driggl/jsonapi_errors_handler/blob/master/lib/jsonapi_errors_handler/errors/invalid.rb)
 *   [JsonapiErrorsHandler::Errors::Forbidden](https://github.com/driggl/jsonapi_errors_handler/blob/master/lib/jsonapi_errors_handler/errors/forbidden.rb)
 *   [JsonapiErrorsHandler::Errors::NotFound](https://github.com/driggl/jsonapi_errors_handler/blob/master/lib/jsonapi_errors_handler/errors/not_found.rb)
-*   [JsonapiErrorsHandler::Errors::Unauthorized](https://github.com/driggl/jsonapi_errors_handler/blob/master/lib/jsonapi_errors_handler/errors/not_found.rb)
+*   [JsonapiErrorsHandler::Errors::Unauthorized](https://github.com/driggl/jsonapi_errors_handler/blob/master/lib/jsonapi_errors_handler/errors/unauthorized.rb)
 
 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 +64,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.
@@ -76,7 +108,7 @@ By default, we deliver hardcoded responses. You can check out the defined error
 *   [JsonapiErrorsHandler::Errors::Invalid](https://github.com/driggl/jsonapi_errors_handler/blob/master/lib/jsonapi_errors_handler/errors/invalid.rb)
 *   [JsonapiErrorsHandler::Errors::Forbidden](https://github.com/driggl/jsonapi_errors_handler/blob/master/lib/jsonapi_errors_handler/errors/forbidden.rb)
 *   [JsonapiErrorsHandler::Errors::NotFound](https://github.com/driggl/jsonapi_errors_handler/blob/master/lib/jsonapi_errors_handler/errors/not_found.rb)
-*   [JsonapiErrorsHandler::Errors::Unauthorized](https://github.com/driggl/jsonapi_errors_handler/blob/master/lib/jsonapi_errors_handler/errors/not_found.rb)
+*   [JsonapiErrorsHandler::Errors::Unauthorized](https://github.com/driggl/jsonapi_errors_handler/blob/master/lib/jsonapi_errors_handler/errors/unauthorized.rb)
 
 If you want to have custom error responses being delivered, just create your own `Api::Errors` that inherits from `JsonapiErrorsHandler::StandardError`
 
@@ -112,16 +144,17 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/driggl/jsonapi_errors_handler](https://github.com/driggl/jsonapi_errors_handler).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/driggl/jsonapi_errors_handler>.
 
 **How to contribute:**
 
 1.  Fork repository
 2.  Install [Rubocop](https://github.com/rubocop-hq/rubocop) - make sure you run it before commiting changes
 3.  Commit changes
-  *   Keep commits small and atomic
-  *   Start commit message from keywords (Add/Remove/Change/Refactor/Move/Rename/Upgrade/Downgrade)
-  *   Keep commits imperative style
+    *   Keep commits small and atomic
+    *   Start commit message from keywords (Add/Remove/Change/Refactor/Move/Rename/Upgrade/Downgrade)
+    *   Keep commits imperative style
+
 4.  Create Pull Request
 
 ## License

data/jsonapi_errors_handler.gemspec

@@ -2,6 +2,7 @@
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'jsonapi_errors_handler/version'
 
 Gem::Specification.new do |spec|
@@ -31,6 +32,8 @@ Gem::Specification.new do |spec|
       'public gem pushes.'
   end
 
+  spec.required_ruby_version = '>= 2.4.0'
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
@@ -40,7 +43,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-cobertura'
 end

data/lib/jsonapi_errors_handler.rb

@@ -1,21 +1,28 @@
 # frozen_string_literal: true
 
-require 'irb'
 require 'jsonapi_errors_handler/version'
 require 'jsonapi_errors_handler/configuration'
 require 'jsonapi_errors_handler/errors'
 require 'jsonapi_errors_handler/error_mapper'
 require 'jsonapi_errors_handler/error_serializer'
 
+# Allows to handle ruby errors and return the serialized JSON:API output
+#
 module JsonapiErrorsHandler
+  PREDEFINED_HASH = {
+    'JsonapiErrorsHandler::Errors::Invalid' =>
+      'JsonapiErrorsHandler::Errors::Invalid',
+    'JsonapiErrorsHandler::Errors::Forbidden' =>
+      'JsonapiErrorsHandler::Errors::Forbidden',
+    'JsonapiErrorsHandler::Errors::NotFound' => '
+      JsonapiErrorsHandler::Errors::NotFound',
+    'JsonapiErrorsHandler::Errors::Unauthorized' =>
+      'JsonapiErrorsHandler::Errors::Unauthorized'
+  }.freeze
+
   def self.included(base)
     base.class_eval do
-      ErrorMapper.map_errors!(
-        'JsonapiErrorsHandler::Errors::Invalid' => 'JsonapiErrorsHandler::Errors::Invalid',
-        'JsonapiErrorsHandler::Errors::Forbidden' => 'JsonapiErrorsHandler::Errors::Forbidden',
-        'JsonapiErrorsHandler::Errors::NotFound' => 'JsonapiErrorsHandler::Errors::NotFound',
-        'JsonapiErrorsHandler::Errors::Unauthorized' => 'JsonapiErrorsHandler::Errors::Unauthorized'
-      )
+      ErrorMapper.map_errors!(PREDEFINED_HASH)
     end
   end
 
@@ -25,7 +32,8 @@ module JsonapiErrorsHandler
   end
 
   def handle_unexpected_error(error)
-    return raise error unless config.handle_unexpected?
+    return raise error unless configuration.handle_unexpected?
+
     log_error(error) if respond_to?(:log_error)
     render_error(::JsonapiErrorsHandler::Errors::StandardError.new)
   end
@@ -35,11 +43,10 @@ module JsonapiErrorsHandler
   end
 
   def self.configure(&block)
-    config = Configuration.instance
-    config.configure(&block)
+    Configuration.instance.configure(&block)
   end
 
-  def self.config
+  def configuration
     Configuration.instance
   end
 end

data/lib/jsonapi_errors_handler/configuration.rb

@@ -3,15 +3,23 @@
 require 'singleton'
 
 module JsonapiErrorsHandler
+  # Configuration class allowing to set up the initial behavior for the gem
+  #
   class Configuration
     include Singleton
 
     attr_writer :handle_unexpected
 
+    # Allows to override the configuration options
+    # @param [Block] - list of options to be overwriten
+    #
     def configure
       yield(self) if block_given?
     end
 
+    # Checks if unexpected errors should be handled by the gem
+    # @return [Boolean]
+    #
     def handle_unexpected?
       @handle_unexpected
     end

data/lib/jsonapi_errors_handler/error_mapper.rb

@@ -1,14 +1,18 @@
 # frozen_string_literal: true
 
 module JsonapiErrorsHandler
+  # Maps any of the given error classes into the serializable errors
+  # from the predefined collection
+  #
   class ErrorMapper
-    @@mapped_errors = {}
-    def self.mapped_errors
-      @@mapped_errors
+    @mapped_errors = {}
+
+    class << self
+      attr_reader :mapped_errors
     end
 
     def self.map_errors!(errors_hash = {})
-      @@mapped_errors.merge!(errors_hash)
+      @mapped_errors.merge!(errors_hash)
     end
 
     def self.mapped_error?(error_klass)
@@ -22,11 +26,13 @@ module JsonapiErrorsHandler
       root_class = error_class.split('::').first
       mapped = mapped_errors[error_class] || mapped_errors[root_class]
       return unless mapped
+
       Object.const_get(mapped).new
     end
 
     def self.descendant_of_predefined?(error)
       return false if error.is_a?(Class)
+
       error.class < JsonapiErrorsHandler::Errors::StandardError
     end
   end