Class: Isaca::Request::AuthenticateUser

Inherits:

Object

• Object
• Isaca::Request::AuthenticateUser

Defined in:

lib/isaca/requests/authenticate_user.rb

Overview

Class used to create user sessions.

Class Method Summary

• .get(username, password) ⇒ Isaca::Model::AuthenticateUser

  Method used to generate a session token.

• .send_request(username, password) ⇒ Faraday::Response

  Method used to send the request – exists for easy stubbing during tests.

Class Method Details

.get(username, password) ⇒ Isaca::Model::AuthenticateUser

Method used to generate a session token.

Returns:

• (Isaca::Model::AuthenticateUser) —

  An object representation of the response.

Raises:

• (Isaca::SessionError) —

  Raised if the returned session is invalid.

# File 'lib/isaca/requests/authenticate_user.rb', line 10

def self.get(username, password)
  response = self.send_request(username, password)
  Isaca::Model::AuthenticateUser.new(JSON.parse(response.body, {symbolize_names: true}))
end

.send_request(username, password) ⇒ Faraday::Response

Method used to send the request – exists for easy stubbing during tests

Parameters:

• username (String)
• password (String)

Returns:

• (Faraday::Response)

# File 'lib/isaca/requests/authenticate_user.rb', line 22

def self.send_request(username, password)
  Isaca::Request.get do |request|
    request.path = request.path + '/AuthenticateUser'
    request.params['username'] = username
    request.params['password'] = password
  end
end