ferro-cargo-registry-server 0.0.1

Cargo Alternative Registry Protocol server-side primitives — sparse index, /config.json, publish/yank/owners API. Backed by ferro-blob-store. Extracted from the Ferro ecosystem.
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

// SPDX-License-Identifier: Apache-2.0
//! Sparse-index `config.json` representation.
//!
//! Reference:
//! `doc.rust-lang.org/cargo/reference/registries.html#index-configuration`.
//!
//! Cargo fetches `config.json` at the root of the index and uses it to
//! discover the download and API URLs. FerroRepo serves the following
//! fields:
//!
//! ```json
//! {
//!   "dl":   "/api/v1/crates/{crate}/{version}/download",
//!   "api":  "<host>",
//!   "auth-required": false
//! }
//! ```

use serde::{Deserialize, Serialize};

/// Root-level sparse index configuration.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct IndexConfig {
    /// Download URL template. `{crate}` and `{version}` are substituted
    /// by the client.
    pub dl: String,
    /// Base URL for the Registry Web API.
    pub api: String,
    /// Whether all requests must carry an `Authorization` header.
    #[serde(rename = "auth-required", default)]
    pub auth_required: bool,
}

impl IndexConfig {
    /// Build the default Phase 1 configuration pinned to `api_host`.
    #[must_use]
    pub fn new(api_host: impl Into<String>) -> Self {
        Self {
            dl: "/api/v1/crates/{crate}/{version}/download".to_owned(),
            api: api_host.into(),
            auth_required: false,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::IndexConfig;

    #[test]
    fn config_json_round_trip() {
        let c = IndexConfig::new("http://localhost:8080");
        let s = serde_json::to_string(&c).unwrap();
        let c2: IndexConfig = serde_json::from_str(&s).unwrap();
        assert_eq!(c, c2);
    }

    #[test]
    fn dl_template_matches_spec() {
        let c = IndexConfig::new("x");
        assert!(c.dl.contains("{crate}"));
        assert!(c.dl.contains("{version}"));
    }
}