lhc 10.3.0 → 10.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a923e58a34351a5d61e64d0f3bcc7516bcbfc17d7f06d0ef6cc3af9531b91bcc
-  data.tar.gz: 96f10388992ef3687fa01a62ef0e99fc831f8fbe1ce15d8abc15e2eb39d78a30
+  metadata.gz: 818f5150c8583bd190bf11aab7edf82aa4c42072f2fdd12d93552086f6693d27
+  data.tar.gz: 9c2cf115d254de301d29b07f4d7a238506fa50878066355b25776498bde245ac
 SHA512:
-  metadata.gz: 3bb29402da0b779d8f485274defb9481fc78f0566f18bbbe3b3235ce4b214e1d936255d2293a0a9f7fc6c9694ca04458ec5ee927f53296aabcce5cf955f87def
-  data.tar.gz: 352657bdbc5d76f595ea5af072c794c02ecf64641f0c2fbcb2932948731ff7c5b11d26f75b03b03a3244b4bd60eb0417169f8a43951d5a90549e0541cced337f
+  metadata.gz: 6430c14afed05c3aa09e4e05b5347c45db01f95bc46a8cd0ed47987bffe92cff256b1f944c6aaacc4697f6a0ed994e9a73b1a2ee89f51c331e6b742ac8b44cef
+  data.tar.gz: 7a599bda71021fd43bcd7bc80712dd044d090268cbcfd31fc1d2f9feba9139dde906114d93e9c224c307a34e1ff73301cb0334eaf58c052a21b95ba339fdb8d5

data/README.md

