lhs 13.0.1 → 13.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 163b82a58eaed908884ea40ab28605f01323a4bd
-  data.tar.gz: 66320f0e30fcecc454702e089a4a3f2630cd6dce
+  metadata.gz: 619fa442b169b251cb6501e59940d0c587010de6
+  data.tar.gz: e0fdac02b30115bab5c2e98eb8e1f0847d042921
 SHA512:
-  metadata.gz: 3bb2c9f3b2725aaa43724025054e2ed1a53e21c62c8c2fb5ed26bbd2e9fedf399a20c1d5d3d422fa6ea35602fddb1a19e39fc3336d18388f9a755a5fa1bd9cb5
-  data.tar.gz: 4a90025e71d0ee499cde8ee06faf08363ad15aea0c2eea44e1d7de7c1b72331f00bc34a5184ab1eb0c5e378c9460d24c9af2bf9c4c9707d58fdbb269497601bf
+  metadata.gz: ab7fcafa5689e4796f82a7c2da65600c60068dbb2325763775f8d5db833d1814730d91b1819e97f7e29aa51001cc5225e983b2fb58a52ae106fcc269a3f27dd7
+  data.tar.gz: 6f73e3433aa5e955c336da8b2dddc8aebd9b557b8256efd2bf4adc6503376fb75951055d0cddc759f8b3f6efa4509a64c280bf052be8791d0cad00edb4b3bda6

data/README.md

