Module: OpenID::Consumer::Response

Included in:
CancelResponse, FailureResponse, SetupNeededResponse, SuccessResponse
Defined in:
lib/openid/consumer/responses.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#endpointObject (readonly)

Returns the value of attribute endpoint.



23
24
25
# File 'lib/openid/consumer/responses.rb', line 23

def endpoint
  @endpoint
end

Instance Method Details

#display_identifierObject

The display identifier is related to the Claimed Identifier, but the two are not always identical. The display identifier is something the user should recognize as what they entered, whereas the response’s claimed identifier (in the identity_url attribute) may have extra information for better persistence.

URLs will be stripped of their fragments for display. XRIs will display the human-readable identifier (i-name) instead of the persistent identifier (i-number).

Use the display identifier in your user interface. Use identity_url for querying your database or authorization server, or other identifier equality comparisons.



48
49
50
# File 'lib/openid/consumer/responses.rb', line 48

def display_identifier
  @endpoint ? @endpoint.display_identifier : nil
end

#identity_urlObject

The identity URL that has been authenticated; the Claimed Identifier. See also display_identifier.



31
32
33
# File 'lib/openid/consumer/responses.rb', line 31

def identity_url
  @endpoint ? @endpoint.claimed_id : nil
end

#statusObject



25
26
27
# File 'lib/openid/consumer/responses.rb', line 25

def status
  self.class::STATUS
end