zaikio-oauth_client 0.18.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f6d99b08d0e3fc512ce6a4bf8184be7c7d95144f3798062756f8f8159f86655
-  data.tar.gz: 4ed2286c417bdac976e6ad1f26c4ec84fc8d18b52312b082fd548800edfbec9b
+  metadata.gz: fd5390d254c886ad8c082def82463c6653bdb91b4f08433bf138b872e9fb54ff
+  data.tar.gz: b9bca34becf29861bd4e5f57d88492a9dfb7aecb8ad6ed2306c2007ee75740e5
 SHA512:
-  metadata.gz: fb66005f53cbb480678247a36aa77af00c32fb93cdf4ca9615aa3bf51efa82e83e60fdf4f61d68123e331a369451db548b40a8cc0f8e57cec3d6cd686872918f
-  data.tar.gz: 63e5d71e4025046ef18c1759d582262f319581a8462092026b7f21e19640250ce94f6caefe5a6365e823c910eb4d8a390cb3a65a328a579739b06387e2732141
+  metadata.gz: 61f6e1657014daa3b0cc5efb2e5a0ac97c0d81708d68ad7a98b030e24ce5fd2e3918c2613371dc7f9ed64f5546dad84e8f189e996fe1db113a5a295137cba74c
+  data.tar.gz: 38e9e845d6bae276a28ef32d6fab275ae0539598c1f7c85680ba87554e3ac0f5619261cb9346435b787c06526d0a87ca2ddfbb502a299027d1b81ea75bc424af

data/README.md

@@ -145,12 +145,19 @@ redirect_to zaikio_oauth_client.new_subscription_path(plan: "free")
 
 #### Session handling
 
