lhc 13.0.0 → 15.0.0

data/spec/request/scrubbed_params_spec.rb

@@ -0,0 +1,35 @@
+# 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
+
+  context 'when value is empty' do
+    let(:params) { { api_key: nil, secret_key: '' } }
+
+    it 'does not filter the value' do
+      LHC.config.scrubs[:params].push('api_key', 'secret_key')
+      expect(response.request.scrubbed_params).to include(api_key: nil)
+      expect(response.request.scrubbed_params).to include(secret_key: '')
+    end
+  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/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: 13.0.0
+  version: 15.0.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,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
@@ -202,8 +216,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".rubocop.localch.yml"
 - ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
@@ -212,17 +227,6 @@ files:
 - 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-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
@@ -266,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
@@ -277,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
@@ -357,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
@@ -377,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
@@ -402,7 +416,7 @@ homepage: https://github.com/local-ch/lhc
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -410,7 +424,7 @@ 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:
   - - ">="
@@ -418,8 +432,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby >= 2.0.0
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Advanced HTTP Client for Ruby, fueled with interceptors
 test_files:
@@ -431,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
@@ -511,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
@@ -531,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

data/.rubocop.localch.yml

@@ -1,325 +0,0 @@
-# This is master rubocop configuration.
-# DO NOT EDIT THIS FILE - it WILL be overwriten on every config update
-AllCops:
-  TargetRubyVersion: 2.3
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  Exclude:
-    - 'db/**/*'
-    - 'script/**/*'
-    - 'vendor/bundle/**/*'
-    - 'vendor/assets/**/*'
-    - 'bin/**/*'
-    - 'config/unicorn.rb'
-    - 'config/compass.rb'
-    - 'Rakefile'
-    - 'app/controllers/error_trap_controller.rb'
-    - 'app/controllers/hsts_controller.rb'
-    - 'spec/lib/util_spec.rb'
-
-Rails:
-  Enabled: true
-
-require:
-  - rubocop-rspec
-
-Bundler/OrderedGems:
-  Enabled: false
-
-Lint/HandleExceptions:
-  Exclude:
-    - spec/**/*
-
-Lint/UriEscapeUnescape:
-  Enabled: false
-
-Style/RescueStandardError:
-  Enabled: false
-
-Metrics/LineLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Enabled: false
-
-Metrics/BlockNesting:
-  Enabled: false
-
-Performance/StringReplacement:
-  Enabled: false
-
-Performance/TimesMap:
-  Enabled: false
-
-Performance/RedundantBlockCall:
-  Enabled: false
-
-Performance/RedundantMatch:
-  Enabled: false
-
-Performance/RedundantMerge:
-  Enabled: false
-
-Performance/Casecmp:
-  Enabled: false
-
-Layout/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
-Layout/DotPosition:
-  EnforcedStyle: leading
-
-Layout/AlignParameters:
-  Enabled: false
-
-Layout/EmptyLinesAroundClassBody:
-  Enabled: false
-
-Layout/IndentArray:
-  EnforcedStyle: consistent
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-Layout/MultilineMethodCallBraceLayout:
-  EnforcedStyle: symmetrical
-
-Layout/EmptyLinesAroundBlockBody:
-  EnforcedStyle: no_empty_lines
-
-Layout/IndentHeredoc:
-  Enabled: false
-
-Layout/MultilineArrayBraceLayout:
-  EnforcedStyle: symmetrical
-
-Layout/MultilineHashBraceLayout:
-  EnforcedStyle: symmetrical
-
-Style/StringLiterals:
-  Enabled: false
-
-Style/RegexpLiteral:
-  Exclude:
-    - spec/**/*
-
-Style/NumericLiterals:
-  Enabled: false
-
-Style/WordArray:
-  Enabled: false
-
-Style/Next:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Style/GlobalVars:
-  Enabled: false
-
-Style/CommentAnnotation:
-  Enabled: false
-
-Style/SymbolProc:
-  Enabled: false
-
-Style/DoubleNegation:
-  Enabled: false
-
-Style/FormatString:
-  Enabled: false
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/BarePercentLiterals:
-  Enabled: false
-
-Style/SingleLineBlockParams:
-  Enabled: false
-
-Style/MultilineBlockChain:
-  Enabled: false
-
-Style/UnneededCapitalW:
-  Enabled: false
-
-Style/UnneededPercentQ:
-  Enabled: false
-
-Style/BlockDelimiters:
-  Exclude:
-    - spec/**/*
-
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/GuardClause:
-  Enabled: false
-
-Naming/AccessorMethodName:
-  Exclude:
-    - spec/support/pages/**/*
-
-Style/NegatedIf:
-  Enabled: false
-
-Style/MutableConstant:
-  Enabled: false
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Style/Lambda:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/SymbolArray:
-  Enabled: false
-
-Style/HashSyntax:
-  EnforcedStyle: ruby19
-
-Style/FormatStringToken:
-  Enabled: false
-
-Style/EmptyMethod:
-  EnforcedStyle: expanded
-
-Style/TernaryParentheses:
-  EnforcedStyle: require_parentheses_when_complex
-
-Naming/VariableNumber:
-  Enabled: false
-
-Style/PerlBackrefs:
-  Enabled: false
-
-Style/RegexpLiteral:
-  AllowInnerSlashes: false
-
-Style/BlockComments:
-  Enabled: false
-
-Style/RedundantParentheses:
-  Enabled: false
-
-Naming/FileName:
-  Exclude:
-    - Gemfile
-    - Brewfile
-    - Guardfile
-
-Style/NumericPredicate:
-  Enabled: false
-
-RSpec/DescribeClass:
-  Exclude:
-    - spec/views/**/*
-    - spec/routing/**/*
-    - spec/requests/**/*
-    - spec/features/**/*
-
-RSpec/FilePath:
-  Enabled: false
-
-RSpec/NamedSubject:
-  Enabled: false
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-RSpec/ExampleLength:
-  Enabled: false
-
-RSpec/HookArgument:
-  EnforcedStyle: implicit
-
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-
-RSpec/NestedGroups:
-  Enabled: false
-
-RSpec/VerifiedDoubles:
-  Enabled: false
-
-RSpec/LeadingSubject:
-  Enabled: false
-
-RSpec/ExpectInHook:
-  Enabled: false
-
-RSpec/ReturnFromStub:
-  Enabled: false
-
-RSpec/SubjectStub:
-  Enabled: false
-
-RSpec/EmptyLineAfterSubject:
-  Enabled: false
-
-RSpec/LetSetup:
-  Enabled: false
-
-RSpec/ImplicitExpect:
-  EnforcedStyle: is_expected
-
-RSpec/ScatteredLet:
-  Enabled: false
-
-RSpec/ContextWording:
-  Enabled: false
-
-Rails/Output:
-  Exclude:
-    - 'config/application.rb'
-    - 'config/initializers/asset_manifest_warning.rb'
-
-Rails/DynamicFindBy:
-  Enabled: false
-
-Rails/Presence:
-  Enabled: false
-
-Capybara/CurrentPathExpectation:
-  Enabled: false
-
-Naming/UncommunicativeMethodParamName:
-  Enabled: false
-
-Style/ExpandPathArguments:
-  Enabled: false