interlude 0.1.0

Convert share links of different music streaming services.
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
use std::sync::Arc;

use tokio::sync::RwLock;

use reqwest::Client;
use rust_iso3166::CountryCode;
use serde::Deserialize;

use crate::{
    config::ClientCredentials,
    share_link::{LinkType, ShareLink, ShareObject},
    shared_item::{AlbumData, ArtistData, SongData},
};

use super::{
    ApiError,
    authorization::{AccessToken, AuthorizationError},
};

#[derive(Deserialize, Debug, Clone)]
struct QueryResult {
    data: Data,
    included: Option<Vec<Data>>,
}

#[derive(Debug, Clone, Deserialize)]
struct FilterQuery {
    data: Vec<Data>,
}

#[derive(Deserialize, Debug, Clone)]
struct Data {
    id: String,
    #[serde(flatten)]
    attributes: Attributes,
}

#[derive(Deserialize, Debug, Clone)]
#[serde(tag = "type", content = "attributes")]
enum Attributes {
    #[serde(rename = "tracks")]
    Tracks(TrackAttrs),
    #[serde(rename = "albums")]
    Albums(AlbumAttrs),
    #[serde(rename = "artists")]
    Artists(ArtistAttrs),
}

#[derive(Deserialize, Debug, Clone)]
struct TrackAttrs {
    pub title: String,
    pub isrc: String,
    pub duration: String,
}

#[derive(Deserialize, Debug, Clone)]
struct AlbumAttrs {
    pub title: String,
    #[serde(alias = "barcodeId")]
    pub upc: String,
}

#[derive(Deserialize, Debug, Clone)]
struct ArtistAttrs {
    pub name: String,
}

#[derive(Clone)]
pub struct TidalApi {
    client: Client,
    creds: ClientCredentials,
    access_token: Arc<RwLock<AccessToken>>,
}

const ISO_DURATION_ERR_MSG: &'static str = "Duration does not follow iso8601.";
const INCLUDE_ERR_MSG: &'static str =
    "Request with include query parameter did not return included in response.";

impl TidalApi {
    const BASE_URL: &'static str = "https://openapi.tidal.com/v2";
    const AUTH_ENDPOINT: &'static str = "https://auth.tidal.com/v1/oauth2/token";

    pub async fn new(
        client: &Client,
        credentials: &ClientCredentials,
    ) -> Result<Self, AuthorizationError> {
        Ok(Self {
            client: client.clone(),
            creds: credentials.clone(),
            access_token: Arc::new(RwLock::new(
                AccessToken::new(client, credentials, Self::AUTH_ENDPOINT).await?,
            )),
        })
    }

    async fn get_bearer_token(&self) -> Result<String, AuthorizationError> {
        {
            let token_ro = self.access_token.read().await;
            if !token_ro.is_expired() {
                return Ok(token_ro.token.clone());
            }
        }
        let mut token_w = self.access_token.write().await;
        token_w.refresh(&self.client, &self.creds).await?;
        return Ok(token_w.token.clone());
    }

    pub async fn get_song_data(&self, song_link: &ShareLink) -> Result<SongData, ApiError> {
        if song_link.link_type != LinkType::Tidal || song_link.share_obj != ShareObject::Song {
            return Err(ApiError::UnsuitableLink);
        }

        let cc = song_link.country_code.clone();
        let id = song_link.id.clone();

        let response = self
            .client
            .get(format!(
                "{}/tracks/{}?countryCode={}&include=albums,artists",
                Self::BASE_URL,
                id,
                cc.alpha2
            ))
            .bearer_auth(self.get_bearer_token().await?)
            .send()
            .await?
            .text()
            .await?;

        let results: QueryResult = serde_json::from_str(&response)?;

        let song_attrs = match results.data.attributes {
            Attributes::Tracks(attrs) => attrs,
            _ => return Err(ApiError::IncorrectAttributes),
        };
        let song_name = song_attrs.title;
        let song_isrc = song_attrs.isrc;
        let song_dur = iso8601_to_seconds(&song_attrs.duration).unwrap();

        let mut albums = Vec::new();
        let mut artists = Vec::new();

        for include in results.included.expect(INCLUDE_ERR_MSG) {
            match include.attributes {
                Attributes::Tracks(_) => return Err(ApiError::IncorrectAttributes),
                Attributes::Albums(attrs) => {
                    albums.push(AlbumData::with_limited_info(&attrs.title, &attrs.upc))
                }
                Attributes::Artists(attrs) => artists.push(ArtistData::without_albums(&attrs.name)),
            }
        }

        Ok(SongData::new(
            &song_name, &song_isrc, song_dur, albums, artists,
        ))
    }

