discordrb 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c072a97e659190bb7de8ba2f2ebe7483b7064b20
-  data.tar.gz: dafe2d7da6257050652b82c864478d3a3225c641
+  metadata.gz: 63b47e7d0728741bab426ae48763d83324c2096d
+  data.tar.gz: bc0bb96095c0f670d172c054673f78641dadc061
 SHA512:
-  metadata.gz: 9891d792cbe3c1b34b775a90a8829e136fc0f80a7166a98e4456d57a8833bd3a7d96c8cd512ffaa2cb25c9881c724a25a9eb209395117e06250c5c979abbb506
-  data.tar.gz: 5f67ff2dcaa46e19a4c5bf94c67838a0f21bbc47831553a585278018f0b4b3af1372badf2c3b68d5fad528f2ee9536ea57b009168e162f58c854bd508f124a45
+  metadata.gz: 64aa1b967a77ab2b0dc0d2ce1679436d2da83f2b332c803b2564c08eabef65ab65fb6499ea861cf9514f19cf77c76120f2b7b2f3eb5289b484e7031dc2c0f83e
+  data.tar.gz: 928cebe04848e4aa4db8427c1e821f6a03dbade08bca3d7d7da0e13498f896bef996024e978826a2242c0cbf3c63115072e674ed808e5c1f81abf3dff44568ec

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 3.1.0
+
+- Emoji handling support ([#226](https://github.com/meew0/discordrb/pull/226), thanks @greenbigfrog)
+- A `channels` attribute has been added to `CommandBot` as well as `Command` to restrict the channels in which either of the two works ([#249](https://github.com/meew0/discordrb/pull/249), thanks @Xzanth)
+- The bulk deletion endpoint is now exposed directly using the `Channel#delete_messages` method ([#235](https://github.com/meew0/discordrb/pull/235), thanks @z64)
+- The internal settings fields for user statuses that cause statuses to persist across restarts can now be modified ([#233](https://github.com/meew0/discordrb/pull/233), thanks @Daniel-Worrall)
+- A few examples have been added to the docs ([#250](https://github.com/meew0/discordrb/pull/250), thanks @SunDwarf)
+- The specs have been improved; they're still not exhaustive by far but there are at least slightly more now.
+
+### Bugfixes
+
+- Fixed an important bug that caused the logger not to work in some cases. ([#243](https://github.com/meew0/discordrb/pull/243), thanks @Daniel-Worrall)
+- Fixed logger token redaction.
+- `unavailable_servers` should no longer crash the bot due to being nil in some cases ([#244](https://github.com/meew0/discordrb/pull/244), thanks @Daniel-Worrall)
+- `Profile#on` for member resolution is now no longer overwritten by an alias for `#online` ([#247](https://github.com/meew0/discordrb/pull/247), thanks @Daniel-Worrall)
+- A `CommandBot` without any commands should no longer crash when receiving a message that triggers it ([#242](https://github.com/meew0/discordrb/issues/242))
+- Changing nicknames works again, it has apparently been broken in 3.0.0.
+
 ## 3.0.2
 
 - A small change to how CommandBot parameter lists are formatted ([#240](https://github.com/meew0/discordrb/pull/240), thanks @FormalHellhound)

data/README.md

@@ -86,7 +86,7 @@ You can make a simple bot like this:
 ```ruby
 require 'discordrb'
 
-bot = Discordrb::Bot.new token: '<token here>', application_id: 168123456789123456
+bot = Discordrb::Bot.new token: '<token here>', client_id: 168123456789123456
 
 bot.message(with_text: 'Ping!') do |event|
   event.respond 'Pong!'

data/discordrb.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/meew0/discordrb'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']

data/lib/discordrb/api.rb

@@ -137,6 +137,11 @@ module Discordrb::API
     "#{api_base}/guilds/#{server_id}/widget.png?style=#{style}"
   end
 
+  # Make an emoji icon URL from emoji ID
+  def emoji_icon_url(emoji_id)
+    "https://cdn.discordapp.com/emojis/#{emoji_id}.png"
+  end
+
   # Login to the server
   def login(email, password)
     request(

data/lib/discordrb/api/user.rb

@@ -127,6 +127,19 @@ module Discordrb::API::User
     )
   end
 
+  # Change user status setting
+  def change_status_setting(token, status)
+    Discordrb::API.request(
+      :users_me_settings,
+      nil,
+      :patch,
+      "#{Discordrb::API.api_base}/users/@me/settings",
+      { status: status }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
   # Make an avatar URL from the user and avatar IDs
   def avatar_url(user_id, avatar_id)
     "#{Discordrb::API.api_base}/users/#{user_id}/avatars/#{avatar_id}.jpg"

data/lib/discordrb/await.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'discordrb/container'
-
 module Discordrb
   # Awaits are a way to register new, temporary event handlers on the fly. Awaits can be
   # registered using {Bot#add_await}, {User#await}, {Message#await} and {Channel#await}.

data/lib/discordrb/bot.rb

@@ -152,6 +152,39 @@ module Discordrb
       @servers
     end
 
+    # @overload emoji(id)
+    #   Return an emoji by its ID
+    #   @param id [Integer] The emoji's ID.
+    #   @return emoji [GlobalEmoji, nil] the emoji object. `nil` if the emoji was not found.
+    # @overload emoji
+    #   The list of emoji the bot can use.
+    #   @return [Array<GlobalEmoji>] the emoji available.
+    def emoji(id = nil)
+      gateway_check
+      if id
+        emoji = @emoji.find { |sth| sth.id == id }
+      else
+        emoji = {}
+        @servers.each do |_, server|
+          server.emoji.values.each do |element|
+            emoji[element.name] = GlobalEmoji.new(element, self)
+          end
+        end
+        emoji.values
+      end
+    end
+
+    alias_method :emojis, :emoji
+    alias_method :all_emoji, :emoji
+
+    # Finds an emoji by its name.
+    # @param name [String] The emoji name that should be resolved.
+    # @return [GlobalEmoji, nil] the emoji identified by the name, or `nil` if it couldn't be found.
+    def find_emoji(name)
+      LOGGER.out("Resolving emoji #{name}")
+      emoji.find { |element| element.name == name }
+    end
+
     # The bot's user profile. This special user object can be used
     # to edit user data like the current username (see {Profile#username=}).
     # @return [Profile] The bot's profile that can be used to edit data.
@@ -398,13 +431,23 @@ module Discordrb
       API.update_oauth_application(@token, name, redirect_uris, description, icon)
     end
 
-    # Gets the user from a mention of the user.
-    # @param mention [String] The mention, which should look like <@12314873129>.
-    # @return [User] The user identified by the mention, or `nil` if none exists.
-    def parse_mention(mention)
+    # Gets the user, role or emoji from a mention of the user, role or emoji.
+    # @param mention [String] The mention, which should look like `<@12314873129>`, `<@&123456789>` or `<:Name:126328:>`.
+    # @param server [Server, nil] The server of the associated mention. (recommended for role parsing, to speed things up)
+    # @return [User, Role, Emoji] The user, role or emoji identified by the mention, or `nil` if none exists.
+    def parse_mention(mention, server = nil)
       # Mention format: <@id>
-      return nil unless /<@!?(?<id>\d+)>?/ =~ mention
-      user(id.to_i)
+      if /<@!?(?<id>\d+)>?/ =~ mention
+        user(id.to_i)
+      elsif /<@&(?<id>\d+)>?/ =~ mention
+        return server.role(id) if server
+        servers.each do |element|
+          role = element.role(id)
+          return role unless role.nil?
+        end
+      elsif /<:(\w+):(?<id>\d+)>?/ =~ mention
+        emoji.find { |element| element.id.to_i == id.to_i }
+      end
     end
 
     # Updates presence status.
@@ -812,7 +855,7 @@ module Discordrb
         LOGGER.warn("This means some servers are unavailable due to an outage. Notifying ready now, we'll have to live without these servers")
 
         # Unset the unavailable server count so this doesn't get triggered again
-        @unavailable_servers = nil
+        @unavailable_servers = 0
 
         notify_ready
       end

data/lib/discordrb/commands/command_bot.rb

@@ -50,6 +50,8 @@ module Discordrb::Commands
     #   command. Default is false.
     # @option attributes [true, false] :webhook_commands Whether messages sent by webhooks are allowed to trigger
     #   commands. Default is true.
+    # @option attributes [Array<String, Integer, Channel>] :channels The channels this command bot accepts commands on.
+    #   Superseded if a command has a 'channels' attribute.
     # @option attributes [String] :previous Character that should designate the result of the previous command in
     #   a command chain (see :advanced_functionality). Default is '~'.
     # @option attributes [String] :chain_delimiter Character that should designate that a new command begins in the
@@ -77,7 +79,7 @@ module Discordrb::Commands
         parse_self: attributes[:parse_self],
         shard_id: attributes[:shard_id],
         num_shards: attributes[:num_shards],
-        redact_token: attributes[:redact_token])
+        redact_token: attributes.key?(:redact_token) ? attributes[:redact_token] : true)
 
       @prefix = attributes[:prefix]
       @attributes = {
@@ -100,6 +102,8 @@ module Discordrb::Commands
         # Webhooks allowed to trigger commands
         webhook_commands: attributes[:webhook_commands].nil? ? true : attributes[:webhook_commands],
 
+        channels: attributes[:channels] || [],
+
         # All of the following need to be one character
         # String to designate previous result in command chain
         previous: attributes[:previous] || '~',
@@ -169,19 +173,27 @@ module Discordrb::Commands
     # @param arguments [Array<String>] The arguments to pass to the command.
     # @param chained [true, false] Whether or not it should be executed as part of a command chain. If this is false,
     #   commands that have chain_usable set to false will not work.
+    # @param check_permissions [true, false] Whether permission parameters such as `required_permission` or
+    #   `permission_level` should be checked.
     # @return [String, nil] the command's result, if there is any.
-    def execute_command(name, event, arguments, chained = false)
+    def execute_command(name, event, arguments, chained = false, check_permissions = true)
       debug("Executing command #{name} with arguments #{arguments}")
+      return unless @commands
       command = @commands[name]
+      return unless !check_permissions || channels?(event.channel, @attributes[:channels]) ||
+                    (command && !command.attributes[:channels].nil?)
       unless command
         event.respond @attributes[:command_doesnt_exist_message].gsub('%command%', name.to_s) if @attributes[:command_doesnt_exist_message]
         return
       end
-      if permission?(event.author, command.attributes[:permission_level], event.server) &&
+      return unless !check_permissions || channels?(event.channel, command.attributes[:channels])
+      if (check_permissions &&
+         permission?(event.author, command.attributes[:permission_level], event.server) &&
          required_permissions?(event.author, command.attributes[:required_permissions], event.channel) &&
-         required_roles?(event.author, command.attributes[:required_roles])
+         required_roles?(event.author, command.attributes[:required_roles])) ||
+         !check_permissions
         event.command = command
-        result = command.call(event, arguments, chained)
+        result = command.call(event, arguments, chained, check_permissions)
         stringify(result)
       else
         event.respond command.attributes[:permission_message].gsub('%name%', name.to_s) if command.attributes[:permission_message]
@@ -301,6 +313,20 @@ module Discordrb::Commands
       end
     end
 
+    def channels?(channel, channels)
+      return true if channels.nil? || channels.empty?
+      channels.any? do |c|
+        if c.is_a? String
+          # Make sure to remove the "#" from channel names in case it was specified
+          c.delete('#') == channel.name
+        elsif c.is_a? Fixnum
+          c == channel.id
+        else
+          c == channel
+        end
+      end
+    end
+
     def execute_chain(chain, event)
       t = Thread.new do
         @event_threads << t

data/lib/discordrb/commands/container.rb

@@ -23,6 +23,8 @@ module Discordrb::Commands
     # @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 [Array<String, Integer, Channel>] :channels The channels that this command can be used on. An
+    #   empty array indicates it can be used on any channel. Supersedes the command bot attribute.
     # @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

@@ -25,6 +25,9 @@ module Discordrb::Commands
         # Roles required to use this command
         required_roles: attributes[:required_roles] || [],
 
+        # Channels this command can be used on
+        channels: attributes[:channels] || nil,
+
         # Whether this command is usable in a command chain
         chain_usable: attributes[:chain_usable].nil? ? true : attributes[:chain_usable],
 
@@ -61,8 +64,10 @@ module Discordrb::Commands
     # @param event [CommandEvent] The event to call the command with.
     # @param arguments [Array<String>] The attributes for the command.
     # @param chained [true, false] Whether or not this command is part of a command chain.
+    # @param check_permissions [true, false] Whether the user's permission to execute the command (i.e. rate limits)
+    #   should be checked.
     # @return [String] the result of the execution.
-    def call(event, arguments, chained = false)
+    def call(event, arguments, chained = false, check_permissions = true)
       if arguments.length < @attributes[:min_args]
         event.respond "Too few arguments for command `#{name}`!"
         event.respond "Usage: `#{@attributes[:usage]}`" if @attributes[:usage]
@@ -80,12 +85,14 @@ module Discordrb::Commands
         end
       end
 
-      rate_limited = event.bot.rate_limited?(@attributes[:bucket], event.author)
-      if @attributes[:bucket] && rate_limited
-        if @attributes[:rate_limit_message]
-          event.respond @attributes[:rate_limit_message].gsub('%time%', rate_limited.round(2).to_s)
+      if check_permissions
+        rate_limited = event.bot.rate_limited?(@attributes[:bucket], event.author)
+        if @attributes[:bucket] && rate_limited
+          if @attributes[:rate_limit_message]
+            event.respond @attributes[:rate_limit_message].gsub('%time%', rate_limited.round(2).to_s)
+          end
+          return
         end
-        return
       end
 
       result = @block.call(event, *arguments)

data/lib/discordrb/data.rb

@@ -10,7 +10,6 @@ require 'discordrb/api/channel'
 require 'discordrb/api/server'
 require 'discordrb/api/invite'
 require 'discordrb/api/user'
-require 'discordrb/events/message'
 require 'time'
 require 'base64'
 
@@ -262,7 +261,7 @@ module Discordrb
     end
 
     # Utility function to get a application's icon URL.
-    # @return [String, nil] the URL to the icon image (nil if no iamge is set).
+    # @return [String, nil] the URL to the icon image (nil if no image is set).
     def icon_url
       return nil if @icon_id.nil?
       API.app_icon_url(@id, @icon_id)
@@ -296,6 +295,9 @@ module Discordrb
     # through for example being the server owner or having the Manage Roles permission
     # @param action [Symbol] The permission that should be checked. See also {Permissions::Flags} for a list.
     # @param channel [Channel, nil] If channel overrides should be checked too, this channel specifies where the overrides should be checked.
+    # @example Check if the bot can send messages to a specific channel in a server.
+    #   bot_profile = bot.profile.on(event.server)
+    #   can_send_messages = bot_profile.permission?(:send_messages, channel)
     # @return [true, false] whether or not this user has the permission.
     def permission?(action, channel = nil)
       # If the member is the server owner, it irrevocably has all permissions.
@@ -315,6 +317,8 @@ module Discordrb
     # Manage Roles)
     # @param action [Symbol] The permission that should be checked. See also {Permissions::Flags} for a list.
     # @param channel [Channel, nil] If channel overrides should be checked too, this channel specifies where the overrides should be checked.
+    # @example Check if a member has the Manage Channels permission defined in the server.
+    #   has_manage_channels = member.defined_permission?(:manage_channels)
     # @return [true, false] whether or not this user has the permission defined.
     def defined_permission?(action, channel = nil)
       # Get the permission the user's roles have
@@ -489,6 +493,10 @@ module Discordrb
     # Adds and removes roles from a member.
     # @param add [Role, Array<Role>] The role(s) to add.
     # @param remove [Role, Array<Role>] The role(s) to remove.
+    # @example Remove the 'Member' role from a user, and add the 'Muted' role to them.
+    #   to_add = server.roles.find {|role| role.name == 'Muted'}
+    #   to_remove = server.roles.find {|role| role.name == 'Member'}
+    #   member.modify_roles(to_add, to_remove)
     def modify_roles(add, remove)
       add_role_ids = role_id_array(add)
       remove_role_ids = role_id_array(remove)
@@ -548,7 +556,7 @@ module Discordrb
       if @user.current_bot?
         API::User.change_own_nickname(@bot.token, @server.id, nick)
       else
-        API.change_nickname(@bot.token, @server.id, @user.id, nick)
+        API::Server.update_member(@bot.token, @server.id, @user.id, nick: nick)
       end
     end
 
@@ -676,6 +684,32 @@ module Discordrb
       @avatar_id = new_data[:avatar_id] || @avatar_id
     end
 
+    # Sets the user status setting to Online.
+    # @note Only usable on User accounts.
+    def online
+      update_profile_status_setting('online')
+    end
+
+    # Sets the user status setting to Idle.
+    # @note Only usable on User accounts.
+    def idle
+      update_profile_status_setting('idle')
+    end
+
+    # Sets the user status setting to Do Not Disturb.
+    # @note Only usable on User accounts.
+    def dnd
+      update_profile_status_setting('dnd')
+    end
+
+    alias_method(:busy, :dnd)
+
+    # Sets the user status setting to Invisible.
+    # @note Only usable on User accounts.
+    def invisible
+      update_profile_status_setting('invisible')
+    end
+
     # The inspect method is overwritten to give more useful output
     def inspect
       "<Profile user=#{super}>"
@@ -683,6 +717,11 @@ module Discordrb
 
     private
 
+    # Internal handler for updating the user's status setting
+    def update_profile_status_setting(status)
+      API::User.change_status_setting(@bot.token, status)
+    end
+
     def update_profile_data(new_data)
       API::User.update_profile(@bot.token,
                                nil, nil,
@@ -729,6 +768,11 @@ module Discordrb
       def write(bits)
         @role.send(:packed=, bits, false)
       end
+
+      # The inspect method is overridden, in this case to prevent the token being leaked
+      def inspect
+        "<RoleWriter role=#{@role} token=...>"
+      end
     end
 
     # @!visibility private
@@ -822,7 +866,7 @@ module Discordrb
       @permissions.bits = packed if update_perms
     end
 
-    # Delets this role. This cannot be undone without recreating the role!
+    # Deletes this role. This cannot be undone without recreating the role!
     def delete
       API::Server.delete_role(@bot.token, @server.id, @id)
       @server.delete_role(@id)
@@ -1213,6 +1257,8 @@ module Discordrb
     #   start at the current message.
     # @param after_id [Integer] The ID of the oldest message the retrieval should start at, or nil if it should start
     #   as soon as possible with the specified amount.
+    # @example Count the number of messages in the last 50 messages that contain the letter 'e'.
+    #   message_count = channel.history(50).count {|message| message.content.include? "e"}
     # @return [Array<Message>] the retrieved messages.
     def history(amount, before_id = nil, after_id = nil)
       logs = API::Channel.messages(@bot.token, @id, amount, before_id, after_id)
@@ -1256,6 +1302,16 @@ module Discordrb
       API::Channel.bulk_delete_messages(@bot.token, @id, messages)
     end
 
+    # Deletes a collection of messages
+    # @param messages [Array<Message, Integer>] the messages (or message IDs) to delete. Total must be an amount between 2 and 100 (Discord limitation)
+    # @raise [ArgumentError] if the amount of messages is not a value between 2 and 100
+    def delete_messages(messages)
+      raise ArgumentError, 'Can only delete between 2 and 100 messages!' unless messages.count.between?(2, 100)
+
+      messages.map!(&:resolve_id)
+      API::Channel.bulk_delete_messages(@bot.token, @id, messages)
+    end
+
     # Updates the cached permission overwrites
     # @note For internal use only
     # @!visibility private
@@ -1628,6 +1684,8 @@ module Discordrb
       @edited = !@edited_timestamp.nil?
       @id = data['id'].to_i
 
+      @emoji = []
+
       @mentions = []
 
       data['mentions'].each do |element|
@@ -1657,6 +1715,7 @@ module Discordrb
     end
 
     # Edits this message to have the specified content instead.
+    # You can only edit your own messages.
     # @param new_content [String] the new content the message should have.
     # @return [Message] the resulting message.
     def edit(new_content)
@@ -1700,12 +1759,141 @@ module Discordrb
       !@webhook_id.nil?
     end
 
+    # @!visibility private
+    # @return [Array<String>] the emoji mentions found in the message
+    def scan_for_emoji
+      emoji = @content.split
+      emoji = emoji.grep(/<:(?<name>\w+):(?<id>\d+)>?/)
+      emoji
+    end
+
+    # @return [Array<Emoji>] the emotes that were used/mentioned in this message (Only returns Emoji the bot has access to, else nil).
+    def emoji
+      return if @content.nil?
+
+      emoji = scan_for_emoji
+      emoji.each do |element|
+        @emoji << @bot.parse_mention(element)
+      end
+      @emoji
+    end
+
+    # Check if any emoji got used in this message
+    # @return [true, false] whether or not any emoji got used
+    def emoji?
+      emoji = scan_for_emoji
+      return true unless emoji.empty?
+    end
+
     # The inspect method is overwritten to give more useful output
     def inspect
       "<Message content=\"#{@content}\" id=#{@id} timestamp=#{@timestamp} author=#{@author} channel=#{@channel}>"
     end
   end
 
+  # Server emoji
+  class Emoji
+    include IDObject
+
+    # @return [String] the emoji name
+    attr_reader :name
+
+    # @return [Server] the server of this emoji
+    attr_reader :server
+
+    # @return [Array<Role>] roles this emoji is active for
+    attr_reader :roles
+
+    def initialize(data, bot, server)
+      @bot = bot
+      @roles = nil
+
+      @name = data['name']
+      @server = server
+      @id = data['id'].to_i
+
+      process_roles(data['roles']) if server
+    end
+
+    # @return [String] the layout to mention it (or have it used) in a message
+    def mention
+      "<:#{@name}:#{@id}>"
+    end
+
+    alias_method :use, :mention
+    alias_method :to_s, :mention
+
+    # @return [String] the icon URL of the emoji
+    def icon_url
+      API.emoji_icon_url(@id)
+    end
+
+    # The inspect method is overwritten to give more useful output
+    def inspect
+      "<Emoji name=#{@name} id=#{@id}>"
+    end
+
+    # @!visibility private
+    def process_roles(roles)
+      @roles = []
+      return unless roles
+      roles.each do |role_id|
+        role = server.role(role_id)
+        @roles << role
+      end
+    end
+  end
+
+  # Emoji that is not tailored to a server
+  class GlobalEmoji
+    include IDObject
+
+    # @return [String] the emoji name
+    attr_reader :name
+
+    # @return [Hash<Integer => Array<Role>>] roles this emoji is active for in every server
+    attr_reader :role_associations
+
+    def initialize(data, bot)
+      @bot = bot
+      @roles = nil
+
+      @name = data.name
+      @id = data.id
+      @role_associations = Hash.new([])
+      @role_associations[data.server.id] = data.roles
+    end
+
+    # @return [String] the layout to mention it (or have it used) in a message
+    def mention
+      "<:#{@name}:#{@id}>"
+    end
+
+    alias_method :use, :mention
+    alias_method :to_s, :mention
+
+    # @return [String] the icon URL of the emoji
+    def icon_url
+      API.emoji_icon_url(@id)
+    end
+
+    # The inspect method is overwritten to give more useful output
+    def inspect
+      "<GlobalEmoji name=#{@name} id=#{@id}>"
+    end
+
+    # @!visibility private
+    def process_roles(roles)
+      new_roles = []
+      return unless roles
+      roles.each do
+        role = server.role(role_id)
+        new_roles << role
+      end
+      new_roles
+    end
+  end
+
   # Basic attributes a server should have
   module ServerAttributes
     # @return [String] this server's name.
@@ -1724,7 +1912,7 @@ module Discordrb
 
   # Integration Account
   class IntegrationAccount
-    # @return [String] this accounts's name.
+    # @return [String] this account's name.
     attr_reader :name
 
     # @return [Integer] this account's ID.
@@ -1819,6 +2007,10 @@ module Discordrb
     # @return [Array<Role>] an array of all the roles created on this server.
     attr_reader :roles
 
+    # @return [Array<Emoji>] an array of all the emoji available on this server.
+    attr_reader :emoji
+    alias_method :emojis, :emoji
+
     # @return [true, false] whether or not this server is large (members > 100). If it is,
     # it means the members list may be inaccurate for a couple seconds after starting up the bot.
     attr_reader :large
@@ -1857,8 +2049,10 @@ module Discordrb
       @features = data['features'].map { |element| element.downcase.to_sym }
       @members = {}
       @voice_states = {}
+      @emoji = {}
 
       process_roles(data['roles'])
+      process_emoji(data['emojis'])
       process_members(data['members'])
       process_presences(data['presences'])
       process_channels(data['channels'])
@@ -2172,6 +2366,14 @@ module Discordrb
       update_server_data(afk_timeout: afk_timeout)
     end
 
+    # @return [true, false] whether this server has any emoji or not.
+    def any_emoji?
+      @emoji.any?
+    end
+
+    alias_method :has_emoji?, :any_emoji?
+    alias_method :emoji?, :any_emoji?
+
     # Processes a GUILD_MEMBERS_CHUNK packet, specifically the members field
     # @note For internal use only
     # @!visibility private
@@ -2239,6 +2441,14 @@ module Discordrb
       end
     end
 
+    def process_emoji(emoji)
+      return if emoji.empty?
+      emoji.each do |element|
+        new_emoji = Emoji.new(element, @bot, self)
+        @emoji[new_emoji.id] = new_emoji
+      end
+    end
+
     def process_members(members)
       return unless members
       members.each do |element|

data/lib/discordrb/events/message.rb

@@ -6,7 +6,7 @@ require 'discordrb/data'
 module Discordrb::Events
   # Module to make sending messages easier with the presence of a text channel in an event
   module Respondable
-    # @return [Channel] the channel in which this event occured
+    # @return [Channel] the channel in which this event occurred
     attr_reader :channel
 
     # Sends a message to the channel this message was sent in, right now. It is usually preferable to use {#<<} instead

data/lib/discordrb/gateway.rb

@@ -609,7 +609,7 @@ module Discordrb
 
     # Op 9
     def handle_invalidate_session
-      LOGGER.debug('Received op 9, invalidating session and reidentifying.')
+      LOGGER.debug('Received op 9, invalidating session and re-identifying.')
 
       if @session
         @session.invalidate

data/lib/discordrb/logger.rb

@@ -44,7 +44,7 @@ module Discordrb
 
     MODES.each do |mode, hash|
       define_method(mode) do |message|
-        write(message, hash) if @enabled_modes.include? mode
+        write(message.to_s, hash) if @enabled_modes.include? mode
       end
     end
 
@@ -91,13 +91,17 @@ module Discordrb
       timestamp = Time.now.strftime(LOG_TIMESTAMP_FORMAT)
 
       # Redact token if set
-      message.gsub!(@token, 'REDACTED_TOKEN') if @token
+      log = if @token
+              message.to_s.gsub(@token, 'REDACTED_TOKEN')
+            else
+              message.to_s
+            end
 
       @streams.each do |stream|
         if @fancy && !stream.is_a?(File)
-          fancy_write(stream, message, mode, thread_name, timestamp)
+          fancy_write(stream, log, mode, thread_name, timestamp)
         else
-          simple_write(stream, message, mode, thread_name, timestamp)
+          simple_write(stream, log, mode, thread_name, timestamp)
         end
       end
     end

data/lib/discordrb/version.rb

@@ -3,5 +3,5 @@
 # Discordrb and all its functionality, in this case only the version.
 module Discordrb
   # The current version of discordrb.
-  VERSION = '3.0.2'.freeze
+  VERSION = '3.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -171,15 +171,6 @@ files:
 - bin/console
 - bin/setup
 - discordrb.gemspec
-- examples/commands.rb
-- examples/data/music.dca
-- examples/data/music.mp3
-- examples/eval.rb
-- examples/ping.rb
-- examples/ping_with_respond_time.rb
-- examples/pm_send.rb
-- examples/shutdown.rb
-- examples/voice_send.rb
 - lib/discordrb.rb
 - lib/discordrb/api.rb
 - lib/discordrb/api/channel.rb

data/examples/commands.rb

@@ -1,54 +0,0 @@
-# This bot has various commands that show off CommandBot.
-
-require 'discordrb'
-
-# Here we instantiate a `CommandBot` instead of a regular `Bot`, which has the functionality to add commands using the
-# `command` method. We have to set a `prefix` here, which will be the character that triggers command execution.
-bot = Discordrb::Commands::CommandBot.new token: 'B0T.T0KEN.here', application_id: 160123456789876543, prefix: '!'
-
-bot.command :user do |event|
-  # Commands send whatever is returned from the block to the channel. This allows for compact commands like this,
-  # but you have to be aware of this so you don't accidentally return something you didn't intend to.
-  # To prevent the return value to be sent to the channel, you can just return `nil`.
-  event.user.name
-end
-
-bot.command :bold do |_event, *args|
-  # Again, the return value of the block is sent to the channel
-  "**#{args.join(' ')}**"
-end
-
-bot.command :italic do |_event, *args|
-  "*#{args.join(' ')}*"
-end
-
-bot.command(:join, permission_level: 1, chain_usable: false) do |event, invite|
-  event.bot.join invite
-
-  # The `join` call above returns the data Discord sends as a response to joining the server. We don't want that
-  # in the channel so here we're just returning `nil` afterwards
-  nil
-end
-
-bot.command(:random, min_args: 0, max_args: 2, description: 'Generates a random number between 0 and 1, 0 and max or min and max.', usage: 'random [min/max] [max]') do |_event, min, max|
-  # The `if` statement returns one of multiple different things based on the condition. Its return value
-  # is then returned from the block and sent to the channel
-  if max
-    rand(min.to_i..max.to_i)
-  elsif min
-    rand(0..min.to_i)
-  else
-    rand
-  end
-end
-
-bot.command :long do |event|
-  event << 'This is a long message.'
-  event << 'It has multiple lines that are each sent by doing `event << line`.'
-  event << 'This is an easy way to do such long messages, or to create lines that should only be sent conditionally.'
-  event << 'Anyway, have a nice day.'
-
-  # Here we don't have to worry about the return value because the `event << line` statement automatically returns nil.
-end
-
-bot.run

data/examples/eval.rb

@@ -1,20 +0,0 @@
-# Eval bots are useful for developers because they give you a way to execute code directly from your Discord channel,
-# e.g. to quickly check something, demonstrate something to other, or something else entirely. Special care must be
-# taken since anyone with access to the command can execute arbitrary code on your system which may potentially be
-# malicious.
-
-require 'discordrb'
-
-bot = Discordrb::Commands::CommandBot.new token: 'B0T.T0KEN.here', application_id: 160123456789876543, prefix: '!'
-
-bot.command(:eval, help_available: false) do |event, *code|
-  break unless event.user.id == 66237334693085184 # Replace number with your ID
-
-  begin
-    eval code.join(' ')
-  rescue
-    'An error occured 😞'
-  end
-end
-
-bot.run

data/examples/ping.rb

@@ -1,29 +0,0 @@
-# This simple bot responds to every "Ping!" message with a "Pong!"
-
-require 'discordrb'
-
-# This statement creates a bot with the specified token and application ID. After this line, you can add events to the
-# created bot, and eventually run it.
-#
-# If you don't yet have a token and application ID to put in here, you will need to create a bot account here:
-#   https://discordapp.com/developers/applications/me
-# If you're wondering about what redirect URIs and RPC origins, you can ignore those for now. If that doesn't satisfy
-# you, look here: https://github.com/meew0/discordrb/wiki/Redirect-URIs-and-RPC-origins
-# After creating the bot, simply copy the token (*not* the OAuth2 secret) and the client ID and put it into the
-# respective places.
-bot = Discordrb::Bot.new token: 'B0T.T0KEN.here', application_id: 160123456789876543
-
-# Here we output the invite URL to the console so the bot account can be invited to the channel. This only has to be
-# done once, afterwards, you can remove this part if you want
-puts "This bot's invite URL is #{bot.invite_url}."
-puts 'Click on it to invite it to your server.'
-
-# This method call adds an event handler that will be called on any message that exactly contains the string "Ping!".
-# The code inside it will be executed, and a "Pong!" response will be sent to the channel.
-bot.message(content: 'Ping!') do |event|
-  event.respond 'Pong!'
-end
-
-# This method call has to be put at the end of your script, it is what makes the bot actually connect to Discord. If you
-# leave it out (try it!) the script will simply stop and the bot will not appear online.
-bot.run

data/examples/ping_with_respond_time.rb

@@ -1,15 +0,0 @@
-# This example is nearly the same as the normal ping example, but rather than simply responding with "Pong!", it also
-# responds with the time it took to send the message.
-
-require 'discordrb'
-
-bot = Discordrb::Bot.new token: 'B0T.T0KEN.here', application_id: 160123456789876543
-
-bot.message(content: 'Ping!') do |event|
-  # The `respond` method returns a `Message` object, which is stored in a variable `m`. The `edit` method is then called
-  # to edit the message with the time difference between when the event was received and after the message was sent.
-  m = event.respond('Pong!')
-  m.edit "Pong! Time taken: #{Time.now - event.timestamp} seconds."
-end
-
-bot.run

data/examples/pm_send.rb

@@ -1,14 +0,0 @@
-# This bot shows off PM functionality by sending a PM every time the bot is mentioned.
-
-require 'discordrb'
-
-bot = Discordrb::Bot.new token: 'B0T.T0KEN.here', application_id: 160123456789876543
-
-# The `mention` event is called if the bot is *directly mentioned*, i.e. not using a role mention or @everyone/@here.
-bot.mention do |event|
-  # The `pm` method is used to send a private message (also called a DM or direct message) to the user who sent the
-  # initial message.
-  event.user.pm('You have mentioned me!')
-end
-
-bot.run

data/examples/shutdown.rb

@@ -1,19 +0,0 @@
-# This bot doesn't do anything except for letting a specifically authorised user shutdown the bot on command.
-
-require 'discordrb'
-
-bot = Discordrb::Commands::CommandBot.new token: 'B0T.T0KEN.here', application_id: 160123456789876543, prefix: '!'
-
-# Here we can see the `help_available` property used, which can determine whether a command shows up in the default
-# generated `help` command. It is true by default but it can be set to false to hide internal commands that only
-# specific people can use.
-bot.command(:exit, help_available: false) do |event|
-  # This is a check that only allows a user with a specific ID to execute this command. Otherwise, everyone would be
-  # able to shut your bot down whenever they wanted.
-  break unless event.user.id == 66237334693085184 # Replace number with your ID
-
-  bot.send_message(event.channel.id, 'Bot is shutting down')
-  exit
-end
-
-bot.run

data/examples/voice_send.rb

@@ -1,51 +0,0 @@
-# discordrb can send music or other audio data to voice channels. This example exists to show that off.
-#
-# To avoid copyright infringement, the example music I will be using is a self-composed piece of highly debatable
-# quality. If you want something better you can replace the files in the data/ directory. Make sure to execute this
-# example from the appropriate place, so that it has access to the files in that directory.
-
-require 'discordrb'
-
-bot = Discordrb::Commands::CommandBot.new token: 'B0T.T0KEN.here', application_id: 160123456789876543, prefix: '!'
-
-bot.command(:connect) do |event|
-  # The `voice_channel` method returns the voice channel the user is currently in, or `nil` if the user is not in a
-  # voice channel.
-  channel = event.user.voice_channel
-
-  # Here we return from the command unless the channel is not nil (i. e. the user is in a voice channel). The `next`
-  # construct can be used to exit a command prematurely, and even send a message while we're at it.
-  next "You're not in any voice channel!" unless channel
-
-  # The `voice_connect` method does everything necessary for the bot to connect to a voice channel. Afterwards the bot
-  # will be connected and ready to play stuff back.
-  bot.voice_connect(channel)
-  "Connected to voice channel: #{channel.name}"
-end
-
-# A simple command that plays back an mp3 file.
-bot.command(:play_mp3) do |event|
-  # `event.voice` is a helper method that gets the correct voice bot on the server the bot is currently in. Since a
-  # bot may be connected to more than one voice channel (never more than one on the same server, though), this is
-  # necessary to allow the differentiation of servers.
-  #
-  # It returns a `VoiceBot` object that methods such as `play_file` can be called on.
-  voice_bot = event.voice
-  voice_bot.play_file('data/music.mp3')
-end
-
-# DCA is a custom audio format developed by a couple people from the Discord API community (including myself, meew0).
-# It represents the audio data exactly as Discord wants it in a format that is very simple to parse, so libraries can
-# very easily add support for it. It has the advantage that absolutely no transcoding has to be done, so it is very
-# light on CPU in comparison to `play_file`.
-#
-# A conversion utility that converts existing audio files to DCA can be found here: https://github.com/nstafie/dca-rs
-bot.command(:play_dca) do |event|
-  voice_bot = event.voice
-
-  # Since the DCA format is non-standard (i.e. ffmpeg doesn't support it), a separate method other than `play_file` has
-  # to be used to play DCA files back. `play_dca` fulfills that role.
-  voice_bot.play_dca('data/music.dca')
-end
-
-bot.run