block_kit 0.1.0

Simple wrapper for slack api
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

use crate::payload::message::CommonMessagePayload;
use serde::Serialize;

/// Reference.
/// https://api.slack.com/messaging/sending#publishing_your_message
/// https://api.slack.com/methods/chat.postMessage
///
/// # chat.postMessage api's payload.
/// `channel` and `payload` are required to be perform as expected.
///
/// Outmoded approaches are not supported;
/// https://api.slack.com/docs/message-formatting
/// https://api.slack.com/docs/message-attachments
#[derive(Debug, Serialize)]
pub struct ChatPostMessagePayload {
    channel: String,
    #[serde(flatten)]
    payload: CommonMessagePayload,
    #[serde(skip_serializing_if = "Option::is_none")]
    as_user: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    icon_emoji: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    icon_url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    username: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    reply_broadcast: Option<bool>,
}

impl ChatPostMessagePayload {
    /// Use this to generate instance.
    pub fn new(channel: impl Into<String>, payload: CommonMessagePayload) -> Self {
        ChatPostMessagePayload {
            channel: channel.into(),
            payload,
            as_user: Option::default(),
            icon_emoji: Option::default(),
            icon_url: Option::default(),
            username: Option::default(),
            reply_broadcast: Option::default(),
        }
    }

    pub fn as_user(mut self, as_user: bool) -> Self {
        self.as_user = Some(as_user);
        self
    }

    /// `emoji` has higher priority than url.
    /// This means, if both of emoji and url are set, emoji will display.
    ///
    /// Must be used in conjunction with `as_user` set to false, otherwise ignored.
    pub fn icon_emoji(mut self, icon_emoji: impl Into<String>) -> Self {
        self.icon_emoji = Some(icon_emoji.into());
        self
    }

    /// `url` has lower priority than url.
    /// This means, if both of emoji and url are set, url won't display.
    ///
    /// Must be used in conjunction with `as_user` set to false, otherwise ignored.
    pub fn icon_url(mut self, icon_url: impl Into<String>) -> Self {
        self.icon_url = Some(icon_url.into());
        self
    }

    /// Bot's username.
    ///
    /// Must be used in conjunction with `as_user` set to false, otherwise ignored.
    pub fn username(mut self, username: impl Into<String>) -> Self {
        self.username = Some(username.into());
        self
    }

    pub fn reply_broadcast(mut self, reply_broadcast: bool) -> Self {
        self.reply_broadcast = Some(reply_broadcast);
        self
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::block::section::SectionBlock;
    use crate::block::Block::Section;
    use crate::composition::text::PlainText;
    use crate::composition::text::Text::Plain;
    use crate::payload::message::CommonMessagePayload;

    #[test]
    fn test_ser_new() {
        let section = SectionBlock::new(Plain(PlainText::new("text")));
        let block = Section(section);
        let payload = CommonMessagePayload::new().blocks(vec![block]);
        let payload = ChatPostMessagePayload::new("channel", payload);
        let json = serde_json::to_string_pretty(&payload).unwrap();

        let expected = r#"{
  "channel": "channel",
  "blocks": [
    {
      "type": "section",
      "text": {
        "type": "plain_text",
        "text": "text"
      }
    }
  ]
}"#;
        assert_eq!(json, expected);
    }

    #[test]
    fn test_ser_all() {
        let section = SectionBlock::new(Plain(PlainText::new("text")));
        let block = Section(section);
        let payload = CommonMessagePayload::new().blocks(vec![block]);
        let payload = ChatPostMessagePayload::new("channel", payload)
            .as_user(false)
            .icon_emoji(":man:")
            .icon_url("url")
            .username("username")
            .reply_broadcast(false);
        let json = serde_json::to_string_pretty(&payload).unwrap();

        let expected = r#"{
  "channel": "channel",
  "blocks": [
    {
      "type": "section",
      "text": {
        "type": "plain_text",
        "text": "text"
      }
    }
  ],
  "as_user": false,
  "icon_emoji": ":man:",
  "icon_url": "url",
  "username": "username",
  "reply_broadcast": false
}"#;
        assert_eq!(json, expected);
    }
}