tone3000 0.1.0

Async Rust client for the TONE3000 API (v1)
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
use tone3000::{ArchitectureVersion, Client, Model, ModelId, ToneId};
use wiremock::matchers::{header, method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};

/// A client in Bearer mode with a fixed access token, for read-path tests.
fn client(server: &MockServer) -> Client {
    Client::builder("t3k_pub_x")
        .access_token("AT")
        .base_url(server.uri())
        .build()
}

/// `Model` is `#[non_exhaustive]`, so build it the way a consumer would ever get one:
/// by deserializing an API payload.
fn model_fixture(server: &MockServer, file_path: &str) -> Model {
    serde_json::from_value(serde_json::json!({
        "id": 1,
        "tone_id": 2,
        "user_id": "u",
        "name": "",
        "model_url": format!("{}{}", server.uri(), file_path),
    }))
    .expect("model fixture deserializes")
}

#[tokio::test]
async fn search_parses_fixture_and_sends_bearer() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/tones/search"))
        .and(header("authorization", "Bearer AT"))
        .respond_with(
            ResponseTemplate::new(200).set_body_string(include_str!("fixtures/search.json")),
        )
        .mount(&server)
        .await;

    let results = client(&server).tones().query("plexi").await.unwrap();

    assert_eq!(results.total, 254);
    assert_eq!(results.data[0].id, ToneId(51949));
    assert_eq!(results.data[0].title, "Plexi 51");
}

#[tokio::test]
async fn search_serializes_all_filters() {
    use tone3000::{Format, Gear, Size};

    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/tones/search"))
        .respond_with(
            ResponseTemplate::new(200).set_body_string(include_str!("fixtures/search.json")),
        )
        .mount(&server)
        .await;

    client(&server)
        .tones()
        .query("plexi")
        .gears([Gear::Amp, Gear::Pedal])
        .format(Format::Nam)
        .size(Size::Standard)
        .tags(["clean", "crunch"])
        .make("Marshall")
        .creators(["brucew", "akka5"])
        .await
        .unwrap();

    let req = &server.received_requests().await.unwrap()[0];
    let q: std::collections::HashMap<_, _> = req.url.query_pairs().into_owned().collect();

    assert_eq!(q.get("gears").unwrap(), "amp_pedal");
    assert_eq!(q.get("format").unwrap(), "nam");
    assert_eq!(q.get("sizes").unwrap(), "standard");
    assert_eq!(q.get("tags").unwrap(), "clean_crunch");
    assert_eq!(q.get("makes").unwrap(), "Marshall");
    // creators is comma-joined, unlike every other multi-value filter. This asymmetry is
    // in the API, not a typo — see tone-3000/api src/tone3000-client.ts.
    assert_eq!(q.get("creators").unwrap(), "brucew,akka5");
}

#[tokio::test]
async fn tone_parses_fixture() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/tones/51949"))
        .respond_with(
            ResponseTemplate::new(200).set_body_string(include_str!("fixtures/tone.json")),
        )
        .mount(&server)
        .await;

    let tone = client(&server).tone(ToneId(51949)).await.unwrap();
    assert_eq!(tone.id, ToneId(51949));
    assert_eq!(tone.title, "Plexi 51");
}

#[tokio::test]
async fn tone_404_maps_to_status_error() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/tones/999"))
        .respond_with(ResponseTemplate::new(404).set_body_string("not found"))
        .mount(&server)
        .await;

    let err = client(&server).tone(ToneId(999)).await.unwrap_err();
    assert!(matches!(err, tone3000::Error::Status { code: 404, .. }));
}

#[tokio::test]
async fn models_parses_paginated_fixture() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/models"))
        .respond_with(
            ResponseTemplate::new(200).set_body_string(include_str!("fixtures/models.json")),
        )
        .mount(&server)
        .await;

    let page = client(&server).models(ToneId(51949)).await.unwrap();
    assert_eq!(page.total, 3);
    assert_eq!(page.data[0].id, ModelId(293886));
    assert_eq!(page.data[0].tone_id, ToneId(51949));
}

#[tokio::test]
async fn users_parses_paginated_fixture() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/users"))
        .respond_with(
            ResponseTemplate::new(200).set_body_string(include_str!("fixtures/users.json")),
        )
        .mount(&server)
        .await;

    let page = client(&server).users().await.unwrap();
    assert_eq!(page.data[0].username, "akka5");
    assert_eq!(page.data[0].tones_count, 153);
}

