error_normalizer 0.2.3 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6a89827f4de579d063163a35e830eed4c4f1cf3d491cb30053b3392b75224cb
-  data.tar.gz: ea6b31b86c5542db161e9297ba1f2ed8d3e4e9732c27bf096603cb9ef7d38d47
+  metadata.gz: cb14b964d184febd948c8965030548fdaf37d7ac39d8fac6e4fabebdf518150b
+  data.tar.gz: 87220e4f46faae5c1f2cf1ed8813978d60720910ccb3662e45698ae826b2b435
 SHA512:
-  metadata.gz: 3b3747acc7be3524f9c76e2699704378572a6300893e58dd72e473f7b0feecc3d4129384059471518e7586967d76877e1dec7d9a6f3e59da3b8315d6236a67eb
-  data.tar.gz: 595c13c118e91f7e5f62e96614b2a11b24a65950f973fd290141680556a68be3b1083abc61c422a5cd6f04af8d503080bcf4539c1adc32d8e934819c495a9728
+  metadata.gz: 2765ca075126a57926c60da14b84add0dd0a6dad55861640f034de164353f38dc1b9c5d4de6588d5ae8ff267f69a0f700354771e4b41b3af8a92d6c50c52b40f
+  data.tar.gz: 4cfa14ae30cdf1ecf5c3963716ba908269865ba8c3c539b23ea70b83b999a1a1b1fcff43c2048396a31b46c0de2a64efdb482e4fa2aab5c0f70bd6b5c5e47e69

data/.gitignore

@@ -1,3 +1,5 @@
+*.gem
+.rspec_status
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -6,6 +8,3 @@
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rubocop.yml

@@ -1,7 +1,6 @@
 # Common configuration.
 AllCops:
-  TargetRubyVersion: 2.5
-  TargetRailsVersion: 5.1
+  TargetRubyVersion: 2.0
 
 #################### Style ###########################
 

data/.ruby-version

@@ -0,0 +1 @@
+2.5.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    error_normalizer (0.2.2)
+    error_normalizer (0.2.4)
       dry-configurable (~> 0.7.0)
 
 GEM

data/README.md

@@ -1,6 +1,8 @@
+[![Build Status](https://jenkins.yalantis.com/buildStatus/icon?job=error_normalizer)](https://jenkins.yalantis.com/job/error_normalizer/)
+
 # Hola :call_me_hand:
 
-This gem was born out of need to have a establish a single universal error format to be consumed by frontend (JS), Android and iOS clients.
+This gem was born out of the need to have an established universal error format to be consumed by frontend (JS), Android and iOS clients.
 
 ## API error format
 
@@ -20,9 +22,10 @@ In our projects we have a convention, that in case of a failed request (422) bac
 Each error object **must have** 4 required fields: `key`, `type`, `message` and `payload`.
 
 - `key` is a concise error code that will be used in a user-friendly translations
-- `type` may be `params`, `custom` or something else
+- `type` may be `params`, `custom`, `rule` or something else
   - `params` means that some parameter that the backend received was wrong
-  - `custom` covers everything else from the business validation composed from several parameters to something really special
+  - `rule` covers cases of the high-level (business) rules which validate against several fields simultaneously
+  - `custom` covers everything else
 - `message` is a "default" or "fallback" error message in plain English that may be used if client does not have translation for the error code
 - `payload` contains other useful data that assists client error handling. For example, in case of `type: "params"` we can provide a _path_ to the invalid paramter.
 
@@ -76,7 +79,7 @@ For more information about supported errors and how they would be parsed please
 
 **TL;DR:** Add `_rule` to the [custom validation block](https://dry-rb.org/gems/dry-validation/custom-validation-blocks/) names (adding this to the [high-level rules](https://dry-rb.org/gems/dry-validation/high-level-rules/) won't harm either, praise the consistency!).
 
-**Long version**: When you're using [custom validation blocks](https://dry-rb.org/gems/dry-validation/custom-validation-blocks/) the error output is slightly diffenet. Instead of attribute name it will have a rule name as a key. For example, GIVEN this schema
+**Long version**: When you're using [custom validation blocks](https://dry-rb.org/gems/dry-validation/custom-validation-blocks/) the error output is slightly diffenet. Instead of the attribute name it will have a rule name as a key. For example, GIVEN this schema
 
     schema = Dry::Validation.Schema do
       configure do
@@ -144,7 +147,7 @@ You can customize rule name match pattern, type name or turn off this feature co
 
 ##### Full message translation
 
-This feature enables to define localization for schema attributes (think of `path` that you get in `payload`), translate it with I18n and concatenate it with the error messages.
+This feature allows to define the localization for schema attributes (think of `path` that you get in `payload`), translate it with I18n and concatenate it with the error messages.
 
     schema = Dry::Validation.Schema do
       required(:user).schema do
@@ -242,12 +245,6 @@ THEN we can normalize object errors to API error format
     #   :type=>"params"
     # }]
 
-## TODO
-
-- configure Gitlab CI
-- parse ActiveModel error mesasges
-- support array of errors as an input
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/error_normalizer.gemspec

@@ -5,11 +5,11 @@ require_relative 'lib/error_normalizer/version'
 Gem::Specification.new do |spec|
   spec.name          = 'error_normalizer'
   spec.version       = ErrorNormalizer::VERSION
-  spec.authors       = ['Denis Kondratenko']
+  spec.authors       = ['Denis Kondratenko', 'Aleksandra Stolyar']
   spec.email         = ['di.kondratenko@gmail.com']
 
   spec.summary       = 'Normalize dry-validation and ActiveModel errors to the universal format'
-  spec.homepage      = 'https://gitlab.yalantis.com/public-repo/error_normalizer/'
+  spec.homepage      = 'https://github.com/Yalantis/error_normalizer'
   spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.0'
 
   spec.add_runtime_dependency 'dry-configurable', '~> 0.7.0'
   spec.add_development_dependency 'i18n', '~> 1'

data/lib/error_normalizer/schema_path_translator.rb

@@ -42,7 +42,7 @@ class ErrorNormalizer
         translated_tokens << translate_token(token, i, tokens)
       end
 
-      translated_tokens.join(' ').capitalize
+      upcase_sentence(translated_tokens.join(' '))
     end
 
     private
@@ -69,5 +69,9 @@ class ErrorNormalizer
         lookup << token
       end
     end
+
+    def upcase_sentence(string)
+      string.length > 0 ? string[0].upcase.concat(string[1..-1]) : ""
+    end
   end
 end

data/lib/error_normalizer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ErrorNormalizer
-  VERSION = '0.2.3'
+  VERSION = '0.2.6'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: error_normalizer
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.6
 platform: ruby
 authors:
 - Denis Kondratenko
+- Aleksandra Stolyar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2019-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -132,6 +133,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -145,7 +147,7 @@ files:
 - lib/error_normalizer/normalizer.rb
 - lib/error_normalizer/schema_path_translator.rb
 - lib/error_normalizer/version.rb
-homepage: https://gitlab.yalantis.com/public-repo/error_normalizer/
+homepage: https://github.com/Yalantis/error_normalizer
 licenses:
 - MIT
 metadata: {}
@@ -155,9 +157,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="