nvrs 0.1.7

🚦 fast new version checker for software releases 🦀
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

//! this module handles management & communication with sources, also knows as APIs

#[cfg(feature = "aur")]
mod aur;
#[cfg(feature = "crates-io")]
mod crates_io;
#[cfg(feature = "gitea")]
mod gitea;
#[cfg(feature = "github")]
mod github;
#[cfg(feature = "gitlab")]
mod gitlab;
#[cfg(feature = "regex")]
mod regex;

/// struct containing the API name & a pointer to API's `get_latest` function
pub struct Api {
    /// name of the API
    pub name: &'static str,
    /// pointer to the API's `get_latest` function
    pub(crate) func: fn(ApiArgs) -> ReleaseFuture,
}

/// arguments passed to a source
pub(crate) struct ApiArgs {
    pub request_client: reqwest::Client,
    /// name of the package
    pub package: String,
    pub use_max_tag: Option<bool>,
    /// arguments passed to the source
    pub args: Vec<String>,
    pub api_key: String, // empty String if none
}

/// this is what `get_latest`s return
#[derive(Debug)]
pub struct Release {
    /// name of the package
    pub name: String,
    /// version of the package
    pub tag: Option<String>,
    /// url to the version's source
    pub url: String,
}

// this is necessary because we need to store a reference to an async function in `Api`
type ReleaseFuture =
    std::pin::Pin<Box<dyn std::future::Future<Output = crate::error::Result<Release>> + Send>>;

fn setup_headers() -> reqwest::header::HeaderMap {
    use reqwest::header::{HeaderMap, HeaderValue, USER_AGENT};

    let mut headers = HeaderMap::new();
    headers.insert(USER_AGENT, HeaderValue::from_static("nvrs"));

    headers
}

fn match_statuscode(status: &reqwest::StatusCode, package: String) -> crate::error::Result<()> {
    use crate::error;
    use reqwest::StatusCode;

    match status.to_owned() {
        StatusCode::OK => Ok(()),
        StatusCode::FORBIDDEN => Err(error::Error::RequestForbidden(package)),
        _ => Err(error::Error::RequestNotOK(package, status.to_string())),
    }
}

/// public list of available sources
pub const API_LIST: &[Api] = &[
    #[cfg(feature = "aur")]
    Api {
        name: "aur",
        func: aur::get_latest,
    },
    #[cfg(feature = "crates-io")]
    Api {
        name: "cratesio",
        func: crates_io::get_latest,
    },
    #[cfg(feature = "gitea")]
    Api {
        name: "gitea",
        func: gitea::get_latest,
    },
    #[cfg(feature = "github")]
    Api {
        name: "github",
        func: github::get_latest,
    },
    #[cfg(feature = "gitlab")]
    Api {
        name: "gitlab",
        func: gitlab::get_latest,
    },
    #[cfg(feature = "regex")]
    Api {
        name: "regex",
        func: regex::get_latest,
    },
];

#[test]
fn statuscode_matching_test() {
    use reqwest::StatusCode;

    assert!(match_statuscode(&StatusCode::OK, String::new()).is_ok());
    assert!(match_statuscode(&StatusCode::IM_A_TEAPOT, String::new()).is_err());
}