#[tokio::test]
async fn created_parses_empty_page() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/tones/created"))
        .respond_with(
            ResponseTemplate::new(200).set_body_string(include_str!("fixtures/created.json")),
        )
        .mount(&server)
        .await;

    let page = client(&server).created().await.unwrap();
    assert_eq!(page.total, 0);
    assert!(page.data.is_empty());
}

#[tokio::test]
async fn download_model_fetches_bytes_with_bearer() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/files/a.nam"))
        .and(header("authorization", "Bearer AT"))
        .respond_with(ResponseTemplate::new(200).set_body_bytes(vec![1u8, 2, 3, 4]))
        .mount(&server)
        .await;

    let model = model_fixture(&server, "/files/a.nam");
    let bytes = client(&server).download_model(&model).await.unwrap();
    assert_eq!(&bytes[..], &[1, 2, 3, 4]);
}

#[tokio::test]
async fn download_model_to_streams_to_writer() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/files/b.nam"))
        .respond_with(ResponseTemplate::new(200).set_body_bytes(vec![9u8; 100]))
        .mount(&server)
        .await;

    let model = model_fixture(&server, "/files/b.nam");
    let mut buf: Vec<u8> = Vec::new();
    let n = client(&server)
        .download_model_to(&model, &mut buf)
        .await
        .unwrap();
    assert_eq!(n, 100);
    assert_eq!(buf.len(), 100);
}

#[tokio::test]
async fn download_model_json_rejects_non_utf8() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/files/bad.nam"))
        .respond_with(ResponseTemplate::new(200).set_body_bytes(vec![0xFFu8, 0xFE]))
        .mount(&server)
        .await;

    let model = model_fixture(&server, "/files/bad.nam");
    let err = client(&server)
        .download_model_json(&model)
        .await
        .unwrap_err();
    assert!(matches!(err, tone3000::Error::Utf8(_)));
}

#[tokio::test]
async fn forbidden_maps_to_forbidden_error() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/tones/search"))
        .respond_with(ResponseTemplate::new(403))
        .mount(&server)
        .await;

    let err = client(&server).tones().await.unwrap_err();
    assert!(matches!(err, tone3000::Error::Forbidden));
}

#[tokio::test]
async fn call_without_token_errors_unauthenticated() {
    let client = Client::builder("t3k_pub_x").build();
    let err = client.user().await.unwrap_err();
    assert!(matches!(err, tone3000::Error::Unauthenticated));
}

#[tokio::test]
async fn list_builders_serialize_pagination() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_string(r#"{"data":[]}"#))
        .mount(&server)
        .await;

    let c = client(&server);
    c.tones().page(2).page_size(24).await.unwrap();
    c.created().page(3).await.unwrap();
    c.favorited().page_size(5).await.unwrap();
    c.models(ToneId(51949)).page(4).await.unwrap();
    c.users().query("akka").page_size(10).await.unwrap();

    let reqs = server.received_requests().await.unwrap();
    let q = |i: usize| -> std::collections::HashMap<String, String> {
        reqs[i].url.query_pairs().into_owned().collect()
    };

    assert_eq!(reqs[0].url.path(), "/tones/search");
    assert_eq!(q(0).get("page").unwrap(), "2");
    assert_eq!(q(0).get("page_size").unwrap(), "24");

    assert_eq!(reqs[1].url.path(), "/tones/created");
    assert_eq!(q(1).get("page").unwrap(), "3");

    assert_eq!(reqs[2].url.path(), "/tones/favorited");
    assert_eq!(q(2).get("page_size").unwrap(), "5");

    assert_eq!(reqs[3].url.path(), "/models");
    assert_eq!(q(3).get("tone_id").unwrap(), "51949");
    assert_eq!(q(3).get("page").unwrap(), "4");

    assert_eq!(reqs[4].url.path(), "/users");
    assert_eq!(q(4).get("query").unwrap(), "akka");
    assert_eq!(q(4).get("page_size").unwrap(), "10");
}

