qobuz-api 4.0.0

A Rust client library for the Qobuz music streaming API
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

//! Service delegates for user library (favorites) operations.

use tokio::runtime::Runtime;

use crate::api::{
    content::records::UserFavorites,
    favorites::{
        add_user_favorites, delete_user_favorites, get_user_favorite_ids, get_user_favorites,
    },
    service_state::QobuzApiService,
};

impl QobuzApiService {
    delegate!(
        /// Adds items to the user's favorites.
        ///
        /// # Arguments
        ///
        /// * `item_ids` - IDs of items to favorite
        /// * `item_type` - Type of items (`"album"`, `"artist"`, or `"track"`)
        ///
        /// # Returns
        ///
        /// `Ok(())` on success.
        pub fn add_user_favorites(item_ids: &[i32], item_type: &str) -> () = add_user_favorites
    );

    delegate!(
        /// Removes items from the user's favorites.
        ///
        /// # Arguments
        ///
        /// * `item_ids` - IDs of items to remove
        /// * `item_type` - Type of items (`"album"`, `"artist"`, or `"track"`)
        ///
        /// # Returns
        ///
        /// `Ok(())` on success.
        pub fn delete_user_favorites(item_ids: &[i32], item_type: &str) -> () = delete_user_favorites
    );

    delegate!(
        /// Retrieves the user's favorites list.
        ///
        /// # Arguments
        ///
        /// * `item_type` - Type of items to retrieve
        /// * `limit` - Maximum number of results
        /// * `offset` - Pagination offset
        ///
        /// # Returns
        ///
        /// The user's favorited items grouped by type.
        pub fn get_user_favorites(item_type: &str, limit: Option<i32>, offset: Option<i32>) -> UserFavorites = get_user_favorites
    );

    delegate!(
        /// Retrieves only the favorite IDs grouped by type.
        ///
        /// # Returns
        ///
        /// The user's favorite IDs grouped by type.
        pub fn get_user_favorite_ids() -> UserFavorites = get_user_favorite_ids
    );
}

#[cfg(test)]
mod tests {
    use anyhow::{Result, ensure};

    use crate::api::dev_server::{MockServer, make_service};

    #[test]
    fn add_user_favorites_succeeds() -> Result<()> {
        let server = MockServer::start(200, "{}")?;
        let service = make_service(&server.base_url())?;
        service.add_user_favorites(&[1, 2], "track")?;
        Ok(())
    }

    #[test]
    fn delete_user_favorites_succeeds() -> Result<()> {
        let server = MockServer::start(200, "{}")?;
        let service = make_service(&server.base_url())?;
        service.delete_user_favorites(&[1, 2], "track")?;
        Ok(())
    }

    #[test]
    fn get_user_favorites_returns_ids() -> Result<()> {
        let server = MockServer::start(200, r#"{"track_ids":[1,2]}"#)?;
        let service = make_service(&server.base_url())?;
        let favorites = service.get_user_favorites("track", Some(50), None)?;
        ensure!(favorites.track_ids == Some(vec![1, 2]));
        Ok(())
    }

    #[test]
    fn get_user_favorite_ids_returns_ids() -> Result<()> {
        let server = MockServer::start(200, r#"{"track_ids":[7]}"#)?;
        let service = make_service(&server.base_url())?;
        let favorites = service.get_user_favorite_ids()?;
        ensure!(favorites.track_ids == Some(vec![7]));
        Ok(())
    }
}