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

//! [Stage Instances](https://discord.com/developers/docs/resources/stage-instance#create-stage-instance)

use serde::Serialize;

use crate::types::{Snowflake, StageInstance, StagePrivacyLevel};

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

routes! {
    CREATE_STAGE_INSTANCE = Post "/stage-instances";
    GET_STAGE_INSTANCE = Get "/stage-instances/{channel_id}";
    MODIFY_STAGE_INSTANCE = Patch "/stage-instances/{channel_id}";
    DELETE_STAGE_INSTANCE = Delete "/stage-instances/{channel_id}";
}

/// Body of [`BotClient::create_stage_instance`]
#[derive(Debug, Clone, Copy, Serialize)]
pub struct CreateStageInstance<'a> {
    /// The stage channel to go live in
    pub channel_id: Snowflake,

    /// What it is about, 1-120 characters
    pub topic: &'a str,

    /// Who can see it; guild members by default
    #[serde(skip_serializing_if = "Option::is_none")]
    pub privacy_level: Option<StagePrivacyLevel>,

    /// Notify `@everyone` that the stage is live (needs the Mention Everyone permission)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub send_start_notification: Option<bool>,

    /// The scheduled event it is for
    #[serde(skip_serializing_if = "Option::is_none")]
    pub guild_scheduled_event_id: Option<Snowflake>,

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

/// Body of [`BotClient::modify_stage_instance`]. Absent fields are unchanged.
#[derive(Debug, Clone, Copy, Default, Serialize)]
pub struct ModifyStageInstance<'a> {
    /// What it is about, 1-120 characters
    #[serde(skip_serializing_if = "Option::is_none")]
    pub topic: Option<&'a str>,

    /// Who can see it
    #[serde(skip_serializing_if = "Option::is_none")]
    pub privacy_level: Option<StagePrivacyLevel>,

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

impl<T: Transport> BotClient<T> {
    /// [Create Stage Instance](https://discord.com/developers/docs/resources/stage-instance#create-stage-instance):
    /// goes live; the bot must be a stage moderator
    pub async fn create_stage_instance(
        &self,
        stage: &CreateStageInstance<'_>,
    ) -> Result<Response<StageInstance>> {
        let url = self.rest.url(CREATE_STAGE_INSTANCE, &[]);
        self.rest
            .call(CREATE_STAGE_INSTANCE, url, Body::Json(stage), stage.reason)
            .await
    }

    /// [Get Stage Instance](https://discord.com/developers/docs/resources/stage-instance#get-stage-instance)
    /// of the stage channel `channel_id`
    pub async fn get_stage_instance(
        &self,
        channel_id: Snowflake,
    ) -> Result<Response<StageInstance>> {
        let url = self.rest.url(GET_STAGE_INSTANCE, &[&channel_id]);
        self.rest
            .call(GET_STAGE_INSTANCE, url, Body::NONE, None)
            .await
    }

    /// [Modify Stage Instance](https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance)
    pub async fn modify_stage_instance(
        &self,
        channel_id: Snowflake,
        stage: &ModifyStageInstance<'_>,
    ) -> Result<Response<StageInstance>> {
        let url = self.rest.url(MODIFY_STAGE_INSTANCE, &[&channel_id]);
        self.rest
            .call(MODIFY_STAGE_INSTANCE, url, Body::Json(stage), stage.reason)
            .await
    }

    /// [Delete Stage Instance](https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance):
    /// ends the stage
    pub async fn delete_stage_instance(
        &self,
        channel_id: Snowflake,
        reason: Option<&str>,
    ) -> Result<()> {
        let url = self.rest.url(DELETE_STAGE_INSTANCE, &[&channel_id]);
        self.rest
            .call_empty(DELETE_STAGE_INSTANCE, 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 channel = Snowflake::from_u64(5);
        let create = CreateStageInstance {
            channel_id: channel,
            topic: "Release party",
            privacy_level: None,
            send_start_notification: Some(true),
            guild_scheduled_event_id: None,
            reason: None,
        };
        let modify = ModifyStageInstance {
            topic: Some("Q&A"),
            ..Default::default()
        };
        block_on(c.create_stage_instance(&create)).unwrap();
        block_on(c.get_stage_instance(channel)).unwrap();
        block_on(c.modify_stage_instance(channel, &modify)).unwrap();
        block_on(c.delete_stage_instance(channel, Some("over"))).unwrap();
        let t = c.transport();
        assert_eq!(
            t.sent(),
            [
                (Post, "/stage-instances".into()),
                (Get, "/stage-instances/5".into()),
                (Patch, "/stage-instances/5".into()),
                (Delete, "/stage-instances/5".into()),
            ]
        );
        assert_eq!(
            t.body(0),
            json!({ "channel_id": "5", "topic": "Release party", "send_start_notification": true })
        );
        assert_eq!(t.body(2), json!({ "topic": "Q&A" }));
        assert_eq!(t.request(3).header("x-audit-log-reason"), Some("over"));
    }
}