lhc 12.3.0 → 13.4.0.pre.pro1766.1

data/spec/request/scrubbed_headers_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHC::Request do
+  let(:headers) { { private_key: 'xyz-123' } }
+  let(:response) { LHC.get(:local, headers: headers) }
+  let(:auth) { {} }
+
+  before :each do
+    LHC.config.endpoint(:local, 'http://local.ch', auth: auth)
+    stub_request(:get, 'http://local.ch').with(headers: headers)
+  end
+
+  it 'scrubs "private_key"' do
+    LHC.config.scrubs[:headers] << 'private_key'
+    expect(response.request.scrubbed_headers).to include(private_key: LHC::Scrubber::SCRUB_DISPLAY)
+  end
+
+  it 'does not add a new attribute when a non existing header should be scrubbed' do
+    LHC.config.scrubs[:headers] << 'anything'
+    expect(response.request.scrubbed_headers).not_to include('anything' => LHC::Scrubber::SCRUB_DISPLAY)
+  end
+
+  context 'when strings instead of symbols are provided' do
+    let(:headers) { { 'private_key' => 'xyz-123' } }
+
+    it 'scrubs "private_key"' do
+      LHC.config.scrubs[:headers] << 'private_key'
+      expect(response.request.scrubbed_headers).to include('private_key' => LHC::Scrubber::SCRUB_DISPLAY)
+    end
+  end
+
+  context 'other authentication strategy' do
+    let(:api_key) { '123456' }
+    let(:authorization_header) { { 'Authorization' => "Apikey #{api_key}" } }
+    let(:headers) { authorization_header }
+
+    it 'provides srubbed Authorization header' do
+      LHC.config.scrubs[:headers] << 'Authorization'
+      expect(response.request.scrubbed_headers).to include('Authorization' => LHC::Scrubber::SCRUB_DISPLAY)
+      expect(response.request.headers).to include(authorization_header)
+    end
+  end
+
+  describe 'auth' do
+    before :each do
+      LHC.config.interceptors = [LHC::Auth]
+      stub_request(:get, 'http://local.ch').with(headers: authorization_header)
+    end
+
+    let(:request) do
+      response = LHC.get(:local)
+      response.request
+    end
+
+    context 'bearer authentication' do
+      let(:bearer_token) { '123456' }
+      let(:authorization_header) { { 'Authorization' => "Bearer #{bearer_token}" } }
+      let(:auth) { { bearer: -> { bearer_token } } }
+
+      it 'provides srubbed request headers' do
+        expect(request.scrubbed_headers).to include('Authorization' => "Bearer #{LHC::Scrubber::SCRUB_DISPLAY}")
+        expect(request.headers).to include(authorization_header)
+      end
+
+      context 'when nothing should get scrubbed' do
+        before :each do
+          LHC.config.scrubs = {}
+        end
+
+        it 'does not filter beaerer auth' do
+          expect(request.scrubbed_headers).to include(authorization_header)
+        end
+      end
+    end
+
+    context 'basic authentication' do
+      let(:username) { 'steve' }
+      let(:password) { 'abcdefg' }
+      let(:credentials_base_64_codiert) { Base64.strict_encode64("#{username}:#{password}").chomp }
+      let(:authorization_header) { { 'Authorization' => "Basic #{credentials_base_64_codiert}" } }
+      let(:auth) { { basic: { username: username, password: password } } }
+
+      it 'provides srubbed request headers' do
+        expect(request.scrubbed_headers).to include('Authorization' => "Basic #{LHC::Scrubber::SCRUB_DISPLAY}")
+        expect(request.headers).to include(authorization_header)
+      end
+
+      context 'when nothing should get scrubbed' do
+        before :each do
+          LHC.config.scrubs = {}
+        end
+
+        it 'does not filter basic auth' do
+          expect(request.scrubbed_headers).to include(authorization_header)
+        end
+      end
+    end
+  end
+end

