Class: MijDiscord::Bot

Inherits:
Object
  • Object
show all
Defined in:
lib/mij-discord/bot.rb

Defined Under Namespace

Classes: AuthInfo

Constant Summary collapse

EVENTS = 
{
  ready: MijDiscord::Events::Ready,
  heartbeat: MijDiscord::Events::Heartbeat,
  connect: MijDiscord::Events::Connect,
  disconnect: MijDiscord::Events::Disconnect,
  exception: MijDiscord::Events::Exception,

  update_user: MijDiscord::Events::UpdateUser,
  create_server: MijDiscord::Events::CreateServer,
  update_server: MijDiscord::Events::UpdateServer,
  delete_server: MijDiscord::Events::DeleteServer,
  update_emoji: MijDiscord::Events::UpdateEmoji,
  ban_user: MijDiscord::Events::BanUser,
  unban_user: MijDiscord::Events::UnbanUser,

  create_role: MijDiscord::Events::CreateRole,
  update_role: MijDiscord::Events::UpdateRole,
  delete_role: MijDiscord::Events::DeleteRole,
  create_member: MijDiscord::Events::CreateMember,
  update_member: MijDiscord::Events::UpdateMember,
  delete_member: MijDiscord::Events::DeleteMember,

  create_channel: MijDiscord::Events::CreateChannel,
  update_channel: MijDiscord::Events::UpdateChannel,
  delete_channel: MijDiscord::Events::DeleteChannel,
  add_recipient: MijDiscord::Events::AddRecipient,
  remove_recipient: MijDiscord::Events::RemoveRecipient,

  create_message: MijDiscord::Events::CreateMessage,
  channel_message: MijDiscord::Events::ChannelMessage,
  private_message: MijDiscord::Events::PrivateMessage,
  edit_message: MijDiscord::Events::EditMessage,
  delete_message: MijDiscord::Events::DeleteMessage,
  add_reaction: MijDiscord::Events::AddReaction,
  remove_reaction: MijDiscord::Events::RemoveReaction,
  toggle_reaction: MijDiscord::Events::ToggleReaction,
  clear_reactions: MijDiscord::Events::ClearReactions,
  start_typing: MijDiscord::Events::StartTyping,

  update_presence: MijDiscord::Events::UpdatePresence,
  update_playing: MijDiscord::Events::UpdatePlaying,
  update_voice_state: MijDiscord::Events::UpdateVoiceState,
}.freeze
UNAVAILABLE_SERVER_TIMEOUT = 
10
USER_STATUS = 
[:online, :idle, :dnd, :invisible, :offline].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client_id:, token:, type: :bot, name: nil, shard_id: nil, num_shards: nil, ignore_bots: false, ignore_self: true) ⇒ Bot

Returns a new instance of Bot.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/mij-discord/bot.rb', line 79

def initialize(client_id:, token:, type: :bot, name: nil,
shard_id: nil, num_shards: nil, ignore_bots: false, ignore_self: true)
  @client_id, @name = client_id.to_id, name || ''

  token = case type
    when :bot then "Bot #{token}"
    when :user then "#{token}"
    else raise ArgumentError, 'Invalid bot type'
  end

  @auth = AuthInfo.new(token, type)

  @cache = MijDiscord::Cache::BotCache.new(self)

  @shard_key = [shard_id, num_shards] if num_shards
  @gateway = MijDiscord::Core::Gateway.new(self, @auth, @shard_key)

  @ignore_bots, @ignore_self, @ignored_ids = ignore_bots, ignore_self, Set.new

  @unavailable_servers = 0

  @event_dispatchers = {}
end

Instance Attribute Details

#auth ⇒ Object (readonly)

Returns the value of attribute auth.



69
70
71
 
# File 'lib/mij-discord/bot.rb', line 69

def auth
  @auth
end

#cache ⇒ Object (readonly)

Returns the value of attribute cache.



77
78
79
 
# File 'lib/mij-discord/bot.rb', line 77

def cache
  @cache
end

#client_id ⇒ Object (readonly)

Returns the value of attribute client_id.



67
68
69
 
# File 'lib/mij-discord/bot.rb', line 67

def client_id
  @client_id
end

#gateway ⇒ Object (readonly)

Returns the value of attribute gateway.



75
76
77
 
# File 'lib/mij-discord/bot.rb', line 75

def gateway
  @gateway
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



65
66
67
 
# File 'lib/mij-discord/bot.rb', line 65

def name
  @name
end

#profile ⇒ Object (readonly)

