rsoundcloud 0.2.6

A SoundCloud API client
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233

use async_trait::async_trait;

use crate::{client::SoundCloudClient, errors::{convert_404_to_invalid_id, ClientError}, http::Query, models::{comment::Comment, conversation::Conversation, message::Message, playlist::BasicAlbumPlaylist, track::BasicTrack, user::{User, UserEmail}, web_profile::WebProfile, LikeItem, RepostItem, SearchItem, StreamItem}, need_authentication, utils::schemas::ResourceId, ClientResult};

use super::{convert_collection, convert_like_items, convert_repost_items, convert_result, convert_stream_items, misc::MiscApi};

#[async_trait]
pub trait UsersApi {

    /// Returns the user with the given user_id.
    async fn get_user(&self, user_id: ResourceId) -> ClientResult<User>;

    /// Returns the user with the given username.
    async fn get_user_by_username(&self, username: &str) -> ClientResult<User>;

    /// Get comments by this user.
    async fn get_user_comments(&self, user_id: ResourceId) -> ClientResult<Vec<Comment>>;

    /// Get user's email addresses. 
    /// ! Needs authentication.
    async fn get_user_emails(&self, user_id: ResourceId) -> ClientResult<Vec<UserEmail>>;

    /// Get profiles featured by this user.
    async fn get_user_featured_profiles(&self, user_id: ResourceId) -> ClientResult<Vec<User>>;

    /// Get followers of this user.
    async fn get_user_followers(&self, user_id: ResourceId) -> ClientResult<Vec<User>>;

    /// Get users followed by this user.
    async fn get_user_followings(&self, user_id: ResourceId) -> ClientResult<Vec<User>>;

    /// Get user's likes.
    async fn get_user_likes(&self, user_id: ResourceId) -> ClientResult<Vec<LikeItem>>;

    /// Get artists related to this user.
    async fn get_user_related_artists(&self, user_id: ResourceId) -> ClientResult<Vec<User>>;

    /// Get user's reposts.
    async fn get_user_reposts(&self, user_id: ResourceId) -> ClientResult<Vec<RepostItem>>;
    
    /// Get user's streams    
    async fn get_user_streams(&self, user_id: ResourceId) -> ClientResult<Vec<StreamItem>>;
    
    /// Get user's tracks.
    async fn get_user_tracks(&self, user_id: ResourceId) -> ClientResult<Vec<BasicTrack>>;

    /// Get user's popular tracks
    async fn get_user_popular_tracks(&self, user_id: ResourceId) -> ClientResult<Vec<BasicTrack>>;

    /// Get user's albums.
    async fn get_user_albums(&self, user_id: ResourceId) -> ClientResult<Vec<BasicAlbumPlaylist>>;

    /// Get user's playlists.
    async fn get_user_playlists(&self, user_id: ResourceId) -> ClientResult<Vec<BasicAlbumPlaylist>>;

    /// Get user's links.
    async fn get_user_links(&self, user_id: ResourceId) -> ClientResult<Vec<WebProfile>>;

    /// Get user's conversations
    /// ! Needs authentication.
    async fn get_user_conversations(&self, user_id: ResourceId) -> ClientResult<Vec<Conversation>>;

    /// Get conversation messages.
    /// ! Needs authentication.
    async fn get_conversation_messages(&self, user_id: ResourceId, conversation_id: u64) -> ClientResult<Vec<Message>>;

    /// Get unread conversations
    /// ! Needs authentication.
    async fn get_unread_conversations(&self, user_id: ResourceId) -> ClientResult<Vec<Conversation>>;    

    // Utils

    /// Extracts the user id from the given user_id.
    async fn extract_user_id(&self, user_id: ResourceId) -> ClientResult<u64>;
}

#[async_trait]
impl UsersApi for SoundCloudClient {

