lhs 21.3.0 → 21.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cadb661567a1a911f12d612030d14ca963216bc6cca0874525b50ec9afe6d2c1
-  data.tar.gz: f110c85be3c7ff12f00797f1268f14ba9376c235e1d8dbe9665fb51515f7c0b2
+  metadata.gz: c43753bff8b039bf6b5b2384333afcc1d09da6c61f1616b06751c7a023e0fbc0
+  data.tar.gz: ee5cd17ace1e7f82fc8a713dc493543e800658bd76909ddb026951d84f31c2df
 SHA512:
-  metadata.gz: ed5dc79199bd8563b951f0131dbb4965e7133898f703104f054cbffe52953ed2c6d9526d046d2077d7b1420ba15e6a3c1ef6ac8168a8087c62d9cc50e227a8cc
-  data.tar.gz: 2cf77b9a2955eac7cf408f3f35174863b6b773133149b77e0aea47a74808d5d43ab43d99e00cd7bdab4a1c41e8c59c831d31dfae64f8f5d3723f65102288aa06
+  metadata.gz: 14d9ddf1745b15e1c635060eec564a3e578f31829e24dede722ca5509a1dffeefec3fb0daaeb27c94f3c9854314d41fe9042cccfbd04ca3fdc2bab3a32bb9120
+  data.tar.gz: ac97fc333b97f8492bc519b401b68377af441e398486ceaea183d8b006015b691d1aad9a0f518ebf5367cf4427098d767e96354813da94807021195a38f3e997

data/README.md

@@ -136,6 +136,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 +151,7 @@ record.review # "Lunch was great
 
 
 
+
 ## Installation/Startup checklist
 
 - [ ] Install LHS gem, preferably via `Gemfile`
@@ -2545,6 +2547,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/lib/lhs/concerns/record/request.rb

@@ -532,7 +532,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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHS
-  VERSION = '21.3.0'
+  VERSION = '21.3.1'
 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

data/spec/dummy/app/models/providers/internal_services.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Providers
+  class InternalServices < LHS::Record
+    provider(oauth: true)
+  end
+end

data/spec/dummy/config/routes.rb

@@ -6,6 +6,7 @@ Rails.application.routes.draw do
   # Automatic Authentication
   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'
 
   # Request Cycle Cache
   get 'request_cycle_cache/simple' => 'request_cycle_cache#simple'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 21.3.0
+  version: 21.3.1
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
@@ -388,12 +388,14 @@ files:
 - spec/dummy/app/models/concerns/.keep
 - spec/dummy/app/models/dummy_customer.rb
 - spec/dummy/app/models/dummy_record.rb
+- spec/dummy/app/models/dummy_record_with_auto_oauth_provider.rb
 - spec/dummy/app/models/dummy_record_with_multiple_oauth_providers1.rb
 - spec/dummy/app/models/dummy_record_with_multiple_oauth_providers2.rb
 - spec/dummy/app/models/dummy_record_with_multiple_providers_per_endpoint.rb
 - spec/dummy/app/models/dummy_record_with_oauth.rb
 - spec/dummy/app/models/dummy_user.rb
 - spec/dummy/app/models/providers/customer_system.rb
+- spec/dummy/app/models/providers/internal_services.rb
 - spec/dummy/app/views/error_handling_with_chains/error.html.erb
 - spec/dummy/app/views/error_handling_with_chains/show.html.erb
 - spec/dummy/app/views/form_for.html.erb
@@ -613,12 +615,14 @@ test_files:
 - spec/dummy/app/models/concerns/.keep
 - spec/dummy/app/models/dummy_customer.rb
 - spec/dummy/app/models/dummy_record.rb
+- spec/dummy/app/models/dummy_record_with_auto_oauth_provider.rb
 - spec/dummy/app/models/dummy_record_with_multiple_oauth_providers1.rb
 - spec/dummy/app/models/dummy_record_with_multiple_oauth_providers2.rb
 - spec/dummy/app/models/dummy_record_with_multiple_providers_per_endpoint.rb
 - spec/dummy/app/models/dummy_record_with_oauth.rb
 - spec/dummy/app/models/dummy_user.rb
 - spec/dummy/app/models/providers/customer_system.rb
+- spec/dummy/app/models/providers/internal_services.rb
 - spec/dummy/app/views/error_handling_with_chains/error.html.erb
 - spec/dummy/app/views/error_handling_with_chains/show.html.erb
 - spec/dummy/app/views/form_for.html.erb