discordrb 2.1.3 → 3.0.0

data/lib/discordrb/cache.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'discordrb/api'
+require 'discordrb/api/server'
+require 'discordrb/api/invite'
+require 'discordrb/api/user'
 require 'discordrb/data'
 
 module Discordrb
@@ -15,7 +18,7 @@ module Discordrb
       @servers = {}
 
       @channels = {}
-      @private_channels = {}
+      @pm_channels = {}
 
       @restricted_channels = []
     end
@@ -36,7 +39,7 @@ module Discordrb
 
       begin
         begin
-          response = API.channel(token, id)
+          response = API::Channel.resolve(token, id)
         rescue RestClient::ResourceNotFound
           return nil
         end
@@ -49,6 +52,8 @@ module Discordrb
       end
     end
 
+    alias_method :group_channel, :channel
+
     # Gets a user by its ID.
     # @note This can only resolve users known by the bot (i.e. that share a server with the bot).
     # @param id [Integer] The user ID that should be resolved.
@@ -59,7 +64,7 @@ module Discordrb
 
       LOGGER.out("Resolving user #{id}")
       begin
-        response = API.user(token, id)
+        response = API::User.resolve(token, id)
       rescue RestClient::ResourceNotFound
         return nil
       end
@@ -77,7 +82,7 @@ module Discordrb
 
       LOGGER.out("Resolving server #{id}")
       begin
-        response = API.server(token, id)
+        response = API::Server.resolve(token, id)
       rescue RestClient::ResourceNotFound
         return nil
       end
@@ -85,20 +90,21 @@ module Discordrb
       @servers[id] = server
     end
 
-    # Gets a member by both IDs
-    # @param server_id [Integer] The server ID for which a member should be resolved
+    # Gets a member by both IDs, or `Server` and user ID.
+    # @param server_or_id [Server, Integer] The `Server` or server ID for which a member should be resolved
     # @param user_id [Integer] The ID of the user that should be resolved
     # @return [Member, nil] The member identified by the IDs, or `nil` if none could be found
-    def member(server_id, user_id)
-      server_id = server_id.resolve_id
+    def member(server_or_id, user_id)
+      server_id = server_or_id.resolve_id
       user_id = user_id.resolve_id
 
-      server = self.server(server_id)
+      server = server_or_id.is_a?(Server) ? server_or_id : self.server(server_id)
+
       return server.member(user_id) if server.member_cached?(user_id)
 
       LOGGER.out("Resolving member #{server_id} on server #{user_id}")
       begin
-        response = API.member(token, server_id, user_id)
+        response = API::Server.resolve_member(token, server_id, user_id)
       rescue RestClient::ResourceNotFound
         return nil
       end
@@ -106,21 +112,22 @@ module Discordrb
       server.cache_member(member)
     end
 
-    # Creates a private channel for the given user ID, or if one exists already, returns that one.
+    # Creates a PM channel for the given user ID, or if one exists already, returns that one.
     # It is recommended that you use {User#pm} instead, as this is mainly for internal use. However,
     # usage of this method may be unavoidable if only the user ID is known.
     # @param id [Integer] The user ID to generate a private channel for.
     # @return [Channel] A private channel for that user.
-    def private_channel(id)
+    def pm_channel(id)
       id = id.resolve_id
-      debug("Creating private channel with user id #{id}")
-      return @private_channels[id] if @private_channels[id]
-
-      response = API.create_private(token, @profile.id, id)
+      return @pm_channels[id] if @pm_channels[id]
+      debug("Creating pm channel with user id #{id}")
+      response = API::User.create_pm(token, id)
       channel = Channel.new(JSON.parse(response), self)
-      @private_channels[id] = channel
+      @pm_channels[id] = channel
     end
 
+    alias_method :private_channel, :pm_channel
+
     # Ensures a given user object is cached and if not, cache it from the given data hash.
     # @param data [Hash] A data hash representing a user.
     # @return [User] the user represented by the data hash.
@@ -158,15 +165,7 @@ module Discordrb
     # Requests member chunks for a given server ID.
     # @param id [Integer] The server ID to request chunks for.
     def request_chunks(id)