    pub async fn get_album_data(&self, album_link: &ShareLink) -> Result<AlbumData, ApiError> {
        if album_link.link_type != LinkType::Tidal || album_link.share_obj != ShareObject::Album {
            return Err(ApiError::UnsuitableLink);
        }

        let cc = album_link.country_code.clone();
        let id = album_link.id.clone();

        let response = self
            .client
            .get(format!(
                "{}/albums/{}?countryCode={}&include=items,artists",
                Self::BASE_URL,
                id,
                cc.alpha2
            ))
            .bearer_auth(self.get_bearer_token().await?)
            .send()
            .await?
            .text()
            .await?;

        let results: QueryResult = serde_json::from_str(&response)?;
        let album_attrs = match results.data.attributes {
            Attributes::Albums(attrs) => attrs,
            _ => return Err(ApiError::IncorrectAttributes),
        };

        let album_name = album_attrs.title;
        let album_upc = album_attrs.upc;
        let mut songs: Vec<SongData> = Vec::new();
        let mut artists: Vec<ArtistData> = Vec::new();
        let includes = results.included.expect(INCLUDE_ERR_MSG);

        for include in includes {
            match include.attributes {
                Attributes::Artists(attrs) => artists.push(ArtistData::without_albums(&attrs.name)),
                Attributes::Tracks(attrs) => songs.push(SongData::new(
                    &attrs.title,
                    &attrs.isrc,
                    iso8601_to_seconds(&attrs.duration).expect(ISO_DURATION_ERR_MSG),
                    Vec::new(),
                    Vec::new(),
                )),
                _ => {}
            }
        }

        Ok(AlbumData::new(&album_name, &album_upc, songs, artists))
    }

    pub async fn get_artist_data(&self, artist_link: ShareLink) -> Result<ArtistData, ApiError> {
        #[derive(Deserialize, Debug, Clone)]
        struct RelationshipResults {
            links: Link,
            included: Vec<Data>,
        }

        #[derive(Deserialize, Debug, Clone)]
        struct Link {
            next: Option<String>,
        }

        if artist_link.link_type != LinkType::Tidal || artist_link.share_obj != ShareObject::Artist
        {
            return Err(ApiError::UnsuitableLink);
        }

        let cc = artist_link.country_code.clone();
        let id = artist_link.id.clone();

        let response = self
            .client
            .get(format!(
                "{}/artists/{}?countryCode={}",
                Self::BASE_URL,
                id,
                cc.alpha2
            ))
            .bearer_auth(self.get_bearer_token().await?)
            .send()
            .await?
            .text()
            .await?;

        let results: QueryResult = serde_json::from_str(&response)?;
        let artist_attrs = match results.data.attributes {
            Attributes::Artists(attrs) => attrs,
            _ => return Err(ApiError::IncorrectAttributes),
        };

        let artist_name = artist_attrs.name;

        let mut albums: Vec<AlbumData> = Vec::new();
        let response = self
            .client
            .get(format!(
                "{}/artists/{}/relationships/albums?countryCode={}&include=albums",
                Self::BASE_URL,
                id,
                cc.alpha2
            ))
            .bearer_auth(self.get_bearer_token().await?)
            .send()
            .await?
            .text()
            .await?;

        let mut results: RelationshipResults = serde_json::from_str(&response)?;

        // TODO: This needs a better solution
        let max_requests = 3; // in development mode a tidal application can make max 10 requests
        let mut request_counter = 0;

        loop {
            for item in results.included {
                let album_attrs = match item.attributes {
                    Attributes::Albums(attrs) => attrs,
                    _ => return Err(ApiError::IncorrectAttributes),
                };

                albums.push(AlbumData::with_limited_info(
                    &album_attrs.title,
                    &album_attrs.upc,
                ))
            }

            if request_counter == max_requests {
                break;
            }

            match results.links.next {
                None => break,
                Some(link) => {
                    let response = self
                        .client
                        .get(format!("{}{}", Self::BASE_URL, &link))
                        .bearer_auth(self.get_bearer_token().await?)
                        .send()
                        .await?
                        .text()
                        .await?;

                    request_counter += 1;
                    results = serde_json::from_str(&response)?;
                }
            }
        }

        return Ok(ArtistData::new(&artist_name, albums));
    }