Returns the value of attribute profile.



73
74
75
 
# File 'lib/mij-discord/bot.rb', line 73

def profile
  @profile
end

#shard_key ⇒ Object (readonly)

Returns the value of attribute shard_key.



71
72
73
 
# File 'lib/mij-discord/bot.rb', line 71

def shard_key
  @shard_key
end

Instance Method Details

#accept_invite(invite) ⇒ Object 



205
206
207
208
209
 
# File 'lib/mij-discord/bot.rb', line 205

def accept_invite(invite)
  code = parse_invite_code(invite)
  MijDiscord::Core::API::Invite.accept(@auth, code)
  nil
end

#add_event(type, key = nil, **filter, &block) ⇒ Object

Raises:

  • (ArgumentError) 


265
266
267
268
269
270
 
# File 'lib/mij-discord/bot.rb', line 265

def add_event(type, key = nil, **filter, &block)
  raise ArgumentError, "Invalid event type: #{type}" unless EVENTS[type]

  event = (@event_dispatchers[type] ||= MijDiscord::Events::EventDispatcher.new(EVENTS[type], self))
  event.add_callback(key, filter, &block)
end

#application ⇒ Object 



192
193
194
195
196
197
 
# File 'lib/mij-discord/bot.rb', line 192

def application
  raise 'Cannot get OAuth application for non-bot user' if @type != :bot

  response = MijDiscord::Core::API.oauth_application(@auth)
  MijDiscord::Data::Application.new(JSON.parse(response), self)
end

#change_status(status: nil, game: nil, url: nil) ⇒ Object

Raises:

  • (ArgumentError) 


299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/mij-discord/bot.rb', line 299

def change_status(status: nil, game: nil, url: nil)
  gateway_check

  status = status.nil? ? @profile.status : USER_STATUS.find(status)
  raise ArgumentError, "Status '#{status}' is not valid" unless status

  game_obj = case game
    when false
      nil
    when nil
      {'name' => @profile.game, 'url' => @profile.stream_url, 'type' => @profile.stream_type}
    else
      {'name' => game, 'url' => url, 'type' => url ? 1 : 0}
  end

  game_obj&.reject! {|_,v| v.nil? }
  game_obj = nil if game_obj&.empty?

  @gateway.send_status_update(status, nil, game_obj, false)
  @profile.update_presence('status' => status, 'game' => game_obj)
  nil
end

#channel(id, server = nil) ⇒ Object 



140
141
142
143
 
# File 'lib/mij-discord/bot.rb', line 140

def channel(id, server = nil)
  gateway_check
  @cache.get_channel(id, server)
end

#channels ⇒ Object 



135
136
137
138
 
# File 'lib/mij-discord/bot.rb', line 135

def channels
  gateway_check
  @cache.list_channels
end

#connect(async = true) ⇒ Object 



103
104
105
106
107
 
# File 'lib/mij-discord/bot.rb', line 103

def connect(async = true)
  @gateway.run_async
  @gateway.sync unless async
  nil
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/mij-discord/bot.rb', line 121

def connected?
  @gateway.open?
end

#create_server(name, region = 'eu-central') ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/mij-discord/bot.rb', line 218

def create_server(name, region = 'eu-central')
  response = API::Server.create(@auth, name, region)
  id = JSON.parse(response)['id'].to_i

  loop do
    server = @cache.get_server(id, local: true)
    return server if server

    sleep(0.1)
  end
end

#disconnect(no_sync = false) ⇒ Object Also known as: shutdown 



114
115
116
117
 
# File 'lib/mij-discord/bot.rb', line 114

def disconnect(no_sync = false)
  @gateway.stop(no_sync)
  nil
end

#emoji(server_id, id) ⇒ Object 



187
188
189
190
 
# File 'lib/mij-discord/bot.rb', line 187

def emoji(server_id, id)
  gateway_check
  server(server_id)&.emoji(id)
end

#emojis(server_id) ⇒ Object 



182
183
184
185
 
# File 'lib/mij-discord/bot.rb', line 182

def emojis(server_id)
  gateway_check
  server(server_id)&.emojis
end

#events(type) ⇒ Object

Raises:

  • (ArgumentError) 


279
280
281
282
283
 
# File 'lib/mij-discord/bot.rb', line 279

def events(type)
  raise ArgumentError, "Invalid event type: #{type}" unless EVENTS[type]

  @event_dispatchers[type]&.callbacks || []
end

#handle_dispatch(type, data) ⇒ Object 



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
 
