jsonapi_errors_handler 0.1.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df8269ff040273b0368d86c043bf1cd50fb29503be3d4b5207ffba0aa89d27b8
-  data.tar.gz: 7d85f4979969cf3e914145633c11abc0c6d3ff325671bbe788c614ebb5292d59
+  metadata.gz: ae6d9355a82a2ff27bf1681dba4d37579d5018da3fd6f219305b5169b18541d1
+  data.tar.gz: 8e06b88766e7c18ebf9f9a12f145edbee8cf60e357d5c464f7df4dac45f75b3a
 SHA512:
-  metadata.gz: 0d18a2f65e6a93525ec2c45a04714efd01fc8894a87f4d54ffce2652e73c6320ae5ed5447db4499c085a4e335a9162186c1a757d8a6ef6fb8c96bf0c7e6fc625
-  data.tar.gz: 2a3491ecaa2b1c1fcffdbc4d6bcaa430fb80c77c6daa9af55121b4d2ff5532b14781fb07c9a174aeec0e17599700fd50f3629988f99501c1ff0d0f23773186dd
+  metadata.gz: 5f47b8542ca61fd1f331c010f5aa7e9d94e9105d2808a97c5464ae49d3152add962da1126bd1b74cf8d88ecc67747319b458d6fa3f3781128194a788d7ec3b10
+  data.tar.gz: f67a3b5ab34dca5177797ccbf0eeab38319e4cea39e6937eafce62cba21aebe1b4b7aaccf2b0d90c3bd8123bd04512fa7ac538d4a15d2b797079cf62c6bb5014

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.6)
+    jsonapi_errors_handler (0.4.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,7 +41,7 @@ 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
 
@@ -103,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`
 
@@ -139,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,32 +1,50 @@
 # 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
 
   def handle_error(error)
+    log_error(error) if respond_to?(:log_error)
+    # Handle every error which inherits from
+    # JsonapiErrorsHandler::Errors::StandardError
+    #
+    if JsonapiErrorsHandler::ErrorMapper.mapped_error?(error.class.superclass.to_s)
+      return render_error(error)
+    end
+
     mapped = ErrorMapper.mapped_error(error)
     mapped ? render_error(mapped) : handle_unexpected_error(error)
   end
 
   def handle_unexpected_error(error)
-    return raise error unless config.handle_unexpected?
-    log_error(error) if respond_to?(:log_error)
+    config = JsonapiErrorsHandler::Configuration.instance
+    raise error unless config.handle_unexpected?
+
+    notify_handle_unexpected_error(error) if respond_to?(:notify_handle_unexpected_error)
+
     render_error(::JsonapiErrorsHandler::Errors::StandardError.new)
   end
 
@@ -35,11 +53,6 @@ module JsonapiErrorsHandler
   end
 
   def self.configure(&block)
-    config = Configuration.instance
-    config.configure(&block)
-  end
-
-  def config
-    Configuration.instance
+    Configuration.instance.configure(&block)
   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

data/lib/jsonapi_errors_handler/error_serializer.rb

@@ -3,6 +3,8 @@
 require 'json'
 
 module JsonapiErrorsHandler
+  # Serializes the given error to match the JSON:API specification
+  #
   class ErrorSerializer
     def initialize(error)
       @error = error
@@ -20,7 +22,7 @@ module JsonapiErrorsHandler
 
     def serializable_hash
       {
-        errors: [error.serializable_hash]
+        errors: [error.serializable_hash].flatten
       }
     end