keycloak_rails 1.0.0.pre.beta → 1.0.0.pre.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f02d892062dce2d81c45f4de13d30c78201eb376675a47bb91b1292ac8963487
-  data.tar.gz: a8272329fa865c85099399b1f819c525aa65483c0cd13cf6e711a18525d9f866
+  metadata.gz: 3ab83f2bbc67c999f4575e3f9949d6569056144634463fc6d186309152343082
+  data.tar.gz: 2fb463727955abda0b386031ac6a6b1444a4b5637cbee5dc64966fe5aa41cfe3
 SHA512:
-  metadata.gz: df5bf2f2e77dacbf7c6211ccdf70adb1046398a46d94f31777af3c2987085b1db30fc95daead3dcde8b838105cd69f1ee42d1f407ea3c7f35eb869af6fd58e42
-  data.tar.gz: 4d43eaffc5aafd0822c399a6ee45e31e135e01abd72b4fdd79c1beef773c14672d814eda9edf9336b61c97a05ec1fba1cb13431d91c2966d1a9e2cceff55dd8b
+  metadata.gz: d4f85ee2ed8bbfef4022e24a47f1ac6a5e3d39ac6e89807e1362212e046259895d81ab15254cf14af2858677e618ef4a8ce53a6e7bd6bf544eaef2aafc835d16
+  data.tar.gz: daac0698880760a92939ac6955d107ec1e5b3ad919d2c2b4e1f8e53d7dec7de95857a4dad5e1405b6763712a3e4c31623bbd4f5d0067c5f0c34b4f8badf8f773

data/README.md

