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

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 response to a map

decode_response(any, config)

Decodes a request response.

normalize_userinfo(claims, extra \\ %{})

Normalize API user request response into standard claims

prune(map)

Recursively prunes map for nil values.

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

Makes a HTTP request.

sign_jwt(claims, alg, secret, config)

Signs a JWT

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

Generates a URL

verify_jwt(token, secret, config)

Verifies a JWT

Callbacks

authorize_url(t)

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

callback(t, map)

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

Functions

decode_json(response, config)

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

Decode a JSON response to a map

decode_response(any, config)

@spec decode_response(
  {:ok, Assent.HTTPAdapter.HTTPResponse.t()}
  | {:error, Assent.HTTPAdapter.HTTPResponse.t()}
  | {:error, term()},
  Assent.Config.t()
) ::
  {:ok, Assent.HTTPAdapter.HTTPResponse.t()}
  | {:error, Assent.HTTPAdapter.HTTPResponse.t()}
  | {:error, term()}

Decodes a request response.

normalize_userinfo(claims, extra \\ %{})

@spec normalize_userinfo(map(), map()) :: {:ok, map()}

Normalize API user request response into standard claims

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

prune(map)

@spec prune(map()) :: map()

Recursively prunes map for nil values.

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

@spec request(atom(), binary(), binary() | nil, list(), Assent.Config.t()) ::
  {:ok, Assent.HTTPAdapter.HTTPResponse.t()}
  | {:error, Assent.HTTPAdapter.HTTPResponse.t()}
  | {:error, term()}

Makes a HTTP request.

sign_jwt(claims, alg, secret, config)

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

Signs a JWT

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, Assent.Config.t()) ::
  {:ok, map()} | {:error, any()}

Verifies a JWT