discordrb 3.4.3 → 3.6.0

data/lib/discordrb/permissions.rb

@@ -6,37 +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
+      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|
@@ -70,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
@@ -101,7 +120,7 @@ module Discordrb
     #   permission.can_speak = true
     # @example Create a permissions object that could allow/deny read messages, connect, and speak by an array of symbols
     #   Permissions.new [:read_messages, :connect, :speak]
-    # @param bits [Integer, Array<Symbol>] The permission bits that should be set from the beginning, or an array of permission flag symbols
+    # @param bits [String, Integer, Array<Symbol>] The permission bits that should be set from the beginning, or an array of permission flag symbols
     # @param writer [RoleWriter] The writer that should be used to update data when a permission is set.
     def initialize(bits = 0, writer = nil)
       @writer = writer
@@ -109,15 +128,26 @@ module Discordrb
       @bits = if bits.is_a? Array
                 self.class.bits(bits)
               else
-                bits
+                bits.to_i
               end
 
       init_vars
     end
 
+    # Return an array of permission flag symbols for this class's permissions
+    # @example Get the permissions for the bits "9"
+    #   permissions = Permissions.new(9)
+    #   permissions.defined_permissions #=> [:create_instant_invite, :administrator]
+    # @return [Array<Symbol>] the permissions
+    def defined_permissions
+      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
@@ -154,6 +184,12 @@ module Discordrb
     #   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)
+      # For slash commands we may not have access to the server or role
+      # permissions. In this case we use the permissions given to us by the
+      # interaction. If attempting to check against a specific channel the check
+      # is skipped.
+      return @permissions.__send__(action) if @permissions && channel.nil?
+
       # Get the permission the user's roles have
       role_permission = defined_role_permission?(action, channel)
 
@@ -179,7 +215,7 @@ module Discordrb
     private
 
     def defined_role_permission?(action, channel)
-      roles_to_check = [@server.everyone_role] + @roles
+      roles_to_check = [@server.everyone_role] + roles
 
       # For each role, check if
       #   (1) the channel explicitly allows or permits an action for the role and

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.4.3'
+  VERSION = '3.6.0'
 end

data/lib/discordrb/voice/encoder.rb

@@ -102,8 +102,8 @@ module Discordrb::Voice
         '-ar', '48000',
         '-ac', '2',
         'pipe:1',
-        filter_volume_argument,
-      ].concat(options.split).reject {|segment| segment.nil? || segment == '' }
+        filter_volume_argument
+      ].concat(options.split).reject { |segment| segment.nil? || segment == '' }
     end
 
     def filter_volume_argument

data/lib/discordrb/voice/network.rb

@@ -42,10 +42,10 @@ module Discordrb::Voice
     attr_writer :secret_key
 
     # The UDP encryption mode
-    attr_reader :mode # rubocop:disable Style/BisectedAttrAccessor
+    attr_reader :mode
 
     # @!visibility private
-    attr_writer :mode # rubocop:disable Style/BisectedAttrAccessor
+    attr_writer :mode
 
     # Creates a new UDP connection. Only creates a socket as the discovery reply may come before the data is
     # initialized.
@@ -69,9 +69,9 @@ module Discordrb::Voice
     # @return [Array(String, Integer)] the IP and port received from the discovery reply.
     def receive_discovery_reply
       # Wait for a UDP message
-      message = @socket.recv(70)
-      ip = message[4..-3].delete("\0")
-      port = message[-2..-1].unpack1('n')
+      message = @socket.recv(74)
+      ip = message[8..-3].delete("\0")
+      port = message[-2..].unpack1('n')
       [ip, port]
     end
 
@@ -98,10 +98,21 @@ module Discordrb::Voice
     # Sends the UDP discovery packet with the internally stored SSRC. Discord will send a reply afterwards which can
     # be received using {#receive_discovery_reply}
     def send_discovery
-      discovery_packet = [@ssrc].pack('N')
+      # Create empty packet
+      discovery_packet = ''
 
-      # Add 66 zeroes so the packet is 70 bytes long
+      # Add Type request (0x1 = request, 0x2 = response)
+      discovery_packet += [0x1].pack('n')
+
+      # Add Length (excluding Type and itself = 70)
+      discovery_packet += [70].pack('n')
+
+      # Add SSRC
+      discovery_packet += [@ssrc].pack('N')
+
+      # Add 66 zeroes so the packet is 74 bytes long
       discovery_packet += "\0" * 66
+
       send_packet(discovery_packet)
     end
 

data/lib/discordrb/voice/sodium.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require 'ffi'
+
 module Discordrb::Voice
   # @!visibility private
   module Sodium
-    extend FFI::Library
+    extend ::FFI::Library
 
     ffi_lib(['sodium', 'libsodium.so.18', 'libsodium.so.23'])
 

data/lib/discordrb/voice/voice_bot.rb

