libfmp 0.1.0

Async, typed Rust client for the Financial Modeling Prep API
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

use libfmp::{
    Error,
    error::{
        ErrorCategory, MAX_SAFE_BODY_BYTES, REDACTED, Redactor, SafeBody, SecretNameError,
        SecretString, SecretUrl,
    },
    types::Ticker,
};

#[test]
fn validation_and_configuration_have_stable_categories() {
    let validation = Error::from(Ticker::new(" ").unwrap_err());
    let configuration = Error::configuration("base URL must be absolute");

    assert_eq!(validation.category(), ErrorCategory::Validation);
    assert_eq!(validation.category().as_str(), "validation");
    assert_eq!(configuration.category(), ErrorCategory::Configuration);
    assert_eq!(configuration.endpoint(), None);
    assert_eq!(configuration.status_code(), None);
}

#[test]
fn status_and_decode_retain_only_safe_structured_context() {
    let mut redactor = Redactor::new();
    redactor.add_secret(&SecretString::new("very-secret"));
    let body = SafeBody::new("denied: very-secret", &redactor);
    let status = Error::status("/stable/quote-short", 401, Some(body));

    assert_eq!(status.category(), ErrorCategory::Status);
    assert_eq!(status.endpoint(), Some("/stable/quote-short"));
    assert_eq!(status.status_code(), Some(401));
    assert_eq!(status.body().unwrap().as_str(), "denied: [REDACTED]");
    assert!(!status.to_string().contains("very-secret"));

    let decode = Error::decode(
        Some("/stable/quote-short"),
        Some(200),
        status.body().cloned(),
        "invalid JSON",
    );
    assert_eq!(decode.category(), ErrorCategory::Decode);
    assert_eq!(decode.status_code(), Some(200));
}

#[test]
fn safe_body_is_redacted_and_bounded_in_utf8_bytes() {
    let secret = SecretString::new("token-value");
    let mut redactor = Redactor::new();
    redactor.add_secret(&secret);
    let body = format!(
        "https://example.test/report?apikey=abc&symbol=AAPL token-value {}",
        "界".repeat(MAX_SAFE_BODY_BYTES)
    );
    let safe = SafeBody::new(&body, &redactor);

    assert!(safe.is_truncated());
    assert!(safe.as_str().len() <= MAX_SAFE_BODY_BYTES);
    assert!(!safe.as_str().contains("abc"));
    assert!(!safe.as_str().contains("token-value"));
    assert!(safe.as_str().contains(REDACTED));
}

#[test]
fn authentication_values_and_secret_urls_never_format_in_cleartext() {
    let secret = SecretString::new("bearer-token");
    let url = SecretUrl::new(
        "https://financialmodelingprep.com/stable/financial-reports-json?apikey=key",
    );
    let mut redactor = Redactor::new();
    redactor.add_secret(&secret);
    redactor.add_secret_header_name("x-router-secret").unwrap();
    redactor.add_secret_query_name("router_token").unwrap();

    assert_eq!(secret.to_string(), REDACTED);
    assert!(!format!("{secret:?}").contains("bearer-token"));
    assert_eq!(url.to_string(), "[REDACTED URL]");
    assert!(!format!("{url:?}").contains("financial-reports"));
    assert_eq!(
        redactor.redact_header("Authorization", "Bearer x"),
        REDACTED
    );
    assert_eq!(
        redactor.redact_header("X-Router-Secret", "router-value"),
        REDACTED
    );
    assert_eq!(
        redactor.redact("/route?router_token=router-value&symbol=AAPL"),
        "/route?router_token=[REDACTED]&symbol=AAPL"
    );
}

#[test]
fn custom_secret_names_reject_empty_and_unsafe_values() {
    let mut redactor = Redactor::new();

    assert_eq!(redactor.add_secret_header_name("x.router-secret"), Ok(()));
    assert_eq!(redactor.add_secret_query_name("router.token"), Ok(()));
    assert_eq!(
        redactor.add_secret_header_name(""),
        Err(SecretNameError::Empty)
    );
    assert_eq!(
        redactor.add_secret_query_name("api=key"),
        Err(SecretNameError::InvalidCharacter)
    );
    assert_eq!(
        redactor.add_secret_header_name("bad header"),
        Err(SecretNameError::InvalidCharacter)
    );
    assert_eq!(
        redactor.redact_header("X.Router-Secret", "hidden"),
        REDACTED
    );
    assert_eq!(
        redactor.redact("?router.token=hidden&x=visible"),
        "?router.token=[REDACTED]&x=visible"
    );
}

#[test]
fn empty_success_arrays_are_not_an_error_concept() {
    let rows: libfmp::Result<Vec<()>> = Ok(Vec::new());
    assert!(matches!(rows, Ok(values) if values.is_empty()));
}