lhc 10.4.3 → 10.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a016cff9475c03c337aa44f8688b1499e6ea983a63f3d23d65bf638668ad54d8
-  data.tar.gz: 061122763aef50722147734b3fe1985427a657b761da635dd3a3e91f82acff52
+  metadata.gz: 3cf5537cde6885a7e37d2bb70d7b222e761804018d0aab94bd9249c68a40d3f7
+  data.tar.gz: 1d501413fd820cffc020cc39eec04b4e775440abebdf61e030f8d6114b660922
 SHA512:
-  metadata.gz: 27230061ee806b82ae5f566156460ff179d8b79089dd44fbe5ab493761edf4809165f7f69ff043a99f59a81eb123d603b1644d40116a2682cd4509d32dd6034a
-  data.tar.gz: 774fffe78afb5c755b17ec7c04740fd5681a130f4dbe074e19c926d7df863a7948ea6a5b23bc43124238fcb4133029f318547db94f3a5e862bcb8b9f915a7b40
+  metadata.gz: 5fc4d1cb8b374931d4c53d295319e6f3c16657e0bde1dd7aa0799812bbc378390165f097b7c6627ced47f92d2ebe7459d5180745a4b00692875fbdfffda2c931
+  data.tar.gz: d5d39be61013fe93e275d2725e7fc4cfec83f27646c36762a2c3fbe64d1c40aa9831f7274fb7a46a7ff1500244a19a8fe76b2887539cb0e2f435a438178ff21a

data/.rubocop.yml

@@ -56,3 +56,6 @@ RSpec/BeforeAfterAll:
 
 Style/EmptyMethod:
   EnforcedStyle: compact
+
+RSpec/RepeatedExample:
+  Enabled: false

data/README.md

@@ -67,7 +67,6 @@ use it like:
                * [Bearer Authentication with client access token](#bearer-authentication-with-client-access-token)
             * [Caching Interceptor](#caching-interceptor)
                * [Options](#options)
-               * [Testing](#testing)
             * [Default Timeout Interceptor](#default-timeout-interceptor)
                * [Overwrite defaults](#overwrite-defaults)
             * [Logging Interceptor](#logging-interceptor)
@@ -83,13 +82,16 @@ use it like:
             * [Retry Interceptor](#retry-interceptor)
                * [Limit the amount of retries while making the request](#limit-the-amount-of-retries-while-making-the-request)
                * [Change the default maximum of retries of the retry interceptor](#change-the-default-maximum-of-retries-of-the-retry-interceptor)
+               * [Retry all requests](#retry-all-requests)
             * [Rollbar Interceptor](#rollbar-interceptor)
                * [Forward additional parameters](#forward-additional-parameters)
+            * [Throttle](#throttle)
             * [Zipkin](#zipkin)
          * [Create an interceptor from scratch](#create-an-interceptor-from-scratch)
             * [Interceptor callbacks](#interceptor-callbacks)
             * [Interceptor request/response](#interceptor-requestresponse)
             * [Provide a response replacement through an interceptor](#provide-a-response-replacement-through-an-interceptor)
+      * [Testing](#testing)
       * [License](#license)
 
 ## Basic methods
@@ -629,16 +631,6 @@ To avoid that case the first process to find an expired cache entry will bump th
 
 `use` - Set an explicit cache to be used for this request. If this option is missing `LHC::Caching.cache` is used.
 
-##### Testing
-
-Add to your spec_helper.rb:
-
-```ruby
-  require 'lhc/test/cache_helper.rb'
-```
-
-This will initialize a MemoryStore cache for LHC::Caching interceptor and resets the cache before every test.
-
 #### Default Timeout Interceptor
 
 Applies default timeout values to all requests made in an application, that uses LHC.
@@ -963,6 +955,16 @@ You can access the request.response to identify if a response was already provid
   end
 ```
 
+## Testing
+
+When writing tests for your application when using LHC, please make sure you require the lhc rspec test helper:
+
+```ruby
+# spec/spec_helper.rb
+
+require 'lhc/rspec'
+```
+
 ## License
 
 [GNU General Public License Version 3.](https://www.gnu.org/licenses/gpl-3.0.en.html)

data/lib/lhc/rspec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'lhc'
+
+RSpec.configure do |config|
+  LHC::Caching.cache = ActiveSupport::Cache::MemoryStore.new
+
+  config.before(:each) do
+    LHC::Caching.cache.clear
+    LHC::Throttle.track = nil
+  end
+end

data/lib/lhc/test/cache_helper.rb

@@ -1,9 +1,3 @@
 # frozen_string_literal: true
 
-RSpec.configure do |config|
-  LHC::Caching.cache = ActiveSupport::Cache::MemoryStore.new
-
-  config.before(:each) do
-    LHC::Caching.cache.clear
-  end
-end
+warn("[WARNING] require 'lhc/test/cache_helper.rb' is not needed any more! Just require 'lhc/rspec' in your spec helper instead.")

data/lib/lhc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHC
-  VERSION ||= '10.4.3'
+  VERSION ||= '10.5.0'
 end

data/spec/interceptors/throttle/reset_track_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHC::Throttle do
+  let(:provider) { 'local.ch' }
+  let(:limit) { 10000 }
+  let(:remaining) { 1900 }
+  let(:options) do
+    {
+      throttle: {
+        provider: provider,
+        track: true,
+        limit: limit_options,
+        remaining: { header: 'Rate-Limit-Remaining' },
+        expires: { header: 'Rate-Limit-Reset' },
+        break: '80%'
+      }
+    }
+  end
+  let(:limit_options) { { header: 'Rate-Limit-Limit' } }
+  let(:break_option) { false }
+  let(:expires_in) { (Time.zone.now + 1.hour).to_i }
+
+  before(:each) do
+    LHC::Throttle.track = nil
+    LHC.config.interceptors = [LHC::Throttle]
+
+    stub_request(:get, 'http://local.ch')
+      .to_return(
+        headers: {
+          'Rate-Limit-Limit' => limit,
+          'Rate-Limit-Remaining' => remaining,
+          'Rate-Limit-Reset' => expires_in
+        }
+      )
+  end
+
+  # If LHC::Trottle.track would be kept accross multiple tests,
+  # at least 2/3 of the following would fail
+
+  it 'resets track accross multiple tests 1/3' do
+    LHC.get('http://local.ch', options)
+  end
+
+  it 'resets track accross multiple tests 2/3' do
+    LHC.get('http://local.ch', options)
+  end
+
+  it 'resets track accross multiple tests 3/3' do
+    LHC.get('http://local.ch', options)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 10.4.3
+  version: 10.5.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
@@ -245,6 +245,7 @@ files:
 - lib/lhc/response/data/base.rb
 - lib/lhc/response/data/collection.rb
 - lib/lhc/response/data/item.rb
+- lib/lhc/rspec.rb
 - lib/lhc/test/cache_helper.rb
 - lib/lhc/version.rb
 - script/ci/build.sh
@@ -336,6 +337,7 @@ files:
 - spec/interceptors/return_response_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
 - spec/interceptors/throttle/main_spec.rb
+- spec/interceptors/throttle/reset_track_spec.rb
 - spec/interceptors/zipkin/distributed_tracing_spec.rb
 - spec/rails_helper.rb
 - spec/request/body_spec.rb
@@ -482,6 +484,7 @@ test_files:
 - spec/interceptors/return_response_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
 - spec/interceptors/throttle/main_spec.rb
+- spec/interceptors/throttle/reset_track_spec.rb
 - spec/interceptors/zipkin/distributed_tracing_spec.rb
 - spec/rails_helper.rb
 - spec/request/body_spec.rb