View Source Pow.Ecto.Context (Pow v1.0.36)

Handles pow users context for user.

Usage

This module will be used by pow by default. If you wish to have control over context functions, you can do configure lib/my_project/users/users.ex the following way:

defmodule MyApp.Users do
  use Pow.Ecto.Context,
    repo: MyApp.Repo,
    user: MyApp.Users.User

  def create(params) do
    pow_create(params)
  end
end

Remember to update configuration with users_context: MyApp.Users.

The following Pow functions can be accessed:

pow_authenticate/1
pow_create/1
pow_update/2
pow_delete/1
pow_get_by/1

Configuration options

:repo - the ecto repo module (required)
:user - the user schema module (required)
:repo_opts - keyword list options for the repo, :prefix can be set here

Summary

Functions

authenticate(params, config)

Finds a user based on the user id, and verifies the password on the user.

create(params, config)

Creates a new user.

delete(user, config)

Deletes the user.

do_insert(changeset, config)

Inserts a changeset to the database.

do_update(changeset, config)

Updates a changeset in the database.

get_by(clauses, config)

Retrieves an user by the provided clauses.

repo(config) deprecated

See Pow.Config.repo!/1.

update(user, params, config)

Updates the user.

user_schema_mod(config) deprecated

See Pow.Config.user!/1.

Types

changeset()

@type changeset() :: Pow.Context.changeset()

user()

@type user() :: Pow.Context.user()

Functions

authenticate(params, config)

@spec authenticate(map(), Pow.Config.t()) :: user() | nil

Finds a user based on the user id, and verifies the password on the user.

User schema module and repo module will be fetched from the config. The user id field is fetched from the user schema module.

The function will return nil if either the fetched user or password is nil.

To prevent timing attacks, a blank user struct will be passed to the verify_password/2 function for the user schema module to ensure that the the response time will be equal as when a password is verified.

create(params, config)

@spec create(map(), Pow.Config.t()) :: {:ok, user()} | {:error, changeset()}

Creates a new user.

User schema module and repo module will be fetched from config.

delete(user, config)

@spec delete(user(), Pow.Config.t()) :: {:ok, user()} | {:error, changeset()}

Deletes the user.

Repo module will be fetched from the config.

do_insert(changeset, config)

@spec do_insert(changeset(), Pow.Config.t()) :: {:ok, user()} | {:error, changeset()}

Inserts a changeset to the database.

If succesful, the returned row will be reloaded from the database.

do_update(changeset, config)

@spec do_update(changeset(), Pow.Config.t()) :: {:ok, user()} | {:error, changeset()}

Updates a changeset in the database.

If succesful, the returned row will be reloaded from the database.

get_by(clauses, config)

@spec get_by(Keyword.t() | map(), Pow.Config.t()) :: user() | nil

Retrieves an user by the provided clauses.

User schema module and repo module will be fetched from the config.

repo(config)

This function is deprecated. Use `Pow.Config.repo!/1` instead.

See Pow.Config.repo!/1.

update(user, params, config)

@spec update(user(), map(), Pow.Config.t()) :: {:ok, user()} | {:error, changeset()}

Updates the user.

User schema module will be fetched from provided user and repo will be fetched from the config.

user_schema_mod(config)

This function is deprecated. Use `Pow.Config.user!/1` instead.

See Pow.Config.user!/1.