Class: Clearance::FailureStatus

Inherits:

Object

• Object
• Clearance::FailureStatus

Defined in:

lib/clearance/session_status.rb

Overview

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

Instance Attribute Summary

• #failure_message ⇒ Object readonly

  The reason the sign in failed.

Instance Method Summary

• #initialize(failure_message) ⇒ FailureStatus constructor

  A new instance of FailureStatus.

• #success? ⇒ Boolean

  Is false, indicating that the sign in was unsuccessful.

Constructor Details

#initialize(failure_message) ⇒ FailureStatus

Returns a new instance of FailureStatus.

Parameters:

• failure_message (String) —

  The reason the sign in failed.

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

def initialize(failure_message)
  @failure_message = failure_message
end

Instance Attribute Details

#failure_message ⇒ Object (readonly)

The reason the sign in failed.

# 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)

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

def success?
  false
end