data/spec/request/scrubbed_options_spec.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHC::Request do
+  before :each do
+    LHC.config.interceptors = [LHC::Auth]
+    LHC.config.endpoint(:local, 'http://local.ch', auth: auth)
+    LHC.config.scrubs[:params] << 'api_key'
+    LHC.config.scrubs[:headers] << 'private_key'
+    LHC.config.scrubs[:body] << 'user_token'
+    stub_request(:post, "http://local.ch?#{params.to_query}").with(headers: authorization_header.merge(headers), body: body.to_json)
+  end
+
+  let(:bearer_token) { '123456' }
+  let(:authorization_header) { { 'Authorization' => "Bearer #{bearer_token}" } }
+  let(:auth) { { bearer: -> { bearer_token } } }
+  let(:params) { { api_key: 'api-key-params' } }
+  let(:headers) { { private_key: 'private-key-header' } }
+  let(:body) { { user_token: 'user-token-body' } }
+
+  let(:request) do
+    response = LHC.post(:local, params: params, headers: headers, body: body)
+    response.request
+  end
+
+  it 'provides srubbed request options' do
+    expect(request.scrubbed_options[:params]).to include(api_key: LHC::Scrubber::SCRUB_DISPLAY)
+    expect(request.scrubbed_options[:headers]).to include(private_key: LHC::Scrubber::SCRUB_DISPLAY)
+    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
+  end
+
+  context 'when options do not have auth' do
+    let(:authorization_header) { {} }
+    let(:auth) { nil }
+
+    it 'provides srubbed request options' do
+      expect(request.scrubbed_options[:params]).to include(api_key: LHC::Scrubber::SCRUB_DISPLAY)
+      expect(request.scrubbed_options[:headers]).to include(private_key: LHC::Scrubber::SCRUB_DISPLAY)
+      expect(request.scrubbed_options[:body]).to include(user_token: LHC::Scrubber::SCRUB_DISPLAY)
+      expect(request.scrubbed_options[:auth]).to be nil
+    end
+  end
+
+  context 'when body data is nested' do
+    let(:body) do
+      {
+        data: {
+          attributes: {
+            employee: {
+              name: 'Muster',
+              surname: 'Hans',
+              password: 'test-1234',
+              password_confirmation: 'test-1234'
+            }
+          }
+        }
+      }
+    end
+
+    it 'srubbes nested attributes' do
+      expect(request.scrubbed_options[:params]).to include(api_key: LHC::Scrubber::SCRUB_DISPLAY)
+      expect(request.scrubbed_options[:headers]).to include(private_key: LHC::Scrubber::SCRUB_DISPLAY)
+      expect(request.scrubbed_options[:body][:data][:attributes][:employee]).to include(password: LHC::Scrubber::SCRUB_DISPLAY)
+      expect(request.scrubbed_options[:body][:data][:attributes][:employee]).to include(password_confirmation: 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
+    end
+  end
+
+  context 'basic authentication' do
+    let(:username) { 'steve' }
+    let(:password) { 'abcdefg' }
+    let(:credentials_base_64_codiert) { Base64.strict_encode64("#{username}:#{password}").chomp }
+    let(:authorization_header) { { 'Authorization' => "Basic #{credentials_base_64_codiert}" } }
+    let(:auth) { { basic: { username: username, password: password } } }
+
+    it 'provides srubbed request headers' do
+      expect(request.scrubbed_options[:auth][:basic][:username]).to eq(LHC::Scrubber::SCRUB_DISPLAY)
+      expect(request.scrubbed_options[:auth][:basic][:password]).to eq(LHC::Scrubber::SCRUB_DISPLAY)
+      expect(request.scrubbed_options[:auth][:basic][:base_64_encoded_credentials]).to eq(LHC::Scrubber::SCRUB_DISPLAY)
+      expect(request.scrubbed_options[:auth][:bearer]).to be nil
+    end
+  end
+
+  context 'when nothing should get scrubbed' do
+    before :each do
+      LHC.config.scrubs = {}
+    end
+
+    it 'does not filter anything' do
+      expect(request.scrubbed_options[:params]).not_to include(api_key: LHC::Scrubber::SCRUB_DISPLAY)
+      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)
+    end
+  end
+
+  context 'custom data structures that respond to as_json (like LHS data or record)' do
+    before do
+      class CustomStructure
+
+        def initialize(data)
+          @data = data
+        end
+
+        def as_json
+          @data.as_json
+        end
+
+        def to_json
+          as_json.to_json
+        end
+      end
+
+      stub_request(:post, 'http://local.ch').with(body: custom_structure.to_json)
+    end
+
+    let(:custom_structure) do
+      CustomStructure.new(user_token: '12345')
+    end
+
+    let(:request) do
+      response = LHC.post(:local, body: custom_structure)
+      response.request
+    end
+
+    it 'provides srubbed request options' do
+      expect(request.scrubbed_options[:body]).to include('user_token' => LHC::Scrubber::SCRUB_DISPLAY)
+    end
+  end
+
+  context 'encoded data hash' do
+    let(:body) { { user_token: 'user-token-body' } }
+
+    let(:request) do
+      response = LHC.post(:local, body: body.to_json)
+      response.request
+    end
+
+    before :each do
+      stub_request(:post, 'http://local.ch').with(body: body.to_json)
+    end
+
+    it 'provides srubbed request options' do
+      expect(request.scrubbed_options[:body]).to include('user_token' => LHC::Scrubber::SCRUB_DISPLAY)
+    end
+  end
+
+  context 'array' do
+    let(:body) { [{ user_token: 'user-token-body' }] }
+
+    let(:request) do
+      response = LHC.post(:local, body: body)
+      response.request
+    end
+
+    before :each do
+      stub_request(:post, 'http://local.ch').with(body: body.to_json)
+    end
+
+    it 'provides srubbed request options' do
+      expect(request.scrubbed_options[:body]).to eq([user_token: LHC::Scrubber::SCRUB_DISPLAY])
+    end
+  end
+
+  context 'encoded array' do
+    let(:body) { [{ user_token: 'user-token-body' }] }
+
+    let(:request) do
+      response = LHC.post(:local, body: body.to_json)
+      response.request
+    end
+
+    before :each do
+      stub_request(:post, 'http://local.ch').with(body: body.to_json)
+    end
+
+    it 'provides srubbed request options' do
+      expect(request.scrubbed_options[:body]).to eq(['user_token' => LHC::Scrubber::SCRUB_DISPLAY])
+    end
+  end
+end

