Module: Devise::Models::Invitable::ClassMethods
- Defined in:
- lib/devise_invitable/model.rb
Instance Method Summary collapse
-
#_invite(attributes = {}, invited_by = nil, &block) ⇒ Object
Attempt to find a user by it’s 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.
-
#invitation_token ⇒ Object
Generate a token checking if one does not already exist in the database.
- #invite!(attributes = {}, invited_by = nil, &block) ⇒ Object
-
#invite_key_fields ⇒ Object
Return fields to invite.
- #invite_mail!(attributes = {}, invited_by = nil, &block) ⇒ Object
-
#inviter_role(inviter) ⇒ Object
Override this method if the invitable is using Mass Assignment Security and the inviter has a non-default role.
Instance Method Details
#_invite(attributes = {}, invited_by = nil, &block) ⇒ Object
Attempt to find a user by it’s email. If a record is not found, create a new user and send invitation to it. If user is found, returns the user with an email already exists error. If user is found and still have pending invitation, email is resend unless resend_invitation is set to false Attributes must contain the user email, other attributes will be set in the record
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/devise_invitable/model.rb', line 217 def _invite(attributes={}, invited_by=nil, &block) invite_key_array = invite_key_fields attributes_hash = {} invite_key_array.each do |k,v| attributes_hash[k] = attributes.delete(k).try(:strip) end invitable = find_or_initialize_with_errors(invite_key_array, attributes_hash) invitable.assign_attributes(attributes, :as => inviter_role(invited_by)) invitable.invited_by = invited_by invitable.skip_password = true invitable.valid? if self.validate_on_invite if invitable.new_record? invitable.errors.clear if !self.validate_on_invite and invitable.invite_key_valid? elsif !invitable.invited_to_sign_up? || !self.resend_invitation invite_key_array.each do |key| invitable.errors.add(key, :taken) end end if invitable.errors.empty? yield invitable if block_given? mail = invitable.invite! end [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
266 267 268 269 270 271 272 273 274 |
# File 'lib/devise_invitable/model.rb', line 266 def accept_invitation!(attributes={}) invitable = find_or_initialize_with_error_by(:invitation_token, attributes.delete(:invitation_token)) invitable.errors.add(:invitation_token, :invalid) if invitable.invitation_token && invitable.persisted? && !invitable.valid_invitation? if invitable.errors.empty? invitable.attributes = attributes invitable.accept_invitation! end invitable end |
#after_invitation_accepted(*args, &blk) ⇒ Object
286 287 288 |
# File 'lib/devise_invitable/model.rb', line 286 def after_invitation_accepted(*args, &blk) set_callback(:invitation_accepted, :after, *args, &blk) end |
#before_invitation_accepted(*args, &blk) ⇒ Object
Callback convenience methods
282 283 284 |
# File 'lib/devise_invitable/model.rb', line 282 def before_invitation_accepted(*args, &blk) set_callback(:invitation_accepted, :before, *args, &blk) end |
#invitation_token ⇒ Object
Generate a token checking if one does not already exist in the database.
277 278 279 |
# File 'lib/devise_invitable/model.rb', line 277 def invitation_token generate_token(:invitation_token) end |
#invite!(attributes = {}, invited_by = nil, &block) ⇒ Object
251 252 253 254 |
# File 'lib/devise_invitable/model.rb', line 251 def invite!(attributes={}, invited_by=nil, &block) invitable, mail = _invite(attributes, invited_by, &block) invitable end |
#invite_key_fields ⇒ Object
Return fields to invite
202 203 204 205 206 207 208 209 |
# File 'lib/devise_invitable/model.rb', line 202 def invite_key_fields if invite_key.is_a? Hash invite_key.keys else ActiveSupport::Deprecation.warn("invite_key should be a hash like {#{invite_key.inspect} => /.../}") Array(invite_key) end end |
#invite_mail!(attributes = {}, invited_by = nil, &block) ⇒ Object
256 257 258 259 |
# File 'lib/devise_invitable/model.rb', line 256 def invite_mail!(attributes={}, invited_by=nil, &block) invitable, mail = _invite(attributes, invited_by, &block) mail end |
#inviter_role(inviter) ⇒ Object
Override this method if the invitable is using Mass Assignment Security and the inviter has a non-default role.
247 248 249 |
# File 'lib/devise_invitable/model.rb', line 247 def inviter_role(inviter) :default end |