# File 'lib/mij-discord/bot.rb', line 332

def handle_dispatch(type, data)
  MijDiscord::LOGGER.debug('Dispatch') { "<#{type} #{data.inspect}>" }

  if @unavailable_servers > 0 && Time.now > @unavailable_servers_timeout
    MijDiscord::LOGGER.warn('Dispatch') { "Proceeding with #{@unavailable_servers} servers still unavailable" }

    @unavailable_servers = 0
    notify_ready
  end

  case type
    when :CONNECT
      trigger_event(:connect, self)

    when :DISCONNECT
      trigger_event(:disconnect, self)

    when :READY
      @cache.reset

      @profile = MijDiscord::Data::Profile.new(data['user'], self)
      @profile.update_presence('status' => :online)

      @unavailable_servers = 0
      @unavailable_servers_timeout = Time.now + UNAVAILABLE_SERVER_TIMEOUT

      data['guilds'].each do |sv|
        if sv['unavailable'].eql?(true)
          @unavailable_servers += 1
        else
          @cache.put_server(sv)
        end
      end

      data['private_channels'].each do |ch|
        @cache.put_channel(ch, nil)
      end

      notify_ready if @unavailable_servers.zero?

    when :GUILD_MEMBERS_CHUNK
      server = @cache.get_server(data['guild_id'])
      server.update_members_chunk(data['members'])

    when :GUILD_CREATE
      server = @cache.put_server(data)

      if data['unavailable'].eql?(false)
        @unavailable_servers -= 1
        @unavailable_servers_timeout = Time.now + UNAVAILABLE_SERVER_TIMEOUT

        notify_ready if @unavailable_servers.zero?
        return
      end

      trigger_event(:create_server, self, server)

    when :GUILD_UPDATE
      server = @cache.put_server(data, update: true)
      trigger_event(:update_server, self, server)

    when :GUILD_DELETE
      server = @cache.remove_server(data['id'])

      if data['unavailable'].eql?(true)
        MijDiscord::LOGGER.warn('Dispatch') { "Server <#{data['id']}> died due to outage" }
        return
      end

      trigger_event(:delete_server, self, server)

    when :CHANNEL_CREATE
      channel = @cache.put_channel(data, nil)
      trigger_event(:create_channel, self, channel)

    when :CHANNEL_UPDATE
      channel = @cache.put_channel(data, nil, update: true)
      trigger_event(:update_channel, self, channel)

    when :CHANNEL_DELETE
      channel = @cache.remove_channel(data['id'])
      trigger_event(:delete_channel, self, channel)

    when :CHANNEL_RECIPIENT_ADD
      channel = @cache.get_channel(data['channel_id'], nil)
      recipient = channel.update_recipient(add: data['user'])
      trigger_event(:add_recipient, self, channel, recipient)

    when :CHANNEL_RECIPIENT_REMOVE
      channel = @cache.get_channel(data['channel_id'], nil)
      recipient = channel.update_recipient(remove: data['user'])
      trigger_event(:remove_recipient, self, channel, recipient)

    when :GUILD_MEMBER_ADD
      server = @cache.get_server(data['guild_id'])
      member = server.cache.put_member(data)
      trigger_event(:create_member, self, member, server)

    when :GUILD_MEMBER_UPDATE
      server = @cache.get_server(data['guild_id'])
      member = server.cache.put_member(data, update: true)
      trigger_event(:update_member, self, member, server)

    when :GUILD_MEMBER_REMOVE
      server = @cache.get_server(data['guild_id'])
      member = server.cache.remove_member(data['user']['id'])
      trigger_event(:delete_member, self, member, server)

    when :GUILD_ROLE_CREATE
      server = @cache.get_server(data['guild_id'])
      role = server.cache.put_role(data['role'])
      trigger_event(:create_role, self, server, role)

    when :GUILD_ROLE_UPDATE
      server = @cache.get_server(data['guild_id'])
      role = server.cache.put_role(data['role'], update: true)
      trigger_event(:update_role, self, server, role)

    when :GUILD_ROLE_DELETE
      server = @cache.get_server(data['guild_id'])
      role = server.cache.remove_role(data['role_id'])
      trigger_event(:delete_role, self, server, role)

    when :GUILD_EMOJIS_UPDATE
      server = @cache.get_server(data['guild_id'])
      old_emojis = server.emojis
      server.update_emojis(data)
      trigger_event(:update_emoji, self, server, old_emojis, server.emojis)

    when :GUILD_BAN_ADD
      server = @cache.get_server(data['guild_id'])
      user = @cache.get_user(data['user']['id'])
      trigger_event(:ban_user, self, server, user)

    when :GUILD_BAN_REMOVE
      server = @cache.get_server(data['guild_id'])
      user = @cache.get_user(data['user']['id'])
      trigger_event(:unban_user, self, server, user)

    when :MESSAGE_CREATE
      return if ignored_user?(data['author']['id'])
      return if @ignore_bots && data['author']['bot']

      channel = @cache.get_channel(data['channel_id'], nil)
      message = channel.cache.put_message(data)
      trigger_event(:create_message, self, message)

      if message.channel.private?
        trigger_event(:private_message, self, message)
      else
        trigger_event(:channel_message, self, message)
      end

    when :MESSAGE_ACK
      # Do nothing with message acknowledgement

    when :MESSAGE_UPDATE
      author = data['author']
      return if author.nil?

      return if ignored_user?(author['id'])
      return if @ignore_bots && author['bot']

      channel = @cache.get_channel(data['channel_id'], nil)
      message = channel.cache.put_message(data, update: true)
      trigger_event(:edit_message, self, message)

    when :MESSAGE_DELETE
      channel = @cache.get_channel(data['channel_id'], nil)
      channel.cache.remove_message(data['id'])

      trigger_event(:delete_message, self, data)

    when :MESSAGE_DELETE_BULK
      messages = data['ids'].map {|x| {'id' => x, 'channel_id' => data['channel_id']} }
      messages.each {|x| trigger_event(:delete_message, self, x) }

    when :MESSAGE_REACTION_ADD
      # Should add full use ignore support?
      return if ignored_user?(data['user_id'])

      trigger_event(:add_reaction, self, data)
      trigger_event(:toggle_reaction, self, data)

    when :MESSAGE_REACTION_REMOVE
      # Should add full use ignore support?
      return if ignored_user?(data['user_id'])

      trigger_event(:remove_reaction, self, data)
      trigger_event(:toggle_reaction, self, data)

    when :MESSAGE_REACTION_REMOVE_ALL
      trigger_event(:clear_reactions, self, data)

    when :TYPING_START
      begin
        trigger_event(:start_typing, self, data)
      rescue MijDiscord::Core::Errors::NoPermission
        # Ignoring the channel we can't access
        # Why is this even sent? :S
      end

    when :USER_UPDATE
      user = @cache.put_user(data, update: true)
      trigger_event(:update_user, self, user)

    when :PRESENCE_UPDATE
      return unless data['guild_id']

      server = @cache.get_server(data['guild_id'])
      member = server.cache.put_member(data, update: true)

      old_game = member.game
      member.update_presence(data)

      if old_game != member.game
        trigger_event(:update_playing, self, data)
      else
        trigger_event(:update_presence, self, data)
      end

    when :VOICE_STATE_UPDATE
      server = @cache.get_server(data['guild_id'])
      state = server.update_voice_state(data)
      trigger_event(:update_voice_state, self, state)

    else
      MijDiscord::LOGGER.warn('Dispatch') { "Unhandled gateway event type: #{type}" }
  end
