zaikio-oauth_client 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ff245bb6a309f304b580e81ad30acc9a91916919697b2df717fdb884d3e4a25
-  data.tar.gz: c8db756a72615d02de42a58804e23b597f095e709506a6055008a8682cc72bbd
+  metadata.gz: 959893e57238209160b6945a5044bbc82bdc862fb78cd69ba606356e376978a7
+  data.tar.gz: b73e404116786a133e3438a12ebdfc87548da89c3a581a66436a6d2c0ef63ebd
 SHA512:
-  metadata.gz: 45d03fc98118ae5c283139628d0b8b9eaf1dd9a5ddcf22a02f1a57d8052365190907627831992976d8607329e404a021516403000b54ee072fbd9bc155bb9a89
-  data.tar.gz: 6ecae0a7e65289cad9c6691dcdaf3179694db40df26cedefe93cecaf7b16b999617f7931cbbc112116744e418b333c787b4b5e426baf6f6db0591ff6a399e6e7
+  metadata.gz: 71c7597c63d0aa761754fae087a6dcbbca1c1ebcae034330d08bbcdf7dd837874901c5b343435005b97b033220609255903cbc0aae796ad7b88192c4d150fe36
+  data.tar.gz: 38f0f062bebf746c5e23341524d9bcf4b3b31f9a70c972b5afa7ded4f72c6ec5ec5d1d694e8515412e9118359f8f8ee6bcdc493c28e55b5716d1c7261371dc06

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/app/models/zaikio/access_token.rb

@@ -26,17 +26,17 @@ module Zaikio
     end
 
     # Scopes
-    scope :valid, lambda {
-      where("expires_at > :now", now: Time.current)
+    scope :valid, lambda { |valid_until = Time.current|
+      where("expires_at > :valid_until", valid_until: valid_until)
         .where.not(id: Zaikio::JWTAuth.revoked_token_ids)
     }
     scope :with_invalid_refresh_token, lambda {
       where("created_at <= ?", Time.current - Zaikio::AccessToken.refresh_token_valid_for)
     }
-    scope :valid_refresh, lambda {
-      where("expires_at <= :now AND created_at > :created_at_max",
-            now: Time.current,
-            created_at_max: Time.current - refresh_token_valid_for)
+    scope :valid_refresh, lambda { |valid_until = Time.current|
+      where("expires_at <= :valid_until AND created_at > :created_at_max",
+            valid_until: valid_until,
+            created_at_max: valid_until - refresh_token_valid_for)
         .where.not(refresh_token: nil)
         .where.not(id: Zaikio::JWTAuth.revoked_token_ids)
     }
@@ -44,9 +44,10 @@ module Zaikio
       where(bearer_type: bearer_type, bearer_id: bearer_id)
         .where("requested_scopes @> ARRAY[?]::varchar[]", requested_scopes)
     }
-    scope :usable, lambda { |options|
-      by_bearer(**options).valid.or(by_bearer(**options).valid_refresh)
-                          .order(expires_at: :desc)
+    scope :usable, lambda { |valid_until: Time.current, **options|
+      by_bearer(**options).valid(valid_until).or(
+        by_bearer(**options).valid_refresh
+      ).order(expires_at: :desc)
     }
 
     def expired?
@@ -72,6 +73,8 @@ module Zaikio
     end
 
     def refresh!
+      return unless refresh_token?
+
       Zaikio::OAuthClient.with_oauth_scheme(:basic_auth) do
         refreshed_token = OAuth2::AccessToken.from_hash(
           Zaikio::OAuthClient.for(audience),
@@ -80,16 +83,12 @@ module Zaikio
 
         destroy
 
-        self.class.build_from_access_token(
-          refreshed_token,
-          requested_scopes: requested_scopes
-        ).tap(&:save!)
+        self.class.build_from_access_token(refreshed_token, requested_scopes: requested_scopes).tap(&:save!)
       end
     rescue OAuth2::Error => e
       raise unless e.code == "invalid_grant"
 
       destroy
-
       nil
     end
   end

data/lib/zaikio/oauth_client/authenticatable.rb

@@ -4,7 +4,8 @@ module Zaikio
       extend ActiveSupport::Concern
 
       def new
-        opts = params.permit(:client_name, :show_signup, :prompt, :force_login, :state, :lang)
+        opts = params.permit(:client_name, :show_signup, :prompt, :prompt_email_confirmation,
+                             :force_login, :state, :lang)
         opts[:lang] ||= I18n.locale if defined?(I18n)
         client_name = opts.delete(:client_name)
         opts[:state] ||= session[:state] = SecureRandom.urlsafe_base64(32)
@@ -81,7 +82,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.16.0".freeze
   end
 end

data/lib/zaikio/oauth_client.rb

@@ -62,14 +62,15 @@ 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)
 
         token = find_usable_access_token(client_name: client_config.client_name,
                                          bearer_type: bearer_type,
                                          bearer_id: bearer_id,
-                                         requested_scopes: scopes)
+                                         requested_scopes: scopes,
+                                         valid_for: valid_for)
 
         token = token.refresh! if token&.expired?
 
@@ -82,9 +83,9 @@ module Zaikio
 
       # Finds the best usable access token. Note that this token may have expired and
       # would require refreshing.
-      def find_usable_access_token(client_name:, bearer_type:, bearer_id:, requested_scopes:)  # rubocop:disable Metrics/MethodLength
+      def find_usable_access_token(client_name:, bearer_type:, bearer_id:, requested_scopes:, valid_for: 30.seconds)  # 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
@@ -92,7 +93,8 @@ module Zaikio
             .usable(
               bearer_type: bearer_type,
               bearer_id: bearer_id,
-              requested_scopes: requested_scopes
+              requested_scopes: requested_scopes,
+              valid_until: valid_for.from_now
             )
             .first
         }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-oauth_client
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Zaikio GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-18 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Zaikio Platform Connectivity