lhs 26.0.0 → 26.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69eb6dce95fcd8672e27e8a2de0ffadde9f2d43264ea5cdda59b4d9920799c6a
-  data.tar.gz: ded231b01b80c8d889811425c3cd7a9f3f57867490273d0f7502a66ec8b7c6c9
+  metadata.gz: 22e5b204d979d2ed46eb93ce3ff08b6eb0aea9576f2509c7ff0c83f3c3835f75
+  data.tar.gz: 8ce212c4ad06e810bf0911f0a9fdc4e86afe434c00cfca2d3cdaaf4b5e4e1ba9
 SHA512:
-  metadata.gz: 68164ed94455f2ed987ea9447597ab4d71a8f7ed3748064250d2972da49a6b0c923ae96e62f22e0bee8da57c9415a2e70bf06eb21ce74bcd5c313a1a4ab496b1
-  data.tar.gz: b09b62b536b2e89a76a23d41b2570a6a82e939a9cffbf4a84a055df980f4327c186ac366f7d88f8d3c859b703e5fceb948180c42853941dc6e4e4fb21ba413ac
+  metadata.gz: 377c21cf804980cd3eb2ceaaac9a1bff0a68dce97fc6c92cdf15370808bb1b161cac99b20ffb94eda901ed11ed17fefac3eda74eca54c1249c837baf8ef8e1e8
+  data.tar.gz: 8a9f39abe3ee1f969d0397099d219fde3eb80278299d0ea9d44938726310b7b1025220e1a715793c787661c44219b62b17aa759cefc2bcc07fbea75b94a99447

data/README.md

@@ -171,7 +171,7 @@ record.review # "Lunch was great
 
 ### Endpoints
 
-> Endpoint, the entry point to a service, a process, or a queue or topic destination in service-oriented architecture
+> Endpoint, the entry point to a service, a process, a queue or a topic in a service-oriented architecture
 
 Start a record with configuring one or multiple endpoints.
 
@@ -251,7 +251,7 @@ end
 
 #### Endpoint Priorities
 
-LHS uses endpoint configurations to determine what endpoint to use when data is requested, in a similiar way, routes are identified in Rails to map requests to controllers.
+LHS uses endpoint configurations to determine what endpoint to use when data is requested, in a similar way, routes are identified in Rails to map requests to controllers.
 
 If they are ambiguous, LHS will always use the first one found:
 
@@ -275,7 +275,7 @@ Record.fetch
 GET https://service.example.com/records
 ```
 
-**Be aware that, if you configure ambigious endpoints accross multiple classes, the order of things is not deteministic. Ambigious endpoints accross multiple classes need to be avoided.**
+**Be aware that, if you configure ambiguous endpoints across multiple classes, the order of things is not deterministic. Ambiguous endpoints across multiple classes need to be avoided.**
 
 ### Provider
 
@@ -479,7 +479,7 @@ The different behavior of `count` and `length` is based on ActiveRecord's behavi
 
 `count` The total number of items available remotly via the provided endpoint/api, communicated via pagination meta data.
 
-`length` The number of items already loaded from the endpoint/api and kept in memmory right now. In case of a paginated endpoint this can differ to what `count` returns, as it depends on how many pages have been loaded already.
+`length` The number of items already loaded from the endpoint/api and kept in memory right now. In case of a paginated endpoint this can differ to what `count` returns, as it depends on how many pages have been loaded already.
 
 ### Find single records
 
@@ -593,7 +593,7 @@ How to configure endpoints for automatic collection detection?
 
 LHS detects automatically if the responded data is a single business object or a set of business objects (collection).
 
-Conventionally, when the responds contains an `items` key `{ items: [] }` it's treated as a collection, but also if the responds contains a plain raw array: `[{ href: '' }]` it's also treated as a collection.
+Conventionally, when the respons contains an `items` key `{ items: [] }` it's treated as a collection, but also if the respons contains a plain raw array: `[{ href: '' }]` it's also treated as a collection.
 
 If you need to configure the attribute of the response providing the collection, configure `items_key` as explained here: [Determine collections from the response body](#determine-collections-from-the-response-body)
 
@@ -782,7 +782,7 @@ end
 
 #### Unwrap nested items from the response body
 
-If the actual item data is mixed with meta data in the response body, LHS allows you to configure a record in a way to automatically unwrap items from within nested response data.
+If the actual item data is mixed with metadata in the response body, LHS allows you to configure a record in a way to automatically unwrap items from within nested response data.
 
 `item_key` is used to unwrap the actual object from within the response body.
 
@@ -1058,7 +1058,7 @@ records = Record.where(color: 'blue').fetch
 
 #### Add request options to a query chain: options
 
-You can apply options to the request chain. Those options will be forwarded to the request perfomed by the chain/query:
+You can apply options to the request chain. Those options will be forwarded to the request performed by the chain/query:
 
 ```ruby
 # app/controllers/some_controller.rb
