@spec confirm!(Ecto.Schema.t()) :: schema_or_error()

Confirm a user account.

Adds the :confirmed_at datetime field on the user model and updates the database

@spec deactivate_user(conn()) :: conn()

Deactivate a user.

Removes all logged in sessions for a user.

@spec expired?(
  nil | struct(),
  keyword()
) :: boolean()

Test if a datetime has expired.

Convert the datetime from NaiveDateTime format to Timex format to do the comparison given the time during in opts.

Examples

expired?(user.expire_at, days: 5)
expired?(user.expire_at, minutes: 10)

iex> NaiveDateTime.utc_now()
...> |> Coherence.Controller.expired?(days: 1)
false

iex> NaiveDateTime.utc_now()
...> |> Coherence.Controller.shift(days: -2)
...> |> Coherence.Controller.expired?(days: 1)
true

@spec layout_view(
  Plug.Conn.t(),
  keyword()
) :: Plug.Conn.t()

Put LayoutView

Adds Config.layout if set.

@spec lock!(
  Ecto.Schema.t(),
  struct()
) :: schema_or_error()

Lock a use account.

Sets the :locked_at field on the user model to the current date and time unless provided a value for the optional parameter.

You can provide a date in the future to override the configured lock expiry time. You can set this data far in the future to do a pseudo permanent lock.

@spec lockable_failure(Ecto.Changeset.t()) :: :ok

Log an error message when lockable update fails.

@spec logged_in_url(Plug.Conn.t()) :: String.t()

Get the configured logged_in_url.

@spec logged_out_url(Plug.Conn.t()) :: String.t()

Get the configured logged_out_url.

@spec login_user(conn(), schema(), params()) :: conn()

Login a user.

Logs in a user and redirects them to the session_create page.

@spec logout_user(
  conn(),
  keyword()
) :: conn()

Logout a user.

Logs out a user and redirects them to the session_delete page.

@spec permit(map(), []) :: map()

leaves in params only permitted request parameters.

Same as Rails permit, prevents mass assignment attacks.

@spec random_string(integer()) :: binary()

Get a random string of given length.

Returns a random url safe encoded64 string of the given length. Used to generate tokens for the various modules that require unique tokens.

@spec redirect_logged_in(conn(), any()) :: conn()

Plug to redirect already logged in users.

@spec router_helpers() :: module()

Get the Router.Helpers module for the project..

Returns the projects Router.Helpers module.

@spec send_confirmation(Plug.Conn.t(), Ecto.Schema.t(), module()) :: Plug.Conn.t()

Send confirmation email with token.

If the user supports confirmable, generate a token and send the email.

Sends an email if the mailer is properly configured and add the appropriate flash.

@spec send_user_email(atom(), Ecto.Schema.t(), String.t()) :: any()

Send a user email.

Sends a user email given the module, model, and url. Logs the email for debug purposes.

Note: This function uses an apply to avoid compile warnings if the mailer is not selected as an option.

@spec set_view(
  Plug.Conn.t(),
  keyword()
) :: Plug.Conn.t()

Set view plug

@spec shift(struct(), keyword()) :: struct()

Shift a NaiveDateTime.

Examples

iex> ~N(2016-10-10 10:10:10)
...> |> Coherence.Controller.shift(days: -2)
...> |> to_string
"2016-10-08 10:10:10Z"

@spec unlock!(Ecto.Schema.t()) :: schema_or_error()

Unlock a user account.

Clears the :locked_at field on the user model and updates the database.