Packages

An Ueberauth strategy for using Twitch to authenticate your users.

Current section

Files

Jump to
uberauth_twitch lib ueberauth strategy twitch.ex
Raw

lib/ueberauth/strategy/twitch.ex

defmodule Ueberauth.Strategy.Twitch do
@moduledoc """
Provides an Ueberauth strategy for authenticating with Twitch.
"""
use Ueberauth.Strategy, uid_field: :id,
default_scope: "user_read",
oauth2_module: Ueberauth.Strategy.Twitch.OAuth
alias Ueberauth.Auth.Info
alias Ueberauth.Auth.Credentials
alias Ueberauth.Auth.Extra
@doc """
Handles the initial redirect to the twitch.tv authentication page.
"""
def handle_request!(conn) do
scopes = conn.params["scope"] || option(conn, :default_scope)
opts = [redirect_uri: callback_url(conn), scope: scopes]
opts =
if conn.params["state"], do: Keyword.put(opts, :state, conn.params["state"]), else: opts
module = option(conn, :oauth2_module)
redirect!(conn, apply(module, :authorize_url!, [opts]))
end
@doc """
Handles the callback from TwitchTv. When there is a failure from TwitchTv the failure is included in the
`ueberauth_failure` struct. Otherwise the information returned from TwitchTv is returned in the `Ueberauth.Auth` struct.
"""
def handle_callback!(%Plug.Conn{ params: %{ "code" => code } } = conn) do
module = option(conn, :oauth2_module)
token = apply(module, :get_token!, [[code: code, redirect_uri: callback_url(conn)]])
if token.access_token == nil do
set_errors!(conn, [error(token.other_params["error"], token.other_params["error_description"])])
else
fetch_user(conn, token)
end
end
@doc false
def handle_callback!(conn) do
set_errors!(conn, [error("missing_code", "No code received")])
end
@doc """
Cleans up the private area of the connection used for passing the raw TwitchTv response around during the callback.
"""
def handle_cleanup!(conn) do
conn
|> put_private(:twitch_tv_user, nil)
|> put_private(:twitch_tv_token, nil)
end
@doc """
Fetches the uid field from the twitch tv response. This defaults to the option `uid_field` which in-turn defaults to `login`
"""
def uid(conn) do
conn.private.twitch_tv_user[option(conn, :uid_field) |> to_string]
end
@doc """
Includes the credentials from the twitch tv response.
"""
def credentials(conn) do
token = conn.private.twitch_tv_token
# scopes = (token.other_params["scope"] || "")
# |> String.split(",")
%Credentials{
token: token.access_token,
refresh_token: token.refresh_token,
expires_at: token.expires_at,
token_type: token.token_type,
expires: !!token.expires_at,
# scopes: scopes
}
end
@doc """
Fetches the fields to populate the info section of the `Ueberauth.Auth` struct.
"""
def info(conn) do
user = conn.private.twitch_tv_user
%Info {
name: user["name"], ## this is your display name
first_name: nil,
last_name: nil,
nickname: nil,
email: user["email"],
location: nil,
description: user["bio"],
image: user["logo"],
phone: nil,
urls: %{
self: user["self"]
}
}
end
@doc """
Stores the raw information (including the token) obtained from the Twitch Tv callback.
"""
def extra(conn) do
%Extra {
raw_info: %{
token: conn.private.twitch_tv_token,
user: conn.private.twitch_tv_user,
is_partnered: conn.private.twitch_tv_user["partnered"]
}
}
end
defp fetch_user(conn, token) do
conn = put_private(conn, :twitch_tv_token, token)
path = "https://api.twitch.tv/kraken/user"
headers = [
Authorization: "OAuth #{token.access_token}",
Accept: "application/vnd.twitchtv.v5+json"
]
resp = OAuth2.AccessToken.get(token, path, headers)
case resp do
{ :ok, %OAuth2.Response{status_code: 401, body: _body}} ->
set_errors!(conn, [error("token", "unauthorized")])
{ :ok, %OAuth2.Response{status_code: status_code, body: user} } when status_code in 200..399 ->
put_private(conn, :twitch_tv_user, user)
{ :error, %OAuth2.Error{reason: reason} } ->
set_errors!(conn, [error("OAuth2", reason)])
end
end
defp option(conn, key) do
Keyword.get(options(conn), key, Keyword.get(default_options, key))
end
end