Class: Decidim::User

Inherits:
UserBaseEntity show all
Includes:
ActsAsAuthor, DataPortability, Searchable, Traceable, UserReportable
Defined in:
app/models/decidim/user.rb

Overview

A User is a citizen that wants to join the platform to participate.

Defined Under Namespace

Classes: Roles

Constant Summary

Constants inherited from UserBaseEntity

Decidim::UserBaseEntity::REGEXP_NAME

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Searchable

searchable_resources, searchable_resources_of_type_comment, searchable_resources_of_type_component, searchable_resources_of_type_participant, searchable_resources_of_type_participatory_space

Methods inherited from UserBaseEntity

#following

Methods included from HasUploadValidations

#maximum_avatar_size, #maximum_upload_size

Methods included from Followable

#followers

Instance Attribute Details

#invitation_instructions ⇒ Object

Public: Allows customizing the invitation instruction email content when inviting a user.

Returns a String.



98
99
100
 
# File 'app/models/decidim/user.rb', line 98

def invitation_instructions
  @invitation_instructions
end

#newsletter_notifications ⇒ Object

Returns the value of attribute newsletter_notifications.



77
78
79
 
# File 'app/models/decidim/user.rb', line 77

def newsletter_notifications
  @newsletter_notifications
end

Class Method Details

.data_portability_images(user) ⇒ Object 



187
188
189
 
# File 'app/models/decidim/user.rb', line 187

def self.data_portability_images(user)
  user_collection(user).map(&:avatar)
end

.export_serializer ⇒ Object 



183
184
185
 
# File 'app/models/decidim/user.rb', line 183

def self.export_serializer
  Decidim::DataPortabilitySerializers::DataPortabilityUserSerializer
end

.find_for_authentication(warden_conditions) ⇒ Object

Check if the user exists with the given email and the current organization

warden_conditions - A hash with the authentication conditions

* email - a String that represents user's email.
* env - A Hash containing environment variables.

Returns a User.



171
172
173
174
175
176
177
 
# File 'app/models/decidim/user.rb', line 171

def self.find_for_authentication(warden_conditions)
  organization = warden_conditions.dig(:env, "decidim.current_organization")
  find_by(
    email: warden_conditions[:email].to_s.downcase,
    decidim_organization_id: organization.id
  )
end

.has_pending_invitations?(organization_id, email) ⇒ Boolean

Returns the user corresponding to the given email if it exists and has pending invitations,

otherwise returns nil.

Returns:

  • (Boolean) 


102
103
104
 
# File 'app/models/decidim/user.rb', line 102

def self.has_pending_invitations?(organization_id, email)
  invitation_not_accepted.find_by(decidim_organization_id: organization_id, email: email)
end

.log_presenter_class_for(_log) ⇒ Object 



112
113
114
 
# File 'app/models/decidim/user.rb', line 112

def self.log_presenter_class_for(_log)
  Decidim::AdminLog::UserPresenter
end

.user_collection(user) ⇒ Object 



179
180
181
 
# File 'app/models/decidim/user.rb', line 179

def self.user_collection(user)
  where(id: user.id)
end

Instance Method Details

#accepted_user_groups ⇒ Object

return the groups where this user has been accepted



235
236
237
 
# File 'app/models/decidim/user.rb', line 235

def accepted_user_groups
  UserGroups::AcceptedUserGroups.for(self)
end

#accepts_conversation?(user) ⇒ Boolean

Public: whether the user accepts direct messages from another

Returns:

  • (Boolean) 


151
152
153
154
155
 
# File 'app/models/decidim/user.rb', line 151

def accepts_conversation?(user)
  return follows?(user) if direct_message_types == "followed-only"

  true
end

#active_role ⇒ Object

Public: Returns the active role of the user



127
128
129
 
# File 'app/models/decidim/user.rb', line 127

def active_role
  admin ? "admin" : roles.first
end

#admin_terms_accepted? ⇒ Boolean

Returns:

  • (Boolean) 


201
202
203
 
# File 'app/models/decidim/user.rb', line 201

def admin_terms_accepted?
  return true if admin_terms_accepted_at
end

#authenticatable_salt ⇒ Object 



244
245
246
 
# File 'app/models/decidim/user.rb', line 244

def authenticatable_salt
  "#{super}#{session_token}"
end

#being_impersonated? ⇒ Boolean

