discordrb 3.2.1 → 3.3.0

data/lib/discordrb/errors.rb

@@ -102,6 +102,9 @@ module Discordrb
     # Unknown User
     UnknownUser = Code(10_013)
 
+    # Unknown Emoji
+    UnknownEmoji = Code(10_014)
+
     # Bots cannot use this endpoint
     EndpointNotForBots = Code(20_001)
 
@@ -114,6 +117,18 @@ module Discordrb
     # Maximum number of friends reached (1000)
     FriendLimitReached = Code(30_002)
 
+    # Maximum number of pins reached (50)
+    PinLimitReached = Code(30_003)
+
+    # Maximum number of guild roles reached (250)
+    RoleLimitReached = Code(30_005)
+
+    # Too many reactions
+    ReactionLimitReached = Code(30_010)
+
+    # Maximum number of guild channels reached (500)
+    ChannelLimitReached = Code(30_013)
+
     # Unauthorized
     Unauthorized = Unauthorised = Code(40_001)
 
@@ -124,7 +139,7 @@ module Discordrb
     InvalidAccountType = Code(50_002)
 
     # Cannot execute action on a DM channel
-    InvalidForDM = Code(50_003)
+    InvalidActionForDM = Code(50_003)
 
     # Embed Disabled
     EmbedDisabled = Code(50_004)
@@ -164,5 +179,23 @@ module Discordrb
 
     # Provided too few or too many messages to delete. Must provide at least 2 and fewer than 100 messages to delete.
     InvalidBulkDeleteCount = Code(50_016)
+
+    # A message can only be pinned to the channel it was sent in
+    CannotPinInDifferentChannel = Code(50_019)
+
+    # Cannot execute action on a system message
+    InvalidActionForSystemMessage = Code(50_021)
+
+    # A message provided was too old to bulk delete
+    MessageTooOld = Code(50_034)
+
+    # Invalid Form Body
+    InvalidFormBody = Code(50_035)
+
+    # An invite was accepted to a guild the application's bot is not in
+    MissingBotMember = Code(50_036)
+
+    # Reaction Blocked
+    ReactionBlocked = Code(90_001)
   end
 end

data/lib/discordrb/events/generic.rb

@@ -19,7 +19,7 @@ module Discordrb::Events
   #  2. A single attribute, negated
   #  3. An array of attributes, not negated
   #  4. An array of attributes, not negated
-  # Note that it doesn't allow an array of negated attributes. For info on negation stuff, see {not!}
+  # Note that it doesn't allow an array of negated attributes. For info on negation stuff, see {::#not!}
   # @param attributes [Object, Array<Object>, Negated<Object>, Negated<Array<Object>>, nil] One or more attributes to
   #   compare to the to_check value.
   # @param to_check [Object] What to compare the attributes to.

data/lib/discordrb/events/guilds.rb

@@ -82,6 +82,7 @@ module Discordrb::Events
       process_emoji(data)
     end
 
+    # @!visibility private
     def process_emoji(data)
       @emoji = data['emojis'].map do |e|
         @server.emoji[e['id']]

data/lib/discordrb/events/message.rb

@@ -12,9 +12,22 @@ module Discordrb::Events
     # Sends a message to the channel this message was sent in, right now. It is usually preferable to use {#<<} instead
     # because it avoids rate limiting problems
     # @param content [String] The message to send to the channel
+    # @param tts [true, false] Whether or not this message should be sent using Discord text-to-speech.
+    # @param embed [Hash, Discordrb::Webhooks::Embed, nil] The rich embed to append to this message.
     # @return [Discordrb::Message] the message that was sent
