discordrb 3.5.0 → 3.6.1

data/lib/discordrb/gateway.rb

@@ -90,14 +90,22 @@ module Discordrb
   # This class stores the data of an active gateway session. Note that this is different from a websocket connection -
   # there may be multiple sessions per connection or one session may persist over multiple connections.
   class Session
+    # @return [String] Used to uniquely identify this session. Mostly used when resuming connections.
     attr_reader :session_id
+
+    # @return [Integer] Incrementing integer used to determine the most recent event reccived from Discord.
     attr_accessor :sequence
 
-    def initialize(session_id)
+    # @return [String] Gateway URL used to reconnect to the gateway node that Discord wants this session to use.
+    attr_reader :resume_gateway_url
+
+    # @!visibility private
+    def initialize(session_id, resume_gateway_url)
       @session_id = session_id
       @sequence = 0
       @suspended = false
       @invalid = false
+      @resume_gateway_url = resume_gateway_url
     end
 
     # Flags this session as suspended, so we know not to try and send heartbeats, etc. to the gateway until we've reconnected
@@ -117,6 +125,7 @@ module Discordrb
     # Flags this session as being invalid
     def invalidate
       @invalid = true
+      @resume_gateway_url = nil
     end
 
     def invalid?
@@ -136,6 +145,13 @@ module Discordrb
     # The version of the gateway that's supposed to be used.
     GATEWAY_VERSION = 9
 
+    # Close codes that are unrecoverable, after which we should not try to reconnect.
+    # - 4003: Not authenticated. How did this happen?
+    # - 4004: Authentication failed. Token was wrong, nothing we can do.
+    # - 4011: Sharding required. Currently requires developer intervention.
+    # - 4014: Use of disabled privileged intents.
+    FATAL_CLOSE_CODES = [4003, 4004, 4011, 4014].freeze
+
     # 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
@@ -452,8 +468,13 @@ module Discordrb
           # suspended (e.g. after op7)
           if (@session && !@session.suspended?) || !@session
             sleep @heartbeat_interval
-            @bot.raise_heartbeat_event
-            heartbeat
+            # Check if we're connected here, since we could possibly be waiting for a reconnect to occur.
+            if @handshaked && !@closed
+              @bot.raise_heartbeat_event
+              heartbeat
+            else
+              LOGGER.debug('Tried to send a heartbeat without being connected! Ignoring, we should be fine.')
+            end
           else
             sleep 1
           end
@@ -538,7 +559,7 @@ module Discordrb
     end
 
     def process_gateway
-      raw_url = find_gateway
+      raw_url = @session&.resume_gateway_url || find_gateway
 
       # Append a slash in case it's not there (I'm not sure how well WSCS handles it otherwise)
       raw_url += '/' unless raw_url.end_with? '/'
@@ -656,7 +677,9 @@ module Discordrb
       LOGGER.log_exception(e)
     end
 
+    # rubocop:disable Lint/UselessConstantScoping
     ZLIB_SUFFIX = "\x00\x00\xFF\xFF".b.freeze
+    # rubocop:enable Lint/UselessConstantScoping
 
     def handle_message(msg)
       case @compress_mode
@@ -716,9 +739,9 @@ module Discordrb
       when :READY
         LOGGER.info("Discord using gateway protocol version: #{data['v']}, requested: #{GATEWAY_VERSION}")
 
-        @session = Session.new(data['session_id'])
+        @session = Session.new(data['session_id'], data['resume_gateway_url'])
         @session.sequence = 0
-        @bot.__send__(:notify_ready) if @intents && (@intents & INTENTS[:servers]).zero?
+        @bot.__send__(:notify_ready) if @intents && @intents.nobits?(INTENTS[:servers])
       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). Starting with v5, it doesn't set a new heartbeat interval anymore
@@ -789,13 +812,6 @@ module Discordrb
       handle_close(e)
     end
 
-    # Close codes that are unrecoverable, after which we should not try to reconnect.
-    # - 4003: Not authenticated. How did this happen?
-    # - 4004: Authentication failed. Token was wrong, nothing we can do.
-    # - 4011: Sharding required. Currently requires developer intervention.
-    # - 4014: Use of disabled privileged intents.
-    FATAL_CLOSE_CODES = [4003, 4004, 4011, 4014].freeze
-
     def handle_close(e)
       @bot.__send__(:raise_event, Events::DisconnectEvent.new(@bot))
 

data/lib/discordrb/paginator.rb

@@ -24,7 +24,7 @@ module Discordrb
     # no more results or the configured `limit` is reached.
     def each
       last_page = nil
-      until limit_check
+      until limit_exceeded?
         page = @block.call(last_page)
         return if page.empty?
 
@@ -38,7 +38,7 @@ module Discordrb
         enumerator.each do |item|
           yield item
           @count += 1
-          break if limit_check
+          break if limit_exceeded?
         end
 
         last_page = page
@@ -48,7 +48,7 @@ module Discordrb
     private
 
     # Whether the paginator limit has been exceeded
-    def limit_check
+    def limit_exceeded?
       return false if @limit.nil?
 
       @count >= @limit

