Module: Wikiwiki::Auth

Defined in:

lib/wikiwiki/auth.rb,
lib/wikiwiki/auth/token.rb,
lib/wikiwiki/auth/api_key.rb,
lib/wikiwiki/auth/password.rb

Overview

Authentication credentials module

Provides factory methods for creating authentication objects

Defined Under Namespace

Classes: ApiKey, Password, Token

Class Method Summary

• .api_key(api_key_id:, secret:) ⇒ ApiKey

  Create API key-based authentication credentials.

• .password(password:) ⇒ Password

  Create password-based authentication credentials.

• .token(token:) ⇒ Token

  Create token-based authentication credentials.

Class Method Details

.api_key(api_key_id:, secret:) ⇒ ApiKey

Create API key-based authentication credentials

Parameters:

• api_key_id (String) —

  API key ID

• secret (String) —

  secret key

Returns:

• (ApiKey) —

  API key authentication object

# File 'lib/wikiwiki/auth.rb', line 19

def self.api_key(api_key_id:, secret:) = ApiKey.new(api_key_id:, secret:)

.password(password:) ⇒ Password

Create password-based authentication credentials

Parameters:

• password (String) —

  admin password

Returns:

• (Password) —

  password authentication object

# File 'lib/wikiwiki/auth.rb', line 12

def self.password(password:) = Password.new(password:)

.token(token:) ⇒ Token

Create token-based authentication credentials

Parameters:

• token (String) —

  JWT authentication token

Returns:

• (Token) —

  token authentication object

# File 'lib/wikiwiki/auth.rb', line 25

def self.token(token:) = Token.new(token:)