-    def send_message(content)
-      channel.send_message(content)
+    def send_message(content, tts = false, embed = nil)
+      channel.send_message(content, tts, embed)
+    end
+
+    # The same as {#send_message}, but yields a {Webhooks::Embed} for easy building of embedded content inside a block.
+    # @see Channel#send_embed
+    # @param message [String] The message that should be sent along with the embed. If this is the empty string, only the embed will be shown.
+    # @param embed [Discordrb::Webhooks::Embed, nil] The embed to start the building process with, or nil if one should be created anew.
+    # @yield [embed] Yields the embed to allow for easy building inside a block.
+    # @yieldparam embed [Discordrb::Webhooks::Embed] The embed from the parameters, or a new one.
+    # @return [Message] The resulting message.
+    def send_embed(message = '', embed = nil, &block)
+      channel.send_embed(message, embed, &block)
     end
 
     # Sends a temporary message to the channel this message was sent in, right now.
@@ -99,20 +112,14 @@ module Discordrb::Events
       @file = nil
     end
 
-    # Sends a message to the channel this message was sent in, right now. It is usually preferable to use {#<<} instead
-    # because it avoids rate limiting problems
-    # @param content [String] The message to send to the channel
-    # @return [Discordrb::Message] the message that was sent
-    def send_message(content)
-      @message.channel.send_message(content)
-    end
-
     # Sends file with a caption to the channel this message was sent in, right now.
     # It is usually preferable to use {#<<} and {#attach_file} instead
     # because it avoids rate limiting problems
     # @param file [File] The file to send to the channel
     # @param caption [String] The caption attached to the file
     # @return [Discordrb::Message] the message that was sent
+    # @example Send a file from disk
+    #   event.send_file(File.open('rubytaco.png', 'r'))
     def send_file(file, caption: nil)
       @message.channel.send_file(file, caption: caption)
     end
@@ -129,7 +136,6 @@ module Discordrb::Events
     # Detaches a file from the message event.
     def detach_file
       @file = nil
-      nil
     end
 
     # @return [true, false] whether or not this message was sent by the bot itself
@@ -165,7 +171,7 @@ module Discordrb::Events
           if a.is_a? String
             e.end_with? a
           elsif a.is_a? Regexp
-            a.match(e) ? e.end_with?(a.match(e)[-1]) : false
+            !(e =~ Regexp.new("#{a}$")).nil?
           end
         end,
         matches_all(@attributes[:containing] || @attributes[:contains], event.content) do |a, e|

data/lib/discordrb/events/presence.rb

@@ -65,17 +65,22 @@ module Discordrb::Events
     # @return [String] the URL to the stream
     attr_reader :url
 
+    # @return [String] what the player is currently doing (ex. game being streamed)
+    attr_reader :details
+
     # @return [Integer] the type of play. 0 = game, 1 = Twitch
     attr_reader :type
 
     def initialize(data, bot)
       @bot = bot
 
+      @server = bot.server(data['guild_id'].to_i)
       @user = bot.user(data['user']['id'].to_i)
       @game = data['game'] ? data['game']['name'] : nil
-      @server = bot.server(data['guild_id'].to_i)
-      @url = data['game'] ? data['game']['url'] : nil
       @type = data['game'] ? data['game']['type'].to_i : nil
+      # Handle optional 'game' fields safely
+      @url = data['game'] && data['game']['url'] ? data['game']['url'] : nil
+      @details = data['game'] && data['game']['details'] ? data['game']['details'] : nil
     end
   end
 

data/lib/discordrb/events/reactions.rb

@@ -5,7 +5,7 @@ require 'discordrb/data'
 
 module Discordrb::Events
   # Generic superclass for events about adding and removing reactions
-  class ReactionEvent
+  class ReactionEvent < Event
     include Respondable
 
     # @return [Emoji] the emoji that was reacted with.
@@ -20,10 +20,14 @@ module Discordrb::Events
       @channel_id = data['channel_id'].to_i
     end
 
-    # @return [User] the user that reacted to this message.
+    # @return [User, Member] the user that reacted to this message, or member if a server exists.
     def user
       # Cache the user so we don't do requests all the time
-      @user ||= @bot.user(@user_id)
+      @user ||= if server
+                  @server.member(@user_id)
+                else
+                  @bot.user(@user_id)
+                end
     end
 
     # @return [Message] the message that was reacted to.
