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

use crate::blocks::elements::types::FileType;
use crate::validators::*;

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

/// [File input element](https://docs.slack.dev/reference/block-kit/block-elements/file-input-element)
/// representation.
///
/// # Fields and Validations
///
/// For more details, see the [official
/// documentation](https://docs.slack.dev/reference/block-kit/block-elements/file-input-element).
///
/// | Field | Type | Required | Validation |
/// |-------|------|----------|------------|
/// | action_id | String | No | Max length 255 characters |
/// | filetypes | Vec<[FileType]> | No | N/A |
/// | max_files | i64 | No | Min value 1, Max value 10 |
///
/// # Example
///
/// ```
/// use slack_messaging::blocks::elements::{FileInput, types::FileType};
/// # use std::error::Error;
///
/// # fn try_main() -> Result<(), Box<dyn Error>> {
/// let input = FileInput::builder()
///     .action_id("file_input_action_id_1")
///     .filetype(FileType::Jpg)
///     .build()?;
///
/// let expected = serde_json::json!({
///     "type": "file_input",
///     "action_id": "file_input_action_id_1",
///     "filetypes": ["jpg"]
/// });
///
/// let json = serde_json::to_value(input).unwrap();
///
/// assert_eq!(json, expected);
///
/// // If your object has any validation errors, the build method returns Result::Err
/// let input = FileInput::builder()
///     .action_id("file_input_action_id_1")
///     .filetype(FileType::Jpg)
///     .max_files(99)
///     .build();
///
/// assert!(input.is_err());
/// #     Ok(())
/// # }
/// # fn main() {
/// #     try_main().unwrap()
/// # }
/// ```
#[derive(Debug, Clone, Serialize, PartialEq, Builder)]
#[serde(tag = "type", rename = "file_input")]
pub struct FileInput {
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(validate("text::max_255"))]
    pub(crate) action_id: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(push_item = "filetype")]
    pub(crate) filetypes: Option<Vec<FileType>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(validate("integer::min_1", "integer::max_10"))]
    pub(crate) max_files: Option<i64>,
}

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

    #[test]
    fn it_implements_builder() {
        let expected = FileInput {
            action_id: Some("file_input_0".into()),
            filetypes: Some(vec![FileType::Jpg, FileType::Png]),
            max_files: Some(5),
        };

        let val = FileInput::builder()
            .set_action_id(Some("file_input_0"))
            .set_filetypes(Some(vec![FileType::Jpg, FileType::Png]))
            .set_max_files(Some(5))
            .build()
            .unwrap();

        assert_eq!(val, expected);

        let val = FileInput::builder()
            .action_id("file_input_0")
            .filetypes(vec![FileType::Jpg, FileType::Png])
            .max_files(5)
            .build()
            .unwrap();

        assert_eq!(val, expected);
    }

    #[test]
    fn it_implements_push_item_method() {
        let expected = FileInput {
            action_id: None,
            filetypes: Some(vec![FileType::Jpg, FileType::Png]),
            max_files: None,
        };

        let val = FileInput::builder()
            .filetype(FileType::Jpg)
            .filetype(FileType::Png)
            .build()
            .unwrap();

        assert_eq!(val, expected);
    }

    #[test]
    fn it_requires_action_id_less_than_255_characters_long() {
        let err = FileInput::builder()
            .action_id("a".repeat(256))
            .build()
            .unwrap_err();
        assert_eq!(err.object(), "FileInput");

        let errors = err.field("action_id");
        assert!(errors.includes(ValidationErrorKind::MaxTextLength(255)));
    }

    #[test]
    fn it_requires_max_files_greater_than_1() {
        let err = FileInput::builder().max_files(0).build().unwrap_err();
        assert_eq!(err.object(), "FileInput");

        let errors = err.field("max_files");
        assert!(errors.includes(ValidationErrorKind::MinIntegerValue(1)));
    }

    #[test]
    fn it_requires_max_files_less_than_10() {
        let err = FileInput::builder().max_files(11).build().unwrap_err();
        assert_eq!(err.object(), "FileInput");

        let errors = err.field("max_files");
        assert!(errors.includes(ValidationErrorKind::MaxIntegerValue(10)));
    }
}