Module: Hanko::Rails

Defined in:
lib/hanko-rails.rb,
lib/hanko/rails/engine.rb,
lib/hanko/rails/version.rb,
lib/hanko/rails/middleware.rb,
lib/hanko/rails/test_helper.rb,
lib/hanko/rails/configuration.rb,
lib/hanko/rails/authentication.rb,
lib/hanko/rails/generators/install_generator.rb

Overview

Rails integration for Hanko authentication.

Provides middleware, controller helpers, and test utilities for authenticating users via Hanko in a Rails application.

Examples:

Configure Hanko::Rails in an initializer

Hanko::Rails.configure do |config|
  config.cookie_name = 'hanko'
  config.jwks_cache_ttl = 3600
  config.exclude_paths = ['/health']
end

Defined Under Namespace

Modules: Authentication, Generators, TestHelper Classes: Configuration, Engine, Middleware

Constant Summary collapse

VERSION = 
'0.1.5'

Class Method Summary collapse

Class Method Details

.configuration ⇒ Hanko::Rails::Configuration

Returns the current configuration instance.

Returns:

  • the current configuration



27
28
29
 
# File 'lib/hanko-rails.rb', line 27

def configuration
  @configuration ||= Configuration.new
end

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

This method returns an undefined value.

Yields the configuration instance for modification.

Examples:

Hanko::Rails.configure do |config|
  config.cookie_name = 'hanko_session'
end

Yields:

  • (config) —

    the configuration instance

Yield Parameters:



41
42
43
 
# File 'lib/hanko-rails.rb', line 41

def configure
  yield(configuration)
end

.reset_configuration! ⇒ Hanko::Rails::Configuration

Resets the configuration to default values.

Returns:

  • the new default configuration



48
49
50
 
# File 'lib/hanko-rails.rb', line 48

def reset_configuration!
  @configuration = Configuration.new
end