libfmp 0.4.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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

use std::str::FromStr;

use libfmp::{
    query::FiscalPeriod,
    responses::statements::RevenueSegmentation,
    types::{CalendarYear, CurrencyCode, Date, Ticker},
};
use serde::de::DeserializeOwned;

const PRODUCT: &[u8] = include_bytes!("fixtures/revenue_product_segmentation.json");
const GEOGRAPHIC: &[u8] = include_bytes!("fixtures/revenue_geographic_segmentation.json");

#[test]
fn product_fixture_decodes_exact_envelope_and_arbitrary_product_keys() {
    let value: serde_json::Value = serde_json::from_slice(PRODUCT).unwrap();
    assert_eq!(value[0].as_object().unwrap().len(), 6);

    let rows: Vec<RevenueSegmentation> = serde_json::from_value(value).unwrap();
    let row = &rows[0];
    assert_eq!(row.symbol, Ticker::new("AAPL").unwrap());
    assert_eq!(row.fiscal_year, CalendarYear(2025));
    assert_eq!(row.period, FiscalPeriod::FullYear);
    assert_eq!(row.reported_currency, CurrencyCode::new("USD").unwrap());
    assert_eq!(row.date, Date::from_str("2025-09-27").unwrap());
    assert_eq!(row.data.len(), 5);
    assert_eq!(row.data["Mac"], serde_json::json!(33_708_000_000_u64));
    assert_eq!(
        row.data["Wearables, Home and Accessories"],
        serde_json::json!(35_686_000_000_u64)
    );
    assert_eq!(row.data["iPhone"], serde_json::json!(209_586_000_000_u64));
}

#[test]
fn geographic_fixture_decodes_exact_shared_shape_and_spaced_keys() {
    let value: serde_json::Value = serde_json::from_slice(GEOGRAPHIC).unwrap();
    assert_eq!(value[0].as_object().unwrap().len(), 6);

    let rows: Vec<RevenueSegmentation> = serde_json::from_value(value).unwrap();
    assert_eq!(rows[0].data.len(), 5);
    assert_eq!(
        rows[0].data["Greater China Segment"],
        serde_json::json!(64_377_000_000_u64)
    );
    assert_eq!(
        rows[0].data["Rest of Asia Pacific Segment"],
        serde_json::json!(33_696_000_000_u64)
    );
}

#[test]
fn dynamic_data_preserves_open_keys_values_and_large_integer_tokens() {
    let mut value: serde_json::Value = serde_json::from_slice(PRODUCT).unwrap();
    value[0]["data"]["Consumer / Pro, North America (Rest)"] =
        serde_json::from_str("9007199254740993").unwrap();
    value[0]["data"]["Future Segment: beta + services"] =
        serde_json::json!({ "reported": true, "adjustments": [null, -7] });

    let rows: Vec<RevenueSegmentation> = serde_json::from_value(value).unwrap();
    assert_eq!(
        rows[0].data["Consumer / Pro, North America (Rest)"].to_string(),
        "9007199254740993"
    );
    assert_eq!(
        rows[0].data["Future Segment: beta + services"]["adjustments"][1],
        serde_json::json!(-7)
    );

    let encoded = serde_json::to_string(&rows).unwrap();
    assert!(encoded.contains("9007199254740993"));
    assert!(!encoded.contains("9007199254740992"));
}

#[test]
fn every_envelope_field_is_required_non_null_and_exactly_typed() {
    for fixture in [PRODUCT, GEOGRAPHIC] {
        assert_every_field_required_and_non_null::<RevenueSegmentation>(fixture);
    }

    let mut string_year: serde_json::Value = serde_json::from_slice(PRODUCT).unwrap();
    string_year[0]["fiscalYear"] = serde_json::json!("2025");
    assert!(serde_json::from_value::<Vec<RevenueSegmentation>>(string_year).is_err());

    let mut retrieval_period: serde_json::Value = serde_json::from_slice(PRODUCT).unwrap();
    retrieval_period[0]["period"] = serde_json::json!("annual");
    assert!(serde_json::from_value::<Vec<RevenueSegmentation>>(retrieval_period).is_err());

    let mut array_data: serde_json::Value = serde_json::from_slice(PRODUCT).unwrap();
    array_data[0]["data"] = serde_json::json!([]);
    assert!(serde_json::from_value::<Vec<RevenueSegmentation>>(array_data).is_err());
}

fn assert_every_field_required_and_non_null<T: DeserializeOwned>(fixture: &[u8]) {
    let source: serde_json::Value = serde_json::from_slice(fixture).unwrap();
    let keys = source[0]
        .as_object()
        .unwrap()
        .keys()
        .cloned()
        .collect::<Vec<_>>();

    for key in keys {
        let mut missing = source.clone();
        missing[0].as_object_mut().unwrap().remove(&key);
        assert!(
            serde_json::from_value::<Vec<T>>(missing).is_err(),
            "accepted missing field {key}"
        );

        let mut null = source.clone();
        null[0][&key] = serde_json::Value::Null;
        assert!(
            serde_json::from_value::<Vec<T>>(null).is_err(),
            "accepted null field {key}"
        );
    }
}

#[test]
fn both_endpoints_are_bare_arrays_preserving_empty_and_multiple_rows() {
    assert!(
        serde_json::from_slice::<Vec<RevenueSegmentation>>(b"[]")
            .unwrap()
            .is_empty()
    );
    for fixture in [PRODUCT, GEOGRAPHIC] {
        let mut value: serde_json::Value = serde_json::from_slice(fixture).unwrap();
        let duplicate = value[0].clone();
        value.as_array_mut().unwrap().push(duplicate);
        assert_eq!(
            serde_json::from_value::<Vec<RevenueSegmentation>>(value)
                .unwrap()
                .len(),
            2
        );
    }

    assert!(
        serde_json::from_value::<Vec<RevenueSegmentation>>(serde_json::json!({ "segments": [] }))
            .is_err()
    );
}