# DEPRECATION NOTICE

This crate is deprecated in favour of [rspotify](https://docs.rs/rspotify). Originally, this crate
was created when rspotify didn't support async and had a much worse API than it does now. But since
then it has much improved, and I don't have the time or energy to maintain this crate anymore.

# Original README

Asynchronous Rust Spotify client.

## Description

Aspotify is a Rust wrapper for the Spotify API. It provides Rust structures around all of Spotify's
[Object Model](https://developer.spotify.com/documentation/web-api/reference/object-model/) and
functions around all their endpoints.

## Authorization

All Spotify endpoints require authorization. There are two forms of authorization provided by this
library; Client Credentials and Authorization Code. To use either, you first need a [Spotify
Developer](https://developer.spotify.com/dashboard/applications) account, which is free. Then you
can use endpoints with your Client ID and Client Secret with Client Credentials, or perform actions
on behalf of a user with oauth2 and Authorization Code.

## Example

```rust
use aspotify::{Client, ClientCredentials};

// This from_env function tries to read the CLIENT_ID and CLIENT_SECRET environment variables.
// You can use the dotenv crate to read it from a file.
let credentials = ClientCredentials::from_env()
    .expect("CLIENT_ID and CLIENT_SECRET not found.");

// Create a Spotify client.
let client = Client::new(credentials);

// Gets the album "Favourite Worst Nightmare" from Spotify, with no specified market.
let album = client.albums().get_album("1XkGORuUX2QGOEIL4EbJKm", None).await.unwrap();
```

## Features

At the time of the latest release, `aspotify` supports all the features of the Spotify API. It uses
`reqwest` internally, and so must run with Tokio's runtime.

## Testing

In order to test, you first need to add `http://non.existant/` in your Spotify whitelisted URLs. Get
your Client ID and Client Secret and put them in a `.env` file in the crate root like this:
```
CLIENT_ID=some value
CLIENT_SECRET=some value
```
Then, run `cargo run --example refresh_file`. Follow the instructions shown. If everything went
successfully, you should see a file called `.refresh_token` in your crate root. This file contains a
refresh token that will be used to run all the tests. For more infomation about this process, see
`examples/refresh_file.rs`.

These tests will make temporary changes to your account, however they will all be reverted. You will
also need an unrestricted non-private Spotify client open to get all the tests to run successfully,
and you must not have any songs in your queue.

## Planned

- Add a blocking API.
- Support other HTTP clients.
- Automatically send multiple requests when the limit is above Spotify's limit for functions that
return `Page`/`CursorPage`.