@@ -181,6 +181,16 @@ record = Record.where(color: 'blue')
 
 [List of possible error classes](https://github.com/local-ch/lhc/tree/master/lib/lhc/errors)
 
+If an error handler returns `nil` an empty LHS::Record is returned, not `nil`!
+
+In case you want to ignore errores and continue working with `nil` in those cases,
+please use `ignore`:
+
+```ruby
+record = Record.ignore(LHC::NotFound).find_by(color: 'blue')
+record # nil
+```
+
 ## Resolve chains
 
 LHS Chains can be resolved with `fetch`, similiar to ActiveRecord:

data/lhs.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.requirements << 'Ruby >= 2.3.0'
   s.required_ruby_version = '>= 2.3.0'
 
-  s.add_dependency 'lhc', '>= 6.3.0'
+  s.add_dependency 'lhc', '>= 6.3.1'
   s.add_dependency 'activesupport', '> 4.2'
   s.add_dependency 'activemodel'
 

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

@@ -45,6 +45,10 @@ class LHS::Record
         Chain.new(self, ErrorHandling.new(error_class => handler))
       end
 
+      def ignore(error_class)
+        Chain.new(self, IgnoredError.new(error_class))
+      end
+
       def includes(*args)
         Chain.new(self, Include.new(Chain.unfold(args)))
       end
@@ -108,6 +112,10 @@ class LHS::Record
       end
     end
 
+    # IgnoredError: Ignore certain LHC errors when resolving the chain
+    class IgnoredError < Link
+    end
+
     # A sequence of links
     class Chain
 
@@ -193,6 +201,10 @@ class LHS::Record
         push(Option.new(hash))
       end
 
+      def ignore(error_class)
+        push(IgnoredError.new(error_class))
+      end
+
       def page(page)
         push(Pagination.new(page: page))
       end
@@ -300,6 +312,7 @@ class LHS::Record
         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(including: chain_includes) if chain_includes.present?
         options = options.merge(referencing: chain_references) if chain_references.present?
         options
@@ -350,23 +363,29 @@ class LHS::Record
       end
 
       def chain_parameters
-        merge_links(_links.select { |link| link.is_a? Parameter })
+        @chain_parameters ||= merge_links(_links.select { |link| link.is_a? Parameter })
       end
 
       def chain_options
-        merge_links(_links.select { |link| link.is_a? Option })
+        @chain_options ||= merge_links(_links.select { |link| link.is_a? Option })
       end
 
       def chain_error_handler
-        _links.select { |link| link.is_a? ErrorHandling }
+        @chain_error_handler ||= _links.select { |link| link.is_a? ErrorHandling }
+      end
+
+      def chain_ignored_errors
+        @chain_ignored_errors ||= _links
+          .select { |link| link.is_a? IgnoredError }
+          .map { |link| link.data }
       end
 
       def chain_pagination
-        resolve_pagination _links.select { |link| link.is_a? Pagination }
+        @chain_pagination ||= resolve_pagination _links.select { |link| link.is_a? Pagination }
       end
 
       def chain_includes
-        LHS::Complex.reduce(
+        @chain_includes ||= LHS::Complex.reduce(
           _links
             .select { |link| link.is_a?(Include) && link.data.present? }
             .map { |link| link.data }
@@ -374,7 +393,7 @@ class LHS::Record
       end
 
       def chain_references
-        LHS::Complex.reduce(
+        @chain_references ||= LHS::Complex.reduce(
           _links
             .select { |link| link.is_a?(Reference) && link.data.present? }
             .map { |link| link.data }

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

@@ -9,10 +9,11 @@ class LHS::Record
     module ClassMethods
       def request(options)
         options ||= {}
-        options = options.deep_dup
+        options = options.freeze
         if options.is_a?(Array)
-          filter_request_options!(options)
-          multiple_requests(options)
+          multiple_requests(
+            filter_empty_request_options(options)
+          )
         else
           single_request(options)
         end
@@ -20,10 +21,9 @@ class LHS::Record
 
       private
 
-      def filter_request_options!(options)
-        options.each_with_index do |option, index|
-          next if !option || !option.key?(:url) || !option[:url].nil?
-          options[index] = nil
+      def filter_empty_request_options(options)
+        options.each_with_index.map do |option|
+          option if !option || !option.key?(:url) || !option[:url].nil?
         end
       end
 
@@ -399,7 +399,9 @@ class LHS::Record
 
       # Merge explicit params and take configured endpoints options as base
       def process_options(options, endpoint)
+        ignored_errors = options[:ignored_errors]
         options = options.deep_dup
+        options[:ignored_errors] = ignored_errors if ignored_errors.present?
         options[:params].deep_symbolize_keys! if options[:params]
         options[:error_handler] = merge_error_handlers(options[:error_handler]) if options[:error_handler]
         options = (endpoint.options || {}).merge(options)

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "13.0.1"
+  VERSION = "13.1.0"
 end

data/spec/record/ignore_errors_spec.rb

@@ -0,0 +1,57 @@
+require 'rails_helper'
+
+describe LHS::Record do
+  let(:handler) { spy('handler') }
+
+  before(:each) do
+    class Record < LHS::Record
+      endpoint 'http://local.ch/v2/records'
+      endpoint 'http://local.ch/v2/records/:id'
+    end
+  end
+
+  context 'ignore errors' do
+    before(:each) do
+      stub_request(:get, "http://local.ch/v2/records?color=blue").to_return(status: 404)
+    end
+
+    it 'allows to ignore errors' do
+      record = Record
+        .where(color: 'blue')
+        .ignore(LHC::NotFound)
+        .fetch
+      expect(record).to eq nil
+    end
+  end
+
+  context 'multiple ignored errors' do
+    it 'ignores error if one of them is specified' do
+      stub_request(:get, "http://local.ch/v2/records?color=blue").to_return(status: 401)
+      record = Record
+        .ignore(LHC::Unauthorized)
+        .where(color: 'blue')
+        .ignore(LHC::NotFound)
+        .fetch
+      expect(record).to eq nil
+    end
+
+    it 'ignores error if one of them is specified' do
+      stub_request(:get, "http://local.ch/v2/records?color=blue").to_return(status: 404)
+      record = Record
+        .ignore(LHC::Unauthorized)
+        .where(color: 'blue')
+        .ignore(LHC::NotFound)
+        .fetch
+      expect(record).to eq nil
+    end
+  end
+
+  it 'also can ignore all LHC errors' do
+    stub_request(:get, "http://local.ch/v2/records?color=blue").to_return(status: 401)
+    record = Record
+      .ignore(LHC::Error)
+      .where(color: 'blue')
+      .fetch
+    expect(record).to eq nil
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 13.0.1
+  version: 13.1.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.3.0
+        version: 6.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.3.0
+        version: 6.3.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -358,6 +358,7 @@ files:
 - spec/record/find_in_parallel_spec.rb
 - spec/record/find_spec.rb
 - spec/record/first_spec.rb
+- spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb
 - spec/record/includes_all_spec.rb
 - spec/record/includes_spec.rb
@@ -414,7 +415,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.3.0
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Rails gem providing an easy, active-record-like interface for http json services
@@ -530,6 +531,7 @@ test_files:
 - spec/record/find_in_parallel_spec.rb
 - spec/record/find_spec.rb
 - spec/record/first_spec.rb
+- spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb
 - spec/record/includes_all_spec.rb
 - spec/record/includes_spec.rb