aspotify 0.7.1

Deprecated in favour of rspotify
Documentation 
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

use crate::{Artist, Client, Error, Page, Response, TimeRange, Track};

/// Endpoint functions relating to a user's top artists and tracks.
#[derive(Debug, Clone, Copy)]
pub struct Personalization<'a>(pub &'a Client);

impl Personalization<'_> {
    /// Get a user's top artists.
    ///
    /// Requires `user-top-read`.
    ///
    /// [Reference](https://developer.spotify.com/documentation/web-api/reference/personalization/get-users-top-artists-and-tracks/).
    pub async fn get_top_artists(
        self,
        limit: usize,
        offset: usize,
        time_range: TimeRange,
    ) -> Result<Response<Page<Artist>>, Error> {
        self.0
            .send_json(self.0.client.get(endpoint!("/v1/me/top/artists")).query(&(
                ("limit", limit.to_string()),
                ("offset", offset.to_string()),
                ("time_range", time_range.as_str()),
            )))
            .await
    }

    /// Get a user's top tracks.
    ///
    /// Requires `user-top-read`.
    ///
    /// [Reference](https://developer.spotify.com/documentation/web-api/reference/personalization/get-users-top-tracks-and-tracks/).
    pub async fn get_top_tracks(
        self,
        limit: usize,
        offset: usize,
        time_range: TimeRange,
    ) -> Result<Response<Page<Track>>, Error> {
        self.0
            .send_json(self.0.client.get(endpoint!("/v1/me/top/tracks")).query(&(
                ("limit", limit.to_string()),
                ("offset", offset.to_string()),
                ("time_range", time_range.as_str()),
            )))
            .await
    }
}

#[cfg(test)]
mod tests {
    use crate::endpoints::client;
    use crate::TimeRange;

    #[tokio::test]
    async fn test() {
        let client = client();
        let personalization = client.personalization();

        let top = personalization
            .get_top_artists(5, 2, TimeRange::Short)
            .await
            .unwrap()
            .data;
        assert_eq!(top.limit, 5);
        assert_eq!(top.offset, 2);
        assert!(top.items.len() <= 5);

        let top = personalization
            .get_top_tracks(2, 8, TimeRange::Long)
            .await
            .unwrap()
            .data;
        assert_eq!(top.limit, 2);
        assert_eq!(top.offset, 8);
        assert!(top.items.len() <= 2);
    }
}