use serde::{Deserialize, Serialize};
#[derive(Debug, Serialize, Clone, Deserialize)]
pub struct GiftItem {
pub id: i64,
pub name: String,
pub price: i64,
pub r#type: i32,
pub coin_type: String,
pub effect: i32,
pub stay_time: i32,
pub animation_frame_num: i32,
pub desc: String,
pub img_basic: String,
pub gif: String,
}
#[derive(Debug, Serialize, Clone, Deserialize)]
pub struct GiftConfig {
pub list: Vec<GiftItem>,
}
#[derive(Debug, Serialize, Clone, Deserialize)]
pub struct GiftBaseConfig {
pub base_config: GiftConfig,
}
#[derive(Debug, Serialize, Clone, Deserialize)]
pub struct RoomGiftData {
pub gift_config: Option<GiftBaseConfig>,
pub gift_data: Option<serde_json::Value>,
pub global_config: Option<serde_json::Value>,
}
#[derive(Debug, Serialize, Clone, Deserialize)]
pub struct BlindGiftItem {
pub gift_id: i64,
pub price: i64,
pub gift_name: String,
pub gift_img: String,
pub chance: String,
}
#[derive(Debug, Serialize, Clone, Deserialize)]
pub struct BlindGiftData {
pub note_text: String,
pub blind_price: i64,
pub blind_gift_name: String,
pub gifts: Vec<BlindGiftItem>,
}
#[cfg(test)]
mod tests {
use super::*;
use crate::probe::contract::HttpMethod;
use crate::probe::endpoint_contract::EndpointContract;
use crate::{ApiEnvelope, BpiClient, BpiError, BpiResult};
fn contract(endpoint: &str) -> BpiResult<EndpointContract> {
let bytes = match endpoint {
"room-gift-list" => {
include_bytes!("../../tests/contracts/live/gift-read/room-gift-list/contract.json")
.as_slice()
}
"blind-gift-info" => {
include_bytes!("../../tests/contracts/live/gift-read/blind-gift-info/contract.json")
.as_slice()
}
_ => unreachable!("unknown live gift contract endpoint"),
};
EndpointContract::from_slice(bytes)
}
#[ignore = "legacy live API test; requires explicit BPI_LIVE_TEST review"]
#[tokio::test]
async fn test_get_room_gift_list() -> Result<(), Box<BpiError>> {
let bpi = BpiClient::new().expect("client should build");
let data = bpi.live().room_gift_list(23174842, None, None).await?;
if let Some(gift_config) = data.gift_config {
assert!(!gift_config.base_config.list.is_empty());
} else {
assert!(data.gift_data.is_some());
}
Ok(())
}
#[ignore = "legacy live API test; requires explicit BPI_LIVE_TEST review"]
#[tokio::test]
async fn test_get_blind_gift_info() -> Result<(), Box<BpiError>> {
let bpi = BpiClient::new().expect("client should build");
let data = bpi.live().blind_gift_info(32251).await?;
assert!(!data.gifts.is_empty());
Ok(())
}
#[test]
fn live_room_gift_list_contract_matches_endpoint_request() -> BpiResult<()> {
let contract = contract("room-gift-list")?;
assert_eq!(contract.name, "live.room_gift_list");
assert_eq!(contract.request.method, HttpMethod::Get);
assert_eq!(
contract.request.url.as_str(),
"https://api.live.bilibili.com/xlive/web-room/v1/giftPanel/roomGiftList"
);
assert_eq!(
contract.request.query.get("room_id").map(String::as_str),
Some("23174842")
);
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("RoomGiftData")
);
Ok(())
}
#[test]
fn live_blind_gift_info_contract_matches_endpoint_request() -> BpiResult<()> {
let contract = contract("blind-gift-info")?;
assert_eq!(contract.name, "live.blind_gift_info");
assert_eq!(contract.request.method, HttpMethod::Get);
assert_eq!(
contract.request.url.as_str(),
"https://api.live.bilibili.com/xlive/general-interface/v1/blindFirstWin/getInfo"
);
assert_eq!(
contract.request.query.get("gift_id").map(String::as_str),
Some("32251")
);
assert_eq!(contract.cases.len(), 3);
assert_eq!(contract.cases[0].response.api_code, Some(-101));
assert_eq!(
contract.cases[1].response.rust_model.as_deref(),
Some("BlindGiftData")
);
Ok(())
}
#[test]
fn live_gift_response_fixtures_parse_declared_models() -> BpiResult<()> {
let room_gift = ApiEnvelope::<RoomGiftData>::from_slice(include_bytes!(
"../../tests/contracts/live/gift-read/room-gift-list/responses/success.json"
))?
.into_payload()?;
assert!(room_gift.gift_config.is_none());
assert!(room_gift.gift_data.is_some());
let err = ApiEnvelope::<serde_json::Value>::from_slice(include_bytes!(
"../../tests/contracts/live/gift-read/blind-gift-info/responses/anonymous.requires_login.json"
))?
.ensure_success()
.unwrap_err();
assert!(err.requires_login());
let blind = ApiEnvelope::<BlindGiftData>::from_slice(include_bytes!(
"../../tests/contracts/live/gift-read/blind-gift-info/responses/authenticated.success.json"
))?
.into_payload()?;
assert_eq!(blind.gifts.len(), 1);
Ok(())
}
fn local_probe_body(endpoint: &str, profile: &str) -> Option<serde_json::Value> {
let path =
format!("target/bpi-probe-runs/live/gift-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 live_gift_models_match_local_probe_outputs_when_available() -> BpiResult<()> {
for profile in ["anonymous", "normal", "vip"] {
if let Some(body) = local_probe_body("room-gift-list", profile) {
let payload =
serde_json::from_value::<ApiEnvelope<RoomGiftData>>(body)?.into_payload()?;
assert!(payload.gift_config.is_some() || payload.gift_data.is_some());
}
if let Some(body) = local_probe_body("blind-gift-info", profile) {
let envelope = serde_json::from_value::<ApiEnvelope<BlindGiftData>>(body)?;
if profile == "anonymous" {
let err = envelope.ensure_success().unwrap_err();
assert!(err.requires_login());
} else {
let payload = envelope.into_payload()?;
assert!(!payload.gifts.is_empty());
}
}
}
Ok(())
}
}