Module: Verikloak::Rails

Defined in:
lib/verikloak/rails.rb,
lib/verikloak/rails/railtie.rb,
lib/verikloak/rails/testing.rb,
lib/verikloak/rails/version.rb,
lib/verikloak/rails/controller.rb,
lib/verikloak/rails/configuration.rb,
lib/verikloak/rails/error_renderer.rb,
lib/verikloak/rails/railtie_logger.rb,
lib/verikloak/rails/testing/helpers.rb,
lib/verikloak/rails/bff_configurator.rb,
lib/verikloak/rails/skip_path_checker.rb,
lib/verikloak/rails/request_store_mirror.rb,
lib/verikloak/rails/testing/claims_builder.rb,
lib/verikloak/rails/testing/middleware_stub.rb,
lib/verikloak/rails/controller/error_handling.rb

Overview

Rails integration surface for Verikloak.

Exposes configuration and Railtie hooks to wire middleware and controller helpers into a Rails application.

Defined Under Namespace

Modules: BffConfigurator, Controller, RailtieLogger, Testing Classes: Configuration, ErrorRenderer, Railtie, RequestStoreMirror, SkipPathChecker

Constant Summary collapse

VERSION = 
'1.2.1'

Class Method Summary collapse

Class Method Details

.config ⇒ Verikloak::Rails::Configuration

Global configuration object for verikloak-rails.

Examples:

Read current leeway

Verikloak::Rails.config.leeway #=> 60

Returns:



23
24
25
 
# File 'lib/verikloak/rails.rb', line 23

def config
  @config ||= Configuration.new
end

.configure {|config| ... } ⇒ void

This method returns an undefined value.

Configure verikloak-rails.

Examples:

Verikloak::Rails.configure do |c|
  c.discovery_url = ENV['KEYCLOAK_DISCOVERY_URL']
  c.audience      = 'rails-api'
  c.leeway        = 30
end

Yield Parameters:



37
38
39
 
# File 'lib/verikloak/rails.rb', line 37

def configure
  yield(config)
end

.reset! ⇒ void

This method returns an undefined value.

Reset configuration to its default state.

Primarily intended for test environments that need to ensure a clean configuration between examples.



47
48
49
 
# File 'lib/verikloak/rails.rb', line 47

def reset!
  @config = nil
end