linode-api 0.1.0

Linode 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
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

use http_api_client::http::{
    self,
    header::{ACCEPT, AUTHORIZATION, CONTENT_TYPE, USER_AGENT},
    HeaderMap, Method, Request, Response, StatusCode,
};
use serde::{de::DeserializeOwned, ser::Serialize};
use url::Url;

use crate::endpoints::v4::{AccessToken, ErrorResponseBody, BASE_URL};

//
type Body = Vec<u8>;

//
pub fn render_request<ReqQuery, ReqBody>(
    method: Method,
    path: &str,
    query: Option<&ReqQuery>,
    body: Option<&ReqBody>,
    access_token: Option<&AccessToken>,
    base_url: Option<&Url>,
) -> Result<Request<Body>, RenderRequestError>
where
    ReqQuery: Serialize,
    ReqBody: Serialize,
{
    let path = path.strip_prefix('/').unwrap_or(path);
    let path = path.strip_prefix("v4/").unwrap_or(path);
    let base_url = base_url.unwrap_or(&BASE_URL);

    let request = Request::builder().method(method);

    let mut url = base_url.join(path).map_err(RenderRequestError::UrlJoin)?;

    if let Some(query) = query {
        let query = serde_qs::to_string(query).map_err(RenderRequestError::QuerySer)?;
        url.set_query(Some(&query));
    }
    let request = request.uri(url.as_str());

    let request = if let Some(access_token) = access_token {
        request.header(AUTHORIZATION, format!("Bearer {}", access_token))
    } else {
        request
    };

    let request = request
        .header(ACCEPT, "application/json")
        .header(USER_AGENT, "linode-api");

    let request = if let Some(body) = body {
        let body = serde_json::to_vec(body).map_err(RenderRequestError::BodySer)?;
        request.header(CONTENT_TYPE, "application/json").body(body)
    } else {
        request.body(vec![])
    };
    let request = request.map_err(RenderRequestError::RequestBuild)?;

    Ok(request)
}

//
#[derive(Debug)]
pub enum RenderRequestError {
    UrlJoin(url::ParseError),
    QuerySer(serde_qs::Error),
    BodySer(serde_json::Error),
    RequestBuild(http::Error),
}
impl core::fmt::Display for RenderRequestError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{self:?}")
    }
}
impl std::error::Error for RenderRequestError {}

//
pub fn parse_response<RespBody>(
    response: Response<Body>,
) -> Result<(StatusCode, Result<RespBody, ErrorResponseBody>, HeaderMap), ParseResponseError>
where
    RespBody: DeserializeOwned,
{
    let status = response.status();
    let headers = response.headers().to_owned();

    match status {
        StatusCode::NO_CONTENT => {
            let json =
                serde_json::from_slice::<RespBody>(&[]).map_err(ParseResponseError::BodyDe)?;
            Ok((status, Ok(json), headers))
        }
        status if status.is_success() => {
            let json = serde_json::from_slice::<RespBody>(response.body())
                .map_err(ParseResponseError::BodyDe)?;
            Ok((status, Ok(json), headers))
        }
        status => {
            let json = serde_json::from_slice::<ErrorResponseBody>(response.body())
                .map_err(ParseResponseError::BodyDe)?;
            Ok((status, Err(json), headers))
        }
    }
}

//
#[derive(Debug)]
pub enum ParseResponseError {
    BodyDe(serde_json::Error),
}
impl core::fmt::Display for ParseResponseError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{self:?}")
    }
}
impl std::error::Error for ParseResponseError {}

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

    #[test]
    fn test_render_request() {
        for (path, uri) in &[
            ("foo", "https://api.linode.com/v4/foo"),
            ("/foo", "https://api.linode.com/v4/foo"),
            ("foo/bar", "https://api.linode.com/v4/foo/bar"),
            ("/foo/bar", "https://api.linode.com/v4/foo/bar"),
            ("v4/foo", "https://api.linode.com/v4/foo"),
            ("/v4/foo", "https://api.linode.com/v4/foo"),
            ("v4/foo/bar", "https://api.linode.com/v4/foo/bar"),
            ("/v4/foo/bar", "https://api.linode.com/v4/foo/bar"),
        ] {
            match render_request::<(), ()>(Method::GET, path, None, None, None, None) {
                Ok(req) => {
                    assert_eq!(req.uri().to_string(), *uri);
                }
                Err(err) => panic!("{err}"),
            }
        }
    }
}