ai_usagebar/openrouter/
types.rs

1//! Wire types for OpenRouter's `/api/v1/credits` and `/api/v1/key`.
2//!
3//! Both endpoints wrap their payload in `{ "data": { ... } }`, hence the
4//! generic [`OrEnvelope`] wrapper.
5
6use serde::Deserialize;
7
8use crate::usage::OpenRouterSnapshot;
9
10/// Wrapper used by all OpenRouter v1 endpoints.
11#[derive(Debug, Clone, Deserialize)]
12pub struct OrEnvelope<T> {
13    pub data: T,
14}
15
16/// `GET /api/v1/credits` — total_credits and total_usage, both USD doubles.
17#[derive(Debug, Clone, Deserialize)]
18pub struct CreditsData {
19    #[serde(deserialize_with = "de_nonnegative_finite")]
20    pub total_credits: f64,
21    #[serde(deserialize_with = "de_nonnegative_finite")]
22    pub total_usage: f64,
23}
24
25/// `GET /api/v1/key` — per-key usage and free-tier flag.
26#[derive(Debug, Clone, Deserialize)]
27pub struct KeyData {
28    #[serde(default)]
29    pub label: String,
30    #[serde(default, deserialize_with = "de_opt_nonnegative_finite")]
31    pub limit: Option<f64>,
32    #[serde(default, deserialize_with = "de_opt_finite")]
33    pub limit_remaining: Option<f64>,
34    #[serde(deserialize_with = "de_nonnegative_finite")]
35    pub usage_daily: f64,
36    #[serde(deserialize_with = "de_nonnegative_finite")]
37    pub usage_weekly: f64,
38    #[serde(deserialize_with = "de_nonnegative_finite")]
39    pub usage_monthly: f64,
40    pub is_free_tier: bool,
41}
42
43fn checked_finite<E: serde::de::Error>(value: f64) -> Result<f64, E> {
44    if value.is_finite() {
45        Ok(value)
46    } else {
47        Err(E::custom("money value is not finite"))
48    }
49}
50
51fn checked_nonnegative<E: serde::de::Error>(value: f64) -> Result<f64, E> {
52    let value = checked_finite(value)?;
53    if value >= 0.0 {
54        Ok(value)
55    } else {
56        Err(E::custom("money value cannot be negative"))
57    }
58}
59
60fn de_nonnegative_finite<'de, D>(d: D) -> Result<f64, D::Error>
61where
62    D: serde::Deserializer<'de>,
63{
64    checked_nonnegative(f64::deserialize(d)?)
65}
66
67fn de_opt_nonnegative_finite<'de, D>(d: D) -> Result<Option<f64>, D::Error>
68where
69    D: serde::Deserializer<'de>,
70{
71    Option::<f64>::deserialize(d)?
72        .map(checked_nonnegative)
73        .transpose()
74}
75
76fn de_opt_finite<'de, D>(d: D) -> Result<Option<f64>, D::Error>
77where
78    D: serde::Deserializer<'de>,
79{
80    Option::<f64>::deserialize(d)?
81        .map(checked_finite)
82        .transpose()
83}
84
85/// Combine the two endpoint responses into the canonical snapshot.
86pub fn combine(credits: CreditsData, key: KeyData) -> OpenRouterSnapshot {
87    let label = if key.label.is_empty() {
88        "OpenRouter".to_string()
89    } else {
90        format!("OpenRouter — {}", key.label)
91    };
92    OpenRouterSnapshot {
93        label,
94        total_credits: credits.total_credits,
95        total_usage: credits.total_usage,
96        usage_daily: key.usage_daily,
97        usage_weekly: key.usage_weekly,
98        usage_monthly: key.usage_monthly,
99        is_free_tier: key.is_free_tier,
100        limit: key.limit,
101        limit_remaining: key.limit_remaining,
102    }
103}
104
105#[cfg(test)]
106mod tests {
107    use super::*;
108
109    #[test]
110    fn parses_credits_envelope() {
111        let raw = r#"{"data":{"total_credits":100.0,"total_usage":25.5}}"#;
112        let env: OrEnvelope<CreditsData> = serde_json::from_str(raw).unwrap();
113        assert_eq!(env.data.total_credits, 100.0);
114        assert_eq!(env.data.total_usage, 25.5);
115    }
116
117    #[test]
118    fn parses_key_envelope_with_nulls() {
119        let raw = r#"{"data":{
120            "label":"my-key",
121            "limit":null,"limit_remaining":null,
122            "usage":12.34,"usage_daily":1.0,"usage_weekly":3.0,"usage_monthly":12.0,
123            "is_free_tier":false
124        }}"#;
125        let env: OrEnvelope<KeyData> = serde_json::from_str(raw).unwrap();
126        assert_eq!(env.data.label, "my-key");
127        assert!(env.data.limit.is_none());
128        assert_eq!(env.data.usage_monthly, 12.0);
129        assert!(!env.data.is_free_tier);
130    }
131
132    #[test]
133    fn combine_builds_snapshot() {
134        let c = CreditsData {
135            total_credits: 100.0,
136            total_usage: 30.0,
137        };
138        let k = KeyData {
139            label: "key-A".into(),
140            limit: Some(50.0),
141            limit_remaining: Some(20.0),
142            usage_daily: 1.0,
143            usage_weekly: 5.0,
144            usage_monthly: 30.0,
145            is_free_tier: false,
146        };
147        let snap = combine(c, k);
148        assert_eq!(snap.label, "OpenRouter — key-A");
149        assert!((snap.balance() - 70.0).abs() < 1e-9);
150        assert_eq!(snap.consumed_pct(), 30);
151        assert_eq!(snap.usage_monthly, 30.0);
152    }
153
154    #[test]
155    fn combine_with_empty_label() {
156        let snap = combine(
157            CreditsData {
158                total_credits: 0.0,
159                total_usage: 0.0,
160            },
161            KeyData {
162                label: String::new(),
163                limit: None,
164                limit_remaining: None,
165                usage_daily: 0.0,
166                usage_weekly: 0.0,
167                usage_monthly: 0.0,
168                is_free_tier: false,
169            },
170        );
171        assert_eq!(snap.label, "OpenRouter");
172    }
173
174    #[test]
175    fn missing_required_money_does_not_deserialize_as_zero() {
176        assert!(serde_json::from_str::<OrEnvelope<CreditsData>>(r#"{"data":{}}"#).is_err());
177        assert!(
178            serde_json::from_str::<OrEnvelope<KeyData>>(
179                r#"{"data":{"label":"key","is_free_tier":false}}"#
180            )
181            .is_err()
182        );
183    }
184
185    #[test]
186    fn invalid_money_values_are_schema_drift() {
187        for total in ["-1", "1e400", "true", r#""zero""#] {
188            let raw = format!(r#"{{"data":{{"total_credits":{total},"total_usage":0}}}}"#);
189            assert!(
190                serde_json::from_str::<OrEnvelope<CreditsData>>(&raw).is_err(),
191                "{raw}"
192            );
193        }
194    }
195
196    #[test]
197    fn consumed_pct_handles_zero_credits() {
198        let s = OpenRouterSnapshot {
199            label: "x".into(),
200            total_credits: 0.0,
201            total_usage: 5.0,
202            usage_daily: 0.0,
203            usage_weekly: 0.0,
204            usage_monthly: 0.0,
205            is_free_tier: true,
206            limit: None,
207            limit_remaining: None,
208        };
209        assert_eq!(s.consumed_pct(), 0);
210    }
211}
ai_usagebar/openrouter/types.rs

ai_usagebar/openrouter/
types.rs