#[tokio::test]
async fn architecture_serializes_as_the_api_vocabulary() {
    // The API rejects anything outside '1' | '2' | 'custom' with a 400, despite upstream
    // types.ts declaring `architecture?: number`. Verified live 2026-08-11.
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_string(r#"{"data":[]}"#))
        .mount(&server)
        .await;

    let c = client(&server);
    c.tones()
        .architecture(ArchitectureVersion::Custom)
        .await
        .unwrap();
    c.models(ToneId(51949))
        .architecture(ArchitectureVersion::V2)
        .await
        .unwrap();

    let reqs = server.received_requests().await.unwrap();
    let q = |i: usize| -> std::collections::HashMap<String, String> {
        reqs[i].url.query_pairs().into_owned().collect()
    };
    assert_eq!(q(0).get("architecture").unwrap(), "custom");
    assert_eq!(q(1).get("architecture").unwrap(), "2");
}

#[tokio::test]
async fn sort_serializes_for_tones_and_users() {
    use tone3000::{ToneSort, UserSort};

    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_string(r#"{"data":[]}"#))
        .mount(&server)
        .await;

    let c = client(&server);
    c.tones().sort(ToneSort::DownloadsAllTime).await.unwrap();
    c.users().sort(UserSort::Favorites).await.unwrap();

    let reqs = server.received_requests().await.unwrap();
    let q = |i: usize| -> std::collections::HashMap<String, String> {
        reqs[i].url.query_pairs().into_owned().collect()
    };
    assert_eq!(q(0).get("sort").unwrap(), "downloads-all-time");
    assert_eq!(q(1).get("sort").unwrap(), "favorites");
}

#[tokio::test]
async fn repeated_filters_append_and_scalars_replace() {
    use tone3000::{Gear, ToneSort};

    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_string(r#"{"data":[]}"#))
        .mount(&server)
        .await;

    client(&server)
        .tones()
        // Repeatable filters accumulate...
        .gear(Gear::Amp)
        .gear(Gear::Pedal)
        .tags(["clean"])
        .tags(["crunch"])
        // ...while scalars take the last value written.
        .sort(ToneSort::Newest)
        .sort(ToneSort::Trending)
        .query("first")
        .query("second")
        .await
        .unwrap();

    let reqs = server.received_requests().await.unwrap();
    let q: std::collections::HashMap<String, String> =
        reqs[0].url.query_pairs().into_owned().collect();
    assert_eq!(q.get("gears").unwrap(), "amp_pedal");
    assert_eq!(q.get("tags").unwrap(), "clean_crunch");
    assert_eq!(q.get("sort").unwrap(), "trending");
    assert_eq!(q.get("query").unwrap(), "second");
}

#[tokio::test]
async fn bare_request_sends_no_query_parameters() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_string(r#"{"data":[]}"#))
        .mount(&server)
        .await;

    client(&server).tones().await.unwrap();

    let reqs = server.received_requests().await.unwrap();
    assert_eq!(reqs[0].url.query(), None, "browse must not invent filters");
}

#[tokio::test]
async fn unknown_architecture_round_trips_through_other() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_string(r#"{"data":[]}"#))
        .mount(&server)
        .await;

    client(&server)
        .tones()
        .architecture(ArchitectureVersion::Other("3".into()))
        .await
        .unwrap();

    let reqs = server.received_requests().await.unwrap();
    let q: std::collections::HashMap<String, String> =
        reqs[0].url.query_pairs().into_owned().collect();
    assert_eq!(q.get("architecture").unwrap(), "3");
}

#[tokio::test]
async fn connect_failure_surfaces_as_transport_error() {
    // Port 1 refuses connections; nothing is listening.
    let client = Client::builder("t3k_pub_x")
        .access_token("AT")
        .base_url("http://127.0.0.1:1")
        .build();

    let err = client.tones().await.unwrap_err();
    assert!(err.is_connect(), "expected a connect failure, got {err:?}");
    assert!(!err.is_timeout());
    assert!(matches!(err, tone3000::Error::Http(_)));
}

#[tokio::test]
async fn builders_are_cloneable_for_paging() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_string(r#"{"data":[]}"#))
        .mount(&server)
        .await;

    // A configured search is reusable across pages — the point of deriving Clone.
    let base = client(&server).tones().query("plexi");
    base.clone().page(1).await.unwrap();
    base.page(2).await.unwrap();

    let reqs = server.received_requests().await.unwrap();
    let q = |i: usize| -> std::collections::HashMap<String, String> {
        reqs[i].url.query_pairs().into_owned().collect()
    };
    assert_eq!(q(0).get("page").unwrap(), "1");
    assert_eq!(q(1).get("page").unwrap(), "2");
    assert_eq!(q(1).get("query").unwrap(), "plexi");
}

#[tokio::test]
async fn requests_are_spawnable() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_string(r#"{"data":[]}"#))
        .mount(&server)
        .await;

    // Builders own their client clone, so the future is 'static and can be spawned —
    // what a browse UI needs for background prefetch. `tokio::spawn` wants a `Future`,
    // so the `IntoFuture` conversion is explicit here; `.await` does it implicitly.
    use std::future::IntoFuture;
    let handle = tokio::spawn(client(&server).tones().query("plexi").into_future());
    handle.await.unwrap().unwrap();
}