schwarz/ueberauth_reddit

Reddit OAuth2 Strategy for Überauth.

Überauth Reddit

Reddit OAuth2 strategy for Überauth.

Installation

1. Setup your application on Reddit.

2. Add :ueberauth_reddit to your list of dependencies in mix.exs:

   def deps do
     [{:ueberauth_reddit, "~> 0.2"}]
   end

3. Add the strategy to your applications:

   def application do
     [applications: [:ueberauth_reddit]]
   end

4. Add Reddit to your Überauth configuration:

   config :ueberauth, Ueberauth,
     providers: [
       reddit: {Ueberauth.Strategy.Reddit, []}
     ]

5. 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")

6. Include the Überauth plug in your controller:

   defmodule MyApp.AuthController do
     use MyApp.Web, :controller
     plug Ueberauth
     ...
   end

7. 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

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

For an example implementation see the Überauth Example application.

Calling

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.

License

Please see LICENSE for licensing details.