json_errors 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26354ae40f5933c7f0c361ff1ec64f238a6d27571315192ba030dc534c22066f
-  data.tar.gz: 206463accc495b565c19e66b1a8b1d9e0dc1df4fd21b22f50b6e5d6a36954c1e
+  metadata.gz: '09b6a5462beee5879c2112dcf5058e6a7a2641eb4268fc11f222fe854fe921e4'
+  data.tar.gz: 0c8542bd919023acadb2ec9ed83bd6204c9546e64785b7f62180ce067270837d
 SHA512:
-  metadata.gz: 1426aa90ee3cb74f7dd1c3264d60cc5c5747bd170314ba6f19a4ac45d4200c44115e590648b8d298fa58253edf104c4a39aa97d40e893aeec70ec94451e3226f
-  data.tar.gz: c7662a61fcdb269b637914ed33712f4b54271304a7c85bb11e6aecb90322494d03c04cf861c9b64f9513ebadcdf369483bd7c066560e25b2324ebbb1a16a0e3c
+  metadata.gz: 687d743cb610a6b2276781b9d57285035cf75095330ae7828161d4941b0146fdb8198f1b76a4b6cfab1e8cc827ff411539a3d1fce599112382c23511fd84f4d8
+  data.tar.gz: c12c26908c735334d3d8589449c6af052ecf1766028e0a6e79d57d1169c4626889a507d88da1f2b265facd4243f1b71502c0b53c71bc98d809603f1e78a87bac

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2021-08-03
+
+- ActiveRecord validation errors handling added
+- Custom payload added
+
 ## [0.1.1] - 2021-07-27
 
 - Missing configuration error added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_errors (0.1.1)
+    json_errors (0.2.0)
       activesupport (>= 4.2.0)
 
 GEM
@@ -73,11 +73,11 @@ GEM
     crass (1.0.6)
     diff-lcs (1.4.4)
     erubi (1.10.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.10.0)
+    loofah (2.11.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -87,7 +87,7 @@ GEM
     mini_mime (1.1.0)
     minitest (5.14.4)
     nio4r (2.5.7)
-    nokogiri (1.11.7-x86_64-darwin)
+    nokogiri (1.12.0-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.2.0)

data/README.md

@@ -21,113 +21,9 @@ Or install it yourself as:
 
 ___
 ## 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**
+Check out the [manual](https://github.com/nomtek/JsonErrors/wiki)
 
-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

data/config/initializers/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/json_errors.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   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'
+  spec.metadata['changelog_uri'] = 'https://github.com/nomtek/JsonErrors/blob/main/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.

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

@@ -3,21 +3,21 @@
 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 },
+    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, validation_errors: :active_record },
     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.
+    # Uncomment or comment the following lines according to needs.
+    # They are caught and rescued in a cascade manner top to bottom.
 
-    # ActiveRecord::RecordInvalid => :validation_failed,
-    # ActionController::ParameterMissing => :parameter_missing,
-    # ActiveRecord::RecordNotFound => :not_found,
-    # ActiveRecord::ActiveRecordError => :database_error,
+    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

@@ -2,7 +2,10 @@
 
 require_relative 'json_errors/version'
 require_relative 'json_errors/config'
-require_relative 'json_errors/application_error'
+require_relative 'json_errors/error'
+require_relative 'json_errors/error/basic_error'
+require_relative 'json_errors/error/custom_payload_error'
+require_relative 'json_errors/error/validation_error'
 require_relative 'json_errors/rescuer'
 
 # Main module

data/lib/json_errors/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module JsonErrors
+  # Error facade
+  class Error
+    def self.method_missing(name, *args)
+      message, payload = args
+      return super unless name.in?(codes.keys)
+
+      return BasicError.new(message, name) if payload.nil?
+      return ValidationError.new(message, name, payload&.record) if codes[name][:validation_errors] == :active_record
+
+      CustomPayloadError.new(message, name, 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
+  end
+end

data/lib/json_errors/error/basic_error.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module JsonErrors
+  # Main error class to be rescued from
+  class BasicError < StandardError
+    attr_reader :code
+
+    def initialize(msg, name)
+      raise 'Wrong name' unless name.in?(codes.keys)
+
+      @code = codes[name][:code]
+      @name = name
+      super(msg)
+    end
+
+    def self.codes
+      JsonErrors.config.custom_codes
+    end
+
+    def to_json(_options = nil)
+      {
+        code: code,
+        message: message
+      }.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/error/custom_payload_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module JsonErrors
+  # Error class for custom payload errors
+  class CustomPayloadError < BasicError
+    attr_accessor :payload
+
+    def initialize(msg, name, payload)
+      super(msg, name)
+      @payload = payload
+    end
+
+    def to_json(_options = nil)
+      {
+        code: code,
+        message: message,
+        payload: payload
+      }.to_json
+    end
+  end
+end

data/lib/json_errors/error/validation_error.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module JsonErrors
+  # Error class for custom payload errors
+  class ValidationError < BasicError
+    def initialize(msg, name, record)
+      super(msg, name)
+      raise 'Wrong record' unless record.respond_to?(:errors)
+
+      @record = record
+    end
+
+    def to_json(_options = nil)
+      {
+        code: code,
+        message: message,
+        payload: payload
+      }.to_json
+    end
+
+    private
+
+    attr_reader :record
+
+    def payload
+      validation_payload = []
+      record.errors.each do |key, messages|
+        validation_payload << { key => messages }
+      end
+
+      { record.class.to_s => validation_payload }
+    end
+  end
+end

data/lib/json_errors/rescuer.rb

@@ -15,11 +15,11 @@ module JsonErrors
       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)
+          render_error JsonErrors::Error.send(error_dictionary[error_class], error)
         end
       end
 
-      rescue_from ApplicationError do |error|
+      rescue_from JsonErrors::BasicError do |error|
         log_error(error)
         render_error(error)
       end

data/lib/json_errors/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_errors
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Łukasz Pająk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,13 +45,17 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config/initializers/json_errors.rb
 - 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/error.rb
+- lib/json_errors/error/basic_error.rb
+- lib/json_errors/error/custom_payload_error.rb
+- lib/json_errors/error/validation_error.rb
 - lib/json_errors/rescuer.rb
 - lib/json_errors/version.rb
 homepage: https://github.com/nomtek/JsonErrors
@@ -60,7 +64,7 @@ licenses:
 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
+  changelog_uri: https://github.com/nomtek/JsonErrors/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/json_errors/application_error.rb

@@ -1,58 +0,0 @@
-# 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