simbld-http 1.0.0

A comprehensive HTTP response library for Rust.
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

use serde_json::json;
use std::collections::HashMap;

/// This helper function is used to return a JSON response with a status of 200 and a description of "OK" along with the data and headers provided.
///
/// # Arguments
///
/// * `headers` - A `HashMap` containing the headers to be included in the response.
///
/// # Returns
///
/// A `String` containing the JSON response.
///
/// # Example
///
/// ```
/// use std::collections::HashMap;
/// use serde_json::json;
/// use simbld_http::helpers::response_with_headers_helper::ok_with_headers;
///
/// let mut headers = HashMap::new();
/// headers.insert("Content-Type", "application/json");
/// let response = ok_with_headers(headers);
/// println!("{}", response);
pub fn ok_with_headers(headers: HashMap<&str, &str>) -> String {
    json!({
        "status": "OK",
        "code": 200,
        "description": "Request processed successfully",
        "headers": headers
    })
    .to_string()
}

/// This helper function is used to return a JSON response with a status of 400 and a description of "Bad Request" along with the data and headers provided.
///
/// # Arguments
///
/// * `headers` - A `HashMap` containing the headers to be included in the response.
///
/// # Returns
///
/// A `String` containing the JSON response.
///
/// # Example
///
/// ```
/// use std::collections::HashMap;
/// use simbld_http::helpers::response_with_headers_helper::bad_request_with_headers;
///
/// let mut headers = HashMap::new();
/// headers.insert("Content-Type", "application/json");
/// let response = bad_request_with_headers(headers);
/// println!("{}", response);
/// ```
pub fn bad_request_with_headers(headers: HashMap<&str, &str>) -> String {
    json!({
        "status": "Bad Request",
        "code": 400,
        "description": "The server cannot process the request due to malformed syntax",
        "headers": headers
    })
    .to_string()
}

#[cfg(test)]
mod tests {
    use super::*;
    
    #[test]
    fn test_ok_with_headers() {
        let mut headers = HashMap::new();
        headers.insert("Content-Type", "application/json");
        let response = ok_with_headers(headers.clone());
        assert!(response.contains("\"status\":\"OK\""));
        assert!(response.contains("\"code\":200"));
        assert!(response.contains("\"description\":\"Request processed successfully\""));
        assert!(response.contains("\"headers\":{"));
        assert!(response.contains("\"Content-Type\":\"application/json\""));
    }

    #[test]
    fn test_bad_request_with_headers() {
        let mut headers = HashMap::new();
        headers.insert("Content-Type", "application/json");
        let response = bad_request_with_headers(headers.clone());
        assert!(response.contains("\"status\":\"Bad Request\""));
        assert!(response.contains("\"code\":400"));
        assert!(response.contains(
            "\"description\":\"The server cannot process the request due to malformed syntax\""
        ));
        assert!(response.contains("\"headers\":{"));
        assert!(response.contains("\"Content-Type\":\"application/json\""));
    }
}