datahugger 0.6.1

Tool for fetching data and metadata from DOI or URL.
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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
use std::{collections::HashMap, str::FromStr};

use exn::{Exn, OptionExt, ResultExt};
use reqwest::{
    header::{HeaderMap, HeaderValue, AUTHORIZATION, USER_AGENT},
    ClientBuilder,
};
use serde_json::Value as JsonValue;
use url::Url;

use crate::{
    datasets::{
        Arxiv, DataDryad, Dataone, DataverseDataset, DataverseFile, GitHub, HalScience,
        HuggingFace, MaterialsCloud, Zenodo, OSF,
    },
    repo::Dataset,
};

use crate::helper::json_extract;
use std::collections::HashSet;
use std::sync::LazyLock;

#[derive(Debug)]
pub struct DispatchError {
    pub message: String,
}

impl std::fmt::Display for DispatchError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.message)
    }
}

impl std::error::Error for DispatchError {}

#[derive(Debug)]
pub struct ResolveError {
    pub message: String,
}

impl std::fmt::Display for ResolveError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.message)
    }
}

impl std::error::Error for ResolveError {}

static DATAONE_DOMAINS: LazyLock<HashSet<&'static str>> = LazyLock::new(|| {
    HashSet::from([
        "arcticdata.io",
        "knb.ecoinformatics.org",
        "data.pndb.fr",
        "opc.dataone.org",
        "portal.edirepository.org",
        "goa.nceas.ucsb.edu",
        "data.piscoweb.org",
        "adc.arm.gov",
        "scidb.cn",
        "data.ess-dive.lbl.gov",
        "hydroshare.org",
        "ecl.earthchem.org",
        "get.iedadata.org",
        "usap-dc.org",
        "iys.hakai.org",
        "doi.pangaea.de",
        "rvdata.us",
        "sead-published.ncsa.illinois.edu",
    ])
});

static HAL_DOMAINS: LazyLock<HashSet<&'static str>> =
    LazyLock::new(|| HashSet::from(["hal.science", "inrae.fr"]));

static DATAVERSE_DOMAINS: LazyLock<HashSet<&'static str>> = LazyLock::new(|| {
    HashSet::from([
        "www.march.es",
        "www.murray.harvard.edu",
        "abacus.library.ubc.ca",
        "ada.edu.au",
        "adattar.unideb.hu",
        "archive.data.jhu.edu",
        "borealisdata.ca",
        "dados.ipb.pt",
        "dadosdepesquisa.fiocruz.br",
        "darus.uni-stuttgart.de",
        "data.aussda.at",
        "data.cimmyt.org",
        "data.fz-juelich.de",
        "data.goettingen-research-online.de",
        "data.inrae.fr",
        "data.scielo.org",
        "data.sciencespo.fr",
        "data.tdl.org",
        "data.univ-gustave-eiffel.fr",
        "datarepositorium.uminho.pt",
        "datasets.iisg.amsterdam",
        "dataspace.ust.hk",
        "dataverse.asu.edu",
        "dataverse.cirad.fr",
        "dataverse.csuc.cat",
        "dataverse.harvard.edu",
        "dataverse.iit.it",
        "dataverse.uliege.be",
        "dataverse.ird.fr",
        "dataverse.lib.umanitoba.ca",
        "dataverse.lib.unb.ca",
        "dataverse.lib.virginia.edu",
        "dataverse.nl",
        "dataverse.no",
        "dataverse.openforestdata.pl",
        "dataverse.scholarsportal.info",
        "dataverse.theacss.org",
        "dataverse.ucla.edu",
        "dataverse.unc.edu",
        "dataverse.unimi.it",
        "dataverse.yale-nus.edu.sg",
        "dorel.univ-lorraine.fr",
        "dvn.fudan.edu.cn",
        "edatos.consorciomadrono.es",
        "edmond.mpdl.mpg.de",
        "heidata.uni-heidelberg.de",
        "lida.dataverse.lt",
        "mxrdr.icm.edu.pl",
        "osnadata.ub.uni-osnabrueck.de",
        "planetary-data-portal.org",
        "qdr.syr.edu",
        "rdm.aau.edu.et",
        "rdr.kuleuven.be",
        "rds.icm.edu.pl",
        "recherche.data.gouv.fr",
        "redu.unicamp.br",
        "repod.icm.edu.pl",
        "repositoriopesquisas.ibict.br",
        "research-data.urosario.edu.co",
        "researchdata.cuhk.edu.hk",
        "researchdata.ntu.edu.sg",
        "rin.lipi.go.id",
        "ssri.is",
        "www.seanoe.org",
        "trolling.uit.no",
        "www.sodha.be",
        "www.uni-hildesheim.de",
        "dataverse.acg.maine.edu",
        "dataverse.icrisat.org",
        "datos.pucp.edu.pe",
        "datos.uchile.cl",
        "opendata.pku.edu.cn",
        "archaeology.datastations.nl",
        "ssh.datastations.nl",
        "lifesciences.datastations.nl",
        "phys-techsciences.datastations.nl",
        "dataverse.nl",
    ])
});

