README.md

Überauth Spotify

Spotify OAuth2 strategy for Überauth.

Installation

1. Setup your application at the Spotify Developer Console.

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

   def deps do
     [{:ueberauth_spotify, "0.2.1"}]
   end

3. Add the strategy to your applications in mix.exs::

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

4. Fetch the dependencies

   mix deps.get

5. Add Spotify to your Überauth configuration in config/config.exs::

   config :ueberauth, Ueberauth,
     providers: [
       spotify: {Ueberauth.Strategy.Spotify, []}
     ]

6. Update your provider configuration in config/[dev|test|prod].exs. Make sure to add your JSON serlializer of choice:

   config :ueberauth, Ueberauth.Strategy.Spotify.OAuth,
     client_id: System.get_env("SPOTIFY_CLIENT_ID"),
     client_secret: System.get_env("SPOTIFY_CLIENT_SECRET")

7. Include the Überauth plug in your controller:

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

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

9. 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/spotify

Or with options:

/auth/spotify?scope=...&show_dialog=true

By default the requested scope is "user-read-email". Scope can be configured either explicitly as a scope query value on the request path or in your configuration:

config :ueberauth, Ueberauth,
  providers: [
    spotify: {Ueberauth.Strategy.Spotify, [default_scope: "user-read-email,user-read-private"]}
  ]

License

Please see LICENSE for licensing details.