Skip to main content

bpi_rs/vip/
client.rs

1use crate::vip::center::VipCenterData;
2use crate::vip::params::VipCenterInfoParams;
3use crate::{BilibiliRequest, BpiClient, BpiResult};
4
5const CENTER_INFO_ENDPOINT: &str = "https://api.bilibili.com/x/vip/web/vip_center/combine";
6
7/// VIP API client.
8#[derive(Clone, Copy)]
9pub struct VipClient<'a> {
10    pub(crate) client: &'a BpiClient,
11}
12
13impl<'a> VipClient<'a> {
14    pub(crate) fn new(client: &'a BpiClient) -> Self {
15        Self { client }
16    }
17
18    #[cfg(test)]
19    pub(crate) fn center_info_endpoint(&self) -> &'static str {
20        CENTER_INFO_ENDPOINT
21    }
22
23    /// Gets VIP center information.
24    pub async fn center_info(&self, params: VipCenterInfoParams) -> BpiResult<VipCenterData> {
25        self.client
26            .get(CENTER_INFO_ENDPOINT)
27            .query(&params.query_pairs())
28            .send_bpi_payload("vip.center_info")
29            .await
30    }
31}
32
33#[cfg(test)]
34mod tests {
35    use std::future::Future;
36
37    use crate::probe::contract::HttpMethod;
38    use crate::probe::endpoint_contract::EndpointContract;
39    use crate::vip::center::VipCenterData;
40    use crate::vip::params::VipCenterInfoParams;
41    use crate::{BpiClient, BpiResult};
42
43    fn assert_center_info_future<F>(_future: F)
44    where
45        F: Future<Output = BpiResult<VipCenterData>>,
46    {
47    }
48
49    fn contract() -> BpiResult<EndpointContract> {
50        EndpointContract::from_slice(include_bytes!(
51            "../../tests/contracts/vip/read/center-info/contract.json"
52        ))
53    }
54
55    #[test]
56    fn vip_client_exposes_promoted_endpoint_url() -> BpiResult<()> {
57        let client = BpiClient::new()?;
58        let vip = client.vip();
59
60        assert_eq!(
61            vip.center_info_endpoint(),
62            "https://api.bilibili.com/x/vip/web/vip_center/combine"
63        );
64        Ok(())
65    }
66
67    #[test]
68    fn vip_methods_return_payload_futures() -> BpiResult<()> {
69        let client = BpiClient::new()?;
70        let vip = client.vip();
71
72        assert_center_info_future(vip.center_info(VipCenterInfoParams::new()));
73        Ok(())
74    }
75
76    #[test]
77    fn vip_contract_matches_module_client_endpoint() -> BpiResult<()> {
78        let client = BpiClient::new()?;
79        let vip = client.vip();
80        let contract = contract()?;
81
82        assert_eq!(contract.name, "vip.center_info");
83        assert_eq!(contract.request.method, HttpMethod::Get);
84        assert_eq!(contract.request.url.as_str(), vip.center_info_endpoint());
85        assert_eq!(
86            contract.request.query.get("build").map(String::as_str),
87            Some("0")
88        );
89        Ok(())
90    }
91}