@@ -1,3 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/keycloak_rails.svg)](https://badge.fury.io/rb/keycloak_rails)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+[![unstable](http://badges.github.io/stability-badges/dist/unstable.svg)](http://github.com/badges/stability-badges)
+
 # KeycloakRails
 Keycloak_rails is an api wrapper for open source project [Keycloak](https://www.keycloak.org/)
 
@@ -165,19 +171,8 @@ end
 
 #### KeycloakRails::Client
 
-
-## Architecte plan
-
-### Engine Strecture
-<img width="573" alt="Screen Shot 2022-11-20 at 1 11 50 AM" src="https://user-images.githubusercontent.com/84993125/202890379-b7f8abe9-105c-4d7d-bdf8-c5768f4111af.png">
-
-### Some use cases
-|auth request|redirect|protected route request
-|:-:|:-:|:-:|
-|![auth request](https://user-images.githubusercontent.com/84993125/202890457-7d58c789-368a-4423-9064-4c50a8ffa296.png)|![redirect](https://user-images.githubusercontent.com/84993125/202890476-2420025e-0f23-4102-8a63-e961411eff16.png)|![protected route request](https://user-images.githubusercontent.com/84993125/202890490-854bda28-2dd3-41b8-8f06-ce80de4825e9.png)
-
 ## Contributing
-Contribution directions go here.
+refer to [CONTRIBUTING.md](https://github.com/Laborocity/keycloak_rails/blob/main/CONTRIBUTING.md) .
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,3 +1,5 @@
-require "bundler/setup"
+# frozen_string_literal: true
 
-require "bundler/gem_tasks"
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'

data/lib/app/models/keycloak_rails/concerns/sso_recipient.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module KeycloakRails
   module SsoRecipient
     extend ActiveSupport::Concern
 
     included do
-      has_one :keycloak_rails_sso, as: :recipient, class_name: "::KeycloakRails::Sso"
+      has_one :keycloak_rails_sso, as: :recipient, class_name: '::KeycloakRails::Sso'
 
       def sub
-        keycloak_rails_sso.sub
+        keycloak_rails_sso&.sub
       end
     end
   end

data/lib/app/models/keycloak_rails/sso.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module KeycloakRails
   class Sso < ActiveRecord::Base
     belongs_to :recipient, polymorphic: true
   end
-end
+end

data/lib/generators/keycloak_rails/config/config_generator.rb

@@ -3,10 +3,10 @@
 module KeycloakRails
   module Generators
     class ConfigGenerator < Rails::Generators::Base
-      source_root(File.expand_path(File.dirname(__FILE__)))
+      source_root(__dir__)
       def copy_initializer
         copy_file '../keycloak_rails.rb', 'config/initializers/keycloak_rails.rb'
       end
     end
   end
-end
+end

data/lib/generators/keycloak_rails/install/install_generator.rb

@@ -3,15 +3,15 @@
 module KeycloakRails
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root(File.expand_path(File.dirname(__FILE__)))
+      source_root(__dir__)
 
-      TABLE_NAME = 'keycloak_rails_sso'.freeze
+      TABLE_NAME = 'keycloak_rails_sso'
 
-      desc "Generates a name space SSO model to store user subs."
+      desc 'Generates a name space SSO model to store user subs.'
 
       def generate_keycloak_rails_model
-        generate :migration, "create_#{TABLE_NAME}", "recipient:references{polymorphic}",  "sub:string:index"
+        generate :migration, "create_#{TABLE_NAME}", 'recipient:references{polymorphic}', 'sub:string:index'
       end
     end
   end
-end
+end

data/lib/keycloak_rails/client.rb

@@ -16,7 +16,7 @@ module KeycloakRails
                                    attributes: {}, groups: [], enabled: true }.to_json)
       raise StandardError, request[:response] unless request[:status] == :ok
 
-      set_perm_password(email, password)
+      set_perm_password(email, password) unless password.nil? || password.empty?
     end
 
     def current_user_has_active_session?
@@ -51,7 +51,7 @@ module KeycloakRails
     def update_user_attributes(user_id, attributes)
       request = @curl.put(path: "/admin/realms/#{KeycloakRails.realm}/users/#{user_id}",
                           headers: { 'Authorization': client_token, 'Content-Type': 'application/json' },
-                          body: attributes.to_json)
+                          body: attributes.to_json(only: attributes.keys))
       raise StandardError, request[:response] unless request[:status] == :ok
 
       request[:response]
@@ -59,7 +59,7 @@ module KeycloakRails
 
     def require_set_otp(user_email)
       user = user_by_username(user_email)
-      required_actions = user['requiredActions'].push("CONFIGURE_TOTP")
+      required_actions = user['requiredActions'].push('CONFIGURE_TOTP')
       request = @curl.put(path: "/admin/realms/#{KeycloakRails.realm}/users/#{user['id']}",
                           headers: { 'Authorization': client_token, 'Content-Type': 'application/json' },
                           body: { "requiredActions": required_actions }.to_json)
@@ -78,8 +78,9 @@ module KeycloakRails
       request[:response]
     end
 
-    def get_magic_link(email:, redirect_uri:, expiration_seconds: 3600, force_create: false, send_email: false, client_id: KeycloakRails.client_id)
-      request = @curl.post(path: "/auth/realms/#{KeycloakRails.realm}/magic-link",
+    def get_magic_link(email:, redirect_uri:, expiration_seconds: 3600, force_create: false, send_email: false,
+                       client_id: KeycloakRails.client_id)
+      request = @curl.post(path: "/realms/#{KeycloakRails.realm}/magic-link",
                            headers: { 'Authorization': client_token, 'Content-Type': 'application/json' },
                            body: { "email": email, "client_id": client_id,
                                    "redirect_uri": redirect_uri, "expiration_seconds": expiration_seconds,

data/lib/keycloak_rails/controller/helpers.rb

@@ -18,7 +18,9 @@ module KeycloakRails
         end
 
         def ensure_active_session(accept_magic_link_handshake: false)
-          redirect_to root_path unless user_has_active_sso_session?(accept_magic_link_handshake: accept_magic_link_handshake)
+          return if user_has_active_sso_session?(accept_magic_link_handshake: accept_magic_link_handshake)
+
+          redirect_to root_path
         end
 
         def ensure_no_active_session

data/lib/keycloak_rails/controller/magic_links.rb

@@ -9,8 +9,8 @@ module KeycloakRails
       extend ActiveSupport::Concern
 
       included do
-        
-        def generate_magic_link(url:, email: , expiration_seconds: 3600, force_create: false, send_email: false, client_id: KeycloakRails.client_id)
+        def generate_magic_link(url:, email:, expiration_seconds: 3600, force_create: false, send_email: false,
+                                client_id: KeycloakRails.client_id)
           magic_link_obj = keycloak_client.get_magic_link(email: email,
                                                           redirect_uri: url,
                                                           expiration_seconds: expiration_seconds,

data/lib/keycloak_rails/controller/omniauth.rb

@@ -8,7 +8,6 @@ module KeycloakRails
       extend ActiveSupport::Concern
 
       included do
-
       end
     end
   end

data/lib/keycloak_rails/controller/registrations.rb

@@ -8,17 +8,18 @@ module KeycloakRails
       extend ActiveSupport::Concern
 
       included do
-        def create_or_find_sso_user(email:, password:, first_name:, last_name:, password_confirmation: nil, set_session: true)
+        def create_or_find_sso_user(email:, first_name:, last_name:, password_confirmation: nil, set_session: true, password: nil)
           user = keycloak_client.user_by_username(email)
           if user
             { sso_sub: user['id'], email: email,
               first_name: first_name, last_name: last_name }
           else
-            create_sso_user(email: email, password: password, first_name: first_name, last_name: last_name, password_confirmation: password_confirmation, set_session: set_session)
+            create_sso_user(email: email, password: password, first_name: first_name, last_name: last_name,
+                            password_confirmation: password_confirmation, set_session: set_session)
           end
         end
 
-        def create_sso_user(email:, password:, first_name:, last_name:, password_confirmation: nil, set_session: true)
+        def create_sso_user(email:, first_name:, last_name:, password_confirmation: nil, set_session: true, password: nil)
           raise StandardError, 'Passwords must match' if password_confirmation && password != password_confirmation
 
           keycloak_client.create_user(email: email,

data/lib/keycloak_rails/controller/unlocks.rb

@@ -8,7 +8,6 @@ module KeycloakRails
       extend ActiveSupport::Concern
 
       included do
-
       end
     end
   end

data/lib/keycloak_rails/curl.rb

@@ -51,7 +51,7 @@ module KeycloakRails
       end
     end
 
-    def response_to(request, message: "", status: :ok)
+    def response_to(request, message: '', status: :ok)
       { response: request.body && request.body != '' ? JSON.parse(request.body) : {}, message: message, status: status }
     end
   end

data/lib/keycloak_rails/user.rb

@@ -63,6 +63,7 @@ module KeycloakRails
 
     def active_user_sub
       return unless access_token
+
       case KeycloakRails.decode_token_strategy
       when :local then decode_active_user_sub
       when :cloud then fetch_active_user_sub

data/lib/keycloak_rails/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KeycloakRails
-  VERSION = '1.0.0-beta'
+  VERSION = '1.0.0-beta.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta
+  version: 1.0.0.pre.beta.2
 platform: ruby
 authors:
 - Omar Luqman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-10 00:00:00.000000000 Z
+date: 2022-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -66,6 +66,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.3
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-gitlab-security
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A rails wrapper for open source SSO project Keycloak.
 email:
 - oluqman@nucleushealthcare.com
@@ -108,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"