openrouter-rs 0.14.0

A type-safe OpenRouter Rust SDK
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
use std::{
    io::{Read, Write},
    net::TcpListener,
    sync::mpsc,
    thread,
    time::Duration,
};

use openrouter_rs::{
    api::api_keys::{self, ApiKeyDetails},
    types::PaginationOptions,
};

struct CapturedRequest {
    request_line: String,
    request_text: String,
    body_text: String,
}

fn spawn_json_server(
    response_body: &str,
) -> (
    String,
    mpsc::Receiver<CapturedRequest>,
    thread::JoinHandle<()>,
) {
    let listener = TcpListener::bind("127.0.0.1:0").expect("listener should bind");
    let addr = listener
        .local_addr()
        .expect("listener should have local addr");
    let body = response_body.to_string();
    let (tx, rx) = mpsc::channel::<CapturedRequest>();

    let server = thread::spawn(move || {
        let (mut stream, _) = listener
            .accept()
            .expect("server should accept one connection");

        let mut request_bytes = Vec::new();
        let mut chunk = [0_u8; 1024];
        let header_end = loop {
            let read = stream.read(&mut chunk).expect("server should read request");
            if read == 0 {
                break None;
            }
            request_bytes.extend_from_slice(&chunk[..read]);
            if let Some(pos) = request_bytes
                .windows(4)
                .position(|window| window == b"\r\n\r\n")
            {
                break Some(pos + 4);
            }
        }
        .expect("request should contain header terminator");

        let header_text = String::from_utf8_lossy(&request_bytes[..header_end]).to_string();
        let request_line = header_text.lines().next().unwrap_or_default().to_string();

        let content_length = header_text
            .lines()
            .find_map(|line| {
                let lower = line.to_ascii_lowercase();
                if lower.starts_with("content-length:") {
                    line.split(':').nth(1)?.trim().parse::<usize>().ok()
                } else {
                    None
                }
            })
            .unwrap_or(0);

        let mut body_bytes = request_bytes[header_end..].to_vec();
        while body_bytes.len() < content_length {
            let read = stream
                .read(&mut chunk)
                .expect("server should read request body");
            if read == 0 {
                break;
            }
            body_bytes.extend_from_slice(&chunk[..read]);
        }

        let body_text = String::from_utf8_lossy(&body_bytes[..content_length]).to_string();
        let request_text = format!("{header_text}{body_text}");
        tx.send(CapturedRequest {
            request_line,
            request_text,
            body_text,
        })
        .expect("server should send captured request");

        let response = format!(
            "HTTP/1.1 200 OK\r\nContent-Type: application/json\r\nContent-Length: {}\r\nConnection: close\r\n\r\n{}",
            body.len(),
            body
        );
        stream
            .write_all(response.as_bytes())
            .expect("server should write response");
    });

    (format!("http://{addr}/api/v1"), rx, server)
}

#[test]
fn test_api_key_details_deserializes_official_provisioning_field() {
    let raw = r#"{
        "label":"default",
        "usage":1.5,
        "is_free_tier":false,
        "is_provisioning_key":true,
        "rate_limit":{"requests":1000,"interval":"1m"},
        "limit":100.0,
        "limit_remaining":98.5
    }"#;

    let parsed: ApiKeyDetails =
        serde_json::from_str(raw).expect("api key details should deserialize");
    assert!(parsed.is_management_key);
}

#[test]
fn test_api_key_details_deserializes_management_alias_field() {
    let raw = r#"{
        "label":"default",
        "usage":1.5,
        "is_free_tier":false,
        "is_management_key":true,
        "rate_limit":{"requests":1000,"interval":"1m"},
        "limit":100.0,
        "limit_remaining":98.5
    }"#;

    let parsed: ApiKeyDetails =
        serde_json::from_str(raw).expect("api key details should deserialize from alias");
    assert!(parsed.is_management_key);
}

#[test]
fn test_api_key_details_deserializes_when_both_management_and_legacy_fields_exist() {
    let raw = r#"{
        "label":"default",
        "usage":1.5,
        "is_free_tier":false,
        "is_management_key":true,
        "is_provisioning_key":true,
        "rate_limit":{"requests":1000,"interval":"1m"},
        "limit":100.0,
        "limit_remaining":98.5
    }"#;

    let parsed: ApiKeyDetails = serde_json::from_str(raw)
        .expect("api key details should deserialize when both fields exist");
    assert!(parsed.is_management_key);
}

