Module: ActionController::HttpAuthentication::Token::ControllerMethods

Included in:

Base

Defined in:

actionpack/lib/action_controller/metal/http_authentication.rb

Instance Method Summary

• #authenticate_or_request_with_http_token(realm = "Application", message = nil, &login_procedure) ⇒ Object

  Authenticate using an HTTP Bearer token, or otherwise render an HTTP header requesting the client to send a Bearer token.

• #authenticate_with_http_token(&login_procedure) ⇒ Object

  Authenticate using an HTTP Bearer token.

• #request_http_token_authentication(realm = "Application", message = nil) ⇒ Object

  Render an HTTP header requesting the client to send a Bearer token for authentication.

Instance Method Details

#authenticate_or_request_with_http_token(realm = "Application", message = nil, &login_procedure) ⇒ Object

Authenticate using an HTTP Bearer token, or otherwise render an HTTP header requesting the client to send a Bearer token. For the authentication to be considered successful, ‘login_procedure` must not return a false value. Typically, the authenticated user is returned.

See ActionController::HttpAuthentication::Token for example usage.

# File 'actionpack/lib/action_controller/metal/http_authentication.rb', line 438

def authenticate_or_request_with_http_token(realm = "Application", message = nil, &login_procedure)
  authenticate_with_http_token(&login_procedure) || request_http_token_authentication(realm, message)
end

#authenticate_with_http_token(&login_procedure) ⇒ Object

Authenticate using an HTTP Bearer token. Returns the return value of ‘login_procedure` if a token is found. Returns `nil` if no token is found.

See ActionController::HttpAuthentication::Token for example usage.

# File 'actionpack/lib/action_controller/metal/http_authentication.rb', line 446

def authenticate_with_http_token(&login_procedure)
  Token.authenticate(self, &login_procedure)
end

#request_http_token_authentication(realm = "Application", message = nil) ⇒ Object

Render an HTTP header requesting the client to send a Bearer token for authentication.

# File 'actionpack/lib/action_controller/metal/http_authentication.rb', line 452

def request_http_token_authentication(realm = "Application", message = nil)
  Token.authentication_request(self, realm, message)
end