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

use crate::vip::center::VipCenterData;
use crate::vip::params::VipCenterInfoParams;
use crate::{BilibiliRequest, BpiClient, BpiResult};

const CENTER_INFO_ENDPOINT: &str = "https://api.bilibili.com/x/vip/web/vip_center/combine";

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

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

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

    /// Gets VIP center information.
    pub async fn center_info(&self, params: VipCenterInfoParams) -> BpiResult<VipCenterData> {
        self.client
            .get(CENTER_INFO_ENDPOINT)
            .query(&params.query_pairs())
            .send_bpi_payload("vip.center_info")
            .await
    }
}

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

    use crate::probe::contract::HttpMethod;
    use crate::probe::endpoint_contract::EndpointContract;
    use crate::vip::center::VipCenterData;
    use crate::vip::params::VipCenterInfoParams;
    use crate::{BpiClient, BpiResult};

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

    fn contract() -> BpiResult<EndpointContract> {
        EndpointContract::from_slice(include_bytes!(
            "../../tests/contracts/vip/read/center-info/contract.json"
        ))
    }

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

        assert_eq!(
            vip.center_info_endpoint(),
            "https://api.bilibili.com/x/vip/web/vip_center/combine"
        );
        Ok(())
    }

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

        assert_center_info_future(vip.center_info(VipCenterInfoParams::new()));
        Ok(())
    }

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

        assert_eq!(contract.name, "vip.center_info");
        assert_eq!(contract.request.method, HttpMethod::Get);
        assert_eq!(contract.request.url.as_str(), vip.center_info_endpoint());
        assert_eq!(
            contract.request.query.get("build").map(String::as_str),
            Some("0")
        );
        Ok(())
    }
}