zaikio-oauth_client 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ff245bb6a309f304b580e81ad30acc9a91916919697b2df717fdb884d3e4a25
-  data.tar.gz: c8db756a72615d02de42a58804e23b597f095e709506a6055008a8682cc72bbd
+  metadata.gz: fb0748eddd282729e6a9ca264b17a59d58b9822c5e900f1bc3690b2b10549567
+  data.tar.gz: 191d4f0652fa8dfb9dae28bbfcd550ef8b2114366ef41ad291f25620011e8d3e
 SHA512:
-  metadata.gz: 45d03fc98118ae5c283139628d0b8b9eaf1dd9a5ddcf22a02f1a57d8052365190907627831992976d8607329e404a021516403000b54ee072fbd9bc155bb9a89
-  data.tar.gz: 6ecae0a7e65289cad9c6691dcdaf3179694db40df26cedefe93cecaf7b16b999617f7931cbbc112116744e418b333c787b4b5e426baf6f6db0591ff6a399e6e7
+  metadata.gz: 21c66faa4cd6cad8b787b39f919b0e1c30ec718b912f5442ad0fd4c96b7871a0db798bdf84e798d3ddaf441f8ae96819abea31fad7b4a631b12d2983fef378be
+  data.tar.gz: acc5550981b27d38cb986e0b934d4dad992ea7f3c462d9dd1f6c202a304e4cd13bb8e202db070f66f458e3263606601943d1f078d9967125c89b068d82554126

data/README.md

@@ -266,6 +266,18 @@ Zaikio::OAuthClient.with_auth(bearer_type: "Organization", bearer_id: "fd61f5f5-
 end
 ```
 
+If you need the token for a certain period (e.g. a long-running job which makes many
+requests in sequence), you can specify the `valid_for` interval when requesting the token.
+By default, it won't return an access token which was due to expire in less than 30
+seconds from now. If there is an existing token, but it was due to expire before the end
+of the validity period, this will go and get a fresh token anyway:
+
+```rb
+Zaikio::OAuthClient.with_auth(..., valid_for: 10.minutes) do |access_token|
+  # ...
+end
+```
+
 ## Use of dummy app
 
 You can use the included dummy app as a showcase for the workflow and to adjust your own application. To set up the dummy application properly, go into `test/dummy` and use [puma-dev](https://github.com/puma/puma-dev) like this:

data/lib/zaikio/oauth_client.rb

@@ -62,7 +62,7 @@ module Zaikio
       #   * If the token has expired, it will be refreshed using the refresh_token flow
       #     (if this fails, we fallback to getting a new token using client_credentials)
       #   * If the token does not exist, we'll get a new one using the client_credentials flow
-      def get_access_token(bearer_id:, client_name: nil, bearer_type: "Person", scopes: nil)
+      def get_access_token(bearer_id:, client_name: nil, bearer_type: "Person", scopes: nil, valid_for: 30.seconds)
         client_config = client_config_for(client_name || self.client_name)
         scopes ||= client_config.default_scopes_for(bearer_type)
 
@@ -71,7 +71,7 @@ module Zaikio
                                          bearer_id: bearer_id,
                                          requested_scopes: scopes)
 
-        token = token.refresh! if token&.expired?
+        token = token.refresh! if token && (token.expired? || token.expires_at < valid_for.from_now)
 
         token ||= fetch_new_token(client_config: client_config,
                                   bearer_type: bearer_type,
@@ -84,7 +84,7 @@ module Zaikio
       # would require refreshing.
       def find_usable_access_token(client_name:, bearer_type:, bearer_id:, requested_scopes:)  # rubocop:disable Metrics/MethodLength
         configuration.logger.debug "Try to fetch token for client_name: #{client_name}, "\
-          "bearer #{bearer_type}/#{bearer_id}, requested_scopes: #{requested_scopes}"
+                                   "bearer #{bearer_type}/#{bearer_id}, requested_scopes: #{requested_scopes}"
 
         fetch_access_token = lambda {
           Zaikio::AccessToken

data/lib/zaikio/oauth_client/authenticatable.rb

@@ -81,7 +81,7 @@ module Zaikio
 
       def client_config
         client_config = Zaikio::OAuthClient.configuration.find!(client_name)
-        client_config = use_org_config? ? client_config.org_config : client_config
+        client_config = client_config.org_config if use_org_config?
 
         client_config or raise ActiveRecord::RecordNotFound
       end

data/lib/zaikio/oauth_client/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module OAuthClient
-    VERSION = "0.14.0".freeze
+    VERSION = "0.15.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-oauth_client
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Zaikio GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-18 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack