composure 0.2.4

Discord bots over HTTP Interactions, no gateway: slash commands, components, modals and JSX-like views, on Cloudflare Workers (WASM) or any server
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216

//! [Soundboard](https://discord.com/developers/docs/resources/soundboard#endpoints)

use serde::{Deserialize, Serialize};

use crate::types::{Snowflake, SoundboardSound};

use super::{Body, BotClient, Response, Result, Transport, route::routes};

routes! {
    SEND_SOUNDBOARD_SOUND = Post "/channels/{channel_id}/send-soundboard-sound";
    LIST_DEFAULT_SOUNDBOARD_SOUNDS = Get "/soundboard-default-sounds";
    LIST_GUILD_SOUNDBOARD_SOUNDS = Get "/guilds/{guild_id}/soundboard-sounds";
    GET_GUILD_SOUNDBOARD_SOUND = Get "/guilds/{guild_id}/soundboard-sounds/{sound_id}";
    CREATE_GUILD_SOUNDBOARD_SOUND = Post "/guilds/{guild_id}/soundboard-sounds";
    MODIFY_GUILD_SOUNDBOARD_SOUND = Patch "/guilds/{guild_id}/soundboard-sounds/{sound_id}";
    DELETE_GUILD_SOUNDBOARD_SOUND = Delete "/guilds/{guild_id}/soundboard-sounds/{sound_id}";
}

/// Body of [`BotClient::create_guild_soundboard_sound`] (needs `name` and `sound`) and
/// [`BotClient::modify_guild_soundboard_sound`]
#[derive(Debug, Clone, Copy, Default, Serialize)]
pub struct SoundboardSoundFields<'a> {
    /// 2-32 characters
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<&'a str>,

    /// Create only: MP3 or OGG data URI (max 512 KiB, 5.2 seconds)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sound: Option<&'a str>,

    /// 0-1, default 1
    #[serde(skip_serializing_if = "Option::is_none")]
    pub volume: Option<Option<f64>>,

    /// A custom emoji shown with it
    #[serde(skip_serializing_if = "Option::is_none")]
    pub emoji_id: Option<Option<Snowflake>>,

    /// A unicode emoji shown with it
    #[serde(skip_serializing_if = "Option::is_none")]
    pub emoji_name: Option<Option<&'a str>>,

    /// `X-Audit-Log-Reason`
    #[serde(skip)]
    pub reason: Option<&'a str>,
}

/// Guild sounds come wrapped
#[derive(Debug, Clone, Deserialize)]
pub struct SoundboardSounds {
    /// The sounds
    pub items: Vec<SoundboardSound>,
}

#[derive(Serialize)]
struct SendSound {
    sound_id: Snowflake,
    #[serde(skip_serializing_if = "Option::is_none")]
    source_guild_id: Option<Snowflake>,
}

impl<T: Transport> BotClient<T> {
    /// [Send Soundboard Sound](https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound)
    /// in the voice channel the bot is connected to; `source_guild_id` for another guild's sound
    pub async fn send_soundboard_sound(
        &self,
        channel_id: Snowflake,
        sound_id: Snowflake,
        source_guild_id: Option<Snowflake>,
    ) -> Result<()> {
        let url = self.rest.url(SEND_SOUNDBOARD_SOUND, &[&channel_id]);
        let body = SendSound {
            sound_id,
            source_guild_id,
        };
        self.rest
            .call_empty(SEND_SOUNDBOARD_SOUND, url, Body::Json(&body), None)
            .await
    }

    /// [List Default Soundboard Sounds](https://discord.com/developers/docs/resources/soundboard#list-default-soundboard-sounds)
    pub async fn list_default_soundboard_sounds(&self) -> Result<Response<Vec<SoundboardSound>>> {
        let url = self.rest.url(LIST_DEFAULT_SOUNDBOARD_SOUNDS, &[]);
        self.rest
            .call(LIST_DEFAULT_SOUNDBOARD_SOUNDS, url, Body::NONE, None)
            .await
    }

    /// [List Guild Soundboard Sounds](https://discord.com/developers/docs/resources/soundboard#list-guild-soundboard-sounds)
    pub async fn list_guild_soundboard_sounds(
        &self,
        guild_id: Snowflake,
    ) -> Result<Response<SoundboardSounds>> {
        let url = self.rest.url(LIST_GUILD_SOUNDBOARD_SOUNDS, &[&guild_id]);
        self.rest
            .call(LIST_GUILD_SOUNDBOARD_SOUNDS, url, Body::NONE, None)
            .await
    }

