discordrb 3.1.1 → 3.2.0

data/lib/discordrb/gateway.rb

@@ -72,8 +72,9 @@ module Discordrb
     # members when it receives them. (Sending this is never necessary for a gateway client to behave correctly)
     REQUEST_MEMBERS = 8
 
-    # **Received**: The functionality of this opcode is less known than the others but it appears to specifically
-    # tell the client to invalidate its local session and continue by {IDENTIFY}ing.
+    # **Received**: Sent by Discord when the session becomes invalid for any reason. This may include improperly
+    # resuming existing sessions, attempting to start sessions with invalid data, or something else entirely. The client
+    # should handle this by simply starting a new session.
     INVALIDATE_SESSION = 9
 
     # **Received**: Sent immediately for any opened connection; tells the client to start heartbeating early on, so the
@@ -93,7 +94,7 @@ module Discordrb
     attr_accessor :sequence
 
     def initialize(session_id)
-      @id = session_id
+      @session_id = session_id
       @sequence = 0
       @suspended = false
       @invalid = false
@@ -107,6 +108,10 @@ module Discordrb
       @suspended
     end
 
+    def resume
+      @suspended = false
+    end
+
     def invalidate
       @invalid = true
     end
@@ -128,14 +133,25 @@ module Discordrb
     # The version of the gateway that's supposed to be used.
     GATEWAY_VERSION = 6
 
-    def initialize(bot, token)
+    # Heartbeat ACKs are Discord's way of verifying on the client side whether the connection is still alive. If this is
+    # set to true (default value) the gateway client will use that functionality to detect zombie connections and
+    # reconnect in such a case; however it may lead to instability if there's some problem with the ACKs. If this occurs
+    # it can simply be set to false.
+    # @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)
       @token = token
       @bot = bot
 
+      @shard_key = shard_key
+
       @getc_mutex = Mutex.new
 
       # Whether the connection to the gateway has succeeded yet
       @ws_success = false
+
+      @check_heartbeat_acks = true
     end
 
     # Connect to the gateway server in a separate thread
@@ -213,6 +229,21 @@ module Discordrb
     # before it), or if none have been received yet, with 0.
     # @see #send_heartbeat
     def heartbeat
+      if check_heartbeat_acks
+        unless @last_heartbeat_acked
+          # We're in a bad situation - apparently the last heartbeat wasn't acked, which means the connection is likely
+          # a zombie. Reconnect
+          LOGGER.warn('Last heartbeat was not acked, so this is a zombie connection! Reconnecting')
+
+          # We can't send anything on zombie connections
+          @pipe_broken = true
+          reconnect
+          return
+        end
+
+        @last_heartbeat_acked = false
+      end
+
       send_heartbeat(@session ? @session.sequence : 0)
     end
 
@@ -232,7 +263,7 @@ module Discordrb
                       :'$device' => 'discordrb',
                       :'$referrer' => '',
                       :'$referring_domain' => ''
-                    }, true, 100)
+                    }, true, 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.
@@ -251,7 +282,9 @@ module Discordrb
     # @param compress [true, false] Whether certain large packets should be compressed using zlib.
     # @param large_threshold [Integer] The member threshold after which a server counts as large and will have to have
     #   its member list chunked.
-    def send_identify(token, properties, compress, large_threshold)
+    # @param shard_key [Array(Integer, Integer), nil] The shard key to use for sharding, represented as
+    #   [shard_id, num_shards], or nil if the bot should not be sharded.
+    def send_identify(token, properties, compress, large_threshold, shard_key = nil)
       data = {
         # Don't send a v anymore as it's entirely determined by the URL now
         token: token,
@@ -260,6 +293,9 @@ module Discordrb
         large_threshold: large_threshold
       }
 
+      # Don't include the shard key at all if it is nil as Discord checks for its mere existence
+      data[:shard] = shard_key if shard_key
+
       send_packet(Opcodes::IDENTIFY, data)
     end
 
@@ -305,6 +341,17 @@ module Discordrb
       send_resume(@token, @session.session_id, @session.sequence)
     end
 
+    # 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
+
+      @instant_reconnect = true
+      @should_reconnect = true
+
+      close
+    end
+
     # Sends a resume packet (op 6). This replays all events from a previous point specified by its packet sequence. This
     # will not work if the packet to resume from has already been acknowledged using a heartbeat, or if the session ID
     # belongs to a now invalid session.
