Module: BrickFTP::API::Authentication

Defined in:

lib/brick_ftp/api/authentication.rb,
lib/brick_ftp/api/authentication/session.rb

Defined Under Namespace

Classes: Session

Constant Summary

COOKIE_NAME =

'BrickAPI'.freeze

Class Method Summary

• .cookie(session) ⇒ CGI::Cookie

  Generate authentication cookie.

• .login(username, password) ⇒ Object

  Alias for ‘BrickFTP::API::Authentication::Session.create`.

• .logout ⇒ Object

  Alias for ‘BrickFTP::API::Authentication::Session#destroy`.

Class Method Details

.cookie(session) ⇒ CGI::Cookie

Generate authentication cookie.

Parameters:

• session (BrickFTP::API::Authentication::Session) —

  authentication session object.

Returns:

• (CGI::Cookie) —

  authentication cookie.

# File 'lib/brick_ftp/api/authentication.rb', line 11

def self.cookie(session)
  CGI::Cookie.new(COOKIE_NAME, session.id)
end

.login(username, password) ⇒ Object

Alias for ‘BrickFTP::API::Authentication::Session.create`.

Parameters:

• username (String) —

  username of BrickFTP’s user.

• password (String) —

  password of BrickFTP’s user.

# File 'lib/brick_ftp/api/authentication.rb', line 18

def self.login(username, password)
  Session.create(username: username, password: password)
end

.logout ⇒ Object

Alias for ‘BrickFTP::API::Authentication::Session#destroy`.

# File 'lib/brick_ftp/api/authentication.rb', line 23

def self.logout
  BrickFTP.config.session.destroy
end