    pub async fn get_song_link(
        &self,
        song_data: &SongData,
        country_code: &CountryCode,
    ) -> Result<ShareLink, ApiError> {
        let response = self
            .client
            .get(format!(
                "{}/tracks?countryCode={}&filter[isrc]={}",
                Self::BASE_URL,
                country_code.alpha2,
                song_data.isrc
            ))
            .bearer_auth(self.get_bearer_token().await?)
            .send()
            .await?
            .text()
            .await?;

        let results: FilterQuery = serde_json::from_str(&response)?;
        for item in results.data {
            let share_link = ShareLink::new(LinkType::Tidal, ShareObject::Song, &item.id, country_code);
                return Ok(share_link);
        }
        Err(ApiError::UnsuccessfulConversion)
    }

    pub async fn get_album_link(
        &self,
        album_data: &AlbumData,
        country_code: &CountryCode,
    ) -> Result<ShareLink, ApiError> {
        let response = self
            .client
            .get(format!(
                "{}/albums?countryCode={}&filter[barcodeId]={}",
                Self::BASE_URL,
                country_code.alpha2,
                album_data.upc
            ))
            .bearer_auth(self.get_bearer_token().await?)
            .send()
            .await?
            .text()
            .await?;

        let results: FilterQuery = serde_json::from_str(&response)?;
        if results.data.len() == 0 {
            Err(ApiError::UnsuccessfulConversion)
        } else {
            Ok(ShareLink::new(
                LinkType::Tidal,
                ShareObject::Album,
                &results.data[0].id,
                &country_code,
            ))
        }
    }

    const PREFERRED_MAX_IMAGE_SIZE: u16 = 800;
    const PREFERRED_MIN_IMAGE_SIZE: u16 = 300;

    pub async fn get_cover_art(
        &self,
        album_data: &AlbumData,
        country_code: &CountryCode,
    ) -> Result<String, ApiError> {
        #[derive(Deserialize)]
        struct CoverArtQueryResult {
            included: Vec<Include>,
        }
        #[derive(Deserialize)]
        struct Include {
            attributes: IncludeAttrs,
        }
        #[derive(Deserialize)]
        struct IncludeAttrs {
            files: Vec<ImageFile>,
        }
        #[derive(Deserialize)]
        struct ImageFile {
            href: String,
            meta: MetaData,
        }
        #[derive(Deserialize)]
        struct MetaData {
            width: u16,
        }

        let response = self
            .client
            .get(format!(
                "{}/albums?countryCode={}&filter[barcodeId]={}&include=coverArt",
                Self::BASE_URL,
                country_code.alpha2,
                album_data.upc
            ))
            .bearer_auth(self.get_bearer_token().await?)
            .send()
            .await?
            .text()
            .await?;

        let result: CoverArtQueryResult = serde_json::from_str(&response)?;
        if result.included.is_empty() {
            return Ok(String::from(""));
        }
        if result.included[0].attributes.files.is_empty() {
            return Ok(String::from(""));
        }

        let images = &result.included[0].attributes.files;

        let mut chosen_image_link = images[0].href.clone();

        for image in images {
            if image.meta.width <= Self::PREFERRED_MAX_IMAGE_SIZE
                && image.meta.width >= Self::PREFERRED_MIN_IMAGE_SIZE
            {
                chosen_image_link = image.href.clone();
            }
        }

        Ok(chosen_image_link)
    }
}

fn iso8601_to_seconds(iso8601_duration: &str) -> Result<u64, String> {
    let iso_dur = iso8601::duration(iso8601_duration).unwrap();
    match iso_dur {
        iso8601::Duration::Weeks(_) => {
            return Err(String::from("Week long durations  are not supported."));
        }
        iso8601::Duration::YMDHMS {
            year,
            month,
            day,
            hour,
            minute,
            second,
            millisecond,
        } => {
            if year != 0 {
                return Err(String::from("Year long durations are not supported."));
            }
            if month != 0 {
                return Err(String::from("Month long durations are not supported."));
            }
            let mut seconds: u64 = if millisecond > 500 { 1 } else { 0 };
            seconds += u64::from(second);
            seconds += u64::from(minute) * 60;
            seconds += u64::from(hour) * 60 * 60;
            seconds += u64::from(day) * 24 * 60 * 60;
            return Ok(seconds);
        }
    }
}