dxm-artifacts 0.2.2

Crate for installing FXServer installations.
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

//! Contains code for accessing the FXServer version changelog.

pub use channel::ArtifactsChannel;
pub use platform::ArtifactsPlatform;
use reqwest::blocking::Client;
use serde::Deserialize;

mod channel;
mod platform;

const CFX_SERVER_VERSIONS_API_URL: &str =
    "https://changelogs-live.fivem.net/api/changelog/versions/{platform}/server";

/// Represents the FXServer version changelog.
///
/// Does not support `ArtifactsChannel::LatestJg`.
/// Use `dxm_artifacts::jg` instead.
#[derive(Deserialize)]
pub struct ServerVersions {
    critical: String,
    recommended: String,
    optional: String,
    latest: String,

    critical_txadmin: String,
    recommended_txadmin: String,
    optional_txadmin: String,
    latest_txadmin: String,
}

impl ServerVersions {
    /// Returns the FXServer version for the given update channel.
    ///
    /// Panics if given `LatestJg` - use `dxm_artifacts::jg` instead.
    pub fn version(&self, channel: &ArtifactsChannel) -> &str {
        match channel {
            ArtifactsChannel::Critical => &self.critical,
            ArtifactsChannel::Recommended => &self.recommended,
            ArtifactsChannel::Optional => &self.optional,
            ArtifactsChannel::Latest => &self.latest,
            ArtifactsChannel::LatestJg => {
                panic!("received unexpected LatestJg in cfx server versions")
            }
        }
    }

    /// Returns the txAdmin version for the given update channel.
    ///
    /// Panics if given `LatestJg` - use `dxm_artifacts::jg` instead.
    pub fn txadmin(&self, channel: &ArtifactsChannel) -> &str {
        match channel {
            ArtifactsChannel::Critical => &self.critical_txadmin,
            ArtifactsChannel::Recommended => &self.recommended_txadmin,
            ArtifactsChannel::Optional => &self.optional_txadmin,
            ArtifactsChannel::Latest => &self.latest_txadmin,
            ArtifactsChannel::LatestJg => {
                panic!("received unexpected LatestJg in cfx server versions")
            }
        }
    }

    /// Returns a string containing information for the given update channel.
    pub fn alias_display(&self, alias: &ArtifactsChannel) -> String {
        format!(
            "{}\twith txAdmin v{}",
            self.version(alias),
            self.txadmin(alias)
        )
    }
}

/// Fetches and returns the FXServer version changelog.
pub fn versions(client: &Client, platform: &ArtifactsPlatform) -> reqwest::Result<ServerVersions> {
    log::trace!("getting artifacts versions");

    let url = changelogs_url(platform);
    let resp = client.get(url).send()?.error_for_status()?;

    resp.json::<ServerVersions>()
}

/// Returns the changelog URL for the given platform.
fn changelogs_url(platform: &ArtifactsPlatform) -> String {
    CFX_SERVER_VERSIONS_API_URL.replace("{platform}", platform.changelogs_name())
}

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

    #[test]
    fn returns_changelogs_url() {
        assert_eq!(
            changelogs_url(&ArtifactsPlatform::Windows),
            "https://changelogs-live.fivem.net/api/changelog/versions/win32/server"
        );
    }
}