@@ -35,6 +39,11 @@ module Discordrb::Events
     def channel
       @channel ||= @bot.channel(@channel_id)
     end
+
+    # @return [Server, nil] the server that was reacted in. If reacted in a PM channel, it will be nil.
+    def server
+      @server ||= channel.server
+    end
   end
 
   # Generic superclass for event handlers pertaining to adding and removing reactions
@@ -70,7 +79,7 @@ module Discordrb::Events
   class ReactionRemoveEventHandler < ReactionEventHandler; end
 
   # Event raised when somebody removes all reactions from a message
-  class ReactionRemoveAllEvent
+  class ReactionRemoveAllEvent < Event
     include Respondable
 
     def initialize(data, bot)

data/lib/discordrb/events/roles.rb

@@ -12,6 +12,11 @@ module Discordrb::Events
     # @return [Server] the server on which a role got created
     attr_reader :server
 
+    # @!attribute [r] name
+    #   @return [String] this role's name
+    #   @see Role#name
+    delegate :name, to: :role
+
     def initialize(data, bot)
       @bot = bot
 
@@ -68,12 +73,8 @@ module Discordrb::Events
       return false unless event.is_a? ServerRoleDeleteEvent
 
       [
-        matches_all(@attributes[:name], event.name) do |a, e|
-          a == if a.is_a? String
-                 e.to_s
-               else
-                 e
-               end
+        matches_all(@attributes[:id], event.id) do |a, e|
+          a.resolve_id == e.resolve_id
         end
       ].reduce(true, &:&)
     end

data/lib/discordrb/events/typing.rb

@@ -10,7 +10,7 @@ module Discordrb::Events
     # @return [Channel] the channel on which a user started typing.
     attr_reader :channel
 
-    # @return [Member] the user that started typing.
+    # @return [User, Member, Recipient] the user that started typing.
     attr_reader :user
     alias_method :member, :user
 

data/lib/discordrb/events/webhooks.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'discordrb/events/generic'
+require 'discordrb/data'
+
+module Discordrb::Events
+  # Event raised when a webhook is updated
+  class WebhookUpdateEvent < Event
+    # @return [Server] the server where the webhook updated
+    attr_reader :server
+
+    # @return [Channel] the channel the webhook is associated to
+    attr_reader :channel
+
+    def initialize(data, bot)
+      @bot = bot
+
+      @server = bot.server(data['guild_id'].to_i)
+      @channel = bot.channel(data['channel_id'].to_i)
+    end
+  end
+
+  # Event handler for {WebhookUpdateEvent}
+  class WebhookUpdateEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? WebhookUpdateEvent
+
+      [
+        matches_all(@attributes[:server], event.server) do |a, e|
+          a == if a.is_a? String
+                 e.name
+               elsif a.is_a? Integer
+                 e.id
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:channel], event.channel) do |a, e|
+          if a.is_a? String
+            # Make sure to remove the "#" from channel names in case it was specified
+            a.delete('#') == e.name
+          elsif a.is_a? Integer
+            a == e.id
+          else
+            a == e
+          end
+        end,
+        matches_all(@attributes[:webhook], event) do |a, e|
+          a == if a.is_a? String
+                 e.name
+               elsif a.is_a? Integer
+                 e.id
+               else
+                 e
+               end
+        end
+      ].reduce(true, &:&)
+    end
+  end
+end

data/lib/discordrb/gateway.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file uses code from Websocket::Client::Simple, licensed under the following license:
 #
 # Copyright (c) 2013-2014 Sho Hashimoto
@@ -100,6 +102,7 @@ module Discordrb
       @invalid = false
     end
 
+    # Flags this session as suspended, so we know not to try and send heartbeats, etc. to the gateway until we've reconnected
     def suspend
       @suspended = true
     end
@@ -108,10 +111,12 @@ module Discordrb
       @suspended
     end
 