Returns:

  • (Boolean) 


210
211
212
 
# File 'app/models/decidim/user.rb', line 210

def being_impersonated?
  ImpersonationLog.active.exists?(user: self)
end

#data_portability_file(filename) ⇒ Object

Caches a Decidim::DataPortabilityUploader with the retrieved file.



227
228
229
230
231
232
 
# File 'app/models/decidim/user.rb', line 227

def data_portability_file(filename)
  @data_portability_file ||= DataPortabilityUploader.new(self).tap do |uploader|
    uploader.retrieve_from_store!(filename)
    uploader.cache!(filename)
  end
end

#deleted? ⇒ Boolean

Check if the user account has been deleted or not

Returns:

  • (Boolean) 


137
138
139
 
# File 'app/models/decidim/user.rb', line 137

def deleted?
  deleted_at.present?
end

#follows?(followable) ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
 
# File 'app/models/decidim/user.rb', line 146

def follows?(followable)
  Decidim::Follow.where(user: self, followable: followable).any?
end

#interested_scopes ⇒ Object 



218
219
220
 
# File 'app/models/decidim/user.rb', line 218

def interested_scopes
  @interested_scopes ||= organization.scopes.where(id: interested_scopes_ids)
end

#interested_scopes_ids ⇒ Object 



214
215
216
 
# File 'app/models/decidim/user.rb', line 214

def interested_scopes_ids
  extended_data["interested_scopes"] || []
end

#invalidate_all_sessions! ⇒ Object 



248
249
250
251
 
# File 'app/models/decidim/user.rb', line 248

def invalidate_all_sessions!
  self.session_token = SecureRandom.hex
  save!
end

#manageable_user_groups ⇒ Object

return the groups where this user has admin permissions



240
241
242
 
# File 'app/models/decidim/user.rb', line 240

def manageable_user_groups
  UserGroups::ManageableUserGroups.for(self)
end

#name ⇒ Object

Public: returns the user’s name or the default one



132
133
134
 
# File 'app/models/decidim/user.rb', line 132

def name
  super || I18n.t("decidim.anonymous_user")
end

#officialized? ⇒ Boolean

Public: whether the user has been officialized or not

Returns:

  • (Boolean) 


142
143
144
 
# File 'app/models/decidim/user.rb', line 142

def officialized?
  !officialized_at.nil?
end

#presenter ⇒ Object

Returns the presenter for this author, to be used in the views. Required by ActsAsAuthor.



108
109
110
 
# File 'app/models/decidim/user.rb', line 108

def presenter
  Decidim::UserPresenter.new(self)
end

#role?(role) ⇒ Boolean

Checks if the user has the given ‘role` or not.

role - a String or a Symbol that represents the role that is being

checked

Returns a boolean.

Returns:

  • (Boolean) 


122
123
124
 
# File 'app/models/decidim/user.rb', line 122

def role?(role)
  roles.include?(role.to_s)
end

#tos_accepted? ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
194
195
196
197
198
199
 
# File 'app/models/decidim/user.rb', line 191

def tos_accepted?
  return true if managed
  return false if accepted_tos_version.nil?

  # For some reason, if we don't use `#to_i` here we get some
  # cases where the comparison returns false, but calling `#to_i` returns
  # the same number :/
  accepted_tos_version.to_i >= organization.tos_version.to_i
end

#unread_conversations ⇒ Object 



157
158
159
 
# File 'app/models/decidim/user.rb', line 157

def unread_conversations
  Decidim::Messaging::Conversation.unread_by(self)
end

#unread_messages_count ⇒ Object 



161
162
163
 
# File 'app/models/decidim/user.rb', line 161

def unread_messages_count
  @unread_messages_count ||= Decidim::Messaging::Receipt.unread_count(self)
end

#user_invited? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'app/models/decidim/user.rb', line 90

def user_invited?
  invitation_token_changed? && invitation_accepted_at_changed?
end

#user_name ⇒ Object 



222
223
224
 
# File 'app/models/decidim/user.rb', line 222

def user_name
  extended_data["user_name"] || name
end

#verifiable? ⇒ Boolean

Whether this user can be verified against some authorization or not.

Returns:

  • (Boolean) 


206
207
208
 
# File 'app/models/decidim/user.rb', line 206

def verifiable?
  confirmed? || managed? || being_impersonated?
end