ibapi 3.3.0

A Rust implementation of the Interactive Brokers TWS API, providing a reliable and user friendly interface for TWS and IB Gateway. Designed with a focus on simplicity and performance.
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

use crate::client::blocking::Client;
use crate::common::test_utils::helpers::{decode_request_proto, proto_response, TEST_REQ_ID_FIRST};
use crate::config::{ApiConfig, ApiSettings, ConfigWarning, LockAndExit, MessageSetting, OrdersConfig, OrdersSmartRouting};
use crate::messages::IncomingMessages;
use crate::stubs::MessageBusStub;
use crate::testdata::builders::config::update_config_response;
use crate::testdata::builders::ResponseProtoEncoder;
use crate::{proto, Error};
use std::sync::Arc;

fn stub(responses: Vec<crate::messages::ResponseMessage>) -> Arc<MessageBusStub> {
    Arc::new(MessageBusStub::with_ordered_responses(responses))
}

#[test]
fn test_update_config_request_body() {
    let message_bus = stub(vec![proto_response(
        IncomingMessages::UpdateConfigResponse,
        update_config_response().request_id(TEST_REQ_ID_FIRST).status("ok").encode_proto(),
    )]);

    let client = Client::stubbed(message_bus.clone(), crate::server_versions::UPDATE_CONFIG);
    client
        .update_config()
        .api(ApiConfig {
            settings: Some(ApiSettings {
                socket_port: Some(7497),
                ..Default::default()
            }),
            ..Default::default()
        })
        .orders(OrdersConfig {
            smart_routing: Some(OrdersSmartRouting {
                seek_price_improvement: Some(true),
                ..Default::default()
            }),
        })
        .lock_and_exit(LockAndExit {
            auto_logoff_time: Some("23:59".to_string()),
            ..Default::default()
        })
        .message(MessageSetting {
            id: Some(131),
            enabled: Some(false),
            ..Default::default()
        })
        .accept_warning(ConfigWarning {
            message_id: Some(131),
            ..Default::default()
        })
        .reset_api_order_sequence()
        .submit()
        .expect("update config failed");

    // Verify the captured wire request round-trips through the production encoder.
    let sent: proto::UpdateConfigRequest = decode_request_proto(&message_bus, 0);
    assert_eq!(sent.req_id, Some(TEST_REQ_ID_FIRST));
    assert_eq!(sent.api.unwrap().settings.unwrap().socket_port, Some(7497));
    assert_eq!(sent.orders.unwrap().smart_routing.unwrap().seek_price_improvement, Some(true));
    assert_eq!(sent.lock_and_exit.unwrap().auto_logoff_time.as_deref(), Some("23:59"));
    assert_eq!(sent.messages.len(), 1);
    assert_eq!(sent.messages[0].id, Some(131));
    assert_eq!(sent.accepted_warnings.len(), 1);
    assert_eq!(sent.accepted_warnings[0].message_id, Some(131));
    assert_eq!(sent.reset_api_order_sequence, Some(true));
}

#[test]
fn test_update_config_bulk_setters() {
    let message_bus = stub(vec![proto_response(
        IncomingMessages::UpdateConfigResponse,
        update_config_response().request_id(TEST_REQ_ID_FIRST).status("ok").encode_proto(),
    )]);

    let client = Client::stubbed(message_bus.clone(), crate::server_versions::UPDATE_CONFIG);
    client
        .update_config()
        .messages([
            MessageSetting {
                id: Some(131),
                ..Default::default()
            },
            MessageSetting {
                id: Some(132),
                ..Default::default()
            },
        ])
        .accept_warnings([
            ConfigWarning {
                message_id: Some(131),
                ..Default::default()
            },
            ConfigWarning {
                message_id: Some(132),
                ..Default::default()
            },
        ])
        .submit()
        .expect("update config failed");

    let sent: proto::UpdateConfigRequest = decode_request_proto(&message_bus, 0);
    assert_eq!(sent.messages.iter().filter_map(|m| m.id).collect::<Vec<_>>(), vec![131, 132]);
    assert_eq!(
        sent.accepted_warnings.iter().filter_map(|w| w.message_id).collect::<Vec<_>>(),
        vec![131, 132]
    );
}

#[test]
fn test_update_config_response_decoded() {
    // Proves the decoded response flows back through submit(); exhaustive
    // field-mapping is owned by decoders_tests::test_decode_update_config_message_populated.
    let message_bus = stub(vec![proto_response(
        IncomingMessages::UpdateConfigResponse,
        update_config_response()
            .request_id(TEST_REQ_ID_FIRST)
            .status("warning")
            .warning(131, "Confirm Mandatory Cap Price")
            .encode_proto(),
    )]);

    let client = Client::stubbed(message_bus, crate::server_versions::UPDATE_CONFIG);
    let response = client.update_config().reset_api_order_sequence().submit().expect("update config failed");

    assert_eq!(response.status.as_deref(), Some("warning"));
    assert_eq!(response.warnings.len(), 1);
    assert_eq!(response.warnings[0].message_id, Some(131));
}

#[test]
fn test_update_config_server_version_error() {
    let message_bus = stub(vec![]);

    let client = Client::stubbed(message_bus, crate::server_versions::UPDATE_CONFIG - 1);
    match client.update_config().reset_api_order_sequence().submit() {
        Err(Error::ServerVersion(_, _, _)) => {}
        other => panic!("expected ServerVersion error, got {other:?}"),
    }
}

#[test]
fn test_update_config_unexpected_end_of_stream() {
    let message_bus = stub(vec![]);

    let client = Client::stubbed(message_bus, crate::server_versions::UPDATE_CONFIG);
    match client.update_config().reset_api_order_sequence().submit() {
        Err(Error::UnexpectedEndOfStream) => {}
        other => panic!("expected UnexpectedEndOfStream, got {other:?}"),
    }
}