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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
use serde::{Deserialize, Serialize};

// --- 获取收藏夹元数据 ---

/// 收藏夹元数据的创建者信息
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct FavFolderUpper {
    pub mid: u64,
    pub name: String,
    pub face: String,
    pub followed: bool,
    pub vip_type: u8,
    /// 阿b拼写错误
    #[serde(rename = "vip_statue")]
    pub vip_status: u8,
}

/// 收藏夹元数据的状态数
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct FavFolderCntInfo {
    pub collect: u64,
    pub play: u64,
    pub thumb_up: u64,
    pub share: u64,
}

/// 收藏夹元数据
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct FavFolderInfo {
    pub id: u64,
    pub fid: u64,
    pub mid: u64,
    pub attr: u32,
    pub title: String,
    pub cover: String,
    pub upper: FavFolderUpper,
    pub cover_type: u8,
    pub cnt_info: FavFolderCntInfo,
    #[serde(rename = "type")]
    pub type_name: u32,
    pub intro: String,
    pub ctime: u64,
    pub mtime: u64,
    pub state: u8,
    pub fav_state: u8,
    pub like_state: u8,
    pub media_count: u32,
}

// --- 获取指定用户创建的所有收藏夹信息 ---

/// 用户创建的收藏夹列表项
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct CreatedFolderItem {
    pub id: u64,
    pub fid: u64,
    pub mid: u64,
    pub attr: u32,
    pub title: String,
    pub fav_state: u8,
    pub media_count: u32,
}

/// 用户创建的收藏夹信息数据
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct CreatedFolderListData {
    pub count: u32,
    pub list: Vec<CreatedFolderItem>,
}

// --- 查询用户收藏的视频收藏夹 ---

/// 用户收藏的视频收藏夹列表项的创建人信息
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct CollectedFolderUpper {
    pub mid: u64,
    pub name: String,
    pub face: String,
}

/// 用户收藏的视频收藏夹列表项
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct CollectedFolderItem {
    pub id: u64,
    pub fid: u64,
    pub mid: u64,
    pub attr: u32,
    pub title: String,
    pub cover: String,
    pub upper: CollectedFolderUpper,
    pub cover_type: u8,
    pub intro: String,
    pub ctime: u64,
    pub mtime: u64,
    pub state: u8,
    pub fav_state: u8,
    pub media_count: u32,
}

/// 用户收藏的视频收藏夹列表数据
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct CollectedFolderListData {
    pub count: u32,
    pub list: Vec<CollectedFolderItem>,
}

// --- 批量获取指定收藏id的内容 ---

/// 内容信息列表中的UP主信息
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ResourceInfoUpper {
    pub mid: u64,
    pub name: String,
    pub face: String,
}

/// 内容信息列表中的状态数
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ResourceInfoCntInfo {
    pub collect: u64,
    pub play: u64,
    pub danmaku: u64,
}

