Holds the credentials used to authenticate every request.
A client is a plain struct — build one and pass it to any Magpie function. There are three ways to build it:
# 1. A static access token. Simplest, but Dropbox access tokens expire
# in about 4 hours — fine for scripts, not for daemons.
client = Magpie.Client.new("ACCESS_TOKEN")
# 2. A refresh token. Magpie starts a linked `Magpie.Auth.TokenServer`
# and keeps the access token fresh for you.
client = Magpie.Client.new(refresh_token: rt, app_key: key, app_secret: secret)
client = Magpie.Client.new(refresh_token: rt, app_key: key, pkce: true)
# 3. A token provider you supervise (or wrote) yourself.
client = Magpie.Client.new(token_provider: {Magpie.Auth.TokenServer, MyApp.DropboxToken})
client = Magpie.Client.new(token_provider: {MyApp.DropboxTokens, "user-42"})Form 2 links the token server to the calling process, which is convenient
in scripts and iex, but in an application you usually want the server in
your supervision tree — see Magpie.Auth.TokenServer and the
OAuth guide.
Whatever the form, the credentials end up behind a
Magpie.Auth.TokenProvider stored in token_provider.
Summary
Functions
Builds a client with no credentials.
Builds a client from an access token, a refresh token or a token provider.
Returns the {module, arg} token provider a client authenticates with.
Types
Functions
@spec new() :: m()
Builds a client with no credentials.
iex> Magpie.Client.new()
%Magpie.Client{access_token: nil, token_provider: nil}@spec new(access_token() | keyword()) :: t()
Builds a client from an access token, a refresh token or a token provider.
Examples
iex> client = Magpie.Client.new("ACCESS_TOKEN")
iex> client.token_provider
{Magpie.Auth.StaticToken, "ACCESS_TOKEN"}
iex> client = Magpie.Client.new(token_provider: {Magpie.Auth.TokenServer, MyApp.DropboxToken})
iex> client.token_provider
{Magpie.Auth.TokenServer, MyApp.DropboxToken}With :refresh_token, a Magpie.Auth.TokenServer is started and linked to
the calling process — every other option (:name, :refresh_margin,
:on_refresh, ...) is forwarded to it:
client =
Magpie.Client.new(
refresh_token: System.fetch_env!("DROPBOX_REFRESH_TOKEN"),
app_key: System.fetch_env!("DROPBOX_APP_KEY"),
app_secret: System.fetch_env!("DROPBOX_APP_SECRET")
)Returns the {module, arg} token provider a client authenticates with.
Clients built by hand (%Magpie.Client{access_token: "..."}) fall back to
Magpie.Auth.StaticToken.
iex> Magpie.Client.token_provider(%Magpie.Client{access_token: "ACCESS_TOKEN"})
{Magpie.Auth.StaticToken, "ACCESS_TOKEN"}