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

//! [Roles](https://discord.com/developers/docs/resources/guild#get-guild-roles)

use std::collections::HashMap;

use serde::Serialize;

use crate::types::{Permissions, Role, Snowflake};

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

routes! {
    GET_ROLES = Get "/guilds/{guild_id}/roles";
    GET_ROLE = Get "/guilds/{guild_id}/roles/{role_id}";
    CREATE_ROLE = Post "/guilds/{guild_id}/roles";
    MODIFY_ROLE = Patch "/guilds/{guild_id}/roles/{role_id}";
    MODIFY_ROLE_POSITIONS = Patch "/guilds/{guild_id}/roles";
    DELETE_ROLE = Delete "/guilds/{guild_id}/roles/{role_id}";
    GET_ROLE_MEMBER_COUNTS = Get "/guilds/{guild_id}/roles/member-counts";
}

/// Body of [`BotClient::create_role`] and [`BotClient::modify_role`]. Absent fields take
/// Discord's default (create) or are unchanged (modify); `Some(None)` clears.
#[derive(Debug, Clone, Copy, Default, Serialize)]
pub struct RoleFields<'a> {
    /// 1-100 characters
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<&'a str>,

    /// What members with the role may do
    #[serde(skip_serializing_if = "Option::is_none")]
    pub permissions: Option<Permissions>,

    /// RGB
    #[serde(skip_serializing_if = "Option::is_none")]
    pub color: Option<u32>,

    /// Shown separately in the member list
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hoist: Option<bool>,

    /// Data URI (needs the ROLE_ICONS feature)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub icon: Option<Option<&'a str>>,

    /// A unicode emoji shown as the role icon (needs the ROLE_ICONS feature)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unicode_emoji: Option<Option<&'a str>>,

    /// Anyone may mention it
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mentionable: Option<bool>,

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

/// One entry of [`BotClient::modify_role_positions`]
#[derive(Debug, Clone, Copy, Serialize)]
pub struct RolePosition {
    /// The role
    pub id: Snowflake,
    /// Its new position
    #[serde(skip_serializing_if = "Option::is_none")]
    pub position: Option<i32>,
}

impl<T: Transport> BotClient<T> {
    /// [Get Guild Roles](https://discord.com/developers/docs/resources/guild#get-guild-roles)
    pub async fn get_roles(&self, guild_id: Snowflake) -> Result<Response<Vec<Role>>> {
        let url = self.rest.url(GET_ROLES, &[&guild_id]);
        self.rest.call(GET_ROLES, url, Body::NONE, None).await
    }

    /// [Get Guild Role](https://discord.com/developers/docs/resources/guild#get-guild-role)
    pub async fn get_role(
        &self,
        guild_id: Snowflake,
        role_id: Snowflake,
    ) -> Result<Response<Role>> {
        let url = self.rest.url(GET_ROLE, &[&guild_id, &role_id]);
        self.rest.call(GET_ROLE, url, Body::NONE, None).await
    }

    /// [Create Guild Role](https://discord.com/developers/docs/resources/guild#create-guild-role)
    pub async fn create_role(
        &self,
        guild_id: Snowflake,
        role: &RoleFields<'_>,
    ) -> Result<Response<Role>> {
        let url = self.rest.url(CREATE_ROLE, &[&guild_id]);
        self.rest
            .call(CREATE_ROLE, url, Body::Json(role), role.reason)
            .await
    }

    /// [Modify Guild Role](https://discord.com/developers/docs/resources/guild#modify-guild-role)
    pub async fn modify_role(
        &self,
        guild_id: Snowflake,
        role_id: Snowflake,
        role: &RoleFields<'_>,
    ) -> Result<Response<Role>> {
        let url = self.rest.url(MODIFY_ROLE, &[&guild_id, &role_id]);
        self.rest
            .call(MODIFY_ROLE, url, Body::Json(role), role.reason)
            .await
    }

    /// [Modify Guild Role Positions](https://discord.com/developers/docs/resources/guild#modify-guild-role-positions)
    pub async fn modify_role_positions(
        &self,
        guild_id: Snowflake,
        positions: &[RolePosition],
        reason: Option<&str>,
    ) -> Result<Response<Vec<Role>>> {
        let url = self.rest.url(MODIFY_ROLE_POSITIONS, &[&guild_id]);
        self.rest
            .call(MODIFY_ROLE_POSITIONS, url, Body::Json(&positions), reason)
            .await
    }

    /// [Delete Guild Role](https://discord.com/developers/docs/resources/guild#delete-guild-role)
    pub async fn delete_role(
        &self,
        guild_id: Snowflake,
        role_id: Snowflake,
        reason: Option<&str>,
    ) -> Result<()> {
        let url = self.rest.url(DELETE_ROLE, &[&guild_id, &role_id]);
        self.rest
            .call_empty(DELETE_ROLE, url, Body::NONE, reason)
            .await
    }

    /// [Get Guild Role Member Counts](https://discord.com/developers/docs/resources/guild#get-guild-role-member-counts):
    /// members per role id (`@everyone` excluded)
    pub async fn get_role_member_counts(
        &self,
        guild_id: Snowflake,
    ) -> Result<Response<HashMap<Snowflake, u32>>> {
        let url = self.rest.url(GET_ROLE_MEMBER_COUNTS, &[&guild_id]);
        self.rest
            .call(GET_ROLE_MEMBER_COUNTS, url, Body::NONE, None)
            .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().respond(200, "[]"),
            "t",
            Snowflake::from_u64(1),
        );
        let (g, r) = (Snowflake::from_u64(5), Snowflake::from_u64(6));
        let fields = RoleFields {
            name: Some("Mods"),
            permissions: Some(Permissions::KickMembers | Permissions::BanMembers),
            color: Some(0xff0000),
            icon: Some(None),
            reason: Some("staffing"),
            ..Default::default()
        };
        block_on(c.get_roles(g)).unwrap();
        block_on(c.get_role(g, r)).unwrap();
        block_on(c.create_role(g, &fields)).unwrap();
        block_on(c.modify_role(g, r, &fields)).unwrap();
        block_on(c.modify_role_positions(
            g,
            &[RolePosition {
                id: r,
                position: Some(3),
            }],
            None,
        ))
        .unwrap();
        block_on(c.delete_role(g, r, None)).unwrap();
        let t = c.transport();
        t.queue(super::super::RawResponse {
            status: 200,
            headers: Vec::new(),
            body: br#"{"6":12,"7":0}"#.to_vec(),
        });
        let counts = block_on(c.get_role_member_counts(g))
            .unwrap()
            .model()
            .unwrap();
        assert_eq!(counts[&r], 12);
        assert_eq!(
            t.sent(),
            [
                (Get, "/guilds/5/roles".into()),
                (Get, "/guilds/5/roles/6".into()),
                (Post, "/guilds/5/roles".into()),
                (Patch, "/guilds/5/roles/6".into()),
                (Patch, "/guilds/5/roles".into()),
                (Delete, "/guilds/5/roles/6".into()),
                (Get, "/guilds/5/roles/member-counts".into()),
            ]
        );
        assert_eq!(
            t.body(2),
            json!({ "name": "Mods", "permissions": "6", "color": 16711680, "icon": null })
        );
        assert_eq!(t.body(4), json!([{ "id": "6", "position": 3 }]));
    }
}