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
//! Endpoint functions relating to artists.
use std::fmt::Display;
use itertools::Itertools;
use serde::Deserialize;
use super::chunked_sequence;
use crate::{AlbumGroup, Artist, ArtistsAlbum, Client, Error, Market, Page, Response, Track};
/// Artist-related endpoints.
#[derive(Debug, Clone, Copy)]
pub struct Artists<'a>(pub &'a Client);
impl Artists<'_> {
/// Get information about an artist.
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/artists/get-artist/).
pub async fn get_artist(self, id: &str) -> Result<Response<Artist>, Error> {
self.0
.send_json(self.0.client.get(endpoint!("/v1/artists/{}", id)))
.await
}
/// Get information about several artists.
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/artists/get-several-artists/).
pub async fn get_artists<I: IntoIterator>(self, ids: I) -> Result<Response<Vec<Artist>>, Error>
where
I::Item: Display,
{
#[derive(Deserialize)]
struct Artists {
artists: Vec<Artist>,
}
chunked_sequence(ids, 50, |mut ids| {
let req = self
.0
.client
.get(endpoint!("/v1/artists"))
.query(&(("ids", ids.join(",")),));
async move {
Ok(self
.0
.send_json::<Artists>(req)
.await?
.map(|res| res.artists))
}
})
.await
}
/// Get an artist's albums.
///
/// The `include_groups` parameter can specify which groups to include (`album`, `single`,
/// `appears_on`, `compilation`). If not specified it includes them all. Limit and offset
/// control the attributes of the resulting Page. Limit has a maximum of 50.
///
/// If no market is specified this function is likely to give duplicate albums, one for each
/// market, so it is advised to provide a market.
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/artists/get-artists-albums/).
pub async fn get_artist_albums(
self,
id: &str,
include_groups: Option<&[AlbumGroup]>,
limit: usize,
offset: usize,
country: Option<Market>,
) -> Result<Response<Page<ArtistsAlbum>>, Error> {
self.0
.send_json(
self.0
.client
.get(endpoint!("/v1/artists/{}/albums", id))
.query(&(
("limit", limit.to_string()),
("offset", offset.to_string()),
include_groups.map(|groups| {
(
"include_groups",
groups.iter().map(|group| group.as_str()).join(","),
)
}),
country.map(|m| ("country", m.as_str())),
)),
)
.await
}
/// Get an artist's top tracks.
///
/// Unlike most other endpoints, the country code is required. The response contains up to 10
/// tracks which are the artist's top tracks.
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/artists/get-artists-top-tracks/).
pub async fn get_artist_top(
self,
id: &str,
market: Market,
) -> Result<Response<Vec<Track>>, Error> {
#[derive(Deserialize)]
struct Tracks {
tracks: Vec<Track>,
}
Ok(self
.0
.send_json::<Tracks>(
self.0
.client
.get(endpoint!("/v1/artists/{}/top-tracks", id))
.query(&(("country", market.as_str()),)),
)
.await?
.map(|res| res.tracks))
}
/// Get an artist's related artists.
///
/// These artists are similar in style to the given artist.
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/artists/get-related-artists/).
pub async fn get_related_artists(self, id: &str) -> Result<Response<Vec<Artist>>, Error> {
#[derive(Deserialize)]
struct Artists {
artists: Vec<Artist>,
}
Ok(self
.0
.send_json::<Artists>(
self.0
.client
.get(endpoint!("/v1/artists/{}/related-artists", id)),
)
.await?
.map(|res| res.artists))
}
}
#[cfg(test)]
mod tests {
use isocountry::CountryCode;
use crate::endpoints::client;
use crate::{AlbumGroup, Market};
#[tokio::test]
async fn test_get_artist() {
let artist = client()
.artists()
.get_artist("0L8ExT028jH3ddEcZwqJJ5")
.await
.unwrap()
.data;
assert_eq!(artist.id, "0L8ExT028jH3ddEcZwqJJ5");
assert_eq!(artist.name, "Red Hot Chili Peppers");
}
#[tokio::test]
async fn test_get_artists() {
let artists = client()
.artists()
.get_artists(&["0L8ExT028jH3ddEcZwqJJ5", "0gxyHStUsqpMadRV0Di1Qt"])
.await
.unwrap()
.data;
assert_eq!(artists.len(), 2);
assert_eq!(artists[0].name, "Red Hot Chili Peppers");
assert_eq!(artists[1].name, "Rick Astley");
}
#[tokio::test]
async fn test_get_artist_albums() {
let albums = client()
.artists()
.get_artist_albums(
"0L8ExT028jH3ddEcZwqJJ5",
Some(&[AlbumGroup::Single]),
2,
1,
Some(Market::Country(CountryCode::GBR)),
)
.await
.unwrap()
.data;
assert_eq!(albums.limit, 2);
assert_eq!(albums.offset, 1);
assert_eq!(albums.items.len(), 2);
assert!(albums
.items
.iter()
.all(|album| album.album_group == AlbumGroup::Single));
assert!(albums.items.iter().all(|album| album
.artists
.iter()
.any(|artist| artist.name == "Red Hot Chili Peppers")));
}
#[tokio::test]
async fn test_get_artist_top() {
let top = client()
.artists()
.get_artist_top("0L8ExT028jH3ddEcZwqJJ5", Market::Country(CountryCode::GBR))
.await
.unwrap()
.data;
assert!(top.iter().all(|track| track
.artists
.iter()
.any(|artist| artist.name == "Red Hot Chili Peppers")));
}
}