data/spec/request/scrubbed_params_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHC::Request do
+  let(:params) { { api_key: 'xyz-123', secret_key: '123-xyz' } }
+  let(:response) { LHC.get(:local, params: params) }
+
+  before :each do
+    LHC.config.endpoint(:local, 'http://local.ch')
+    stub_request(:get, "http://local.ch?#{params.to_query}")
+  end
+
+  it 'scrubs "api_key"' do
+    LHC.config.scrubs[:params] << 'api_key'
+    expect(response.request.scrubbed_params).to include(api_key: LHC::Scrubber::SCRUB_DISPLAY)
+    expect(response.request.scrubbed_params).to include(secret_key: '123-xyz')
+  end
+
+  it 'scrubs "api_key" and "secret_key"' do
+    LHC.config.scrubs[:params].push('api_key', 'secret_key')
+    expect(response.request.scrubbed_params).to include(api_key: LHC::Scrubber::SCRUB_DISPLAY)
+    expect(response.request.scrubbed_params).to include(secret_key: LHC::Scrubber::SCRUB_DISPLAY)
+  end
+end

data/spec/response/data_spec.rb

@@ -75,9 +75,9 @@ describe LHC::Response do
     it 'does not throw a stack level to deep issue when accessing data in a rescue context' do
       begin
         LHC.get('http://listings')
-      rescue LHC::Error => error
+      rescue LHC::Error => e
         expect(
-          error.response.request.response.data.meta.errors.detect { |item| item.code == 2000 }.msg
+          e.response.request.response.data.meta.errors.detect { |item| item.code == 2000 }.msg
         ).to eq 'I like to hide error messages (this is meta).'
       end
     end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@
 require 'pry'
 require 'webmock/rspec'
 require 'lhc'
+require 'lhc/rspec'
 require 'timecop'
 
 Dir[File.join(__dir__, "support/**/*.rb")].each { |f| require f }

data/spec/support/zipkin_mock.rb

@@ -3,6 +3,7 @@
 module ZipkinTracer
   class TraceContainer
     attr_reader :trace_id, :parent_id, :span_id, :sampled, :flags
+
     class << self
       attr_accessor :current
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 12.3.0
+  version: 13.4.0.pre.pro1766.1
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.1
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.1
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -188,29 +216,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".rubocop.localch.yml"
 - ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
-- Gemfile.activesupport4
 - Gemfile.activesupport5
 - Gemfile.activesupport6
 - LICENSE
 - README.md
 - Rakefile
-- cider-ci.yml
-- cider-ci/bin/bundle
-- cider-ci/bin/ruby_install
-- cider-ci/bin/ruby_version
-- cider-ci/jobs/rspec-activesupport-4.yml
-- cider-ci/jobs/rspec-activesupport-5.yml
-- cider-ci/jobs/rspec-activesupport-6.yml
-- cider-ci/jobs/rubocop.yml
-- cider-ci/task_components/bundle.yml
-- cider-ci/task_components/rspec.yml
-- cider-ci/task_components/rubocop.yml
-- cider-ci/task_components/ruby.yml
 - friday.yml
 - lhc.gemspec
 - lib/core_ext/hash/deep_transform_values.rb
