OpenPace v0.0.1

View Source Squeeze.Fitbit.AuthBehaviour behaviour (OpenPace v0.0.1)

Behaviour module defining callbacks for Fitbit OAuth authentication.

Link to this section Summary

Types

auth_opts()
client()
code()
credential()
grant_type()
headers()
scope()
token()
token_opts()

Callbacks

authorize_url!()

Generates the authorization URL for the OAuth2 flow.

authorize_url!(auth_opts)
get_credential!(client)

Creates credential map from OAuth2 client response.

get_token()

Gets an OAuth2 token, returns {:ok, client} or {:error, reason}.

get_token(token_opts)
get_token(token_opts, headers)
get_token!()

Gets an OAuth2 token, raising an error if the request fails.

get_token!(token_opts)
get_token!(token_opts, headers)
new()

Creates a new OAuth2 client with default configuration.

Link to this section Types

Link to this type

auth_opts()

View Source 
@type auth_opts() :: [scope: scope(), expires_in: integer()]
Link to this type

client()

View Source 
@type client() :: OAuth2.Client.t()
Link to this type

code()

View Source 
@type code() :: String.t()
Link to this type

credential()

View Source 
@type credential() :: %{
  access_token: binary(),
  refresh_token: binary(),
  provider: binary(),
  uid: binary()
}
Link to this type

grant_type()

View Source 
@type grant_type() :: String.t()
Link to this type

headers()

View Source 
@type headers() :: [{binary(), binary()}]
Link to this type

scope()

View Source 
@type scope() :: String.t()
Link to this type

token()

View Source 
@type token() :: OAuth2.AccessToken.t()
Link to this type

token_opts()

View Source 
@type token_opts() :: [
  code: code(),
  grant_type: grant_type(),
  refresh_token: binary()
]

Link to this section Callbacks

Link to this callback

authorize_url!()

View Source 
@callback authorize_url!() :: String.t()

Generates the authorization URL for the OAuth2 flow.

Link to this callback

authorize_url!(auth_opts)

View Source 
@callback authorize_url!(auth_opts()) :: String.t()
Link to this callback

get_credential!(client)

View Source 
@callback get_credential!(client()) :: credential()

Creates credential map from OAuth2 client response.

Link to this callback

get_token()

View Source 
@callback get_token() :: {:ok, client()} | {:error, any()}

Gets an OAuth2 token, returns {:ok, client} or {:error, reason}.

Link to this callback

get_token(token_opts)

View Source 
@callback get_token(token_opts()) :: {:ok, client()} | {:error, any()}
Link to this callback

get_token(token_opts, headers)

View Source 
@callback get_token(token_opts(), headers()) :: {:ok, client()} | {:error, any()}
Link to this callback

get_token!()

View Source 
@callback get_token!() :: client()

Gets an OAuth2 token, raising an error if the request fails.

Link to this callback

get_token!(token_opts)

View Source 
@callback get_token!(token_opts()) :: client()
Link to this callback

get_token!(token_opts, headers)

View Source 
@callback get_token!(token_opts(), headers()) :: client()
Link to this callback

new()

View Source 
@callback new() :: client()

Creates a new OAuth2 client with default configuration.