https://github.com/davejlong/ueberauth_spotify

An Ueberauth Strategy for Spotify
https://github.com/davejlong/ueberauth_spotify

Last synced: 6 days ago
JSON representation

An Ueberauth Strategy for Spotify

• Host: GitHub
• URL: https://github.com/davejlong/ueberauth_spotify
• Owner: davejlong
• License: mit
• Created: 2017-07-05T03:05:36.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-01-22T02:04:50.000Z (almost 6 years ago)
• Last Synced: 2024-10-30T16:58:29.493Z (16 days ago)
• Language: Elixir
• Size: 22.5 KB
• Stars: 3
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Überauth Spotify

> Spotify OAuth2 strategy for Überauth.

## Installation

1. Setup your application at [Spotify Developer Console](https://developer.spotify.com/my-applications).

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

    ```elixir

    def deps do

      [{:ueberauth_spotify, "~> 0.0.1", hex: :ueberauth_spotify_oauth}]

    end

    ```

1. Add the strategy to your applications:

    ```elixir

    def application do

      [applications: [:ueberauth_spotify]]

    end

    ```

1. Add Spotify to your Überauth configuration:

    ```elixir

    config :ueberauth, Ueberauth,

      providers: [

        spotify: {Ueberauth.Strategy.Spotify, []}

      ]

    ```

1.  Update your provider configuration:

    ```elixir

    config :ueberauth, Ueberauth.Strategy.Spotify.OAuth,

      client_id: System.get_env("SPOTIFY_CLIENT_ID"),

      client_secret: System.get_env("SPOTIFY_CLIENT_SECRET")

    ```

1.  Include the Überauth plug in your controller:

    ```elixir

    defmodule MyApp.AuthController do

      use MyApp.Web, :controller

      plug Ueberauth

      ...

    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://github.com/ueberauth/ueberauth_example) application.

## Calling

Depending on the configured url you can initial the request through:

    /auth/spotify

Or with options:

    /auth/spotify?scope=user-library-modify

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

```elixir

config :ueberauth, Ueberauth,

  providers: [

    spotify: {Ueberauth.Strategy.Spotify, [default_scope: "user-library-modify streaming"]}

  ]

```

This project was heavily inspired by [UeberauthGoogle](https://github.com/ueberauth/ueberauth_google).

## License

Please see [LICENSE](https://github.com/davejlong/ueberauth_spotify/blob/master/LICENSE) for licensing details.