opensubsonic 0.3.0

Complete async Rust client for the OpenSubsonic/Subsonic REST API
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
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

//! User Management API endpoints.

use crate::Client;
use crate::data::User;
use crate::error::Error;

impl Client {
    /// Get details about a specific user.
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/getuser/>
    pub async fn get_user(&self, username: &str) -> Result<User, Error> {
        let data = self
            .get_response("getUser", &[("username", username)])
            .await?;
        let user = data
            .get("user")
            .ok_or_else(|| Error::Parse("Missing 'user' in response".into()))?;
        Ok(serde_json::from_value(user.clone())?)
    }

    /// Get details about all users (admin only).
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/getusers/>
    pub async fn get_users(&self) -> Result<Vec<User>, Error> {
        let data = self.get_response("getUsers", &[]).await?;
        let users = data
            .get("users")
            .and_then(|v| v.get("user"))
            .cloned()
            .unwrap_or_else(|| serde_json::Value::Array(vec![]));
        Ok(serde_json::from_value(users)?)
    }

    /// Create a new user (admin only).
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/createuser/>
    #[allow(clippy::too_many_arguments)]
    pub async fn create_user(
        &self,
        username: &str,
        password: &str,
        email: &str,
        ldap_authenticated: Option<bool>,
        admin_role: Option<bool>,
        settings_role: Option<bool>,
        stream_role: Option<bool>,
        jukebox_role: Option<bool>,
        download_role: Option<bool>,
        upload_role: Option<bool>,
        playlist_role: Option<bool>,
        cover_art_role: Option<bool>,
        comment_role: Option<bool>,
        podcast_role: Option<bool>,
        share_role: Option<bool>,
        video_conversion_role: Option<bool>,
        music_folder_ids: &[i64],
    ) -> Result<(), Error> {
        let mut params = vec![
            ("username", username.to_string()),
            ("password", password.to_string()),
            ("email", email.to_string()),
        ];
        if let Some(v) = ldap_authenticated {
            params.push(("ldapAuthenticated", v.to_string()));
        }
        if let Some(v) = admin_role {
            params.push(("adminRole", v.to_string()));
        }
        if let Some(v) = settings_role {
            params.push(("settingsRole", v.to_string()));
        }
        if let Some(v) = stream_role {
            params.push(("streamRole", v.to_string()));
        }
        if let Some(v) = jukebox_role {
            params.push(("jukeboxRole", v.to_string()));
        }
        if let Some(v) = download_role {
            params.push(("downloadRole", v.to_string()));
        }
        if let Some(v) = upload_role {
            params.push(("uploadRole", v.to_string()));
        }
        if let Some(v) = playlist_role {
            params.push(("playlistRole", v.to_string()));
        }
        if let Some(v) = cover_art_role {
            params.push(("coverArtRole", v.to_string()));
        }
        if let Some(v) = comment_role {
            params.push(("commentRole", v.to_string()));
        }
        if let Some(v) = podcast_role {
            params.push(("podcastRole", v.to_string()));
        }
        if let Some(v) = share_role {
            params.push(("shareRole", v.to_string()));
        }
        if let Some(v) = video_conversion_role {
            params.push(("videoConversionRole", v.to_string()));
        }
        for folder_id in music_folder_ids {
            params.push(("musicFolderId", folder_id.to_string()));
        }
        let param_refs: Vec<(&str, &str)> = params.iter().map(|(k, v)| (*k, v.as_str())).collect();
        self.get_response("createUser", &param_refs).await?;
        Ok(())
    }

    /// Update an existing user (admin only).
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/updateuser/>
    #[allow(clippy::too_many_arguments)]
    pub async fn update_user(
        &self,
        username: &str,
        password: Option<&str>,
        email: Option<&str>,
        ldap_authenticated: Option<bool>,
        admin_role: Option<bool>,
        settings_role: Option<bool>,
        stream_role: Option<bool>,
        jukebox_role: Option<bool>,
        download_role: Option<bool>,
        upload_role: Option<bool>,
        playlist_role: Option<bool>,
        cover_art_role: Option<bool>,
        comment_role: Option<bool>,
        podcast_role: Option<bool>,
        share_role: Option<bool>,
        video_conversion_role: Option<bool>,
        max_bit_rate: Option<i32>,
        music_folder_ids: &[i64],
    ) -> Result<(), Error> {
        let mut params = vec![("username", username.to_string())];
        if let Some(v) = password {
            params.push(("password", v.to_string()));
        }
        if let Some(v) = email {
            params.push(("email", v.to_string()));
        }
        if let Some(v) = ldap_authenticated {
            params.push(("ldapAuthenticated", v.to_string()));
        }
        if let Some(v) = admin_role {
            params.push(("adminRole", v.to_string()));
        }
        if let Some(v) = settings_role {
            params.push(("settingsRole", v.to_string()));
        }
        if let Some(v) = stream_role {
            params.push(("streamRole", v.to_string()));
        }
        if let Some(v) = jukebox_role {
            params.push(("jukeboxRole", v.to_string()));
        }
        if let Some(v) = download_role {
            params.push(("downloadRole", v.to_string()));
        }
        if let Some(v) = upload_role {
            params.push(("uploadRole", v.to_string()));
        }
        if let Some(v) = playlist_role {
            params.push(("playlistRole", v.to_string()));
        }
        if let Some(v) = cover_art_role {
            params.push(("coverArtRole", v.to_string()));
        }
        if let Some(v) = comment_role {
            params.push(("commentRole", v.to_string()));
        }
        if let Some(v) = podcast_role {
            params.push(("podcastRole", v.to_string()));
        }
        if let Some(v) = share_role {
            params.push(("shareRole", v.to_string()));
        }
        if let Some(v) = video_conversion_role {
            params.push(("videoConversionRole", v.to_string()));
        }
        if let Some(v) = max_bit_rate {
            params.push(("maxBitRate", v.to_string()));
        }
        for folder_id in music_folder_ids {
            params.push(("musicFolderId", folder_id.to_string()));
        }
        let param_refs: Vec<(&str, &str)> = params.iter().map(|(k, v)| (*k, v.as_str())).collect();
        self.get_response("updateUser", &param_refs).await?;
        Ok(())
    }

    /// Delete a user (admin only).
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/deleteuser/>
    pub async fn delete_user(&self, username: &str) -> Result<(), Error> {
        self.get_response("deleteUser", &[("username", username)])
            .await?;
        Ok(())
    }

    /// Change a user's password.
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/changepassword/>
    pub async fn change_password(&self, username: &str, password: &str) -> Result<(), Error> {
        self.get_response(
            "changePassword",
            &[("username", username), ("password", password)],
        )
        .await?;
        Ok(())
    }
}