lhs 14.3.4 → 14.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23340184de8a2e5596232bb3aa09208c86a11687
-  data.tar.gz: dbbc8b0fb443b46b077f0743698252c5b9cbcd6f
+  metadata.gz: 915b54df82b092a12fef1395a21e854e4f95738d
+  data.tar.gz: ff5e0fbca423676b763606ebcdf2d2b2a4562084
 SHA512:
-  metadata.gz: dd22d59947be1c7d9187ddca6a0b46f9ca3d7942418b4aadbf3c1d7ec376a1d6fd7d192ba825d48896ed7715b909ff965a7346b0cad4812f015b3ad3d834e44d
-  data.tar.gz: 04113fb6808937fe56f9859291cb3ba0c308542a408090da03035098b09c59d1f6cff5ad9a3ab95401b922c65f6bb41e9b04ad2bbe0ef5e1313b7a9a8a738eec
+  metadata.gz: 5fbbe1749a1266a6b4fc2df4d4aaf9b55b4d24a69d3af3af000c6c9d4b159eea16d7435e93799fcbfc28f0db46f4e86a84283938578edb62b05b4bdf47f1ca2f
+  data.tar.gz: 4f2652ef35ec40aa670901203fcbbf02de58fffe900090f90af7acb9fcdc032b40dbe86a350a2cc8c83efb7e25cb7bbb21aa34e74a7586956c6d313c88e2df80

data/.rubocop.yml

@@ -32,3 +32,6 @@ Metrics/BlockLength:
 
 Style/EmptyLinesAroundBlockBody:
   Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/README.md

@@ -775,7 +775,8 @@ end
 user.errors #<LHS::Problems::Errors>
 user.errors.include?(:email) # true
 user.errors[:email] # ['REQUIRED_PROPERTY_VALUE']
-user.errors.messages # {:email=>["REQUIRED_PROPERTY_VALUE"]}
+user.errors.messages # {:email=>["Translated error message that this value is required"]}
+user.errors.codes # {:email=>["REQUIRED_PROPERTY_VALUE"]}
 user.errors.message # email must be set when user is created."
 ```
 
@@ -885,7 +886,8 @@ LHS makes those errors available when accessing `.errors`:
   )
 
   presence.errors.any? # true
-  presence.place.errors.messages[:opening_hours] # ['REQUIRED_PROPERTY_VALUE']
+  presence.place.errors.messages[:opening_hours] # ['This field needs to be present']
+  presence.place.errors.codes[:opening_hours] # ['REQUIRED_PROPERTY_VALUE']
 ```
 
 ### Non blocking validation errors, so called warnings

data/lib/lhs/problems/base.rb

@@ -6,7 +6,7 @@ module LHS::Problems
   class Base
     include Enumerable
 
-    attr_reader :raw, :messages, :record
+    attr_reader :raw, :messages, :codes, :record
 
     def include?(attribute)
       messages[attribute].present?
@@ -55,6 +55,7 @@ module LHS::Problems
     def clear
       @raw = nil
       @messages.clear
+      @codes.clear
     end
 
     delegate :values, to: :messages
@@ -73,6 +74,8 @@ module LHS::Problems
 
     def add_error(messages, key, value)
       key = key.to_sym
+      codes[key] ||= []
+      codes[key].push(value)
       messages[key] ||= []
       messages[key].push(generate_message(key, value))
     end

data/lib/lhs/problems/errors.rb

@@ -6,11 +6,13 @@ module LHS::Problems
     def initialize(response = nil, record = nil)
       @raw = response.body if response
       @record = record
+      @codes = {}.with_indifferent_access
       @messages = messages_from_response(response).with_indifferent_access
       @message = message_from_response(response)
       @status_code = response.code if response
     rescue JSON::ParserError
       @messages = (messages || {}).with_indifferent_access
+      @codes = (codes || {}).with_indifferent_access
       @message = 'parse error'
       add_error(@messages, 'body', 'parse error')
     end

data/lib/lhs/problems/warnings.rb

@@ -4,6 +4,7 @@ module LHS::Problems
     def initialize(raw, record = nil)
       @raw = raw
       @record = record
+      @codes = {}.with_indifferent_access
       @messages = warnings_from_raw
     end
 

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = '14.3.4'
+  VERSION = '14.4.0'
 end

data/spec/item/error_codes_spec.rb

