keycloak_ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69b02c30af6136bdddbf2bbd025fb4b9468eb4cbc483367ede0774bdc3c4ba71
-  data.tar.gz: 6f080dfe0802d3124ca38b09077b4fa9793c8032694919b2eb7bccf008fb745a
+  metadata.gz: fe23b854fa6a62cf06242aab5d164dbcc9174e14c925dc296f9ebd1537bd1403
+  data.tar.gz: 4ce5b1e227d240df6a9322346fccca4404f9f3519accd04989da8fde6c2ad6e2
 SHA512:
-  metadata.gz: bb4794636898be09829f9bf14395db896af56ddcb9ef92738225f95ad23be49135463c9deb0abaa7274d453574818647326cba80c89e306b1098ab5169805746
-  data.tar.gz: 3450f8d4fdd49e76b05fbd596078d03df83cb3b5d9869f93e8f9525ddac8a8dabaa7c089e55b141d375bfa32209e944615b799ee1a036dd5236c3bc82d20d86b
+  metadata.gz: dfb814621225d471d3121cd7a0f1e4543dea709f1e8251d58550bf6789e0f2a71d7d1882b2b1d90cfc2ec62730615f1a3c40e8cfb6839d54d9ae81385eea0108
+  data.tar.gz: ecf788e5417fc9f1f22f175fbc454a936552bf64776930cbc32076863db3b08031180b62f75168f5ebc7274fe6810a0bff5c30d51beda0764e51cafba5fc2f93

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.4.1

data/README.md

@@ -7,6 +7,9 @@ This library is designed to use Keycloak identification in Rails application
 Add to Gemfile
 
 ```bash
+# stable version
+gem "keycloak_ruby"
+# latest master
 gem "keycloak_ruby", git: "https://github.com/sergey-arkhipov/keycloak_ruby.git"
 
 ```