rescue => exc
  MijDiscord::LOGGER.error('Dispatch') { 'An error occurred in dispatch handler' }
  MijDiscord::LOGGER.error('Dispatch') { exc }
end

#handle_exception(type, exception, payload = nil) ⇒ Object 



326
327
328
329
330
 
# File 'lib/mij-discord/bot.rb', line 326

def handle_exception(type, exception, payload = nil)
  return if type == :event && payload&.is_a?(MijDiscord::Events::Exception)

  trigger_event(:exception, self, type, exception, payload)
end

#handle_heartbeat ⇒ Object 



322
323
324
 
# File 'lib/mij-discord/bot.rb', line 322

def handle_heartbeat
  trigger_event(:heartbeat, self)
end

#ignore_user(user) ⇒ Object 



285
286
287
288
 
# File 'lib/mij-discord/bot.rb', line 285

def ignore_user(user)
  @ignored_ids << user.to_id
  nil
end

#ignored_user?(user) ⇒ Boolean

Returns:

  • (Boolean) 


295
296
297
 
# File 'lib/mij-discord/bot.rb', line 295

def ignored_user?(user)
  @ignore_self && user.to_id == @client_id || @ignored_ids.include?(user.to_id)
end

#invite(invite) ⇒ Object 



199
200
201
202
203
 
