Module: Devise::Models::Invitable::ClassMethods
- Defined in:
- lib/devise_invitable/model.rb
Instance Method Summary collapse
-
#_invite(attributes = {}, invited_by = nil) {|invitable| ... } ⇒ Object
Attempt to find a user by its email.
-
#accept_invitation!(attributes = {}) ⇒ Object
Attempt to find a user by it’s invitation_token to set it’s password.
- #after_invitation_accepted(*args, &blk) ⇒ Object
-
#before_invitation_accepted(*args, &blk) ⇒ Object
Callback convenience methods.
- #find_by_invitation_token(original_token, only_valid) ⇒ Object
- #invite!(attributes = {}, invited_by = nil, &block) ⇒ Object
-
#invite_key_fields ⇒ Object
Return fields to invite.
- #invite_mail!(attributes = {}, invited_by = nil, &block) ⇒ Object
Instance Method Details
#_invite(attributes = {}, invited_by = nil) {|invitable| ... } ⇒ Object
Attempt to find a user by its email. If a record is not found, create a new user and send an invitation to it. If the user is found, return the user with an email already exists error. If the user is found and still has a pending invitation, invitation email is resent unless resend_invitation is set to false. Attributes must contain the user’s email, other attributes will be set in the record
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/devise_invitable/model.rb', line 245 def _invite(attributes={}, invited_by=nil, &block) invite_key_array = invite_key_fields attributes_hash = {} invite_key_array.each do |k,v| attribute = attributes.delete(k) attribute = attribute.to_s.strip if strip_whitespace_keys.include?(k) attributes_hash[k] = attribute end invitable = find_or_initialize_with_errors(invite_key_array, attributes_hash) invitable.assign_attributes(attributes) invitable.invited_by = invited_by unless invitable.password invitable.password = Devise.friendly_token[0, 20] end invitable.valid? if self.validate_on_invite if invitable.new_record? invitable.clear_errors_on_valid_keys if !self.validate_on_invite elsif !invitable.invited_to_sign_up? || !self.resend_invitation invite_key_array.each do |key| invitable.errors.add(key, :taken) end end yield invitable if block_given? mail = invitable.invite! if invitable.errors.empty? [invitable, mail] end |
#accept_invitation!(attributes = {}) ⇒ Object
Attempt to find a user by it’s invitation_token to set it’s password. If a user is found, reset it’s password and automatically try saving the record. If not user is found, returns a new user containing an error in invitation_token attribute. Attributes must contain invitation_token, password and confirmation
288 289 290 291 292 293 294 295 296 |
# File 'lib/devise_invitable/model.rb', line 288 def accept_invitation!(attributes={}) original_token = attributes.delete(:invitation_token) invitable = find_by_invitation_token(original_token, false) if invitable.errors.empty? invitable.assign_attributes(attributes) invitable.accept_invitation! end invitable end |
#after_invitation_accepted(*args, &blk) ⇒ Object
311 312 313 |
# File 'lib/devise_invitable/model.rb', line 311 def after_invitation_accepted(*args, &blk) set_callback(:invitation_accepted, :after, *args, &blk) end |
#before_invitation_accepted(*args, &blk) ⇒ Object
Callback convenience methods
307 308 309 |
# File 'lib/devise_invitable/model.rb', line 307 def before_invitation_accepted(*args, &blk) set_callback(:invitation_accepted, :before, *args, &blk) end |
#find_by_invitation_token(original_token, only_valid) ⇒ Object
298 299 300 301 302 303 304 |
# File 'lib/devise_invitable/model.rb', line 298 def find_by_invitation_token(original_token, only_valid) invitation_token = Devise.token_generator.digest(self, :invitation_token, original_token) invitable = find_or_initialize_with_error_by(:invitation_token, invitation_token) invitable.errors.add(:invitation_token, :invalid) if invitable.invitation_token && invitable.persisted? && !invitable.valid_invitation? invitable unless only_valid && invitable.errors.present? end |
#invite!(attributes = {}, invited_by = nil, &block) ⇒ Object
275 276 277 |
# File 'lib/devise_invitable/model.rb', line 275 def invite!(attributes={}, invited_by=nil, &block) _invite(attributes.with_indifferent_access, invited_by, &block).first end |
#invite_key_fields ⇒ Object
Return fields to invite
234 235 236 |
# File 'lib/devise_invitable/model.rb', line 234 def invite_key_fields invite_key.keys end |
#invite_mail!(attributes = {}, invited_by = nil, &block) ⇒ Object
279 280 281 |
# File 'lib/devise_invitable/model.rb', line 279 def invite_mail!(attributes={}, invited_by=nil, &block) _invite(attributes, invited_by, &block).last end |