payrail 0.1.5

Provider-neutral Rust payments facade for Stripe, PayPal, and Mobile Money
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

use crate::{CountryCode, PhoneNumber};

/// Optional customer details attached to a payment request.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct Customer {
    email: Option<String>,
    phone: Option<PhoneNumber>,
    country: Option<CountryCode>,
    name: Option<String>,
}

impl Customer {
    /// Creates an empty customer.
    #[inline]
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Sets the email address.
    #[must_use]
    pub fn with_email(mut self, email: impl Into<String>) -> Self {
        self.email = Some(email.into());
        self
    }

    /// Sets the phone number.
    #[must_use]
    pub fn with_phone(mut self, phone: PhoneNumber) -> Self {
        self.phone = Some(phone);
        self
    }

    /// Sets the country.
    #[must_use]
    pub fn with_country(mut self, country: CountryCode) -> Self {
        self.country = Some(country);
        self
    }

    /// Sets the customer name.
    #[must_use]
    pub fn with_name(mut self, name: impl Into<String>) -> Self {
        self.name = Some(name.into());
        self
    }

    /// Returns the email address.
    #[inline]
    #[must_use]
    pub fn email(&self) -> Option<&str> {
        self.email.as_deref()
    }

    /// Returns the phone number.
    #[inline]
    #[must_use]
    pub const fn phone(&self) -> Option<&PhoneNumber> {
        self.phone.as_ref()
    }

    /// Returns the country.
    #[inline]
    #[must_use]
    pub const fn country(&self) -> Option<&CountryCode> {
        self.country.as_ref()
    }

    /// Returns the customer name.
    #[inline]
    #[must_use]
    pub fn name(&self) -> Option<&str> {
        self.name.as_deref()
    }
}

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

    #[test]
    fn builder_methods_set_customer_fields() {
        let phone = PhoneNumber::new("260971234567").expect("phone should be valid");
        let country = CountryCode::new("ZM").expect("country should be valid");

        let customer = Customer::new()
            .with_email("customer@example.com")
            .with_phone(phone)
            .with_country(country)
            .with_name("Ada Buyer");

        assert_eq!(customer.email(), Some("customer@example.com"));
        assert_eq!(
            customer.phone().expect("phone should be present").as_e164(),
            "+260971234567"
        );
        assert_eq!(
            customer
                .country()
                .expect("country should be present")
                .as_str(),
            "ZM"
        );
        assert_eq!(customer.name(), Some("Ada Buyer"));
    }
}