north 0.1.4

North Microservice Framework
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

use std::net::AddrParseError;
use futures::task::SpawnError;

#[derive(Debug, derive_more::Display, PartialEq, Eq)]
#[allow(dead_code)]
pub enum Error {
    BadRequest(String),
    BlockingError(String),
    CacheError(String),
    CannotDecodeJwtToken(String),
    CannotEncodeJwtToken(String),
    InternalServerError(String),
    NotFound(String),
    Conflict(String),
    RequestTimeout(String),
    Gone(String),
    PaymentRequired(String),
    PayloadTooLarge(String),
    TooManyRequests(String),
    DatabaseError(String),
    ParseError(String),
    PoolError(String),
    #[display(fmt = "")]
    ValidationError(Vec<String>),
    Unauthorized(String),
}

/// User-friendly error messages
#[derive(Debug, Deserialize, Serialize)]
pub struct ErrorResponse {
    errors: Vec<String>,
}

/// Automatically convert NorthErrors to external Response Errors
#[cfg(feature = "api-actix")]
impl ResponseError for Error {
    fn status_code(&self) -> StatusCode {
        match self {
            Error::BadRequest(_error) => StatusCode::BAD_REQUEST,
            Error::NotFound(_message) => StatusCode::NOT_FOUND,
            Error::ValidationError(_errors) => StatusCode::UNPROCESSABLE_ENTITY,
            Error::Unauthorized(_error) => StatusCode::UNAUTHORIZED,
            Error::Conflict(_message) => StatusCode::CONFLICT,
            Error::Gone(_errors) => StatusCode::GONE,
            Error::PaymentRequired(_error) => StatusCode::PAYMENT_REQUIRED,
            Error::PayloadTooLarge(_error) => StatusCode::PAYLOAD_TOO_LARGE,
            Error::TooManyRequests(_error) => StatusCode::TOO_MANY_REQUESTS,
            _ => StatusCode::INTERNAL_SERVER_ERROR,
        }
    }

    fn error_response(&self) -> HttpResponse {
        match self {
            Error::BadRequest(error) => {
                HttpResponseBuilder::new(self.status_code()).body::<String>(error.into())
                // HttpResponse::BadRequest().json(error.into())
            }
            Error::NotFound(message) => {
                HttpResponseBuilder::new(self.status_code()).body::<String>(message.into())
                // HttpResponse::NotFound().json(message.into())
            }
            Error::ValidationError(errors) => {
                HttpResponseBuilder::new(self.status_code()).json(errors.to_vec())
                // HttpResponse::UnprocessableEntity().json(errors.to_vec().into())
            }
            Error::Unauthorized(error) => {
                HttpResponseBuilder::new(self.status_code()).body::<String>(error.into())
            }
            Error::Conflict(message) => {
                HttpResponseBuilder::new(self.status_code()).body::<String>(message.into())
                // HttpResponse::Conflict().json(message.into())
            }
            Error::Gone(errors) => {
                HttpResponseBuilder::new(self.status_code()).body::<String>(errors.into())
                // HttpResponse::Gone().json(errors.into())
            }
            Error::PaymentRequired(error) => {
                HttpResponseBuilder::new(self.status_code()).body::<String>(error.into())
                // HttpResponse::PaymentRequired().json(error.into())
            }
            Error::PayloadTooLarge(error) => {
                HttpResponseBuilder::new(self.status_code()).body::<String>(error.into())
                // HttpResponse::PayloadTooLarge().json(error.into())
            }
            Error::TooManyRequests(error) => {
                HttpResponseBuilder::new(self.status_code()).body::<String>(error.into())
                // HttpResponse::TooManyRequests().json(error.into())
            }
            Error::DatabaseError(error) => {
                HttpResponseBuilder::new(self.status_code()).body::<String>(error.into())
                // HttpResponse::TooManyRequests().json(error.into())
            }
            _ => HttpResponse::new(StatusCode::INTERNAL_SERVER_ERROR),
        }
    }
}

/// Utility to make transforming a string reference into an ErrorResponse
impl From<&String> for ErrorResponse {
    fn from(error: &String) -> Self {
        ErrorResponse {
            errors: vec![error.into()],
        }
    }
}

/// Utility to make transforming a vector of strings into an ErrorResponse
impl From<Vec<String>> for ErrorResponse {
    fn from(errors: Vec<String>) -> Self {
        ErrorResponse { errors }
    }
}

/// Convert PoolErrors to NorthErrors
// impl From<PoolError> for NorthError {
//     fn from(error: PoolError) -> NorthError {
//         NorthError::PoolError(error.to_string())
//     }
// }

/// Convert std::io::Error to NorthErrors
impl From<std::io::Error> for Error {
    fn from(error: std::io::Error) -> Error {
        Error::InternalServerError(error.to_string())
    }
}

/// Convert serde_yaml::Error to NorthErrors
impl From<serde_yaml::Error> for Error {
    fn from(error: serde_yaml::Error) -> Error {
        Error::InternalServerError(error.to_string())
    }
}

/// Convert SpawnError to NorthErrors
impl From<SpawnError> for Error {
    fn from(error: SpawnError) -> Error {
        Error::InternalServerError(error.to_string())
    }
}
/// Convert AddrParseError to NorthErrors
impl From<AddrParseError> for Error {
    fn from(error: AddrParseError) -> Error {
        Error::InternalServerError(error.to_string())
    }
}