quokka-handler 0.3.0-beta.0

Handler helpers for Quokka
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::collections::HashMap;

use axum::{http::StatusCode, response::IntoResponse, Json};

///
/// A response object folling the [jsonapi format](https://jsonapi.org/format/).
///
/// # Note // TODO: Address these inconsistencies
///
/// This is mostly a scratch, relying in the [serde_json::Value] for certain scenarios
///
/// Also it does not restrict the [Self::data] variant (see <https://jsonapi.org/format/#document-top-level> for how it should look).
///
///
#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
pub struct JsonResponse<D = serde_json::Value, M = DefaultMeta> {
    #[serde(skip_serializing_if = "Option::is_none", default = "Option::default")]
    pub data: Option<D>,
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    pub errors: Vec<ErrorObject>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub meta: Option<M>,
    #[serde(skip, default)]
    pub status_code: u16,
}

pub type DefaultMeta = HashMap<String, serde_json::Value>;

#[derive(Clone, Debug, Default, serde::Deserialize, serde::Serialize)]
pub struct ErrorObject<M = serde_json::Value> {
    #[serde(skip_serializing_if = "String::is_empty", default)]
    pub id: String,
    #[serde(skip_serializing_if = "HashMap::is_empty", default)]
    pub links: HashMap<String, Link>,
    pub status: String,
    #[serde(skip_serializing_if = "String::is_empty", default)]
    pub title: String,
    #[serde(skip_serializing_if = "String::is_empty", default)]
    pub detail: String,
    pub source: Source,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub meta: Option<M>,
}

#[derive(Clone, Debug, Default, serde::Deserialize, serde::Serialize)]
pub struct Source {
    #[serde(skip_serializing_if = "String::is_empty", default)]
    pub pointer: String,
    #[serde(skip_serializing_if = "String::is_empty", default)]
    pub parameter: String,
    #[serde(skip_serializing_if = "String::is_empty", default)]
    pub header: String,
}

#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
pub enum Link<M = DefaultMeta> {
    String(String),
    Link {
        href: String,
        #[serde(skip_serializing_if = "String::is_empty", default)]
        rel: String,
        #[serde(skip_serializing_if = "String::is_empty", default)]
        title: String,
        #[serde(rename = "type")]
        typ: String,
        #[serde(skip_serializing_if = "String::is_empty", default)]
        hreflang: String,
        #[serde(skip_serializing_if = "Option::is_none", default)]
        meta: Option<M>,
    },
}

impl JsonResponse<(), serde_json::Value> {
    ///
    /// Responds with no data, but a "message" in the "meta" section
    ///
    pub fn no_data(message: impl ToString) -> Self {
        Self {
            status_code: 204,
            meta: Some(serde_json::json! {{
                "message": message.to_string(),
            }}),
            ..Default::default()
        }
    }
}

impl<D> JsonResponse<D> {
    pub fn data(data: D) -> Self {
        Self {
            status_code: 200,
            data: Some(data),
            ..Default::default()
        }
    }
}

impl<D: serde::Serialize, M: serde::Serialize> IntoResponse for JsonResponse<D, M> {
    fn into_response(self) -> axum::response::Response {
        let status = self.status_code;

        let mut response = Json(self).into_response();

        if status >= 100 {
            *response.status_mut() = StatusCode::from_u16(status).unwrap_or_default();
        }

        response
    }
}

impl<D, M> JsonResponse<D, M> {
    pub fn error(status: u16, title: impl ToString, detail: impl ToString) -> Self {
        let mut me = Self {
            status_code: status,
            meta: None,
            data: None,
            ..Default::default()
        };
        me.add_error(ErrorObject {
            status: status.to_string(),
            title: title.to_string(),
            detail: detail.to_string(),
            ..Default::default()
        });

        me
    }

    pub fn add_error(&mut self, error: ErrorObject) -> &mut Self {
        self.errors.push(error);

        self
    }
}

impl<D, M> Default for JsonResponse<D, M> {
    fn default() -> Self {
        Self {
            data: Default::default(),
            errors: Default::default(),
            meta: Default::default(),
            status_code: Default::default(),
        }
    }
}