Amur.Provider behaviour (amur v0.3.4)

Behaviour for defining custom OAuth providers.

Example

defmodule MyApp.Auth.Discord do
  use Amur.Provider

  def strategy, do: Assent.Strategy.OAuth2

  def base_config do
    [
      base_url: "https://discord.com/api",
      authorization_endpoint: "/oauth2/authorize",
      token_endpoint: "/oauth2/token",
      user_endpoint: "/users/@me"
    ]
  end

  def normalize_user(user) do
    %{uid: user["id"], email: user["email"], name: user["username"]}
  end
end

Summary

Callbacks

base_config()

normalize_user(map)

strategy()

Functions

__using__(_)

Marks the using module as an Amur.Provider implementation.

Callbacks

base_config()

@callback base_config() :: keyword()

normalize_user(map)

@callback normalize_user(map()) :: map()

strategy()

@callback strategy() :: module()

Functions

using(_)

(macro)

Marks the using module as an Amur.Provider implementation.

This macro registers the behaviour callbacks without adding runtime functions, allowing the module to define its provider-specific strategy, configuration, and user normalization.