+    # Flags this session as no longer being suspended, so we can resume
     def resume
       @suspended = false
     end
 
+    # Flags this session as being invalid
     def invalidate
       @invalid = true
     end
@@ -140,7 +145,7 @@ module Discordrb
     # @return [true, false] whether or not this gateway should check for heartbeat ACKs.
     attr_accessor :check_heartbeat_acks
 
-    def initialize(bot, token, shard_key = nil)
+    def initialize(bot, token, shard_key = nil, compress_mode = :stream)
       @token = token
       @bot = bot
 
@@ -152,6 +157,8 @@ module Discordrb
       @ws_success = false
 
       @check_heartbeat_acks = true
+
+      @compress_mode = compress_mode
     end
 
     # Connect to the gateway server in a separate thread
@@ -167,7 +174,7 @@ module Discordrb
       LOGGER.debug('Confirmation received! Exiting run.')
     end
 
-    # Prevents all further execution until the websocket thread stops (e. g. through a closed connection).
+    # Prevents all further execution until the websocket thread stops (e.g. through a closed connection).
     def sync
       @ws_thread.join
     end
@@ -260,13 +267,14 @@ module Discordrb
     # Identifies to Discord with the default parameters.
     # @see #send_identify
     def identify
+      compress = @compress_mode == :large
       send_identify(@token, {
-                      :'$os' => RUBY_PLATFORM,
-                      :'$browser' => 'discordrb',
-                      :'$device' => 'discordrb',
-                      :'$referrer' => '',
-                      :'$referring_domain' => ''
-                    }, true, 100, @shard_key)
+                      '$os': RUBY_PLATFORM,
+                      '$browser': 'discordrb',
+                      '$device': 'discordrb',
+                      '$referrer': '',
+                      '$referring_domain': ''
+                    }, compress, 100, @shard_key)
     end
 
     # Sends an identify packet (op 2). This starts a new session on the current connection and tells Discord who we are.
@@ -347,7 +355,7 @@ module Discordrb
     # Reconnects the gateway connection in a controlled manner.
     # @param attempt_resume [true, false] Whether a resume should be attempted after the reconnection.
     def reconnect(attempt_resume = true)
-      @session.suspend if attempt_resume
+      @session.suspend if @session && attempt_resume
 
       @instant_reconnect = true
       @should_reconnect = true
@@ -392,6 +400,29 @@ module Discordrb
       send_packet(Opcodes::REQUEST_MEMBERS, data)
     end
 
+    # Sends a custom packet over the connection. This can be useful to implement future yet unimplemented functionality
+    # or for testing. You probably shouldn't use this unless you know what you're doing.
+    # @param op [Integer] The opcode the packet should be sent as. Can be one of {Opcodes} or a custom value if
+    #   necessary.
+    # @param packet [Object] Some arbitrary JSON-serialisable data that should be sent as the `d` field.
+    def send_packet(op, packet)
+      data = {
+        op: op,
+        d: packet
+      }
+
+      send(data.to_json)
+    end
+
+    # Sends custom raw data over the connection. Only useful for testing; even if you know what you're doing you
+    # probably want to use {#send_packet} instead.
+    # @param data [String] The data to send.
+    # @param type [Symbol] The type the WebSocket frame should have; either `:text`, `:binary`, `:ping`, `:pong`, or
+    #   `:close`.
+    def send_raw(data, type = :text)
+      send(data, type)
+    end
+
     private
 
     def setup_heartbeats(interval)
@@ -440,7 +471,7 @@ module Discordrb
           wait_for_reconnect
         end
 
-        # Restart the loop, i. e. reconnect
+        # Restart the loop, i.e. reconnect
       end
     end
 
@@ -462,14 +493,19 @@ module Discordrb
 
       if secure_uri?(uri)
         ctx = OpenSSL::SSL::SSLContext.new
-        ctx.ssl_version = 'SSLv23'
-        ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE # use VERIFY_PEER for verification
 
