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

use serde_json::{Value, json};

use crate::{BpiError, BpiResult};

/// Parameters for `/paywallet/wallet/getUserWallet`.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WalletInfoParams {
    platform_type: u32,
    timestamp_ms: i64,
    trace_id: i64,
    version: String,
}

impl WalletInfoParams {
    /// Creates wallet-info parameters using the current UTC timestamp in milliseconds.
    pub fn new() -> Self {
        Self::at_timestamp(chrono::Utc::now().timestamp_millis())
    }

    /// Creates wallet-info parameters with a fixed timestamp for deterministic callers/tests.
    pub fn at_timestamp(timestamp_ms: i64) -> Self {
        Self {
            platform_type: 3,
            timestamp_ms,
            trace_id: timestamp_ms,
            version: "1.0".to_string(),
        }
    }

    pub fn with_platform_type(mut self, platform_type: u32) -> BpiResult<Self> {
        if platform_type == 0 {
            return Err(BpiError::invalid_parameter(
                "platformType",
                "platform type must be non-zero",
            ));
        }

        self.platform_type = platform_type;
        Ok(self)
    }

    pub fn with_trace_id(mut self, trace_id: i64) -> BpiResult<Self> {
        if trace_id <= 0 {
            return Err(BpiError::invalid_parameter(
                "traceId",
                "trace id must be positive",
            ));
        }

        self.trace_id = trace_id;
        Ok(self)
    }

    pub fn with_version(mut self, version: impl Into<String>) -> BpiResult<Self> {
        let version = version.into();
        let version = version.trim();
        if version.is_empty() {
            return Err(BpiError::invalid_parameter(
                "version",
                "version cannot be blank",
            ));
        }

        self.version = version.to_string();
        Ok(self)
    }

    pub(crate) fn body(&self, csrf: &str) -> Value {
        json!({
            "csrf": csrf,
            "platformType": self.platform_type,
            "timestamp": self.timestamp_ms,
            "traceId": self.trace_id,
            "version": self.version,
        })
    }
}

impl Default for WalletInfoParams {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn wallet_info_params_serializes_default_body() {
        let params = WalletInfoParams::at_timestamp(1_700_000_000_000);

        assert_eq!(
            params.body("csrf-token"),
            json!({
                "csrf": "csrf-token",
                "platformType": 3,
                "timestamp": 1_700_000_000_000_i64,
                "traceId": 1_700_000_000_000_i64,
                "version": "1.0",
            })
        );
    }

    #[test]
    fn wallet_info_params_serializes_custom_values() -> BpiResult<()> {
        let params = WalletInfoParams::at_timestamp(1_700_000_000_000)
            .with_platform_type(4)?
            .with_trace_id(1_700_000_000_001)?
            .with_version("2.0")?;

        assert_eq!(
            params.body("csrf-token"),
            json!({
                "csrf": "csrf-token",
                "platformType": 4,
                "timestamp": 1_700_000_000_000_i64,
                "traceId": 1_700_000_000_001_i64,
                "version": "2.0",
            })
        );
        Ok(())
    }

    #[test]
    fn wallet_info_params_rejects_zero_platform_type() {
        let err = WalletInfoParams::at_timestamp(1)
            .with_platform_type(0)
            .unwrap_err();

        assert!(matches!(
            err,
            BpiError::InvalidParameter {
                field: "platformType",
                ..
            }
        ));
    }

    #[test]
    fn wallet_info_params_rejects_blank_version() {
        let err = WalletInfoParams::at_timestamp(1)
            .with_version("  ")
            .unwrap_err();

        assert!(matches!(
            err,
            BpiError::InvalidParameter {
                field: "version",
                ..
            }
        ));
    }

    #[test]
    fn wallet_info_params_trims_version() -> BpiResult<()> {
        let params = WalletInfoParams::at_timestamp(1).with_version(" 2.0 ")?;

        assert_eq!(params.body("csrf-token")["version"], "2.0");
        Ok(())
    }
}