Class: Decidim::User

Inherits:
UserBaseEntity show all
Includes:
ActsAsAuthor, DataPortability, Searchable
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.



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

def invitation_instructions
  @invitation_instructions
end

#newsletter_notifications ⇒ Object

Returns the value of attribute newsletter_notifications.



70
71
72
 
# File 'app/models/decidim/user.rb', line 70

def newsletter_notifications
  @newsletter_notifications
end

Class Method Details

.data_portability_images(user) ⇒ Object 



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

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

.export_serializer ⇒ Object 



176
177
178
 
# File 'app/models/decidim/user.rb', line 176

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.



164
165
166
167
168
169
170
 
# File 'app/models/decidim/user.rb', line 164

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) 


95
96
97
 
# File 'app/models/decidim/user.rb', line 95

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 



105
106
107
 
# File 'app/models/decidim/user.rb', line 105

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

.user_collection(user) ⇒ Object 



172
173
174
 
# File 'app/models/decidim/user.rb', line 172

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



224
225
226
 
# File 'app/models/decidim/user.rb', line 224

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

#accepts_conversation?(user) ⇒ Boolean

Public: whether the user accepts direct messages from another

Returns:

  • (Boolean) 


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

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



120
121
122
 
# File 'app/models/decidim/user.rb', line 120

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

#admin_terms_accepted? ⇒ Boolean

Returns:

  • (Boolean) 


194
195
196
 
# File 'app/models/decidim/user.rb', line 194

def admin_terms_accepted?
  return true if admin_terms_accepted_at
end

#authenticatable_salt ⇒ Object 



233
234
235
 
# File 'app/models/decidim/user.rb', line 233

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

#being_impersonated? ⇒ Boolean

Returns:

  • (Boolean) 


203
204
205
 
# File 'app/models/decidim/user.rb', line 203

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

#data_portability_file(filename) ⇒ Object

Caches a Decidim::DataPortabilityUploader with the retrieved file.



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

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) 


130
131
132
 
# File 'app/models/decidim/user.rb', line 130

def deleted?
  deleted_at.present?
end

#follows?(followable) ⇒ Boolean

Returns:

  • (Boolean) 


139
140
141
 
# File 'app/models/decidim/user.rb', line 139

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

#interested_scopes ⇒ Object 



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

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

#interested_scopes_ids ⇒ Object 



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

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

#invalidate_all_sessions! ⇒ Object 



237
238
239
240
 
# File 'app/models/decidim/user.rb', line 237

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

#manageable_user_groups ⇒ Object

return the groups where this user has admin permissions



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

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

#name ⇒ Object

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



125
126
127
 
# File 'app/models/decidim/user.rb', line 125

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

#officialized? ⇒ Boolean

Public: whether the user has been officialized or not

Returns:

  • (Boolean) 


135
136
137
 
# File 'app/models/decidim/user.rb', line 135

def officialized?
  !officialized_at.nil?
end

#presenter ⇒ Object

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



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

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) 


115
116
117
 
# File 'app/models/decidim/user.rb', line 115

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

#tos_accepted? ⇒ Boolean

Returns:

  • (Boolean) 


184
185
186
187
188
189
190
191
192
 
# File 'app/models/decidim/user.rb', line 184

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 



150
151
152
 
# File 'app/models/decidim/user.rb', line 150

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

#unread_messages_count ⇒ Object 



154
155
156
 
# File 'app/models/decidim/user.rb', line 154

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

#user_invited? ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
 
# File 'app/models/decidim/user.rb', line 83

def user_invited?
  invitation_token_changed? && invitation_accepted_at_changed?
end

#verifiable? ⇒ Boolean

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

Returns:

  • (Boolean) 


199
200
201
 
# File 'app/models/decidim/user.rb', line 199

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