-        cert_store = OpenSSL::X509::Store.new
-        cert_store.set_default_paths
-        ctx.cert_store = cert_store
+        if ENV['DISCORDRB_SSL_VERIFY_NONE']
+          ctx.ssl_version = 'SSLv23'
+          ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE # use VERIFY_PEER for verification
 
-        socket = ::OpenSSL::SSL::SSLSocket.new(socket, ctx)
+          cert_store = OpenSSL::X509::Store.new
+          cert_store.set_default_paths
+          ctx.cert_store = cert_store
+        else
+          ctx.set_params ssl_version: :TLSv1_2
+        end
+
+        socket = OpenSSL::SSL::SSLSocket.new(socket, ctx)
         socket.connect
       end
 
@@ -478,7 +514,7 @@ module Discordrb
 
     # Whether the URI is secure (connection should be encrypted)
     def secure_uri?(uri)
-      %w(https wss).include? uri.scheme
+      %w[https wss].include? uri.scheme
     end
 
     # The port we should connect to, if the URI doesn't have one set.
@@ -497,8 +533,13 @@ module Discordrb
       # Append a slash in case it's not there (I'm not sure how well WSCS handles it otherwise)
       raw_url += '/' unless raw_url.end_with? '/'
 
-      # Add the parameters we want
-      raw_url + "?encoding=json&v=#{GATEWAY_VERSION}"
+      query = if @compress_mode == :stream
+                "?encoding=json&v=#{GATEWAY_VERSION}&compress=zlib-stream"
+              else
+                "?encoding=json&v=#{GATEWAY_VERSION}"
+              end
+
+      raw_url + query
     end
 
     def connect
@@ -511,6 +552,9 @@ module Discordrb
       # Parse it
       gateway_uri = URI.parse(url)
 
+      # Zlib context for this gateway connection
+      @zlib_reader = Zlib::Inflate.new
+
       # Connect to the obtained URI with a socket
       @socket = obtain_socket(gateway_uri)
       LOGGER.debug('Obtained socket')
@@ -537,6 +581,11 @@ module Discordrb
 
       until @closed
         begin
+          unless @socket
+            LOGGER.warn('Socket is nil in websocket_loop! Reconnecting')
+            handle_internal_close('Socket is nil in websocket_loop')
+          end
+
           recv_data = nil
 
           # Get some data from the socket, synchronised so the socket can't be closed during this
@@ -593,10 +642,23 @@ module Discordrb
       LOGGER.log_exception(e)
     end
 
+    ZLIB_SUFFIX = "\x00\x00\xFF\xFF".b.freeze
+
     def handle_message(msg)
-      if msg.byteslice(0) == 'x'
-        # The message is compressed, inflate it
-        msg = Zlib::Inflate.inflate(msg)
+      if @compress_mode == :large
+        if msg.byteslice(0) == 'x'
+          # The message is compressed, inflate it
+          msg = Zlib::Inflate.inflate(msg)
+        end
+      elsif @compress_mode == :stream
+        # Write deflated string to buffer
+        @zlib_reader << msg
+
+        # Check if message ends in `ZLIB_SUFFIX`
+        return if msg.bytesize < 4 || msg.byteslice(-4, 4) != ZLIB_SUFFIX
+
+        # Inflate the deflated buffer
+        msg = @zlib_reader.inflate('')
       end
 
       # Parse packet
@@ -645,7 +707,7 @@ module Discordrb
         # The RESUMED event is received after a successful op 6 (resume). It does nothing except tell the bot the
         # connection is initiated (like READY would). Starting with v5, it doesn't set a new heartbeat interval anymore
         # since that is handled by op 10 (HELLO).
-        LOGGER.good 'Resumed'
+        LOGGER.info 'Resumed'
         return
       end
 
@@ -726,15 +788,6 @@ module Discordrb
       end
     end
 
-    def send_packet(op, packet)
-      data = {
-        op: op,
-        d: packet
-      }
-
-      send(data.to_json)
-    end
-
     def send(data, type = :text)
       LOGGER.out(data)