-The Zaikio gem engine will set a cookie for the user after a successful OAuth flow: `session[:zaikio_person_id]`.
+The Zaikio gem engine will set a cookie for the access token after a successful OAuth flow: `session[:zaikio_access_token_id]`.
 
 If you are using for example `Zaikio::Hub::Models`, you can use this snippet to set the current user:
 
 ```ruby
-Current.user ||= Zaikio::Hub::Models::Person.find_by(id: session[:zaikio_person_id])
+access_token = Zaikio::OAuthClient.find_active_access_token(session[:zaikio_access_token_id])
+session[:zaikio_access_token_id] = access_token&.id
+Current.user = Zaikio::Hub::Models::Person.find_by(id: access_token&.bearer_id)
+
+unless Current.user
+  session[:origin] = request.fullpath
+  redirect_to zaikio_oauth_client.new_session_path
+end
 ````
 
 You can then use `Current.user` anywhere.

data/app/models/zaikio/access_token.rb

@@ -9,7 +9,7 @@ module Zaikio
     encrypts :token
     encrypts :refresh_token
 
-    def self.build_from_access_token(access_token, requested_scopes: nil)
+    def self.build_from_access_token(access_token, requested_scopes: nil, include_refresh_token: true)
       payload = JWT.decode(access_token.token, nil, false).first rescue {} # rubocop:disable Style/RescueModifier
       scopes = access_token.params["scope"].split(",")
       new(
@@ -18,7 +18,7 @@ module Zaikio
         bearer_id: access_token.params["bearer"]["id"],
         audience: access_token.params["audiences"].first,
         token: access_token.token,
-        refresh_token: access_token.refresh_token,
+        refresh_token: (access_token.refresh_token if include_refresh_token),
         expires_at: Time.strptime(access_token.expires_at.to_s, "%s"),
         scopes: scopes,
         requested_scopes: requested_scopes || scopes
@@ -67,7 +67,7 @@ module Zaikio
     end
 
     def bearer_klass
-      return unless Zaikio.const_defined?("Hub::Models", false) # rubocop:disable Performance/StringIdentifierArgument
+      return unless Zaikio.const_defined?("Hub::Models", false)
 
       if Zaikio::Hub::Models.configuration.respond_to?(:"#{bearer_type.underscore}_class_name")
         Zaikio::Hub::Models.configuration.public_send(:"#{bearer_type.underscore}_class_name").constantize
@@ -95,5 +95,15 @@ module Zaikio
       destroy
       nil
     end
+
+    def revoke!
+      return unless Zaikio.const_defined?("Hub::RevokedAccessToken", false)
+
+      Zaikio::Hub.with_token(token) do
+        Zaikio::Hub::RevokedAccessToken.create
+      end
+    rescue Zaikio::ConnectionError => e
+      Zaikio::OAuthClient.configuration.logger.warn "Access Token #{id} could not be revoked: #{e.message}"
+    end
   end
 end

data/lib/zaikio/oauth_client/authenticatable.rb

@@ -55,13 +55,16 @@ module Zaikio
       end
 
       def destroy
-        access_token_id = session[:zaikio_access_token_id]
+        if (access_token = Zaikio::AccessToken.valid.or(Zaikio::AccessToken.valid_refresh)
+                                             .find_by(id: session[:zaikio_access_token_id]))
+          access_token.revoke!
+        end
         session.delete(:zaikio_access_token_id)
         session.delete(:origin)
 
         redirect_to send(
           respond_to?(:after_destroy_path_for) ? :after_destroy_path_for : :default_after_destroy_path_for,
-          access_token_id
+          access_token.id
         )
       end
 

data/lib/zaikio/oauth_client/test_helper.rb

@@ -3,6 +3,23 @@ module Zaikio
     module TestHelper
       extend ActiveSupport::Concern
 
+      VirtualAccessToken = Struct.new(:bearer_id, :bearer_type, :audience, :expired?, keyword_init: true)
+
+      class << self
+        def find_active_access_token(id)
+          return unless id.to_s.starts_with?("AT:")
+
+          _, audience, person_id = id.split(":")
+
+          VirtualAccessToken.new(
+            bearer_id: person_id,
+            audience: audience,
+            bearer_type: "Person",
+            expired?: false
+          )
+        end
+      end
+
       class TestSessionController < ActionController::Base # rubocop:disable Rails/ApplicationController
         def show
           if session[params[:key]].nil?
@@ -43,7 +60,15 @@ module Zaikio
         get "/zaikio/oauth_client/test_helper/session", params: { id: value, key: key }
       end
 
-      def logged_in_as(person)
+      def logged_in_as(person, access_token: nil, client_name: nil)
+        client_name ||= Zaikio::OAuthClient.client_name ||
+                        Zaikio::OAuthClient.configuration.all_client_names.first
+        set_session(
+          :zaikio_access_token_id,
+          access_token&.id || "AT:#{client_name}:#{person.id}"
+        )
+
+        # Deprecated please use zaikio_access_token_id
         set_session(:zaikio_person_id, person.id)
       end
     end

data/lib/zaikio/oauth_client/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module OAuthClient
-    VERSION = "0.18.0".freeze
+    VERSION = "0.19.1".freeze
   end
 end

data/lib/zaikio/oauth_client.rb

@@ -6,7 +6,7 @@ require "zaikio/oauth_client/configuration"
 require "zaikio/oauth_client/authenticatable"
 
 module Zaikio
-  module OAuthClient
+  module OAuthClient # rubocop:disable Metrics/ModuleLength
     class << self
       attr_reader :client_name
 
@@ -58,9 +58,8 @@ module Zaikio
         end
       end
 
-      # Finds the best possible access token, using the DB or an API call
-      #   * 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)
+      # Finds active access token, using the DB or Client Credentials flow
+      #   * It searches in the DB for an active access token
       #   * 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, valid_for: 30.seconds)
         client_config = client_config_for(client_name || self.client_name)
@@ -72,8 +71,6 @@ module Zaikio
                                          requested_scopes: scopes,
                                          valid_for: valid_for)
 
-        token = token.refresh! if token&.expired?
-
         token ||= fetch_new_token(client_config: client_config,
                                   bearer_type: bearer_type,
                                   bearer_id: bearer_id,
@@ -81,21 +78,36 @@ module Zaikio
         token
       end
 
-      # 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:, valid_for: 30.seconds)  # rubocop:disable Metrics/MethodLength
-        configuration.logger.debug "Try to fetch token for client_name: #{client_name}, "\
+      # This method can be used to find an active access token by id.
+      # It might refresh the access token to get an active one.
+      def find_active_access_token(id)
+        return unless id
+
+        if Rails.env.test?
+          access_token = TestHelper.find_active_access_token(id)
+          return access_token if access_token
+        end
+
+        access_token = Zaikio::AccessToken.find_by(id: id)
+        access_token = access_token.refresh! if access_token&.expired?
+
+        access_token
+      end
+
+      # Finds active access token with matching criteria for bearer and scopes.
+      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}"
 
         fetch_access_token = lambda {
           Zaikio::AccessToken
             .where(audience: client_name)
-            .usable(
+            .by_bearer(
               bearer_type: bearer_type,
               bearer_id: bearer_id,
-              requested_scopes: requested_scopes,
-              valid_until: valid_for.from_now
+              requested_scopes: requested_scopes
             )
+            .valid(valid_for.from_now)
             .first
         }
 
@@ -113,7 +125,10 @@ module Zaikio
             bearer_id: bearer_id,
             scopes: scopes
           ),
-          requested_scopes: scopes
+          requested_scopes: scopes,
+          include_refresh_token: false
+          # Do not store refresh token on client credentials flow
+          # https://docs.zaikio.com/changelog/2022-08-09_client-credentials-drop-refresh-token.html
         ).tap(&:save!)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-oauth_client
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.1
 platform: ruby
 authors:
 - Zaikio GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-26 00:00:00.000000000 Z
+date: 2022-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -89,7 +89,7 @@ dependencies:
         version: '0.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -99,7 +99,7 @@ dependencies:
         version: '0.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement