ferro-notifications 0.2.11

Multi-channel notification system for Ferro framework
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

//! Core notification trait.

use crate::channel::Channel;
use crate::channels::{DatabaseMessage, MailMessage, SlackMessage};

/// A notification that can be sent through multiple channels.
///
/// Notifications encapsulate a message that should be delivered to users
/// through one or more channels (mail, database, slack, etc.).
///
/// # Example
///
/// ```rust
/// use ferro_notifications::{Notification, Channel, MailMessage, DatabaseMessage};
///
/// struct OrderShipped {
///     order_id: i64,
///     tracking_number: String,
/// }
///
/// impl Notification for OrderShipped {
///     fn via(&self) -> Vec<Channel> {
///         vec![Channel::Mail, Channel::Database]
///     }
///
///     fn to_mail(&self) -> Option<MailMessage> {
///         Some(MailMessage::new()
///             .subject("Your order has shipped!")
///             .body(format!("Tracking: {}", self.tracking_number)))
///     }
///
///     fn to_database(&self) -> Option<DatabaseMessage> {
///         Some(DatabaseMessage::new("order_shipped")
///             .data("order_id", self.order_id)
///             .data("tracking", &self.tracking_number))
///     }
/// }
/// ```
pub trait Notification: Send + Sync {
    /// The channels this notification should be sent through.
    fn via(&self) -> Vec<Channel>;

    /// Convert the notification to a mail message.
    fn to_mail(&self) -> Option<MailMessage> {
        None
    }

    /// Convert the notification to a database message.
    fn to_database(&self) -> Option<DatabaseMessage> {
        None
    }

    /// Convert the notification to a Slack message.
    fn to_slack(&self) -> Option<SlackMessage> {
        None
    }

    /// Get the notification type name for logging.
    fn notification_type(&self) -> &'static str {
        std::any::type_name::<Self>()
    }
}

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

    struct TestNotification;

    impl Notification for TestNotification {
        fn via(&self) -> Vec<Channel> {
            vec![Channel::Mail, Channel::Database]
        }

        fn to_mail(&self) -> Option<MailMessage> {
            Some(MailMessage::new().subject("Test").body("Test body"))
        }
    }

    #[test]
    fn test_notification_via() {
        let notification = TestNotification;
        let channels = notification.via();
        assert_eq!(channels.len(), 2);
        assert!(channels.contains(&Channel::Mail));
        assert!(channels.contains(&Channel::Database));
    }

    #[test]
    fn test_notification_to_mail() {
        let notification = TestNotification;
        let mail = notification.to_mail();
        assert!(mail.is_some());
        let mail = mail.unwrap();
        assert_eq!(mail.subject, "Test");
    }

    #[test]
    fn test_notification_to_database_default() {
        let notification = TestNotification;
        assert!(notification.to_database().is_none());
    }
}