lhs 22.1.0 → 24.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b42b1f0f10d4d0dcf31de3e65ed4ca0c3f7bcfded40e9897231b5ff09a9c472
-  data.tar.gz: 1c041ff80320d79d73ef02e9af30278d58e779c239044c3485eac9b5e047f8ee
+  metadata.gz: e31a9b37f1bc0f12b3a6c87933b145781ed3054e08ea4ea347d5b27d00a069ea
+  data.tar.gz: d67f414e70fdcae5567dcf5c81c2e2dec93237026e829c9dc9522df5eb778480
 SHA512:
-  metadata.gz: 1a33c68f7d0c82a6c54482fa3ba3986bac1dccc83d9284951fa0f95bf92c0cd17fe3283c62c1c9dee067769d0fe81daf5ca3c86b8c6f84c07ccc0c3977b108cc
-  data.tar.gz: fe26fa077139d670284ef136e6f702549bd1fd8e8d2c3bfd5f5d43dcd1dba3bf3ac72f7dca8ae70628184c85ff83908558353e0d835fa00052d21ab0539b88d8
+  metadata.gz: f39832a96aa989660bfbaf051c53bd53c647d4e75f7b9fa3ca81ab1243ec94bd17828da931207f80fd57a9f98f38188cca659143912a01a4ffc5e197090f6b3a
+  data.tar.gz: 19ea228303da96f4f4e831825c19c98ea9a81c15b76ad645b3ecbe23532f0a7336eb87d815f432f2d25ee5d6f0c07d98963ed0ba5388022cd79521cd0ae04424

data/README.md

