discordrb 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c44d3aabc75cea8c55af00a64f2d8f095d1b0435
-  data.tar.gz: d0769329fa9175353b605ba4993d1be07a0c9927
+  metadata.gz: a2c02619526d20cdc2271007727d9d6dde54d99e
+  data.tar.gz: 8ef9e1bb4e10d628c8700e77954d52b56e35dd13
 SHA512:
-  metadata.gz: 7ccf838cda0542222deb998e4bc335fccabd479b15d34c7b7df51e437b142f04f05bda5c7b0d0f41c6f30503cbaeea80d90b8751187e8dfe72ed6e4a4f093c93
-  data.tar.gz: cb2cb4640fa336a79a17f22b90c913d8f88edcda6dad403e66530257f7a16756cac99461b7c1508ed21252555333274be8161546dd1667061af214681ecae295
+  metadata.gz: e5379d34964d6c0b613cab7f7ea3867bf1ea34cd060aba580bdd457eb3a25fd143ef3825a8b5e4c2b81a98c8d431da50de552cf5631d04b5c489023232787964
+  data.tar.gz: 84398d02eb4482b53cb1727caf418e548b9c9a1769352eb28a71671958a2a5b6f7c810d4c0ec3ee51acf7dec200eca3db0cb57913921dcfadb19150d828bd8a3

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 2.1.2
+
+- A reader was added (`Bot#awaits`) to read the hash of awaits, so ones that aren't necessary anymore can be deleted.
+- `Channel#prune` now uses the bulk delete endpoint which means it will be much faster and no longer rate limited ([#118](https://github.com/meew0/discordrb/pull/118), thanks @snapcase)
+
+### Bugfixes
+
+- A few unresolved links in the documentation were fixed.
+- The tracking of streamed servers was updated so that very long lists of servers should now all be processed.
+- Resolution methods now return nil if the object to resolve can't be found, which should alleviate some rare caching problems ([#124](https://github.com/meew0/discordrb/pull/124), thanks @Snazzah)
+- In the rare event that Discord sends a voice state update for a nonexistent member, there should no longer be a gateway error ([#125](https://github.com/meew0/discordrb/issues/125))
+- Network errors (`EPIPE` and the like) should no longer cause an exception while processing ([#127](https://github.com/meew0/discordrb/issues/127))
+- Uncached members in messages are now logged.
+
 ## 2.1.1
 
 *Bugfix-only release.*

data/README.md

@@ -71,7 +71,7 @@ For example
 
     C:/Ruby23-x64/lib/ruby/2.3.0/rubygems/core_ext/kernel_require.rb:55:in `require': cannot load such file -- ffi_c (LoadError)
 
-Your ffi setup is screwed up, run `gem install ffi --platform=ruby` to fix it. If it says something about build tools, follow the steps in the first troubleshooting section.
+Your ffi setup is screwed up, first run `gem uninstall ffi` (uninstall all versions if it asks you, say yes to any unmet dependencies), then run `gem install ffi --platform=ruby` to fix it. If it says something about build tools, follow the steps in the first troubleshooting section.
 
 **If you're having trouble getting voice playback to work**:
 

data/lib/discordrb/api.rb

@@ -415,6 +415,18 @@ module Discordrb::API
     )
   end
 
+  # Delete messages in bulk
+  def bulk_delete(token, channel_id, messages = [])
+    request(
+      __method__,
+      :post,
+      "#{api_base}/channels/#{channel_id}/messages/bulk_delete",
+      { messages: messages }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
   # Edit a message
   def edit_message(token, channel_id, message_id, message, mentions = [])
     request(

data/lib/discordrb/bot.rb

@@ -112,6 +112,9 @@ module Discordrb
     # @return [Array(Integer, Integer)] the current shard key
     attr_reader :shard_key
 
+    # @return [Hash<Symbol => Await>] the list of registered {Await}s.
+    attr_reader :awaits
+
     include EventContainer
     include Cache
 
@@ -325,8 +328,8 @@ module Discordrb
 
     # Connects to a voice channel, initializes network connections and returns the {Voice::VoiceBot} over which audio
     # data can then be sent. After connecting, the bot can also be accessed using {#voice}. If the bot is already
-    # connected to voice, the existing connection will be terminated - you don't have to call {VoiceBot#destroy}
-    # before calling this method.
+    # connected to voice, the existing connection will be terminated - you don't have to call
+    # {Discordrb::Voice::VoiceBot#destroy} before calling this method.
     # @param chan [Channel] The voice channel to connect to.
     # @param encrypted [true, false] Whether voice communication should be encrypted using RbNaCl's SecretBox
     #   (uses an XSalsa20 stream cipher for encryption and Poly1305 for authentication)
@@ -646,6 +649,11 @@ module Discordrb
 
       user = server.member(user_id)
 
+      unless user
+        warn "Invalid user for voice state update: #{user_id} on #{server_id}, ignoring"
+        return
+      end
+
       channel_id = data['channel_id']
       channel = nil
       channel = self.channel(channel_id.to_i) if channel_id
@@ -994,7 +1002,7 @@ module Discordrb
               v#{GATEWAY_VERSION} #{packet}" unless opcode == Opcodes::DISPATCH
 
       # Check whether there are still unavailable servers and there have been more than 10 seconds since READY
-      if @unavailable_servers && @unavailable_servers > 0 && (Time.now - @ready_time) > 10
+      if @unavailable_servers && @unavailable_servers > 0 && (Time.now - @unavailable_timeout_time) > 10
         # The server streaming timed out!
         LOGGER.warn("Server streaming timed out with #{@unavailable_servers} servers remaining")
         LOGGER.warn("This means some servers are unavailable due to an outage. Notifying ready now, we'll have to live without these servers")
@@ -1059,6 +1067,7 @@ module Discordrb
         end
 
         @ready_time = Time.now
+        @unavailable_timeout_time = Time.now
       when :RESUMED
         # 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) and set a new heartbeat interval.
@@ -1212,6 +1221,7 @@ module Discordrb
         # Check for false specifically (no data means the server has never been unavailable)
         if data['unavailable'].is_a? FalseClass
           @unavailable_servers -= 1 if @unavailable_servers
+          @unavailable_timeout_time = Time.now
 
           notify_ready if @unavailable_servers == 0
 
@@ -1247,19 +1257,19 @@ module Discordrb
       # Handle actual close frames and errors separately
       if event.respond_to? :code
         LOGGER.error(%(Disconnected from WebSocket - code #{event.code} with reason: "#{event.data}"))
+
+        if event.code.to_i == 4006
+          # If we got disconnected with a 4006, it means we sent a resume when Discord wanted an identify. To battle this,
+          # we invalidate the local session so we'll just send an identify next time
+          debug('Apparently we just sent the wrong type of initiation packet (resume rather than identify) to Discord. (Sorry!)
+                Invalidating session so this is fixed next time')
+          invalidate_session
+        end
       else
         LOGGER.error('Disconnected from WebSocket due to an exception!')
         LOGGER.log_exception event
       end
 
-      if event.code.to_i == 4006
-        # If we got disconnected with a 4006, it means we sent a resume when Discord wanted an identify. To battle this,
-        # we invalidate the local session so we'll just send an identify next time
-        debug('Apparently we just sent the wrong type of initiation packet (resume rather than identify) to Discord. (Sorry!)
-                Invalidating session so this is fixed next time')
-        invalidate_session
-      end
-
       raise_event(DisconnectEvent.new(self))
 
       # Stop sending heartbeats

data/lib/discordrb/cache.rb

@@ -35,7 +35,11 @@ module Discordrb
       return @channels[id] if @channels[id]
 
       begin
-        response = API.channel(token, id)
+        begin
+          response = API.channel(token, id)
+        rescue RestClient::ResourceNotFound
+          return nil
+        end
         channel = Channel.new(JSON.parse(response), self, server)
         @channels[id] = channel
       rescue Discordrb::Errors::NoPermission
@@ -54,7 +58,11 @@ module Discordrb
       return @users[id] if @users[id]
 
       LOGGER.out("Resolving user #{id}")
-      response = API.user(token, id)
+      begin
+        response = API.user(token, id)
+      rescue RestClient::ResourceNotFound
+        return nil
+      end
       user = User.new(JSON.parse(response), self)
       @users[id] = user
     end
@@ -68,7 +76,11 @@ module Discordrb
       return @servers[id] if @servers[id]
 
       LOGGER.out("Resolving server #{id}")
-      response = API.server(token, id)
+      begin
+        response = API.server(token, id)
+      rescue RestClient::ResourceNotFound
+        return nil
+      end
       server = Server.new(JSON.parse(response), self)
       @servers[id] = server
     end
@@ -85,7 +97,11 @@ module Discordrb
       return server.member(user_id) if server.member_cached?(user_id)
 
       LOGGER.out("Resolving member #{server_id} on server #{user_id}")
-      response = API.member(token, server_id, user_id)
+      begin
+        response = API.member(token, server_id, user_id)
+      rescue RestClient::ResourceNotFound
+        return nil
+      end
       member = Member.new(JSON.parse(response), server, self)
       server.cache_member(member)
     end

data/lib/discordrb/data.rb

@@ -1005,26 +1005,14 @@ module Discordrb
       JSON.parse(logs).map { |message| Message.new(message, @bot) }
     end
 
-    # Deletes the last N messages on this channel. Each delete request is performed in a separate thread for performance
-    # reasons, so if a large number of messages are pruned, many threads will be created.
-    # @note As of the April 29 update, the message delete request is rate limited, which means this method will take
-    #   a long time. It will eventually be updated to use batch deletes once those are released, but that will be in the
-    #   far future.
-    # @param amount [Integer] How many messages to delete. Must be 100 or less (Discord limitation)
-    # @raise [ArgumentError] if more than 100 messages are requested.
+    # Delete the last N messages on this channel.
+    # @param amount [Integer] How many messages to delete. Must be a value between 2 and 100 (Discord limitation)
+    # @raise [ArgumentError] if the amount of messages is not a value between 2 and 100
     def prune(amount)
-      raise ArgumentError, "Can't prune more than 100 messages!" if amount > 100
+      raise ArgumentError, 'Can only prune between 2 and 100 messages!' unless amount.between?(2, 100)
 
-      threads = []
-      history(amount).each do |message|
-        threads << Thread.new { message.delete }
-      end
-
-      # Make sure all requests have finished
-      threads.each(&:join)
-
-      # Delete the threads
-      threads.map! { nil }
+      messages = history(amount).map(&:id)
+      API.bulk_delete(@bot.token, @id, messages)
     end
 
     # Updates the cached permission overwrites
@@ -1163,7 +1151,9 @@ module Discordrb
                     # directly because the bot may also send messages to the channel
                     Recipient.new(bot.user(data['author']['id'].to_i), @channel, bot)
                   else
-                    @channel.server.member(data['author']['id'].to_i, false)
+                    member = @channel.server.member(data['author']['id'].to_i, false)
+                    Discordrb::LOGGER.warn("Member with ID #{data['author']['id']} not cached even though it should be.") unless member
+                    member
                   end
                 end
 
@@ -1320,6 +1310,8 @@ module Discordrb
 
       member = @bot.member(@id, id)
       @members[id] = member
+    rescue
+      nil
     end
 
     # @return [Array<Member>] an array of all the members on this server.

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 = '2.1.1'.freeze
+  VERSION = '2.1.2'.freeze
 end

data/lib/discordrb/voice/voice_bot.rb

@@ -227,7 +227,7 @@ module Discordrb::Voice
 
     # Plays a stream of audio data in the DCA format. This format has the advantage that no recoding has to be
     # done - the file contains the data exactly as Discord needs it.
-    # @note DCA playback will not be affected by the volume modifier ({volume=}) because the modifier operates on raw
+    # @note DCA playback will not be affected by the volume modifier ({#volume}) because the modifier operates on raw
     #   PCM, not opus data. Modifying the volume of DCA data would involve decoding it, multiplying the samples and
     #   re-encoding it, which defeats its entire purpose (no recoding).
     # @see https://github.com/bwmarrin/dca

data/lib/discordrb/websocket.rb

@@ -3,6 +3,9 @@
 require 'websocket-client-simple'
 
 puts "Using WSCS version: #{WebSocket::Client::Simple::VERSION}"
+
+# The WSCS module which we're hooking
+# @see Websocket::Client::Simple::Client
 module WebSocket::Client::Simple
   # Patch to the WSCS class to allow reading the internal thread
   class Client

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-08 00:00:00.000000000 Z
+date: 2016-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client