Top Level Namespace

Defined Under Namespace

Modules: Cql

Instance Method Summary

• #authentication_successful(token) ⇒ nil

  Called when the authentication is successful.

• #challenge_response(token) ⇒ String

  If the authentication requires multiple challenge/response cycles this method will be called when a challenge is returned by the server.

• #initial_response ⇒ String

  This method must return the initial authentication token to be sent to the server.

Instance Method Details

#authentication_successful(token) ⇒ nil

Note:

This method must absolutely not block.

Called when the authentication is successful.

Parameters:

• token (String) —

  a token sent by the server

Returns:

• (nil)

# File 'lib/cql/auth.rb', line 65

#challenge_response(token) ⇒ String

Note:

This method must absolutely not block.

If the authentication requires multiple challenge/response cycles this method will be called when a challenge is returned by the server. A response token must be created and will be sent back to the server.

Parameters:

• token (String) —

  a challenge token sent by the server

Returns:

• (String) —

  the authentication token to send back to the server

# File 'lib/cql/auth.rb', line 54

#initial_response ⇒ String

Note:

This method must absolutely not block.

This method must return the initial authentication token to be sent to the server.

Returns:

• (String) —

  the initial authentication token

# File 'lib/cql/auth.rb', line 45