-      chunk_packet = {
-        op: 8,
-        d: {
-          guild_id: id,
-          query: '',
-          limit: 0
-        }
-      }.to_json
-      @ws.send(chunk_packet)
+      @gateway.send_request_members(id, '', 0)
     end
 
     # Gets the code for an invite.
@@ -189,13 +188,13 @@ module Discordrb
     # @return [Invite] The invite with information about the given invite URL.
     def invite(invite)
       code = resolve_invite_code(invite)
-      Invite.new(JSON.parse(API.resolve_invite(token, code)), self)
+      Invite.new(JSON.parse(API::Invite.resolve(token, code)), self)
     end
 
     # Finds a channel given its name and optionally the name of the server it is in.
     # @param channel_name [String] The channel to search for.
     # @param server_name [String] The server to search for, or `nil` if only the channel should be searched for.
-    # @param type [String, nil] The type of channel to search for (`'text'` or `'voice'`), or `nil` if either type of
+    # @param type [Integer, nil] The type of channel to search for (0: text, 1: private, 2: voice, 3: group), or `nil` if any type of
     #   channel should be searched for
     # @return [Array<Channel>] The array of channels that were found. May be empty if none were found.
     def find_channel(channel_name, server_name = nil, type: nil)

data/lib/discordrb/commands/command_bot.rb

@@ -32,18 +32,20 @@ module Discordrb::Commands
     #     "hitest". Don't forget to put spaces in if you need them!
     #   * An array of prefixes. Those will behave similarly to setting one string as a prefix, but instead of only one
     #     string, any of the strings in the array can be used.
-    #   * Something Proc-like (responds to :call) that takes a string as an argument (the message) and returns either
-    #     the command chain in raw form or `nil` if the given string shouldn't be parsed. This can be used to make more
-    #     complicated dynamic prefixes, or even something else entirely (suffixes, or most adventurous, infixes).
+    #   * Something Proc-like (responds to :call) that takes a {Message} object as an argument and returns either
+    #     the command chain in raw form or `nil` if the given message shouldn't be parsed. This can be used to make more
+    #     complicated dynamic prefixes (e. g. based on server), or even something else entirely (suffixes, or most
+    #     adventurous, infixes).
     # @option attributes [true, false] :advanced_functionality Whether to enable advanced functionality (very powerful
     #   way to nest commands into chains, see https://github.com/meew0/discordrb/wiki/Commands#command-chain-syntax
-    #   for info. Default is true.
+    #   for info. Default is false.
     # @option attributes [Symbol, Array<Symbol>, false] :help_command The name of the command that displays info for
     #   other commands. Use an array if you want to have aliases. Default is "help". If none should be created, use
     #   `false` as the value.
     # @option attributes [String] :command_doesnt_exist_message The message that should be displayed if a user attempts
     #   to use a command that does not exist. If none is specified, no message will be displayed. In the message, you
     #   can use the string '%command%' that will be replaced with the name of the command.
+    # @option attributes [String] :no_permission_message The message to be displayed when `NoPermission` error is raised.
     # @option attributes [true, false] :spaces_allowed Whether spaces are allowed to occur between the prefix and the
     #   command. Default is false.
     # @option attributes [String] :previous Character that should designate the result of the previous command in