@@ -99,6 +99,8 @@ record.review # "Lunch was great
         * [Change/Update existing records](#changeupdate-existing-records)
            * [save](#save)
            * [update](#update)
+              * [Directly via Record](#directly-via-record)
+              * [per Instance](#per-instance)
            * [partial_update](#partial_update)
         * [Endpoint url parameter injection during record creation/change](#endpoint-url-parameter-injection-during-record-creationchange)
         * [Record validation](#record-validation)
@@ -119,8 +121,8 @@ record.review # "Lunch was great
         * [Record getters](#record-getters)
      * [Include linked resources (hyperlinks and hypermedia)](#include-linked-resources-hyperlinks-and-hypermedia)
         * [Generate links from parameters](#generate-links-from-parameters)
-        * [Ensure the whole linked collection is included: includes_all](#ensure-the-whole-linked-collection-is-included-includes_all)
-        * [Include the first linked page or single item is included: include](#include-the-first-linked-page-or-single-item-is-included-include)
+        * [Ensure the whole linked collection is included with includes](#ensure-the-whole-linked-collection-is-included-with-includes)
+        * [Include only the first linked page of a linked collection: includes_first_page](#include-only-the-first-linked-page-of-a-linked-collection-includes_first_page)
         * [Include various levels of linked data](#include-various-levels-of-linked-data)
         * [Identify and cast known records when including records](#identify-and-cast-known-records-when-including-records)
         * [Apply options for requests performed to fetch included records](#apply-options-for-requests-performed-to-fetch-included-records)
@@ -152,6 +154,7 @@ record.review # "Lunch was great
 
 
 
+
 ## Installation/Startup checklist
 
 - [ ] Install LHS gem, preferably via `Gemfile`
@@ -976,7 +979,7 @@ If you need to render some different view in Rails based on an LHS error raised
 
 def show
   @records = Record
-    .handle(LHC::Error, ->(error){ handle_error(error) })
+    .rescue(LHC::Error, ->(error){ rescue_from(error) })
     .where(color: 'blue')
   render 'show'
   render_error if @error
@@ -984,7 +987,7 @@ end
 
 private
 
-def handle_error(error)
+def rescue_from(error)
   @error = error
   nil
 end
@@ -1009,7 +1012,7 @@ If you want to inject values for the failing records, that might not have been f
 # app/controllers/some_controller.rb
 
 data = Record
-  .handle(LHC::Unauthorized, ->(response) { Record.new(name: 'unknown') })
+  .rescue(LHC::Unauthorized, ->(response) { Record.new(name: 'unknown') })
   .find(1, 2, 3)
 
 data[1].name # 'unknown'
@@ -2276,6 +2279,17 @@ In parallel:
   GET https://service.example.com/places/4 { headers: { 'Authentication': 'Bearer 123' } }
 ```
 
+Here is another example, if you want to ignore errors, that occure while you fetch included resources:
+
+```ruby
+# app/controllers/some_controller.rb
+
+feedback = Feedback
+  .includes(campaign: :entry)
+  .references(campaign: { ignore: LHC::NotFound })
+  .find(12345)
+```
+
 ### Record batch processing
 
 **Be careful using methods for batch processing. They could result in a lot of HTTP requests!**

data/lhs.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activemodel'
   s.add_dependency 'activesupport', '>= 4.2.11'
-  s.add_dependency 'lhc', '>= 10', '< 12'
+  s.add_dependency 'lhc', '>= 12.1.1', '< 13'
   s.add_dependency 'local_uri'
 
   s.add_development_dependency 'capybara'
@@ -39,5 +39,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'sprockets', '< 4'
   s.add_development_dependency 'webmock'
 
-  s.license = 'GPL-3'
+  s.license = 'GPL-3.0'
 end

data/lib/lhs/concerns/record/chainable.rb

@@ -52,7 +52,7 @@ class LHS::Record
         Chain.new(self, Pagination.new(per: argument))
       end
 
-      def handle(error_class, handler)
+      def rescue(error_class, handler)
         Chain.new(self, ErrorHandling.new(error_class => handler))
       end
 
@@ -255,7 +255,7 @@ class LHS::Record
         push(Pagination.new(per: argument))
       end
 
-      def handle(error_class, handler)
+      def rescue(error_class, handler)
         push(ErrorHandling.new(error_class => handler))
       end
 
@@ -348,8 +348,8 @@ class LHS::Record
       def resolved_options
         options = chain_options
         options = options.deep_merge(params: chain_parameters.merge(chain_pagination))
-        options = options.merge(error_handler: chain_error_handler) if chain_error_handler.present?
-        options = options.merge(ignored_errors: chain_ignored_errors) if chain_ignored_errors.present?
+        options = options.merge(rescue: chain_error_handler) if chain_error_handler.present?
+        options = options.merge(ignore: chain_ignored_errors) if chain_ignored_errors.present?
         options = options.merge(including: chain_includes) if chain_includes.present?
         options = options.merge(referencing: chain_references) if chain_references.present?
         options

data/lib/lhs/concerns/record/request.rb

@@ -138,6 +138,7 @@ class LHS::Record
       end
 
       def extend_base_item!(data, addition, key)
+        return if addition.nil?
         if addition.collection?
           extend_base_item_with_collection!(data, addition, key)
         else # simple case merges hash into hash
@@ -187,7 +188,7 @@ class LHS::Record
           options = extend_with_reference(options, reference)
           addition = load_include(options, data, sub_includes, reference)
           extend_raw_data!(data, addition, included)
-          expand_addition!(data, included, options) if no_expanded_data?(addition)
+          expand_addition!(data, included, options) unless expanded_data?(addition)
         end
       end
 
@@ -205,28 +206,24 @@ class LHS::Record
       def expand_addition!(data, included, reference)
         addition = data[included]
         options = options_for_data(addition)
-        options = extend_with_reference(options, reference.except(:url))
+        options = extend_with_reference(options, reference)
         record = record_for_options(options) || self
         options = convert_options_to_endpoints(options) if record_for_options(options)
-        expanded_data = begin
-          record.request(options)
-        rescue LHC::NotFound
-          LHS::Data.new({}, data, record)
-        end
+        expanded_data = record.request(options)
         extend_raw_data!(data, expanded_data, included)
       end
 
-      def no_expanded_data?(addition)
+      def expanded_data?(addition)
         return false if addition.blank?
         if addition.item?
-          (addition._raw.keys - [:href]).empty?
+          (addition._raw.keys - [:href]).any?
         elsif addition.collection?
-          addition.all? do |item|
+          addition.any? do |item|
             next if item.blank?
             if item._raw.is_a?(Hash)
-              (item._raw.keys - [:href]).empty?
+              (item._raw.keys - [:href]).any?
             elsif item._raw.is_a?(Array)
-              item.any? { |item| (item._raw.keys - [:href]).empty? }
+              item.any? { |item| (item._raw.keys - [:href]).any? }
             end
           end
         end
@@ -234,7 +231,8 @@ class LHS::Record
 
       # Extends request options with options provided for this reference
       def extend_with_reference(options, reference)
-        return options unless reference
+        return options if reference.blank?
+        reference = reference.except(:url)
         options ||= {}
         if options.is_a?(Array)
           options.map { |request_options| request_options.merge(reference) if request_options.present? }
@@ -348,18 +346,14 @@ class LHS::Record
       end
 
       # Load additional resources that are requested with include
-      def load_include(options, data, sub_includes, references)
+      def load_include(options, _data, sub_includes, references)
         record = record_for_options(options) || self
         options = convert_options_to_endpoints(options) if record_for_options(options)
-        begin
-          prepare_options_for_include_request!(options, sub_includes, references)
-          if references && references[:all] # include all linked resources
-            load_include_all!(options, record, sub_includes, references)
-          else # simply request first page/batch
-            load_include_simple!(options, record)
-          end
-        rescue LHC::NotFound
-          LHS::Data.new({}, data, record)
+        prepare_options_for_include_request!(options, sub_includes, references)
+        if references && references[:all] # include all linked resources
+          load_include_all!(options, record, sub_includes, references)
+        else # simply request first page/batch
+          load_include_simple!(options, record)
         end
       end
 
@@ -372,7 +366,7 @@ class LHS::Record
 
       def load_include_simple!(options, record)
         data = record.request(options)
-        warn "[WARNING] You included `#{options[:url]}`, but this endpoint is paginated. You might want to use `includes_all` instead of `includes` (https://github.com/local-ch/lhs#includes_all-for-paginated-endpoints)." if paginated?(data._raw)
+        warn "[WARNING] You included `#{options[:url]}`, but this endpoint is paginated. You might want to use `includes_all` instead of `includes` (https://github.com/local-ch/lhs#includes_all-for-paginated-endpoints)." if data && paginated?(data._raw)
         data
       end
 
@@ -510,7 +504,7 @@ class LHS::Record
         options = options.deep_dup
         options[:ignored_errors] = ignored_errors if ignored_errors.present?
         options[:params]&.deep_symbolize_keys!
-        options[:error_handler] = merge_error_handlers(options[:error_handler]) if options[:error_handler]
+        options[:rescue] = merge_error_handlers(options[:rescue]) if options[:rescue]
         options = (provider_options || {})
           .deep_merge(endpoint.options || {})
           .deep_merge(options)

data/lib/lhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHS
-  VERSION = '22.1.0'
+  VERSION = '24.0.0'
 end

data/spec/dummy/app/controllers/error_handling_with_chains_controller.rb

@@ -6,7 +6,7 @@ class ErrorHandlingWithChainsController < ApplicationController
   # in the view (during render 'show')
   def fetch_in_view
     @records = DummyRecord
-      .handle(LHC::Error, ->(error) { handle_error(error) })
+      .rescue(LHC::Error, ->(error) { handle_error(error) })
       .where(color: 'blue')
     render 'show'
     render_error if @error
@@ -16,7 +16,7 @@ class ErrorHandlingWithChainsController < ApplicationController
   # before the view is rendered
   def fetch_in_controller
     @records = DummyRecord
-      .handle(LHC::Error, ->(error) { handle_error(error) })
+      .rescue(LHC::Error, ->(error) { handle_error(error) })
       .where(color: 'blue').fetch
     render 'show'
     render_error if @error

data/spec/record/error_handling_spec.rb

@@ -15,14 +15,14 @@ describe LHS::Record do
 
   it 'allows to chain error handling' do
     expect {
-      Record.where(color: 'blue').handle(LHC::Error, ->(_error) { handler.handle }).first
+      Record.where(color: 'blue').rescue(LHC::Error, ->(_error) { handler.handle }).first
     }.not_to raise_error
     expect(handler).to have_received(:handle)
   end
 
   it 'reraises in case chained error is not matched' do
     expect {
-      Record.where(color: 'blue').handle(LHC::Conflict, ->(_error) { handler.handle }).first
+      Record.where(color: 'blue').rescue(LHC::Conflict, ->(_error) { handler.handle }).first
     }.to raise_error(LHC::Error)
     expect(handler).not_to have_received(:handle)
   end
@@ -30,8 +30,8 @@ describe LHS::Record do
   it 'calls all the handlers' do
     expect {
       Record.where(color: 'blue')
-        .handle(LHC::Error, ->(_error) { handler.handle_1 })
-        .handle(LHC::Error, ->(_error) { handler.handle_2 })
+        .rescue(LHC::Error, ->(_error) { handler.handle_1 })
+        .rescue(LHC::Error, ->(_error) { handler.handle_2 })
         .first
     }.not_to raise_error
     expect(handler).to have_received(:handle_1)

data/spec/record/find_in_parallel_spec.rb

@@ -33,7 +33,7 @@ describe LHS::Record do
     it 'applies error handlers from the chain and returns whatever the error handler returns' do
       stub_request(:get, "http://datastore/records/2").to_return(status: 401)
       data = Record
-        .handle(LHC::Unauthorized, ->(_response) { Record.new(name: 'unknown') })
+        .rescue(LHC::Unauthorized, ->(_response) { Record.new(name: 'unknown') })
         .find(1, 2, 3)
       expect(data[1].name).to eq 'unknown'
     end

data/spec/record/handle_includes_errors_spec.rb

@@ -25,7 +25,7 @@ describe LHS::Record do
 
   it 'allows to pass error_handling for includes to LHC' do
     handler = ->(_) { return { deleted: true } }
-    record = Record.includes_first_page(:other).references(other: { error_handler: { LHC::NotFound => handler } }).find(id: 1)
+    record = Record.includes_first_page(:other).references(other: { rescue: { LHC::NotFound => handler } }).find(id: 1)
 
     expect(record.other.deleted).to be(true)
   end

data/spec/record/includes_first_page_spec.rb

@@ -224,7 +224,7 @@ describe LHS::Record do
   end
 
   context 'links pointing to nowhere' do
-    it 'sets nil for links that cannot be included' do
+    before do
       class Feedback < LHS::Record
         endpoint '{+datastore}/feedbacks'
         endpoint '{+datastore}/feedbacks/{id}'
@@ -238,10 +238,20 @@ describe LHS::Record do
 
       stub_request(:get, "#{datastore}/content-ads/51dfc5690cf271c375c5a12d")
         .to_return(status: 404)
+    end
+
+    it 'raises LHC::NotFound for links that cannot be included' do
+      expect(-> {
+        Feedback.includes_first_page(campaign: :entry).find(123)
+      }).to raise_error LHC::NotFound
+    end
 
-      feedback = Feedback.includes_first_page(campaign: :entry).find(123)
-      expect(feedback.campaign._raw.keys.count).to eq 1
-      expect(feedback.campaign.href).to be_present
+    it 'ignores LHC::NotFound for links that cannot be included if configured so with reference options' do
+      feedback = Feedback
+        .includes_first_page(campaign: :entry)
+        .references(campaign: { ignore: [LHC::NotFound] })
+        .find(123)
+      expect(feedback.campaign._raw.keys.length).to eq 1
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 22.1.0
+  version: 24.0.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -44,20 +44,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: 12.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: 12.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: local_uri
   requirement: !ruby/object:Gem::Requirement
@@ -548,7 +548,7 @@ files:
 - spec/views/form_for_spec.rb
 homepage: https://github.com/local-ch/lhs
 licenses:
-- GPL-3
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []