dhc 1.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b22e30900912a713bfb89ff65a146da3ddba654aa02b9b0352fb857d2df9c33
-  data.tar.gz: 54958fd32986660a12ecd05fe2e73f74873dea1eaac303a6bee53b5050ebe321
+  metadata.gz: a8e0bb9f278c6894075dfd3004f3a639be1d5da7dd02df7b4e6d3f6169ee33ef
+  data.tar.gz: f3ee060e925fca3a629f8ca3c53e815c9c33bcb6dcbba75ff57651d1f57595e2
 SHA512:
-  metadata.gz: 3153ef2ea5a6602daedfb2d6264d40b3092d047e508c29ec4090e47b9372d820e7199e129acf5fa24468edc38903ed814f8e33acf2ff50f08c30a5c3890facab
-  data.tar.gz: 0b6753fa4e0792a533ec0667a1084e223f374008a1b999dd6e01e423f18e6e063e099aea321a80681c06ee9885a9d89e009ae737273ebd385e48c4de8a6b3561
+  metadata.gz: fbdd2700bd73f043a0d6aa4f37c2505255451be5fd6228df2013951df03f63c3dd964116bcf5a7c05a273a28025d06cab319aca08f19fa7339a7eb349e39c9a9
+  data.tar.gz: 99800e3225e33e433218698f075c492be9fa6f59d11c457a09ab3558eabbebb5ecb68b15ed796c2ffea6803cd02199f3d1ffda3d52717a8f0e543e56b55c6982

data/.github/workflows/rubocop.yml

@@ -8,20 +8,9 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@master
         with:
-          ruby-version: 2.7.2
-      - name: Cache Ruby Gems
-        uses: actions/cache@v2
-        with:
-          path: /.tmp/vendor/bundle
-          key: ${{ runner.os }}-gems-latest-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-latest-
-      - name: Bundle Install
-        run: |
-          bundle config path /.tmp/vendor/bundle
-          bundle install --jobs 4 --retry 3
+          bundler-cache: true
       - name: Run Rubocop
         run: |
           bundle exec rubocop

data/.github/workflows/test.yml

@@ -8,20 +8,9 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@master
         with:
-          ruby-version: 2.7.2
-      - name: Cache Ruby Gems
-        uses: actions/cache@v2
-        with:
-          path: /.tmp/vendor/bundle
-          key: ${{ runner.os }}-gems-latest-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-latest-
-      - name: Bundle Install
-        run: |
-          bundle config path /.tmp/vendor/bundle
-          bundle install --jobs 4 --retry 3
+          bundler-cache: true
       - name: Run Tests
         run: |
           bundle exec rspec

data/.rubocop.yml

@@ -62,6 +62,9 @@ Style/SingleArgumentDig:
 Metrics/ClassLength:
   Enabled: false
 
+Metrics/PerceivedComplexity:
+  Enabled: false
+
 Style/OptionalBooleanParameter:
   Enabled: false
 

data/README.md

@@ -854,6 +854,8 @@ If it raises, it forwards the request and response object to rollbar, which cont
 
 The throttle interceptor allows you to raise an exception if a predefined quota of a provider request limit is reached in advance.
 
+The throttle state (tracker) is stored in Rails.cache.
+
 ```ruby
   DHC.configure do |c|
     c.interceptors = [DHC::Throttle]
@@ -889,10 +891,33 @@ DHC.get('http://depay.fi', options)
 * `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