@@ -0,0 +1,53 @@
+require 'rails_helper'
+
+describe LHS::Item do
+  context 'error codes' do
+    before(:each) do
+      I18n.reload!
+      I18n.backend.store_translations(:en, YAML.safe_load(translation)) if translation.present?
+      class Record < LHS::Record
+        endpoint 'http://datastore/records'
+      end
+    end
+
+    let(:translation) do
+      %q{
+        lhs:
+          errors:
+            fallback_message: 'This value is wrong'
+      }
+    end
+
+    it 'provides error codes along side with translated messages' do
+      stub_request(:post, 'http://datastore/records')
+        .to_return(body: {
+          field_errors: [{
+            code: 'UNSUPPORTED_PROPERTY_VALUE',
+            path: ['gender'],
+            message: 'The property value is unsupported.'
+          }, {
+            code: 'INCOMPLETE_PROPERTY_VALUE',
+            path: ['gender'],
+            message: 'The property value is incomplete. It misses some data'
+          }, {
+            code: 'INCOMPLETE_PROPERTY_VALUE',
+            path: ['contract', 'entry_id'],
+            message: 'The property value is incomplete. It misses some data'
+          }]
+        }.to_json)
+      record = Record.create
+      expect(record.errors.messages['gender']).to eq(
+        ['This value is wrong', 'This value is wrong']
+      )
+      expect(record.errors.codes['gender']).to eq(
+        ['UNSUPPORTED_PROPERTY_VALUE', 'INCOMPLETE_PROPERTY_VALUE']
+      )
+      expect(record.errors.messages['contract.entry_id']).to eq(
+        ['This value is wrong']
+      )
+      expect(record.errors.codes['contract.entry_id']).to eq(
+        ['INCOMPLETE_PROPERTY_VALUE']
+      )
+    end
+  end
+end

data/spec/item/errors_spec.rb

@@ -51,6 +51,8 @@ describe LHS::Item do
   end
 
   before(:each) do
+    I18n.reload!
+    I18n.backend.store_translations(:en, {}) if defined? translations
     LHC.config.placeholder(:datastore, datastore)
     class Record < LHS::Record
       endpoint ':datastore/:campaign_id/feedbacks'

data/spec/item/warning_codes_spec.rb

@@ -0,0 +1,53 @@
+require 'rails_helper'
+
+describe LHS::Item do
+  context 'error codes' do
+    before(:each) do
+      I18n.reload!
+      I18n.backend.store_translations(:en, YAML.safe_load(translation)) if translation.present?
+      class Record < LHS::Record
+        endpoint 'http://datastore/records'
+      end
+    end
+
+    let(:translation) do
+      %q{
+        lhs:
+          warnings:
+            fallback_message: 'This value is problematic'
+      }
+    end
+
+    it 'provides error codes along side with translated messages' do
+      stub_request(:post, 'http://datastore/records')
+        .to_return(body: {
+          field_warnings: [{
+            code: 'UNSUPPORTED_PROPERTY_VALUE',
+            path: ['gender'],
+            message: 'The property value is unsupported.'
+          }, {
+            code: 'INCOMPLETE_PROPERTY_VALUE',
+            path: ['gender'],
+            message: 'The property value is incomplete. It misses some data'
+          }, {
+            code: 'INCOMPLETE_PROPERTY_VALUE',
+            path: ['contract', 'entry_id'],
+            message: 'The property value is incomplete. It misses some data'
+          }]
+        }.to_json)
+      record = Record.create
+      expect(record.warnings.messages['gender']).to eq(
+        ['This value is problematic', 'This value is problematic']
+      )
+      expect(record.warnings.codes['gender']).to eq(
+        ['UNSUPPORTED_PROPERTY_VALUE', 'INCOMPLETE_PROPERTY_VALUE']
+      )
+      expect(record.warnings.messages['contract.entry_id']).to eq(
+        ['This value is problematic']
+      )
+      expect(record.warnings.codes['contract.entry_id']).to eq(
+        ['INCOMPLETE_PROPERTY_VALUE']
+      )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 14.3.4
+  version: 14.4.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-09 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -328,6 +328,7 @@ files:
 - spec/item/delegate_spec.rb
 - spec/item/destroy_spec.rb
 - spec/item/dig_spec.rb
+- spec/item/error_codes_spec.rb
 - spec/item/errors_spec.rb
 - spec/item/getter_spec.rb
 - spec/item/internal_data_structure_spec.rb
@@ -340,6 +341,7 @@ files:
 - spec/item/translate_errors_spec.rb
 - spec/item/update_spec.rb
 - spec/item/validation_spec.rb
+- spec/item/warning_codes_spec.rb
 - spec/item/warnings_spec.rb
 - spec/pagination/pages_left_spec.rb
 - spec/proxy/create_sub_resource_spec.rb
@@ -508,6 +510,7 @@ test_files:
 - spec/item/delegate_spec.rb
 - spec/item/destroy_spec.rb
 - spec/item/dig_spec.rb
+- spec/item/error_codes_spec.rb
 - spec/item/errors_spec.rb
 - spec/item/getter_spec.rb
 - spec/item/internal_data_structure_spec.rb
@@ -520,6 +523,7 @@ test_files:
 - spec/item/translate_errors_spec.rb
 - spec/item/update_spec.rb
 - spec/item/validation_spec.rb
+- spec/item/warning_codes_spec.rb
 - spec/item/warnings_spec.rb
 - spec/pagination/pages_left_spec.rb
 - spec/proxy/create_sub_resource_spec.rb