Module: Verikloak::Audience

Defined in:
lib/verikloak/audience.rb,
lib/verikloak/audience/errors.rb,
lib/verikloak/audience/checker.rb,
lib/verikloak/audience/railtie.rb,
lib/verikloak/audience/version.rb,
lib/verikloak/audience/middleware.rb,
lib/verikloak/audience/configuration.rb,
lib/generators/verikloak/audience/install/install_generator.rb

Overview

Audience configuration entrypoint and helpers. This file also requires the public components of the gem.

Defined Under Namespace

Modules: Checker, Generators, RailtieHelpers, RailtieWarnings Classes: Configuration, ConfigurationError, Error, Forbidden, Middleware, Railtie

Constant Summary collapse

VERSION =

Current gem version.

Returns:

  • (String) 
'1.1.0'

Class Method Summary collapse

Class Method Details

.config ⇒ Verikloak::Audience::Configuration

Access the current configuration without mutating it.

Returns:



34
35
36
 
# File 'lib/verikloak/audience.rb', line 34

def config
  @config ||= Configuration.new
end

.configure {|config| ... } ⇒ Verikloak::Audience::Configuration

Configure verikloak-audience.

When a block is given, the current configuration is yielded so callers can mutate settings in one place.

Yields:

  • (config) —

    yields the current configuration for mutation

Yield Parameters:

Returns:



25
26
27
28
29
 
# File 'lib/verikloak/audience.rb', line 25

def configure
  @config ||= Configuration.new
  yield @config if block_given?
  @config
end

.reset! ⇒ void

This method returns an undefined value.

Reset configuration to defaults. Intended for test teardown to prevent leakage between examples.



42
43
44
 
# File 'lib/verikloak/audience.rb', line 42

def reset!
  @config = nil
end