#[tokio::test]
async fn test_get_current_api_key_path_and_auth_header() {
    let (base_url, rx, server) = spawn_json_server(
        r#"{"data":{"label":"default","usage":1.5,"is_free_tier":false,"is_management_key":true,"rate_limit":{"requests":1000,"interval":"1m"},"limit":100.0,"limit_remaining":98.5}}"#,
    );

    let details = api_keys::get_current_api_key(&base_url, "api-key")
        .await
        .expect("get current key should succeed");
    assert_eq!(details.label, "default");
    assert!(details.is_management_key);

    let captured = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request");
    assert_eq!(captured.request_line, "GET /api/v1/key HTTP/1.1");

    let request_lower = captured.request_text.to_ascii_lowercase();
    assert!(
        request_lower.contains("authorization: bearer api-key")
            || request_lower.contains("authorization:bearer api-key"),
        "authorization header should include API key, request:\n{}",
        captured.request_text
    );

    server.join().expect("server thread should finish");
}

#[tokio::test]
async fn test_delete_api_key_uses_single_api_v1_prefix() {
    let listener = TcpListener::bind("127.0.0.1:0").expect("listener should bind");
    let addr = listener
        .local_addr()
        .expect("listener should have local addr");
    let (tx, rx) = mpsc::channel::<String>();

    let server = thread::spawn(move || {
        let (mut stream, _) = listener
            .accept()
            .expect("server should accept one connection");
        let mut request_bytes = Vec::new();
        let mut chunk = [0_u8; 1024];

        loop {
            let read = stream.read(&mut chunk).expect("server should read request");
            if read == 0 {
                break;
            }
            request_bytes.extend_from_slice(&chunk[..read]);
            if request_bytes.windows(4).any(|window| window == b"\r\n\r\n") {
                break;
            }
        }

        let request_line = String::from_utf8_lossy(&request_bytes)
            .lines()
            .next()
            .unwrap_or_default()
            .to_string();
        tx.send(request_line)
            .expect("server should send request line");

        let response = b"HTTP/1.1 200 OK\r\nContent-Length: 0\r\nConnection: close\r\n\r\n";
        stream
            .write_all(response)
            .expect("server should write response");
    });

    let base_url = format!("http://{addr}/api/v1");
    let deleted = api_keys::delete_api_key(&base_url, "test-key", "key-hash")
        .await
        .expect("delete request should succeed");

    assert!(deleted, "delete endpoint should return true on success");

    let request_line = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request line");
    assert_eq!(request_line, "DELETE /api/v1/keys/key-hash HTTP/1.1");

    server.join().expect("server thread should finish");
}

#[tokio::test]
async fn test_list_api_keys_serializes_pagination_query() {
    let listener = TcpListener::bind("127.0.0.1:0").expect("listener should bind");
    let addr = listener
        .local_addr()
        .expect("listener should have local addr");
    let (tx, rx) = mpsc::channel::<String>();

    let server = thread::spawn(move || {
        let (mut stream, _) = listener
            .accept()
            .expect("server should accept one connection");
        let mut request_bytes = Vec::new();
        let mut chunk = [0_u8; 1024];

        loop {
            let read = stream.read(&mut chunk).expect("server should read request");
            if read == 0 {
                break;
            }
            request_bytes.extend_from_slice(&chunk[..read]);
            if request_bytes.windows(4).any(|window| window == b"\r\n\r\n") {
                break;
            }
        }

        let request_line = String::from_utf8_lossy(&request_bytes)
            .lines()
            .next()
            .unwrap_or_default()
            .to_string();
        tx.send(request_line)
            .expect("server should send request line");

        let response = b"HTTP/1.1 200 OK\r\nContent-Type: application/json\r\nContent-Length: 11\r\nConnection: close\r\n\r\n{\"data\":[]}";
        stream
            .write_all(response)
            .expect("server should write response");
    });

    let base_url = format!("http://{addr}/api/v1");
    let keys = api_keys::list_api_keys(
        &base_url,
        "mgmt-key",
        Some(PaginationOptions::with_offset(5)),
        Some(true),
    )
    .await
    .expect("list API keys should succeed");
    assert!(keys.is_empty(), "response payload should parse");

    let request_line = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request line");
    assert_eq!(
        request_line,
        "GET /api/v1/keys?offset=5&include_disabled=true HTTP/1.1"
    );

    server.join().expect("server thread should finish");
}

