slack-messaging 0.7.3

Support building Slack Block Kit message
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
157
158

use crate::composition_objects::types::InputParameter;
use crate::validators::required;

use serde::Serialize;
use slack_messaging_derive::Builder;

/// [Trigger object](https://docs.slack.dev/reference/block-kit/composition-objects/trigger-object)
/// representation.
///
/// # Fields and Validations
///
/// For more details, see the [official
/// documentation](https://docs.slack.dev/reference/block-kit/composition-objects/trigger-object).
///
/// | Field | Type | Required | Validation |
/// |-------|------|----------|------------|
/// | url | String | Yes | N/A |
/// | customizable_input_parameters | Vec<[InputParameter]> | No | N/A |
///
/// # Example
///
/// ```
/// use slack_messaging::composition_objects::{types::InputParameter, Trigger};
/// # use std::error::Error;
///
/// # fn try_main() -> Result<(), Box<dyn Error>> {
/// let trigger = Trigger::builder()
///     .url("https://slack.com/shortcuts/Ft0123ABC456/123...xyz")
///     .customizable_input_parameter(
///         InputParameter::builder()
///             .name("input_parameter_a")
///             .value("Value for input param A")
///             .build()?
///     )
///     .customizable_input_parameter(
///         InputParameter::builder()
///             .name("input_parameter_b")
///             .value("Value for input param B")
///             .build()?
///     )
///     .build()?;
///
/// let expected = serde_json::json!({
///     "url": "https://slack.com/shortcuts/Ft0123ABC456/123...xyz",
///     "customizable_input_parameters": [
///         {
///             "name": "input_parameter_a",
///             "value": "Value for input param A"
///         },
///         {
///             "name": "input_parameter_b",
///             "value": "Value for input param B"
///         }
///     ]
/// });
///
/// let json = serde_json::to_value(trigger).unwrap();
///
/// assert_eq!(json, expected);
///
/// // If your object has any validation errors, the build method returns Result::Err
/// let trigger = Trigger::builder()
///     .customizable_input_parameter(
///         InputParameter::builder()
///             .name("input_parameter_a")
///             .value("Value for input param A")
///             .build()?
///     )
///     .build();
///
/// assert!(trigger.is_err());
/// #     Ok(())
/// # }
/// # fn main() {
/// #     try_main().unwrap()
/// # }
/// ```
#[derive(Debug, Clone, Serialize, PartialEq, Builder)]
pub struct Trigger {
    #[builder(validate("required"))]
    pub(crate) url: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(push_item = "customizable_input_parameter")]
    pub(crate) customizable_input_parameters: Option<Vec<InputParameter>>,
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::composition_objects::test_helpers::*;
    use crate::errors::*;

    #[test]
    fn it_implements_builder() {
        let expected = Trigger {
            url: Some("https://slack.com/shortcuts/Ft0123ABC456/123...xyz".into()),
            customizable_input_parameters: Some(vec![
                input_param("param_0", "value_0"),
                input_param("param_1", "value_1"),
            ]),
        };

        let val = Trigger::builder()
            .set_url(Some("https://slack.com/shortcuts/Ft0123ABC456/123...xyz"))
            .set_customizable_input_parameters(Some(vec![
                input_param("param_0", "value_0"),
                input_param("param_1", "value_1"),
            ]))
            .build()
            .unwrap();

        assert_eq!(val, expected);

        let val = Trigger::builder()
            .url("https://slack.com/shortcuts/Ft0123ABC456/123...xyz")
            .customizable_input_parameters(vec![
                input_param("param_0", "value_0"),
                input_param("param_1", "value_1"),
            ])
            .build()
            .unwrap();

        assert_eq!(val, expected);
    }

    #[test]
    fn it_implements_push_item_method() {
        let expected = Trigger {
            url: Some("https://slack.com/shortcuts/Ft0123ABC456/123...xyz".into()),
            customizable_input_parameters: Some(vec![
                input_param("param_0", "value_0"),
                input_param("param_1", "value_1"),
            ]),
        };

        let val = Trigger::builder()
            .url("https://slack.com/shortcuts/Ft0123ABC456/123...xyz")
            .customizable_input_parameter(input_param("param_0", "value_0"))
            .customizable_input_parameter(input_param("param_1", "value_1"))
            .build()
            .unwrap();

        assert_eq!(val, expected);
    }

    #[test]
    fn it_requires_url_field() {
        let err = Trigger::builder()
            .customizable_input_parameter(input_param("param_0", "value_0"))
            .build()
            .unwrap_err();
        assert_eq!(err.object(), "Trigger");

        let errors = err.field("url");
        assert!(errors.includes(ValidationErrorKind::Required));
    }
}