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

use crate::composition_objects::Trigger;
use crate::validators::required;

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

/// [Workflow object](https://docs.slack.dev/reference/block-kit/composition-objects/workflow-object)
/// representation.
///
/// # Fields and Validations
///
/// For more details, see the [official
/// documentation](https://docs.slack.dev/reference/block-kit/composition-objects/workflow-object).
///
/// | Field | Type | Required | Validation |
/// |-------|------|----------|------------|
/// | trigger | [Trigger] | Yes | N/A |
///
/// # Example
///
/// ```
/// use slack_messaging::composition_objects::{types::InputParameter, Trigger, Workflow};
/// # use std::error::Error;
///
/// # fn try_main() -> Result<(), Box<dyn Error>> {
/// let workflow = Workflow::builder()
///     .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()?
///     )
///     .build()?;
///
/// let expected = serde_json::json!({
///     "trigger": {
///         "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(workflow).unwrap();
///
/// assert_eq!(json, expected);
///
/// // If your object has any validation errors, the build method returns Result::Err
/// let workflow = Workflow::builder().build();
/// assert!(workflow.is_err());
/// #     Ok(())
/// # }
/// # fn main() {
/// #     try_main().unwrap()
/// # }
/// ```
#[derive(Debug, Clone, Serialize, PartialEq, Builder)]
pub struct Workflow {
    #[builder(validate("required"))]
    pub(crate) trigger: Option<Trigger>,
}

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

    #[test]
    fn it_implements_builder() {
        let expected = Workflow {
            trigger: Some(trigger()),
        };

        let val = Workflow::builder()
            .set_trigger(Some(trigger()))
            .build()
            .unwrap();

        assert_eq!(val, expected);

        let val = Workflow::builder().trigger(trigger()).build().unwrap();

        assert_eq!(val, expected);
    }

    #[test]
    fn it_requires_trigger_field() {
        let err = Workflow::builder().build().unwrap_err();
        assert_eq!(err.object(), "Workflow");

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