@@ -22,10 +22,10 @@ module Discordrb::Voice
   # {VoiceBot#adjust_offset}, and {VoiceBot#adjust_average}.
   class VoiceBot
     # @return [Channel] the current voice channel
-    attr_reader :channel # rubocop:disable Style/BisectedAttrAccessor
+    attr_reader :channel
 
     # @!visibility private
-    attr_writer :channel # rubocop:disable Style/BisectedAttrAccessor
+    attr_writer :channel
 
     # @return [Integer, nil] the amount of time the stream has been playing, or `nil` if nothing has been played yet.
     attr_reader :stream_time
@@ -149,7 +149,7 @@ module Discordrb::Voice
 
     # Sets whether or not the bot is speaking (green circle around user).
     # @param value [true, false, Integer] whether or not the bot should be speaking, or a bitmask denoting the audio type
-    # @note https://discordapp.com/developers/docs/topics/voice-connections#speaking for information on the speaking bitmask
+    # @note https://discord.com/developers/docs/topics/voice-connections#speaking for information on the speaking bitmask
     def speaking=(value)
       @playing = value
       @ws.send_speaking(value)

data/lib/discordrb/webhooks.rb

@@ -4,6 +4,8 @@ require 'discordrb/webhooks/version'
 require 'discordrb/webhooks/embeds'
 require 'discordrb/webhooks/client'
 require 'discordrb/webhooks/builder'
+require 'discordrb/webhooks/view'
+require 'discordrb/webhooks/modal'
 
 module Discordrb
   # Webhook client

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

@@ -10,13 +10,13 @@ module Discordrb
   Thread.current[:discordrb_name] = 'main'
 
   # The default debug logger used by discordrb.
-  LOGGER = Logger.new(ENV['DISCORDRB_FANCY_LOG'])
+  LOGGER = Logger.new(ENV.fetch('DISCORDRB_FANCY_LOG', false))
 
   # The Unix timestamp Discord IDs are based on
   DISCORD_EPOCH = 1_420_070_400_000
 
   # Used to declare what events you wish to recieve from Discord.
-  # @see https://discordapp.com/developers/docs/topics/gateway#gateway-intents
+  # @see https://discord.com/developers/docs/topics/gateway#gateway-intents
   INTENTS = {
     servers: 1 << 0,
     server_members: 1 << 1,
@@ -35,17 +35,39 @@ module Discordrb
     direct_message_typing: 1 << 14
   }.freeze
 
-  # @return [Integer] All available intents
+  # All available intents
   ALL_INTENTS = INTENTS.values.reduce(&:|)
 
+  # All unprivileged intents
+  # @see https://discord.com/developers/docs/topics/gateway#privileged-intents
+  UNPRIVILEGED_INTENTS = ALL_INTENTS & ~(INTENTS[:server_members] | INTENTS[:server_presences])
+
+  # No intents
+  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
 
+  # For creating timestamps with {timestamp}
+  # @see https://discord.com/developers/docs/reference#message-formatting-timestamp-styles
+  TIMESTAMP_STYLES = {
+    short_time: 't', # 16:20
+    long_time: 'T', # 16:20:30
+    short_date: 'd', # 20/04/2021
+    long_date: 'D', # 20 April 2021
+    short_datetime: 'f', # 20 April 2021 16:20
+    long_datetime: 'F', # Tuesday, 20 April 2021 16:20
+    relative: 'R' # 2 months ago
+  }.freeze
+
   # Splits a message into chunks of 2000 characters. Attempts to split by lines if possible.
   # @param msg [String] The message to split.
   # @return [Array<String>] the message split into chunks
@@ -76,7 +98,7 @@ module Discordrb
     ideal_ary = ideal.length > CHARACTER_LIMIT ? ideal.split(/(.{1,#{CHARACTER_LIMIT}}\b|.{1,#{CHARACTER_LIMIT}})/o).reject(&:empty?) : [ideal]
 
     # Slice off the ideal part and strip newlines
-    rest = msg[ideal.length..-1].strip
+    rest = msg[ideal.length..].strip
 
     # If none remains, return an empty array -> we're done
     return [] unless rest
@@ -84,6 +106,33 @@ module Discordrb
     # Otherwise, call the method recursively to split the rest of the string and add it onto the ideal array
     ideal_ary + split_message(rest)
   end
+
+  # @param time [Time, Integer] The time to create the timestamp from, or a unix timestamp integer.
+  # @param style [Symbol, String] One of the keys from {TIMESTAMP_STYLES} or a string with the style.
+  # @return [String]
+  # @example
+  #   Discordrb.timestamp(Time.now, :short_time)
+  #   # => "<t:1632146954:t>"
+  def self.timestamp(time, style = nil)
+    if style.nil?
+      "<t:#{time.to_i}>"
+    else
+      "<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