https://github.com/bianchidotdev/ueberauth_tidal
https://github.com/bianchidotdev/ueberauth_tidal
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bianchidotdev/ueberauth_tidal
- Owner: bianchidotdev
- License: mit
- Created: 2025-05-03T19:57:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-11T22:47:10.000Z (about 1 year ago)
- Last Synced: 2025-05-11T23:25:59.904Z (about 1 year ago)
- Language: Elixir
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Überauth Tidal
> Tidal OAuth2 strategy for [Überauth](https://github.com/ueberauth).
## Installation
1. Setup your application at the [Tidal Developer Console](https://developer.tidal.com/dashboard).
1. Add `:ueberauth_tidal` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:ueberauth_tidal, "~> 0.1"}]
end
```
1. Add the strategy to your applications in `mix.exs`::
```elixir
def application do
[applications: [:ueberauth_tidal]]
end
```
1. Fetch the dependencies
```elixir
mix deps.get
```
1. Add Tidal to your Überauth configuration in `config/config.exs`::
```elixir
config :ueberauth, Ueberauth,
providers: [
tidal: {Ueberauth.Strategy.Tidal, []}
]
```
1. Update your provider configuration in `config/[dev|test|prod].exs`.
Make sure to add your JSON serlializer of choice:
```elixir
config :ueberauth, Ueberauth.Strategy.Tidal.OAuth,
client_id: System.get_env("TIDAL_CLIENT_ID"),
client_secret: System.get_env("TIDAL_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/tidal
Or with options:
/auth/tidal?scope=...&show_dialog=true
By default the requested scope is "user.read". Scope can be configured either explicitly as a `scope` query value on the request path or in your configuration:
```elixir
config :ueberauth, Ueberauth,
providers: [
tidal: {Ueberauth.Strategy.Tidal, [default_scope: "user.read playlist.read"]}
]
```
## TODO
* Make Jason not required
## License
Please see [LICENSE](https://github.com/bianchidotdev/ueberauth_tidal/blob/master/LICENSE) for licensing details.