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
//! Endpoints relating to saving albums and tracks.

use crate::*;

/// Check if the current user has saved some albums.
///
/// Returns vector of bools that is in the same order as the given ids, telling whether the user
/// has saved each album. Requires `user-library-read`.
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/library/check-users-saved-albums/).
pub async fn user_saved_albums(
    token: &AccessToken,
    ids: &[&str],
) -> Result<Vec<bool>, EndpointError<Error>> {
    if ids.is_empty() {
        return Ok(Vec::new());
    }
    Ok(request!(
        token,
        GET "/v1/me/albums/contains",
        query_params = {"ids": ids.join(",")},
        ret = Vec<bool>
    ))
}

/// Check if the current user has saved some tracks.
///
/// Returns vector of bools that is in the same order as the given ids, telling whether the user
/// has saved each track. Requires `user-library-read`.
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/library/check-users-saved-tracks/).
pub async fn user_saved_tracks(
    token: &AccessToken,
    ids: &[&str],
) -> Result<Vec<bool>, EndpointError<Error>> {
    if ids.is_empty() {
        return Ok(Vec::new());
    }
    Ok(request!(
        token,
        GET "/v1/me/tracks/contains",
        query_params = {"ids": ids.join(",")},
        ret = Vec<bool>
    ))
}

/// Get the current user's saved albums.
///
/// Requires `user-library-read`. Limit must be in the range [1..50].
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/library/get-users-saved-albums/).
pub async fn get_saved_albums(
    token: &AccessToken,
    limit: usize,
    offset: usize,
    market: Option<Market>,
) -> Result<Page<SavedAlbum>, EndpointError<Error>> {
    Ok(request!(
        token,
        GET "/v1/me/albums",
        query_params = {"limit": limit.to_string(), "offset": offset.to_string()},
        optional_query_params = {"market": market.map(|m| m.as_str())},
        ret = Page<SavedAlbum>
    ))
}

/// Get the current user's saved tracks.
///
/// Requires `user-library-read`. Limit must be in the range [1..50].
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/library/get-users-saved-tracks/).
pub async fn get_saved_tracks(
    token: &AccessToken,
    limit: usize,
    offset: usize,
    market: Option<Market>,
) -> Result<Page<SavedTrack>, EndpointError<Error>> {
    Ok(request!(
        token,
        GET "/v1/me/tracks",
        query_params = {"limit": limit.to_string(), "offset": offset.to_string()},
        optional_query_params = {"market": market.map(|m| m.as_str())},
        ret = Page<SavedTrack>
    ))
}

/// Unsave some of the current user's saved albums.
///
/// Requires `user-library-modify`. Maximum of 50 ids.
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/library/remove-albums-user/).
pub async fn unsave_albums(token: &AccessToken, ids: &[&str]) -> Result<(), EndpointError<Error>> {
    if ids.is_empty() {
        return Ok(());
    }
    request!(
        token,
        DELETE "/v1/me/albums",
        query_params = {"ids": ids.join(",")},
        body = "{}"
    );
    Ok(())
}

/// Unsave some of the current user's saved tracks.
///
/// Requires `user-library-modify`. Maximum of 50 ids.
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/library/remove-tracks-user/).
pub async fn unsave_tracks(token: &AccessToken, ids: &[&str]) -> Result<(), EndpointError<Error>> {
    if ids.is_empty() {
        return Ok(());
    }
    request!(
        token,
        DELETE "/v1/me/tracks",
        query_params = {"ids": ids.join(",")},
        body = "{}"
    );
    Ok(())
}

/// Save albums for the current user.
///
/// Requires `user-library-modify`. Maximum of 50 ids.
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/library/save-albums-user/).
pub async fn save_albums(token: &AccessToken, ids: &[&str]) -> Result<(), EndpointError<Error>> {
    if ids.is_empty() {
        return Ok(());
    }
    request!(
        token,
        PUT "/v1/me/albums",
        query_params = {"ids": ids.join(",")},
        body = "{}"
    );
    Ok(())
}