data/lib/discordrb/permissions.rb

@@ -6,47 +6,56 @@ module Discordrb
     # This hash maps bit positions to logical permissions.
     FLAGS = {
       # Bit => Permission # Value
-      0 => :create_instant_invite,     # 1
-      1 => :kick_members,              # 2
-      2 => :ban_members,               # 4
-      3 => :administrator,             # 8
-      4 => :manage_channels,           # 16
-      5 => :manage_server,             # 32
-      6 => :add_reactions,             # 64
-      7 => :view_audit_log,            # 128
-      8 => :priority_speaker,          # 256
-      9 => :stream,                    # 512
-      10 => :read_messages,            # 1024
-      11 => :send_messages,            # 2048
-      12 => :send_tts_messages,        # 4096
-      13 => :manage_messages,          # 8192
-      14 => :embed_links,              # 16384
-      15 => :attach_files,             # 32768
-      16 => :read_message_history,     # 65536
-      17 => :mention_everyone,         # 131072
-      18 => :use_external_emoji,       # 262144
-      19 => :view_server_insights,     # 524288
-      20 => :connect,                  # 1048576
-      21 => :speak,                    # 2097152
-      22 => :mute_members,             # 4194304
-      23 => :deafen_members,           # 8388608
-      24 => :move_members,             # 16777216
-      25 => :use_voice_activity,       # 33554432
-      26 => :change_nickname,          # 67108864
-      27 => :manage_nicknames,         # 134217728
-      28 => :manage_roles,             # 268435456, also Manage Permissions
-      29 => :manage_webhooks,          # 536870912
-      30 => :manage_emojis,            # 1073741824, also Manage Stickers
-      31 => :use_slash_commands,       # 2147483648
-      32 => :request_to_speak,         # 4294967296
-      33 => :manage_events,            # 8589934592
-      34 => :manage_threads,           # 17179869184
-      35 => :use_public_threads,       # 34359738368
-      36 => :use_private_threads,      # 68719476736
-      37 => :use_external_stickers,    # 137438953472
-      38 => :send_messages_in_threads, # 274877906944
-      39 => :use_embedded_activities,  # 549755813888
-      40 => :moderate_members          # 1099511627776
+      0 => :create_instant_invite,        # 1
+      1 => :kick_members,                 # 2
+      2 => :ban_members,                  # 4
+      3 => :administrator,                # 8
+      4 => :manage_channels,              # 16
+      5 => :manage_server,                # 32
+      6 => :add_reactions,                # 64
+      7 => :view_audit_log,               # 128
+      8 => :priority_speaker,             # 256
+      9 => :stream,                       # 512
+      10 => :read_messages,               # 1024
+      11 => :send_messages,               # 2048
+      12 => :send_tts_messages,           # 4096
+      13 => :manage_messages,             # 8192
+      14 => :embed_links,                 # 16384
+      15 => :attach_files,                # 32768
+      16 => :read_message_history,        # 65536
+      17 => :mention_everyone,            # 131072
+      18 => :use_external_emoji,          # 262144
+      19 => :view_server_insights,        # 524288
+      20 => :connect,                     # 1048576
+      21 => :speak,                       # 2097152
+      22 => :mute_members,                # 4194304
+      23 => :deafen_members,              # 8388608
+      24 => :move_members,                # 16777216
+      25 => :use_voice_activity,          # 33554432
+      26 => :change_nickname,             # 67108864
+      27 => :manage_nicknames,            # 134217728
+      28 => :manage_roles,                # 268435456, also Manage Permissions
+      29 => :manage_webhooks,             # 536870912
+      30 => :manage_emojis,               # 1073741824, also Manage Stickers
+      31 => :use_slash_commands,          # 2147483648
+      32 => :request_to_speak,            # 4294967296
+      33 => :manage_events,               # 8589934592
+      34 => :manage_threads,              # 17179869184
+      35 => :use_public_threads,          # 34359738368
+      36 => :use_private_threads,         # 68719476736
+      37 => :use_external_stickers,       # 137438953472
+      38 => :send_messages_in_threads,    # 274877906944
+      39 => :use_embedded_activities,     # 549755813888
+      40 => :moderate_members,            # 1099511627776
+      41 => :view_monetization_analytics, # 2199023255552
+      42 => :use_soundboard,              # 4398046511104
+      43 => :create_server_expressions,   # 8796093022208
+      44 => :create_scheduled_events,     # 17592186044416
+      45 => :use_external_sounds,         # 35184372088832
+      46 => :send_voice_messages,         # 70368744177664
+      49 => :send_polls,                  # 562949953421312
+      50 => :use_external_apps,           # 1125899906842624
+      51 => :pin_messages                 # 2251799813685248
     }.freeze
 
     FLAGS.each do |position, flag|
@@ -80,7 +89,7 @@ module Discordrb
     # Initialize the instance variables based on the bitset.
     def init_vars
       FLAGS.each do |position, flag|
-        flag_set = ((@bits >> position) & 0x1) == 1
+        flag_set = (@bits >> position).allbits?(0x1)
         instance_variable_set "@#{flag}", flag_set
       end
     end