@@ -845,6 +845,33 @@ If it raises, it forwards the request and response object to rollbar, which cont
   LHC.get('http://local.ch', rollbar: { tracking_key: 'this particular request' })
 ```
 
+#### Throttle
+
+The throttle interceptor allows you to raise an exception if a predefined quota of a provider request limit is reached in advance.
+
+```ruby
+  LHC.configure do |c|
+    c.interceptors = [LHC::Throttle]
+  end
+```
+```ruby
+options = { 
+  throttle: {
+    track: true, # enables tracking of current limit/remaining requests of rate-limiting
+    break: '80%', # 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: 'local.ch', # name of the provider under which throttling tracking is aggregated,
+    limit: { header: 'Rate-Limit-Limit' }, # either a hard-coded integer, or a hash pointing at the response header containing the limit value
+    remaining: { header: 'Rate-Limit-Remaining' }, # a hash pointing at the response header containing the current amount of remaining requests
+  } 
+}
+
+LHC.get('http://local.ch', options)
+# { headers: { 'Rate-Limit-Limit' => 100, 'Rate-Limit-Remaining' => 19 } }
+
+LHC.get('http://local.ch', options)
+# raises LHC::Throttle::OutOfQuota: Reached predefined quota for local.ch
+```
+
 #### Zipkin
 
 ** Zipkin 0.33 breaks our current implementation of the Zipkin interceptor **

data/friday.yml

@@ -0,0 +1,3 @@
+---
+  request_reviews: true
+  cleanup_stale_branches: 8.days

data/lib/lhc.rb

@@ -28,6 +28,8 @@ module LHC
     'lhc/interceptors/prometheus'
   autoload :Retry,
     'lhc/interceptors/retry'
+  autoload :Throttle,
+    'lhc/interceptors/throttle'
 
   autoload :Config,
     'lhc/config'

data/lib/lhc/interceptors/throttle.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+class LHC::Throttle < LHC::Interceptor
+
+  class OutOfQuota < StandardError
+  end
+
+  class << self
+    attr_accessor :track
+  end
+
+  def before_request
+    options = request.options.dig(:throttle)
+    return unless options
+    break_options = options.dig(:break)
+    return unless break_options
+    break_when_quota_reached! if break_options.match('%')
+  end
+
+  def after_response
+    options = response.request.options.dig(:throttle)
+    return unless options
+    return unless options.dig(:track)
+    self.class.track ||= {}
+    self.class.track[options.dig(:provider)] = {
+      limit: limit(options: options[:limit], response: response),
+      remaining: remaining(options: options[:remaining], response: response)
+    }
+  end
+
+  private
+
+  def break_when_quota_reached!
+    options = request.options.dig(:throttle)
+    track = (self.class.track || {}).dig(options[:provider])
+    return unless track
+    # avoid floats by multiplying with 100
+    remaining = track[:remaining] * 100
+    limit = track[:limit]
+    quota = 100 - options[:break].to_i
+    raise(OutOfQuota, "Reached predefined quota for #{options[:provider]}") if remaining < quota * limit
+  end
+
+  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
+    end
+  end
+
+  def remaining(options:, response:)
+    @remaining ||= begin
+      if options.is_a?(Hash) && options[:header]
+        response.headers[options[:header]]&.to_i
+      end
+    end
+  end
+end

data/lib/lhc/version.rb

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

data/spec/interceptors/throttle/main_spec.rb

@@ -0,0 +1,70 @@
+# 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' },
+        break: break_option
+      }
+    }
+  end
+  let(:limit_options) { { header: 'Rate-Limit-Limit' } }
+  let(:break_option) { false }
+
+  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
+        }
+      )
+  end
+
+  it 'tracks the request limits based on response data' do
+    LHC.get('http://local.ch', options)
+    expect(LHC::Throttle.track[provider][:limit]).to eq limit
+    expect(LHC::Throttle.track[provider][:remaining]).to eq remaining
+  end
+
+  context 'fix predefined integer for limit' do
+    let(:limit_options) { 1000 }
+
+    it 'tracks the limit based on initialy provided data' do
+      LHC.get('http://local.ch', options)
+      expect(LHC::Throttle.track[provider][:limit]).to eq limit_options
+    end
+  end
+
+  context 'breaks' do
+    let(:break_option) { '80%' }
+
+    it 'hit the breaks if throttling quota is reached' do
+      LHC.get('http://local.ch', options)
+      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(:break_option) { '90%' }
+
+      it 'does not hit the breaks' do
+        LHC.get('http://local.ch', options)
+        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: 10.3.0
+  version: 10.4.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-18 00:00:00.000000000 Z
+date: 2019-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -192,6 +192,7 @@ files:
 - cider-ci/task_components/rspec.yml
 - cider-ci/task_components/rubocop.yml
 - cider-ci/task_components/ruby.yml
+- friday.yml
 - lhc.gemspec
 - lib/lhc.rb
 - lib/lhc/concerns/lhc/basic_methods_concern.rb
@@ -221,6 +222,7 @@ files:
 - lib/lhc/interceptors/prometheus.rb
 - lib/lhc/interceptors/retry.rb
 - lib/lhc/interceptors/rollbar.rb
+- lib/lhc/interceptors/throttle.rb
 - lib/lhc/interceptors/zipkin.rb
 - lib/lhc/railtie.rb
 - lib/lhc/request.rb
@@ -319,6 +321,7 @@ files:
 - spec/interceptors/retry/main_spec.rb
 - spec/interceptors/return_response_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
+- spec/interceptors/throttle/main_spec.rb
 - spec/interceptors/zipkin/distributed_tracing_spec.rb
 - spec/rails_helper.rb
 - spec/request/body_spec.rb
@@ -371,7 +374,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby >= 2.0.0
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Advanced HTTP Client for Ruby, fueled with interceptors
@@ -463,6 +467,7 @@ test_files:
 - spec/interceptors/retry/main_spec.rb
 - spec/interceptors/return_response_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
+- spec/interceptors/throttle/main_spec.rb
 - spec/interceptors/zipkin/distributed_tracing_spec.rb
 - spec/rails_helper.rb
 - spec/request/body_spec.rb