/// Save tracks for the current user.
///
/// Requires `user-library-modify`. Maximum of 50 ids.
///
/// [Reference](https://developer.spotify.com/documentation/web-api/reference/library/save-albums-user/).
pub async fn save_tracks(token: &AccessToken, ids: &[&str]) -> Result<(), EndpointError<Error>> {
    if ids.is_empty() {
        return Ok(());
    }
    request!(
        token,
        PUT "/v1/me/tracks",
        query_params = {"ids": ids.join(",")},
        body = "{}"
    );
    Ok(())
}

#[cfg(test)]
mod tests {
    use crate::endpoints::token;
    use crate::*;

    #[tokio::test]
    async fn test_save_albums() {
        let token = token().await;

        // "Wish", "The Black Parade", and "Spirit Phone"
        let albums = &[
            "0aEL0zQ4XLuxQP0j7sLlS1",
            "0FZK97MXMm5mUQ8mtudjuK",
            "4ocal2JegUDVQdP6KN1roI",
        ];
        let split = 2;
        let (saved_albums, unsaved_albums) = albums.split_at(split);

        // Store old saved status to restore
        let old = user_saved_albums(&token, albums).await.unwrap();

        // Saving and unsaving
        save_albums(&token, saved_albums).await.unwrap();
        unsave_albums(&token, unsaved_albums).await.unwrap();

        // Check
        let check = user_saved_albums(&token, albums).await.unwrap();
        let (save_check, unsave_check) = check.split_at(split);
        assert!(save_check.into_iter().all(|&saved| saved));
        assert!(unsave_check.into_iter().all(|&saved| !saved));

        // Check by finding in list
        let saved = get_saved_albums(&token, 50, 0, None).await.unwrap();
        if saved.total <= 50 {
            for saved_album in saved_albums {
                assert!(saved
                    .items
                    .iter()
                    .any(|album| album.album.id == *saved_album));
            }
            for unsaved_album in unsaved_albums {
                assert!(saved
                    .items
                    .iter()
                    .all(|album| album.album.id != *unsaved_album));
            }
        }

        // Restore
        let mut old_saved = Vec::with_capacity(albums.len());
        let mut old_unsaved = Vec::with_capacity(albums.len());
        for i in 0..albums.len() {
            if old[i] {
                &mut old_saved
            } else {
                &mut old_unsaved
            }
            .push(albums[i]);
        }
        save_albums(&token, &old_saved).await.unwrap();
        unsave_albums(&token, &old_unsaved).await.unwrap();
    }

    #[tokio::test]
    async fn test_save_tracks() {
        let token = token().await;

        // "Friday I'm In Love" and "Spiral of Ants"
        let tracks = &["4QlzkaRHtU8gAdwqjWmO8n", "77hzctaLvLRLAh71LwNPE3"];
        let split = 1;
        let (saved_tracks, unsaved_tracks) = tracks.split_at(split);

        // Store old saved status to restore
        let old = user_saved_tracks(&token, tracks).await.unwrap();

        // Saving and unsaving
        save_tracks(&token, saved_tracks).await.unwrap();
        unsave_tracks(&token, unsaved_tracks).await.unwrap();

        // Check
        let check = user_saved_tracks(&token, tracks).await.unwrap();
        let (save_check, unsave_check) = check.split_at(split);
        assert!(save_check.into_iter().all(|&saved| saved));
        assert!(unsave_check.into_iter().all(|&saved| !saved));

        // Check by finding in list, only if it has them all
        let saved = get_saved_tracks(&token, 50, 0, None).await.unwrap();
        if saved.total <= 50 {
            for saved_track in saved_tracks {
                assert!(saved
                    .items
                    .iter()
                    .any(|track| track.track.id == *saved_track));
            }
            for unsaved_track in unsaved_tracks {
                assert!(saved
                    .items
                    .iter()
                    .all(|track| track.track.id != *unsaved_track));
            }
        }

        // Restore
        let mut old_saved = Vec::with_capacity(tracks.len());
        let mut old_unsaved = Vec::with_capacity(tracks.len());
        for i in 0..tracks.len() {
            if old[i] {
                &mut old_saved
            } else {
                &mut old_unsaved
            }
            .push(tracks[i]);
        }
        save_tracks(&token, &old_saved).await.unwrap();
        unsave_tracks(&token, &old_unsaved).await.unwrap();
    }
}