-
Notifications
You must be signed in to change notification settings - Fork 99
/
channel.rb
599 lines (548 loc) · 21 KB
/
channel.rb
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
# frozen_string_literal: true
# API calls for Channel
module Discordrb::API::Channel
module_function
# Get a channel's data
# https://discord.com/developers/docs/resources/channel#get-channel
def resolve(token, channel_id)
Discordrb::API.request(
:channels_cid,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}",
Authorization: token
)
end
# Update a channel's data
# https://discord.com/developers/docs/resources/channel#modify-channel
def update(token, channel_id, name, topic, position, bitrate, user_limit, nsfw, permission_overwrites = nil, parent_id = nil, rate_limit_per_user = nil, reason = nil)
data = { name: name, position: position, topic: topic, bitrate: bitrate, user_limit: user_limit, nsfw: nsfw, parent_id: parent_id, rate_limit_per_user: rate_limit_per_user }
data[:permission_overwrites] = permission_overwrites unless permission_overwrites.nil?
Discordrb::API.request(
:channels_cid,
channel_id,
:patch,
"#{Discordrb::API.api_base}/channels/#{channel_id}",
data.to_json,
Authorization: token,
content_type: :json,
'X-Audit-Log-Reason': reason
)
end
# Delete a channel
# https://discord.com/developers/docs/resources/channel#deleteclose-channel
def delete(token, channel_id, reason = nil)
Discordrb::API.request(
:channels_cid,
channel_id,
:delete,
"#{Discordrb::API.api_base}/channels/#{channel_id}",
Authorization: token,
'X-Audit-Log-Reason': reason
)
end
# Get a list of messages from a channel's history
# https://discord.com/developers/docs/resources/channel#get-channel-messages
def messages(token, channel_id, amount, before = nil, after = nil, around = nil)
query_string = URI.encode_www_form({ limit: amount, before: before, after: after, around: around }.compact)
Discordrb::API.request(
:channels_cid_messages,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages?#{query_string}",
Authorization: token
)
end
# Get a single message from a channel's history by id
# https://discord.com/developers/docs/resources/channel#get-channel-message
def message(token, channel_id, message_id)
Discordrb::API.request(
:channels_cid_messages_mid,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}",
Authorization: token
)
end
# Send a message to a channel
# https://discord.com/developers/docs/resources/channel#create-message
# @param attachments [Array<File>, nil] Attachments to use with `attachment://` in embeds. See
# https://discord.com/developers/docs/resources/channel#create-message-using-attachments-within-embeds
def create_message(token, channel_id, message, tts = false, embeds = nil, nonce = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil)
body = { content: message, tts: tts, embeds: embeds, nonce: nonce, allowed_mentions: allowed_mentions, message_reference: message_reference, components: components&.to_a }
body = if attachments
files = [*0...attachments.size].zip(attachments).to_h
{ **files, payload_json: body.to_json }
else
body.to_json
end
headers = { Authorization: token }
headers[:content_type] = :json unless attachments
Discordrb::API.request(
:channels_cid_messages_mid,
channel_id,
:post,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages",
body,
**headers
)
rescue RestClient::BadRequest => e
parsed = JSON.parse(e.response.body)
raise Discordrb::Errors::MessageTooLong, "Message over the character limit (#{message.length} > 2000)" if parsed['content'].is_a?(Array) && parsed['content'].first == 'Must be 2000 or fewer in length.'
raise
end
# Send a file as a message to a channel
# https://discord.com/developers/docs/resources/channel#upload-file
def upload_file(token, channel_id, file, caption: nil, tts: false)
Discordrb::API.request(
:channels_cid_messages_mid,
channel_id,
:post,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages",
{ file: file, content: caption, tts: tts },
Authorization: token
)
end
# Edit a message
# https://discord.com/developers/docs/resources/channel#edit-message
def edit_message(token, channel_id, message_id, message, mentions = [], embeds = nil, components = nil)
Discordrb::API.request(
:channels_cid_messages_mid,
channel_id,
:patch,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}",
{ content: message, mentions: mentions, embeds: embeds, components: components }.to_json,
Authorization: token,
content_type: :json
)
end
# Delete a message
# https://discord.com/developers/docs/resources/channel#delete-message
def delete_message(token, channel_id, message_id, reason = nil)
Discordrb::API.request(
:channels_cid_messages_mid,
channel_id,
:delete,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}",
Authorization: token,
'X-Audit-Log-Reason': reason
)
end
# Delete messages in bulk
# https://discord.com/developers/docs/resources/channel#bulk-delete-messages
def bulk_delete_messages(token, channel_id, messages = [], reason = nil)
Discordrb::API.request(
:channels_cid_messages_bulk_delete,
channel_id,
:post,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages/bulk-delete",
{ messages: messages }.to_json,
Authorization: token,
content_type: :json,
'X-Audit-Log-Reason': reason
)
end
# Create a reaction on a message using this client
# https://discord.com/developers/docs/resources/channel#create-reaction
def create_reaction(token, channel_id, message_id, emoji)
emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
Discordrb::API.request(
:channels_cid_messages_mid_reactions_emoji_me,
channel_id,
:put,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}/@me",
nil,
Authorization: token,
content_type: :json
)
end
# Delete this client's own reaction on a message
# https://discord.com/developers/docs/resources/channel#delete-own-reaction
def delete_own_reaction(token, channel_id, message_id, emoji)
emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
Discordrb::API.request(
:channels_cid_messages_mid_reactions_emoji_me,
channel_id,
:delete,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}/@me",
Authorization: token
)
end
# Delete another client's reaction on a message
# https://discord.com/developers/docs/resources/channel#delete-user-reaction
def delete_user_reaction(token, channel_id, message_id, emoji, user_id)
emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
Discordrb::API.request(
:channels_cid_messages_mid_reactions_emoji_uid,
channel_id,
:delete,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}/#{user_id}",
Authorization: token
)
end
# Get a list of clients who reacted with a specific reaction on a message
# https://discord.com/developers/docs/resources/channel#get-reactions
def get_reactions(token, channel_id, message_id, emoji, before_id, after_id, limit = 100)
emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
query_string = URI.encode_www_form({ limit: limit || 100, before: before_id, after: after_id }.compact)
Discordrb::API.request(
:channels_cid_messages_mid_reactions_emoji,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}?#{query_string}",
Authorization: token
)
end
# Deletes all reactions on a message from all clients
# https://discord.com/developers/docs/resources/channel#delete-all-reactions
def delete_all_reactions(token, channel_id, message_id)
Discordrb::API.request(
:channels_cid_messages_mid_reactions,
channel_id,
:delete,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions",
Authorization: token
)
end
# Deletes all the reactions for a given emoji on a message
# https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji
def delete_all_emoji_reactions(token, channel_id, message_id, emoji)
emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
Discordrb::API.request(
:channels_cid_messages_mid_reactions_emoji,
channel_id,
:delete,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}",
Authorization: token
)
end
# Update a channels permission for a role or member
# https://discord.com/developers/docs/resources/channel#edit-channel-permissions
def update_permission(token, channel_id, overwrite_id, allow, deny, type, reason = nil)
Discordrb::API.request(
:channels_cid_permissions_oid,
channel_id,
:put,
"#{Discordrb::API.api_base}/channels/#{channel_id}/permissions/#{overwrite_id}",
{ type: type, id: overwrite_id, allow: allow, deny: deny }.to_json,
Authorization: token,
content_type: :json,
'X-Audit-Log-Reason': reason
)
end
# Get a channel's invite list
# https://discord.com/developers/docs/resources/channel#get-channel-invites
def invites(token, channel_id)
Discordrb::API.request(
:channels_cid_invites,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}/invites",
Authorization: token
)
end
# Create an instant invite from a server or a channel id
# https://discord.com/developers/docs/resources/channel#create-channel-invite
def create_invite(token, channel_id, max_age = 0, max_uses = 0, temporary = false, unique = false, reason = nil)
Discordrb::API.request(
:channels_cid_invites,
channel_id,
:post,
"#{Discordrb::API.api_base}/channels/#{channel_id}/invites",
{ max_age: max_age, max_uses: max_uses, temporary: temporary, unique: unique }.to_json,
Authorization: token,
content_type: :json,
'X-Audit-Log-Reason': reason
)
end
# Delete channel permission
# https://discord.com/developers/docs/resources/channel#delete-channel-permission
def delete_permission(token, channel_id, overwrite_id, reason = nil)
Discordrb::API.request(
:channels_cid_permissions_oid,
channel_id,
:delete,
"#{Discordrb::API.api_base}/channels/#{channel_id}/permissions/#{overwrite_id}",
Authorization: token,
'X-Audit-Log-Reason': reason
)
end
# Start typing (needs to be resent every 5 seconds to keep up the typing)
# https://discord.com/developers/docs/resources/channel#trigger-typing-indicator
def start_typing(token, channel_id)
Discordrb::API.request(
:channels_cid_typing,
channel_id,
:post,
"#{Discordrb::API.api_base}/channels/#{channel_id}/typing",
nil,
Authorization: token
)
end
# Get a list of pinned messages in a channel
# https://discord.com/developers/docs/resources/channel#get-pinned-messages
def pinned_messages(token, channel_id)
Discordrb::API.request(
:channels_cid_pins,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}/pins",
Authorization: token
)
end
# Pin a message
# https://discord.com/developers/docs/resources/channel#add-pinned-channel-message
def pin_message(token, channel_id, message_id, reason = nil)
Discordrb::API.request(
:channels_cid_pins_mid,
channel_id,
:put,
"#{Discordrb::API.api_base}/channels/#{channel_id}/pins/#{message_id}",
nil,
Authorization: token,
'X-Audit-Log-Reason': reason
)
end
# Unpin a message
# https://discord.com/developers/docs/resources/channel#delete-pinned-channel-message
def unpin_message(token, channel_id, message_id, reason = nil)
Discordrb::API.request(
:channels_cid_pins_mid,
channel_id,
:delete,
"#{Discordrb::API.api_base}/channels/#{channel_id}/pins/#{message_id}",
Authorization: token,
'X-Audit-Log-Reason': reason
)
end
# Create an empty group channel.
# @deprecated Discord no longer supports bots in group DMs, this endpoint was repurposed and no longer works as implemented here.
# https://discord.com/developers/docs/resources/user#create-group-dm
def create_empty_group(token, bot_user_id)
Discordrb::API.request(
:users_uid_channels,
nil,
:post,
"#{Discordrb::API.api_base}/users/#{bot_user_id}/channels",
{}.to_json,
Authorization: token,
content_type: :json
)
end
# Create a group channel.
# @deprecated Discord no longer supports bots in group DMs, this endpoint was repurposed and no longer works as implemented here.
# https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
def create_group(token, pm_channel_id, user_id)
Discordrb::API.request(
:channels_cid_recipients_uid,
nil,
:put,
"#{Discordrb::API.api_base}/channels/#{pm_channel_id}/recipients/#{user_id}",
{}.to_json,
Authorization: token,
content_type: :json
)
rescue RestClient::InternalServerError
raise 'Attempted to add self as a new group channel recipient!'
rescue RestClient::NoContent
raise 'Attempted to create a group channel with the PM channel recipient!'
rescue RestClient::Forbidden
raise 'Attempted to add a user to group channel without permission!'
end
# Add a user to a group channel.
# @deprecated Discord no longer supports bots in group DMs, this endpoint was repurposed and no longer works as implemented here.
# https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
def add_group_user(token, group_channel_id, user_id)
Discordrb::API.request(
:channels_cid_recipients_uid,
nil,
:put,
"#{Discordrb::API.api_base}/channels/#{group_channel_id}/recipients/#{user_id}",
{}.to_json,
Authorization: token,
content_type: :json
)
end
# Remove a user from a group channel.
# @deprecated Discord no longer supports bots in group DMs, this endpoint was repurposed and no longer works as implemented here.
# https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient
def remove_group_user(token, group_channel_id, user_id)
Discordrb::API.request(
:channels_cid_recipients_uid,
nil,
:delete,
"#{Discordrb::API.api_base}/channels/#{group_channel_id}/recipients/#{user_id}",
Authorization: token,
content_type: :json
)
end
# Leave a group channel.
# @deprecated Discord no longer supports bots in group DMs, this endpoint was repurposed and no longer works as implemented here.
# https://discord.com/developers/docs/resources/channel#deleteclose-channel
def leave_group(token, group_channel_id)
Discordrb::API.request(
:channels_cid,
nil,
:delete,
"#{Discordrb::API.api_base}/channels/#{group_channel_id}",
Authorization: token,
content_type: :json
)
end
# Create a webhook
# https://discord.com/developers/docs/resources/webhook#create-webhook
def create_webhook(token, channel_id, name, avatar = nil, reason = nil)
Discordrb::API.request(
:channels_cid_webhooks,
channel_id,
:post,
"#{Discordrb::API.api_base}/channels/#{channel_id}/webhooks",
{ name: name, avatar: avatar }.to_json,
Authorization: token,
content_type: :json,
'X-Audit-Log-Reason': reason
)
end
# Get channel webhooks
# https://discord.com/developers/docs/resources/webhook#get-channel-webhooks
def webhooks(token, channel_id)
Discordrb::API.request(
:channels_cid_webhooks,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}/webhooks",
Authorization: token
)
end
# Start a thread based off a channel message.
# https://discord.com/developers/docs/resources/channel#start-thread-with-message
def start_thread_with_message(token, channel_id, message_id, name, auto_archive_duration)
Discordrb::API.request(
:channels_cid_messages_mid_threads,
channel_id,
:post,
"#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/threads",
{ name: name, auto_archive_duration: auto_archive_duration }.to_json,
Authorization: token,
content_type: :json
)
end
# Start a thread without an associated message.
# https://discord.com/developers/docs/resources/channel#start-thread-without-message
def start_thread_without_message(token, channel_id, name, auto_archive_duration, type = 11)
Discordrb::API.request(
:channels_cid_threads,
channel_id,
:post,
"#{Discordrb::API.api_base}/channels/#{channel_id}/threads",
{ name: name, auto_archive_duration: auto_archive_duration, type: type },
Authorization: token,
content_type: :json
)
end
# Add the current user to a thread.
# https://discord.com/developers/docs/resources/channel#join-thread
def join_thread(token, channel_id)
Discordrb::API.request(
:channels_cid_thread_members_me,
channel_id,
:put,
"#{Discordrb::API.api_base}/channels/#{channel_id}/thread-members/@me",
nil,
Authorization: token
)
end
# Add a user to a thread.
# https://discord.com/developers/docs/resources/channel#add-thread-member
def add_thread_member(token, channel_id, user_id)
Discordrb::API.request(
:channels_cid_thread_members_uid,
channel_id,
:put,
"#{Discordrb::API.api_base}/channels/#{channel_id}/thread-members/#{user_id}",
nil,
Authorization: token
)
end
# Remove the current user from a thread.
# https://discord.com/developers/docs/resources/channel#leave-thread
def leave_thread(token, channel_id)
Discordrb::API.request(
:channels_cid_thread_members_me,
channel_id,
:delete,
"#{Discordrb::API.api_base}/channels/#{channel_id}/thread-members/#{user_id}",
Authorization: token
)
end
# Remove a user from a thread.
# https://discord.com/developers/docs/resources/channel#remove-thread-member
def remove_thread_member(token, channel_id, user_id)
Discordrb::API.request(
:channels_cid_thread_members_uid,
channel_id,
:delete,
"#{Discordrb::API.api_base}/channels/#{channel_id}/thread-members/#{user_id}",
Authorization: token
)
end
# Get the members of a thread.
# https://discord.com/developers/docs/resources/channel#list-thread-members
def list_thread_members(token, channel_id, before, limit)
query = URI.encode_www_form({ before: before, limit: limit }.compact)
Discordrb::API.request(
:channels_cid_thread_members,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}/thread-members?#{query}",
Authorization: token
)
end
# List active threads
# https://discord.com/developers/docs/resources/channel#list-active-threads
def list_active_threads(token, channel_id)
Discordrb::API.request(
:channels_cid_threads_active,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}/threads/active",
Authorization: token
)
end
# List public archived threads.
# https://discord.com/developers/docs/resources/channel#list-public-archived-threads
def list_public_archived_threads(token, channel_id, before = nil, limit = nil)
query = URI.encode_www_form({ before: before, limit: limit }.compact)
Discordrb::API.request(
:channels_cid_threads_archived_public,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}/threads/archived/public?#{query}",
Authorization: token
)
end
# List private archived threads.
# https://discord.com/developers/docs/resources/channel#list-private-archived-threads
def list_private_archived_threads(token, channel_id, before = nil, limit = nil)
query = URI.encode_www_form({ before: before, limit: limit }.compact)
Discordrb::API.request(
:channels_cid_threads_archived_private,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}/threads/archived/private?#{query}",
Authorization: token
)
end
# List joined private archived threads.
# https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads
def list_joined_private_archived_threads(token, channel_id, before = nil, limit = nil)
query = URI.encode_www_form({ before: before, limit: limit }.compact)
Discordrb::API.request(
:channels_cid_users_me_threads_archived_private,
channel_id,
:get,
"#{Discordrb::API.api_base}/channels/#{channel_id}/users/@me/threads/archived/private?#{query}",
Authorization: token
)
end
end