#[test]
fn test_api_key_deserializes_workspace_id() {
    let raw = r#"{
        "name":"ops",
        "label":"Operations",
        "hash":"key_hash_1",
        "workspace_id":"ws_123"
    }"#;

    let parsed: api_keys::ApiKey = serde_json::from_str(raw).expect("api key should deserialize");
    assert_eq!(parsed.workspace_id.as_deref(), Some("ws_123"));
}

#[tokio::test]
async fn test_list_api_keys_serializes_workspace_filter_query() {
    let listener = TcpListener::bind("127.0.0.1:0").expect("listener should bind");
    let addr = listener
        .local_addr()
        .expect("listener should have local addr");
    let (tx, rx) = mpsc::channel::<String>();

    let server = thread::spawn(move || {
        let (mut stream, _) = listener
            .accept()
            .expect("server should accept one connection");
        let mut request_bytes = Vec::new();
        let mut chunk = [0_u8; 1024];

        loop {
            let read = stream.read(&mut chunk).expect("server should read request");
            if read == 0 {
                break;
            }
            request_bytes.extend_from_slice(&chunk[..read]);
            if request_bytes.windows(4).any(|window| window == b"\r\n\r\n") {
                break;
            }
        }

        let request_line = String::from_utf8_lossy(&request_bytes)
            .lines()
            .next()
            .unwrap_or_default()
            .to_string();
        tx.send(request_line)
            .expect("server should send request line");

        let response = b"HTTP/1.1 200 OK\r\nContent-Type: application/json\r\nContent-Length: 11\r\nConnection: close\r\n\r\n{\"data\":[]}";
        stream
            .write_all(response)
            .expect("server should write response");
    });

    let base_url = format!("http://{addr}/api/v1");
    let response = api_keys::list_api_keys_in_workspace(
        &base_url,
        "mgmt-key",
        Some(PaginationOptions::with_offset(7)),
        Some(true),
        Some("ws_123"),
    )
    .await
    .expect("list_api_keys_in_workspace should succeed");
    assert!(response.is_empty());

    let request_line = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request line");
    assert_eq!(
        request_line,
        "GET /api/v1/keys?offset=7&include_disabled=true&workspace_id=ws_123 HTTP/1.1"
    );

    server.join().expect("server thread should finish");
}

#[tokio::test]
async fn test_list_api_keys_serializes_workspace_filter_without_other_query_params() {
    let listener = TcpListener::bind("127.0.0.1:0").expect("listener should bind");
    let addr = listener
        .local_addr()
        .expect("listener should have local addr");
    let (tx, rx) = mpsc::channel::<String>();

    let server = thread::spawn(move || {
        let (mut stream, _) = listener
            .accept()
            .expect("server should accept one connection");
        let mut request_bytes = Vec::new();
        let mut chunk = [0_u8; 1024];

        loop {
            let read = stream.read(&mut chunk).expect("server should read request");
            if read == 0 {
                break;
            }
            request_bytes.extend_from_slice(&chunk[..read]);
            if request_bytes.windows(4).any(|window| window == b"\r\n\r\n") {
                break;
            }
        }

        let request_line = String::from_utf8_lossy(&request_bytes)
            .lines()
            .next()
            .unwrap_or_default()
            .to_string();
        tx.send(request_line)
            .expect("server should send request line");

        let response = b"HTTP/1.1 200 OK\r\nContent-Type: application/json\r\nContent-Length: 11\r\nConnection: close\r\n\r\n{\"data\":[]}";
        stream
            .write_all(response)
            .expect("server should write response");
    });

    let base_url = format!("http://{addr}/api/v1");
    let response =
        api_keys::list_api_keys_in_workspace(&base_url, "mgmt-key", None, None, Some("ws_456"))
            .await
            .expect("list_api_keys_in_workspace should succeed");
    assert!(response.is_empty());

    let request_line = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request line");
    assert_eq!(
        request_line,
        "GET /api/v1/keys?workspace_id=ws_456 HTTP/1.1"
    );

    server.join().expect("server thread should finish");
}

