lhc 12.1.3 → 13.1.0

data/spec/interceptors/response_competition_spec.rb

@@ -12,7 +12,7 @@ describe LHC do
 
         def before_request
           if @@cached
-            return LHC::Response.new(Typhoeus::Response.new(response_body: 'Im served from local cache'), nil)
+            return LHC::Response.new(Typhoeus::Response.new(response_code: 200, return_code: :ok, response_body: 'Im served from local cache'), nil)
           end
         end
       end
@@ -22,7 +22,7 @@ describe LHC do
 
         def before_request
           if request.response.nil?
-            return LHC::Response.new(Typhoeus::Response.new(response_body: 'Im served from remote cache'), nil)
+            return LHC::Response.new(Typhoeus::Response.new(response_code: 200, return_code: :ok, response_body: 'Im served from remote cache'), nil)
           end
         end
       end

data/spec/interceptors/return_response_spec.rb

@@ -8,7 +8,7 @@ describe LHC do
       class CacheInterceptor < LHC::Interceptor
 
         def before_request
-          LHC::Response.new(Typhoeus::Response.new(response_body: 'Im served from cache'), nil)
+          LHC::Response.new(Typhoeus::Response.new(response_code: 200, return_code: :ok, response_body: 'Im served from cache'), nil)
         end
       end
       LHC.configure { |c| c.interceptors = [CacheInterceptor] }
@@ -23,7 +23,7 @@ describe LHC do
       before(:each) do
         class AnotherInterceptor < LHC::Interceptor
           def before_request
-            LHC::Response.new(Typhoeus::Response.new({}), nil)
+            LHC::Response.new(Typhoeus::Response.new(response_code: 200, return_code: :ok), nil)
           end
         end
       end

data/spec/interceptors/throttle/main_spec.rb

@@ -3,66 +3,64 @@
 require 'rails_helper'
 
 describe LHC::Throttle do
+  let(:options_break) { false }
+  let(:options_expires) { { header: 'reset' } }
+  let(:options_limit) { { header: 'limit' } }
+  let(:options_remaining) { { header: 'remaining' } }
   let(:provider) { 'local.ch' }
-  let(:limit) { 10000 }
-  let(:remaining) { 1900 }
+  let(:quota_limit) { 10_000 }
+  let(:quota_remaining) { 1900 }
+  let(:quota_reset) { (Time.zone.now + 1.hour).to_i }
   let(:options) do
     {
       throttle: {
         provider: provider,
         track: true,
-        limit: limit_options,
-        remaining: { header: 'Rate-Limit-Remaining' },
-        expires: { header: 'Rate-Limit-Reset' },
-        break: break_option
+        limit: options_limit,
+        remaining: options_remaining,
+        expires: options_expires,
+        break: options_break
       }
     }
   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
-        }
-      )
+    stub_request(:get, 'http://local.ch').to_return(
+      headers: { 'limit' => quota_limit, 'remaining' => quota_remaining, 'reset' => quota_reset }
+    )
   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
+    expect(LHC::Throttle.track[provider][:limit]).to eq quota_limit
+    expect(LHC::Throttle.track[provider][:remaining]).to eq quota_remaining
   end
 
   context 'fix predefined integer for limit' do