struct ParsedLink {
    owner: String,
    repo: String,
    reference: Option<String>,
    path: Option<String>,
}

fn parse_github_link(link: &str) -> Result<(ParsedLink, Url), Box<dyn std::error::Error>> {
    let url = Url::parse(link)?;
    let host = url.host_str().ok_or("Invalid URL: missing host")?;
    if host != "github.com" {
        return Err("URL is not a github.com link".into());
    }

    let segments: Vec<_> = url
        .path_segments()
        .ok_or("Cannot parse URL path segments")?
        .collect();

    if segments.len() < 2 {
        return Err("URL must be at least https://github.com/owner/repo".into());
    }

    let owner = segments[0].to_string();
    let repo = segments[1].to_string();

    let mut reference = None;
    let mut path = None;

    if segments.len() > 2 && segments[2] == "tree" {
        if segments.len() < 4 {
            return Err("Missing branch/commit after /tree".into());
        }

        reference = Some(segments[3].to_string());

        if segments.len() > 4 {
            path = Some(segments[4..].join("/"));
        }
    }

    Ok((
        ParsedLink {
            owner,
            repo,
            reference,
            path,
        },
        url,
    ))
}

// get default branch's commit
// NOTE: this might reach rate limit as well, therefore need a client as parameter.
async fn github_get_default_branch_commit(
    owner: &str,
    repo: &str,
) -> Result<String, Exn<DispatchError>> {
    // TODO: don't panic, and wrap client.get as client.get_json() to be used everywhere.
    let user_agent = format!("datahugger-cli/{}", env!("CARGO_PKG_VERSION"));
    let mut headers = HeaderMap::new();
    if let Ok(token) = std::env::var("GITHUB_TOKEN") {
        headers.insert(
            AUTHORIZATION,
            HeaderValue::from_str(&format!("token {token}")).unwrap(),
        );
    }
    headers.insert(USER_AGENT, HeaderValue::from_str(&user_agent).unwrap());
    let client = ClientBuilder::new()
        .user_agent(&user_agent)
        .default_headers(headers)
        .use_native_tls()
        .build()
        .unwrap();
    let repo_url = format!("https://api.github.com/repos/{owner}/{repo}");
    let resp: JsonValue = client
        .get(&repo_url)
        .send()
        .await
        .unwrap()
        .error_for_status()
        .unwrap()
        .json()
        .await
        .unwrap();
    let default_branch: String =
        json_extract(&resp, "default_branch").map_err(|_| DispatchError {
            message: "not able to get default branch".to_string(),
        })?;

    let commits_url =
        format!("https://api.github.com/repos/{owner}/{repo}/commits/{default_branch}");

    let resp: JsonValue = client
        .get(&commits_url)
        .header("User-Agent", user_agent.clone())
        .send()
        .await
        .unwrap()
        .error_for_status()
        .unwrap()
        .json()
        .await
        .unwrap();
    let commit_sha: String = json_extract(&resp, "sha").map_err(|_| DispatchError {
        message: "not able to get default branch".to_string(),
    })?;

    Ok(commit_sha)
}