@@ -1178,7 +1178,7 @@ Record.page(3).per(20).where(color: 'blue')
 GET https://service.example.com/records?offset=40&limit=20&color=blue
 ```
 
-The applied pagination strategy depends on whats configured for the particular record: See [Record pagination](#record-pagination)
+The applied pagination strategy depends on what's configured for the particular record: See [Record pagination](#record-pagination)
 
 ### Record pagination
 
@@ -1330,7 +1330,7 @@ Sequentially:
 ##### limit_key
 
 `limit_key` sets the key used to indicate how many items you want to retrieve per page e.g. `size`, `limit`, etc.
-In case the `limit_key` parameter differs for how it needs to be requested from how it's provided in the reponse, use `body` and `parameter` subkeys.
+In case the `limit_key` parameter differs for how it needs to be requested from how it's provided in the response, use `body` and `parameter` subkeys.
 
 ```ruby
 # app/models/record.rb
@@ -1359,7 +1359,7 @@ GET https://service.example.com/records?color=blue&max=100
 ##### pagination_key
 
 `pagination_key` defines which key to use to paginate a page (e.g. `offset`, `page`, `startAt` etc.).
-In case the `limit_key` parameter differs for how it needs to be requested from how it's provided in the reponse, use `body` and `parameter` subkeys.
+In case the `limit_key` parameter differs for how it needs to be requested from how it's provided in the response, use `body` and `parameter` subkeys.
 
 ```ruby
 # app/models/record.rb
@@ -1584,7 +1584,7 @@ POST https://service.example.com/records { body: "{ 'name' : 'Starbucks' }" }
 
 ##### save
 
-`save` persist the whole object in it's current state. 
+`save` persist the whole object in its current state. 
 
 `save` will return `false` if persisting fails. `save!` instead will raise an exception.
 
@@ -2023,7 +2023,7 @@ DELETE https://service.example.com/records?name='Steve'
 
 ### Record getters and setters
 
-Sometimes it is neccessary to implement custom getters and setters and convert data to a processable (endpoint) format behind the scenes.
+Sometimes it is necessary to implement custom getters and setters and convert data to a processable (endpoint) format behind the scenes.
 
 #### Record setters
 
@@ -2201,7 +2201,7 @@ customer.contracts.first.products.first.name # Local Business Card
 
 #### Include various levels of linked data
 
-The method syntax of `includes` allows you include hyperlinks stored in deep nested data strutures:
+The method syntax of `includes` allows you to include hyperlinks stored in deep nested data structures:
 
 Some examples:
 
@@ -2283,7 +2283,7 @@ 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:
+Here is another example, if you want to ignore errors, that occur while you fetch included resources:
 
 ```ruby
 # app/controllers/some_controller.rb

data/lhs.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'json', '>=  1.8.2'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'pry-byebug'
-  s.add_development_dependency 'rails', '>= 4.2.11'
+  s.add_development_dependency 'rails', '>= 4.2.11', '< 7'
   s.add_development_dependency 'rollbar', '<= 2.24.0'
   s.add_development_dependency 'rspec-rails', '>= 3.7.0'
   s.add_development_dependency 'rubocop', '~> 0.57.1'

data/lib/lhs/concerns/item/save.rb

@@ -34,7 +34,7 @@ class LHS::Item < LHS::Proxy
     private
 
     def apply_default_creation_options(options, url, data)
-      options = options.merge(method: :post, url: url, body: data)
+      options = options.merge(method: options.fetch(:method, :post), url: url, body: data)
       options[:headers] ||= {}
       options
     end

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

@@ -123,7 +123,15 @@ class LHS::Record
           options = extend_with_reference(options, reference)
           addition = load_existing_includes(options, data, sub_includes, reference)
           data.extend!(addition, included)
