View Source Assent.Strategy behaviour (Assent v0.3.0)

Used for creating strategies.

Usage

Set up my_strategy.ex the following way:

defmodule MyStrategy do
  @behaviour Assent.Strategy

  alias Assent.Strategy, as: Helpers

  def authorize_url(config) do
    # Generate redirect URL

    {:ok, %{url: url, ...}}
  end

  def callback(config, params) do
    # Fetch user data

    user = Helpers.normalize_userinfo(userinfo)

    {:ok, %{user: user, ...}}
  end
end

Summary

Callbacks

authorize_url(t)
callback(t, map)

Functions

decode_json(response, config)

Decode a JSON string.

http_request(method, url, body, headers, config)

Makes a HTTP request.

normalize_userinfo(claims, extra \\ %{})

Normalize API user request response into standard claims.

sign_jwt(claims, alg, secret, config)

Signs a JSON Web Token.

to_url(base_url, uri, params \\ [])

Generates a URL.

verify_jwt(token, secret, config)

Verifies a JSON Web Token.

Callbacks

authorize_url(t)

@callback authorize_url(Keyword.t()) ::
  {:ok, %{:url => binary(), optional(atom()) => any()}} | {:error, term()}

callback(t, map)

@callback callback(Keyword.t(), map()) ::
  {:ok, %{:user => map(), optional(atom()) => any()}} | {:error, term()}

Functions

decode_json(response, config)

@spec decode_json(binary(), Keyword.t()) :: {:ok, term()} | {:error, term()}

Decode a JSON string.

Options

http_request(method, url, body, headers, config)

Makes a HTTP request.

See Assent.HTTPAdapter.request/5.

normalize_userinfo(claims, extra \\ %{})

@spec normalize_userinfo(map(), map()) :: {:ok, map()} | {:error, term()}

Normalize API user request response into standard claims.

The function will cast values to adhere to the following types:

%{
  "address" => %{
    "country" => :binary,
    "formatted" => :binary,
    "locality" => :binary,
    "postal_code" => :binary,
    "region" => :binary,
    "street_address" => :binary
  },
  "birthdate" => :binary,
  "email" => :binary,
  "email_verified" => :boolean,
  "family_name" => :binary,
  "gender" => :binary,
  "given_name" => :binary,
  "locale" => :binary,
  "middle_name" => :binary,
  "name" => :binary,
  "nickname" => :binary,
  "phone_number" => :binary,
  "phone_number_verified" => :boolean,
  "picture" => :binary,
  "preferred_username" => :binary,
  "profile" => :binary,
  "sub" => :binary,
  "updated_at" => :integer,
  "website" => :binary,
  "zoneinfo" => :binary
}

Returns an Assent.CastClaimsError if any of the above types can't be casted.

Based on https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.5.1

sign_jwt(claims, alg, secret, config)

@spec sign_jwt(map(), binary(), binary(), Keyword.t()) ::
  {:ok, binary()} | {:error, term()}

Signs a JSON Web Token.

See Assent.JWTAdapter.sign/3 for options.

to_url(base_url, uri, params \\ [])

@spec to_url(binary(), binary(), Keyword.t()) :: binary()

Generates a URL.

verify_jwt(token, secret, config)

@spec verify_jwt(binary(), binary() | map() | nil, Keyword.t()) ::
  {:ok, map()} | {:error, any()}

Verifies a JSON Web Token.

See Assent.JWTAdapter.verify/3 for options.