netbox 0.3.3

ergonomic rust client for NetBox 4.x REST API
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

//! status endpoint for basic health and version info.
//!
//! basic usage:
//! ```no_run
//! # use netbox::{Client, ClientConfig};
//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
//! # let client = Client::new(ClientConfig::new("https://netbox.example.com", "token"))?;
//! let status = client.status().status().await?;
//! println!("{}", status.len());
//! # Ok(())
//! # }
//! ```

use crate::Client;
use crate::error::Result;
use serde_json::Value;
use std::collections::HashMap;

/// status payload.
pub type Status = HashMap<String, Value>;

/// api for status endpoints.
#[derive(Clone)]
pub struct StatusApi {
    client: Client,
}

impl StatusApi {
    pub(crate) fn new(client: Client) -> Self {
        Self { client }
    }

    /// fetch netbox status.
    pub async fn status(&self) -> Result<Status> {
        self.client.get("status/").await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ClientConfig;
    use httpmock::{Method::GET, MockServer};

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn status_fetches_expected_path() {
        let server = MockServer::start();
        let base_url = server.base_url();
        let config = ClientConfig::new(&base_url, "token").with_max_retries(0);
        let client = Client::new(config).unwrap();
        let api = StatusApi::new(client);

        let response = serde_json::json!({"netbox-version": "4.4.2"});
        server.mock(|when, then| {
            when.method(GET).path("/api/status/");
            then.status(200).json_body(response);
        });

        let status = api.status().await.unwrap();
        assert_eq!(
            status.get("netbox-version").and_then(Value::as_str),
            Some("4.4.2")
        );
    }
}