mycelium-http-tools 8.3.1-rc.2

Provide HTTP related elements to the mycelium project.
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

use actix_web::HttpResponse;
use serde::Serialize;
use std::fmt::{Display, Formatter, Result as FmtResult};
use utoipa::{ToResponse, ToSchema};

#[derive(Debug, Serialize, ToResponse, ToSchema)]
#[serde(rename_all = "camelCase")]
pub struct HttpJsonResponse {
    #[serde(skip_serializing_if = "Option::is_none")]
    msg: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    code: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    body: Option<String>,
}

impl HttpJsonResponse {
    pub fn new_message<T: ToString>(msg: T) -> Self {
        Self {
            msg: msg.to_string().into(),
            code: None,
            body: None,
        }
    }

    pub fn new_body<T: Serialize>(body: T) -> Result<Self, HttpResponse> {
        match serde_json::to_string(&body) {
            Err(err) => {
                let json_error = HttpJsonResponse::new_message(err.to_string());

                return Err(
                    HttpResponse::InternalServerError().json(json_error)
                );
            }
            Ok(body) => Ok(Self {
                msg: None,
                code: None,
                body: Some(body),
            }),
        }
    }

    pub fn new_vec_body<T: Serialize>(
        body: Vec<T>,
    ) -> Result<Self, HttpResponse> {
        match serde_json::to_string(&body) {
            Err(err) => {
                let json_error = HttpJsonResponse::new_message(err.to_string());

                return Err(
                    HttpResponse::InternalServerError().json(json_error)
                );
            }
            Ok(body) => Ok(Self {
                msg: None,
                code: None,
                body: Some(body),
            }),
        }
    }

    pub fn with_code<T: ToString>(&self, code: T) -> Self {
        Self {
            msg: self.msg.to_owned(),
            code: Some(code.to_string()),
            body: self.body.to_owned(),
        }
    }

    pub fn with_code_str(&self, code: &'static str) -> Self {
        Self {
            msg: self.msg.to_owned(),
            code: Some(code.to_string()),
            body: self.body.to_owned(),
        }
    }

    pub fn with_body(&self, body: String) -> Self {
        Self {
            msg: self.msg.to_owned(),
            code: self.code.to_owned(),
            body: Some(body),
        }
    }

    pub fn with_serializable_body<T: Serialize>(
        &self,
        body: T,
    ) -> Result<Self, HttpResponse> {
        match serde_json::to_string(&body) {
            Err(err) => {
                let json_error = HttpJsonResponse::new_message(err.to_string());

                return Err(
                    HttpResponse::InternalServerError().json(json_error)
                );
            }
            Ok(body) => Ok(Self {
                msg: self.msg.to_owned(),
                code: self.code.to_owned(),
                body: Some(body),
            }),
        }
    }
}

impl Display for HttpJsonResponse {
    fn fmt(&self, f: &mut Formatter) -> FmtResult {
        let msg = self.msg.to_owned().unwrap_or("no message".to_string());

        if self.code.is_some() {
            return write!(f, "{}: {}", self.code.as_ref().unwrap(), msg);
        }

        write!(f, "{}", msg)
    }
}

// * ---------------------------------------------------------------------------
// * TESTS
// * ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    fn test_json_error() {
        let json_error = HttpJsonResponse::new_message("test".to_string());
        assert_eq!(json_error.msg, Some("test".to_string()));
        assert_eq!(json_error.code, None);
    }

    #[test]
    fn test_json_error_code() {
        let json_error = HttpJsonResponse::new_message("test".to_string())
            .with_code_str("code");
        assert_eq!(json_error.msg, Some("test".to_string()));
        assert_eq!(json_error.code, Some("code".to_string()));
    }

    #[test]
    fn test_json_error_display() {
        let json_error = HttpJsonResponse::new_message("test".to_string());
        assert_eq!(format!("{}", json_error), "test");

        let json_error = HttpJsonResponse::new_message("test".to_string())
            .with_code_str("code");
        assert_eq!(format!("{}", json_error), "code: test");
    }
}