libfmp 0.3.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

use libfmp::{
    endpoints::analyst::{
        FinancialEstimatesQuery, HistoricalRatingsQuery, HistoricalStockGradesQuery,
        PriceTargetConsensusQuery, PriceTargetSummaryQuery, RatingsSnapshotQuery, StockGradesQuery,
        StockGradesSummaryQuery,
    },
    query::RetrievalFrequency,
    types::{Limit, Page, Ticker},
};

#[test]
fn estimates_require_the_narrow_frequency_and_preserve_unbounded_pagination() {
    let symbol = Ticker::new("BRK.B / Class A").unwrap();
    let annual = FinancialEstimatesQuery::new(symbol.clone(), RetrievalFrequency::Annual);
    assert_eq!(annual.symbol(), &symbol);
    assert_eq!(annual.period(), RetrievalFrequency::Annual);
    assert_eq!(annual.period().to_string(), "annual");
    assert_eq!(annual.page(), None);
    assert_eq!(annual.limit(), None);

    let quarterly = FinancialEstimatesQuery::new(symbol, RetrievalFrequency::Quarterly)
        .with_page(Page(0))
        .with_limit(Limit(u32::MAX));
    assert_eq!(quarterly.period().to_string(), "quarter");
    assert_eq!(quarterly.page(), Some(Page(0)));
    assert_eq!(quarterly.limit(), Some(Limit(u32::MAX)));
}

#[test]
fn every_symbol_only_query_preserves_owned_and_borrowed_tickers() {
    let symbol = Ticker::new("BRK.B / Class A").unwrap();

    macro_rules! assert_symbol_query {
        ($query:ty) => {{
            let owned: $query = symbol.clone().into();
            assert_eq!(owned.symbol(), &symbol);
            let borrowed: $query = (&symbol).into();
            assert_eq!(borrowed.symbol(), &symbol);
        }};
    }

    assert_symbol_query!(RatingsSnapshotQuery);
    assert_symbol_query!(PriceTargetSummaryQuery);
    assert_symbol_query!(PriceTargetConsensusQuery);
    assert_symbol_query!(StockGradesQuery);
    assert_symbol_query!(StockGradesSummaryQuery);
}

#[test]
fn both_historical_queries_preserve_omission_zero_and_full_limit_domain() {
    let symbol = Ticker::new("AAPL").unwrap();

    let ratings: HistoricalRatingsQuery = (&symbol).into();
    assert_eq!(ratings.symbol(), &symbol);
    assert_eq!(ratings.limit(), None);
    assert_eq!(ratings.with_limit(Limit(0)).limit(), Some(Limit(0)));

    let grades: HistoricalStockGradesQuery = symbol.into();
    assert_eq!(grades.limit(), None);
    assert_eq!(
        grades.with_limit(Limit(u32::MAX)).limit(),
        Some(Limit(u32::MAX))
    );
}