#[tokio::test]
async fn test_create_api_key_serializes_workspace_id() {
    let (base_url, rx, server) =
        spawn_json_server(r#"{"data":{"name":"ops","hash":"key_hash_1","workspace_id":"ws_123"}}"#);

    let response = api_keys::create_api_key_in_workspace(
        &base_url,
        "mgmt-key",
        "ops",
        Some(25.0),
        Some("ws_123"),
    )
    .await
    .expect("create_api_key_in_workspace should succeed");
    assert_eq!(response.workspace_id.as_deref(), Some("ws_123"));

    let captured = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request");
    assert_eq!(captured.request_line, "POST /api/v1/keys HTTP/1.1");
    let body: serde_json::Value =
        serde_json::from_str(&captured.body_text).expect("request body should be valid json");
    assert_eq!(body["name"], "ops");
    assert_eq!(body["limit"], 25.0);
    assert_eq!(body["workspace_id"], "ws_123");

    server.join().expect("server thread should finish");
}

#[tokio::test]
async fn test_create_api_key_sends_path_body_and_auth_header() {
    let (base_url, rx, server) =
        spawn_json_server(r#"{"data":{"hash":"hash_123","name":"new-key","disabled":false}}"#);

    let created = api_keys::create_api_key(&base_url, "mgmt-key", "new-key", Some(25.0))
        .await
        .expect("create API key should succeed");
    assert_eq!(created.hash.as_deref(), Some("hash_123"));
    assert_eq!(created.name.as_deref(), Some("new-key"));

    let captured = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request");
    assert_eq!(captured.request_line, "POST /api/v1/keys HTTP/1.1");
    let request_lower = captured.request_text.to_ascii_lowercase();
    assert!(
        request_lower.contains("authorization: bearer mgmt-key")
            || request_lower.contains("authorization:bearer mgmt-key"),
        "authorization header should include management key, request:\n{}",
        captured.request_text
    );

    let request_json: serde_json::Value =
        serde_json::from_str(&captured.body_text).expect("request body should be valid JSON");
    assert_eq!(request_json["name"], "new-key");
    assert_eq!(request_json["limit"], 25.0);

    server.join().expect("server thread should finish");
}

#[tokio::test]
async fn test_get_api_key_sends_path_and_auth_header() {
    let (base_url, rx, server) =
        spawn_json_server(r#"{"data":{"hash":"hash_123","name":"new-key","disabled":false}}"#);

    let fetched = api_keys::get_api_key(&base_url, "mgmt-key", "hash_123")
        .await
        .expect("get API key should succeed");
    assert_eq!(fetched.hash.as_deref(), Some("hash_123"));

    let captured = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request");
    assert_eq!(captured.request_line, "GET /api/v1/keys/hash_123 HTTP/1.1");
    let request_lower = captured.request_text.to_ascii_lowercase();
    assert!(
        request_lower.contains("authorization: bearer mgmt-key")
            || request_lower.contains("authorization:bearer mgmt-key"),
        "authorization header should include management key, request:\n{}",
        captured.request_text
    );

    server.join().expect("server thread should finish");
}

#[tokio::test]
async fn test_update_api_key_sends_path_body_and_auth_header() {
    let (base_url, rx, server) =
        spawn_json_server(r#"{"data":{"hash":"hash_123","name":"renamed-key","disabled":true}}"#);

    let updated = api_keys::update_api_key(
        &base_url,
        "mgmt-key",
        "hash_123",
        Some("renamed-key".to_string()),
        Some(true),
        Some(99.0),
    )
    .await
    .expect("update API key should succeed");
    assert_eq!(updated.name.as_deref(), Some("renamed-key"));

    let captured = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request");
    assert_eq!(
        captured.request_line,
        "PATCH /api/v1/keys/hash_123 HTTP/1.1"
    );
    let request_lower = captured.request_text.to_ascii_lowercase();
    assert!(
        request_lower.contains("authorization: bearer mgmt-key")
            || request_lower.contains("authorization:bearer mgmt-key"),
        "authorization header should include management key, request:\n{}",
        captured.request_text
    );

    let request_json: serde_json::Value =
        serde_json::from_str(&captured.body_text).expect("request body should be valid JSON");
    assert_eq!(request_json["name"], "renamed-key");
    assert_eq!(request_json["disabled"], true);
    assert_eq!(request_json["limit"], 99.0);

    server.join().expect("server thread should finish");
}