Class: OmniAuth::AuthHash

Inherits:
Hashie::Mash
  • Object
show all
Defined in:
lib/omniauth/auth_hash.rb

Overview

The AuthHash is a normalized schema returned by all OmniAuth strategies. It maps as much user information as the provider is able to provide into the InfoHash (stored as the 'info' key).

Defined Under Namespace

Classes: InfoHash

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.subkey_classObject


9
10
11
# File 'lib/omniauth/auth_hash.rb', line 9

def self.subkey_class
  Hashie::Mash
end

Instance Method Details

#regular_writer(key, value) ⇒ Object


22
23
24
25
26
27
# File 'lib/omniauth/auth_hash.rb', line 22

def regular_writer(key, value)
  if key.to_s == 'info' && !value.is_a?(InfoHash)
    value = InfoHash.new(value)
  end
  super
end

#valid?Boolean

Tells you if this is considered to be a valid OmniAuth AuthHash. The requirements for that are that it has a provider name, a uid, and a valid info hash. See InfoHash#valid? for more details there.

Returns:

  • (Boolean)

18
19
20
# File 'lib/omniauth/auth_hash.rb', line 18

def valid?
  uid? && provider? && info? && info.valid?
end