ueberauth_openstreetmap/lib/ueberauth/strategy/osm.ex

defmodule Ueberauth.Strategy.OpenStreetMap do
  @moduledoc """
  Opestreetmap Strategy for Überauth.
  """

  use Ueberauth.Strategy, uid_field: :id_str

  alias Ueberauth.Auth.Info
  alias Ueberauth.Auth.Credentials
  alias Ueberauth.Auth.Extra
  alias Ueberauth.Strategy.OpenStreetMap

  @doc """
  Handles initial request for OpenStreetMap authentication.
  """
  def handle_request!(conn) do
    token = OpenStreetMap.OAuth.request_token!([], [redirect_uri: callback_url(conn)])

    conn
    |> put_session(:OpenStreetMap_token, token)
    |> redirect!(OpenStreetMap.OAuth.authorize_url!(token))
  end

  @doc """
  Handles the callback from OpenStreetMap.
  """
  def handle_callback!(%Plug.Conn{params: %{"oauth_verifier" => oauth_verifier}} = conn) do
    token = get_session(conn, :OpenStreetMap_token)
    case OpenStreetMap.OAuth.access_token(token, oauth_verifier) do
      {:ok, access_token} -> fetch_user(conn, access_token)
      {:error, error} -> set_errors!(conn, [error(error.code, error.reason)])
    end
  end

  @doc false
  def handle_callback!(conn) do
    set_errors!(conn, [error("missing_code", "No code received")])
  end

  @doc false
  def handle_cleanup!(conn) do
    conn
    |> put_private(:OpenStreetMap_user, nil)
    |> put_session(:OpenStreetMap_token, nil)
  end

  @doc """
  Fetches the uid field from the response.
  """
  def uid(conn) do
    uid_field =
      conn
      |> option(:uid_field)
      |> to_string

    conn.private.OpenStreetMap_user[uid_field]
  end

  @doc """
  Includes the credentials from the OpenStreetMap response.
  """
  def credentials(conn) do
    {token, secret} = conn.private.OpenStreetMap_token

    %Credentials{token: token, secret: secret}
  end

  @doc """
  Fetches the fields to populate the info section of the `Ueberauth.Auth` struct.
  """
  def info(conn) do
    user = conn.private.OpenStreetMap_user

    %Info{
      email: user["email"],
      image: user["profile_image_url_https"],
      name: user["name"],
      nickname: user["screen_name"],
      description: user["description"],
      location: user["location"],
      urls: %{
        OpenStreetMap: "https://OpenStreetMap.com/#{user["screen_name"]}",
        Website: user["url"]
      }
    }
  end

  @doc """
  Stores the raw information (including the token) obtained from the OpenStreetMap callback.
  """
  def extra(conn) do
    {token, _secret} = get_session(conn, :OpenStreetMap_token)

    %Extra{
      raw_info: %{
        token: token,
        user: conn.private.OpenStreetMap_user
      }
    }
  end

  defp fetch_user(conn, token) do
    params = [{"include_entities", false}, {"skip_status", true}, {"include_email", true}]

    case OpenStreetMap.OAuth.get("/1.1/account/verify_credentials.json", params, token) do
      {:ok, %{status_code: 401, body: _, headers: _}} ->
        set_errors!(conn, [error("token", "unauthorized")])

      {:ok, %{status_code: status_code, body: body, headers: _}} when status_code in 200..399 ->
        conn
        |> put_private(:OpenStreetMap_token, token)
        |> put_private(:OpenStreetMap_user, body)

      {:ok, %{status_code: _, body: body, headers: _}} ->
        error = List.first(body["errors"])
        set_errors!(conn, [error("token", error["message"])])
    end
  end

  defp option(conn, key) do
    default = Keyword.get(default_options(), key)

    conn
    |> options
    |> Keyword.get(key, default)
  end
end