lhc 15.1.1 → 16.0.0.pre.pro2162

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 301499c3239741a748386c3e33d552611f2817f2880579b3df9e320b336db894
-  data.tar.gz: 27c61057ca12aa70076e0fbe71da8cf8f0eac225420dcdd11ba297336aea85e8
+  metadata.gz: 624333537e8e35fa6ece5b46b1748263e023b439060c8e8b6b7ca0572db52ead
+  data.tar.gz: 588b9c2328f9ef96fa6709d6d12580083712e863838cb6e3b75b9dfb2e0efe35
 SHA512:
-  metadata.gz: 890dd068ed2902de6990b1b90ef5082f4f6d0c26e65022db14157615dd858f7302a8419b8457f6da403f3423aabdfa13f0838a748846f7f93e13339c0415eca6
-  data.tar.gz: e66683421af741d105294a5eb5fb33f26dbab024653b51647f3597e3256cd2bb114202d1599e4f0019f6157b08123afea794c68ddddd6f286518a99476c9dc9d
+  metadata.gz: d038ab78edbddf4f9d3cd8c4f8dd85285448a79498df99f02e9893bf04a68a80fc17fa286555399752452c1e68701307eb2d45112df1bb31df7f96b81c531b23
+  data.tar.gz: d45a0a5e8990644c7748527affe7fcee24f481f10043f6368ca90a5bbe8b76ad6e32fbfecc85e65e8f21765799926576ad815f443b34617540b6da8594f66d2b

data/README.md

@@ -618,18 +618,12 @@ Adds the following to body of all requests:
 
 ##### Reauthenticate
 
-The current implementation offers only reauthentication for _client access tokens_.
-Make sure that your interceptors contain `LHC::Auth` and `LHC::Retry`, whereas `LHC::Retry` comes _after_ `LHC::Auth` in the chain.
-Provide the refresh token as following:
-```ruby
-LHC.get('http://local.ch', auth: { bearer: -> { access_token }, refresh_client_token: -> { TokenRefreshUtil.client_access_token(true) })
-```
-Where `TokenRefreshUtil.client_access_token(true)` forces a refresh of the token and returns the new token. It is also expected that this implementation will handle invalidating caches if necessary.
+The current implementation can only offer reauthenticate for _client access tokens_. For this to work the following has to be given:
 
-You can also set a global `refresh_client_token`. This is not recommended for apps with multiple endpoint and different access tokens.
-```ruby
-LHC::Auth.refresh_client_token = -> { TokenRefreshUtil.client_access_token(true) }
-```
+* You have configured and implemented `LHC::Auth.refresh_client_token = -> { TokenRefreshUtil.client_access_token(true) }` which when called will force a refresh of the token and return the new value. It is also expected that this implementation will handle invalidating caches if necessary.
+* Your interceptors contain `LHC::Auth` and `LHC::Retry`, whereas `LHC::Retry` comes _after_ `LHC::Auth` in the chain.
+
+##### Bearer Authentication with client access token
 
 Reauthentication will be initiated if:
 

data/lhc.gemspec

@@ -24,7 +24,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activesupport', '>= 5.2'
   s.add_dependency 'addressable'
-  s.add_dependency 'local_uri'
   s.add_dependency 'typhoeus', '>= 0.11'
 
   s.add_development_dependency 'geminabox'

data/lib/lhc/error.rb

@@ -75,7 +75,7 @@ class LHC::Error < StandardError
     debug << "Options: #{request.scrubbed_options}"
     debug << "Headers: #{request.scrubbed_headers}"
     debug << "Response Code: #{response.code} (#{response.options[:return_code]})"
-    debug << "Response Options: #{response.scrubbed_options}"
+    debug << "Response Options: #{response.options}"
     debug << response.body
     debug << _message
     debug.map { |str| self.class.fix_invalid_encoding(str) }.join("\n")

data/lib/lhc/interceptors/auth.rb

@@ -56,9 +56,14 @@ class LHC::Auth < LHC::Interceptor
   # rubocop:enable Style/AccessorMethodName
 
   def reauthenticate!
-    # refresh token and update header
-    token = refresh_client_token_option.call
-    set_bearer_authorization_header(token)
+    # refresh access_token
+    refresh_client_token_option.call
+
+    # Now as the token is refreshe
+    # we need to use the refreshed bearer token
+    # in the authorization header
+    bearer_authentication! if auth_options[:bearer]
+
     # trigger LHC::Retry and ensure we do not trigger reauthenticate!
     # again should it fail another time
     new_options = request.options.dup

data/lib/lhc/request.rb

@@ -72,7 +72,6 @@ class LHC::Request
 
   def scrubbed_options
     scrubbed_options = options.deep_dup
