schwab-sdk 0.4.0

Async Rust client for the Charles Schwab Trader API and real-time market-data streaming.
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

use crate::secrets::AuthToken;
use crate::streamer::{Service, StreamerCommand, StreamerRequest};

#[derive(Debug, Clone)]
pub(crate) struct Login {
    pub authorization: AuthToken,
    pub schwab_client_channel: String,
    pub schwab_client_function_id: String,
}

impl From<Login> for StreamerRequest {
    fn from(login: Login) -> Self {
        StreamerRequest {
            service: Service::Admin,
            command: StreamerCommand::Login,
            parameters: serde_json::json!({
                "Authorization": login.authorization.expose_secret(),
                "SchwabClientChannel": login.schwab_client_channel,
                "SchwabClientFunctionId": login.schwab_client_function_id,
            }),
        }
    }
}

pub(crate) struct Logout;

impl From<Logout> for StreamerRequest {
    fn from(_: Logout) -> Self {
        StreamerRequest {
            service: Service::Admin,
            command: StreamerCommand::Logout,
            parameters: serde_json::json!({}),
        }
    }
}

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

    use crate::streamer::StreamerResponse;
    use crate::streamer::protocol::ResponseCode;
    use crate::streamer::response::parse;

    #[test]
    fn parses_login_success_response() {
        let frame = r#"{
            "response": [{
                "service": "ADMIN",
                "command": "LOGIN",
                "requestid": "1",
                "SchwabClientCorrelId": "5be0b7e7-5b8b-4fd3-9bed-7f49106cfe96",
                "timestamp": 1669828276886,
                "content": { "code": 0, "msg": "server=s0166bdv-1;status=PN" }
            }]
        }"#;
        match parse(frame).unwrap() {
            StreamerResponse::Response(responses) => {
                assert_eq!(responses.len(), 1);
                let r = &responses[0];
                assert_eq!(r.service, Service::Admin);
                assert_eq!(r.command, StreamerCommand::Login);
                assert_eq!(r.request_id, 1);
                assert_eq!(r.content.code, ResponseCode::Ok);
                assert!(r.content.message.contains("status=PN"));
            }
            other => panic!("expected Response, got {other:?}"),
        }
    }

    #[test]
    fn parses_login_denied_response() {
        let frame = r#"{
            "response": [{
                "service": "ADMIN",
                "command": "LOGIN",
                "requestid": "1",
                "SchwabClientCorrelId": "x",
                "timestamp": 1669828982588,
                "content": { "code": 3, "msg": "Login Denied.: token is invalid or has expired." }
            }]
        }"#;
        let StreamerResponse::Response(responses) = parse(frame).unwrap() else {
            panic!("expected Response");
        };
        assert_eq!(responses[0].content.code, ResponseCode::LoginDenied);
    }

    #[test]
    fn login_frame_parameters_encode_fields() {
        let login = Login {
            authorization: AuthToken::new("1234567890"),
            schwab_client_channel: "channel".to_string(),
            schwab_client_function_id: "fn-id".to_string(),
        };
        let request: StreamerRequest = login.into();
        assert_eq!(request.parameters["Authorization"], "1234567890");
        assert_eq!(request.parameters["SchwabClientChannel"], "channel");
        assert_eq!(request.parameters["SchwabClientFunctionId"], "fn-id");
    }

    #[test]
    fn login_debug_does_not_leak_auth_token() {
        let login = Login {
            authorization: AuthToken::new("super-secret-bearer"),
            schwab_client_channel: "ch".to_string(),
            schwab_client_function_id: "fn".to_string(),
        };
        let debug = format!("{login:?}");
        assert!(
            !debug.contains("super-secret-bearer"),
            "Debug leaked auth token: {debug}"
        );
    }

    #[test]
    fn from_login_never_panics() {
        let login = Login {
            authorization: AuthToken::new(""),
            schwab_client_channel: String::new(),
            schwab_client_function_id: String::new(),
        };
        let _request: StreamerRequest = login.into();

        let login = Login {
            authorization: AuthToken::new("\u{0}\"\\\n"),
            schwab_client_channel: "ch".to_string(),
            schwab_client_function_id: "fn".to_string(),
        };
        let _request: StreamerRequest = login.into();
    }
}