View Source Bonfire.Common.AntiSpam.Provider behaviour (Bonfire v0.9.10-classic-beta.156)

Provider Behaviour for anti-spam detection.

Supported backends

Credit to https://joinmobilizon.org for the original code.

result()

spam_result()

Check a comment (or microblog) details

Check an user details

Check an object details (such as a blog post)

Check a profile details

ready?()

Make sure the provider is ready

@type result() :: spam_result() | {:error, any()}

@type spam_result() :: :ham | :spam | :discard

@callback check_comment(
  comment_body :: String.t(),
  is_reply? :: boolean(),
  context :: any()
) :: result()

Check a comment (or microblog) details

@callback check_current_user(context :: any()) :: result()

Check an user details

@callback check_object(
  body :: String.t(),
  context :: any()
) :: result()

Check an object details (such as a blog post)

@callback check_profile(
  summary :: String.t(),
  context :: any()
) :: result()

Check a profile details

@callback ready?() :: boolean()

Make sure the provider is ready

@callback report_ham(user :: any(), text :: String.t() | nil) ::
  :ok | {:error, atom()} | {:error, HTTPoison.Response.t()}

@callback report_spam(user :: any(), text :: String.t() | nil) ::
  :ok | {:error, atom()} | {:error, HTTPoison.Response.t()}