-    scrubbed_options[:cache] = LHC::CacheScrubber.new(scrubbed_options[:cache]).scrubbed
     scrubbed_options[:params] = LHC::ParamsScrubber.new(scrubbed_options[:params]).scrubbed
     scrubbed_options[:headers] = LHC::HeadersScrubber.new(scrubbed_options[:headers], scrubbed_options[:auth]).scrubbed
     scrubbed_options[:auth] = LHC::AuthScrubber.new(scrubbed_options[:auth]).scrubbed

data/lib/lhc/response.rb

@@ -54,12 +54,6 @@ class LHC::Response
     request.format
   end
 
-  def scrubbed_options
-    scrubbed_options = options.deep_dup
-    scrubbed_options[:effective_url] = LHC::EffectiveUrlScrubber.new(scrubbed_options[:effective_url]).scrubbed
-    scrubbed_options
-  end
-
   private
 
   attr_accessor :raw

data/lib/lhc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHC
-  VERSION ||= '15.1.1'
+  VERSION ||= '16.0.0-pro2162'
 end

data/lib/lhc.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'local_uri'
 require 'typhoeus'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/keys'
@@ -120,10 +119,6 @@ module LHC
            'lhc/scrubbers/auth_scrubber'
   autoload :BodyScrubber,
            'lhc/scrubbers/body_scrubber'
-  autoload :CacheScrubber,
-           'lhc/scrubbers/cache_scrubber'
-  autoload :EffectiveUrlScrubber,
-           'lhc/scrubbers/effective_url_scrubber'
   autoload :HeadersScrubber,
            'lhc/scrubbers/headers_scrubber'
   autoload :ParamsScrubber,

data/spec/error/to_s_spec.rb

@@ -55,12 +55,10 @@ describe LHC::Error do
       end
 
       let(:response) do
-        options = { return_code: :internal_error, response_headers: "" }
         double('LHC::Response',
                request: request,
                code: 500,
-               options: options,
-               scrubbed_options: options,
+               options: { return_code: :internal_error, response_headers: "" },
                body: '{"status":500,"message":"undefined"}')
       end
 

data/spec/interceptors/auth/reauthentication_spec.rb

@@ -5,7 +5,10 @@ require 'rails_helper'
 describe LHC::Auth do
   let(:initial_token) { '123456' }
   let(:refresh_token) { 'abcdef' }
-  let(:options) { { bearer: initial_token, refresh_client_token: -> { refresh_token } } }
+
+  let(:options) do
+    { bearer: -> { DummyAuthentication.access_token }, refresh_client_token: -> { DummyAuthentication.refresh_token } }
+  end
   let!(:auth_failing) do
     stub_request(:get, 'http://local.ch')
       .with(headers: { 'Authorization' => "Bearer #{initial_token}" })
@@ -17,6 +20,23 @@ describe LHC::Auth do
   end
 
   before(:each) do
+    class DummyAuthentication
+
+      def self.refresh_token
+        # updates access_token
+      end
+
+      def self.access_token
+        # this is used as bearer token
+      end
+    end
+
+    # It does not matter what value this method returns it is not use by LHC.
+    # That method needs just to make sure that the value of the access_token
+    # is the new valid token
+    allow(DummyAuthentication).to receive(:refresh_token).and_return(nil)
+
+    allow(DummyAuthentication).to receive(:access_token).and_return(initial_token, refresh_token)
     LHC.config.interceptors = [LHC::Auth, LHC::Retry]
   end
 

data/spec/request/scrubbed_options_spec.rb

@@ -18,12 +18,9 @@ describe LHC::Request do
   let(:params) { { api_key: 'api-key-params' } }
   let(:headers) { { private_key: 'private-key-header' } }
   let(:body) { { user_token: 'user-token-body' } }
-  let(:cache) do
-    { key: "LHS_REQUEST_CYCLE_CACHE(v1) POST http://local.ch?#{params}" }
-  end
 
   let(:request) do
-    response = LHC.post(:local, params: params, headers: headers, body: body, cache: cache)
+    response = LHC.post(:local, params: params, headers: headers, body: body)
     response.request
   end
 
@@ -33,8 +30,6 @@ describe LHC::Request do
     expect(request.scrubbed_options[:body]).to include(user_token: LHC::Scrubber::SCRUB_DISPLAY)
     expect(request.scrubbed_options[:auth][:bearer_token]).to eq(LHC::Scrubber::SCRUB_DISPLAY)
     expect(request.scrubbed_options[:auth][:basic]).to be nil
-    expect(request.scrubbed_options[:cache])
-      .to include(key: "LHS_REQUEST_CYCLE_CACHE(v1) POST http://local.ch?{:api_key=>\"[FILTERED]\"}")
   end
 
   context 'when bearer auth is not a proc' do
@@ -58,19 +53,6 @@ describe LHC::Request do
     end
   end
 
