README.md

Überauth Goodreads

Goodreads strategy for Überauth.

Note: Sessions are required for this strategy.

Installation

1. Setup your application at Gooreads Developers.

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

   def deps do
     [{:ueberauth_goodreads, "~> 0.1"},
      {:oauth, github: "tim/erlang-oauth"}]
   end

3. Add the strategy to your applications:

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

4. Add Goodreads to your Überauth configuration:

   config :ueberauth, Ueberauth,
     providers: [
       goodreads: {Ueberauth.Strategy.Goodreads, []}
     ]

5. Update your provider configuration:

   config :ueberauth, Ueberauth.Strategy.Goodreads.OAuth,
     consumer_key: System.get_env("GOODREADS_CONSUMER_KEY"),
     consumer_secret: System.get_env("GOODREADS_CONSUMER_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. You 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/goodreads

License

Please see LICENSE for licensing details.