    /// [Get Guild Soundboard Sound](https://discord.com/developers/docs/resources/soundboard#get-guild-soundboard-sound)
    pub async fn get_guild_soundboard_sound(
        &self,
        guild_id: Snowflake,
        sound_id: Snowflake,
    ) -> Result<Response<SoundboardSound>> {
        let url = self
            .rest
            .url(GET_GUILD_SOUNDBOARD_SOUND, &[&guild_id, &sound_id]);
        self.rest
            .call(GET_GUILD_SOUNDBOARD_SOUND, url, Body::NONE, None)
            .await
    }

    /// [Create Guild Soundboard Sound](https://discord.com/developers/docs/resources/soundboard#create-guild-soundboard-sound)
    pub async fn create_guild_soundboard_sound(
        &self,
        guild_id: Snowflake,
        sound: &SoundboardSoundFields<'_>,
    ) -> Result<Response<SoundboardSound>> {
        let url = self.rest.url(CREATE_GUILD_SOUNDBOARD_SOUND, &[&guild_id]);
        self.rest
            .call(
                CREATE_GUILD_SOUNDBOARD_SOUND,
                url,
                Body::Json(sound),
                sound.reason,
            )
            .await
    }

    /// [Modify Guild Soundboard Sound](https://discord.com/developers/docs/resources/soundboard#modify-guild-soundboard-sound)
    pub async fn modify_guild_soundboard_sound(
        &self,
        guild_id: Snowflake,
        sound_id: Snowflake,
        sound: &SoundboardSoundFields<'_>,
    ) -> Result<Response<SoundboardSound>> {
        let url = self
            .rest
            .url(MODIFY_GUILD_SOUNDBOARD_SOUND, &[&guild_id, &sound_id]);
        let sound = SoundboardSoundFields {
            sound: None,
            ..*sound
        };
        self.rest
            .call(
                MODIFY_GUILD_SOUNDBOARD_SOUND,
                url,
                Body::Json(&sound),
                sound.reason,
            )
            .await
    }

    /// [Delete Guild Soundboard Sound](https://discord.com/developers/docs/resources/soundboard#delete-guild-soundboard-sound)
    pub async fn delete_guild_soundboard_sound(
        &self,
        guild_id: Snowflake,
        sound_id: Snowflake,
        reason: Option<&str>,
    ) -> Result<()> {
        let url = self
            .rest
            .url(DELETE_GUILD_SOUNDBOARD_SOUND, &[&guild_id, &sound_id]);
        self.rest
            .call_empty(DELETE_GUILD_SOUNDBOARD_SOUND, url, Body::NONE, reason)
            .await
    }
}

#[cfg(test)]
mod tests {
    use futures::executor::block_on;
    use serde_json::json;

    use super::super::{Method::*, testing::MockTransport};
    use super::*;

    #[test]
    fn routes() {
        let c = BotClient::new(MockTransport::default(), "t", Snowflake::from_u64(1));
        let (g, s) = (Snowflake::from_u64(5), Snowflake::from_u64(6));
        let create = SoundboardSoundFields {
            name: Some("boop"),
            sound: Some("data:audio/ogg;base64,AA=="),
            volume: Some(Some(0.5)),
            ..Default::default()
        };
        block_on(c.send_soundboard_sound(g, s, None)).unwrap();
        block_on(c.list_default_soundboard_sounds()).unwrap();
        block_on(c.list_guild_soundboard_sounds(g)).unwrap();
        block_on(c.get_guild_soundboard_sound(g, s)).unwrap();
        block_on(c.create_guild_soundboard_sound(g, &create)).unwrap();
        block_on(c.modify_guild_soundboard_sound(g, s, &create)).unwrap();
        block_on(c.delete_guild_soundboard_sound(g, s, None)).unwrap();
        let t = c.transport();
        assert_eq!(
            t.sent(),
            [
                (Post, "/channels/5/send-soundboard-sound".into()),
                (Get, "/soundboard-default-sounds".into()),
                (Get, "/guilds/5/soundboard-sounds".into()),
                (Get, "/guilds/5/soundboard-sounds/6".into()),
                (Post, "/guilds/5/soundboard-sounds".into()),
                (Patch, "/guilds/5/soundboard-sounds/6".into()),
                (Delete, "/guilds/5/soundboard-sounds/6".into()),
            ]
        );
        assert_eq!(t.body(0), json!({ "sound_id": "6" }));
        assert_eq!(
            t.body(5),
            json!({ "name": "boop", "volume": 0.5 }),
            "the sound itself cannot change"
        );
    }
}