/// 批量获取的内容信息列表项
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ResourceInfoItem {
    pub id: u64,
    #[serde(rename = "type")]
    pub type_name: u8,
    pub title: String,
    pub cover: String,
    pub intro: String,
    pub page: Option<u32>,
    pub duration: u32,
    pub upper: ResourceInfoUpper,
    pub attr: u8,
    pub cnt_info: ResourceInfoCntInfo,
    pub link: String,
    pub ctime: u64,
    pub pubtime: u64,
    pub fav_time: u64,
    pub bv_id: Option<String>,
    pub bvid: Option<String>,
    pub season: Option<serde_json::Value>,
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::fav::params::{
        FavCollectedListParams, FavCreatedListParams, FavFolderInfoParams, FavResourceInfosParams,
    };
    use crate::probe::contract::HttpMethod;
    use crate::probe::endpoint_contract::EndpointContract;
    use crate::{ApiEnvelope, BpiClient, BpiResult};
    use tracing::info;

    fn contract(endpoint: &str) -> BpiResult<EndpointContract> {
        let bytes = match endpoint {
            "folder-info" => {
                include_bytes!("../../tests/contracts/fav/read/folder-info/contract.json")
                    .as_slice()
            }
            "created-list" => {
                include_bytes!("../../tests/contracts/fav/read/created-list/contract.json")
                    .as_slice()
            }
            "collected-list" => {
                include_bytes!("../../tests/contracts/fav/read/collected-list/contract.json")
                    .as_slice()
            }
            "resource-infos" => {
                include_bytes!("../../tests/contracts/fav/read/resource-infos/contract.json")
                    .as_slice()
            }
            _ => unreachable!("unknown fav info contract endpoint"),
        };

        EndpointContract::from_slice(bytes)
    }

    #[ignore = "legacy live API test; requires explicit BPI_LIVE_TEST review"]
    #[tokio::test]
    async fn test_get_fav_folder_info() {
        let bpi = BpiClient::new().expect("client should build");
        // 替换为一个公开收藏夹的media_id
        let params = FavFolderInfoParams::new(
            crate::ids::MediaId::new(1052622027).expect("fixture media id should be valid"),
        );
        let resp = bpi.fav().folder_info(params).await;

        info!("{:?}", resp);
        assert!(resp.is_ok());

        let data = resp.unwrap();
        info!("folder title: {}", data.title);
        info!("folder media_count: {}", data.media_count);
        info!("upper info: {:?}", data.upper);
    }

    #[ignore = "legacy live API test; requires explicit BPI_LIVE_TEST review"]
    #[tokio::test]
    async fn test_get_fav_created_list() {
        let bpi = BpiClient::new().expect("client should build");

        let params = FavCreatedListParams::new(
            crate::ids::Mid::new(7792521).expect("fixture mid should be valid"),
        );
        let resp = bpi.fav().created_list(params).await;

        info!("{:?}", resp);
        assert!(resp.is_ok());

        let data = resp.unwrap();
        info!("created folders count: {}", data.count);
        info!("first folder info: {:?}", data.list.first());
    }

    #[ignore = "legacy live API test; requires explicit BPI_LIVE_TEST review"]
    #[tokio::test]
    async fn test_get_fav_collected_list() {
        let bpi = BpiClient::new().expect("client should build");

        let params = FavCollectedListParams::new(
            crate::ids::Mid::new(7792521).expect("fixture mid should be valid"),
        )
        .with_page(1)
        .expect("fixture page should be valid")
        .with_page_size(20)
        .expect("fixture page size should be valid");
        let resp = bpi.fav().collected_list(params).await;

        info!("{:?}", resp);
        assert!(resp.is_ok());

        let data = resp.unwrap();
        info!("collected folders count: {}", data.count);
        info!("first collected folder info: {:?}", data.list.first());
    }

    #[ignore = "legacy live API test; requires explicit BPI_LIVE_TEST review"]
    #[tokio::test]
    async fn test_get_fav_resource_infos() {
        let bpi = BpiClient::new().expect("client should build");
        let params =
            FavResourceInfosParams::new("371494037:2").expect("fixture resources should be valid");
        let resp = bpi.fav().resource_infos(params).await;

        info!("{:?}", resp);
        assert!(resp.is_ok());

        let data = resp.unwrap();
        info!("retrieved {} resources", data.len());
        info!("first resource info: {:?}", data.first());
    }

    #[test]
    fn fav_folder_info_contract_matches_endpoint_request() -> BpiResult<()> {
        let contract = contract("folder-info")?;

        assert_eq!(contract.name, "fav.folder_info");
        assert_eq!(contract.request.method, HttpMethod::Get);
        assert_eq!(
            contract.request.url.as_str(),
            "https://api.bilibili.com/x/v3/fav/folder/info"
        );
        assert_eq!(
            contract.request.query.get("media_id").map(String::as_str),
            Some("1052622027")
        );
        assert_eq!(contract.cases.len(), 3);
        assert_eq!(
            contract.cases[0].response.rust_model.as_deref(),
            Some("FavFolderInfo")
        );
        Ok(())
    }

    #[test]
    fn fav_created_list_contract_matches_endpoint_request() -> BpiResult<()> {
        let contract = contract("created-list")?;

        assert_eq!(contract.name, "fav.created_list");
        assert_eq!(contract.request.method, HttpMethod::Get);
        assert_eq!(
            contract.request.url.as_str(),
            "https://api.bilibili.com/x/v3/fav/folder/created/list-all"
        );
        assert_eq!(
            contract.request.query.get("up_mid").map(String::as_str),
            Some("7792521")
        );
        assert_eq!(contract.cases.len(), 3);
        assert_eq!(
            contract.cases[0].response.rust_model.as_deref(),
            Some("CreatedFolderListData")
        );
        Ok(())
    }

    #[test]
    fn fav_collected_list_contract_matches_endpoint_request() -> BpiResult<()> {
        let contract = contract("collected-list")?;

        assert_eq!(contract.name, "fav.collected_list");
        assert_eq!(contract.request.method, HttpMethod::Get);
        assert_eq!(
            contract.request.url.as_str(),
            "https://api.bilibili.com/x/v3/fav/folder/collected/list"
        );
        assert_eq!(
            contract.request.query.get("up_mid").map(String::as_str),
            Some("7792521")
        );
        assert_eq!(
            contract.request.query.get("platform").map(String::as_str),
            Some("web")
        );
        assert_eq!(contract.cases.len(), 3);
        assert_eq!(
            contract.cases[0].response.rust_model.as_deref(),
            Some("CollectedFolderListData")
        );
        Ok(())
    }

    #[test]
    fn fav_resource_infos_contract_matches_endpoint_request() -> BpiResult<()> {
        let contract = contract("resource-infos")?;

        assert_eq!(contract.name, "fav.resource_infos");
        assert_eq!(contract.request.method, HttpMethod::Get);
        assert_eq!(
            contract.request.url.as_str(),
            "https://api.bilibili.com/x/v3/fav/resource/infos"
        );
        assert_eq!(
            contract.request.query.get("resources").map(String::as_str),
            Some("371494037:2")
        );
        assert_eq!(contract.cases.len(), 3);
        assert_eq!(
            contract.cases[0].response.rust_model.as_deref(),
            Some("Vec<ResourceInfoItem>")
        );
        Ok(())
    }

    #[test]
    fn fav_info_response_fixtures_parse_declared_models() -> BpiResult<()> {
        let folder = ApiEnvelope::<FavFolderInfo>::from_slice(include_bytes!(
            "../../tests/contracts/fav/read/folder-info/responses/success.json"
        ))?
        .into_payload()?;
        assert_eq!(folder.id, 1052622027);

        let created = ApiEnvelope::<CreatedFolderListData>::from_slice(include_bytes!(
            "../../tests/contracts/fav/read/created-list/responses/success.json"
        ))?
        .into_payload()?;
        assert_eq!(created.list.len(), 1);

        let collected = ApiEnvelope::<CollectedFolderListData>::from_slice(include_bytes!(
            "../../tests/contracts/fav/read/collected-list/responses/success.json"
        ))?
        .into_payload()?;
        assert!(collected.list.is_empty());

        let resources = ApiEnvelope::<Vec<ResourceInfoItem>>::from_slice(include_bytes!(
            "../../tests/contracts/fav/read/resource-infos/responses/success.json"
        ))?
        .into_payload()?;
        assert_eq!(resources.len(), 1);
        Ok(())
    }

    fn local_probe_body(endpoint: &str, profile: &str) -> Option<serde_json::Value> {
        let path = format!("target/bpi-probe-runs/fav/read/{endpoint}/{profile}.response.json");
        let bytes = std::fs::read(path).ok()?;
        let value: serde_json::Value = serde_json::from_slice(&bytes).ok()?;
        value
            .get("response")
            .and_then(|response| response.get("body"))
            .cloned()
    }

    #[test]
    fn fav_info_models_match_local_probe_outputs_when_available() -> BpiResult<()> {
        for profile in ["anonymous", "normal", "vip"] {
            if let Some(body) = local_probe_body("folder-info", profile) {
                let payload =
                    serde_json::from_value::<ApiEnvelope<FavFolderInfo>>(body)?.into_payload()?;
                assert_eq!(payload.id, 1052622027);
            }

            if let Some(body) = local_probe_body("created-list", profile) {
                let payload = serde_json::from_value::<ApiEnvelope<CreatedFolderListData>>(body)?
                    .into_payload()?;
                assert!(payload.count >= payload.list.len() as u32);
            }

            if let Some(body) = local_probe_body("collected-list", profile) {
                let payload = serde_json::from_value::<ApiEnvelope<CollectedFolderListData>>(body)?
                    .into_payload()?;
                assert!(payload.count >= payload.list.len() as u32);
            }

            if let Some(body) = local_probe_body("resource-infos", profile) {
                let payload = serde_json::from_value::<ApiEnvelope<Vec<ResourceInfoItem>>>(body)?
                    .into_payload()?;
                assert!(!payload.is_empty());
            }
        }
        Ok(())
    }
}