async fn resolve_doi_to_url_with_base(
    client: &reqwest::Client,
    doi: &str,
    base_url: Option<&str>,
    follow_redirects: bool,
) -> Result<String, Exn<ResolveError>> {
    // check if doi is valid
    if !(doi.starts_with("10.") && doi.contains('/')) {
        exn::bail!(ResolveError {
            message: format!("Invalid DOI: '{doi}'"),
        });
    }

    let base_url = base_url.unwrap_or("https://doi.org/api/handles");

    let res = match client
        .get(format!("{}/{}", base_url, doi))
        .query(&[("type", "URL")])
        .send()
        .await
    {
        Ok(res) => res,
        Err(err) => {
            exn::bail!(ResolveError {
                message: format!("failed to resolve '{doi}': {err:?}")
            })
        }
    };

    let status = res.status();

    if !status.is_success() {
        exn::bail!(ResolveError {
            message: format!("failed to resolve '{doi}': status {status}")
        });
    }

    let json: serde_json::Value = match res.json().await {
        Ok(json) => json,
        Err(err) => {
            exn::bail!(ResolveError {
                message: format!("failed to parse response for '{doi}': {err:?}")
            })
        }
    };

    let url = match json.get("responseCode").and_then(|v| v.as_i64()) {
        Some(1) => match json.get("values").and_then(|v| v.as_array()) {
            Some(values) if !values.is_empty() => {
                match values[0]
                    .get("data")
                    .and_then(|d| d.get("value"))
                    .and_then(|v| v.as_str())
                {
                    Some(url) => Ok::<String, Exn<ResolveError>>(url.to_string()),
                    None => exn::bail!(ResolveError {
                        message: format!("missing data.value for '{doi}'")
                    }),
                }
            }
            _ => exn::bail!(ResolveError {
                message: format!("empty or missing values for '{doi}'")
            }),
        },
        Some(code) => exn::bail!(ResolveError {
            message: format!("unexpected responseCode {code} for '{doi}'")
        }),
        None => exn::bail!(ResolveError {
            message: format!("missing responseCode for '{doi}'")
        }),
    }?;

    if follow_redirects {
        let res = match client.head(&url).send().await {
            Ok(res) => res,
            Err(err) => exn::bail!(ResolveError {
                message: format!("failed to follow redirect for '{url}': {err:?}")
            }),
        };
        Ok(res.url().to_string())
    } else {
        Ok(url)
    }
}

pub async fn resolve_doi_to_url(
    client: &reqwest::Client,
    doi: &str,
    follow_redirects: bool,
) -> Result<String, Exn<ResolveError>> {
    resolve_doi_to_url_with_base(client, doi, None, follow_redirects).await
}