@@ -62,18 +64,18 @@ module Discordrb::Commands
     #   :advanced_functionality). Default is '"'.
     def initialize(attributes = {})
       super(
-        email: attributes[:email],
-        password: attributes[:password],
         log_mode: attributes[:log_mode],
         token: attributes[:token],
         application_id: attributes[:application_id],
+        client_id: attributes[:client_id],
         type: attributes[:type],
         name: attributes[:name],
         fancy_log: attributes[:fancy_log],
         suppress_ready: attributes[:suppress_ready],
         parse_self: attributes[:parse_self],
         shard_id: attributes[:shard_id],
-        num_shards: attributes[:num_shards])
+        num_shards: attributes[:num_shards],
+        redact_token: attributes[:redact_token])
 
       @prefix = attributes[:prefix]
       @attributes = {
@@ -81,12 +83,15 @@ module Discordrb::Commands
         advanced_functionality: attributes[:advanced_functionality].nil? ? false : attributes[:advanced_functionality],
 
         # The name of the help command (that displays information to other commands). False if none should exist
-        help_command: (attributes[:help_command].is_a? FalseClass) ? nil : (attributes[:help_command] || :help),
+        help_command: attributes[:help_command].is_a?(FalseClass) ? nil : (attributes[:help_command] || :help),
 
         # The message to display for when a command doesn't exist, %command% to get the command name in question and nil for no message
         # No default value here because it may not be desired behaviour
         command_doesnt_exist_message: attributes[:command_doesnt_exist_message],
 
+        # The message to be displayed when `NoPermission` error is raised.
+        no_permission_message: attributes[:no_permission_message],
+
         # Spaces allowed between prefix and command
         spaces_allowed: attributes[:spaces_allowed].nil? ? false : attributes[:spaces_allowed],
 
@@ -125,8 +130,13 @@ module Discordrb::Commands
           return "The command `#{command_name}` does not exist!" unless command
           desc = command.attributes[:description] || '*No description available*'
           usage = command.attributes[:usage]
+          parameters = command.attributes[:parameters]
           result = "**`#{command_name}`**: #{desc}"
           result += "\nUsage: `#{usage}`" if usage
+          if parameters
+            result += "\nAccepted Parameters:"
+            parameters.each { |p| result += "\n    `#{p}`" }
+          end
           result
         else
           available_commands = @commands.values.reject { |c| !c.attributes[:help_available] }
@@ -162,7 +172,8 @@ module Discordrb::Commands
         return
       end
       if permission?(event.author, command.attributes[:permission_level], event.server) &&
-         required_permissions?(event.author, command.attributes[:required_permissions], event.channel)
+         required_permissions?(event.author, command.attributes[:required_permissions], event.channel) &&
+         required_roles?(event.author, command.attributes[:required_roles])
         event.command = command
         result = command.call(event, arguments, chained)
         stringify(result)
@@ -170,6 +181,9 @@ module Discordrb::Commands
         event.respond command.attributes[:permission_message].gsub('%name%', name.to_s) if command.attributes[:permission_message]
         nil
       end
+    rescue Discordrb::Errors::NoPermission
+      event.respond @attributes[:no_permission_message] unless @attributes[:no_permission_message].nil?
+      raise
     end
 
     # Executes a command in a simple manner, without command chains or permissions.
@@ -222,7 +236,7 @@ module Discordrb::Commands
 
       event = CommandEvent.new(message, self)
 
-      chain = trigger?(message.content)
+      chain = trigger?(message)
       return unless chain
 
       # Don't allow spaces between the prefix and the command
@@ -242,9 +256,9 @@ module Discordrb::Commands
     # Check whether a message should trigger command execution, and if it does, return the raw chain
     def trigger?(message)
       if @prefix.is_a? String
-        standard_prefix_trigger(message, @prefix)
+        standard_prefix_trigger(message.content, @prefix)
       elsif @prefix.is_a? Array
-        @prefix.map { |e| standard_prefix_trigger(message, e) }.reduce { |a, e| a || e }
+        @prefix.map { |e| standard_prefix_trigger(message.content, e) }.reduce { |a, e| a || e }
       elsif @prefix.respond_to? :call
         @prefix.call(message)
       end
@@ -261,15 +275,30 @@ module Discordrb::Commands
       end
     end
 
+    def required_roles?(member, required)
+      if required.is_a? Array
+        required.all? do |role|
+          member.role?(role)
+        end
+      else
+        member.role?(role)
+      end
+    end
+
     def execute_chain(chain, event)
       t = Thread.new do
         @event_threads << t
         Thread.current[:discordrb_name] = "ct-#{@current_thread += 1}"
         begin
           debug("Parsing command chain #{chain}")
-          result = (@attributes[:advanced_functionality]) ? CommandChain.new(chain, self).execute(event) : simple_execute(chain, event)
-          result = event.saved_message + (result || '')
-          event.respond result unless result.nil? || result.empty?
+          result = @attributes[:advanced_functionality] ? CommandChain.new(chain, self).execute(event) : simple_execute(chain, event)
+          result = event.drain_into(result)
+
+          if event.file
+            event.send_file(event.file, caption: result)
+          else
+            event.respond result unless result.nil? || result.empty?
+          end
         rescue => e
           log_exception(e)
         ensure

data/lib/discordrb/commands/container.rb

@@ -9,11 +9,11 @@ module Discordrb::Commands
   module CommandContainer
     include RateLimiter
 
-    # @return [Array<Command>] the list of commands this container has.
+    # @return [Hash<Symbol, Command>] hash of command names and commands this container has.
     attr_reader :commands
 
     # Adds a new command to the container.
-    # @param name [Symbol] The name of the command to add.
+    # @param name [Symbol, Array<Symbol>] The name of the command to add, or an array of multiple names for the command
     # @param attributes [Hash] The attributes to initialize the command with.
     # @option attributes [Integer] :permission_level The minimum permission level that can use this command, inclusive.
     #   See {CommandBot#set_user_permission} and {CommandBot#set_role_permission}.
@@ -22,6 +22,7 @@ module Discordrb::Commands
     #   the message by setting this option to false.
     # @option attributes [Array<Symbol>] :required_permissions Discord action permissions (e.g. `:kick_members`) that
     #   should be required to use this command. See {Discordrb::Permissions::Flags} for a list.
+    # @option attributes [Array<Role>, Array<#resolve_id>] :required_roles Roles that user should have to use this command.
     # @option attributes [true, false] :chain_usable Whether this command is able to be used inside of a command chain
     #   or sub-chain. Typically used for administrative commands that shouldn't be done carelessly.
     # @option attributes [true, false] :help_available Whether this command is visible in the help command. See the

data/lib/discordrb/commands/parser.rb

@@ -17,11 +17,14 @@ module Discordrb::Commands
         permission_level: attributes[:permission_level] || 0,
 
         # Message to display when a user does not have sufficient permissions to execute a command
-        permission_message: (attributes[:permission_message].is_a? FalseClass) ? nil : (attributes[:permission_message] || "You don't have permission to execute command %name%!"),
+        permission_message: attributes[:permission_message].is_a?(FalseClass) ? nil : (attributes[:permission_message] || "You don't have permission to execute command %name%!"),
 
         # Discord action permissions required to use this command
         required_permissions: attributes[:required_permissions] || [],
 
+        # Roles required to use this command
+        required_roles: attributes[:required_roles] || [],
+
         # Whether this command is usable in a command chain
         chain_usable: attributes[:chain_usable].nil? ? true : attributes[:chain_usable],
 
@@ -34,6 +37,9 @@ module Discordrb::Commands
         # Usage description (for help command and error messages)
         usage: attributes[:usage] || nil,
 
+        # Parameter list (for help command and error messages)
+        parameters: attributes[:parameters] || nil,
+
         # Minimum number of arguments
         min_args: attributes[:min_args] || 0,
 
@@ -82,7 +88,8 @@ module Discordrb::Commands
         return
       end
 
-      @block.call(event, *arguments)
+      result = @block.call(event, *arguments)
+      event.drain_into(result)
     rescue LocalJumpError # occurs when breaking
       nil
     end
@@ -140,7 +147,7 @@ module Discordrb::Commands
         end
 
         if char == @attributes[:sub_chain_start] && !quoted
-          b_start = index if b_level == 0
+          b_start = index if b_level.zero?
           b_level += 1
         end
 
@@ -148,13 +155,13 @@ module Discordrb::Commands
 
         next unless char == @attributes[:sub_chain_end] && !quoted
         b_level -= 1
-        next unless b_level == 0
+        next unless b_level.zero?
         nested = @chain[b_start + 1..index - 1]
         subchain = CommandChain.new(nested, @bot, true)
         result += subchain.execute(event)
       end
 
-      event.respond("Your subchains are mismatched! Make sure you don't have any extra #{@attributes[:sub_chain_start]}'s or #{@attributes[:sub_chain_end]}'s") unless b_level == 0
+      event.respond("Your subchains are mismatched! Make sure you don't have any extra #{@attributes[:sub_chain_start]}'s or #{@attributes[:sub_chain_end]}'s") unless b_level.zero?
 
       @chain = result
 
@@ -222,7 +229,8 @@ module Discordrb::Commands
           executed_chain = divide_chain(old_chain).last
 
           arg[1].to_i.times do
-            new_result += CommandChain.new(executed_chain, @bot).execute(event)
+            chain_result = CommandChain.new(executed_chain, @bot).execute(event)
+            new_result += chain_result if chain_result
           end
 
           result = new_result

data/lib/discordrb/container.rb

@@ -123,6 +123,7 @@ module Discordrb
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String, Integer, User] :from Matches the user whose playing game changes.
     # @option attributes [String] :game Matches the game the user is now playing.
