Class: Tasker::Types::AuthConfig

Inherits:

BaseConfig

• Object
• Dry::Struct
• BaseConfig
• Tasker::Types::AuthConfig

Defined in:

lib/tasker/types/auth_config.rb

Overview

Configuration type for authentication and authorization settings

This configuration handles all authentication and authorization settings for Tasker. It provides the same functionality as the original AuthConfiguration but with dry-struct type safety and immutability.

Examples:

Basic authentication setup

config = AuthConfig.new(
  authentication_enabled: true,
  authenticator_class: 'MyAuthenticator',
  strategy: :custom
)

Full configuration

config = AuthConfig.new(
  authentication_enabled: true,
  authenticator_class: 'JwtAuthenticator',
  current_user_method: :current_user,
  authenticate_user_method: :authenticate_user!,
  authorization_enabled: true,
  authorization_coordinator_class: 'MyAuthorizationCoordinator',
  user_class: 'User',
  strategy: :custom
)

Instance Attribute Summary

• #authenticate_user_method ⇒ Symbol readonly

  Method name to authenticate the user.

• #authentication_enabled ⇒ Boolean readonly

  Whether authentication is enabled.

• #authenticator_class ⇒ String^? readonly

  Class name for the authenticator.

• #authorization_coordinator_class ⇒ String readonly

  Class name for the authorization coordinator.

• #authorization_enabled ⇒ Boolean readonly

  Whether authorization is enabled.

• #current_user_method ⇒ Symbol readonly

  Method name to get the current user.

• #strategy ⇒ Symbol readonly

  Authentication strategy.

• #user_class ⇒ String^? readonly

  Class name for the authorizable user class.

Method Summary

Methods inherited from BaseConfig

#initialize

Constructor Details

This class inherits a constructor from Tasker::Types::BaseConfig

Instance Attribute Details

#authenticate_user_method ⇒ Symbol (readonly)

Returns Method name to authenticate the user.

Returns:

• (Symbol) —

  Method name to authenticate the user

# File 'lib/tasker/types/auth_config.rb', line 54

attribute :authenticate_user_method, Types::Symbol.default(:authenticate_user!)

#authentication_enabled ⇒ Boolean (readonly)

Returns Whether authentication is enabled.

Returns:

• (Boolean) —

  Whether authentication is enabled

# File 'lib/tasker/types/auth_config.rb', line 36

attribute :authentication_enabled, Types::Bool.default(false)

#authenticator_class ⇒ String^? (readonly)

Returns Class name for the authenticator.

Returns:

• (String, nil) —

  Class name for the authenticator

# File 'lib/tasker/types/auth_config.rb', line 42

attribute? :authenticator_class, Types::String.optional.default(nil)

#authorization_coordinator_class ⇒ String (readonly)

Returns Class name for the authorization coordinator.

Returns:

• (String) —

  Class name for the authorization coordinator

# File 'lib/tasker/types/auth_config.rb', line 66

attribute :authorization_coordinator_class, Types::String.default('Tasker::Authorization::BaseCoordinator')

#authorization_enabled ⇒ Boolean (readonly)

Returns Whether authorization is enabled.

Returns:

• (Boolean) —

  Whether authorization is enabled

# File 'lib/tasker/types/auth_config.rb', line 60

attribute :authorization_enabled, Types::Bool.default(false)

#current_user_method ⇒ Symbol (readonly)

Returns Method name to get the current user.

Returns:

• (Symbol) —

  Method name to get the current user

# File 'lib/tasker/types/auth_config.rb', line 48

attribute :current_user_method, Types::Symbol.default(:current_user)

#strategy ⇒ Symbol (readonly)

Returns Authentication strategy.

Returns:

• (Symbol) —

  Authentication strategy

# File 'lib/tasker/types/auth_config.rb', line 78

attribute :strategy, Types::Symbol.default(:none)

#user_class ⇒ String^? (readonly)

Returns Class name for the authorizable user class.

Returns:

• (String, nil) —

  Class name for the authorizable user class

# File 'lib/tasker/types/auth_config.rb', line 72

attribute? :user_class, Types::String.optional.default(nil)