finance-query 3.0.0

A Rust library for querying financial data
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

//! Commodities endpoints for Financial Modeling Prep.

use crate::error::Result;

use crate::adapters::fmp::build_client;
use crate::adapters::fmp::models::FmpQuoteDTO;

/// Convert FMP quote DTOs into a canonical CommodityQuote.
fn commodity_quote_to_canonical(
    symbol: &str,
    quotes: &[FmpQuoteDTO],
) -> crate::models::commodities::CommodityQuote {
    let q = quotes.first();
    crate::models::commodities::CommodityQuote {
        symbol: symbol.to_string(),
        name: q.and_then(|q| q.name.clone()),
        unit: None,
        price: q.and_then(|q| q.price),
        change: q.and_then(|q| q.change),
        change_percent: q.and_then(|q| q.changes_percentage),
        timestamp: None,
    }
}

/// Fetch a canonical commodity quote.
pub async fn fetch_canonical_commodity_quote(
    symbol: &str,
) -> Result<crate::models::commodities::CommodityQuote> {
    let quotes = commodity_quote(symbol).await?;
    Ok(commodity_quote_to_canonical(symbol, &quotes))
}

/// Fetch a real-time commodity quote.
///
/// * `symbol` - e.g., `"GCUSD"` (gold)
pub async fn commodity_quote(symbol: &str) -> Result<Vec<FmpQuoteDTO>> {
    let client = build_client()?;
    client.get("/stable/quote", &[("symbol", symbol)]).await
}

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

    /// Mocked HTTP → `Vec<FmpQuoteDTO>` → `commodity_quote_to_canonical`, covering
    /// the full `fetch_canonical_commodity_quote` pipeline without a network call.
    #[tokio::test]
    async fn test_commodity_quote_to_canonical_mock() {
        let mut server = mockito::Server::new_async().await;
        let _mock = server
            .mock("GET", "/stable/quote")
            .match_query(mockito::Matcher::AllOf(vec![mockito::Matcher::UrlEncoded(
                "apikey".into(),
                "test-key".into(),
            )]))
            .with_status(200)
            .with_body(
                serde_json::json!([{
                    "symbol": "GCUSD",
                    "name": "Gold Futures",
                    "price": 2053.6,
                    "change": 12.3,
                    "changesPercentage": 0.6
                }])
                .to_string(),
            )
            .create_async()
            .await;

        let client = crate::adapters::fmp::build_test_client(&server.url()).unwrap();
        let quotes: Vec<FmpQuoteDTO> = client.get("/stable/quote", &[]).await.unwrap();

        let quote = commodity_quote_to_canonical("GCUSD", &quotes);
        assert_eq!(quote.symbol, "GCUSD");
        assert_eq!(quote.name.as_deref(), Some("Gold Futures"));
        assert_eq!(quote.price, Some(2053.6));
        assert_eq!(quote.change, Some(12.3));
        assert_eq!(quote.change_percent, Some(0.6));
    }

    #[test]
    fn commodity_quote_to_canonical_empty_yields_no_values() {
        let quote = commodity_quote_to_canonical("GCUSD", &[]);
        assert_eq!(quote.symbol, "GCUSD");
        assert!(quote.price.is_none());
        assert!(quote.name.is_none());
    }
}