Module: ActiveRecord::TokenFor::RelationMethods

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `::ActiveRecord::AssociationRelation`, `::ActiveRecord::Associations::CollectionProxy`, `::ActiveRecord::DisableJoinsAssociationRelation`, `::ActiveRecord::Relation`
Defined in:	activerecord/lib/active_record/token_for.rb

Instance Method Summary

#find_by_token_for(purpose, token)

Finds a record using a given token for a predefined purpose.
#find_by_token_for!(purpose, token)

Finds a record using a given token for a predefined purpose.

Instance Method Details

#find_by_token_for(purpose, token)

Finds a record using a given token for a predefined purpose. Returns nil if the token is invalid or the record was not found.

Raises:

(UnknownPrimaryKey)

[ GitHub ]

# File 'activerecord/lib/active_record/token_for.rb', line 41


def find_by_token_for(purpose, token)
  raise UnknownPrimaryKey.new(self) unless model.primary_key
  model.token_definitions.fetch(purpose).resolve_token(token) { |id| find_by(model.primary_key => [id]) }
end

#find_by_token_for!(purpose, token)

Finds a record using a given token for a predefined purpose. Raises ::ActiveSupport::MessageVerifier::InvalidSignature if the token is invalid (e.g. expired, bad format, etc). Raises ::ActiveRecord::RecordNotFound if the token is valid but the record was not found.

[ GitHub ]

# File 'activerecord/lib/active_record/token_for.rb', line 50


def find_by_token_for!(purpose, token)
  model.token_definitions.fetch(purpose).resolve_token(token) { |id| find(id) } ||
    (raise ActiveSupport::MessageVerifier::InvalidSignature)
end