-          expand_addition!(data, included, reference) unless expanded_data?(addition)
+          unless expanded_data?(addition)
+            if data.collection?
+              data.each do |item|
+                expand_addition!(item, included, reference)
+              end
+            else
+              expand_addition!(data, included, reference)
+            end
+          end
         end
       end
 

data/lib/lhs/interceptors/auto_oauth/interceptor.rb

@@ -10,7 +10,7 @@ module LHS
       class Interceptor < LHC::Interceptor
 
         def before_request
-          request.options[:auth] = { bearer: token }
+          request.options[:auth] ||= { bearer: token }
         end
 
         def tokens

data/lib/lhs/version.rb

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

data/spec/auto_oauth_spec.rb

@@ -165,5 +165,46 @@ describe 'Auto OAuth Authentication', type: :request, dummy_models: true do
         expect(records_request).to have_been_requested
       end
     end
+
+    context 'overriding auth options with provider enabled for auto oauth' do
+
+      let(:token) { ApplicationController::ACCESS_TOKEN }
+      let(:overridden_token) { 'ACCESS_TOKEN' }
+
+      let(:record_request) do
+        stub_request(:get, "http://internalservice/v2/records/1")
+          .with(
+            headers: { 'Authorization' => "Bearer #{overridden_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 #{overridden_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_override', params: { access_token: overridden_token }
+        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

@@ -26,4 +26,11 @@ class AutomaticAuthenticationController < ApplicationController
       records: DummyRecordWithAutoOauthProvider.where(color: 'blue').as_json
     }
   end
+
+  def o_auth_with_provider_override
+    render json: {
+      record: DummyRecordWithAutoOauthProvider.options(auth: { bearer: params[:access_token] }).find(1).as_json,
+      records: DummyRecordWithAutoOauthProvider.options(auth: { bearer: params[:access_token] }).where(color: 'blue').as_json
+    }
+  end
 end

data/spec/dummy/config/routes.rb

@@ -7,6 +7,7 @@ Rails.application.routes.draw do
   get 'automatic_authentication/oauth' => 'automatic_authentication#o_auth'
   get 'automatic_authentication/oauth_with_multiple_providers' => 'automatic_authentication#o_auth_with_multiple_providers'
   get 'automatic_authentication/oauth_with_provider' => 'automatic_authentication#o_auth_with_provider'
+  get 'automatic_authentication/oauth_with_provider_override' => 'automatic_authentication#o_auth_with_provider_override'
 
   # Request Cycle Cache
   get 'request_cycle_cache/simple' => 'request_cycle_cache#simple'

data/spec/item/save_spec.rb

@@ -112,4 +112,14 @@ describe LHS::Item do
       expect(request).to have_been_requested
     end
   end
+
+  context 'chainable' do
+    it 'allows to chain save with options' do
+      stub_request(:put, item.href).with(body: item._raw.merge(name: 'Steve').to_json)
+      item.name = 'Steve'
+      result = item.options(method: :put).save
+
+      expect(result).to eq true
+    end
+  end
 end

data/spec/record/includes_after_expansion_spec.rb

@@ -69,4 +69,51 @@ describe LHS::Record do
       ).to eq 'OPL'
     end
   end
+
+  context 'with collections' do
+    before do
+      class User < LHS::Record
+        endpoint 'http://users'
+        endpoint 'http://users/{id}'
+      end
+
+      class Places < LHS::Record
+        endpoint 'http://users/{id}/places'
+        endpoint 'http://places/{id}'
+      end
+
+      stub_request(:get, 'http://users?email=user@example.com')
+        .to_return(
+          body: {
+            href: 'http://users?email=user@example.com',
+            items: [
+              {
+                places: {
+                  href: 'http://users/1/places'
+                }
+              }
+            ]
+          }.to_json
+        )
+
+      stub_request(:get, 'http://users/1/places?limit=100')
+        .to_return(
+          body: {
+            items: [
+              {
+                title: 'Place'
+              }
+            ],
+            total: 0,
+            offset: 0,
+            limit: 10
+          }.to_json
+        )
+    end
+
+    it 'includes resources after expanding plain links' do
+      user = User.includes(:places).find(email: 'user@example.com')
+      expect(user.places.first.title).to eq 'Place'
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 26.0.0
+  version: 26.2.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -135,6 +135,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.11
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -142,6 +145,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.11
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rollbar
   requirement: !ruby/object:Gem::Requirement
@@ -564,7 +570,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby >= 2.3.0
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: 'REST services accelerator: Rails gem providing an easy, active-record-like