lhc 10.4.2 → 10.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1d081bbe01eadc3a60d41068a65bb5b5f5e8d8d44547e8c076b8e0e5f72307d
-  data.tar.gz: e0c41de69f16e1146aa28227a67cebd278a6f203439bdd737aff1d8247522d2f
+  metadata.gz: a016cff9475c03c337aa44f8688b1499e6ea983a63f3d23d65bf638668ad54d8
+  data.tar.gz: 061122763aef50722147734b3fe1985427a657b761da635dd3a3e91f82acff52
 SHA512:
-  metadata.gz: cfaafff18eea78de74559bc8d866be1d9bcc3666d69bd0ee9ed4eefc8da80b9a962a32e134dc1603299481ab1768f0f44f89b0154652ba2764faa9a08eb29e96
-  data.tar.gz: 74f4d0d051992fe02bdb31bafa8291b002466981430ad118b89fab189334ff6824864ead2021f86a0c967d7097e3809e75d1ad69e3e83d0f423099929e3b452a
+  metadata.gz: 27230061ee806b82ae5f566156460ff179d8b79089dd44fbe5ab493761edf4809165f7f69ff043a99f59a81eb123d603b1644d40116a2682cd4509d32dd6034a
+  data.tar.gz: 774fffe78afb5c755b17ec7c04740fd5681a130f4dbe074e19c926d7df863a7948ea6a5b23bc43124238fcb4133029f318547db94f3a5e862bcb8b9f915a7b40

data/README.md

@@ -862,6 +862,7 @@ options = {
     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
+    expires: { header: 'Rate-Limit-Reset' } # a hash pointing at the response header containing the timestamp when the quota will reset
   } 
 }
 

data/lhc.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-rails', '>= 3.0.0'
   s.add_development_dependency 'rubocop', '~> 0.57.1'
   s.add_development_dependency 'rubocop-rspec', '~> 1.26.0'
+  s.add_development_dependency 'timecop'
   s.add_development_dependency 'webmock'
 
   s.license = 'GPL-3'

data/lib/lhc/interceptors/throttle.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/duration'
+
 class LHC::Throttle < LHC::Interceptor
 
   class OutOfQuota < StandardError
@@ -24,7 +26,8 @@ class LHC::Throttle < LHC::Interceptor
     self.class.track ||= {}
     self.class.track[options.dig(:provider)] = {
       limit: limit(options: options[:limit], response: response),
-      remaining: remaining(options: options[:remaining], response: response)
+      remaining: remaining(options: options[:remaining], response: response),
+      expires: expires(options: options[:expires], response: response)
     }
   end
 
@@ -33,7 +36,8 @@ class LHC::Throttle < LHC::Interceptor
   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?
+    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]
@@ -58,4 +62,20 @@ class LHC::Throttle < LHC::Interceptor
       end
     end
   end
+
+  def expires(options:, response:)
+    @expires ||= begin
+      if options.is_a?(Hash) && options[:header] && response.headers.present?
+        convert_expires(response.headers[options[:header]]&.to_i)
+      else
+        convert_expires(options)
+      end
+    end
+  end
+
+  def convert_expires(value)
+    if value.is_a?(Integer)
+      Time.zone.at(value).to_datetime
+    end
+  end
 end

data/lib/lhc/version.rb

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

data/spec/interceptors/throttle/main_spec.rb

@@ -13,12 +13,14 @@ describe LHC::Throttle do
         track: true,
         limit: limit_options,
         remaining: { header: 'Rate-Limit-Remaining' },
+        expires: { header: 'Rate-Limit-Reset' },
         break: break_option
       }
     }
   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
@@ -28,7 +30,8 @@ describe LHC::Throttle do
       .to_return(
         headers: {
           'Rate-Limit-Limit' => limit,
-          'Rate-Limit-Remaining' => remaining
+          'Rate-Limit-Remaining' => remaining,
+          'Rate-Limit-Reset' => expires_in
         }
       )
   end
@@ -87,4 +90,17 @@ describe LHC::Throttle do
       end
     end
   end
+
+  context 'expires' do
+    let(:break_option) { '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')
+      Timecop.travel(Time.zone.now + 2.hours)
+      LHC.get('http://local.ch', options)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -3,5 +3,6 @@
 require 'pry'
 require 'webmock/rspec'
 require 'lhc'
+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: 10.4.2
+  version: 10.4.3
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-22 00:00:00.000000000 Z
+date: 2019-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.26.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: webmock
   requirement: !ruby/object:Gem::Requirement