discordrb 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eae3c0ee1c9f49e7e8c498ce1db7361a9e812053
-  data.tar.gz: ed4937a0c6c8a4c1c084fa684c78e5b8f11ace7b
+  metadata.gz: 746a55903872da764ecd6fb4c82992781e147245
+  data.tar.gz: 519c53e91471feda8194fcc059ce825f4e4e613b
 SHA512:
-  metadata.gz: 6b1fddaa771f734968bc3d0172b8fe87a95a442d9d6ee3ace91ad8e9a182a94c8b1829d333272d01dcad6a8a0cfad676d0c7f1018b34ba9afa66acdca58cf32e
-  data.tar.gz: d1fe90193e8abd77d749a5982bb8ba4bb23b88625acd80f80fbdb0a37ab99127af5574cd3284c187258b254dbb863e235d9d85c313ec8ff5e71253a12bca0923
+  metadata.gz: 52df6acf8f65d4ce36d3111d66e8b0957c3c02a6b0b3c01b98bbb638344d07e67c65dc704ed70a0104785c1874e83ab56609a8054531ddad3c740919518bd798
+  data.tar.gz: 9edacd6ca16c117ac57f7dc1a9a327831ef497944a3a4508332ef6e8f633ae3b55646cb597d211728d11d32d6848b25e287da29969a2b8a2a37a61cb53a4045e

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 3.0.1
+
+A tiny update to support webhook-sent messages properly!
+
+- Added the utility methods `Message#webhook?` and `User#webhook?` to check whether a message or a user belongs to a webhook
+- Added `Message#webhook_id` to get the ID of the sending webhook for webhook messages
+- Added the `webhook_commands` parameter to CommandBot that, if false (default true), prevents webhook-sent messages from being parsed and handled as commands.
+
+### Bugfixes
+
+- Fixed webhook-sent messages being ignored because their author couldn't be resolved.
+- Fixed a minor performance problem where a CommandBot would create unnecessarily create redundant objects for every received message.
+
 ## 3.0.0
 
 I didn't think there could possibly be a release larger than 2.0.0 was, but here it is! Including the respective release commit, there were 540 commits from 1.8.1 to 2.0.0, but a whopping 734 commits from 2.1.3 to 3.0.0.

data/lib/discordrb/bot.rb

@@ -874,9 +874,10 @@ module Discordrb
           return
         end
 
-        create_message(data)
-
-        message = Message.new(data, self)
+        # If create_message is overwritten with a method that returns the parsed message, use that instead, so we don't
+        # parse the message twice (which is just thrown away performance)
+        message = create_message(data)
+        message = Message.new(data, self) unless message.is_a? Message
 
         return if message.from_bot? && !should_parse_self
 

data/lib/discordrb/commands/command_bot.rb

@@ -48,6 +48,8 @@ module Discordrb::Commands
     # @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 [true, false] :webhook_commands Whether messages sent by webhooks are allowed to trigger
+    #   commands. Default is true.
     # @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
@@ -95,6 +97,9 @@ module Discordrb::Commands
         # Spaces allowed between prefix and command
         spaces_allowed: attributes[:spaces_allowed].nil? ? false : attributes[:spaces_allowed],
 
+        # Webhooks allowed to trigger commands
+        webhook_commands: attributes[:webhook_commands].nil? ? true : attributes[:webhook_commands],
+
         # All of the following need to be one character
         # String to designate previous result in command chain
         previous: attributes[:previous] || '~',
@@ -216,9 +221,14 @@ module Discordrb::Commands
     # @param server [Server] The server on which to check
     # @return [true, false] whether or not the user has the given permission
     def permission?(user, level, server)
-      determined_level = server.nil? ? 0 : user.roles.reduce(0) do |memo, role|
-        [@permissions[:roles][role.id] || 0, memo].max
-      end
+      determined_level = if user.webhook? || server.nil?
+                           0
+                         else
+                           user.roles.reduce(0) do |memo, role|
+                             [@permissions[:roles][role.id] || 0, memo].max
+                           end
+                         end
+
       [@permissions[:users][user.id] || 0, determined_level].max >= level
     end
 