@@ -254,6 +270,11 @@ files:
 - lib/lhc/response/data/collection.rb
 - lib/lhc/response/data/item.rb
 - lib/lhc/rspec.rb
+- lib/lhc/scrubber.rb
+- lib/lhc/scrubbers/auth_scrubber.rb
+- lib/lhc/scrubbers/body_scrubber.rb
+- lib/lhc/scrubbers/headers_scrubber.rb
+- lib/lhc/scrubbers/params_scrubber.rb
 - lib/lhc/test/cache_helper.rb
 - lib/lhc/version.rb
 - script/ci/build.sh
@@ -265,6 +286,7 @@ files:
 - spec/basic_methods/request_without_rails_spec.rb
 - spec/config/endpoints_spec.rb
 - spec/config/placeholders_spec.rb
+- spec/config/scrubs_spec.rb
 - spec/core_ext/hash/deep_transform_values_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
@@ -335,6 +357,7 @@ files:
 - spec/interceptors/caching/hydra_spec.rb
 - spec/interceptors/caching/main_spec.rb
 - spec/interceptors/caching/methods_spec.rb
+- spec/interceptors/caching/multilevel_cache_spec.rb
 - spec/interceptors/caching/options_spec.rb
 - spec/interceptors/caching/parameters_spec.rb
 - spec/interceptors/caching/response_status_spec.rb
@@ -344,6 +367,7 @@ files:
 - spec/interceptors/define_spec.rb
 - spec/interceptors/dup_spec.rb
 - spec/interceptors/logging/main_spec.rb
+- spec/interceptors/monitoring/caching_spec.rb
 - spec/interceptors/monitoring/main_spec.rb
 - spec/interceptors/prometheus_spec.rb
 - spec/interceptors/response_competition_spec.rb
@@ -364,6 +388,9 @@ files:
 - spec/request/parallel_requests_spec.rb
 - spec/request/params_encoding_spec.rb
 - spec/request/request_without_rails_spec.rb
+- spec/request/scrubbed_headers_spec.rb
+- spec/request/scrubbed_options_spec.rb
+- spec/request/scrubbed_params_spec.rb
 - spec/request/url_patterns_spec.rb
 - spec/request/user_agent_spec.rb
 - spec/request/user_agent_without_rails_spec.rb
@@ -397,15 +424,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      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.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Advanced HTTP Client for Ruby, fueled with interceptors
@@ -418,6 +445,7 @@ test_files:
 - spec/basic_methods/request_without_rails_spec.rb
 - spec/config/endpoints_spec.rb
 - spec/config/placeholders_spec.rb
+- spec/config/scrubs_spec.rb
 - spec/core_ext/hash/deep_transform_values_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
@@ -488,6 +516,7 @@ test_files:
 - spec/interceptors/caching/hydra_spec.rb
 - spec/interceptors/caching/main_spec.rb
 - spec/interceptors/caching/methods_spec.rb
+- spec/interceptors/caching/multilevel_cache_spec.rb
 - spec/interceptors/caching/options_spec.rb
 - spec/interceptors/caching/parameters_spec.rb
 - spec/interceptors/caching/response_status_spec.rb
@@ -497,6 +526,7 @@ test_files:
 - spec/interceptors/define_spec.rb
 - spec/interceptors/dup_spec.rb
 - spec/interceptors/logging/main_spec.rb
+- spec/interceptors/monitoring/caching_spec.rb
 - spec/interceptors/monitoring/main_spec.rb
 - spec/interceptors/prometheus_spec.rb
 - spec/interceptors/response_competition_spec.rb
@@ -517,6 +547,9 @@ test_files:
 - spec/request/parallel_requests_spec.rb
 - spec/request/params_encoding_spec.rb
 - spec/request/request_without_rails_spec.rb
+- spec/request/scrubbed_headers_spec.rb
+- spec/request/scrubbed_options_spec.rb
+- spec/request/scrubbed_params_spec.rb
 - spec/request/url_patterns_spec.rb
 - spec/request/user_agent_spec.rb
 - spec/request/user_agent_without_rails_spec.rb