fandwill-vo 0.5.0

Serde, garde, and utoipa value objects for the Fandwill platform API.
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[cfg_attr(feature = "garde", derive(garde::Validate))]
#[serde(deny_unknown_fields)]
pub struct SignUpVO {
    #[cfg_attr(feature = "garde", garde(email))]
    #[cfg_attr(feature = "utoipa", schema(example = "user@example.com"))]
    pub email: String,

    #[cfg_attr(feature = "garde", garde(length(min = 8)))]
    #[cfg_attr(feature = "utoipa", schema(example = "password123"))]
    pub password: String,

    #[cfg_attr(feature = "garde", garde(skip))]
    #[cfg_attr(feature = "utoipa", schema(example = "TestUser"))]
    pub nickname: Option<String>,
}

#[derive(Debug, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct SignUpResponseVO {
    pub iam_id: String,
}

#[derive(Debug, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[cfg_attr(feature = "garde", derive(garde::Validate))]
#[serde(untagged, deny_unknown_fields)]
pub enum SignInVO {
    Email {
        #[cfg_attr(feature = "garde", garde(email))]
        #[cfg_attr(feature = "utoipa", schema(example = "user@example.com"))]
        email: String,

        #[cfg_attr(feature = "garde", garde(length(min = 8)))]
        #[cfg_attr(feature = "utoipa", schema(example = "password123"))]
        password: String,
    },
    Phone {
        #[cfg_attr(feature = "garde", garde(phone_number))]
        #[cfg_attr(feature = "utoipa", schema(example = "+861380000000"))]
        phone: String,

        #[cfg_attr(feature = "garde", garde(length(min = 8)))]
        #[cfg_attr(feature = "utoipa", schema(example = "password123"))]
        password: String,
    },
}

#[derive(Debug, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct SignInResponseVO {
    pub token: String,
}

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

    #[test]
    fn response_types_tolerate_flattened_api_metadata() {
        let sign_up: SignUpResponseVO = serde_json::from_value(serde_json::json!({
            "iam_id": "iam-user",
            "code": 200,
            "msg": null
        }))
        .unwrap();
        assert_eq!(sign_up.iam_id, "iam-user");

        let sign_in: SignInResponseVO = serde_json::from_value(serde_json::json!({
            "token": "jwt",
            "code": 200,
            "msg": "ok"
        }))
        .unwrap();
        assert_eq!(sign_in.token, "jwt");
    }
}