@@ -227,7 +237,8 @@ module Discordrb::Commands
     # Internal handler for MESSAGE_CREATE that is overwritten to allow for command handling
     def create_message(data)
       message = Discordrb::Message.new(data, self)
-      return if message.from_bot? && !@should_parse_self
+      return message if message.from_bot? && !@should_parse_self
+      return message if message.webhook? && !@attributes[:webhook_commands]
 
       unless message.author
         Discordrb::LOGGER.warn("Received a message (#{message.inspect}) with nil author! Ignoring, please report this if you can")
@@ -237,20 +248,23 @@ module Discordrb::Commands
       event = CommandEvent.new(message, self)
 
       chain = trigger?(message)
-      return unless chain
+      return message unless chain
 
       # Don't allow spaces between the prefix and the command
       if chain.start_with?(' ') && !@attributes[:spaces_allowed]
         debug('Chain starts with a space')
-        return
+        return message
       end
 
       if chain.strip.empty?
         debug('Chain is empty')
-        return
+        return message
       end
 
       execute_chain(chain, event)
+
+      # Return the message so it doesn't get parsed again during the rest of the dispatch handling
+      message
     end
 
     # Check whether a message should trigger command execution, and if it does, return the raw chain
@@ -271,11 +285,12 @@ module Discordrb::Commands
 
     def required_permissions?(member, required, channel = nil)
       required.reduce(true) do |a, action|
-        a && member.permission?(action, channel)
+        a && !member.webhook? && member.permission?(action, channel)
       end
     end
 
     def required_roles?(member, required)
+      return (required.nil? || required.empty?) if member.webhook?
       if required.is_a? Array
         required.all? do |role|
           member.role?(role)

data/lib/discordrb/data.rb

@@ -211,6 +211,11 @@ module Discordrb
       @bot.profile.id == @id
     end
 
+    # @return [true, false] whether this user is a fake user for a webhook message
+    def webhook?
+      @discriminator == Message::ZERO_DISCRIM
+    end
+
     [:offline, :idle, :online].each do |e|
       define_method(e.to_s + '?') do
         @status.to_sym == e
@@ -1583,6 +1588,12 @@ module Discordrb
     attr_reader :pinned
     alias_method :pinned?, :pinned
 
+    # @return [Integer, nil] the webhook ID that sent this message, or nil if it wasn't sent through a webhook.
+    attr_reader :webhook_id
+
+    # The discriminator that webhook user accounts have.
+    ZERO_DISCRIM = '0000'.freeze
+
     # @!visibility private
     def initialize(data, bot)
       @bot = bot
@@ -1594,7 +1605,12 @@ module Discordrb
       @mention_everyone = data['mention_everyone']
 
       @author = if data['author']
-                  if @channel.private?
+                  if data['author']['discriminator'] == ZERO_DISCRIM
+                    # This is a webhook user! It would be pointless to try to resolve a member here, so we just create
+                    # a User and return that instead.
+                    Discordrb::LOGGER.debug("Webhook user: #{data['author']['id']}")
+                    User.new(data['author'], @bot)
+                  elsif @channel.private?
                     # Turn the message user into a recipient - we can't use the channel recipient
                     # directly because the bot may also send messages to the channel
                     Recipient.new(bot.user(data['author']['id'].to_i), @channel, bot)
@@ -1605,6 +1621,8 @@ module Discordrb
                   end
                 end
 
+      @webhook_id = data['webhook_id'].to_i if data['webhook_id']
+
       @timestamp = Time.parse(data['timestamp']) if data['timestamp']
       @edited_timestamp = data['edited_timestamp'].nil? ? nil : Time.parse(data['edited_timestamp'])
       @edited = !@edited_timestamp.nil?
@@ -1677,6 +1695,11 @@ module Discordrb
       @author && @author.current_bot?
     end
 
+    # @return [true, false] whether this message has been sent over a webhook.
+    def webhook?
+      !@webhook_id.nil?
+    end
+
     # The inspect method is overwritten to give more useful output
     def inspect
       "<Message content=\"#{@content}\" id=#{@id} timestamp=#{@timestamp} author=#{@author} channel=#{@channel}>"

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.0'.freeze
+  VERSION = '3.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client