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

use async_trait::async_trait;

use crate::{client::SoundCloudClient, errors::{convert_404_to_invalid_id, ClientError}, http::{build_query, HttpError, Query}, models::{comment::BasicComment, playlist::BasicAlbumPlaylist, track::{BasicTrack, Track}, user::User}, need_authentication, utils::schemas::ResourceId, ClientResult};

use super::{convert_collection, convert_result, misc::MiscApi};

#[async_trait]
pub trait TracksApi {

    /// Returns the track with the given track_id.
    async fn get_track(&self, track_id: ResourceId) -> ClientResult<Track>;

    /// Returns the tracks with the given track_ids.
    /// Can be used to get track info for hidden tracks in a hidden playlist.
    /// Limit: 50 track_ids.
    async fn get_tracks(&self, track_ids: Vec<u64>, playlist_id: Option<u64>, playlist_secret_token: Option<String>) -> ClientResult<Vec<Track>>;

    /// Get albums that this track is in.
    async fn get_track_albums(&self, track_id: ResourceId) -> ClientResult<Vec<BasicAlbumPlaylist>>;

    /// Get playlists that this track is in.
    async fn get_track_playlists(&self, track_id: ResourceId) -> ClientResult<Vec<BasicAlbumPlaylist>>;

    /// Get comments on this track.
    async fn get_track_comments(&self, track_id: ResourceId, threaded: Option<u32>) -> ClientResult<Vec<BasicComment>>;

    /// Get users who liked this track.
    async fn get_track_likers(&self, track_id: ResourceId) -> ClientResult<Vec<User>>;

    /// Get users who reposted this track.
    async fn get_track_reposters(&self, track_id: ResourceId) -> ClientResult<Vec<User>>;

    /// Get related tracks.
    async fn get_related_tracks(&self, track_id: ResourceId) -> ClientResult<Vec<BasicTrack>>;

    /// Get track original download link. If track is private, requires secret token to be provided (last part of secret URL).
    /// ! Need authentication.
    async fn get_track_original_download_link(&self, track_id: ResourceId, secret_token: Option<String>) -> ClientResult<String>;
    
    // Utils

    /// Extracts the track id from the given track_id.
    async fn extract_track_id(&self, track_id: ResourceId) -> ClientResult<u64>;
}

#[async_trait]
impl TracksApi for SoundCloudClient {

    async fn get_track(&self, track_id: ResourceId) -> ClientResult<Track> {
        let uri = format!("/tracks/{}", self.extract_track_id(track_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_result(&result)
    }

    async fn get_tracks(&self, track_ids: Vec<u64>, playlist_id: Option<u64>, playlist_secret_token: Option<String>) -> ClientResult<Vec<Track>> {
        if track_ids.len() > 50 {
            return Err(ClientError::Custom("Limit of 50 track_ids exceeded".to_string()));
        }
        let uri = format!("/tracks");
        let mut query_params = Query::new();
        query_params.insert("ids".to_string(), track_ids.iter().map(|id| id.to_string()).collect::<Vec<String>>().join(","));
        if let Some(playlist_id) = playlist_id {
            query_params.insert("playlistId".to_string(), playlist_id.to_string());
        }
        if let Some(playlist_secret_token) = playlist_secret_token {
            query_params.insert("playlistSecretToken".to_string(), playlist_secret_token);
        }
        
        let result = self.api_get(&uri, query_params).await?;
        convert_result(&result)
    }

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

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

    async fn get_track_comments(&self, track_id: ResourceId, threaded: Option<u32>) -> ClientResult<Vec<BasicComment>> {
        let uri = format!("/tracks/{}/comments", self.extract_track_id(track_id).await?);
        let query_params = build_query([
            ("threaded", threaded.unwrap_or(0).to_string().as_str())
        ]);
        
        let result = self.api_get(&uri, query_params).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_track_likers(&self, track_id: ResourceId) -> ClientResult<Vec<User>> {
        let uri = format!("/tracks/{}/likers", self.extract_track_id(track_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

    async fn get_track_reposters(&self, track_id: ResourceId) -> ClientResult<Vec<User>> {
        let uri = format!("/tracks/{}/reposters", self.extract_track_id(track_id).await?);
        
        let result = self.api_get(&uri, Query::new()).await.map_err(convert_404_to_invalid_id)?;
        convert_collection(&result)
    }

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

    async fn get_track_original_download_link(&self, track_id: ResourceId, secret_token: Option<String>) -> ClientResult<String> {
        need_authentication!(self);
        let uri = format!("/tracks/{}/download", self.extract_track_id(track_id).await?);
        let mut query_params = Query::new();
        if let Some(secret_token) = secret_token {
            query_params.insert("secret_token".to_string(), secret_token);
        }
        
        let result = self.api_get(&uri, query_params).await
            .map_err(|error| {
                if let ClientError::Http(ref http_err) = error {
                    if let HttpError::StatusCode(response) = http_err.as_ref() {
                        if response.status() == reqwest::StatusCode::NOT_FOUND {
                            return ClientError::Custom("Invalid id or track has no original download link".to_string());
                        }
                    }
                }
                error
            })?;
        convert_result(&result)
    }
    
    // Utils

    async fn extract_track_id(&self, track_id: ResourceId) -> ClientResult<u64> {
        match track_id {
            ResourceId::Id(id) => Ok(id),
            ResourceId::Url(url) => {
                self.resolve_track(&url).await
                    .map(|t| t.track.id)
            },
            ResourceId::Uri(uri) => {
                self.resolve_track(&format!("https://soundcloud.com/{}", uri)).await
                    .map(|t| t.track.id)
            }
        }
    }
}