oxihttp-core 0.1.4

OxiHTTP core types: error and http crate re-exports.
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264

//! Execution-free HTTP request builder for constructing `http::Request<Body>` values.
//!
//! Unlike the client's request builder, this builder has no network I/O — the terminal method
//! is `.build()` which returns an `OxiRequest<Body>`. Useful for tests, server-side request
//! forging, and as a reusable base for building requests without a live connection.

use bytes::Bytes;
use http::{HeaderMap, HeaderName, HeaderValue, Method, Uri};

use crate::body::Body;
use crate::error::OxiHttpError;
use crate::OxiRequest;

/// Execution-free HTTP request builder.
///
/// Constructs an `http::Request<Body>` without performing any network I/O.
/// The terminal method is [`RequestBuilder::build`] which returns an
/// `OxiRequest<Body>`. This is distinct from `oxihttp_client::RequestBuilder`
/// which owns a network connection and executes requests.
///
/// # Example
///
/// ```rust
/// use oxihttp_core::CoreRequestBuilder;
///
/// let req = CoreRequestBuilder::get("http://example.com/api")
///     .expect("valid URI")
///     .header("x-api-key", "secret")
///     .expect("valid header")
///     .build()
///     .expect("valid request");
///
/// assert_eq!(req.method(), http::Method::GET);
/// ```
#[derive(Debug)]
pub struct RequestBuilder {
    method: Method,
    uri: Uri,
    headers: HeaderMap,
    body: Body,
}

impl RequestBuilder {
    /// Create a new builder with the given method and URI.
    pub fn new(method: Method, uri: Uri) -> Self {
        Self {
            method,
            uri,
            headers: HeaderMap::new(),
            body: Body::empty(),
        }
    }

    /// Create a GET request builder.
    pub fn get(uri: impl AsRef<str>) -> Result<Self, OxiHttpError> {
        let uri = Uri::try_from(uri.as_ref())?;
        Ok(Self::new(Method::GET, uri))
    }

    /// Create a POST request builder.
    pub fn post(uri: impl AsRef<str>) -> Result<Self, OxiHttpError> {
        let uri = Uri::try_from(uri.as_ref())?;
        Ok(Self::new(Method::POST, uri))
    }

    /// Create a PUT request builder.
    pub fn put(uri: impl AsRef<str>) -> Result<Self, OxiHttpError> {
        let uri = Uri::try_from(uri.as_ref())?;
        Ok(Self::new(Method::PUT, uri))
    }

    /// Create a DELETE request builder.
    pub fn delete(uri: impl AsRef<str>) -> Result<Self, OxiHttpError> {
        let uri = Uri::try_from(uri.as_ref())?;
        Ok(Self::new(Method::DELETE, uri))
    }

    /// Create a PATCH request builder.
    pub fn patch(uri: impl AsRef<str>) -> Result<Self, OxiHttpError> {
        let uri = Uri::try_from(uri.as_ref())?;
        Ok(Self::new(Method::PATCH, uri))
    }

    /// Create a HEAD request builder.
    pub fn head(uri: impl AsRef<str>) -> Result<Self, OxiHttpError> {
        let uri = Uri::try_from(uri.as_ref())?;
        Ok(Self::new(Method::HEAD, uri))
    }

    /// Add a single header, replacing any existing header with the same name.
    pub fn header(
        mut self,
        name: impl AsRef<str>,
        value: impl AsRef<str>,
    ) -> Result<Self, OxiHttpError> {
        let name = HeaderName::try_from(name.as_ref())
            .map_err(|e| OxiHttpError::InvalidHeader(e.to_string()))?;
        let value = HeaderValue::try_from(value.as_ref())
            .map_err(|e| OxiHttpError::InvalidHeader(e.to_string()))?;
        self.headers.insert(name, value);
        Ok(self)
    }

    /// Merge a `HeaderMap` into the request headers, replacing duplicates.
    pub fn headers(mut self, headers: HeaderMap) -> Self {
        for (k, v) in &headers {
            self.headers.insert(k.clone(), v.clone());
        }
        self
    }

    /// Set a raw body (no `Content-Type` set automatically).
    pub fn body(mut self, body: impl Into<Body>) -> Self {
        self.body = body.into();
        self
    }

