bpi-rs 0.2.0

Bilibili API client library for Rust
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

use crate::opus::{OpusSpaceFeedParams, SpaceData};
use crate::{BilibiliRequest, BpiClient, BpiResult};

const SPACE_FEED_ENDPOINT: &str =
    "https://api.bilibili.com/x/polymer/web-dynamic/v1/opus/feed/space";

/// Opus API client.
#[derive(Clone, Copy)]
pub struct OpusClient<'a> {
    pub(crate) client: &'a BpiClient,
}

impl<'a> OpusClient<'a> {
    pub(crate) fn new(client: &'a BpiClient) -> Self {
        Self { client }
    }

    #[cfg(test)]
    pub(crate) fn space_feed_endpoint(&self) -> &'static str {
        SPACE_FEED_ENDPOINT
    }

    /// Gets opus items from a user's space feed.
    pub async fn space_feed(&self, params: OpusSpaceFeedParams) -> BpiResult<SpaceData> {
        self.client
            .get(SPACE_FEED_ENDPOINT)
            .query(&params.query_pairs())
            .send_bpi_payload("opus.space_feed")
            .await
    }
}

#[cfg(test)]
mod tests {
    use std::future::Future;

    use crate::ids::Mid;
    use crate::opus::{OpusSpaceFeedParams, SpaceData};
    use crate::probe::contract::HttpMethod;
    use crate::probe::endpoint_contract::EndpointContract;
    use crate::{BpiClient, BpiResult};

    fn assert_space_feed_future<F>(_future: F)
    where
        F: Future<Output = BpiResult<SpaceData>>,
    {
    }

    fn contract() -> BpiResult<EndpointContract> {
        EndpointContract::from_slice(include_bytes!(
            "../../tests/contracts/opus/space-read/space-feed/contract.json"
        ))
    }

    #[test]
    fn opus_client_exposes_promoted_endpoint_url() -> BpiResult<()> {
        let client = BpiClient::new()?;
        let opus = client.opus();

        assert_eq!(
            opus.space_feed_endpoint(),
            "https://api.bilibili.com/x/polymer/web-dynamic/v1/opus/feed/space"
        );
        Ok(())
    }

    #[test]
    fn opus_space_feed_returns_payload_future() -> BpiResult<()> {
        let client = BpiClient::new()?;
        let opus = client.opus();

        assert_space_feed_future(opus.space_feed(OpusSpaceFeedParams::new(Mid::new(4_279_370)?)));
        Ok(())
    }

    #[test]
    fn opus_contract_matches_module_client_endpoint() -> BpiResult<()> {
        let client = BpiClient::new()?;
        let opus = client.opus();
        let contract = contract()?;

        assert_eq!(contract.name, "opus.space_feed");
        assert_eq!(contract.request.method, HttpMethod::Get);
        assert_eq!(contract.request.url.as_str(), opus.space_feed_endpoint());
        assert_eq!(
            contract.request.query.get("host_mid").map(String::as_str),
            Some("4279370")
        );
        assert_eq!(
            contract.request.query.get("page").map(String::as_str),
            Some("0")
        );
        assert_eq!(
            contract.request.query.get("type").map(String::as_str),
            Some("all")
        );
        assert_eq!(
            contract
                .request
                .query
                .get("web_location")
                .map(String::as_str),
            Some("333.1387")
        );
        Ok(())
    }
}