spotify_web_api 0.2.0

A wrapper for the Spotify Web 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

use crate::api::prelude::*;

/// Seeks to the given position in the user’s currently playing track.
/// This API only works for users who have Spotify Premium.
/// The order of execution is not guaranteed when you use this API with other Player API endpoints.
#[derive(Default, Debug, Clone)]
pub struct SeekToPosition {
    /// The id of the device this command is targeting. If not supplied, the user's currently active device is the target.
    pub device_id: Option<String>,

    /// The position in milliseconds to seek to.
    /// Passing in a position that is greater than the length of the track will cause the player to start playing the next song.
    pub position_ms: u32,
}

impl From<u32> for SeekToPosition {
    fn from(position_ms: u32) -> Self {
        Self {
            position_ms,
            ..Self::default()
        }
    }
}

impl Endpoint for SeekToPosition {
    fn method(&self) -> Method {
        Method::PUT
    }

    fn endpoint(&self) -> Cow<'static, str> {
        "me/player/seek".into()
    }

    fn parameters(&self) -> QueryParams<'_> {
        let mut params = QueryParams::default();
        params.push("position_ms", &self.position_ms);
        params.push_opt("device_id", self.device_id.as_ref());
        params
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        api::{self, Query as _},
        test::client::{ExpectedUrl, SingleTestClient},
    };

    #[test]
    fn test_seek_to_position_endpoint() {
        let endpoint = ExpectedUrl::builder()
            .method(Method::PUT)
            .endpoint("me/player/seek")
            .add_query_params(&[("position_ms", "1000")])
            .build();
        let client = SingleTestClient::new_raw(endpoint, "");
        api::ignore(SeekToPosition::from(1000))
            .query(&client)
            .unwrap();
    }
}