    /// Set a JSON body, serialising `value` and setting `Content-Type: application/json`.
    pub fn json<T: serde::Serialize>(mut self, value: &T) -> Result<Self, OxiHttpError> {
        let bytes = serde_json::to_vec(value).map_err(|e| OxiHttpError::Json(e.to_string()))?;
        self.headers.insert(
            http::header::CONTENT_TYPE,
            HeaderValue::from_static("application/json"),
        );
        self.body = Body::full(Bytes::from(bytes));
        Ok(self)
    }

    /// Set a URL-encoded form body, setting
    /// `Content-Type: application/x-www-form-urlencoded`.
    ///
    /// Takes a [`crate::FormBody`] whose `build()` is infallible, so this
    /// method returns `Self` directly.
    pub fn form(mut self, body: crate::FormBody) -> Self {
        self.headers.insert(
            http::header::CONTENT_TYPE,
            HeaderValue::from_static("application/x-www-form-urlencoded"),
        );
        self.body = Body::full(body.build());
        self
    }

    /// Build the request.
    ///
    /// Returns `Err` only when the accumulated headers, method, or URI are
    /// invalid at the `http::Request` layer (which should be rare given that
    /// the builder already validated each piece).
    pub fn build(self) -> Result<OxiRequest<Body>, OxiHttpError> {
        let mut builder = http::Request::builder().method(self.method).uri(self.uri);
        for (k, v) in &self.headers {
            builder = builder.header(k, v);
        }
        builder
            .body(self.body)
            .map_err(|e| OxiHttpError::Http(std::sync::Arc::new(e)))
    }
}

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

    #[test]
    fn test_get_builder() {
        let req = RequestBuilder::get("http://example.com/path")
            .expect("valid URI")
            .build()
            .expect("build succeeds");
        assert_eq!(req.method(), &Method::GET);
        assert_eq!(req.uri().to_string(), "http://example.com/path");
    }

    #[test]
    fn test_post_with_json() {
        #[derive(serde::Serialize)]
        struct Payload {
            key: &'static str,
        }

        let req = RequestBuilder::post("http://example.com/api")
            .expect("valid URI")
            .json(&Payload { key: "value" })
            .expect("serialises")
            .build()
            .expect("build succeeds");

        assert_eq!(req.method(), &Method::POST);
        assert_eq!(
            req.headers()
                .get(http::header::CONTENT_TYPE)
                .map(|v| v.as_bytes()),
            Some(b"application/json".as_ref()),
        );
    }

    #[test]
    fn test_headers_merged() {
        let mut extra = HeaderMap::new();
        extra.insert(
            HeaderName::from_static("x-custom"),
            HeaderValue::from_static("abc"),
        );

        let req = RequestBuilder::get("http://example.com")
            .expect("valid URI")
            .headers(extra)
            .build()
            .expect("build succeeds");

        assert_eq!(
            req.headers().get("x-custom").map(|v| v.as_bytes()),
            Some(b"abc".as_ref()),
        );
    }

    #[test]
    fn test_form_sets_content_type() {
        let form = FormBody::new().field("foo", "bar");
        let req = RequestBuilder::post("http://example.com/form")
            .expect("valid URI")
            .form(form)
            .build()
            .expect("build succeeds");

        assert_eq!(
            req.headers()
                .get(http::header::CONTENT_TYPE)
                .map(|v| v.as_bytes()),
            Some(b"application/x-www-form-urlencoded".as_ref()),
        );
    }

    #[test]
    fn test_invalid_uri_returns_error() {
        let result = RequestBuilder::get("not a valid uri!!!!");
        assert!(result.is_err());
    }

    #[test]
    fn test_all_methods() {
        let cases: &[(&str, Method)] = &[
            ("http://a.com", Method::POST),
            ("http://a.com", Method::PUT),
            ("http://a.com", Method::DELETE),
            ("http://a.com", Method::PATCH),
            ("http://a.com", Method::HEAD),
        ];
        for (uri, method) in cases {
            let req = match method.as_str() {
                "POST" => RequestBuilder::post(uri),
                "PUT" => RequestBuilder::put(uri),
                "DELETE" => RequestBuilder::delete(uri),
                "PATCH" => RequestBuilder::patch(uri),
                "HEAD" => RequestBuilder::head(uri),
                _ => unreachable!(),
            }
            .expect("valid uri")
            .build()
            .expect("build succeeds");
            assert_eq!(req.method(), method);
        }
    }
}