@@ -345,6 +392,12 @@ module Discordrb
     private
 
     def setup_heartbeats(interval)
+      # Make sure to reset ACK handling, so we don't keep reconnecting
+      @last_heartbeat_acked = true
+
+      # If we suspended the session before because of a reconnection, we need to resume it now
+      @session.resume if @session && @session.suspended?
+
       # We don't want to have redundant heartbeat threads, so if one already exists, don't start a new one
       return if @heartbeat_thread
 
@@ -381,8 +434,7 @@ module Discordrb
         break unless @should_reconnect
 
         if @instant_reconnect
-          # We got an op 7! Don't wait before reconnecting
-          LOGGER.info('Got an op 7, reconnecting right away')
+          LOGGER.info('Instant reconnection flag was set - reconnecting right away')
           @instant_reconnect = false
         else
           wait_for_reconnect
@@ -488,6 +540,7 @@ module Discordrb
           recv_data = nil
 
           # Get some data from the socket, synchronised so the socket can't be closed during this
+          # 24: remove locking
           @getc_mutex.synchronize { recv_data = @socket.getc }
 
           # Check if we actually got data
@@ -533,8 +586,7 @@ module Discordrb
       handle_open
     end
 
-    def handle_open
-    end
+    def handle_open; end
 
     def handle_error(e)
       LOGGER.error('An error occurred in the main websocket loop!')
@@ -571,6 +623,8 @@ module Discordrb
         handle_invalidate_session
       when Opcodes::HEARTBEAT_ACK
         handle_heartbeat_ack(packet)
+      when Opcodes::HEARTBEAT
+        handle_heartbeat(packet)
       else
         LOGGER.warn("Received invalid opcode #{op} - please report with this information: #{msg}")
       end
@@ -591,20 +645,23 @@ 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.debug('Connection resumed')
+        LOGGER.good 'Resumed'
         return
       end
 
       @bot.dispatch(type, data)
     end
 
+    # Op 1
+    def handle_heartbeat(packet)
+      # If we receive a heartbeat, we have to resend one with the same sequence
+      send_heartbeat(packet['s'])
+    end
+
     # Op 7
     def handle_reconnect
-      @instant_reconnect = true
-      close
-
-      # Suspend session so we resume afterwards
-      @session.suspend
+      LOGGER.debug('Received op 7, reconnecting and attempting resume')
+      reconnect
     end
 
     # Op 9
@@ -640,6 +697,7 @@ module Discordrb
     # Op 11
     def handle_heartbeat_ack(packet)
       LOGGER.debug("Received heartbeat ack for packet: #{packet.inspect}")
+      @last_heartbeat_acked = true if @check_heartbeat_acks
     end
 
     # Called when the websocket has been disconnected in some way - say due to a pipe error while sending
@@ -686,7 +744,7 @@ module Discordrb
       # Try to send it
       begin
         @socket.write frame.to_s
-      rescue Errno::EPIPE => e
+      rescue => e
         # There has been an error!
         @pipe_broken = true
         handle_internal_close(e)

data/lib/discordrb/permissions.rb

@@ -13,7 +13,7 @@ module Discordrb
       3 => :administrator,         # 8
       4 => :manage_channels,       # 16
       5 => :manage_server,         # 32
-      # 6                          # 64
+      6 => :add_reactions,         # 64
       # 7                          # 128
       # 8                          # 256
       # 9                          # 512
@@ -35,7 +35,9 @@ module Discordrb
       25 => :use_voice_activity,   # 33554432
       26 => :change_nickname,      # 67108864
       27 => :manage_nicknames,     # 134217728
-      28 => :manage_roles          # 268435456, also Manage Permissions
+      28 => :manage_roles,         # 268435456, also Manage Permissions
+      29 => :manage_webhooks,      # 536870912
+      30 => :manage_emojis         # 1073741824
     }.freeze
 
     Flags.each do |position, flag|
@@ -58,7 +60,7 @@ module Discordrb
     attr_reader :bits
 
     # Set the raw bitset of this permission object
-    # @param bits [Fixnum] A number whose binary representation is the desired bitset.
+    # @param bits [Integer] A number whose binary representation is the desired bitset.
     def bits=(bits)
       @bits = bits
       init_vars

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.1.1'.freeze
+  VERSION = '3.2.0'.freeze
 end

