keycloak_oauth 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baa20f03dc097cf9b5f18e60f1cd860e3590fa2eafe097989d39d1b29690dd57
-  data.tar.gz: 477b1887a6020aa95bd7e680bf1abe508ad90b99cc480606fdd5daec81adf210
+  metadata.gz: e85ec71ff01d0bd03e893244b477090209833ee1a6e07a83b170e027ecb9810f
+  data.tar.gz: fd42e9c706a5851edab87f54bc152a6e48be3f53191c6275c3cba7f3d226dfd2
 SHA512:
-  metadata.gz: a5b936cdf70211176742efcad5d1b799d6c72ecc1047c141e07c55ddb6c1b33985879d018616f30ab6ce7bb9b4e2be970977c4a1bcecb417bcf0ebd9e0787d68
-  data.tar.gz: 6f99f5fd86bff651312a0477ca719fb227ae1b5a960c9ebf066cb7e3a2d7a150f1d42a69c0df25efc6ccd78fd733ab220982e053e73202dfadf87d9268c8a1e5
+  metadata.gz: 849611286cae02a3b568093f5289e7ddc34b72ec655b2b33f738edd120705f88a5dd730a7eebe2f9f88819d6121077568f1f00ff881fbc1d5dbebd68bb37ffce
+  data.tar.gz: 9f2f4e363ebdfb495be49acaf0aeb124d5c4c2f8b2d7f86d147c1f439f2c5d428d11557e1adae7af48ab035325dbff8edad5fe9a7f144e6d961554d1e462637c

data/README.md

@@ -56,6 +56,20 @@ e.g.
 
 Once authentication is performed, the access and refresh tokens are stored in the session and can be used in your app as wished. As the session can become larger than we can store in a cookie (`CookieOverflow` exception), we recommend to use [activerecord-session_store](https://github.com/rails/activerecord-session_store).
 
+If you are calling Keycloak in your `ApplicationController`, for example, as a callback:
+
+```ruby
+  before_action :authenticate_with_keycloak
+
+  def authenticate_with_keycloak
+    unless session&.dig(:refresh_token).present? && session&.dig(:access_token).present?
+      redirect_to KeycloakOauth.connection.authorization_endpoint(options: { redirect_uri: keycloak_oauth.oauth2_url })
+    end
+  end
+```
+
+you may get into infinite loop issue, because  `KeycloakOauth::CallbacksController` also inherits from the `ApplicationController` and keeps redirecting to authentication endpoint. As a workaround, create a `BaseController` from which the controllers in your application inherit and move the `authenticate` callback to it.
+
 ### Customising redirect URIs
 
 There are situations where you would want to customise the oauth2 route (e.g. to use a localised version of the callback URL).
@@ -96,7 +110,7 @@ See here an example of retrieving the user information and saving the email addr
 
 ```ruby
 def map_authenticatable(_request)
-  service = KeycloakOauth.connection.get_user_information(access_token: session[:access_token])
+  service = KeycloakOauth.connection.get_user_information(access_token: session[:access_token], refresh_token: session[:refresh_token])
   session[:user_email_address] = service.user_information['email']
 end
 ```

data/app/services/keycloak_oauth/authorizable_error.rb

@@ -0,0 +1,3 @@
+module KeycloakOauth
+  class AuthorizableError < StandardError; end
+end

data/app/services/keycloak_oauth/authorizable_service.rb

@@ -1,9 +1,9 @@
 require 'net/http'
 
-module KeycloakOauth
-  class AuthorizableError < StandardError; end
-  class NotFoundError < StandardError; end
+require_relative "authorizable_error"
+require_relative "not_found_error"
 
+module KeycloakOauth
   class AuthorizableService
     HTTP_SUCCESS_CODES = [Net::HTTPOK, Net::HTTPNoContent, Net::HTTPCreated]
     CONTENT_TYPE_X_WWW_FORM_URLENCODED = 'application/x-www-form-urlencoded'.freeze

data/app/services/keycloak_oauth/duplication_error.rb

@@ -0,0 +1,3 @@
+module KeycloakOauth
+  class DuplicationError < StandardError; end
+end

data/app/services/keycloak_oauth/not_found_error.rb

@@ -0,0 +1,3 @@
+module KeycloakOauth
+  class NotFoundError < StandardError; end
+end

data/app/services/keycloak_oauth/post_users_service.rb

@@ -1,8 +1,9 @@
 require 'net/http'
 
-module KeycloakOauth
-  class DuplicationError < StandardError; end
+require_relative 'authorizable_error'
+require_relative 'not_found_error'
 
+module KeycloakOauth
   class PostUsersService < KeycloakOauth::AuthorizableService
     attr_reader :request_params, :connection, :user_params
 

data/lib/keycloak_oauth/connection.rb

@@ -1,4 +1,4 @@
-require 'keycloak_oauth/endpoints'
+require_relative 'endpoints'
 
 module KeycloakOauth
   class Connection

data/lib/keycloak_oauth/version.rb

@@ -1,3 +1,3 @@
 module KeycloakOauth
-  VERSION = "2.0.0"
+  VERSION = "2.0.2"
 end

data/lib/keycloak_oauth.rb

@@ -1,7 +1,7 @@
-require 'keycloak_oauth/version'
-require 'keycloak_oauth/configuration'
-require 'keycloak_oauth/connection'
-require 'keycloak_oauth/engine'
+require_relative 'keycloak_oauth/version'
+require_relative 'keycloak_oauth/configuration'
+require_relative 'keycloak_oauth/connection'
+require_relative 'keycloak_oauth/engine'
 
 module KeycloakOauth
   def self.configure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak_oauth
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - simplificator
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-14 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -120,9 +120,12 @@ files:
 - app/controllers/keycloak_oauth/callbacks_controller.rb
 - app/services/keycloak_oauth/authentication_service.rb
 - app/services/keycloak_oauth/authentication_service_base.rb
+- app/services/keycloak_oauth/authorizable_error.rb
 - app/services/keycloak_oauth/authorizable_service.rb
+- app/services/keycloak_oauth/duplication_error.rb
 - app/services/keycloak_oauth/get_users_service.rb
 - app/services/keycloak_oauth/logout_service.rb
+- app/services/keycloak_oauth/not_found_error.rb
 - app/services/keycloak_oauth/post_authorization_code_service.rb
 - app/services/keycloak_oauth/post_refresh_token_service.rb
 - app/services/keycloak_oauth/post_users_service.rb