lhs 21.3.0 → 23.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cadb661567a1a911f12d612030d14ca963216bc6cca0874525b50ec9afe6d2c1
-  data.tar.gz: f110c85be3c7ff12f00797f1268f14ba9376c235e1d8dbe9665fb51515f7c0b2
+  metadata.gz: 562b089ef00109a1306d02abae66e41f5c8145f8543a9b9f9dffb75fe2133d7b
+  data.tar.gz: c04bd6e68e91cc8b31348cc6745970775719ab7f7a00ee7c9bdbbf71f96deb79
 SHA512:
-  metadata.gz: ed5dc79199bd8563b951f0131dbb4965e7133898f703104f054cbffe52953ed2c6d9526d046d2077d7b1420ba15e6a3c1ef6ac8168a8087c62d9cc50e227a8cc
-  data.tar.gz: 2cf77b9a2955eac7cf408f3f35174863b6b773133149b77e0aea47a74808d5d43ab43d99e00cd7bdab4a1c41e8c59c831d31dfae64f8f5d3723f65102288aa06
+  metadata.gz: 0e3e2fad39c0d7dd4057823a8b1645a42636dfbe020bfbb7405beff04ef578084ba13f44246556820a9ce77b4674ef8ecac2de05159e5820741273b57c1e43b1
+  data.tar.gz: 18e8f76ad0d212f5153c0ff4eb13c730ae9c4e3d089708fced3d8c409361ababe528d601e6761733c4a50925825e10b1fb36352ec527ea255683e55cacfd5fa6

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)
@@ -136,6 +138,7 @@ record.review # "Lunch was great
      * [Disable request cycle cache](#disable-request-cycle-cache)
   * [Automatic Authentication (OAuth)](#automatic-authentication-oauth)
      * [Configure multiple auth providers (even per endpoint)](#configure-multiple-auth-providers-even-per-endpoint)
+     * [Configure providers](#configure-providers)
   * [Option Blocks](#option-blocks)
   * [Request tracing](#request-tracing)
   * [Extended Rollbar Logging](#extended-rollbar-logging)
@@ -150,6 +153,8 @@ record.review # "Lunch was great
 
 
 
+
+
 ## Installation/Startup checklist
 
 - [ ] Install LHS gem, preferably via `Gemfile`
@@ -1605,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.
@@ -2091,7 +2111,7 @@ In a service-oriented architecture using [hyperlinks](https://en.wikipedia.org/w
 
 When fetching records with LHS, you can specify in advance all the linked resources that you want to include in the results. 
 
-With `includes` or `includes_all` (to enforce fetching all remote objects for paginated endpoints), LHS ensures that all matching and explicitly linked resources are loaded and merged.
+With `includes` LHS ensures that all matching and explicitly linked resources are loaded and merged (even if the linked resources are paginated).
 
 Including linked resources/records is heavily influenced by [https://guides.rubyonrails.org/active_record_querying.html](https://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations) and you should read it to understand this feature in all it's glory.
 
@@ -2110,16 +2130,16 @@ Presence.create(place: { href: Place.href_for(123) })
 POST '/presences' { place: { href: "http://datastore/places/123" } }
 ```
 
-#### Ensure the whole linked collection is included: includes_all
+#### Ensure the whole linked collection is included with includes
 
-In case endpoints are paginated and you are certain that you'll need all objects of a set and not only the first page/batch, use `includes_all`.
+In case endpoints are paginated and you are certain that you'll need all objects of a set and not only the first page/batch, use `includes`.
 
 LHS will ensure that all linked resources are around by loading all pages (parallelized/performance optimized).
 
 ```ruby
 # app/controllers/some_controller.rb
 
-customer = Customer.includes_all(contracts: :products).find(1)
+customer = Customer.includes(contracts: :products).find(1)
 ```
 ```
 > GET https://service.example.com/customers/1
@@ -2146,14 +2166,14 @@ customer.contracts.first.products.first.name # Local Business Card
 
 ```
 
-#### Include the first linked page or single item is included: include
+#### Include only the first linked page of a linked collection: includes_first_page
 
-`includes` includes the first page/response when loading the linked resource. **If the endpoint is paginated, only the first page will be included.**
+`includes_first_page` includes the first page/response when loading the linked resource. **If the endpoint is paginated, only the first page will be included.**
 
 ```ruby
 # app/controllers/some_controller.rb
 
-customer = Customer.includes(contracts: :products).find(1)
+customer = Customer.includes_first_page(contracts: :products).find(1)
 ```
 ```
 > GET https://service.example.com/customers/1
@@ -2177,7 +2197,7 @@ customer.contracts.first.products.first.name # Local Business Card
 
 #### Include various levels of linked data
 
-The method syntax of `includes` and `includes_all`, allows you include hyperlinks stored in deep nested data strutures:
+The method syntax of `includes` allows you include hyperlinks stored in deep nested data strutures:
 
 Some examples:
 
@@ -2197,7 +2217,7 @@ Record.includes(campaign: [:entry, :user])
 
 #### Identify and cast known records when including records
 
-When including linked resources with `includes` or `includes_all`, already defined records and their endpoints and configurations are used to make the requests to fetch the additional data.
+When including linked resources with `includes`, already defined records and their endpoints and configurations are used to make the requests to fetch the additional data.
 
 That also means that options for endpoints of linked resources are applied when requesting those in addition.
 
@@ -2259,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!**
@@ -2545,6 +2576,36 @@ class Record < LHS::Record
 end
 ```
 
+### Configure providers
+
+If you're using LHS service providers, you can also configure auto auth on a provider level:
+
+```ruby
+# app/models/providers/localsearch.rb
+module Providers
+  class Localsearch < LHS::Record
+    
+    provider(
+      oauth: true
+    )
+  end
+end
+```
+
+or with multiple auth providers:
+
+```ruby
+# app/models/providers/localsearch.rb
+module Providers
+  class Localsearch < LHS::Record
+    
+    provider(
+      oauth: :provider_1
+    )
+  end
+end
+```
+
 ## Option Blocks
 
 In order to apply options to all requests performed in a give block, LHS provides option blocks.

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'

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

@@ -64,11 +64,11 @@ class LHS::Record
         chain
       end
 
-      def includes(*args)
+      def includes_first_page(*args)
         Chain.new(self, Include.new(Chain.unfold(args)))
       end
 
-      def includes_all(*args)
+      def includes(*args)
         chain = Chain.new(self, Include.new(Chain.unfold(args)))
         chain.include_all!(args)
         chain
@@ -259,11 +259,11 @@ class LHS::Record
         push(ErrorHandling.new(error_class => handler))
       end
 
-      def includes(*args)
+      def includes_first_page(*args)
         push(Include.new(Chain.unfold(args)))
       end
 
-      def includes_all(*args)
+      def includes(*args)
         chain = push(Include.new(Chain.unfold(args)))
         chain.include_all!(args)
         chain

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
 
@@ -532,7 +526,7 @@ class LHS::Record
         end
 
         endpoint = find_endpoint(options[:params], options.fetch(:url, nil))
-        if auto_oauth? || (endpoint.options&.dig(:oauth) && LHS.config.auto_oauth)
+        if auto_oauth? || (endpoint.options&.dig(:oauth) && LHS.config.auto_oauth) || options[:oauth]
           inject_interceptor!(
             options.merge!(record: self),
             LHS::Interceptors::AutoOauth::Interceptor,

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 = '21.3.0'
+  VERSION = '23.0.0'
 end

data/spec/auto_oauth_spec.rb

@@ -125,5 +125,45 @@ describe 'Auto OAuth Authentication', type: :request, dummy_models: true do
         expect(record_request_per_endpoint_provider_2).to have_been_requested
       end
     end
+
+    context 'with provider enabled for auto oauth' do
+
+      let(:token) { ApplicationController::ACCESS_TOKEN }
+
+      let(:record_request) do
+        stub_request(:get, "http://internalservice/v2/records/1")
+          .with(
+            headers: { 'Authorization' => "Bearer #{token}" }
+          ).to_return(status: 200, body: { name: 'Record' }.to_json)
+      end
+
+      let(:records_request) do
+        stub_request(:get, "http://internalservice/v2/records?color=blue")
+          .with(
+            headers: { 'Authorization' => "Bearer #{token}" }
+          ).to_return(status: 200, body: { items: [{ name: 'Record' }] }.to_json)
+      end
+
+      before do
+        LHS.configure do |config|
+          config.auto_oauth = -> { access_token }
+        end
+        LHC.configure do |config|
+          config.interceptors = [LHC::Auth]
+        end
+        record_request
+        records_request
+      end
+
+      after do
+        LHC.config.reset
+      end
+
+      it 'applies OAuth credentials for the individual request automatically' do
+        get '/automatic_authentication/oauth_with_provider'
+        expect(record_request).to have_been_requested
+        expect(records_request).to have_been_requested
+      end
+    end
   end
 end

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

@@ -19,4 +19,11 @@ class AutomaticAuthenticationController < ApplicationController
       }
     }
   end
+
+  def o_auth_with_provider
+    render json: {
+      record: DummyRecordWithAutoOauthProvider.find(1).as_json,
+      records: DummyRecordWithAutoOauthProvider.where(color: 'blue').as_json
+    }
+  end
 end

data/spec/dummy/app/models/dummy_record_with_auto_oauth_provider.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class DummyRecordWithAutoOauthProvider < Providers::InternalServices
+  endpoint 'http://internalservice/v2/records'
+  endpoint 'http://internalservice/v2/records/{id}'
+end