tidlers 0.1.1

A Rust library for interacting with the TIDAL music streaming 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

pub mod api;
pub mod auth;
pub mod data;
pub mod models;
pub mod oauth;

use crate::{
    auth::init::TidalAuth,
    client::models::{
        playback::{AudioQuality, PlaybackMode},
        user::User,
    },
    error::TidalError,
    requests::{self, RequestClient},
    session::TidalSession,
};

/// Main client for interacting with the Tidal API
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct TidalClient {
    pub user_info: Option<User>,

    pub session: TidalSession,

    #[serde(skip_serializing, skip_deserializing)]
    pub(crate) rq: requests::RequestClient,

    #[serde(skip_serializing, skip_deserializing)]
    pub(crate) debug_mode: bool,
}

impl TidalClient {
    pub const API_V1_LOCATION: &'static str = "https://api.tidal.com/v1";
    pub const API_V2_LOCATION: &'static str = "https://api.tidal.com/v2";
    pub const OPEN_API_V2_LOCATION: &'static str = "https://openapi.tidal.com/v2";
    pub const WEB_API_V2_LOCATION: &'static str = "https://tidal.com/v2";

    /// Creates a new TidalClient with the provided authentication credentials
    ///
    /// # Example
    ///
    /// ```
    /// # use tidlers::{TidalClient, auth::init::TidalAuth};
    /// let auth = TidalAuth::with_oauth();
    /// let client = TidalClient::new(&auth);
    /// ```
    pub fn new(credentials: &TidalAuth) -> TidalClient {
        let session = TidalSession::new(credentials);
        let rq = RequestClient::new(Self::API_V1_LOCATION.to_string());
        TidalClient {
            user_info: None,
            session,
            rq,
            debug_mode: false,
        }
    }

    /// Checks if the client is waiting for OAuth login completion
    pub fn waiting_for_oauth_login(&self) -> bool {
        self.session.auth.oauth_login && self.session.auth.access_token.is_none()
    }

    fn check_auth(&self) -> Result<bool, TidalError> {
        if self.session.auth.access_token.is_none() {
            Err(TidalError::NotAuthenticated)
        } else {
            Ok(true)
        }
    }

    pub(crate) fn user_id(&self) -> Result<u64, TidalError> {
        self.user_info
            .as_ref()
            .map(|u| u.user_id)
            .ok_or(TidalError::NotAuthenticated)
    }

    /// Sets the audio quality preference for playback
    ///
    /// # Example
    ///
    /// ```
    /// # use tidlers::{TidalClient, auth::init::TidalAuth};
    /// # use tidlers::client::models::playback::AudioQuality;
    /// let auth = TidalAuth::with_oauth();
    /// let mut client = TidalClient::new(&auth);
    /// client.set_audio_quality(AudioQuality::HiRes);
    /// ```
    pub fn set_audio_quality(&mut self, quality: AudioQuality) {
        self.session.audio_quality = quality;
    }

    /// Sets the time offset for the session
    pub fn set_time_offset(&mut self, time_offset: String) {
        self.session.time_offset = time_offset;
    }

    /// Sets the playback mode (stream or offline)
    pub fn set_playback_mode(&mut self, playback_mode: PlaybackMode) {
        self.session.playback_mode = playback_mode;
    }

    /// Enables or disables debug mode for verbose logging
    pub fn set_debug_mode(&mut self, debug: bool) {
        self.debug_mode = debug;
    }

    pub async fn home(&self) -> Result<(), TidalError> {
        self.check_auth()?;

        // TODO: Implement home page functionality
        // self.page.r_get("pages/home");
        Ok(())
        // Ok(self.page.get("pages/home").await?)
    }
}

impl Default for TidalClient {
    fn default() -> Self {
        Self::new(&TidalAuth::new())
    }
}