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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

//! 弹幕快照（最近产生的几条弹幕，最多20条）
//!
//! [文档入口](https://github.com/SocialSisterYi/bilibili-API-collect/tree/master/docs/danmaku)

use crate::ids::{Aid, Bvid};

/// Parameters for `/x/v2/dm/ajax` danmaku snapshots.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DanmakuSnapshotParams {
    target: DanmakuSnapshotTarget,
}

#[derive(Debug, Clone, PartialEq, Eq)]
enum DanmakuSnapshotTarget {
    Aid(Aid),
    Bvid(Bvid),
}

impl DanmakuSnapshotParams {
    pub fn from_aid(aid: Aid) -> Self {
        Self {
            target: DanmakuSnapshotTarget::Aid(aid),
        }
    }

    pub fn from_bvid(bvid: Bvid) -> Self {
        Self {
            target: DanmakuSnapshotTarget::Bvid(bvid),
        }
    }

    pub fn query_pairs(&self) -> [(&'static str, String); 1] {
        let value = match &self.target {
            DanmakuSnapshotTarget::Aid(aid) => aid.to_string(),
            DanmakuSnapshotTarget::Bvid(bvid) => bvid.to_string(),
        };

        [("aid", value)]
    }
}

#[cfg(test)]
pub mod tests {
    use crate::danmaku::DanmakuSnapshotParams;
    use crate::ids::{Aid, Bvid};
    use crate::probe::contract::HttpMethod;
    use crate::probe::endpoint_contract::EndpointContract;
    use crate::response::ApiEnvelope;
    use crate::{BpiClient, BpiError, BpiResult};
    use std::collections::BTreeMap;

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

    fn query_map(params: [(&'static str, String); 1]) -> BTreeMap<String, String> {
        params
            .into_iter()
            .map(|(key, value)| (key.to_string(), value))
            .collect()
    }

    #[ignore = "legacy live API test; requires explicit BPI_LIVE_TEST review"]
    #[tokio::test]
    async fn test_get_danmaku_snapshot() -> Result<(), BpiError> {
        let bpi = BpiClient::new().expect("client should build");
        let bvid: Bvid = "BV1fK4y1t741".parse()?;
        let params = DanmakuSnapshotParams::from_bvid(bvid);
        let data = bpi.danmaku().snapshot(params).await?;
        tracing::info!("{:#?}", data);

        Ok(())
    }

    #[test]
    fn danmaku_snapshot_params_serializes_bvid_query() -> Result<(), BpiError> {
        let bvid: Bvid = "BV1fK4y1t741".parse()?;
        let params = DanmakuSnapshotParams::from_bvid(bvid);

        assert_eq!(params.query_pairs(), [("aid", "BV1fK4y1t741".to_string())]);
        Ok(())
    }

    #[test]
    fn danmaku_snapshot_params_serializes_aid_query() -> Result<(), BpiError> {
        let params = DanmakuSnapshotParams::from_aid(Aid::new(170001)?);

        assert_eq!(params.query_pairs(), [("aid", "170001".to_string())]);
        Ok(())
    }

    #[test]
    fn danmaku_snapshot_contract_matches_endpoint_request() -> Result<(), BpiError> {
        let contract = contract()?;
        let bvid: Bvid = "BV1fK4y1t741".parse()?;
        let params = DanmakuSnapshotParams::from_bvid(bvid);

        assert_eq!(contract.name, "danmaku.snapshot");
        assert_eq!(contract.request.method, HttpMethod::Get);
        assert_eq!(
            contract.request.url.as_str(),
            "https://api.bilibili.com/x/v2/dm/ajax"
        );
        assert_eq!(query_map(params.query_pairs()), contract.request.query);
        Ok(())
    }

    #[test]
    fn danmaku_snapshot_response_fixtures_parse_declared_model() -> Result<(), BpiError> {
        for bytes in [
            include_bytes!(
                "../../tests/contracts/danmaku/json-read/snapshot/responses/anonymous.success.json"
            )
            .as_slice(),
            include_bytes!(
                "../../tests/contracts/danmaku/json-read/snapshot/responses/normal.success.json"
            )
            .as_slice(),
            include_bytes!(
                "../../tests/contracts/danmaku/json-read/snapshot/responses/vip.success.json"
            )
            .as_slice(),
        ] {
            let payload = ApiEnvelope::<Vec<String>>::from_slice(bytes)?.into_payload()?;
            assert!(payload.is_empty());
        }
        Ok(())
    }
}