jsonapi_errors_handler 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b33f21143133b7108854ca72320fa5fec7d98bb3b327d8a20bc18396ac805146
-  data.tar.gz: 951de26ca4908740f885a3b63eebaebd5ee213a44d4063a37387172e2368e4d2
+  metadata.gz: 31413f8cbc86bedcb155eb0574b6675ab75133b9ca4fec4721e7fc6b96bce447
+  data.tar.gz: 4d308a155c082df85e91b35d54f0b0c491e7db6905ef756f73493259223fc6b7
 SHA512:
-  metadata.gz: aadfe55f49f98e2ce8807ec0df6833d67f645e9de0c9cbe325c85112a68a9f553903cbc7c4210ea425c3c600fc6cc1ad24a350008e5ae40db238ee8ff5f27fe3
-  data.tar.gz: ab8c65e49f8117d14d276fb2d396204c59d4a6d6ff2cb794a2cb3c67a3725a88ecae8f9fbfe85a4e2a4366d062cac7d945dfa07e85c44cf8293f88760ff7604e
+  metadata.gz: 87a8f68e263dbf1c1c7352ae1c5a9ce3294a4bdf4fe00bf1d60356ace9cea210ebf737047b003c183d22408a44f4e7edfa2bb3183f9df5da3c6d90d18a74f385
+  data.tar.gz: 25e5082f2cceb2f40c50c8ee3d572312b3f6803d3deb0eb7eccf06875451f74a8765e419ac72ce3175a7c95007014919ab47dccd7c399c0d7ead268833c4b2a7

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.2
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - 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.2
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - 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.2

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.2.0)
+    jsonapi_errors_handler (0.5.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
 
@@ -52,6 +57,19 @@ JsonapiErrorsHandler.configure do |config|
 end
 ```
 
+
+### Response Content-Type
+
+If you want to change the response content type you can do it through the configuration setting `content_type` by default it is `application/vnd.api+json`
+
+```ruby
+require 'jsonapi_errors_handler'
+
+JsonapiErrorsHandler.configure do |config|
+  config.content_type = 'application/json'
+end
+```
+
 ### Custom errors mapping
 
 If you want your custom errors being handled by default, just add them to the mapper
@@ -139,16 +157,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/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
-
+    attr_accessor :content_type
+    # Allows to override the configuration options
+    # @param [Block] - list of options to be overwritten
+    #
     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
@@ -20,6 +28,7 @@ module JsonapiErrorsHandler
 
     def initialize
       @handle_unexpected = false
+      @content_type = 'application/vnd.api+json'
     end
   end
 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

data/lib/jsonapi_errors_handler/errors/forbidden.rb

@@ -2,6 +2,8 @@
 
 module JsonapiErrorsHandler
   module Errors
+    # Handles serialization of forbidden HTTP error (403 status code)
+    #
     class Forbidden < ::JsonapiErrorsHandler::Errors::StandardError
       def initialize(message: nil)
         super(

data/lib/jsonapi_errors_handler/errors/invalid.rb

@@ -2,6 +2,8 @@
 
 module JsonapiErrorsHandler
   module Errors
+    # Handles serialization of invalid HTTP error (422 status code)
+    #
     class Invalid < ::JsonapiErrorsHandler::Errors::StandardError
       def initialize(errors: {})
         @errors = errors

data/lib/jsonapi_errors_handler/errors/not_found.rb

@@ -2,6 +2,8 @@
 
 module JsonapiErrorsHandler
   module Errors
+    # Handles serialization of NotFound HTTP error (404 status code)
+    #
     class NotFound < ::JsonapiErrorsHandler::Errors::StandardError
       def initialize(message: nil)
         super(

data/lib/jsonapi_errors_handler/errors/standard_error.rb

@@ -4,11 +4,16 @@ require 'jsonapi_errors_handler/keys_stringifier'
 
 module JsonapiErrorsHandler
   module Errors
+    # Handles serialization of Unexpected HTTP error (500 status code)
+    # It's also a fallback for not mapped errors in the application.
+    #
     class StandardError < ::StandardError
-      def initialize(title: nil, detail: nil, status: nil, message: nil, source: {})
+      def initialize(
+        title: nil, status: nil, detail: nil, message: nil, source: {}
+      )
         @title = title || 'Something went wrong'
-        @detail = detail
-        @detail ||= 'We encountered unexpected error, but our developers had been already notified about it'
+        @detail = detail || message
+        @detail ||= "We've encountered unexpected error, but our developers had been already notified about it" # rubocop:disable Metrics/LineLength
         @status = status || 500
         @source = KeysStringifier.call(source)
       end

data/lib/jsonapi_errors_handler/errors/unauthorized.rb

@@ -2,6 +2,8 @@
 
 module JsonapiErrorsHandler
   module Errors
+    # Handles serialization of Unauthorized HTTP error (401 status code)
+    #
     class Unauthorized < ::JsonapiErrorsHandler::Errors::StandardError
       def initialize(message: nil)
         super(

data/lib/jsonapi_errors_handler/errors.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module JsonapiErrorsHandler
+  # A set of predefined, serializable HTTP error objects
+  #
   module Errors
   end
 end

data/lib/jsonapi_errors_handler/keys_stringifier.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module JsonapiErrorsHandler
+  # Allows to stringify keys on the given hash
+  #
   class KeysStringifier
     def self.call(hash)
       hash.reduce({}) do |h, (k, v)|

data/lib/jsonapi_errors_handler/version.rb

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

data/lib/jsonapi_errors_handler.rb

@@ -1,44 +1,62 @@
 # 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 configuration.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
 
   def render_error(error)
-    render json: ::JsonapiErrorsHandler::ErrorSerializer.new(error), status: error.status
+    render(
+      json: ::JsonapiErrorsHandler::ErrorSerializer.new(error),
+      status: error.status,
+      content_type: Configuration.instance.content_type
+    )
   end
 
   def self.configure(&block)
     Configuration.instance.configure(&block)
   end
-
-  def configuration
-    Configuration.instance
-  end
 end