aaron_nad/cannery
1
0
Fork 0
forked from shibao/cannery
Code Pull Requests Activity

fix dialyzer, credo and format

Browse Source
This commit is contained in:
shibao
2022-01-22 21:40:29 -05:00
parent f5b3eb4a5e
commit 04d798aaa7
39 changed files with 331 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
lib/cannery/accounts/user.ex
View File

@ -1,8 +1,12 @@
defmodule Cannery.Accounts.User do
@moduledoc """
A cannery user
"""
use Ecto.Schema
import Ecto.Changeset
alias Cannery.Accounts.{User}
alias Cannery.Invites.{Invite}
alias Ecto.{Changeset, UUID}
alias Cannery.{Accounts.User, Invites.Invite}
@derive {Inspect, except: [:password]}
@primary_key {:id, :binary_id, autogenerate: true}
@ -19,8 +23,8 @@ defmodule Cannery.Accounts.User do
timestamps()
end
@type t :: %{
id: Ecto.UUID.t(),
@type t :: %User{
id: UUID.t(),
email: String.t(),
password: String.t(),
hashed_password: String.t(),
@ -31,6 +35,8 @@ defmodule Cannery.Accounts.User do
updated_at: NaiveDateTime.t()
}
@type new_user :: %User{}
@doc """
A user changeset for registration.
@ -48,8 +54,8 @@ defmodule Cannery.Accounts.User do
validations on a LiveView form), this option can be set to `false`.
Defaults to `true`.
"""
@spec registration_changeset(User.t(), map()) :: Ecto.Changeset.t()
@spec registration_changeset(User.t(), map(), keyword()) :: Ecto.Changeset.t()
@spec registration_changeset(User.t() | User.new_user(), map()) :: Changeset.t()
@spec registration_changeset(User.t() | User.new_user(), map(), keyword()) :: Changeset.t()
def registration_changeset(user, attrs, opts \\ []) do
user
|> cast(attrs, [:email, :password, :role])
@ -61,12 +67,12 @@ defmodule Cannery.Accounts.User do
A user changeset for role.
"""
@spec role_changeset(User.t(), atom()) :: Ecto.Changeset.t()
@spec role_changeset(User.t(), atom()) :: Changeset.t()
def role_changeset(user, role) do
user |> cast(%{"role" => role}, [:role])
end
@spec validate_email(Ecto.Changeset.t()) :: Ecto.Changeset.t()
@spec validate_email(Changeset.t()) :: Changeset.t()
defp validate_email(changeset) do
changeset
|> validate_required([:email])
@ -76,7 +82,7 @@ defmodule Cannery.Accounts.User do
|> unique_constraint(:email)
end
@spec validate_password(Ecto.Changeset.t(), keyword()) :: Ecto.Changeset.t()
@spec validate_password(Changeset.t(), keyword()) :: Changeset.t()
defp validate_password(changeset, opts) do
changeset
|> validate_required([:password])
@ -87,7 +93,7 @@ defmodule Cannery.Accounts.User do
|> maybe_hash_password(opts)
end
@spec maybe_hash_password(Ecto.Changeset.t(), keyword()) :: Ecto.Changeset.t()
@spec maybe_hash_password(Changeset.t(), keyword()) :: Changeset.t()
defp maybe_hash_password(changeset, opts) do
hash_password? = Keyword.get(opts, :hash_password, true)
password = get_change(changeset, :password)
@ -106,7 +112,7 @@ defmodule Cannery.Accounts.User do
It requires the email to change otherwise an error is added.
"""
@spec email_changeset(User.t(), map()) :: Ecto.Changeset.t()
@spec email_changeset(User.t(), map()) :: Changeset.t()
def email_changeset(user, attrs) do
user
|> cast(attrs, [:email])
@ -129,8 +135,8 @@ defmodule Cannery.Accounts.User do
validations on a LiveView form), this option can be set to `false`.
Defaults to `true`.
"""
@spec password_changeset(User.t(), map()) :: Ecto.Changeset.t()
@spec password_changeset(User.t(), map(), keyword()) :: Ecto.Changeset.t()
@spec password_changeset(User.t(), map()) :: Changeset.t()
@spec password_changeset(User.t(), map(), keyword()) :: Changeset.t()
def password_changeset(user, attrs, opts \\ []) do
user
|> cast(attrs, [:password])
@ -141,10 +147,10 @@ defmodule Cannery.Accounts.User do
@doc """
Confirms the account by setting `confirmed_at`.
"""
@spec confirm_changeset(User.t()) :: Ecto.Changeset.t()
def confirm_changeset(user) do
@spec confirm_changeset(User.t() | Changeset.t()) :: Changeset.t()
def confirm_changeset(user_or_changeset) do
now = NaiveDateTime.utc_now() |> NaiveDateTime.truncate(:second)
change(user, confirmed_at: now)
user_or_changeset |> change(confirmed_at: now)
end
@doc """
@ -167,12 +173,10 @@ defmodule Cannery.Accounts.User do
@doc """
Validates the current password otherwise adds an error to the changeset.
"""
@spec validate_current_password(Ecto.Changeset.t(), String.t()) :: Ecto.UUID.t()
@spec validate_current_password(Changeset.t(), String.t()) :: Changeset.t()
def validate_current_password(changeset, password) do
if valid_password?(changeset.data, password) do
changeset
else
add_error(changeset, :current_password, "is not valid")
end
if valid_password?(changeset.data, password),
do: changeset,
else: changeset |> add_error(:current_password, "is not valid")
end
end