-  context 'when parameter should not get scrubbed' do
-    let(:params) { { any_parameter: 'any-parameter' } }
-
-    let(:cache) do
-      { key: "LHS_REQUEST_CYCLE_CACHE(v1) POST http://local.ch?#{params}" }
-    end
-
-    it 'does not scrubb the parameter' do
-      expect(request.scrubbed_options[:cache])
-        .to include(key: "LHS_REQUEST_CYCLE_CACHE(v1) POST http://local.ch?#{params}")
-    end
-  end
-
   context 'when body data is nested' do
     let(:body) do
       {
@@ -122,8 +104,6 @@ describe LHC::Request do
       expect(request.scrubbed_options[:headers]).not_to include(private_key: LHC::Scrubber::SCRUB_DISPLAY)
       expect(request.scrubbed_options[:body]).not_to include(user_token: LHC::Scrubber::SCRUB_DISPLAY)
       expect(request.scrubbed_options[:auth][:bearer_token]).not_to eq(LHC::Scrubber::SCRUB_DISPLAY)
-      expect(request.scrubbed_options[:cache])
-        .not_to include(key: "LHS_REQUEST_CYCLE_CACHE(v1) POST http://local.ch?{:api_key=>\"[FILTERED]\"}")
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 15.1.1
+  version: 16.0.0.pre.pro2162
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: local_uri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -287,8 +273,6 @@ files:
 - lib/lhc/scrubber.rb
 - lib/lhc/scrubbers/auth_scrubber.rb
 - lib/lhc/scrubbers/body_scrubber.rb
-- lib/lhc/scrubbers/cache_scrubber.rb
-- lib/lhc/scrubbers/effective_url_scrubber.rb
 - lib/lhc/scrubbers/headers_scrubber.rb
 - lib/lhc/scrubbers/params_scrubber.rb
 - lib/lhc/test/cache_helper.rb
@@ -417,7 +401,6 @@ files:
 - spec/response/effective_url_spec.rb
 - spec/response/headers_spec.rb
 - spec/response/options_spec.rb
-- spec/response/scrubbed_options_spec.rb
 - spec/response/success_spec.rb
 - spec/response/time_spec.rb
 - spec/spec_helper.rb
@@ -444,9 +427,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements:
 - Ruby >= 2.0.0
 rubygems_version: 3.1.4
@@ -577,7 +560,6 @@ test_files:
 - spec/response/effective_url_spec.rb
 - spec/response/headers_spec.rb
 - spec/response/options_spec.rb
-- spec/response/scrubbed_options_spec.rb
 - spec/response/success_spec.rb
 - spec/response/time_spec.rb
 - spec/spec_helper.rb

data/lib/lhc/scrubbers/cache_scrubber.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-class LHC::CacheScrubber < LHC::Scrubber
-  def initialize(data)
-    super(data)
-    scrub_cache_options!
-  end
-
-  private
-
-  def scrub_cache_options!
-    return if scrubbed.blank?
-    return if scrub_elements.blank?
-
-    scrub_cache_key!
-  end
-
-  def scrub_cache_key!
-    return if scrubbed[:key].blank?
-
-    scrub_elements.each do |scrub_element|
-      matches = scrubbed[:key].match(/:#{scrub_element}=>"(.*?)"/)
-      next if matches.nil?
-
-      value = matches[-1]
-      scrubbed[:key].gsub!(value, SCRUB_DISPLAY)
-    end
-  end
-
-  def scrub_elements
-    # The cache key includes the whole request url inklusive params.
-    # We need to scrub those params from the cache key.
-    LHC.config.scrubs[:params]
-  end
-end

data/lib/lhc/scrubbers/effective_url_scrubber.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-class LHC::EffectiveUrlScrubber < LHC::Scrubber
-  def initialize(data)
-    super(data)
-    scrub_effective_url_options!
-  end
-
-  private
-
-  def scrub_effective_url_options!
-    return if scrubbed.blank?
-    return if scrub_elements.blank?
-
-    scrub_effective_url!
-  end
-
-  def scrub_effective_url!
-    return if scrubbed.blank?
-
-    scrub_elements.each do |scrub_element|
-      uri = LocalUri::URI.new(scrubbed)
-      self.scrubbed = CGI.unescape(uri.query.merge(scrub_element => SCRUB_DISPLAY).to_s)
-    end
-  end
-
-  def scrub_elements
-    # The effective url includes the params of the request
-    # so we need to scrub those params from the effective url.
-    LHC.config.scrubs[:params]
-  end
-end

data/spec/response/scrubbed_options_spec.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-describe LHC::Response do
-  let(:options) do
-    { effective_url: 'http://local.ch?api_key=api-key' }
-  end
-
-  let(:raw_response) { OpenStruct.new(options: options) }
-
-  before do
-    LHC.config.scrubs[:params] << 'api_key'
-  end
-
-  it 'scrubbes effective url' do
-    response = LHC::Response.new(raw_response, nil)
-    expect(response.scrubbed_options[:effective_url]).to eq "http://local.ch?api_key=#{LHC::Scrubber::SCRUB_DISPLAY}"
-  end
-end