postmark 2.0.1

Postmark rust client
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

use std::borrow::Cow;

use serde::{Deserialize, Serialize};
use typed_builder::TypedBuilder;
use url::form_urlencoded::Serializer;

use crate::Endpoint;
use crate::api::endpoint_with_query;
use crate::api::messages::MessageClick;

#[derive(Debug, Clone, PartialEq, Serialize, TypedBuilder)]
#[builder(field_defaults(default, setter(strip_option)))]
#[serde(rename_all = "PascalCase")]
pub struct MessageClicksRequest {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub count: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub offset: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub recipient: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub message_stream: Option<String>,
}

impl Default for MessageClicksRequest {
    fn default() -> Self {
        Self::builder().build()
    }
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct MessageClicksResponse {
    pub total_count: i64,
    pub clicks: Vec<MessageClick>,
}

impl Endpoint for MessageClicksRequest {
    type Request = MessageClicksRequest;
    type Response = MessageClicksResponse;

    fn endpoint(&self) -> Cow<'static, str> {
        let mut serializer = Serializer::new(String::new());

        if let Some(count) = self.count {
            serializer.append_pair("count", &count.to_string());
        }
        if let Some(offset) = self.offset {
            serializer.append_pair("offset", &offset.to_string());
        }
        if let Some(ref recipient) = self.recipient {
            serializer.append_pair("recipient", recipient);
        }
        if let Some(ref tag) = self.tag {
            serializer.append_pair("tag", tag);
        }
        if let Some(ref message_stream) = self.message_stream {
            serializer.append_pair("messagestream", message_stream);
        }

        endpoint_with_query("/messages/outbound/clicks", serializer.finish())
    }

    fn body(&self) -> &Self::Request {
        self
    }

    fn method(&self) -> http::Method {
        http::Method::GET
    }
}

#[cfg(test)]
mod tests {
    use httptest::matchers::request;
    use httptest::{Expectation, Server, responders::*};
    use serde_json::json;

    use super::*;
    use crate::Query;
    use crate::reqwest::PostmarkClient;

    #[tokio::test]
    async fn message_clicks_gets_events() {
        let server = Server::run();

        server.expect(
            Expectation::matching(request::method_path("GET", "/messages/outbound/clicks"))
                .respond_with(json_encoded(json!({
                    "TotalCount": 1,
                    "Clicks": [
                        {
                            "MessageID": "out-msg-1",
                            "OriginalLink": "https://example.com"
                        }
                    ]
                }))),
        );

        let client = PostmarkClient::builder()
            .base_url(server.url("/").to_string())
            .build();
        let req = MessageClicksRequest::default();

        let resp = req
            .execute(&client)
            .await
            .expect("Should decode message clicks");

        assert_eq!(resp.total_count, 1);
        assert_eq!(resp.clicks[0].message_id, "out-msg-1");
    }

    #[test]
    fn message_clicks_encodes_query_params() {
        let req = MessageClicksRequest::builder()
            .count(10)
            .offset(20)
            .recipient("user@example.com".to_string())
            .tag("welcome".to_string())
            .message_stream("outbound".to_string())
            .build();

        let endpoint = req.endpoint();
        let endpoint = endpoint.as_ref();

        assert!(endpoint.starts_with("/messages/outbound/clicks?"));
        assert!(endpoint.contains("count=10"));
        assert!(endpoint.contains("offset=20"));
        assert!(endpoint.contains("recipient=user%40example.com"));
        assert!(endpoint.contains("tag=welcome"));
        assert!(endpoint.contains("messagestream=outbound"));
    }
}