@@ -17,7 +20,12 @@ Create initializer for omniauth manually or use generator (config/initializers/o
 rails generate keycloak_ruby:install
 ```
 
-Now under active development, so you need create manually:
+Now under active development, so you need create controller and routes manually:
+
+- include `KeycloakRuby::Authentication` in ApplicationController
+- create `SeesionController`
+- add routes to `routes.rb
+`
 
 ```ruby
 # ApplicationController
@@ -54,7 +62,29 @@ delete '/logout', to: 'sessions#destroy', as: :logout
 
 ```
 
-It is assumed that you have a User model in Rails app
+It is assumed that you have a `User` model in Rails app
+
+### Configuration Warning
+
+When using `ENV[...]` or `ENV.fetch(...)` inside your `config/keycloak.yml`, make sure the referenced environment variables are actually defined.
+
+If any variable is missing, the application may crash at boot time with one of the following exceptions:
+
+- `KeyError` - when using `ENV.fetch(...)` without a fallback default;
+- `KeycloakRuby::Errors::ConfigurationError` - when a required value is `nil` or blank after config evaluation.
+
+This issue can happen when building Docker images. To avoid this, **use safe defaults** via `ENV.fetch('VAR', 'fallback')`:
+
+```yaml
+production:
+  keycloak_url: <%= ENV.fetch('KEYCLOAK_URL', 'https://keycloak.example.com') %>
+  app_host: <%= ENV.fetch('DEFAULT_APP_HOST', 'https://app.example.com') %>
+  realm: <%= ENV.fetch('KEYCLOAK_REALM', 'my-realm') %>
+  admin_client_id: <%= ENV.fetch('KEYCLOAK_ADMIN_CLIENT_ID', 'admin-cli') %>
+  admin_client_secret: <%= ENV.fetch('KEYCLOAK_ADMIN_CLIENT_SECRET', 'changeme') %>
+  oauth_client_id: <%= ENV.fetch('KEYCLOAK_OAUTH_CLIENT_ID', 'my-client') %>
+  oauth_client_secret: <%= ENV.fetch('KEYCLOAK_OAUTH_CLIENT_SECRET', 'secret') %>
+```
 
 ## Architecture Overview
 
@@ -145,13 +175,9 @@ sequenceDiagram
 
 ```
 
-## Test
+## Testing in application
 
 For test purpose there mock helper sign_in(user)
 
 - add `require "keycloak_ruby/testing/keycloak_helpers"` to keycloak_helper.rb
 - add sign_in in tests `config.include KeycloakRuby::Testing::KeycloakHelpers`
-
-```
-
-```

data/lib/keycloak_ruby/authentication.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # lib/keycloak_ruby/authentication.rb
+require "active_support/concern"
 module KeycloakRuby
   # Concern to add methods to ApplicationController
   module Authentication

data/lib/keycloak_ruby/token_refresher.rb

@@ -88,7 +88,7 @@ module KeycloakRuby
       {
         "Content-Type" => "application/x-www-form-urlencoded",
         "Accept" => "application/json",
-        "User-Agent" => "KeycloakRuby/#{KeycloakRuby::Version::VERSION}"
+        "User-Agent" => "KeycloakRuby/#{KeycloakRuby::VERSION}"
       }
     end
 

data/lib/keycloak_ruby/version.rb

@@ -1,62 +1,56 @@
 # frozen_string_literal: true
 
 # lib/keycloak_ruby/version.rb
-# Module for interacting with Keycloak
 module KeycloakRuby
-  # Version module following Semantic Versioning 2.0 guidelines
-  # Provides detailed version information and helper methods
+  # The current version of the KeycloakRuby gem as a string.
+  # Follows Semantic Versioning 2.0 (https://semver.org)
+  # @example
+  #   KeycloakRuby::VERSION # => "0.1.2"
+  VERSION = "0.1.2"
+
+  # Provides version information and comparison methods for the KeycloakRuby gem.
+  # This module follows Semantic Versioning 2.0 guidelines.
   #
   # @example Getting version information
-  #   KeycloakRuby::Version::VERSION      # => "0.1.0"
-  #   KeycloakRuby::Version.to_a          # => [0, 1, 0]
-  #   KeycloakRuby::Version.to_h          # => { major: 0, minor: 1, patch: 0, pre: nil }
-  #   KeycloakRuby.version                # => "0.1.0"
+  #   KeycloakRuby::Version.to_a    # => [0, 1, 1]
+  #   KeycloakRuby::Version.to_h    # => { major: 0, minor: 1, patch: 1 }
+  #   KeycloakRuby::Version.to_s    # => "0.1.1"
   #
-  # @example Checking version
-  #   KeycloakRuby::Version >= '0.1.0'    # => true
-  # Module for work with Version
+  # @example Version comparison
+  #   KeycloakRuby::Version >= '0.1.0'  # => true
+  #   KeycloakRuby::Version >= '1.0.0'  # => false
   module Version
-    # Major version number (incompatible API changes)
-    MAJOR = 0
-    # Minor version number (backwards-compatible functionality)
-    MINOR = 1
-    # Patch version number (backwards-compatible bug fixes)
-    PATCH = 1
-    # Pre-release version (nil for stable releases)
-    PRE = nil
-
-    # Full version string
-    VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join(".").freeze
-
-    # Returns version components as an array
-    # @return [Array<Integer, Integer, Integer, String|nil>]
+    # Returns the version components as an array of integers
+    # @return [Array<Integer>] the version components [major, minor, patch]
+    # @example
+    #   KeycloakRuby::Version.to_a # => [0, 1, 1]
     def self.to_a
-      [MAJOR, MINOR, PATCH, PRE]
+      VERSION.split(".").map(&:to_i)
     end
 
-    # Returns version components as a hash
-    # @return [Hash<Symbol, Integer|String|nil>]
+    # Returns the version components as a hash with symbols
+    # @return [Hash<Symbol, Integer>] the version components {major:, minor:, patch:}
+    # @example
+    #   KeycloakRuby::Version.to_h # => { major: 0, minor: 1, patch: 1 }
     def self.to_h
-      { major: MAJOR, minor: MINOR, patch: PATCH, pre: PRE }
+      { major: to_a[0], minor: to_a[1], patch: to_a[2] }
     end
 
-    # Compares version with another version string
-    # @param version_string [String] version to compare with (e.g., "1.2.3")
-    # @return [Boolean]
+    # Compares the current version with another version string
+    # @param version_string [String] the version to compare with (e.g. "1.2.3")
+    # @return [Boolean] true if current version is greater or equal
+    # @example
+    #   KeycloakRuby::Version >= '0.1.0' # => true
     def self.>=(version_string)
       Gem::Version.new(VERSION) >= Gem::Version.new(version_string)
     end
 
-    # Returns the full version string
-    # @return [String]
+    # Returns the version string
+    # @return [String] the version string
+    # @example
+    #   KeycloakRuby::Version.to_s # => "0.1.1"
     def self.to_s
       VERSION
     end
   end
-
-  # Returns the current gem version
-  # @return [String]
-  def self.version
-    Version::VERSION
-  end
 end

data/lib/keycloak_ruby.rb

@@ -1,23 +1,20 @@
 # frozen_string_literal: true
 
+# lib/keycloak_ruby.rb
 require "omniauth"
 require "omniauth_openid_connect"
 require "httparty"
 require "jwt"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore(
+  "#{__dir__}/generators",
+  "#{__dir__}/templates"
+)
+loader.setup
 
-# lib/keycloak_ruby.rb
 require "generators/keycloak_ruby/install_generator" if defined?(Rails)
-require "keycloak_ruby/authentication"
-require "keycloak_ruby/client"
-require "keycloak_ruby/config"
-require "keycloak_ruby/errors"
-require "keycloak_ruby/request_params"
-require "keycloak_ruby/request_performer"
-require "keycloak_ruby/response_validator"
-require "keycloak_ruby/token_refresher"
-require "keycloak_ruby/token_service"
-require "keycloak_ruby/user"
-require "keycloak_ruby/version"
 
 # Module for interacting with Keycloak
 module KeycloakRuby
@@ -56,8 +53,6 @@ module KeycloakRuby
       config.validate!
     end
   end
-  VERSION = Version::VERSION
-  # Only load test helpers when in test environment
   # Load test helpers only in test environment
   if ENV["RACK_ENV"] == "test" || ENV["RAILS_ENV"] == "test" || defined?(RSpec) || defined?(Minitest)
     require "keycloak_ruby/testing"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: keycloak_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sergey Arkhipov
 - Georgy Shcherbakov
 bindir: bin
 cert_chain: []
-date: 2025-04-09 00:00:00.000000000 Z
+date: 2025-04-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 description: Library for using keycloak authentication with Rails
 email:
 - sergey-arkhipov@ya.ru
@@ -76,6 +104,7 @@ extra_rdoc_files: []
 files:
 - ".rspec_status"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE
@@ -105,7 +134,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/sergey-arkhipov/keycloak_ruby
   documentation_uri: https://github.com/sergey-arkhipov/keycloak_ruby/blob/master/README.md
-  changelog_uri: https://github.com/heartcombo/devise/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/sergey-arkhipov/keycloak_ruby/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/sergey-arkhipov/keycloak_ruby
   bug_tracker_uri: https://github.com/sergey-arkhipov/keycloak_ruby/issues
   rubygems_mfa_required: 'true'
@@ -116,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.4'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="