Reddit OAuth2 strategy for Überauth.
-
Setup your application on Reddit.
-
Add
:ueberauth_redditto your list of dependencies inmix.exs:def deps do [{:ueberauth_reddit, "~> 0.3"}] end
-
Add the strategy to your applications:
def application do [applications: [:ueberauth_reddit]] end
-
Add Reddit to your Überauth configuration:
config :ueberauth, Ueberauth, providers: [ reddit: {Ueberauth.Strategy.Reddit, []} ]
-
Update your provider configuration:
config :ueberauth, Ueberauth.Strategy.Reddit.OAuth, client_id: System.get_env("REDDIT_CLIENT_ID"), client_secret: System.get_env("REDDIT_CLIENT_SECRET"), user_agent: "my-custom-user-agent" # optional
-
Include the Überauth plug in your controller:
defmodule MyApp.AuthController do use MyApp.Web, :controller plug Ueberauth ... end
-
Create the request and callback routes if you haven't already:
scope "/auth", MyApp do pipe_through :browser get "/:provider", AuthController, :request get "/:provider/callback", AuthController, :callback end
-
Your controller needs to implement callbacks to deal with
Ueberauth.AuthandUeberauth.Failureresponses.
For an example implementation see the Überauth Example application.
Depending on the configured url you can initial the request through:
/auth/reddit
Or with options:
/auth/reddit?scope=identity
By default the requested scope is "identity". The scope can be configured either explicitly as a scope query value on the request path or in your configuration:
config :ueberauth, Ueberauth,
providers: [
reddit: {Ueberauth.Strategy.Reddit, [scope: "identity"]}
]Available scopes are: identity, edit, flair, history, modconfig, modflair, modlog, modposts, modwiki, mysubreddits, privatemessages, read, report, save, submit, subscribe, vote, wikiedit, wikiread.
Please see LICENSE for licensing details.