# File 'lib/mij-discord/bot.rb', line 199

def invite(invite)
  code = parse_invite_code(invite)
  response = MijDiscord::Core::API::Invite.resolve(@auth, code)
  MijDiscord::Data::Invite.new(JSON.parse(response), self)
end

#make_invite_url(server: nil, permissions: nil) ⇒ Object 



211
212
213
214
215
216
 
# File 'lib/mij-discord/bot.rb', line 211

def make_invite_url(server: nil, permissions: nil)
  url = "https://discordapp.com/oauth2/authorize?scope=bot&client_id=#{@client_id}".dup
  url << "&permissions=#{permissions.to_i}" if permissions.respond_to?(:to_i)
  url << "&guild_id=#{server.to_id}" if server.respond_to?(:to_id)
  url
end

#member(server_id, id) ⇒ Object 



167
168
169
170
 
# File 'lib/mij-discord/bot.rb', line 167

def member(server_id, id)
  gateway_check
  server(server_id)&.member(id)
end

#members(server_id) ⇒ Object 



162
163
164
165
 
# File 'lib/mij-discord/bot.rb', line 162

def members(server_id)
  gateway_check
  server(server_id)&.members
end

#parse_invite_code(invite) ⇒ Object 



230
231
232
233
234
235
236
237
238
 
# File 'lib/mij-discord/bot.rb', line 230

def parse_invite_code(invite)
  case invite
    when %r[^(?:https?://)?discord\.gg/(\w+)$]i then $1
    when %r[^https?://discordapp\.com/invite/(\w+)$]i then $1
    when %r[^([a-zA-Z0-9]+)$] then $1
    when MijDiscord::Data::Invite then invite.code
    else raise ArgumentError, 'Invalid invite format'
  end
end

#parse_mention(mention, server_id = nil) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/mij-discord/bot.rb', line 240

def parse_mention(mention, server_id = nil)
  gateway_check

  case mention
    when /^<@!?(\d+)>$/
      server_id ? member(server_id, $1) : user($1)
    when /^<@&(\d+)>$/
      role = role(server_id, $1)
      return role if role

      servers.each do |sv|
        role = sv.role($1)
        return role if role
      end
    when /^<:\w+:(\d+)>$/
      emoji = emoji(server_id, $1)
      return emoji if emoji

      servers.each do |sv|
        emoji = sv.emoji($1)
        return emoji if emoji
      end
  end
end

#pm_channel(id) ⇒ Object Also known as: dm_channel 



145
146
147
148
 
# File 'lib/mij-discord/bot.rb', line 145

def pm_channel(id)
  gateway_check
  @cache.get_pm_channel(id)
end

#remove_event(type, key) ⇒ Object

Raises:

  • (ArgumentError) 


272
273
274
275
276
277
 
# File 'lib/mij-discord/bot.rb', line 272

def remove_event(type, key)
  raise ArgumentError, "Invalid event type: #{type}" unless EVENTS[type]

  @event_dispatchers[type]&.remove_callback(key)
  nil
end

#role(server_id, id) ⇒ Object 



177
178
179
180
 
# File 'lib/mij-discord/bot.rb', line 177

def role(server_id, id)
  gateway_check
  server(server_id)&.role(id)
end

#roles(server_id) ⇒ Object 



172
173
174
175
 
# File 'lib/mij-discord/bot.rb', line 172

def roles(server_id)
  gateway_check
  server(server_id)&.roles
end

#server(id) ⇒ Object 



130
131
132
133
 
# File 'lib/mij-discord/bot.rb', line 130

def server(id)
  gateway_check
  @cache.get_server(id)
end

#servers ⇒ Object 



125
126
127
128
 
# File 'lib/mij-discord/bot.rb', line 125

def servers
  gateway_check
  @cache.list_servers
end

#sync ⇒ Object 



109
110
111
112
 
# File 'lib/mij-discord/bot.rb', line 109

def sync
  @gateway.sync
  nil
end

#unignore_user(user) ⇒ Object 



290
291
292
293
 
# File 'lib/mij-discord/bot.rb', line 290

def unignore_user(user)
  @ignored_ids.delete(user.to_id)
  nil
end

#user(id) ⇒ Object 



157
158
159
160
 
# File 'lib/mij-discord/bot.rb', line 157

def user(id)
  gateway_check
  @cache.get_user(id)
end

#users ⇒ Object 



152
153
154
155
 
# File 'lib/mij-discord/bot.rb', line 152

def users
  gateway_check
  @cache.list_users
end