data/lib/discordrb/voice/encoder.rb

@@ -29,11 +29,8 @@ module Discordrb::Voice
       @channels = 2
       @filter_volume = 1
 
-      if OPUS_AVAILABLE
-        @opus = Opus::Encoder.new(@sample_rate, @frame_size, @channels)
-      else
-        raise LoadError, 'Opus unavailable - voice not supported! Please install opus for voice support to work.'
-      end
+      raise LoadError, 'Opus unavailable - voice not supported! Please install opus for voice support to work.' unless OPUS_AVAILABLE
+      @opus = Opus::Encoder.new(@sample_rate, @frame_size, @channels)
     end
 
     # Set the opus encoding bitrate

data/lib/discordrb/voice/network.rb

@@ -303,8 +303,8 @@ module Discordrb::Voice
         host,
         method(:websocket_open),
         method(:websocket_message),
-        proc { |e| Discordrb::Logger.error "VWS error: #{e}" },
-        proc { |e| Discordrb::Logger.warn "VWS close: #{e}" }
+        proc { |e| Discordrb::LOGGER.error "VWS error: #{e}" },
+        proc { |e| Discordrb::LOGGER.warn "VWS close: #{e}" }
       )
 
       @bot.debug('VWS connected')

data/lib/discordrb/voice/voice_bot.rb

@@ -160,11 +160,10 @@ module Discordrb::Voice
       @playing = false
       sleep IDEAL_LENGTH / 1000.0 if @was_playing_before
 
-      if wait_for_confirmation
-        @has_stopped_playing = false
-        sleep IDEAL_LENGTH / 1000.0 until @has_stopped_playing
-        @has_stopped_playing = false
-      end
+      return unless wait_for_confirmation
+      @has_stopped_playing = false
+      sleep IDEAL_LENGTH / 1000.0 until @has_stopped_playing
+      @has_stopped_playing = false
     end
 
     # Permanently disconnects from the voice channel; to reconnect you will have to call {Bot#voice_connect} again.
@@ -364,7 +363,7 @@ module Discordrb::Voice
           # Wait `length` ms, then send the next packet
           sleep @length / 1000.0
         else
-          Discordrb::Logger.warn('Audio encoding and sending together took longer than Discord expects one packet to be (20 ms)! This may be indicative of network problems.')
+          Discordrb::LOGGER.warn('Audio encoding and sending together took longer than Discord expects one packet to be (20 ms)! This may be indicative of network problems.')
         end
       end
 

data/lib/discordrb/webhooks.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'discordrb/webhooks/version'
+require 'discordrb/webhooks/embeds'
+require 'discordrb/webhooks/client'
+require 'discordrb/webhooks/builder'
+
+module Discordrb
+  # Webhook client
+  module Webhooks
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-21 00:00:00.000000000 Z
+date: 2017-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: opus-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,35 +39,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: opus-ruby
+  name: websocket-client-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: websocket-client-simple
+  name: rbnacl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
-  name: rbnacl
+  name: discordrb-webhooks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,20 +136,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.45.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.45.0
 description: A Ruby implementation of the Discord (https://discordapp.com) API.
 email:
 - ''
@@ -157,6 +171,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".overcommit.yml"
 - ".rspec"
@@ -164,12 +179,14 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- discordrb-webhooks.gemspec
 - discordrb.gemspec
 - lib/discordrb.rb
 - lib/discordrb/api.rb
@@ -197,6 +214,8 @@ files:
 - lib/discordrb/events/members.rb
 - lib/discordrb/events/message.rb
 - lib/discordrb/events/presence.rb
+- lib/discordrb/events/raw.rb
+- lib/discordrb/events/reactions.rb
 - lib/discordrb/events/roles.rb
 - lib/discordrb/events/typing.rb
 - lib/discordrb/events/voice_state_update.rb
@@ -211,6 +230,7 @@ files:
 - lib/discordrb/voice/encoder.rb
 - lib/discordrb/voice/network.rb
 - lib/discordrb/voice/voice_bot.rb
+- lib/discordrb/webhooks.rb
 - lib/discordrb/websocket.rb
 homepage: https://github.com/meew0/discordrb
 licenses:
@@ -232,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Discord API for Ruby