mobilizon/lib/service/notifier/notifier.ex
Thomas Citharel b5d9b82bdd
Refactor Mobilizon.Federation.ActivityPub and add typespecs
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2021-09-29 16:31:11 +02:00

33 lines
936 B
Elixir

defmodule Mobilizon.Service.Notifier do
@moduledoc """
Behaviour for notifiers
"""
alias Mobilizon.Activities.Activity
alias Mobilizon.Config
alias Mobilizon.Users.User
@doc """
Whether the notifier is enabled and configured
"""
@callback ready?() :: boolean()
@doc """
Sends one or multiple notifications from an activity
"""
@callback send(User.t(), Activity.t(), Keyword.t()) :: {:ok, any()} | {:error, String.t()}
@callback send(User.t(), list(Activity.t()), Keyword.t()) :: {:ok, any()} | {:error, String.t()}
@spec notify(User.t(), Activity.t(), Keyword.t()) :: :ok
def notify(%User{} = user, %Activity{} = activity, opts \\ []) do
Enum.each(providers(opts), & &1.send(user, activity, opts))
end
@spec providers(Keyword.t()) :: list()
defp providers(opts) do
opts
|> Keyword.get(:notifiers, Config.get([__MODULE__, :notifiers]))
|> Enum.filter(& &1.ready?())
end
end