+  * not set: will track remaining by counting down limit until `expires`
 * `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
+  * an ActiveSupport::Duration e.g. 1.minute
+
+Example for throttling manually without relating to any information in the response:
 
+```ruby
+options = {
+  throttle: {
+    track: true,
+    break: '80%',
+    provider: 'depay.fi',
+    limit: 100,
+    expires: 1.minute
+  }
+}
+
+DHC.get('http://depay.fi', options)
+```
+
+Will reset every minute, and will allow up to 80 requests per minute. The 81st request attempt within a minute will raise:
+
+```ruby
+DHC::Throttle::OutOfQuota: Reached predefined quota for depay.fi
+```
 
 #### Zipkin
 
@@ -941,7 +966,7 @@ config.middleware.use ZipkinTracer::RackHandler, {
 
 #### Interceptor callbacks
 
-`before_raw_request` is called before the raw typhoeus request is prepared/created.
+`before_init` is called before the raw typhoeus request has been initialized.
 
 `before_request` is called when the request is prepared and about to be executed.
 

data/lib/dhc/error.rb

@@ -70,10 +70,7 @@ class DHC::Error < StandardError
 
     debug = []
     debug << [request.method, request.url].map { |str| self.class.fix_invalid_encoding(str) }.join(' ')
-    debug << "Options: #{request.options}"
-    debug << "Headers: #{request.headers}"
     debug << "Response Code: #{response.code} (#{response.options[:return_code]})"
-    debug << "Response Options: #{response.options}"
     debug << response.body
     debug << _message
 

data/lib/dhc/interceptor.rb

@@ -12,7 +12,7 @@ class DHC::Interceptor
     @request.response
   end
 
-  def before_raw_request; end
+  def before_init; end
 
   def before_request; end
 

data/lib/dhc/interceptors/auth.rb

@@ -4,7 +4,7 @@ class DHC::Auth < DHC::Interceptor
   include ActiveSupport::Configurable
   config_accessor :refresh_client_token
 
-  def before_raw_request
+  def before_init
     body_authentication! if auth_options[:body]
   end
 

data/lib/dhc/interceptors/default_timeout.rb

@@ -8,7 +8,7 @@ class DHC::DefaultTimeout < DHC::Interceptor
   CONNECTTIMEOUT = 2 # seconds
   TIMEOUT = 15 # seconds
 
-  def before_raw_request
+  def before_init
     request_options = (request.options || {})
     request_options[:timeout] ||= timeout || TIMEOUT
     request_options[:connecttimeout] ||= connecttimeout || CONNECTTIMEOUT

data/lib/dhc/interceptors/throttle.rb

@@ -6,80 +6,117 @@ class DHC::Throttle < DHC::Interceptor
   class OutOfQuota < StandardError
   end
 
+  CACHE_KEY = 'DHC/throttle/tracker/v1'
+
   class << self
-    attr_accessor :track
+
+    def tracker(provider)
+      (Rails.cache.read(CACHE_KEY) || {})[provider] || {}
+    end
+
+    def tracker=(track)
+      Rails.cache.write(CACHE_KEY, (Rails.cache.read(CACHE_KEY) || {}).merge({ track[:provider] => track }))
+    end
   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('%')
+    break! if break?
   end
 
   def after_response
-    options = response.request.options.dig(:throttle)
-    return unless throttle?(options)
-    self.class.track ||= {}
-    self.class.track[options.dig(:provider)] = {
-      limit: limit(options: options[:limit], response: response),
-      remaining: remaining(options: options[:remaining], response: response),
-      expires: expires(options: options[:expires], response: response)
+    return unless track?
+    self.class.tracker = {
+      provider: options.dig(:provider),
+      limit: limit,
+      remaining: remaining,
+      expires: expires
     }
   end
 
   private
 
-  def throttle?(options)
-    [options&.dig(:track), response.headers].none?(&:blank?)
+  def options
+    @options ||= request.options.dig(:throttle) || {}
+  end
+
+  def provider
+    @provider ||= request.options.dig(:throttle, :provider)
+  end
+
+  def track?
+    (options.dig(:remaining) && [options.dig(:track), response.headers].none?(&:blank?) ||
+      options.dig(:track).present?
+    )
+  end
+
+  def break?
+    @do_break ||= begin
+      return if options.dig(:break) && !options.dig(:break).match('%')
+      tracker = self.class.tracker(options[:provider])
+      return if tracker.blank? || tracker[:remaining].blank? || tracker[:limit].blank? || tracker[:expires].blank?
+      return if Time.zone.now > tracker[:expires]
+      remaining = tracker[:remaining] * 100
+      limit = tracker[:limit]
+      remaining_quota = 100 - options[:break].to_i
+      remaining < remaining_quota * limit
+    end
   end
 
-  def break_when_quota_reached!
-    options = request.options.dig(:throttle)
-    track = (self.class.track || {}).dig(options[:provider])
-    return if track.blank? || track[:remaining].blank? || track[:limit].blank? || track[:expires].blank?
-    return if Time.zone.now > track[:expires]
-    # 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
+  def break!
+    raise(OutOfQuota, "Reached predefined quota for #{provider}")
   end
 
-  def limit(options:, response:)
+  def limit
     @limit ||=
-      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
+      if options.dig(:limit).is_a?(Proc)
+        options.dig(:limit).call(response)
+      elsif options.dig(:limit).is_a?(Integer)
+        options.dig(:limit)
+      elsif options.dig(:limit).is_a?(Hash) && options.dig(:limit, :header) && response.headers
+        response.headers[options.dig(:limit, :header)]&.to_i
       end
   end
 
-  def remaining(options:, response:)
-    @remaining ||=
-      begin
-        if options.is_a?(Proc)
-          options.call(response)
-        elsif options.is_a?(Hash) && options[:header]
-          response.headers[options[:header]]&.to_i
+  def remaining
+    @remaining ||= begin
+      if options.dig(:remaining).is_a?(Proc)
+        options.dig(:remaining).call(response)
+      elsif options.dig(:remaining).is_a?(Hash) && options.dig(:remaining, :header) && response.headers
+        response.headers[options.dig(:remaining, :header)]&.to_i
+      elsif options.dig(:remaining).blank?
+        remaining_before = self.class.tracker(provider).dig(:remaining) || request.options.dig(:throttle, :limit)
+        expires = self.class.tracker(provider).dig(:expires)
+        if expires && expires > DateTime.now
+          remaining_before - 1
+        else
+          request.options.dig(:throttle, :limit) - 1
         end
       end
+    end
   end
 
-  def expires(options:, response:)
-    @expires ||= convert_expires(read_expire_option(options, response))
-  end
+  def expires
+    @expires ||= begin
+      if options.dig(:expires).is_a?(ActiveSupport::Duration) && self.class.tracker(provider).dig(:expires).present?
+        if self.class.tracker(provider)[:expires] > DateTime.now
+          self.class.tracker(provider)[:expires]
+        else
+          DateTime.now + options.dig(:expires)
+        end
+      elsif options.dig(:expires).is_a?(Hash) && options.dig(:expires, :header)
 
-  def read_expire_option(options, response)
-    (options.is_a?(Hash) && options[:header]) ? response.headers[options[:header]] : options
+        convert_expire_value(response.headers[options.dig(:expires, :header)]) if response.headers
+      else
+        convert_expire_value(options.dig(:expires))
+      end
+    end
   end
 
-  def convert_expires(value)
+  def convert_expire_value(value)
     return if value.blank?
     return value.call(response) if value.is_a?(Proc)
+    return DateTime.now + value if value.is_a?(ActiveSupport::Duration)
     return Time.parse(value) if value.match(/GMT/)
     Time.zone.at(value.to_i).to_datetime
   end

data/lib/dhc/request.rb

@@ -22,7 +22,7 @@ class DHC::Request
     use_configured_endpoint!
     generate_url_from_template!
     self.interceptors = DHC::Interceptors.new(self)
-    interceptors.intercept(:before_raw_request)
+    interceptors.intercept(:before_init)
     self.raw = create_request
     interceptors.intercept(:before_request)
     if self_executing && !response

data/lib/dhc/rspec.rb

@@ -6,6 +6,6 @@ RSpec.configure do |config|
   config.before(:each) do
     DHC::Caching.cache = ActiveSupport::Cache::MemoryStore.new
     DHC::Caching.cache.clear
-    DHC::Throttle.track = nil
+    Rails.cache.write(DHC::Throttle::CACHE_KEY, nil) if defined? Rails
   end
 end

data/lib/dhc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DHC
-  VERSION ||= '1.0.0'
+  VERSION ||= '2.1.1'
 end

data/spec/core_ext/hash/deep_transform_values_spec.rb

@@ -19,6 +19,6 @@ describe Hash do
   end
 
   it 'applies upcase to all values' do
-    expect(subject.deep_transform_values { |value| value.upcase }).to eq(expected_result)
+    expect(subject.deep_transform_values(&:upcase)).to eq(expected_result)
   end
 end

data/spec/error/to_s_spec.rb

@@ -72,10 +72,7 @@ describe DHC::Error do
       it 'produces correct debug output' do
         expect(subject.to_s.split("\n")).to eq(<<-MSG.strip_heredoc.split("\n"))
           GET http://example.com/sessions
-          Options: {:followlocation=>true, :auth=>{:bearer=>"aaaaaaaa-bbbb-cccc-dddd-eeee"}, :params=>{:limit=>20}, :url=>"http://example.com/sessions"}
-          Headers: {"Bearer Token"=>"aaaaaaaa-bbbb-cccc-dddd-eeee"}
           Response Code: 500 (internal_error)
-          Response Options: {:return_code=>:internal_error, :response_headers=>""}
           {"status":500,"message":"undefined"}
           The error message
         MSG

data/spec/interceptors/throttle/main_spec.rb

@@ -25,8 +25,8 @@ describe DHC::Throttle do
   end
 
   before(:each) do
-    DHC::Throttle.track = nil
     DHC.config.interceptors = [DHC::Throttle]
+    Rails.cache.write(DHC::Throttle::CACHE_KEY, nil)
 
     stub_request(:get, 'http://depay.fi').to_return(
       headers: { 'limit' => quota_limit, 'remaining' => quota_remaining, 'reset' => quota_reset }
@@ -35,8 +35,8 @@ describe DHC::Throttle do
 
   it 'tracks the request limits based on response data' do
     DHC.get('http://depay.fi', options)
-    expect(DHC::Throttle.track[provider][:limit]).to eq quota_limit
-    expect(DHC::Throttle.track[provider][:remaining]).to eq quota_remaining
+    expect(Rails.cache.read('DHC/throttle/tracker/v1')[provider][:limit]).to eq quota_limit
+    expect(Rails.cache.read('DHC/throttle/tracker/v1')[provider][:remaining]).to eq quota_remaining
   end
 
   context 'fix predefined integer for limit' do
@@ -44,7 +44,7 @@ describe DHC::Throttle do
 
     it 'tracks the limit based on initialy provided data' do
       DHC.get('http://depay.fi', options)
-      expect(DHC::Throttle.track[provider][:limit]).to eq options_limit
+      expect(Rails.cache.read('DHC/throttle/tracker/v1')[provider][:limit]).to eq options_limit
     end
   end
 

data/spec/interceptors/throttle/manually_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC::Throttle do
+  let(:options) do
+    {
+      throttle: {
+        provider: provider,
+        track: true,
+        limit: quota_limit,
+        expires: 1.minute,
+        break: break_after
+      }
+    }
+  end
+
+  let(:provider) { 'depay.fi' }
+  let(:quota_limit) { 100 }
+  let(:break_after) { '80%' }
+
+  before(:each) do
+    DHC.config.interceptors = [DHC::Throttle]
+    Rails.cache.write(DHC::Throttle::CACHE_KEY, nil)
+
+    stub_request(:get, 'http://depay.fi').to_return(status: 200)
+  end
+
+  it 'tracks the request limits based on response data' do
+    DHC.get('http://depay.fi', options)
+    expect(Rails.cache.read('DHC/throttle/tracker/v1')[provider][:limit]).to eq 100
+    expect(Rails.cache.read('DHC/throttle/tracker/v1')[provider][:remaining]).to eq quota_limit - 1
+  end
+
+  context 'breaks' do
+    let(:quota_limit) { 10 }
+    let(:break_after) { '79%' }
+
+    it 'hit the breaks if throttling quota is reached' do
+      8.times do
+        DHC.get('http://depay.fi', options)
+      end
+      expect { DHC.get('http://depay.fi', options) }.to raise_error(
+        DHC::Throttle::OutOfQuota,
+        'Reached predefined quota for depay.fi'
+      )
+    end
+
+    context 'still within quota' do
+      let(:break_after) { '80%' }
+
+      it 'does not hit the breaks' do
+        9.times do
+          DHC.get('http://depay.fi', options)
+        end
+      end
+    end
+  end
+
+  context 'expires' do
+    let(:break_after) { '80%' }
+    let(:quota_limit) { 10 }
+
+    it 'attempts another request if the quota expired' do
+      9.times do
+        DHC.get('http://depay.fi', options)
+      end
+      expect { DHC.get('http://depay.fi', options) }.to raise_error(
+        DHC::Throttle::OutOfQuota,
+        'Reached predefined quota for depay.fi'
+      )
+      Timecop.travel(Time.zone.now + 1.minute)
+      9.times do
+        DHC.get('http://depay.fi', options)
+      end
+      expect { DHC.get('http://depay.fi', options) }.to raise_error(
+        DHC::Throttle::OutOfQuota,
+        'Reached predefined quota for depay.fi'
+      )
+    end
+  end
+
+  context 'multiple provider' do
+
+    it 'tracks multiple providers without a problem' do
+      DHC.get('http://depay.fi', options)
+      stub_request(:get, 'http://depay.app').to_return(status: 200)
+      DHC.get('http://depay.app', {
+        throttle: {
+          provider: 'depay.app',
+          track: true,
+          limit: quota_limit,
+          expires: 1.minute,
+          break: break_after
+        }
+      })
+      expect(Rails.cache.read('DHC/throttle/tracker/v1')['depay.fi']).to be_present
+      expect(Rails.cache.read('DHC/throttle/tracker/v1')['depay.app']).to be_present
+    end
+  end
+end

data/spec/interceptors/throttle/reset_track_spec.rb

@@ -23,7 +23,6 @@ describe DHC::Throttle do
   let(:expires_in) { (Time.zone.now + 1.hour).to_i }
 
   before(:each) do
-    DHC::Throttle.track = nil
     DHC.config.interceptors = [DHC::Throttle]
 
     stub_request(:get, 'http://depay.fi')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhc
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - https://github.com/DePayFi/dhc/contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -338,6 +338,7 @@ files:
 - spec/interceptors/rollbar/invalid_encoding_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
 - spec/interceptors/throttle/main_spec.rb
+- spec/interceptors/throttle/manually_spec.rb
 - spec/interceptors/throttle/reset_track_spec.rb
 - spec/interceptors/zipkin/distributed_tracing_spec.rb
 - spec/rails_helper.rb
@@ -391,7 +392,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby >= 2.0.0
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Advanced HTTP Client for Ruby, fueled with interceptors
@@ -492,6 +493,7 @@ test_files:
 - spec/interceptors/rollbar/invalid_encoding_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
 - spec/interceptors/throttle/main_spec.rb
+- spec/interceptors/throttle/manually_spec.rb
 - spec/interceptors/throttle/reset_track_spec.rb
 - spec/interceptors/zipkin/distributed_tracing_spec.rb
 - spec/rails_helper.rb