Class: Discorb::Client

Inherits:
Object
  • Object
show all
Includes:
ApplicationCommand::Handler, Gateway::Handler
Defined in:
lib/discorb/client.rb

Overview

Class for connecting to the Discord server.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ApplicationCommand::Handler

#message_command, #setup_commands, #slash, #slash_group, #user_command

Constructor Details

#initialize(allowed_mentions: nil, intents: nil, message_caches: 1000, log: nil, colorize_log: false, log_level: :info, wait_until_ready: true) -> Client

Initializes a new client.

Parameters:

  • allowed_mentions (Discorb::AllowedMentions) (defaults to: nil) —

    The allowed mentions that the client is using.

  • intents (Discorb::Intents) (defaults to: nil) —

    The intents that the client is currently using.

  • message_caches (Integer) (defaults to: 1000) —

    The number of messages to cache.

  • log (#puts) (defaults to: nil) —

    The IO object to use for logging.

  • colorize_log (Boolean) (defaults to: false) —

    Whether to colorize the log.

  • log_level (:debug, :info, :warn, :error, :critical) (defaults to: :info) —

    The log level.

  • wait_until_ready (Boolean) (defaults to: true) —

    Whether to delay event dispatch until ready.



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
 
# File 'lib/discorb/client.rb', line 68

def initialize(
  allowed_mentions: nil, intents: nil, message_caches: 1000,
  log: nil, colorize_log: false, log_level: :info,
  wait_until_ready: true
)
  @allowed_mentions = allowed_mentions || AllowedMentions.new(everyone: true, roles: true, users: true)
  @intents = (intents or Intents.default)
  @events = {}
  @api_version = nil
  @log = Logger.new(log, colorize_log, log_level)
  @user = nil
  @users = Discorb::Dictionary.new
  @channels = Discorb::Dictionary.new
  @guilds = Discorb::Dictionary.new(sort: ->(k) { k[0].to_i })
  @emojis = Discorb::Dictionary.new
  @messages = Discorb::Dictionary.new(limit: message_caches)
  @application = nil
  @last_s = nil
  @identify_presence = nil
  @wait_until_ready = wait_until_ready
  @ready = false
  @tasks = []
  @conditions = {}
  @commands = []
  @bottom_commands = []
  @status = :initialized
  set_default_events
end

Instance Attribute Details

#allowed_mentions -> Discorb::AllowedMentions (readonly)

Returns The allowed mentions that the client is using.

Returns:



29
30
31
 
# File 'lib/discorb/client.rb', line 29

def allowed_mentions
  @allowed_mentions
end

#api_version -> Integer? (readonly)

Returns:

  • (Integer) —

    The API version of the Discord gateway.

  • (nil) —

    If not connected to the gateway.



25
26
27
 
# File 'lib/discorb/client.rb', line 25

def api_version
  @api_version
end

#application -> Discorb::Application? (readonly)

Returns:



18
19
20
 
# File 'lib/discorb/client.rb', line 18

def application
  @application
end

#channels -> Discorb::Dictionary{Discorb::Snowflake => Discorb::Channel} (readonly)

Returns A dictionary of channels.

Returns:



37
38
39
 
# File 'lib/discorb/client.rb', line 37

def channels
  @channels
end

#commands -> Array<Discorb::ApplicationCommand::Command> (readonly)

Returns The commands that the client is using.

Returns:



45
46
47
 
# File 'lib/discorb/client.rb', line 45

def commands
  @commands
end

#emojis -> Discorb::Dictionary{Discorb::Snowflake => Discorb::Emoji} (readonly)

Returns A dictionary of emojis.

Returns:



39
40
41
 
# File 'lib/discorb/client.rb', line 39

def emojis
  @emojis
end

#guilds -> Discorb::Dictionary{Discorb::Snowflake => Discorb::Guild} (readonly)

Returns A dictionary of guilds.

Returns:



33
34
35
 
# File 'lib/discorb/client.rb', line 33

def guilds
  @guilds
end

#heartbeat_interval -> Integer (readonly)

Returns The heartbeat interval.

Returns:

  • (Integer) —

    The heartbeat interval.



22
23
24
 
# File 'lib/discorb/client.rb', line 22

def heartbeat_interval
  @heartbeat_interval
end

#http -> Discorb::HTTP (readonly)

Returns The http client.

Returns:

  • (Discorb::HTTP) —

    The http client.



20
21
22
 
# File 'lib/discorb/client.rb', line 20

def http
  @http
end

#intents -> Discorb::Intents

Returns The intents that the client is currently using.

Returns:



15
16
17
 
# File 'lib/discorb/client.rb', line 15

def intents
  @intents
end

#log -> Discorb::Logger (readonly)

Returns The logger.

Returns:

  • (Discorb::Logger) —

    The logger.



43
44
45
 
# File 'lib/discorb/client.rb', line 43

def log
  @log
end

#messages -> Discorb::Dictionary{Discorb::Snowflake => Discorb::Message} (readonly)

Returns A dictionary of messages.

Returns:



41
42
43
 
# File 'lib/discorb/client.rb', line 41

def messages
  @messages
end

#ping -> Float? (readonly)

Returns:

  • (Float) —

    The ping of the client. @note This will be calculated from heartbeat and heartbeat_ack.

  • (nil) —

    If not connected to the gateway.



49
50
51
 
# File 'lib/discorb/client.rb', line 49

def ping
  @ping
end

#session_id -> Integer (readonly)

Returns The session ID of connection.

Returns:

  • (Integer) —

    The session ID of connection.



53
54
55
 
# File 'lib/discorb/client.rb', line 53

def session_id
  @session_id
end

#status -> :initialized, ... (readonly)

Returns The status of the client.

Returns:

  • (:initialized, :running, :closed) —

    The status of the client.



51
52
53
 
# File 'lib/discorb/client.rb', line 51

def status
  @status
end

#token -> String (readonly)

Returns The token of the client.

Returns:

  • (String) —

    The token of the client.



27
28
29
 
# File 'lib/discorb/client.rb', line 27

def token
  @token
end

#user -> Discorb::ClientUser (readonly)

Returns The client user.

Returns:



31
32
33
 
# File 'lib/discorb/client.rb', line 31

def user
  @user
end

#users -> Discorb::Dictionary{Discorb::Snowflake => Discorb::User} (readonly)

Returns A dictionary of users.

Returns:



35
36
37
 
# File 'lib/discorb/client.rb', line 35

def users
  @users
end

Instance Method Details

#close! -> Object

Stops the client.



451
452
453
454
455
456
 
# File 'lib/discorb/client.rb', line 451

def close!
  @connection.send_close
  @tasks.each(&:stop)
  @status = :closed
  @close_condition.signal
end

#dispatch(event_name, *args) -> Object

Dispatch an event.

Parameters:

  • event_name (Symbol) —

    The name of the event.

  • args (Object) —

    The arguments to pass to the event.



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
 
# File 'lib/discorb/client.rb', line 144

def dispatch(event_name, *args)
  Async do
    if (conditions = @conditions[event_name])
      ids = Set[*conditions.map(&:first).map(&:object_id)]
      conditions.delete_if do |condition|
        next unless ids.include?(condition.first.object_id)

        check_result = condition[1].nil? || condition[1].call(*args)
        if check_result
          condition.first.signal(args)
          true
        else
          false
        end
      end
    end
    events = @events[event_name].dup || []
    if respond_to?("on_" + event_name.to_s)
      event_method = method("on_" + event_name.to_s)
      class << event_method
        def id
          "method"
        end
      end
      events << event_method
    end
    if events.nil?
      @log.debug "Event #{event_name} doesn't have any proc, skipping"
      next
    end
    @log.debug "Dispatching event #{event_name}"
    events.each do |block|
      Async do
        Async(annotation: "Discorb event: #{event_name}") do |task|
          if block.is_a?(Discorb::Event)
            @events[event_name].delete(block) if block.metadata[:once]
          end
          block.call(*args)
          @log.debug "Dispatched proc with ID #{block.id.inspect}"
        rescue StandardError, ScriptError => e
          dispatch(:error, event_name, args, e)
        end
      end
    end
  end
end

#event_lock(event, timeout = nil, &check) -> Object Also known as: await

Method to wait for a event.

Parameters:

  • event (Symbol) —

    The name of the event.

  • timeout (Integer) (defaults to: nil) —

    The timeout in seconds.

  • check (Proc) —

    The check to use.

Returns:

  • (Object) —

    The result of the event.

Raises:



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/discorb/client.rb', line 331

def event_lock(event, timeout = nil, &check)
  Async do |task|
    condition = Async::Condition.new
    @conditions[event] ||= []
    @conditions[event] << [condition, check]
    if timeout.nil?
      value = condition.wait
    else
      timeout_task = task.with_timeout(timeout) do
        condition.wait
      rescue Async::TimeoutError
        @conditions[event].delete_if { |c| c.first == condition }
        raise Discorb::TimeoutError, "Timeout waiting for event #{event}", cause: nil
      end
      value = timeout_task
    end
    value.length <= 1 ? value.first : value
  end
end

#extend(mod) -> Object

Load the extension.

Parameters:

  • mod (Module) —

    The extension to load.



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/discorb/client.rb', line 362

def extend(mod)
  if mod.respond_to?(:events)
    @events.each_value do |event|
      event.delete_if { |c| c.metadata[:extension] == mod.name }
    end
    mod.events.each do |name, events|
      @events[name] ||= []
      @events[name].delete_if { |c| c.metadata[:override] }
      events.each do |event|
        @events[name] << event
      end
    end
    @commands.delete_if do |cmd|
      cmd.respond_to? :extension and cmd.extension == mod.name
    end
    mod.commands.each do |cmd|
      cmd.define_singleton_method(:extension) { mod.name }
      @commands << cmd
    end
    @bottom_commands += mod.bottom_commands
    mod.client = self
  end
  super(mod)
end

#fetch_application(force: false) -> Async::Task<Discorb::Application>

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Fetch webhook from ID. If application was cached, it will be used.

Parameters:

  • force (Boolean) (defaults to: false) —

    Whether to force the fetch.

Returns:

Raises:



273
274
275
276
277
278
279
280
281
 
# File 'lib/discorb/client.rb', line 273

def fetch_application(force: false)
  Async do
    next @application if @application && !force

    _resp, data = http.get("/oauth2/applications/@me").wait
    @application = Application.new(self, data)
    @application
  end
end

#fetch_channel(id) -> Async::Task<Discorb::Channel>

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Fetch channel from ID.

Parameters:

  • id (#to_s) —

    The ID of the channel.

Returns:

Raises:



220
221
222
223
224
225
 
# File 'lib/discorb/client.rb', line 220

def fetch_channel(id)
  Async do
    _resp, data = http.get("/channels/#{id}").wait
    Channel.make_channel(self, data)
  end
end

#fetch_guild(id) -> Async::Task<Discorb::Guild>

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Fetch guild from ID.

Parameters:

  • id (#to_s) —

    <description>

Returns:

Raises:



238
239
240
241
242
243
 
# File 'lib/discorb/client.rb', line 238

def fetch_guild(id)
  Async do
    _resp, data = http.get("/guilds/#{id}").wait
    Guild.new(self, data, false)
  end
end

#fetch_invite(code, with_count: false, with_expiration: false) -> Async::Task<Discorb::Invite>

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Fetch invite from code.

Parameters:

  • code (String) —

    The code of the invite.

  • with_count (Boolean) (defaults to: false) —

    Whether to include the count of the invite.

  • with_expiration (Boolean) (defaults to: false) —

    Whether to include the expiration of the invite.

Returns:

Raises:



256
257
258
259
260
261
 
# File 'lib/discorb/client.rb', line 256

def fetch_invite(code, with_count: false, with_expiration: false)
  Async do
    _resp, data = http.get("/invites/#{code}?with_count=#{with_count}&with_expiration=#{with_expiration}").wait
    Invite.new(self, data, false)
  end
end

#fetch_nitro_sticker_packs -> Async::Task<Array<Discorb::Sticker::Pack>>

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Fetch nitro sticker pack from ID.

Returns:

Raises:



290
291
292
293
294
295
 
# File 'lib/discorb/client.rb', line 290

def fetch_nitro_sticker_packs
  Async do
    _resp, data = http.get("/stickers-packs").wait
    data.map { |pack| Sticker::Pack.new(self, pack) }
  end
end

#fetch_user(id) -> Async::Task<Discorb::User>

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Fetch user from ID.

Parameters:

  • id (#to_s) —

    <description>

Returns:

Raises:



202
203
204
205
206
207
 
# File 'lib/discorb/client.rb', line 202

def fetch_user(id)
  Async do
    _resp, data = http.get("/users/#{id}").wait
    User.new(self, data)
  end
end

#inspect -> Object 



353
354
355
 
# File 'lib/discorb/client.rb', line 353

def inspect
  "#<#{self.class} user=\"#{user}\">"
end

#on(event_name, id: nil, **metadata, &block) -> Discorb::Event

Registers an event handler.

Parameters:

  • event_name (Symbol) —

    The name of the event.

  • id (Symbol) (defaults to: nil) —

    Custom ID of the event.

  • metadata (Hash) —

    The metadata of the event.

  • block (Proc) —

    The block to execute when the event is triggered.

Returns:

See Also:



108
109
110
111
112
113
114
 
# File 'lib/discorb/client.rb', line 108

def on(event_name, id: nil, **metadata, &block)
  ne = Event.new(block, id, metadata)
  @events[event_name] ||= []
  @events[event_name].delete_if { |e| e.metadata[:override] }
  @events[event_name] << ne
  ne
end

#once(event_name, id: nil, **metadata, &block) -> Discorb::Event

Almost same as #on, but only triggers the event once.

Parameters:

  • event_name (Symbol) —

    The name of the event.

  • id (Symbol) (defaults to: nil) —

    Custom ID of the event.

  • metadata (Hash) —

    The metadata of the event.

  • block (Proc) —

    The block to execute when the event is triggered.

Returns:



123
124
125
126
 
# File 'lib/discorb/client.rb', line 123

def once(event_name, id: nil, **metadata, &block)
  metadata[:once] = true
  on(event_name, id: id, **metadata, &block)
end

#remove_event(event_name, id) -> Object

Remove event by ID.

Parameters:

  • event_name (Symbol) —

    The name of the event.

  • id (Symbol) —

    The ID of the event.



134
135
136
 
# File 'lib/discorb/client.rb', line 134

def remove_event(event_name, id)
  @events[event_name].delete_if { |e| e.id == id }
end

#run(token = nil) -> Object

Note:

This method behavior will change by CLI.

Note:

If the token is nil, you should use discorb run with the -t or --token option.

Starts the client.

Parameters:

  • token (String, nil) (defaults to: nil) —

    The token to use.

See Also:



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
 
# File 'lib/discorb/client.rb', line 399

def run(token = nil)
  token ||= ENV["DISCORB_CLI_TOKEN"]
  raise ArgumentError, "Token is not specified, and -t/--token is not specified" if token.nil?
  case ENV["DISCORB_CLI_FLAG"]
  when nil
    start_client(token)
  when "run"
    require "json"
    options = JSON.parse(ENV["DISCORB_CLI_OPTIONS"], symbolize_names: true)
    Process.daemon if options[:daemon]
    setup_commands(token) if options[:setup]
    if options[:log_level]
      if options[:log_level] == "none"
        @log.out = nil
      else
        @log.out = case options[:log_file]
          when nil, "stderr"
            $stderr
          when "stdout"
            $stdout
          else
            ::File.open(options[:log_file], "a")
          end
        @log.level = options[:log_level].to_sym
        @log.colorize_log = case options[:log_color]
          when nil
            if @log.out == $stdout || @log.out == $stderr
              true
            else
              false
            end
          when true, false
            options[:log_color]
          end
      end
    end
    start_client(token)
  when "setup"
    guild_ids = "global"
    if guilds = ENV["DISCORB_SETUP_GUILDS"]
      guild_ids = guilds.split(",")
    end
    if guild_ids == ["global"]
      guild_ids = false
    end
    setup_commands(token, guild_ids: guild_ids).wait
  end
end

#update_presence(activity = nil, status: nil) -> Object Also known as: change_presence

Update presence of the client.

Parameters:

  • activity (Discorb::Activity) (defaults to: nil) —

    The activity to update.

  • status (:online, :idle, :dnd, :invisible) (defaults to: nil) —

    The status to update.



303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/discorb/client.rb', line 303

def update_presence(activity = nil, status: nil)
  payload = {}
  if !activity.nil?
    payload[:activities] = [activity.to_hash]
  end
  payload[:status] = status unless status.nil?
  if @connection
    Async do
      send_gateway(3, **payload)
    end
  else
    @identify_presence = payload
  end
end