json_errors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cdc3177ab2716955fe5b508b537af26376724b40b3a637d6ddf157b826a4526
+  data.tar.gz: 841367d8cab569af54ecea2abbfee47ebdfedd9fad0b4d72398e0eb8e20b5005
+SHA512:
+  metadata.gz: e23778be3a5a40ebdbfe98efa22d1dd9f74c4e732827793d7f8ac8092da676ccedaed49336628bbc2ab3fd4dc1da237fe15f6f25702a53c185cf5d8b464959f1
+  data.tar.gz: 0fac03157c291d08b64d96406382186f637aa90e2c74634d05c7fc0af933be63640ac19fd850d1408f23776fe8746334be76cc26d2faa0babfceb189dfa98999

data/.github/workflows/main.yml

@@ -0,0 +1,19 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake rubocop
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+workspace.code-workspace

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+    - config/**/*

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-07-21
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at l.pajak@nomtek.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json_errors.gemspec
+gemspec
+
+gem 'pry', '~> 0.13.1'
+
+gem 'rails', '~> 6.1.0'
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+gem 'rspec-rails'
+
+gem 'rubocop', '~> 1.7'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'

data/Gemfile.lock

@@ -0,0 +1,201 @@
+PATH
+  remote: .
+  specs:
+    json_errors (0.1.0)
+      activesupport (>= 4.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4)
+      actionpack (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activesupport (= 6.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4)
+      actionview (= 6.1.4)
+      activesupport (= 6.1.4)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4)
+      actionpack (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4)
+      activesupport (= 6.1.4)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activestorage (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activesupport (= 6.1.4)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    loofah (2.10.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mini_mime (1.1.0)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.11.7-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4)
+      actioncable (= 6.1.4)
+      actionmailbox (= 6.1.4)
+      actionmailer (= 6.1.4)
+      actionpack (= 6.1.4)
+      actiontext (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activemodel (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (4.0.2)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    rubocop (1.18.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  json_errors!
+  pry (~> 0.13.1)
+  rails (~> 6.1.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-rails
+  rubocop (~> 1.7)
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Łukasz Pająk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,151 @@
+# JsonErrors
+
+Welcome to Ruby on Rails gem for handling the JSON API errors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_errors'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install json_errors
+
+___
+## Usage
+### Basic usage
+
+First, run the `json_errors:install` generator:
+```
+> rails g json_errors:install
+      create  config/initializers/json_errors.rb
+```
+
+It creates the initializer file with config. Check out the file and uncomment what you need.
+
+Then include `JsonErrors::Rescuer` to your JSON API controller and start raising errors. 
+```ruby
+class UsersController < ApplicationController
+  include JsonErrors::Rescuer
+
+  def create
+    user = User.create!(params.require(:name))
+
+    head :created
+  end
+end
+```
+Be sure to use error throwing methods everywhere, like `create!`, `save!`, `find_by!`, etc. The gem will rescue from any exception and respond with a properly formatted JSON body with a custom error code.
+
+No need for `rescue_from` or rendering the JSON error body. Every error is rescued, logged, formatted and rendered. The client application will receive a JSON body like this:
+
+```json
+{
+  "code":1010,
+  "message":"The parameter 'name' is missing or value is empty",
+  "payload":[]
+}
+```
+
+### Custom codes
+
+The initializer file defines custom error codes and error dictionary:
+```ruby
+JsonErrors.configure do |config|
+  config.custom_codes = {
+    general_error: { code: 1001, http_status: 500 },
+    not_found: { code: 1002, http_status: 404 },
+    database_error: { code: 1003, http_status: 500 },
+    parameter_missing: { code: 1010, http_status: 400 },
+    validation_failed: { code: 1020, http_status: 422 },
+    internal_server_error: { code: 1000, http_status: 500 }
+  }
+
+  config.error_dictionary = {
+    ActiveRecord::RecordInvalid => :validation_failed,
+    ActionController::ParameterMissing => :parameter_missing,
+    ActiveRecord::RecordNotFound => :not_found,
+    ActiveRecord::ActiveRecordError => :database_error,
+    StandardError => :internal_server_error
+  }
+end
+```
+
+The `custom_codes` hash assigns the error label to the error code and HTTP status code of the response.
+So, the error labelled with `:general_error` will be considered as `1001` code under the HTTP `500 Internal Server Error` response.
+Codes are customizable. They can be either numeric or string. 
+
+The `error_dictionary` hash defines what error classes are connected to which error codes.
+
+You can create different custom codes and connect them to your error classes. 
+Lets say you have authentication and you want to respond with HTTP `403 Forbidden` whenever someone is unauthenticated. You can do it 2 ways:
+
+### **1. By handling custom error class**
+
+Add new label to the `custom_codes`
+```ruby
+  unauthenticated: { code: 2001, http_status: 403 }
+```
+and your error class to the `error_dictionary`:
+```ruby
+Unauthenticated => :unauthenticated
+```
+
+Then just raise the error while checking the authentication.
+
+```ruby
+Unauthenticated = Class.new(StandardError)
+
+raise Unauthenticated, 'Authentication needed'
+```
+
+
+### **2. By raising error by label**
+Add new label to the `custom_codes`
+```ruby
+  unauthenticated: { code: 2001, http_status: 403 }
+```
+Then just raise the error while checking the authentication.
+
+```ruby
+raise JsonErrors::ApplicationError.unauthenticated('Authentication needed') 
+```
+
+Both cases you will get the HTTP `403 Forbidden` response with JSON formatted body:
+
+```json
+{
+  "code":2001,
+  "message":"Authentication needed",
+  "payload":[]
+}
+```
+___
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+___
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nomtek/json_errors. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nomtek/json_errors/blob/main/CODE_OF_CONDUCT.md).
+
+___
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+___
+## Code of Conduct
+
+Everyone interacting in the JsonErrors project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nomtek/json_errors/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'json_errors'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_errors.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/json_errors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'json_errors'
+  spec.version       = JsonErrors::VERSION
+  spec.authors       = ['Łukasz Pająk', 'Nomtek']
+  spec.email         = ['l.pajak@nomtek.com']
+
+  spec.summary       = 'RoR JSON API errors handling gem'
+  spec.description   = 'Ruby on Rails gem for handling errors in the JSON API'
+  spec.homepage      = 'https://github.com/nomtek/JsonErrors'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/nomtek/JsonErrors'
+  spec.metadata['changelog_uri'] = 'https://github.com/nomtek/JsonErrors/CHANGELOG.md'
+
+  # 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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 4.2.0'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/generators/json_errors/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    It creates initializer file with basic config.
+
+Example:
+    rails generate json_errors:install
+
+    This will create:
+        config/initializers/json_errors.rb

data/lib/generators/json_errors/install/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module JsonErrors
+  module Generators
+    # Main generator class
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def create_initializer_file
+        copy_file 'json_errors.rb', 'config/initializers/json_errors.rb'
+      end
+    end
+  end
+end

data/lib/generators/json_errors/install/templates/json_errors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+JsonErrors.configure do |config|
+  config.custom_codes = {
+    # general_error: { code: 1001, http_status: 500 },
+    # not_found: { code: 1002, http_status: 404 },
+    # database_error: { code: 1003, http_status: 500 },
+    # parameter_missing: { code: 1010, http_status: 400 },
+    # validation_failed: { code: 1020, http_status: 422 },
+    internal_server_error: { code: 1000, http_status: 500 }
+  }
+
+  config.error_dictionary = {
+    # Uncomment the following lines according to needs.
+    # They are caught and rescued in a cascade manned top to bottom.
+
+    # ActiveRecord::RecordInvalid => :validation_failed,
+    # ActionController::ParameterMissing => :parameter_missing,
+    # ActiveRecord::RecordNotFound => :not_found,
+    # ActiveRecord::ActiveRecordError => :database_error,
+    StandardError => :internal_server_error
+  }
+end

data/lib/json_errors.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'json_errors/version'
+require_relative 'json_errors/config'
+require_relative 'json_errors/application_error'
+require_relative 'json_errors/rescuer'
+
+# Main module
+module JsonErrors
+  def self.configure
+    yield(config)
+  end
+
+  def self.config
+    Config.instance
+  end
+end

data/lib/json_errors/application_error.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module JsonErrors
+  # Main error class to be rescued from
+  class ApplicationError < StandardError
+    attr_reader :code, :payload
+
+    def initialize(msg, name, payload = [])
+      raise 'Wrong name' unless name.in?(codes.keys)
+
+      @code = codes[name][:code]
+      @name = name
+      @payload = payload
+      super(msg)
+    end
+
+    def self.method_missing(name, *args)
+      error = args.first
+      return super if error.nil?
+      return super unless name.in?(codes.keys)
+      return new(error.to_s, name) unless error.respond_to?(:record)
+
+      validation_payload = []
+      error.record.errors.each do |key, messages|
+        validation_payload << { key => messages }
+      end
+      new(error.to_s, name, validation_payload)
+    end
+
+    def self.respond_to_missing?(name, _respond_to_private = false)
+      name.in?(codes.keys) || super
+    end
+
+    def self.codes
+      JsonErrors.config.custom_codes
+    end
+
+    def to_json(_options = nil)
+      {
+        code: code,
+        message: message,
+        payload: payload
+      }.to_json
+    end
+
+    def http_status
+      codes[name][:http_status]
+    end
+
+    private
+
+    attr_reader :name
+
+    def codes
+      self.class.codes
+    end
+  end
+end

data/lib/json_errors/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module JsonErrors
+  class Config
+    include Singleton
+
+    attr_accessor :error_dictionary, :custom_codes
+  end
+end

data/lib/json_errors/rescuer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+module JsonErrors
+  # Main concern module to be included to the controller
+  module Rescuer
+    extend ActiveSupport::Concern
+
+    included do
+      error_dictionary = JsonErrors.config.error_dictionary
+      error_dictionary.keys.reverse.each do |error_class|
+        rescue_from error_class do |error|
+          log_error(error)
+          render_error ApplicationError.send(error_dictionary[error_class], error)
+        end
+      end
+
+      rescue_from ApplicationError do |error|
+        log_error(error)
+        render_error(error)
+      end
+    end
+
+    def render_error(error)
+      render json: error, status: error.http_status
+    end
+
+    def log_error(error)
+      Rails.logger.error "#{error.class}: #{error}"
+      Rails.logger.debug error.backtrace.join("\n")
+    end
+  end
+end

data/lib/json_errors/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JsonErrors
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: json_errors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Łukasz Pająk
+- Nomtek
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: Ruby on Rails gem for handling errors in the JSON API
+email:
+- l.pajak@nomtek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_errors.gemspec
+- lib/generators/json_errors/install/USAGE
+- lib/generators/json_errors/install/install_generator.rb
+- lib/generators/json_errors/install/templates/json_errors.rb
+- lib/json_errors.rb
+- lib/json_errors/application_error.rb
+- lib/json_errors/config.rb
+- lib/json_errors/rescuer.rb
+- lib/json_errors/version.rb
+homepage: https://github.com/nomtek/JsonErrors
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nomtek/JsonErrors
+  source_code_uri: https://github.com/nomtek/JsonErrors
+  changelog_uri: https://github.com/nomtek/JsonErrors/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: RoR JSON API errors handling gem
+test_files: []