+    # @option attributes [Integer] :type Matches the type of game object (0 game, 1 Twitch stream)
     # @yield The block is executed when the event is raised.
     # @yieldparam event [PlayingEvent] The event that was raised.
     # @return [PlayingEventHandler] The event handler that was registered.
@@ -150,7 +151,7 @@ module Discordrb
 
     # This **event** is raised when a channel is created.
     # @param attributes [Hash] The event's attributes.
-    # @option attributes [String] :type Matches the type of channel that is being created (text or voice)
+    # @option attributes [Integer] :type Matches the type of channel that is being created (0: text, 1: private, 2: voice, 3: group)
     # @option attributes [String] :name Matches the name of the created channel.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [ChannelCreateEvent] The event that was raised.
@@ -161,7 +162,7 @@ module Discordrb
 
     # This **event** is raised when a channel is updated.
     # @param attributes [Hash] The event's attributes.
-    # @option attributes [String] :type Matches the type of channel that is being updated (text or voice)
+    # @option attributes [Integer] :type Matches the type of channel that is being updated (0: text, 1: private, 2: voice, 3: group).
     # @option attributes [String] :name Matches the new name of the channel.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [ChannelUpdateEvent] The event that was raised.
@@ -172,7 +173,7 @@ module Discordrb
 
     # This **event** is raised when a channel is deleted.
     # @param attributes [Hash] The event's attributes.