4
lib/cannery/accounts/user_notifier.ex
View File

@ -1,4 +1,8 @@
defmodule Cannery.Accounts.UserNotifier do
@moduledoc """
Contains all user emails and notifications
"""
# For simplicity, this module simply logs messages to the terminal.
# You should replace it by a proper email or notification tool, such as:
#

48
lib/cannery/accounts/user_token.ex
View File

@ -1,7 +1,12 @@
defmodule Cannery.Accounts.UserToken do
@moduledoc """
Schema for serialized user session and authentication tokens
"""
use Ecto.Schema
import Ecto.Query
alias Cannery.{Accounts}
alias Ecto.{Query, UUID}
alias Cannery.{Accounts.User, Accounts.UserToken}
@hash_algorithm :sha256
@rand_size 32
@ -19,19 +24,33 @@ defmodule Cannery.Accounts.UserToken do
field :token, :binary
field :context, :string
field :sent_to, :string
belongs_to :user, Accounts.User
belongs_to :user, User
timestamps(updated_at: false)
end
@type t :: %UserToken{
id: UUID.t(),
token: String.t(),
context: String.t(),
sent_to: String.t(),
user: User.t(),
user_id: UUID.t(),
inserted_at: NaiveDateTime.t()
}
@type new_token :: %UserToken{}
@doc """
Generates a token that will be stored in a signed place,
such as session or cookie. As they are signed, those
tokens do not need to be hashed.
"""
def build_session_token(user) do
@spec build_session_token(User.t()) :: {token :: String.t(), UserToken.new_token()}
def build_session_token(%{id: user_id}) do
token = :crypto.strong_rand_bytes(@rand_size)
{token, %Accounts.UserToken{token: token, context: "session", user_id: user.id}}
{token, %UserToken{token: token, context: "session", user_id: user_id}}
end
@doc """
@ -39,6 +58,7 @@ defmodule Cannery.Accounts.UserToken do
The query returns the user found by the token.
"""
@spec verify_session_token_query(String.t()) :: {:ok, Query.t()}
def verify_session_token_query(token) do
query =
from token in token_and_context_query(token, "session"),
@ -57,16 +77,19 @@ defmodule Cannery.Accounts.UserToken do
The token is valid for a week as long as users don't change
their email.
"""
@spec build_email_token(User.t(), String.t()) :: {String.t(), UserToken.new_token()}
def build_email_token(user, context) do
build_hashed_token(user, context, user.email)
end
@spec build_hashed_token(User.t(), String.t(), String.t()) ::
{String.t(), UserToken.new_token()}
defp build_hashed_token(user, context, sent_to) do
token = :crypto.strong_rand_bytes(@rand_size)
hashed_token = :crypto.hash(@hash_algorithm, token)
{Base.url_encode64(token, padding: false),
%Accounts.UserToken{
%UserToken{
token: hashed_token,
context: context,
sent_to: sent_to,
@ -79,6 +102,7 @@ defmodule Cannery.Accounts.UserToken do
The query returns the user found by the token.
"""
@spec verify_email_token_query(String.t(), String.t()) :: {:ok, Query.t()} | :error
def verify_email_token_query(token, context) do
case Base.url_decode64(token, padding: false) do
{:ok, decoded_token} ->
@ -98,6 +122,7 @@ defmodule Cannery.Accounts.UserToken do
end
end
@spec days_for_context(<<_::56>>) :: non_neg_integer()
defp days_for_context("confirm"), do: @confirm_validity_in_days
defp days_for_context("reset_password"), do: @reset_password_validity_in_days
@ -106,6 +131,7 @@ defmodule Cannery.Accounts.UserToken do
The query returns the user token record.
"""
@spec verify_change_email_token_query(String.t(), String.t()) :: {:ok, Query.t()} | :error
def verify_change_email_token_query(token, context) do
case Base.url_decode64(token, padding: false) do
{:ok, decoded_token} ->
@ -125,18 +151,20 @@ defmodule Cannery.Accounts.UserToken do
@doc """
Returns the given token with the given context.
"""
@spec token_and_context_query(String.t(), String.t()) :: Query.t()
@spec token_and_context_query(User.t(), :all | nonempty_maybe_improper_list()) :: Query.t()
def token_and_context_query(token, context) do
from Accounts.UserToken, where: [token: ^token, context: ^context]
from UserToken, where: [token: ^token, context: ^context]
end
@doc """
Gets all tokens for the given user for the given contexts.
"""
def user_and_contexts_query(user, :all) do
from t in Accounts.UserToken, where: t.user_id == ^user.id
def user_and_contexts_query(%{id: user_id}, :all) do
from t in UserToken, where: t.user_id == ^user_id
end
def user_and_contexts_query(user, [_ | _] = contexts) do
from t in Accounts.UserToken, where: t.user_id == ^user.id and t.context in ^contexts
def user_and_contexts_query(%{id: user_id}, [_ | _] = contexts) do
from t in UserToken, where: t.user_id == ^user_id and t.context in ^contexts
end
end