@@ -131,12 +140,14 @@ module Discordrb
     #   permissions.defined_permissions #=> [:create_instant_invite, :administrator]
     # @return [Array<Symbol>] the permissions
     def defined_permissions
-      FLAGS.filter_map { |value, name| (@bits & (1 << value)).positive? ? name : nil }
+      FLAGS.filter_map { |value, name| @bits.anybits?((1 << value)) ? name : nil }
     end
 
     # Comparison based on permission bits
     def ==(other)
+      # rubocop:disable Lint/Void
       false unless other.is_a? Discordrb::Permissions
+      # rubocop:enable Lint/Void
       bits == other.bits
     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.5.0'
+  VERSION = '3.6.1'
 end

data/lib/discordrb/websocket.rb

@@ -2,16 +2,6 @@
 
 require 'websocket-client-simple'
 
-# 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
-    # @return [Thread] the internal thread this client is using for the event loop.
-    attr_reader :thread
-  end
-end
-
 module Discordrb
   # Utility wrapper class that abstracts an instance of WSCS. Useful should we decide that WSCS isn't good either -
   # in that case we can just switch to something else

data/lib/discordrb.rb

@@ -46,10 +46,13 @@ module Discordrb
   NO_INTENTS = 0
 
   # Compares two objects based on IDs - either the objects' IDs are equal, or one object is equal to the other's ID.
-  def self.id_compare(one_id, other)
+  def self.id_compare?(one_id, other)
     other.respond_to?(:resolve_id) ? (one_id.resolve_id == other.resolve_id) : (one_id == other)
   end
 
+  # @deprecated Please use {Discordrb.id_compare?}
+  singleton_class.alias_method :id_compare, :id_compare?
+
   # The maximum length a Discord message can have
   CHARACTER_LIMIT = 2000
 
@@ -117,6 +120,19 @@ module Discordrb
       "<t:#{time.to_i}:#{TIMESTAMP_STYLES[style] || style}>"
     end
   end
+
+  # A utility method to base64 encode a file like object using its mime type.
+  # @param file [File, #read] A file like object that responds to #read.
+  # @return [String] The file object encoded as base64 image data.
+  def self.encode64(file)
+    path_method = %i[original_filename path local_path].find { |method| file.respond_to?(method) }
+
+    raise ArgumentError, 'File object must respond to original_filename, path, or local path.' unless path_method
+    raise ArgumentError, 'File object must respond to read.' unless file.respond_to?(:read)
+
+    mime_type = MIME::Types.type_for(file.__send__(path_method)).first&.to_s || 'image/jpeg'
+    "data:#{mime_type};base64,#{Base64.encode64(file.read).strip}"
+  end
 end
 
 # In discordrb, Integer and {String} are monkey-patched to allow for easy resolution of IDs

metadata

@@ -1,16 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.1
 platform: ruby
 authors:
 - meew0
 - swarley
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
@@ -59,28 +72,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: discordrb-webhooks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -121,42 +134,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rspec-prof
   requirement: !ruby/object:Gem::Requirement
@@ -177,70 +190,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.77.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.77.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.25.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.25.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: 0.9.37
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: 0.9.37
 description: A Ruby implementation of the Discord (https://discord.com) API.
 email:
 - ''
@@ -248,12 +261,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".devcontainer/postcreate.sh"
 - ".github/CONTRIBUTING.md"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/pull_request_template.md"
+- ".github/workflows/ci.yml"
 - ".github/workflows/codeql.yml"
+- ".github/workflows/deploy.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".markdownlint.json"
 - ".overcommit.yml"
@@ -294,7 +312,10 @@ files:
 - lib/discordrb/data/application.rb
 - lib/discordrb/data/attachment.rb
 - lib/discordrb/data/audit_logs.rb
+- lib/discordrb/data/avatar_decoration.rb
+- lib/discordrb/data/call.rb
 - lib/discordrb/data/channel.rb
+- lib/discordrb/data/collectibles.rb
 - lib/discordrb/data/component.rb
 - lib/discordrb/data/embed.rb
 - lib/discordrb/data/emoji.rb
@@ -304,11 +325,14 @@ files:
 - lib/discordrb/data/member.rb
 - lib/discordrb/data/message.rb
 - lib/discordrb/data/overwrite.rb
+- lib/discordrb/data/primary_server.rb
 - lib/discordrb/data/profile.rb
 - lib/discordrb/data/reaction.rb
 - lib/discordrb/data/recipient.rb
 - lib/discordrb/data/role.rb
 - lib/discordrb/data/server.rb
+- lib/discordrb/data/server_preview.rb
+- lib/discordrb/data/snapshot.rb
 - lib/discordrb/data/user.rb
 - lib/discordrb/data/voice_region.rb
 - lib/discordrb/data/voice_state.rb
@@ -353,9 +377,11 @@ homepage: https://github.com/shardlab/discordrb
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/shardlab/discordrb/issues
   changelog_uri: https://github.com/shardlab/discordrb/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/shardlab/discordrb/wiki
+  source_code_uri: https://github.com/shardlab/discordrb
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -363,15 +389,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Discord API for Ruby
 test_files: []