README.md

# Überauth Arise

> Arise OAuth2 strategy for Überauth.

## Installation

1. Setup your application at [ARISE Account](https://accounts.arisechurch.com).

1. Add `:ueberauth_arise` to your list of dependencies in `mix.exs`:

   ```elixir
   def deps do
     [{:ueberauth_arise, "~> 0.1"}]
   end
   ```

1. Add the strategy to your applications:

   ```elixir
   def application do
     [applications: [:ueberauth_arise]]
   end
   ```

1. Add Arise to your Überauth configuration:

   ```elixir
   config :ueberauth, Ueberauth,
     providers: [
       arise: {Ueberauth.Strategy.Arise, []}
     ]
   ```

1. Update your provider configuration:

   ```elixir
   config :ueberauth, Ueberauth.Strategy.Arise.OAuth,
     client_id: System.get_env("ARISE_CLIENT_ID"),
     client_secret: System.get_env("ARISE_CLIENT_SECRET")
   ```

   Or, to read the client credentials at runtime:

   ```elixir
   config :ueberauth, Ueberauth.Strategy.Arise.OAuth,
     client_id: {:system, "ARISE_CLIENT_ID"},
     client_secret: {:system, "ARISE_CLIENT_SECRET"}
   ```

1. Include the Überauth plug in your controller:

   ```elixir
   defmodule MyApp.AuthController do
     use MyApp.Web, :controller

     pipeline :browser do
       plug Ueberauth
       ...
      end
   end
   ```

1. Create the request and callback routes if you haven't already:

   ```elixir
   scope "/auth", MyApp do
     pipe_through :browser

     get "/:provider", AuthController, :request
     get "/:provider/callback", AuthController, :callback
   end
   ```

1. Your controller needs to implement callbacks to deal with `Ueberauth.Auth` and `Ueberauth.Failure` responses.

For an example implementation see the [Überauth Example](https://arise.com/ueberauth/ueberauth_example) application.