lhc 12.2.1 → 12.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41b0c46c3ced081c73e722058eace5a163bb5f84516fb4c6a6d074800ade7d7d
-  data.tar.gz: e4f37fdf66fa76cc137ec6142bc445468a904f0cbaea2578850c6984478f4228
+  metadata.gz: edceeb5ec4bd94dd580a56ed8a0ed0a71a31a8bd5c0b1f08dc96c7f8614d42b3
+  data.tar.gz: 183c118e2861b420877c37dfc8f86643d8fd410f8c2abbb8d681cdd168956108
 SHA512:
-  metadata.gz: b94b128def1cea71f871c2a14787a52e1ca76755b849fb4504b044f99c9ce4d35ce5a89b8d54621f539f83d51dfa72047b2538adc33f8ab4713f030dcefd31db
-  data.tar.gz: e1354bbb77a671ef3d98ef33755ada6c4d32373f34609fc858c57744f4c4aed9543373ebf4f837d0ce4bc8c8f8962bcdef60cc2f0ed2045b1dac00f4139ce054
+  metadata.gz: 92bd31139ebf0bc508e0681c99c5f35b8b9c93b0a6f56fdf2fcdbfb1faa1c3fa80c2894d48ebc31ad8c4138af5df9548b3f65f87a33bb5ebbf5a873a8d696585
+  data.tar.gz: 5b4f2fee1a99c4823ad1d0231624d6bf62794bff60bc27379c180b676439b88f89242813a2b306e44dde1946985114fa1190b1e67a22befdc089f41af520f759

data/README.md

@@ -895,16 +895,22 @@ LHC.get('http://local.ch', options)
 LHC.get('http://local.ch', options)
 # raises LHC::Throttle::OutOfQuota: Reached predefined quota for local.ch
 ```
+
 **Options Description**
 * `track`: enables tracking of current limit/remaining requests of rate-limiting
 * `break`: quota in percent after which errors are raised. Percentage symbol is optional, values will be converted to integer (e.g. '23.5' will become 23)
 * `provider`: name of the provider under which throttling tracking is aggregated,
-* `limit`: either a hard-coded integer, or a hash pointing at the response header containing the limit value
+* `limit`:
+  * a hard-coded integer
+  * a hash pointing at the response header containing the limit value
+  * a proc that receives the response as argument and returns the limit value
 * `remaining`:
   * a hash pointing at the response header containing the current amount of remaining requests
-  * a proc that receives the response as argument and returns the current amount
-  of remaining requests
-* `expires`: a hash pointing at the response header containing the timestamp when the quota will reset
+  * a proc that receives the response as argument and returns the current amount of remaining requests
+* `expires`:
+  * a hash pointing at the response header containing the timestamp when the quota will reset
+  * a proc that receives the response as argument and returns the timestamp when the quota will reset
+
 
 #### Zipkin
 

data/lib/lhc/interceptors/throttle.rb

@@ -49,12 +49,12 @@ class LHC::Throttle < LHC::Interceptor
 
   def limit(options:, response:)
     @limit ||=
-      begin
-        if options.is_a?(Integer)
-          options
-        elsif options.is_a?(Hash) && options[:header]
-          response.headers[options[:header]]&.to_i
-        end
+      if options.is_a?(Proc)
+        options.call(response)
+      elsif options.is_a?(Integer)
+        options
+      elsif options.is_a?(Hash) && options[:header]
+        response.headers[options[:header]]&.to_i
       end
   end
 
@@ -79,6 +79,7 @@ class LHC::Throttle < LHC::Interceptor
 
   def convert_expires(value)
     return if value.blank?
+    return value.call(response) if value.is_a?(Proc)
     return Time.parse(value) if value.match(/GMT/)
     Time.zone.at(value.to_i).to_datetime
   end

data/lib/lhc/version.rb

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

data/spec/interceptors/throttle/main_spec.rb

@@ -100,34 +100,95 @@ describe LHC::Throttle do
     end
   end
 
-  describe 'calculate "remaining" in proc' do
-    let(:quota_current) { 8100 }
-    let(:options_remaining) do
-      ->(response) { (response.headers['limit']).to_i - (response.headers['current']).to_i }
+  describe 'configuration values as Procs' do
+    describe 'calculate "limit" in proc' do
+      let(:options_limit) do
+        ->(*) { 10_000 }
+      end
+
+      before(:each) do
+        LHC.get('http://local.ch', options)
+      end
+
+      context 'breaks' do
+        let(:options_break) { '80%' }
+
+        it 'hit the breaks if throttling quota is reached' do
+          expect { LHC.get('http://local.ch', options) }.to raise_error(
+            LHC::Throttle::OutOfQuota,
+            'Reached predefined quota for local.ch'
+          )
+        end
+
+        context 'still within quota' do
+          let(:options_break) { '90%' }
+
+          it 'does not hit the breaks' do
+            LHC.get('http://local.ch', options)
+          end
+        end
+      end
     end
 
-    before(:each) do
-      stub_request(:get, 'http://local.ch').to_return(
-        headers: { 'limit' => quota_limit, 'current' => quota_current, 'reset' => quota_reset }
-      )
-      LHC.get('http://local.ch', options)
+    describe 'calculate "remaining" in proc' do
+      let(:quota_current) { 8100 }
+      let(:options_remaining) do
+        ->(response) { (response.headers['limit']).to_i - (response.headers['current']).to_i }
+      end
+
+      before(:each) do
+        stub_request(:get, 'http://local.ch').to_return(
+          headers: { 'limit' => quota_limit, 'current' => quota_current, 'reset' => quota_reset }
+        )
+        LHC.get('http://local.ch', options)
+      end
+
+      context 'breaks' do
+        let(:options_break) { '80%' }
+
+        it 'hit the breaks if throttling quota is reached' do
+          expect { LHC.get('http://local.ch', options) }.to raise_error(
+            LHC::Throttle::OutOfQuota,
+            'Reached predefined quota for local.ch'
+          )
+        end
+
+        context 'still within quota' do
+          let(:options_break) { '90%' }
+
+          it 'does not hit the breaks' do
+            LHC.get('http://local.ch', options)
+          end
+        end
+      end
     end
 
-    context 'breaks' do
-      let(:options_break) { '80%' }
+    describe 'calculate "reset" in proc' do
+      let(:options_expires) { ->(*) { Time.zone.now + 1.second } }
 
-      it 'hit the breaks if throttling quota is reached' do
-        expect { LHC.get('http://local.ch', options) }.to raise_error(
-          LHC::Throttle::OutOfQuota,
-          'Reached predefined quota for local.ch'
+      before(:each) do
+        stub_request(:get, 'http://local.ch').to_return(
+          headers: { 'limit' => quota_limit, 'remaining' => quota_remaining }
         )
+        LHC.get('http://local.ch', options)
       end
 
-      context 'still within quota' do
-        let(:options_break) { '90%' }
+      context 'breaks' do
+        let(:options_break) { '80%' }
 
-        it 'does not hit the breaks' do
-          LHC.get('http://local.ch', options)
+        it 'hit the breaks if throttling quota is reached' do
+          expect { LHC.get('http://local.ch', options) }.to raise_error(
+            LHC::Throttle::OutOfQuota,
+            'Reached predefined quota for local.ch'
+          )
+        end
+
+        context 'still within quota' do
+          let(:options_break) { '90%' }
+
+          it 'does not hit the breaks' do
+            LHC.get('http://local.ch', options)
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 12.2.1
+  version: 12.3.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport