dhc 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbcbbfbe466771c1ad389aebe29d997915137216b50b0aceff73f3cbc589f050
-  data.tar.gz: a659a0b022d803a700352d20fe96482731470b31234e8db9df3f665da5547ae7
+  metadata.gz: 674d43c54e6a69f47876b85ef1cc08fdd015002ac96f59fada268959d970d356
+  data.tar.gz: 1e9babbad39edeeedde2269d93108a2a0f604ff56cd7f66de5c960de68328bf8
 SHA512:
-  metadata.gz: 1851454238cb9552457a56c020edcb88b8b7e37eed6ebc0c6d1a8574c8250c520cfd48d8ca1e9f82ddcd334085daf1651fb0c31221ea638921aeb5873218846f
-  data.tar.gz: 4432965dcb69081d1d082cfc47101644a817f387d79213f57b8d2b80192901148e49b6a9ceb4ddb10c632e425385b30026de4c2bbbe69ffdaeefb5bf105c6bf5
+  metadata.gz: 2f29a2c073127d45a6fcd88fab98b8b82b27f3e64aa40a71eab788af580d972d0df7d2dba16e7ba528a28e21a59bf44bfb7d15a93f13bacfd03b1e6d7a0bf78b
+  data.tar.gz: 42aadb278b925b63b2c947616ae7c1c6f6d1c7b54487287303c8b3c0b59b54ed0f7b45de501615b8ab854bd73d9e125218ac7c8c205b033566ada8747766ae06

data/README.md

@@ -471,6 +471,27 @@ Adds the following header to the request:
 
 Assuming the method `access_token` responds on runtime of the request with `123456`.
 
+###### Refresh Bearer Authentication
+
+If you configure `expires_at` and `refresh` proc in addition to `bearer`, DHC will refresh the bearer token using the defined `refresh` proc in two cases:
+
+1. before the request if `expires_at` < `DateTime.now + 1.minute`
+2. if the request fails and `refresh(response)` responds to true
+
+```ruby
+refresh = ->(response = nil){
+  if response
+    if response.code == 401 && response.data && response.data.error_code == 'ACCESS_TOKEN_EXPIRED'
+      session[:access_token] = new_access_token
+    end
+  else
+    session[:access_token] = new_access_token
+  end
+}
+
+DHC.get('http://depay.fi', auth: { bearer: -> { session[:access_token] }, refresh: refresh, expires_at: DateTime.now + 1.day })
+```
+
 ##### Basic Authentication
 
 ```ruby

data/lib/dhc/interceptors/auth.rb

@@ -6,6 +6,7 @@ class DHC::Auth < DHC::Interceptor
 
   def before_init
     body_authentication! if auth_options[:body]
+    auth_options[:refresh].call if refresh_bearer?
   end
 
   def before_request
@@ -14,13 +15,23 @@ class DHC::Auth < DHC::Interceptor
   end
 
   def after_response
-    return unless configuration_correct?
-    return unless reauthenticate?
-    reauthenticate!
+    reauthenticate! if configuration_correct? && reauthenticate?
+    retry_with_refreshed_token! if retry_with_refreshed_token?
   end
 
   private
 
+  def refresh_bearer?
+    auth_options[:bearer] &&
+      auth_options[:refresh].is_a?(Proc) &&
+      bearer_expired?(auth_options[:expires_at])
+  end
+
+  def bearer_expired?(expires_at)
+    expires_at = DateTime.parse(expires_at) if expires_at.is_a?(String)
+    expires_at < DateTime.now + 1.minute
+  end
+
   def body_authentication!
     auth = auth_options[:body]
     request.options[:body] = (request.options[:body] || {}).merge(auth)
@@ -65,6 +76,19 @@ class DHC::Auth < DHC::Interceptor
       DHC::Error.find(response) == DHC::Unauthorized
   end
 
+  def retry_with_refreshed_token!
+    bearer_authentication!
+    new_options = request.options.dup
+    new_options = new_options.merge(retry: { max: 1 })
+    request.options = new_options
+  end
+
+  def retry_with_refreshed_token?
+    auth_options[:bearer] &&
+      auth_options[:refresh].is_a?(Proc) &&
+      auth_options[:refresh].call(response)
+  end
+
   def bearer_header_present?
     @has_bearer_header ||= request.headers['Authorization'] =~ /^Bearer .+$/i
   end

data/lib/dhc/interceptors/rollbar.rb

@@ -28,7 +28,7 @@ class DHC::Rollbar < DHC::Interceptor
     }.merge additional_params
     begin
       Rollbar.warning("Status: #{response.code} URL: #{request.url}", data)
-    rescue Encoding::UndefinedConversionError
+    rescue JSON::GeneratorError
       sanitized_data = data.deep_transform_values { |value| self.class.fix_invalid_encoding(value) }
       Rollbar.warning("Status: #{response.code} URL: #{request.url}", sanitized_data)
     end

data/lib/dhc/interceptors/throttle.rb

@@ -59,7 +59,7 @@ class DHC::Throttle < DHC::Interceptor
       remaining = tracker[:remaining] * 100
       limit = tracker[:limit]
       remaining_quota = 100 - options[:break].to_i
-      remaining < remaining_quota * limit
+      remaining <= remaining_quota * limit
     end
   end
 

data/lib/dhc/version.rb

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

data/spec/error/to_s_spec.rb

@@ -15,7 +15,7 @@ describe DHC::Error do
         expect { "#{valid} #{invalid}" }.to raise_error Encoding::CompatibilityError
       end
       it 'to_json on an array raises an error' do
-        expect { [valid, invalid].to_json }.to raise_error Encoding::UndefinedConversionError
+        expect { [valid, invalid].to_json }.to raise_error JSON::GeneratorError
       end
 
       it 'to_s on a hash does not raise an error' do
@@ -23,7 +23,7 @@ describe DHC::Error do
       end
 
       it 'to_json on a hash does raise an error' do
-        expect { { valid: valid, invalid: invalid }.to_json }.to raise_error Encoding::UndefinedConversionError
+        expect { { valid: valid, invalid: invalid }.to_json }.to raise_error JSON::GeneratorError
       end
     end
 

data/spec/interceptors/auth/bearer_spec.rb

@@ -3,17 +3,61 @@
 require 'rails_helper'
 
 describe DHC::Auth do
-  before(:each) do
-    DHC.config.interceptors = [DHC::Auth]
+  context 'simple bearer token authentication' do
+    before(:each) do
+      DHC.config.interceptors = [DHC::Auth]
+    end
+
+    it 'adds the bearer token to every request' do
+      def bearer_token
+        '123456'
+      end
+      options = { bearer: -> { bearer_token } }
+      DHC.config.endpoint(:local, 'http://depay.fi', auth: options)
+      stub_request(:get, 'http://depay.fi').with(headers: { 'Authorization' => 'Bearer 123456' })
+      DHC.get(:local)
+    end
   end
 
-  it 'adds the bearer token to every request' do
-    def bearer_token
-      '123456'
+  context 'refresh' do
+    before(:each) do
+      DHC.config.interceptors = [DHC::Auth, DHC::Retry]
+    end
+
+    let(:first_access_token) { '1_ACCESS_TOKEN' }
+    let(:second_access_token) { '2_ACCESS_TOKEN' }
+    let(:third_access_token) { '3_ACCESS_TOKEN' }
+
+    let :session do
+      {
+        access_token: first_access_token
+      }
+    end
+
+    refresh = -> {}
+
+    before do
+      refresh = ->(response = nil) {
+        if response
+          if response.code == 401 && response.data && response.data.error_code == 'ACCESS_TOKEN_EXPIRED'
+            session[:access_token] = third_access_token
+          end
+        else
+          session[:access_token] = second_access_token
+        end
+      }
+    end
+
+    it 'refreshes the bearer if it expired' do
+      stub_request(:get, 'http://depay.fi/').with(headers: { 'Authorization' => 'Bearer 2_ACCESS_TOKEN' })
+      DHC.get('http://depay.fi', auth: { bearer: -> { session[:access_token] }, refresh: refresh, expires_at: (DateTime.now - 1.minute).to_s })
+    end
+
+    it 'can evaluate response errors (like unauthorized) inside the refresh proc' do
+      stub_request(:get, 'http://depay.fi/').with(headers: { 'Authorization' => 'Bearer 2_ACCESS_TOKEN' })
+        .to_return(status: 401, body: { "error_code": 'ACCESS_TOKEN_EXPIRED' }.to_json)
+      stub_request(:get, 'http://depay.fi/').with(headers: { 'Authorization' => 'Bearer 3_ACCESS_TOKEN' })
+      DHC.get('http://depay.fi', auth: { bearer: -> { session[:access_token] }, refresh: refresh, expires_at: (DateTime.now - 1.minute).to_s })
     end
-    options = { bearer: -> { bearer_token } }
-    DHC.config.endpoint(:local, 'http://depay.fi', auth: options)
-    stub_request(:get, 'http://depay.fi').with(headers: { 'Authorization' => 'Bearer 123456' })
-    DHC.get(:local)
   end
 end

data/spec/interceptors/rollbar/invalid_encoding_spec.rb

@@ -14,7 +14,7 @@ describe DHC::Rollbar do
       class Rollbar; end
       ::Rollbar.stub(:warning) do
         call_counter += 1
-        raise Encoding::UndefinedConversionError if call_counter == 1
+        raise JSON::GeneratorError if call_counter == 1
       end
 
       # the response for the caller is still DHC::BadRequest
@@ -24,7 +24,7 @@ describe DHC::Rollbar do
     let(:invalid) { (+"in\xc3lid").force_encoding('ASCII-8BIT') }
     let(:valid) { described_class.fix_invalid_encoding(invalid) }
 
-    it 'calls fix_invalid_encoding incase a Encoding::UndefinedConversionError was encountered' do
+    it 'calls fix_invalid_encoding incase a JSON::GeneratorError was encountered' do
       expect(described_class).to have_received(:fix_invalid_encoding).with(invalid)
     end
 

data/spec/interceptors/throttle/manually_spec.rb

@@ -33,11 +33,11 @@ describe DHC::Throttle do
   end
 
   context 'breaks' do
-    let(:quota_limit) { 10 }
+    let(:quota_limit) { 100 }
     let(:break_after) { '79%' }
 
     it 'hit the breaks if throttling quota is reached' do
-      8.times do
+      79.times do
         DHC.get('http://depay.fi', options)
       end
       expect { DHC.get('http://depay.fi', options) }.to raise_error(
@@ -50,19 +50,29 @@ describe DHC::Throttle do
       let(:break_after) { '80%' }
 
       it 'does not hit the breaks' do
-        9.times do
+        80.times do
           DHC.get('http://depay.fi', options)
         end
       end
+
+      it 'does hit the breaks surpassing quota' do
+        80.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
   end
 
   context 'expires' do
     let(:break_after) { '80%' }
-    let(:quota_limit) { 10 }
+    let(:quota_limit) { 100 }
 
     it 'attempts another request if the quota expired' do
-      9.times do
+      80.times do
         DHC.get('http://depay.fi', options)
       end
       expect { DHC.get('http://depay.fi', options) }.to raise_error(
@@ -70,7 +80,7 @@ describe DHC::Throttle do
         'Reached predefined quota for depay.fi'
       )
       Timecop.travel(Time.zone.now + 1.minute)
-      9.times do
+      80.times do
         DHC.get('http://depay.fi', options)
       end
       expect { DHC.get('http://depay.fi', options) }.to raise_error(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhc
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - https://github.com/DePayFi/dhc/contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+date: 2023-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -399,7 +399,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby >= 2.0.0
-rubygems_version: 3.2.22
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Advanced HTTP Client for Ruby, fueled with interceptors