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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

use std::borrow::Cow;

use crate::Endpoint;
use crate::api::domains::DomainDetails;
use serde::Serialize;
use typed_builder::TypedBuilder;

/// Create a new domain.
///
/// ```
/// use postmark::api::domains::CreateDomainRequest;
/// let req = CreateDomainRequest::builder()
///   .name("example.com")
///   .return_path_domain("pm-bounces.example.com")
///   .build();
/// ```
#[derive(Debug, Clone, PartialEq, Serialize)]
#[serde(rename_all = "PascalCase")]
#[derive(TypedBuilder)]
pub struct CreateDomainRequest {
    /// Domain name to register.
    #[builder(setter(into))]
    pub name: String,
    /// Optional custom Return-Path domain. Must be a subdomain of your From Email domain
    /// with a CNAME record pointing to `pm.mtasv.net`.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(into, strip_option))]
    pub return_path_domain: Option<String>,
}

impl Endpoint for CreateDomainRequest {
    type Request = CreateDomainRequest;
    type Response = DomainDetails;

    fn endpoint(&self) -> Cow<'static, str> {
        "/domains".into()
    }

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

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

    use crate::Query;
    use crate::reqwest::PostmarkClient;

    use super::*;

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

        server.expect(
            Expectation::matching(request::method_path("POST", "/domains")).respond_with(
                json_encoded(json!({
                    "Name": "newdomain.com",
                    "SPFVerified": false,
                    "SPFHost": "newdomain.com",
                    "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
                    "DKIMVerified": false,
                    "WeakDKIM": false,
                    "DKIMHost": "",
                    "DKIMTextValue": "",
                    "DKIMPendingHost": "20131031155228pm._domainkey.newdomain.com",
                    "DKIMPendingTextValue": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCFn...",
                    "DKIMRevokedHost": "",
                    "DKIMRevokedTextValue": "",
                    "SafeToRemoveRevokedKeyFromDNS": false,
                    "DKIMUpdateStatus": "Pending",
                    "ReturnPathDomain": "pm-bounces.newdomain.com",
                    "ReturnPathDomainVerified": false,
                    "ReturnPathDomainCNAMEValue": "pm.mtasv.net",
                    "ID": 36736
                })),
            ),
        );

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

        let req = CreateDomainRequest::builder()
            .name("newdomain.com")
            .return_path_domain("pm-bounces.newdomain.com")
            .build();

        assert_eq!(
            serde_json::to_value(&req).unwrap(),
            json!({
                "Name": "newdomain.com",
                "ReturnPathDomain": "pm-bounces.newdomain.com",
            })
        );

        let resp = req
            .execute(&client)
            .await
            .expect("Should get a response and be able to json decode it");

        assert_eq!(resp.name, "newdomain.com");
        assert_eq!(resp.id, 36736);
    }

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

        server.expect(
            Expectation::matching(request::method_path("POST", "/domains")).respond_with(
                json_encoded(json!({
                    "Name": "newdomain.com",
                    "SPFVerified": false,
                    "SPFHost": "newdomain.com",
                    "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
                    "DKIMVerified": false,
                    "WeakDKIM": false,
                    "DKIMHost": "",
                    "DKIMTextValue": "",
                    "DKIMPendingHost": "",
                    "DKIMPendingTextValue": "",
                    "DKIMRevokedHost": "",
                    "DKIMRevokedTextValue": "",
                    "SafeToRemoveRevokedKeyFromDNS": false,
                    "DKIMUpdateStatus": "Pending",
                    "ReturnPathDomain": "",
                    "ReturnPathDomainVerified": false,
                    "ReturnPathDomainCNAMEValue": "",
                    "ID": 36737
                })),
            ),
        );

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

        let req = CreateDomainRequest::builder().name("newdomain.com").build();

        assert_eq!(
            serde_json::to_value(&req).unwrap(),
            json!({
                "Name": "newdomain.com",
            })
        );

        req.execute(&client)
            .await
            .expect("Should get a response and be able to json decode it");
    }
}