1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
//! RSpotify is a wrapper for the [Spotify Web API][spotify-main], inspired by
//! [spotipy][spotipy-github]. It includes support for all the [authorization
//! flows][spotify-auth-flows], and helper methods for [all available
//! endpoints][spotify-reference].
//!
//! ## Configuration
//!
//! ### HTTP Client
//!
//! By default, RSpotify uses the [reqwest][reqwest-docs] asynchronous HTTP
//! client with its default TLS, but you can customize both the HTTP client and
//! the TLS with the following features:
//!
//! - [reqwest][reqwest-docs]: enabling
//! `client-reqwest`, TLS available:
//! + `reqwest-default-tls` (reqwest's default)
//! + `reqwest-rustls-tls`
//! + `reqwest-native-tls`
//! + `reqwest-native-tls-vendored`
//! - [ureq][ureq-docs]: enabling `client-ureq`, TLS
//! available:
//! + `ureq-rustls-tls` (ureq's default)
//! + `ureq-rustls-tls-native-certs` (`rustls` with OS root certificates)
//!
//! If you want to use a different client or TLS than the default ones, you'll
//! have to disable the default features and enable whichever you want. For
//! example, this would compile RSpotify with `reqwest` and the native TLS:
//!
//! ```toml
//! [dependencies]
//! rspotify = {
//! version = "...",
//! default-features = false,
//! features = ["client-reqwest", "reqwest-native-tls"]
//! }
//! ```
//!
//! [`maybe_async`] internally enables RSpotify to use both synchronous and
//! asynchronous HTTP clients. You can also use `ureq`, a synchronous client,
//! like so:
//!
//! ```toml
//! [dependencies]
//! rspotify = {
//! version = "...",
//! default-features = false,
//! features = ["client-ureq", "ureq-rustls-tls"]
//! }
//! ```
//!
//! ### Proxies
//!
//! Both [reqwest][reqwest-proxies] and [ureq][ureq-proxying] support system
//! proxies by default. They both read `http_proxy`, `https_proxy`, `all_proxy`
//! and their uppercase variants `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`,
//! although the specific logic implementations are a little different.
//!
//! See also:
//! - [reqwest](https://docs.rs/reqwest/latest/src/reqwest/proxy.rs.html#897-920)
//! - [ureq](https://docs.rs/ureq/latest/src/ureq/proxy.rs.html#73-95)
//!
//! ### Environmental variables
//!
//! RSpotify supports the `dotenvy` crate, which allows you to save credentials
//! in a `.env` file. These will then be automatically available as
//! environmental values when using methods like [`Credentials::from_env`].
//!
//! ```toml
//! [dependencies]
//! rspotify = { version = "...", features = ["env-file"] }
//! ```
//!
//! ### CLI utilities
//!
//! RSpotify includes basic support for Cli apps to obtain access tokens by
//! prompting the user, after enabling the `cli` feature. See the
//! [Authorization](#authorization) section for more information.
//!
//! ## Getting Started
//!
//! ### Authorization
//!
//! All endpoints require app authorization; you will need to generate a token
//! that indicates that the client has been granted permission to perform
//! requests. You can start by [registering your app to get the necessary client
//! credentials][spotify-register-app]. Read the [official guide for a detailed
//! explanation of the different authorization flows
//! available][spotify-auth-flows].
//!
//! RSpotify has a different client for each of the available authentication
//! flows. They may implement the endpoints in
//! [`BaseClient`](crate::clients::BaseClient) or
//! [`OAuthClient`](crate::clients::OAuthClient) according to what kind of
//! flow it is. Please refer to their documentation for more details:
//!
//! * [Client Credentials Flow][spotify-client-creds]: see
//! [`ClientCredsSpotify`].
//! * [Authorization Code Flow][spotify-auth-code]: see [`AuthCodeSpotify`].
//! * [Authorization Code Flow with Proof Key for Code Exchange
//! (PKCE)][spotify-auth-code-pkce]: see [`AuthCodePkceSpotify`].
//! * [Implicit Grant Flow][spotify-implicit-grant]: unimplemented, as RSpotify
//! has not been tested on a browser yet. If you'd like support for it, let us
//! know in an issue!
//!
//! In order to help other developers to get used to `rspotify`, there are
//! public credentials available for a dummy account. You can test `rspotify`
//! with this account's `RSPOTIFY_CLIENT_ID` and `RSPOTIFY_CLIENT_SECRET` inside
//! the [`.env` file](https://github.com/ramsayleung/rspotify/blob/master/.env)
//! for more details.
//!
//! ### WebAssembly
//!
//! RSpotify supports the `wasm32-unknown-unknown` target in combination
//! with the `client-reqwest` feature. HTTP requests must be processed async.
//! Other HTTP client configurations are not supported.
//!
//! [Spotify recommends][spotify-auth-flows] using [`AuthCodePkceSpotify`] for
//! authorization flows on the web.
//!
//! Importing the Client ID via `RSPOTIFY_CLIENT_ID` is not possible since WASM
//! web runtimes are isolated from the host environment. The client ID must be
//! passed explicitly to [`Credentials::new_pkce`]. Alternatively, it can be
//! embedded at compile time with the [`std::env!`] or
//! [`dotenv!`](https://crates.io/crates/dotenvy) macros.
//!
//! ### Examples
//!
//! There are some [available examples on the GitHub
//! repository][examples-github] which can serve as a learning tool.
//!
//! [spotipy-github]: https://github.com/plamere/spotipy
//! [reqwest-docs]: https://docs.rs/reqwest/
//! [reqwest-proxies]: https://docs.rs/reqwest/#proxies
//! [ureq-docs]: https://docs.rs/ureq/
//! [examples-github]: https://github.com/ramsayleung/rspotify/tree/master/examples
//! [spotify-main]: https://developer.spotify.com/documentation/web-api/
//! [spotify-auth-flows]: https://developer.spotify.com/documentation/general/guides/authorization/
//! [spotify-reference]: https://developer.spotify.com/documentation/web-api/reference/
//! [spotify-register-app]: https://developer.spotify.com/dashboard/applications
//! [spotify-client-creds]: https://developer.spotify.com/documentation/general/guides/authorization/client-credentials/
//! [spotify-auth-code]: https://developer.spotify.com/documentation/general/guides/authorization/code-flow
//! [spotify-auth-code-pkce]: https://developer.spotify.com/documentation/web-api/tutorials/code-pkce-flow
//! [spotify-implicit-grant]: https://developer.spotify.com/documentation/general/guides/authorization/implicit-grant
mod auth_code;
mod auth_code_pkce;
mod client_creds;
pub mod clients;
pub mod sync;
mod util;
// Subcrate re-exports
pub use rspotify_http as http;
pub use rspotify_macros as macros;
pub use rspotify_model as model;
// Top-level re-exports
pub use auth_code::AuthCodeSpotify;
pub use auth_code_pkce::AuthCodePkceSpotify;
pub use client_creds::ClientCredsSpotify;
pub use macros::scopes;
pub use model::Token;
use crate::{http::HttpError, model::Id};
use std::{
collections::{HashMap, HashSet},
env, fmt,
path::PathBuf,
sync::Arc,
};
use base64::{engine::general_purpose, Engine as _};
use getrandom::getrandom;
use thiserror::Error;
pub mod prelude {
pub use crate::clients::{BaseClient, OAuthClient};
pub use crate::model::idtypes::{Id, PlayContextId, PlayableId};
}
/// Common headers as constants.
pub(crate) mod params {
pub const CLIENT_ID: &str = "client_id";
pub const CODE: &str = "code";
pub const GRANT_TYPE: &str = "grant_type";
pub const GRANT_TYPE_AUTH_CODE: &str = "authorization_code";
pub const GRANT_TYPE_CLIENT_CREDS: &str = "client_credentials";
pub const GRANT_TYPE_REFRESH_TOKEN: &str = "refresh_token";
pub const REDIRECT_URI: &str = "redirect_uri";
pub const REFRESH_TOKEN: &str = "refresh_token";
pub const RESPONSE_TYPE_CODE: &str = "code";
pub const RESPONSE_TYPE: &str = "response_type";
pub const SCOPE: &str = "scope";
pub const SHOW_DIALOG: &str = "show_dialog";
pub const STATE: &str = "state";
pub const CODE_CHALLENGE: &str = "code_challenge";
pub const CODE_VERIFIER: &str = "code_verifier";
pub const CODE_CHALLENGE_METHOD: &str = "code_challenge_method";
pub const CODE_CHALLENGE_METHOD_S256: &str = "S256";
}
/// Common alphabets for random number generation and similars
pub(crate) mod alphabets {
pub const ALPHANUM: &[u8] = b"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
/// From <https://datatracker.ietf.org/doc/html/rfc7636#section-4.1>
pub const PKCE_CODE_VERIFIER: &[u8] =
b"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~";
}
pub(crate) mod auth_urls {
pub const AUTHORIZE: &str = "authorize";
pub const TOKEN: &str = "api/token";
}
/// Possible errors returned from the `rspotify` client.
#[derive(Debug, Error)]
pub enum ClientError {
#[error("json parse error: {0}")]
ParseJson(#[from] serde_json::Error),
#[error("url parse error: {0}")]
ParseUrl(#[from] url::ParseError),
// Note that this type is boxed because its size might be very large in
// comparison to the rest. For more information visit:
// https://rust-lang.github.io/rust-clippy/master/index.html#large_enum_variant
#[error("http error: {0}")]
Http(Box<HttpError>),
#[error("input/output error: {0}")]
Io(#[from] std::io::Error),
#[cfg(feature = "cli")]
#[error("cli error: {0}")]
Cli(String),
#[error("cache file error: {0}")]
CacheFile(String),
#[error("token callback function error: {0}")]
TokenCallbackFn(#[from] CallbackError),
#[error("model error: {0}")]
Model(#[from] model::ModelError),
#[error("Token is not valid")]
InvalidToken,
}
// The conversion has to be done manually because it's in a `Box<T>`
impl From<HttpError> for ClientError {
fn from(err: HttpError) -> Self {
Self::Http(Box::new(err))
}
}
pub type ClientResult<T> = Result<T, ClientError>;
pub const DEFAULT_API_BASE_URL: &str = "https://api.spotify.com/v1/";
pub const DEFAULT_AUTH_BASE_URL: &str = "https://accounts.spotify.com/";
pub const DEFAULT_CACHE_PATH: &str = ".spotify_token_cache.json";
pub const DEFAULT_PAGINATION_CHUNKS: u32 = 50;
#[derive(Error, Debug)]
pub enum CallbackError {
#[error("The callback function raises an error: `{0}`")]
CustomizedError(String),
}
/// A callback function is invokved whenever successfully request or refetch a new token.
pub struct TokenCallback(pub Box<dyn Fn(Token) -> Result<(), CallbackError> + Send + Sync>);
impl fmt::Debug for TokenCallback {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str("TokenCallback")
}
}
/// Struct to configure the Spotify client.
#[derive(Debug, Clone)]
pub struct Config {
/// The Spotify API prefix, [`DEFAULT_API_BASE_URL`] by default.
pub api_base_url: String,
/// The Spotify Authentication prefix, [`DEFAULT_AUTH_BASE_URL`] by default.
pub auth_base_url: String,
/// The cache file path, in case it's used. By default it's
/// [`DEFAULT_CACHE_PATH`]
pub cache_path: PathBuf,
/// The pagination chunk size used when performing automatically paginated
/// requests, like [`artist_albums`](crate::clients::BaseClient). This
/// means that a request will be performed every `pagination_chunks` items.
/// By default this is [`DEFAULT_PAGINATION_CHUNKS`].
///
/// Note that most endpoints set a maximum to the number of items per
/// request, which most times is 50.
pub pagination_chunks: u32,
/// Whether or not to save the authentication token into a JSON file,
/// then reread the token from JSON file when launching the program without
/// following the full auth process again
pub token_cached: bool,
/// Whether or not to check if the token has expired when sending a
/// request with credentials, and in that case, automatically refresh it.
pub token_refreshing: bool,
/// Whenever client succeeds to request or refresh a token, the callback function
/// will be invoked
pub token_callback_fn: Arc<Option<TokenCallback>>,
}
impl Default for Config {
fn default() -> Self {
Self {
api_base_url: String::from(DEFAULT_API_BASE_URL),
auth_base_url: String::from(DEFAULT_AUTH_BASE_URL),
cache_path: PathBuf::from(DEFAULT_CACHE_PATH),
pagination_chunks: DEFAULT_PAGINATION_CHUNKS,
token_cached: false,
token_refreshing: true,
token_callback_fn: Arc::new(None),
}
}
}
/// Generate `length` random chars from the Operating System.
///
/// It is assumed that system always provides high-quality cryptographically
/// secure random data, ideally backed by hardware entropy sources.
pub(crate) fn generate_random_string(length: usize, alphabet: &[u8]) -> String {
let mut buf = vec![0u8; length];
getrandom(&mut buf).unwrap();
let range = alphabet.len();
buf.iter()
.map(|byte| alphabet[*byte as usize % range] as char)
.collect()
}
#[inline]
pub(crate) fn join_ids<'a, T: Id + 'a>(ids: impl IntoIterator<Item = T>) -> String {
let ids = ids.into_iter().collect::<Vec<_>>();
ids.iter().map(Id::id).collect::<Vec<_>>().join(",")
}
#[inline]
pub(crate) fn join_scopes(scopes: &HashSet<String>) -> String {
scopes
.iter()
.map(String::as_str)
.collect::<Vec<_>>()
.join(" ")
}
/// Simple client credentials object for Spotify.
#[derive(Debug, Clone, Default)]
pub struct Credentials {
pub id: String,
/// PKCE doesn't require a client secret
pub secret: Option<String>,
}
impl Credentials {
/// Initialization with both the client ID and the client secret
#[must_use]
pub fn new(id: &str, secret: &str) -> Self {
Self {
id: id.to_owned(),
secret: Some(secret.to_owned()),
}
}
/// Initialization with just the client ID
#[must_use]
pub fn new_pkce(id: &str) -> Self {
Self {
id: id.to_owned(),
secret: None,
}
}
/// Parses the credentials from the environment variables
/// `RSPOTIFY_CLIENT_ID` and `RSPOTIFY_CLIENT_SECRET`. You can optionally
/// activate the `env-file` feature in order to read these variables from
/// a `.env` file.
#[must_use]
pub fn from_env() -> Option<Self> {
#[cfg(feature = "env-file")]
{
dotenvy::dotenv().ok();
}
Some(Self {
id: env::var("RSPOTIFY_CLIENT_ID").ok()?,
secret: env::var("RSPOTIFY_CLIENT_SECRET").ok(),
})
}
/// Generates an HTTP basic authorization header with proper formatting
///
/// This will only work when the client secret is set to `Option::Some`.
#[must_use]
pub fn auth_headers(&self) -> Option<HashMap<String, String>> {
let auth = "authorization".to_owned();
let value = format!("{}:{}", self.id, self.secret.as_ref()?);
let value = format!("Basic {}", general_purpose::STANDARD.encode(value));
let mut headers = HashMap::new();
headers.insert(auth, value);
Some(headers)
}
}
/// Structure that holds the required information for requests with OAuth.
#[derive(Debug, Clone)]
pub struct OAuth {
pub redirect_uri: String,
/// The state is generated by default, as suggested by the OAuth2 spec:
/// [Cross-Site Request Forgery](https://tools.ietf.org/html/rfc6749#section-10.12)
pub state: String,
/// You could use macro [scopes!](crate::scopes) to build it at compile time easily
pub scopes: HashSet<String>,
pub proxies: Option<String>,
}
impl Default for OAuth {
fn default() -> Self {
Self {
redirect_uri: String::new(),
state: generate_random_string(16, alphabets::ALPHANUM),
scopes: HashSet::new(),
proxies: None,
}
}
}
impl OAuth {
/// Parses the credentials from the environment variable
/// `RSPOTIFY_REDIRECT_URI`. You can optionally activate the `env-file`
/// feature in order to read these variables from a `.env` file.
#[must_use]
pub fn from_env(scopes: HashSet<String>) -> Option<Self> {
#[cfg(feature = "env-file")]
{
dotenvy::dotenv().ok();
}
Some(Self {
scopes,
redirect_uri: env::var("RSPOTIFY_REDIRECT_URI").ok()?,
..Default::default()
})
}
}
#[cfg(test)]
pub mod test {
use crate::{alphabets, generate_random_string, Credentials};
use std::collections::HashSet;
use wasm_bindgen_test::*;
#[test]
#[wasm_bindgen_test]
fn test_generate_random_string() {
let mut containers = HashSet::new();
for _ in 1..101 {
containers.insert(generate_random_string(10, alphabets::ALPHANUM));
}
assert_eq!(containers.len(), 100);
}
#[test]
#[wasm_bindgen_test]
fn test_basic_auth() {
let creds = Credentials::new_pkce("ramsay");
let headers = creds.auth_headers();
assert_eq!(headers, None);
let creds = Credentials::new("ramsay", "123456");
let headers = creds.auth_headers().unwrap();
assert_eq!(headers.len(), 1);
assert_eq!(
headers.get("authorization"),
Some(&"Basic cmFtc2F5OjEyMzQ1Ng==".to_owned())
);
}
}