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

#![allow(dead_code)]

#[cfg(feature = "api-poem")]
use poem::web::Json as PoemJson;
#[cfg(feature = "api-poem")]
use poem_openapi::{
    payload::{Json, PlainText},
    types::{ParseFromJSON, ToJSON},
    ApiRequest, ApiResponse,
};

use serde::Serialize;

use crate::utils::server_utils::NorthResult;

/// Helper function to reduce boilerplate of an OK/Json response
#[cfg(feature = "api-actix")]
pub fn respond_json<T>(data: T) -> NorthResult<Json<T>>
where
    T: Serialize,
{
    Ok(Json(data))
}

#[cfg(feature = "api-poem")]
pub fn respond_json<T>(data: T) -> NorthResult<PoemJson<T>>
where
    T: Serialize,
{
    Ok(PoemJson(data))
}

/// Helper function to reduce boilerplate of an empty OK response
#[cfg(feature = "api-actix")]
pub fn respond_ok() -> NorthResult<HttpResponse> {
    Ok(HttpResponseBuilder::new(StatusCode::OK).body::<String>("".to_string()))
}

/// ## RequestObject
/// Generic helper enum for wrapping API request dto objects
#[cfg(feature = "api-poem")]
#[derive(ApiRequest)]
pub enum RequestObject<T: Send + ToJSON + ParseFromJSON> {
    #[oai()]
    Input(Json<T>),
}

/// ## ResponseObject
/// Helper enum for wrapping API response dto objects
#[cfg(feature = "api-poem")]
#[derive(ApiResponse)]
pub enum ResponseObject<T: Send + ToJSON> {
    #[oai(status = 200)]
    Ok(Json<T>),

    #[oai(status = 202)]
    Accepted(Json<T>),

    #[oai(status = 201)]
    Created(Json<T>),

    #[oai(status = 404)]
    NotFound(PlainText<String>),

    #[oai(status = 401)]
    Unauthorized(PlainText<String>),

    #[oai(status = 402)]
    PaymentRequired(PlainText<String>),

    #[oai(status = 403)]
    Forbidden(PlainText<String>),

    #[oai(status = 405)]
    MethodNotAllowed(PlainText<String>),

    #[oai(status = 406)]
    NotAcceptable(PlainText<String>),

    #[oai(status = 407)]
    ProxyAuthenticationRequired(PlainText<String>),

    #[oai(status = 408)]
    RequestTimeout(PlainText<String>),

    #[oai(status = 409)]
    Conflict(PlainText<String>),

    #[oai(status = 410)]
    Gone(PlainText<String>),

    #[oai(status = 411)]
    LengthRequired(PlainText<String>),

    #[oai(status = 412)]
    PreconditionFailed(PlainText<String>),

    #[oai(status = 413)]
    PayloadTooLarge(PlainText<String>),

    #[oai(status = 414)]
    URITooLong(PlainText<String>),

    #[oai(status = 415)]
    UnsupportedMediaType(PlainText<String>),

    #[oai(status = 422)]
    UnprocessableEntity(PlainText<String>),

    #[oai(status = 429)]
    TooManyRequests(PlainText<String>),

    #[oai(status = 431)]
    RequestHeaderFieldsTooLarge(PlainText<String>),

    #[oai(status = 451)]
    UnavailableForLegalReasons(PlainText<String>),
}

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

    #[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
    pub struct TestResponse {
        pub first_name: String,
    }

    #[cfg(feature = "api-poem")]
    #[test]
    fn it_responds_json() {
        let response = TestResponse {
            first_name: "satoshi".into(),
        };
        let result = respond_json(response.clone());
        assert!(result.is_ok());
        assert_eq!(result.unwrap().first_name, response.first_name);
    }

    #[cfg(feature = "api-actix")]
    #[test]
    fn it_responds_ok() {
        let result = respond_ok();
        assert!(result.is_ok());
    }
}