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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
//! Error Response of all the public api interfaces

use serde::{Deserialize, Serialize};

/// ErrorCode for all the public interfaces
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub enum ErrorCode {
    /// 500 InternalServerError
    DatabaseErr,
    /// 401 Unauthorized
    AuthTokenMissing,
    /// 401 Unauthorized
    AuthTokenInvalid,
    /// 404 NotFound
    BurrowNotExist,
    /// 403 Forbidden
    BurrowNumLimit,
    /// 403 Forbidden
    BurrowInvalid,
    /// 404 NotFound
    PostNotExist,
    /// 404 NotFound
    ReplyNotExist,
    /// 400 BadRequest
    EmailInvalid,
    /// 400 BadRequest
    EmailDuplicate,
    /// 400 BadRequest
    UsernameDuplicate,
    /// 429 TooManyRequests
    RateLimit,
    /// 403 Forbidden
    UserForbidden,
    ///400 BadRequest
    UserNotExist,
    /// 400 BadRequest
    EmptyField,
    /// 400 BadRequest
    SectionInvalid,
    /// 400 BadRequest
    CredentialInvalid,
    /// 415 UnsupportedMediaType
    UnsupportedMediaType,
    /// 404 NotFound
    FileNotExist,
    /// 500 InternalServerError
    Unknown,
    None,
}

/// Body of ErrorResponse
///
/// ## Fields
///
/// - `code`: ErrorCode, the summary of the error
/// - `message`: String, the detail of the error
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct ErrorMessage {
    pub code: ErrorCode,
    pub message: String,
}

/// Error Response for all the public interfaces
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct ErrorResponse {
    pub error: ErrorMessage,
}

impl ErrorResponse {
    /// Default ErrorResponse
    ///
    /// Returns the DatabaseErr, which is the mostly used case.
    pub fn new() -> Self {
        ErrorResponse {
            error: ErrorMessage {
                code: ErrorCode::DatabaseErr,
                message: String::from(""),
            },
        }
    }

    /// ErrorResponse with ErrorCode and Message
    pub fn build<T: Into<String>>(code: ErrorCode, message: T) -> Self {
        ErrorResponse {
            error: ErrorMessage {
                code,
                message: message.into(),
            },
        }
    }
}

impl Default for ErrorResponse {
    fn default() -> Self {
        Self::new()
    }
}

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

    #[test]
    fn test_default_error() {
        let error = ErrorResponse::new();
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::DatabaseErr,
                    message: String::from(""),
                },
            }
        );
        let error = ErrorResponse::default();
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::DatabaseErr,
                    message: String::from(""),
                },
            }
        );
    }

    #[test]
    fn test_all_kind_error() {
        let error = ErrorResponse::build(ErrorCode::AuthTokenMissing, "AuthTokenMissing");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::AuthTokenMissing,
                    message: String::from("AuthTokenMissing"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::AuthTokenInvalid, "AuthTokenInvalid");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::AuthTokenInvalid,
                    message: String::from("AuthTokenInvalid"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::BurrowNotExist, "BurrowNotExist");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::BurrowNotExist,
                    message: String::from("BurrowNotExist"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::BurrowNumLimit, "BurrowNumLimit");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::BurrowNumLimit,
                    message: String::from("BurrowNumLimit"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::BurrowInvalid, "BurrowInvalid");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::BurrowInvalid,
                    message: String::from("BurrowInvalid"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::PostNotExist, "PostNotExist");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::PostNotExist,
                    message: String::from("PostNotExist"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::ReplyNotExist, "ReplyNotExist");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::ReplyNotExist,
                    message: String::from("ReplyNotExist"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::EmailInvalid, "EmailInvalid");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::EmailInvalid,
                    message: String::from("EmailInvalid"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::EmailDuplicate, "EmailDuplicate");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::EmailDuplicate,
                    message: String::from("EmailDuplicate"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::UsernameDuplicate, "UsernameDuplicate");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::UsernameDuplicate,
                    message: String::from("UsernameDuplicate"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::RateLimit, "RateLimit");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::RateLimit,
                    message: String::from("RateLimit"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::UserForbidden, "UserForbidden");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::UserForbidden,
                    message: String::from("UserForbidden"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::UserNotExist, "UserNotExist");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::UserNotExist,
                    message: String::from("UserNotExist"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::EmptyField, "EmptyField");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::EmptyField,
                    message: String::from("EmptyField"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::SectionInvalid, "SectionInvalid");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::SectionInvalid,
                    message: String::from("SectionInvalid"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::CredentialInvalid, "CredentialInvalid");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::CredentialInvalid,
                    message: String::from("CredentialInvalid"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::UnsupportedMediaType, "UnsupportedMediaType");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::UnsupportedMediaType,
                    message: String::from("UnsupportedMediaType"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::FileNotExist, "FileNotExist");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::FileNotExist,
                    message: String::from("FileNotExist"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::Unknown, "Unknown");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::Unknown,
                    message: String::from("Unknown"),
                },
            }
        );
        let error = ErrorResponse::build(ErrorCode::None, "");
        assert_eq!(
            error,
            ErrorResponse {
                error: ErrorMessage {
                    code: ErrorCode::None,
                    message: String::from(""),
                },
            }
        );
    }
}