    async fn get_user(&self, user_id: ResourceId) -> ClientResult<User> {
        let uri = format!("/users/{}", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_result(&result)
    }

    async fn get_user_by_username(&self, username: &str) -> ClientResult<User> {
        let resource = self.resolve(format!("https://soundcloud.com/{}", username).as_str()).await?;
        match resource {
            SearchItem::User(user) => Ok(user),
            _ => Err(ClientError::NotFound)
        }
    }

    async fn get_user_comments(&self, user_id: ResourceId) -> ClientResult<Vec<Comment>> {
        let uri = format!("/users/{}/comments", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_user_emails(&self, user_id: ResourceId) -> ClientResult<Vec<UserEmail>> {
        need_authentication!(self);
        let uri = format!("/users/{}/emails", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_user_featured_profiles(&self, user_id: ResourceId) -> ClientResult<Vec<User>> {
        let uri = format!("/users/{}/featured-profiles", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_user_followers(&self, user_id: ResourceId) -> ClientResult<Vec<User>> {
        let uri = format!("/users/{}/followers", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_user_followings(&self, user_id: ResourceId) -> ClientResult<Vec<User>> {
        let uri = format!("/users/{}/followings", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_user_likes(&self, user_id: ResourceId) -> ClientResult<Vec<LikeItem>> {
        let uri = format!("/users/{}/likes", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_like_items(&result)
    }

    async fn get_user_related_artists(&self, user_id: ResourceId) -> ClientResult<Vec<User>> {
        let uri = format!("/users/{}/relatedartists", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_user_reposts(&self, user_id: ResourceId) -> ClientResult<Vec<RepostItem>> {
        let uri = format!("/stream/users/{}/reposts", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_repost_items(&result)
    }

    async fn get_user_streams(&self, user_id: ResourceId) -> ClientResult<Vec<StreamItem>> {
        let uri = format!("/stream/users/{}", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_stream_items(&result)
    }

    async fn get_user_tracks(&self, user_id: ResourceId) -> ClientResult<Vec<BasicTrack>> {
        let uri = format!("/users/{}/tracks", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_user_popular_tracks(&self, user_id: ResourceId) -> ClientResult<Vec<BasicTrack>> {
        let uri = format!("/users/{}/toptracks", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_user_albums(&self, user_id: ResourceId) -> ClientResult<Vec<BasicAlbumPlaylist>> {
        let uri = format!("/users/{}/albums", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_user_playlists(&self, user_id: ResourceId) -> ClientResult<Vec<BasicAlbumPlaylist>> {
        let uri = format!("/users/{}/playlists_without_albums", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_user_links(&self, user_id: ResourceId) -> ClientResult<Vec<WebProfile>> {
        let uri = format!("/users/soundcloud:users:{}/web-profiles", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_result(&result) // This endpoint returns a classic array, no need for collection conversion.
    }

    async fn get_user_conversations(&self, user_id: ResourceId) -> ClientResult<Vec<Conversation>> {
        need_authentication!(self);
        let uri = format!("/users/{}/conversations", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_conversation_messages(&self, user_id: ResourceId, conversation_id: u64) -> ClientResult<Vec<Message>> {
        need_authentication!(self);
        let uri = format!("/users/{}/conversations/{}/messages", self.extract_user_id(user_id).await?, conversation_id);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_unread_conversations(&self, user_id: ResourceId) -> ClientResult<Vec<Conversation>> {
        need_authentication!(self);
        let uri = format!("/users/{}/conversations/unread", self.extract_user_id(user_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    // Utils

    async fn extract_user_id(&self, user_id: ResourceId) -> ClientResult<u64> {
        match user_id {
            ResourceId::Id(id) => Ok(id),
            ResourceId::Url(url) => {
                self.resolve_user(&url).await
                    .map(|u| u.user.id)
            },
            ResourceId::Uri(uri) => {
                self.resolve_user(&format!("https://soundcloud.com/{}", uri)).await
                    .map(|u| u.user.id)
            }
        }
    }
}