-    # @option attributes [String] :type Matches the type of channel that is being deleted (text or voice)
+    # @option attributes [Integer] :type Matches the type of channel that is being deleted (0: text, 1: private, 2: voice, 3: group).
     # @option attributes [String] :name Matches the name of the deleted channel.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [ChannelDeleteEvent] The event that was raised.
@@ -181,6 +182,30 @@ module Discordrb
       register_event(ChannelDeleteEvent, attributes, block)
     end
 
+    # This **event** is raised when a recipient is added to a group channel.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String] :name Matches the name of the group channel that the recipient is added to.
+    # @option attributes [#resolve_id] :owner_id Matches the id of the group channel's owner.
+    # @option attributes [#resolve_id] :id Matches the id of the recipient added to the group channel.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelRecipientAddEvent] The event that was raised.
+    # @return [ChannelRecipientAddHandler] The event handler that was registered.
+    def channel_recipient_add(attributes = {}, &block)
+      register_event(ChannelRecipientAddEvent, attributes, block)
+    end
+
+    # This **event** is raised when a recipient is removed from a group channel.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String] :name Matches the name of the group channel that the recipient is added to.
+    # @option attributes [#resolve_id] :owner_id Matches the id of the group channel's owner.
+    # @option attributes [#resolve_id] :id Matches the id of the recipient removed from the group channel.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelRecipientRemoveEvent] The event that was raised.
+    # @return [ChannelRecipientRemoveHandler] The event handler that was registered.
+    def channel_recipient_remove(attributes = {}, &block)
+      register_event(ChannelRecipientRemoveEvent, attributes, block)
+    end
+
     # This **event** is raised when a user's voice state changes.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String, Integer, User] :from Matches the user that sent the message.
@@ -312,6 +337,8 @@ module Discordrb
     end
 
     alias_method :private_message, :pm
+    alias_method :direct_message, :pm
+    alias_method :dm, :pm
 
     # Removes an event handler from this container. If you're looking for a way to do temporary events, I recommend
     # {Await}s instead of this.