Class: Clearance::FailureStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/clearance/session_status.rb

Overview

Indicates a failure in the SignInGuard stack which prevented successful sign in.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(failure_message) ⇒ FailureStatus

Returns a new instance of FailureStatus.

Parameters:

  • failure_message (String)

    The reason the sign in failed.


17
18
19
# File 'lib/clearance/session_status.rb', line 17

def initialize(failure_message)
  @failure_message = failure_message
end

Instance Attribute Details

#failure_messageObject (readonly)

The reason the sign in failed.


14
15
16
# File 'lib/clearance/session_status.rb', line 14

def failure_message
  @failure_message
end

Instance Method Details

#success?Boolean

Is false, indicating that the sign in was unsuccessful.

Returns:

  • (Boolean)

22
23
24
# File 'lib/clearance/session_status.rb', line 22

def success?
  false
end