finance-query 2.8.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

//! Compile tests for docs/library/economic.md
//!
//! Requires the `fred` feature flag:
//!   cargo test --test doc_economic --features fred
//!
//! Runtime behavior of the economic series path is covered without network
//! access by the mock + unit tests in `src/adapters/fred/mod.rs`,
//! `src/adapters/alphavantage/economic/mod.rs`, and
//! `src/adapters/polygon/economic/mod.rs` (mocked HTTP / DTO → canonical
//! `EconomicSeries`).

#![cfg(feature = "fred")]

use finance_query::EconomicSeries;
use finance_query::fred::MacroObservation;

// ---------------------------------------------------------------------------
// Model fields — compile-time verification
// ---------------------------------------------------------------------------

/// Verifies EconomicSeries fields documented in economic.md exist with correct types.
/// Never called; exists only for the compiler to type-check.
#[allow(dead_code)]
fn _verify_economic_series_fields(s: EconomicSeries) {
    let _: String = s.series_id;
    let _: Option<String> = s.title;
    let _: Option<String> = s.units;
    let _: Option<String> = s.frequency;
    let _: Vec<MacroObservation> = s.observations;
}

/// Verifies MacroObservation fields documented in economic.md.
#[allow(dead_code)]
fn _verify_macro_observation_fields(o: MacroObservation) {
    let _: String = o.date;
    let _: Option<f64> = o.value;
}

// ---------------------------------------------------------------------------
// Capability and Provider constants — compile-time verification
// ---------------------------------------------------------------------------

/// Verifies Capability::ECONOMIC and Provider::Fred exist as documented.
#[allow(dead_code)]
fn _verify_routing_constants() {
    use finance_query::{Capability, Provider};
    let _: Capability = Capability::ECONOMIC;
    let _: Provider = Provider::Fred;
}

// ---------------------------------------------------------------------------
// FRED initialization — compile-time verification
// ---------------------------------------------------------------------------

/// Verifies fred::init compiles with the documented pattern from economic.md.
/// Never called; exists only to ensure the compile-time pattern is valid.
#[allow(dead_code)]
fn _verify_fred_init_pattern() {
    use finance_query::fred;

    // This block mirrors the pattern shown in economic.md lines 35-39
    // within the "FRED API Key" note section.
    // In practice, this would use: fred::init(std::env::var("FRED_API_KEY").unwrap())?;
    // For compile-only verification, we use a test key.
    let _ = fred::init("test-key");
}

// ---------------------------------------------------------------------------
// Compile-time: handle API — mirrors the setup block in economic.md
// ---------------------------------------------------------------------------

/// Verifies the documented `EconomicIndicator` flow type-checks:
///   providers.economic("GDP") → series()
/// Never called; exists only for the compiler to type-check. Runtime behavior
/// is covered by the mock + unit tests in `src/adapters/fred/mod.rs`.
#[allow(dead_code)]
async fn _verify_economic_indicator_api() -> finance_query::Result<()> {
    use finance_query::{Capability, Provider, Providers};

    let providers = Providers::builder()
        .route(Capability::ECONOMIC, [Provider::Fred])
        .build()
        .await?;

    let gdp = providers.economic("GDP");
    let _series: EconomicSeries = gdp.series().await?;
    Ok(())
}