lhs 22.0.0 → 23.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a749e7862bb20791a4a25fa5fdce92461ebfceaf6e30602c7e600f7342a69806
-  data.tar.gz: eceb2d57d258630583394079f495474320354db45e15c205f66005b570abc448
+  metadata.gz: 4598d2f5041bf799a481dd7fb9ddbe6767acfdc799de851a7592228023d70f96
+  data.tar.gz: 3688dabba7d80461e187b93107ba785d081bedb8be8b008eadebe00c43513e72
 SHA512:
-  metadata.gz: 9432edd5f7d4c2d76f873d21bb3e79c2bc54965e64d3a2df7aa8c06f64dbea479274adde5ea4d1f1acf3e128d4cc7af1fa8fb41bc801b6b3629e6ddbf1156667
-  data.tar.gz: 719d291ec00314bf8061cbe72a6abab98e1466a7162dcd174588ffc57823b8509951eb2ed28a4be3d6b6e938bd0791ff26cab9f6d478dd49f50cf28139b3cdbf
+  metadata.gz: 73d23712b3ee30c3e55fb11f95be384144ff521580ddb1afd7c3e70694aa3c57778f6a5bf751576e9a633e53720419147aadb249c4d076b0428caa0d30617829
+  data.tar.gz: 95f2eb1975d019b0f5ea57e20225552c459c6784a9584f5a79d6c45a0e92d3fd42eebfdbd010d6f00350ab750bb447ae6b50133537cec002d3aa9f6ff3d8ac73

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`
@@ -1607,6 +1610,21 @@ POST https://service.example.com/records/1z-5r1fkaj { body: "{ 'name': 'Starbuck
 
 ##### update
 
+###### Directly via Record
+
+```ruby
+# app/controllers/some_controller.rb
+
+Record.update(id: '1z-5r1fkaj', name: 'Steve')
+
+```
+```
+GET https://service.example.com/records/1z-5r1fkaj
+{ name: 'Steve' }
+```
+
+###### per Instance
+
 `update` persists the whole object after new parameters are applied through arguments.
 
 `update` will return false if persisting fails. `update!` instead will raise an exception.
@@ -2261,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: { ignored_errors: [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', '>= 11.2.0', '< 12'
   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/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
 

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+class LHS::Record
+
+  module Update
+    extend ActiveSupport::Concern
+
+    included do
+      class <<self
+        alias_method :update, :create
+        alias_method :update!, :create!
+      end
+    end
+  end
+end

data/lib/lhs/record.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class LHS::Record
+  autoload :AttributeAssignment,
+    'lhs/concerns/record/attribute_assignment'
   autoload :Batch,
     'lhs/concerns/record/batch'
   autoload :Chainable,
@@ -45,9 +47,10 @@ class LHS::Record
     'lhs/concerns/record/scope'
   autoload :Tracing,
     'lhs/concerns/record/tracing'
-  autoload :AttributeAssignment,
-    'lhs/concerns/record/attribute_assignment'
+  autoload :Update,
+    'lhs/concerns/record/update'
 
+  include AttributeAssignment
   include Batch
   include Chainable
   include Configuration
@@ -72,7 +75,7 @@ class LHS::Record
   include Relations
   include Scope
   include Tracing
-  include AttributeAssignment
+  include Update
 
   delegate :_proxy, :_endpoint, :merge_raw!, :select, :becomes, :respond_to?, to: :_data
 

data/lib/lhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHS
-  VERSION = '22.0.0'
+  VERSION = '23.0.2'
 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: { ignored_errors: [LHC::NotFound] })
+        .find(123)
+      expect(feedback.campaign._raw.keys.length).to eq 1
     end
   end
 

data/spec/record/update_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::Record do
+  context 'update' do
+
+    before do
+      class Record < LHS::Record
+        endpoint 'http://datastore/records/{id}'
+      end
+    end
+
+    it 'allows to directly update a record without fetching it first' do
+      stub_request(:post, "http://datastore/records/123")
+        .with(body: { name: 'Steve' }.to_json)
+        .to_return(status: 200, body: {}.to_json)
+
+      Record.update(
+        id: '123',
+        name: 'Steve'
+      )
+    end
+
+    it 'does not fail during an error with update' do
+      stub_request(:post, "http://datastore/records/123")
+        .with(body: { name: 'Steve' }.to_json)
+        .to_return(status: 404, body: {}.to_json)
+
+      record = Record.update(
+        id: '123',
+        name: 'Steve'
+      )
+
+      expect(record.errors.status_code).to eq 404
+    end
+
+    it 'allows to directly update! a record without fetching it first' do
+      stub_request(:post, "http://datastore/records/123")
+        .with(body: { name: 'Steve' }.to_json)
+        .to_return(status: 200)
+
+      Record.update!(
+        id: '123',
+        name: 'Steve'
+      )
+    end
+
+    it 'raises an error when trying to update! but retrieving an error status' do
+      stub_request(:post, "http://datastore/records/123")
+        .with(body: { name: 'Steve' }.to_json)
+        .to_return(status: 404)
+
+      expect(-> {
+        Record.update!(
+          id: '123',
+          name: 'Steve'
+        )
+      }).to raise_error(LHC::NotFound)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 22.0.0
+  version: 23.0.2
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -44,7 +44,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: 11.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '12'
@@ -54,7 +54,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: 11.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '12'
@@ -312,6 +312,7 @@ files:
 - lib/lhs/concerns/record/request.rb
 - lib/lhs/concerns/record/scope.rb
 - lib/lhs/concerns/record/tracing.rb
+- lib/lhs/concerns/record/update.rb
 - lib/lhs/config.rb
 - lib/lhs/data.rb
 - lib/lhs/endpoint.rb
@@ -530,6 +531,7 @@ files:
 - spec/record/to_hash_spec.rb
 - spec/record/to_json_spec.rb
 - spec/record/tracing_spec.rb
+- spec/record/update_spec.rb
 - spec/record/where_chains_spec.rb
 - spec/record/where_spec.rb
 - spec/record/where_values_hash_spec.rb
@@ -546,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: []
@@ -757,6 +759,7 @@ test_files:
 - spec/record/to_hash_spec.rb
 - spec/record/to_json_spec.rb
 - spec/record/tracing_spec.rb
+- spec/record/update_spec.rb
 - spec/record/where_chains_spec.rb
 - spec/record/where_spec.rb
 - spec/record/where_values_hash_spec.rb