cannery/lib/cannery/invites.ex

168 lines
3.8 KiB
Elixir
Raw Normal View History

2021-09-10 00:23:26 -04:00
defmodule Cannery.Invites do
@moduledoc """
The Invites context.
"""
import Ecto.Query, warn: false
alias Cannery.{Accounts, Repo}
alias Cannery.Invites.Invite
@invite_token_length 20
@doc """
Returns the list of invites.
## Examples
iex> list_invites()
[%Invite{}, ...]
"""
2021-09-11 18:17:42 -04:00
@spec list_invites() :: [Invite.t()]
2021-09-10 00:23:26 -04:00
def list_invites, do: Repo.all(Invite)
@doc """
Gets a single invite.
Raises `Ecto.NoResultsError` if the Invite does not exist.
## Examples
iex> get_invite!(123)
%Invite{}
iex> get_invite!(456)
** (Ecto.NoResultsError)
"""
2021-09-11 18:17:42 -04:00
@spec get_invite!(Ecto.UUID.t()) :: Invite.t()
2021-09-10 00:23:26 -04:00
def get_invite!(id), do: Repo.get!(Invite, id)
@doc """
Returns a valid invite or nil based on the attempted token
## Examples
iex> get_invite_by_token("valid_token")
%Invite{}
iex> get_invite_by_token("invalid_token")
nil
"""
@spec get_invite_by_token(String.t()) :: Invite.t() | nil
def get_invite_by_token(nil), do: nil
def get_invite_by_token(""), do: nil
def get_invite_by_token(token) do
Repo.one(
from i in Invite,
where: i.token == ^token and i.disabled_at |> is_nil()
)
end
2021-09-10 00:23:26 -04:00
@doc """
Uses invite by decrementing uses_left, or marks invite invalid if it's been
completely used.
2021-09-10 00:23:26 -04:00
"""
@spec use_invite!(Invite.t()) :: Invite.t()
def use_invite!(%Invite{uses_left: nil} = invite), do: invite
2021-09-10 00:23:26 -04:00
def use_invite!(%Invite{uses_left: uses_left} = invite) do
new_uses_left = uses_left - 1
attrs =
if new_uses_left <= 0 do
now = NaiveDateTime.utc_now() |> NaiveDateTime.truncate(:second)
%{"uses_left" => 0, "disabled_at" => now}
else
%{"uses_left" => new_uses_left}
end
invite |> Invite.changeset(attrs) |> Repo.update!()
end
@doc """
Creates a invite.
## Examples
iex> create_invite(%Accounts.User{id: "1"}, %{field: value})
{:ok, %Invite{}}
iex> create_invite("1", %{field: value})
{:ok, %Invite{}}
iex> create_invite(%Accounts.User{id: "1"}, %{field: bad_value})
{:error, %Ecto.Changeset{}}
"""
2022-01-22 17:21:13 -05:00
@spec create_invite(user_or_user_id :: Accounts.User.t() | Ecto.UUID.t(), attrs :: map()) ::
Invite.t()
2021-09-11 18:17:42 -04:00
def create_invite(%{id: user_id}, attrs) do
2021-09-10 00:23:26 -04:00
create_invite(user_id, attrs)
end
def create_invite(user_id, attrs) when not (user_id |> is_nil()) do
attrs =
attrs
|> Map.merge(%{
"user_id" => user_id,
"token" =>
:crypto.strong_rand_bytes(@invite_token_length)
|> Base.url_encode64()
|> binary_part(0, @invite_token_length)
2021-09-10 00:23:26 -04:00
})
%Invite{} |> Invite.changeset(attrs) |> Repo.insert()
end
@doc """
Updates a invite.
## Examples
iex> update_invite(invite, %{field: new_value})
{:ok, %Invite{}}
iex> update_invite(invite, %{field: bad_value})
{:error, %Ecto.Changeset{}}
"""
2021-09-11 18:17:42 -04:00
@spec update_invite(Invite.t(), map()) :: {:ok, Invite.t()} | {:error, Ecto.Changeset.t()}
def update_invite(invite, attrs) do
invite |> Invite.changeset(attrs) |> Repo.update()
2021-09-10 00:23:26 -04:00
end
@doc """
Deletes a invite.
## Examples
iex> delete_invite(invite)
{:ok, %Invite{}}
iex> delete_invite(invite)
{:error, %Ecto.Changeset{}}
"""
2021-09-11 18:17:42 -04:00
@spec delete_invite(Invite.t()) :: {:ok, Invite.t()} | {:error, Ecto.Changeset.t()}
def delete_invite(invite) do
2021-09-10 00:23:26 -04:00
Repo.delete(invite)
end
@doc """
Returns an `%Ecto.Changeset{}` for tracking invite changes.
## Examples
iex> change_invite(invite)
%Ecto.Changeset{data: %Invite{}}
"""
2021-09-11 18:17:42 -04:00
@spec change_invite(Invite.t()) :: Ecto.Changeset.t()
@spec change_invite(Invite.t(), map()) :: Ecto.Changeset.t()
def change_invite(invite, attrs \\ %{}) do
2021-09-10 00:23:26 -04:00
Invite.changeset(invite, attrs)
end
end