-    let(:limit_options) { 1000 }
+    let(:options_limit) { 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
+      expect(LHC::Throttle.track[provider][:limit]).to eq options_limit
     end
   end
 
   context 'breaks' do
-    let(:break_option) { '80%' }
+    let(:options_break) { '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')
+      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%' }
+      let(:options_break) { '90%' }
 
       it 'does not hit the breaks' do
         LHC.get('http://local.ch', options)
@@ -72,17 +70,14 @@ describe LHC::Throttle do
   end
 
   context 'no response headers' do
-    before do
-      stub_request(:get, 'http://local.ch')
-        .to_return(status: 200)
-    end
+    before { stub_request(:get, 'http://local.ch').to_return(status: 200) }
 
     it 'does not raise an exception' do
       LHC.get('http://local.ch', options)
     end
 
     context 'no remaining tracked, but break enabled' do
-      let(:break_option) { '90%' }
+      let(:options_break) { '90%' }
 
       it 'does not fail if a remaining was not tracked yet' do
         LHC.get('http://local.ch', options)
@@ -92,15 +87,150 @@ describe LHC::Throttle do
   end
 
   context 'expires' do
-    let(:break_option) { '80%' }
+    let(:options_break) { '80%' }
 
     it 'attempts another request if the quota expired' 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')
+      expect { LHC.get('http://local.ch', options) }.to raise_error(
+        LHC::Throttle::OutOfQuota,
+        'Reached predefined quota for local.ch'
+      )
       Timecop.travel(Time.zone.now + 2.hours)
       LHC.get('http://local.ch', options)
     end
   end
+
+  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
+
+    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
+
+    describe 'calculate "reset" in proc' do
+      let(:options_expires) { ->(*) { Time.zone.now + 1.second } }
+
+      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 '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
+  end
+
+  describe 'parsing reset time given in prose' do
+    let(:quota_reset) { (Time.zone.now + 1.day).strftime('%A, %B %d, %Y 12:00:00 AM GMT').to_s }
+
+    before { LHC.get('http://local.ch', options) }
+
+    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 'when value is empty' do
+    let(:quota_reset) { nil }
+
+    before do
+      stub_request(:get, 'http://local.ch').to_return(
+        headers: { 'limit' => quota_limit, 'remaining' => quota_remaining }
+      )
+      LHC.get('http://local.ch', options)
+    end
+
+    it 'still runs' do
+      LHC.get('http://local.ch', options)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@
 require 'pry'
 require 'webmock/rspec'
 require 'lhc'
+require 'lhc/rspec'
 require 'timecop'
 
 Dir[File.join(__dir__, "support/**/*.rb")].each { |f| require f }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 12.1.3
+  version: 13.1.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +207,6 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
-- Gemfile.activesupport4
 - Gemfile.activesupport5
 - Gemfile.activesupport6
 - LICENSE
@@ -203,7 +216,6 @@ files:
 - cider-ci/bin/bundle
 - cider-ci/bin/ruby_install
 - cider-ci/bin/ruby_version
-- cider-ci/jobs/rspec-activesupport-4.yml
 - cider-ci/jobs/rspec-activesupport-5.yml
 - cider-ci/jobs/rspec-activesupport-6.yml
 - cider-ci/jobs/rubocop.yml
@@ -335,6 +347,7 @@ files:
 - spec/interceptors/caching/hydra_spec.rb
 - spec/interceptors/caching/main_spec.rb
 - spec/interceptors/caching/methods_spec.rb
+- spec/interceptors/caching/multilevel_cache_spec.rb
 - spec/interceptors/caching/options_spec.rb
 - spec/interceptors/caching/parameters_spec.rb
 - spec/interceptors/caching/response_status_spec.rb
@@ -344,6 +357,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
@@ -488,6 +502,7 @@ test_files:
 - spec/interceptors/caching/hydra_spec.rb
 - spec/interceptors/caching/main_spec.rb
 - spec/interceptors/caching/methods_spec.rb
+- spec/interceptors/caching/multilevel_cache_spec.rb
 - spec/interceptors/caching/options_spec.rb
 - spec/interceptors/caching/parameters_spec.rb
 - spec/interceptors/caching/response_status_spec.rb
@@ -497,6 +512,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

data/Gemfile.activesupport4

@@ -1,4 +0,0 @@
-source 'https://rubygems.org/'
-
-gemspec
-gem 'activesupport', '~> 4.2.11'

data/cider-ci/jobs/rspec-activesupport-4.yml

@@ -1,28 +0,0 @@
-rspec-active-support-v4:
-  name: 'rspec with ActiveSupport v4'
-
-  run_when:
-    'some HEAD has been updated':
-      type: branch
-      include_match: ^.*$
-
-  context:
-
-    script_defaults:
-      template_environment_variables: true
-
-    task_defaults:
-      environment_variables:
-        ACTIVESUPPORT: '4'
-        BUNDLER: '_1.17.3_'
-
-      max_trials: 2
-      dispatch_storm_delay_duration: 1 Seconds
-      include:
-        - cider-ci/task_components/ruby.yml
-        - cider-ci/task_components/bundle.yml
-        - cider-ci/task_components/rspec.yml
-
-    tasks:
-      all-rspec:
-        name: All rspec tests, using ActiveSupport v4