lib/
config.rs

1//! -*- mode: rust; -*-
2//!
3//! This file is part of privatemail crate.
4//! Copyright (c) 2022 Nyah Check
5//! See LICENSE for licensing information.
6//!
7//! Authors:
8//! - Nyah Check <hello@nyah.dev>
9//! GPG signature verification.
10
11//! Configuration struct for `PrivatEmail`
12use serde::{Deserialize, Serialize};
13use std::env;
14
15/// Config object for `PrivatEmail`.
16///
17/// Implements [`serde::Deserialize`] and [`serde::Serialize`] and
18/// can be composed with other consumer configs.
19///  `PrivatEmailConfig`:
20///  `from_email`: Original Recipient Email from Verified SES Domain
21///  `to_email`: Recipient SES verified email address which receives the forwarded email
22///  `black_list`: Black listed email addresses.
23#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
24pub struct PrivatEmailConfig {
25    /// Original Recipient Email from Verified SES Domain
26    pub from_email: String,
27
28    /// Recipient email address that receives the forwarded SES email
29    pub to_email: String,
30
31    /// Black Listed email addresses
32    #[serde(skip_serializing_if = "Option::is_none")]
33    pub black_list: Option<Vec<String>>,
34}
35
36/// Default configuration for `PrivatEmailConfig`
37impl Default for PrivatEmailConfig {
38    fn default() -> Self {
39        PrivatEmailConfig {
40            from_email: String::from("hello@nyah.dev"),
41            to_email: String::from("nyah@hey.com"),
42            black_list: None,
43        }
44    }
45}
46
47/// Create a new `PrivatEmailConfig` client struct from environment variables.
48impl PrivatEmailConfig {
49    /// Create new PrivatEmailConfig struct from environment variables.
50    pub fn new_from_env() -> Self {
51        let b_list = env::var("BLACK_LIST").unwrap_or_default();
52        let black_list =
53            b_list.split(',').map(|x| x.replace(' ', "")).collect();
54
55        PrivatEmailConfig {
56            from_email: env::var("FROM_EMAIL")
57                .unwrap_or_else(|_e| panic!("Invalid FROM_EMAIL")),
58            to_email: env::var("TO_EMAIL")
59                .unwrap_or_else(|_e| panic!("Invalid TO_EMAIL")),
60            black_list: Some(black_list),
61        }
62    }
63
64    /// Create a new `PrivatEmailConfig` struct
65    pub fn new<F, T, B>(from_email: F, to_email: T, black_list: B) -> Self
66    where
67        F: ToString,
68        T: ToString,
69        B: ToString,
70    {
71        let b_list_vec = black_list.to_string();
72        let b_list: Vec<String> =
73            b_list_vec.split(',').map(|x| x.replace(' ', "")).collect();
74        PrivatEmailConfig {
75            from_email: from_email.to_string(),
76            to_email: to_email.to_string(),
77            black_list: Some(b_list),
78        }
79    }
80}
81
82/** Test module for PrivatEmailConfig struct */
83#[cfg(test)]
84mod tests {
85    use super::*;
86    use std::env;
87
88    #[test]
89    fn test_new_privatemail_config() {
90        let new_config = PrivatEmailConfig::new(
91            String::from("test_from"),
92            String::from("test_to"),
93            String::from("fake@email.t, second@fake.email"),
94        );
95        assert!(new_config.from_email.contains("test_from"));
96        assert!(new_config.to_email.contains("test_to"));
97        assert_eq!(
98            new_config.black_list.unwrap(),
99            ["fake@email.t", "second@fake.email"]
100        );
101    }
102    #[test]
103    fn test_default_privatemail_config() {
104        let new_config = PrivatEmailConfig::default();
105        assert!(new_config.from_email.contains("hello@nyah.dev"));
106        assert!(new_config.to_email.contains("nyah@hey.com"));
107        assert!(new_config.black_list.is_none());
108    }
109
110    #[test]
111    fn test_new_from_env_privatemail_config() {
112        env::set_var("FROM_EMAIL", "test_from");
113        env::set_var("TO_EMAIL", "test_to");
114
115        let new_config = PrivatEmailConfig::new_from_env();
116        assert!(new_config.from_email.contains("test_from"));
117        assert!(new_config.to_email.contains("test_to"));
118        assert_eq!(new_config.black_list.unwrap(), [""]);
119    }
120}