/// Resolves a dataset URL into a [`Dataset`] by dispatching based on the
/// URL's domain and structure.
///
/// This function parses the given URL and maps it to a supported data source
/// (e.g., DataONE, Dataverse, arXiv, Hugging Face, Zenodo, GitHub, etc.).
/// The resolution strategy depends on the domain and expected URL format.
///
/// # Errors
///
/// Returns an [`Exn<DispatchError>`] if:
///
/// - The input string is not a valid URL.
/// - Required URL components (e.g., domain, host, or path segments) are missing.
/// - The URL structure does not match the expected format for a supported provider
///   (e.g., missing identifiers like `doi`, `persistentId`, repository info, etc.).
/// - The domain is recognized but contains invalid or unsupported subtypes
///   (e.g., unsupported Hugging Face repo kind).
/// - The domain is unsupported.
/// - Additional resolution steps fail (e.g., fetching the default GitHub branch).
///
/// # Panics
///
/// This function may panic for domains that are explicitly marked as
/// unimplemented.
///
/// # Examples
///
/// ```no_run
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let ds = datahugger::resolve("https://zenodo.org/record/12345").await?;
/// # Ok(())
/// # }
/// ```
#[allow(clippy::too_many_lines)]
pub async fn resolve(link: &str) -> Result<Dataset, Exn<DispatchError>> {
    let link = Url::from_str(link).or_raise(|| DispatchError {
        message: format!("'{link}' not a valid url"),
    })?;
    let scheme = link.scheme();
    let domain = link.domain().ok_or_else(|| DispatchError {
        message: "domain unresolved".to_string(),
    })?;
    let host_str = link.host_str().ok_or_else(|| DispatchError {
        message: format!("host_str unresolved from '{link}'"),
    })?;

    // DataOne spec hosted
    if DATAONE_DOMAINS.contains(domain) {
        // https://data.ess-dive.lbl.gov/view/doi%3A10.15485%2F1971251
        // resolved to xml at https://cn.dataone.org/cn/v2/object/doi%3A10.15485%2F1971251
        let base_url = format!("{scheme}://{host_str}");
        let base_url = Url::from_str(&base_url).or_raise(|| DispatchError {
            message: format!("'{base_url}' is not valid url"),
        })?;
        let mut segments = link.path_segments().ok_or_else(|| DispatchError {
            message: format!("'{link}' cannot be base"),
        })?;
        let id = segments
            .find(|pat| pat.starts_with("doi"))
            .ok_or_raise(|| DispatchError {
                message: format!("expect 'doi' in '{link}'"),
            })?;

        let dataset = Dataset::new(Dataone::new(&base_url, id));
        return Ok(dataset);
    }

    // Dataverse spec hosted
    if DATAVERSE_DOMAINS.contains(domain) {
        // https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/KBHLOD
        // https://dataverse.harvard.edu/file.xhtml?persistentId=doi:10.7910/DVN/KBHLOD/JCJCJC
        let mut segments = link.path_segments().ok_or_else(|| DispatchError {
            message: format!("'{link}' cannot be base"),
        })?;
        let typ = segments.next().ok_or_else(|| DispatchError {
            message: format!("'{link}' no segments found"),
        })?;
        let queries = link.query_pairs();
        let queries = queries.collect::<HashMap<_, _>>();
        let Some(id) = queries.get("persistentId") else {
            exn::bail!(DispatchError {
                message: "query don't contains 'persistentId'".to_string()
            })
        };

        let typ = typ.strip_suffix(".xhtml").ok_or_else(|| DispatchError {
            message: "segment not in format *.xhtml".to_string(),
        })?;
        let base_url = format!("{scheme}://{host_str}");
        let base_url = Url::from_str(&base_url).or_raise(|| DispatchError {
            message: format!("'{base_url}' is not valid url"),
        })?;
        let version = ":latest-published".to_string();
        match typ {
            "dataset" => {
                let dataset = Dataset::new(DataverseDataset::new(id.as_ref(), &base_url, &version));
                return Ok(dataset);
            }
            "file" => {
                let dataset = Dataset::new(DataverseFile::new(id.as_ref(), &base_url, &version));
                return Ok(dataset);
            }
            ty => exn::bail!(DispatchError {
                message: format!("{ty} is not valid type, can only be 'dataset' or 'file'")
            }),
        }
    }

    match domain {
        "arxiv.org" => {
            let mut segments = link.path_segments().ok_or_else(|| DispatchError {
                message: format!("cannot get path segments of url '{}'", link.as_str()),
            })?;
            let id = segments
                .next()
                .and_then(|_| segments.next())
                .ok_or(DispatchError {
                    message: format!("connot get record id from '{link}'"),
                })?;

            let dataset = Dataset::new(Arxiv::new(id));
            Ok(dataset)
        }
        d if HAL_DOMAINS
            .iter()
            .any(|&hal_domain| d.ends_with(hal_domain)) =>
        {
            let mut segments = link.path_segments().ok_or_else(|| DispatchError {
                message: format!("cannot get path segments of url '{}'", link.as_str()),
            })?;
            let id = segments.next().ok_or(DispatchError {
                message: format!("connot get record id from '{link}'"),
            })?;

            // Remove version suffix (e.g., "hal-04707203v2" -> "hal-04707203")
            let id = if let Some(pos) = id.rfind('v') {
                &id[..pos] // Everything before the 'v'
            } else {
                id // No 'v' found, use as-is
            };

            let dataset = Dataset::new(HalScience::new(id));
            Ok(dataset)
        }
        "huggingface.co" => {
            eprintln!(
                "\x1b[33mwarning:\x1b[0m for reliable downloads, consider using the official Hugging Face APIs:\n\
                 \x1b[36m  - Rust:\x1b[0m hf_hub\n\
                 \x1b[36m  - Python:\x1b[0m datasets\n\
                 \n\
                 \x1b[2mFor example, datahugger would handle caching, retries, and consistency for you.\x1b[0m"
            );
            let mut segments = link.path_segments().ok_or_else(|| DispatchError {
                message: format!("cannot get path segments of url '{}'", link.as_str()),
            })?;

            let kind = segments.next().ok_or_else(|| DispatchError {
                message: format!("missing repo kind in url '{}'", link.as_str()),
            })?;

            // Currently only datasets are supported
            if kind != "datasets" {
                exn::bail!(DispatchError {
                    message: format!("unsupported Hugging Face repo kind '{kind}'"),
                });
            }

            let owner = segments.next().ok_or_else(|| DispatchError {
                message: format!("missing owner in url '{}'", link.as_str()),
            })?;

            let repo = segments.next().ok_or_else(|| DispatchError {
                message: format!("missing repo name in url '{}'", link.as_str()),
            })?;

            // URL forms:
            // /datasets/{owner}/{repo}
            // /datasets/{owner}/{repo}/tree/{revision}/...
            let (revision, _subpath) = match segments.next() {
                Some("tree") => {
                    let rev = segments.next().ok_or_else(|| DispatchError {
                        message: format!("missing revision in url '{}'", link.as_str()),
                    })?;
                    let rest: Vec<&str> = segments.collect();
                    (rev, rest.join("/"))
                }
                _ => ("main", String::new()),
            };

            let dataset = Dataset::new(HuggingFace::new(owner, repo, revision));
            Ok(dataset)
        }
        "archive.materialscloud.org" => {
            let segments = link
                .path_segments()
                .ok_or_else(|| DispatchError {
                    message: format!("cannot get path segments of url '{}'", link.as_str()),
                })?
                .collect::<Vec<&str>>();
            let record_id = if segments.len() >= 2 {
                segments[1]
            } else {
                exn::bail!(DispatchError {
                    message: format!("unable to parse dryad dataset id from '{link}'",)
                })
            };
            let dataset = Dataset::new(MaterialsCloud::new(record_id));
            Ok(dataset)
        }
        "zenodo.org" => {
            let segments = link
                .path_segments()
                .ok_or_else(|| DispatchError {
                    message: format!("cannot get path segments of url '{}'", link.as_str()),
                })?
                .collect::<Vec<&str>>();
            let record_id = if segments.len() >= 2 {
                segments[1]
            } else {
                exn::bail!(DispatchError {
                    message: format!("unable to parse dryad dataset id from '{link}'",)
                })
            };
            let dataset = Dataset::new(Zenodo::new(record_id));
            Ok(dataset)
        }
        "github.com" => {
            let (parsed, _url) = parse_github_link(link.as_ref()).map_err(|e| DispatchError {
                message: e.to_string(),
            })?;

            let dataset = if let Some(refspec) = parsed.reference {
                Dataset::new(GitHub::new(
                    &parsed.owner,
                    &parsed.repo,
                    &refspec,
                    parsed.path,
                ))
            } else {
                let branch_or_commit =
                    github_get_default_branch_commit(&parsed.owner, &parsed.repo).await?;

                Dataset::new(GitHub::new(
                    &parsed.owner,
                    &parsed.repo,
                    &branch_or_commit,
                    parsed.path,
                ))
            };

            Ok(dataset)
        }
        "datadryad.org" => {
            // example url: https://datadryad.org/dataset/doi:10.5061/dryad.mj8m0
            let segments = link
                .path_segments()
                .ok_or_else(|| DispatchError {
                    message: format!("cannot get path segments of url '{}'", link.as_str()),
                })?
                .collect::<Vec<&str>>();
            // id is 'doi:10.5061/dryad.mj8m0'
            let record_id = if segments.len() >= 3 && segments[0] == "dataset" {
                format!("{}/{}", segments[1], segments[2])
            } else {
                exn::bail!(DispatchError {
                    message: format!("unable to parse dryad dataset id from '{link}'",)
                })
            };
            let base_url = Url::from_str("https://datadryad.org/").or_raise(|| DispatchError {
                message: "invalid base url".to_string(),
            })?;

            let dataset = Dataset::new(DataDryad::new(record_id, &base_url));
            Ok(dataset)
        }
        "osf.io" => {
            let mut segments = link.path_segments().ok_or_else(|| DispatchError {
                message: format!("cannot get path segments of url '{}'", link.as_str()),
            })?;

            let id = segments.next().ok_or_else(|| DispatchError {
                message: format!("no segments path in url '{}'", link.as_str()),
            })?;

            let dataset = Dataset::new(OSF::new(id));
            Ok(dataset)
        }
        "data.mendeley.com" => {
            unimplemented!("help us! open an issue to request or PR to help us.")
        }
        "data.4tu.nl" => {
            unimplemented!("help us! open an issue to request or PR to help us.")
        }
        // DataVerse repositories (extracted from re3data)
        "b2share.eudat.eu" | "data.europa.eu" => {
            unimplemented!("help us! open an issue to request or PR to help us.")
        }
        _ => {
            exn::bail!(DispatchError {
                message: format!("unknown domain: {domain}")
            })
        }
    }
}

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

    use wiremock::matchers::{method, path, query_param};
    use wiremock::{Mock, MockServer, ResponseTemplate};
    #[tokio::test]
    async fn test_resolve_dataverse_default() {
        // dataset
        let url = "https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/KBHLOD";
        let qr = resolve(url).await.unwrap();
        let qr = qr
            .backend
            .as_any()
            .downcast_ref::<DataverseDataset>()
            .unwrap();
        assert_eq!(qr.id.as_str(), "doi:10.7910/DVN/KBHLOD");

        // file
        let url =
            "https://dataverse.harvard.edu/file.xhtml?persistentId=doi:10.7910/DVN/KBHLOD/DHJ45U";
        let qr = resolve(url).await.unwrap();
        let qr = qr.backend.as_any().downcast_ref::<DataverseFile>().unwrap();
        assert_eq!(qr.id.as_str(), "doi:10.7910/DVN/KBHLOD/DHJ45U");
    }

    #[tokio::test]
    async fn test_resolve_default() {
        // osf.io
        for url in ["https://osf.io/dezms/overview", "https://osf.io/dezms/"] {
            let qr = resolve(url).await.unwrap();
            let qr = qr.backend.as_any().downcast_ref::<OSF>().unwrap();
            assert_eq!(qr.id.as_str(), "dezms");
        }

        // arxiv
        let url = "https://arxiv.org/abs/2101.00001v1";
        let qr = resolve(url).await.unwrap();
        let qr = qr.backend.as_any().downcast_ref::<Arxiv>().unwrap();
        assert_eq!(qr.id.as_str(), "2101.00001v1");

        // Dataone
        let url = "https://arcticdata.io/catalog/view/doi%3A10.18739%2FA2542JB2X";
        let qr = resolve(url).await.unwrap();
        let qr = qr.backend.as_any().downcast_ref::<Dataone>().unwrap();
        assert_eq!(qr.id.as_str(), "doi%3A10.18739%2FA2542JB2X");
        assert_eq!(qr.base_url.as_str(), "https://arcticdata.io/");

        // dryad
        let url = "https://datadryad.org/dataset/doi:10.5061/dryad.mj8m0";
        let qr = resolve(url).await.unwrap();
        let qr = qr.backend.as_any().downcast_ref::<DataDryad>().unwrap();
        assert_eq!(qr.id.as_str(), "doi:10.5061/dryad.mj8m0");

        // github
        // let url = "https://github.com/EOSC-Data-Commons/datahugger-ng";
        // let qr = resolve(url).await.unwrap();
        // let qr = qr.backend.as_any().downcast_ref::<GitHub>().unwrap();
        // assert_eq!(qr.owner.as_str(), "EOSE-Data-Commons");
        // assert_eq!(qr.repo.as_str(), "datahugger-ng");
        // assert_eq!(
        //     qr.branch_or_commit.as_str(),
        //     "<commit number that can change because by default is the commit of default branch>"
        // );

        // hal
        let url = "https://hal.science/cel-01830944";
        let qr = resolve(url).await.unwrap();
        let qr = qr.backend.as_any().downcast_ref::<HalScience>().unwrap();
        assert_eq!(qr.id.as_str(), "cel-01830944");

        // huggingface
        let url = "https://huggingface.co/datasets/HuggingFaceFW/finepdfs";
        let qr = resolve(url).await.unwrap();
        let qr = qr.backend.as_any().downcast_ref::<HuggingFace>().unwrap();
        assert_eq!(qr.owner.as_str(), "HuggingFaceFW");
        assert_eq!(qr.repo.as_str(), "finepdfs");
        assert_eq!(qr.revision.as_str(), "main");

        // zenodo
        let url = "https://zenodo.org/records/17867222";
        let qr = resolve(url).await.unwrap();
        let qr = qr.backend.as_any().downcast_ref::<Zenodo>().unwrap();
        assert_eq!(qr.id.as_str(), "17867222");
    }

    #[tokio::test]
    async fn test_resolve_doi_to_url() {
        // test valid doi and mock HTTP call
        let mock_server = MockServer::start().await;

        Mock::given(method("GET"))
            .and(path("/10.34894/0B7ZLK"))
            .and(query_param("type", "URL"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
        "responseCode": 1,
        "values": [
            {
                "index": 1,
                "type": "URL",
                "data": {
                    "format": "string",
                    "value": "https://dataverse.nl/citation?persistentId=doi:10.34894/0B7ZLK"
                },
                "ttl": 86400,
                "timestamp": "2021-12-23T16:59:30Z"
            }
        ]
    })))
            .mount(&mock_server)
            .await;

        let client = reqwest::Client::builder()
            .use_native_tls()
            .timeout(Duration::from_secs(5))
            .build()
            .unwrap();

        let res = resolve_doi_to_url_with_base(
            &client,
            "10.34894/0B7ZLK",
            Some(&mock_server.uri()),
            false,
        )
        .await;

        assert!(res.is_ok());

        let url = res.unwrap();
        assert_eq!(
            url,
            "https://dataverse.nl/citation?persistentId=doi:10.34894/0B7ZLK"
        );

        // test an invalid DOI
        let res = resolve_doi_to_url_with_base(
            &client,
            "https://doi.org/10.34894/0B7ZLK",
            Some(&mock_server.uri()),
            false,
        )
        .await;

        assert!(res.is_err());

        assert_eq!(
            res.unwrap_err().message,
            "Invalid DOI: 'https://doi.org/10.34894/0B7ZLK'"
        );
    }
}