volga 0.9.1

Easy & Fast Web Framework 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
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

//! Macros for Form Data responses

/// Produces `OK 200` response with Form Data body
///
/// # Example
/// ```no_run
/// use std::collections::HashMap;
/// use volga::form;
///
/// # async fn dox() -> std::io::Result<()> {
/// let data = HashMap::from([
///     ("key", "value")
/// ]);
///
/// form!(data);
/// # Ok(())
/// # }
/// ```
#[macro_export]
macro_rules! form {
    // handles form!({ "key": "value" })
    ({ $($json:tt)* }) => {
        match $crate::HttpBody::form($crate::json::json_internal!({ $($json)* })) {
            Ok(body) => $crate::response!(
                $crate::http::StatusCode::OK,
                body;
                [
                    $crate::headers::ContentType::form(),
                ]
            ),
            Err(err) => Err(err),
        }
    };

    // handles form!({ "key": "value" }; [("key", "val")])
    ({ $($json:tt)* }; [ $( $header:expr ),* $(,)? ]) => {
        match $crate::HttpBody::form($crate::json::json_internal!({ $($json)* })) {
            Ok(body) => $crate::response!(
                $crate::http::StatusCode::OK,
                body;
                [
                    $crate::headers::ContentType::form(),
                    $( $header ),*
                ]
            ),
            Err(err) => Err(err),
        }
    };

    // handles form!(object; [("key", "val")])
    ($body:expr; [ $( $header:expr ),* $(,)? ]) => {
        match $crate::HttpBody::form($body) {
            Ok(body) => $crate::response!(
                $crate::http::StatusCode::OK,
                body;
                [
                    $crate::headers::ContentType::form(),
                    $( $header ),*
                ]
            ),
            Err(err) => Err(err),
        }
    };

    // handles form!(object)
    ($body:expr) => {
        match $crate::HttpBody::form($body) {
            Ok(body) => $crate::response!(
                $crate::http::StatusCode::OK,
                body;
                [
                    $crate::headers::ContentType::form(),
                ]
            ),
            Err(err) => Err(err),
        }
    };
}

#[cfg(test)]
mod tests {
    use http_body_util::BodyExt;
    use std::collections::HashMap;

    #[tokio::test]
    async fn it_creates_form_data_response() {
        let data = HashMap::from([("key", "value")]);
        let response = form!(data);

        assert!(response.is_ok());

        let mut response = response.unwrap();
        let body = &response.body_mut().collect().await.unwrap().to_bytes();

        assert_eq!(response.status(), 200);
        assert_eq!(String::from_utf8_lossy(body), "key=value");
        assert_eq!(
            response.headers().get("Content-Type").unwrap(),
            "application/x-www-form-urlencoded"
        );
    }

    #[tokio::test]
    async fn it_creates_form_data_response_with_headers() {
        let data = HashMap::from([("key", "value")]);
        let response = form!(data; [
            ("x-api-key", "some api key"),
            ("x-req-id", "some req id"),
        ]);

        assert!(response.is_ok());

        let mut response = response.unwrap();
        let body = &response.body_mut().collect().await.unwrap().to_bytes();

        assert_eq!(response.status(), 200);
        assert_eq!(String::from_utf8_lossy(body), "key=value");
        assert_eq!(
            response.headers().get("Content-Type").unwrap(),
            "application/x-www-form-urlencoded"
        );
        assert_eq!(response.headers().get("x-api-key").unwrap(), "some api key");
        assert_eq!(response.headers().get("x-req-id").unwrap(), "some req id");
    }

    #[tokio::test]
    async fn it_creates_form_data_untyped_response() {
        let response = form!({ "key": "value" });

        assert!(response.is_ok());

        let mut response = response.unwrap();
        let body = &response.body_mut().collect().await.unwrap().to_bytes();

        assert_eq!(response.status(), 200);
        assert_eq!(String::from_utf8_lossy(body), "key=value");
        assert_eq!(
            response.headers().get("Content-Type").unwrap(),
            "application/x-www-form-urlencoded"
        );
    }

    #[tokio::test]
    async fn it_creates_form_data_untyped_response_with_headers() {
        let response = form!({ "key": "value" }; [
            ("x-api-key", "some api key"),
            ("x-req-id", "some req id"),
        ]);

        assert!(response.is_ok());

        let mut response = response.unwrap();
        let body = &response.body_mut().collect().await.unwrap().to_bytes();

        assert_eq!(response.status(), 200);
        assert_eq!(String::from_utf8_lossy(body), "key=value");
        assert_eq!(
            response.headers().get("Content-Type").unwrap(),
            "application/x-www-form-urlencoded"
        );
        assert_eq!(response.headers().get("x-api-key").unwrap(), "some api key");
        assert_eq!(response.headers().get("x-req-id").unwrap(), "some req id");
    }
}