Class: Trusty::Omniauth::ProviderMapper

Inherits:
Object
  • Object
show all
Includes:
MappingHelpers
Defined in:
lib/trusty/omniauth/provider_mapper.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MappingHelpers

#clean

Constructor Details

#initialize(provider_attributes, options = {}) ⇒ ProviderMapper

provider_attributes = OmniAuth data options =

  • :user_model = User model

  • :user_attributes = Hash of attributes to merge into user_attributes

  • :user_attributes_names = Array of attribute names to copy from Omniauth data (default: User.column_names)

  • :user_required_criteria = Hash of criteria to use to find users, and also to merge into attributes

  • :user_identifiers = Array of column names that identify a model uniquely with omniauth data

  • :identity_model = Identity model

  • :identity_attributes = Hash of attributes to merge into identity_attributes

  • :identity_attribute_names = Array of attribute names to copy from Omniauth data (default: Identity.column_names)

  • :identity_required_criteria = Hash of criteria to use to find identities, and also to merge into attributes

  • :identity_identifiers = Array of column names that identify a model uniquely with omniauth data

  • :skip_raw_info (default: false) = Boolean whether to exclude OmniAuth “extra” data in identity_attributes

  • :skip_nils (default: true) = Boolean whether to remove attributes with nil values



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 26

def initialize(provider_attributes, options = {})
  @provider_attributes  = provider_attributes.with_indifferent_access
  @provider_name        = provider_attributes['provider']
  @options              = {
    :user_attributes      => {},
    :identity_attributes  => {},
    :skip_raw_info        => false,
    :skip_nils            => true
  }.merge(options)

  @provider_identity = ModelMapper.new(self,
    :model              => @options[:identity_model] || ::Identity,
    :attributes         => @options[:identity_attributes],
    :attribute_names    => @options[:identity_attribute_names],
    :unique_identifiers => @options[:identity_identifiers] || [:provider, :uid],
    :required_criteria  => @options[:identity_required_criteria]
  )
  @provider_user = ModelMapper.new(self,
    :model              => @options[:user_model] || ::User,
    :attributes         => @options[:user_attributes],
    :attribute_names    => @options[:user_attribute_names],
    :unique_identifiers => @options[:user_identifiers] || [:email],
    :required_criteria  => @options[:user_required_criteria]
  )
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

#provider_attributes ⇒ Object (readonly)

Returns the value of attribute provider_attributes.



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

def provider_attributes
  @provider_attributes
end

#provider_identity ⇒ Object (readonly)

Returns the value of attribute provider_identity.



10
11
12
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 10

def provider_identity
  @provider_identity
end

#provider_name ⇒ Object (readonly)

Returns the value of attribute provider_name.



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

def provider_name
  @provider_name
end

#provider_user ⇒ Object (readonly)

Returns the value of attribute provider_user.



10
11
12
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 10

def provider_user
  @provider_user
end

Instance Method Details

#attributes(*filter_attribute_names) ⇒ Object

General ######



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 127

def attributes(*filter_attribute_names)
  unless @attributes
    info            = provider_attributes.fetch('info', {})
    credentials     = provider_attributes['credentials']

    name            = clean(info['name'])       { [info['first_name'], info['last_name']].join(" ").strip }
    first_name      = clean(info['first_name']) { name.split(/\s+/, 2).first }
    last_name       = clean(info['last_name'])  { name.split(/\s+/, 2).last }

    @attributes = {
      :provider       => provider_name,
      :uid            => clean(provider_attributes['uid']),
      :name           => name,
      :email          => clean(info['email'], :downcase, :strip),
      :verified       => provider_attributes['extra']['raw_info']['verified_email'] == true,
      :username       => clean(info['nickname']),
      :first_name     => first_name,
      :middle_name    => clean(info['middle_name']),
      :last_name      => last_name,
      :phone          => clean(info['phone']),
      :image_url      => info['image'],
      :profile_url    => info.fetch('urls', {})['public_profile'],
      :token_type     => clean(credentials['token_type']),
      :token          => clean(credentials['token']),
      :secret         => clean(credentials['secret']),
      :refresh_token  => clean(credentials['refresh_token']),
      :expires        => credentials['expires'] == true,
      :expires_at     => (Time.at(credentials['expires_at']) rescue nil),
      :raw_info       => provider_attributes['extra'].except('access_token').as_json,
      # extra
      :location       => info['location'],
      :time_zone      => info['time_zone'] || Time.zone.name,
      :locale         => info['locale'] || I18n.locale
    }.with_indifferent_access

    @attributes.reject!{|_,value| value.nil?} if options[:skip_nils]
    @attributes.delete(:raw_info) if options[:skip_raw_info]
  end

  if filter_attribute_names.any?
    @attributes.slice(*filter_attribute_names)
  else
    @attributes.dup
  end
end

#build_identity(attributes = {}) ⇒ Object

IDENTITY



108
109
110
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 108

def build_identity(attributes = {})
  @provider_identity.build_record(attributes)
end

#build_identity_for_user(user) ⇒ Object 



112
113
114
115
116
117
118
119
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 112

def build_identity_for_user(user)
  # build_identity.tap do |identity|
  #   # this assumes there is an inverse relationship automatically created
  #   # such as user.identities would now contain this identity for the user
  #   identity.user = user
  # end
  build_identity(user: user)
end

#build_user(attributes = {}) ⇒ Object

USER



102
103
104
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 102

def build_user(attributes = {})
  @provider_user.build_record(attributes)
end

#find_identities_for_user(user) ⇒ Object

Query existing



54
55
56
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 54

def find_identities_for_user(user)
  @provider_identity.find_records(user_id: user.id)
end

#identities_exist? ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 63

def identities_exist?
  matched_identities.any?
end

#matched_identities ⇒ Object

Matched identities based on omniauth unique identifiers (provider, uid)



59
60
61
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 59

def matched_identities
  @matched_identities ||= @provider_identity.find_records
end

#matched_users ⇒ Object

Matched users based on omniauth unique identifiers (email)



76
77
78
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 76

def matched_users
  @matched_users ||= @provider_user.find_records
end

#multiple_identities? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 71

def multiple_identities?
  matched_identities.size > 1
end

#multiple_users? ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 88

def multiple_users?
  matched_users.size > 1
end

#single_identity ⇒ Object 



96
97
98
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 96

def single_identity
  @single_identity ||= matched_identities.first if single_identity?
end

#single_identity? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 67

def single_identity?
  matched_identities.size == 1
end

#single_user ⇒ Object 



92
93
94
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 92

def single_user
  @single_user ||= matched_users.first if single_user?
end

#single_user? ⇒ Boolean

Returns:

  • (Boolean) 


84
85
86
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 84

def single_user?
  matched_users.size == 1
end

#update_identity!(identity) ⇒ Object 



121
122
123
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 121

def update_identity!(identity)
  @provider_identity.update_record!(identity)
end

#users_exist? ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/trusty/omniauth/provider_mapper.rb', line 80

def users_exist?
  matched_users.any?
end