wechat-oa-sdk 1.0.5

WeChat Official Account API SDK for Rust
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
147
148
149

use serde::Deserialize;

/// Subscribe/Unsubscribe event.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct SubscribeEvent {
    pub to_user_name: String,
    pub from_user_name: String,
    pub create_time: i64,
    /// Event type (subscribe/unsubscribe)
    pub event: String,
    /// Event key (QR code scene value for scan subscribe)
    pub event_key: Option<String>,
    /// QR code ticket (for scan subscribe)
    pub ticket: Option<String>,
}

/// QR code scan event (user already subscribed).
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct ScanEvent {
    pub to_user_name: String,
    pub from_user_name: String,
    pub create_time: i64,
    pub event: String,
    /// Scene value from QR code
    pub event_key: String,
    /// QR code ticket
    pub ticket: String,
}

/// Location report event.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct LocationEvent {
    pub to_user_name: String,
    pub from_user_name: String,
    pub create_time: i64,
    pub event: String,
    /// Latitude
    pub latitude: f64,
    /// Longitude
    pub longitude: f64,
    /// Precision
    pub precision: f64,
}

/// Menu click event (CLICK type).
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct MenuClickEvent {
    pub to_user_name: String,
    pub from_user_name: String,
    pub create_time: i64,
    pub event: String,
    /// Custom menu key value
    pub event_key: String,
}

/// Menu view event (VIEW type - user clicks menu link).
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct MenuViewEvent {
    pub to_user_name: String,
    pub from_user_name: String,
    pub create_time: i64,
    pub event: String,
    /// URL that was clicked
    pub event_key: String,
}

/// Template message send job finish event.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct TemplateSendJobFinishEvent {
    pub to_user_name: String,
    pub from_user_name: String,
    pub create_time: i64,
    pub event: String,
    /// Message ID
    #[serde(rename = "MsgID")]
    pub msg_id: i64,
    /// Status: "success", "failed:user block", "failed: system failed"
    pub status: String,
}

/// Helper to peek at event type.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub(crate) struct EventTypePeek {
    pub event: String,
}

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

    #[test]
    fn test_parse_subscribe_event() {
        let xml = r#"<xml>
<ToUserName><![CDATA[gh_test]]></ToUserName>
<FromUserName><![CDATA[oUser123]]></FromUserName>
<CreateTime>1348831860</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[subscribe]]></Event>
</xml>"#;

        let event: SubscribeEvent = from_str(xml).unwrap();
        assert_eq!(event.to_user_name, "gh_test");
        assert_eq!(event.from_user_name, "oUser123");
        assert_eq!(event.event, "subscribe");
        assert!(event.event_key.is_none());
    }

    #[test]
    fn test_parse_menu_click_event() {
        let xml = r#"<xml>
<ToUserName><![CDATA[gh_test]]></ToUserName>
<FromUserName><![CDATA[oUser123]]></FromUserName>
<CreateTime>1348831860</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[CLICK]]></Event>
<EventKey><![CDATA[menu_key_1]]></EventKey>
</xml>"#;

        let event: MenuClickEvent = from_str(xml).unwrap();
        assert_eq!(event.event, "CLICK");
        assert_eq!(event.event_key, "menu_key_1");
    }

    #[test]
    fn test_parse_location_event() {
        let xml = r#"<xml>
<ToUserName><![CDATA[gh_test]]></ToUserName>
<FromUserName><![CDATA[oUser123]]></FromUserName>
<CreateTime>1348831860</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[LOCATION]]></Event>
<Latitude>23.137466</Latitude>
<Longitude>113.352425</Longitude>
<Precision>119.385040</Precision>
</xml>"#;

        let event: LocationEvent = from_str(xml).unwrap();
        assert!((event.latitude - 23.137466).abs() < 0.0001);
        assert!((event.longitude - 113.352425).abs() < 0.0001);
    }
}