onyxcord 2.1.0 → 3.2.1

data/lib/onyxcord/voice/network.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-# Voice networking — uses OnyxCord::WebSocket (async-websocket based)
+# Voice networking — uses OnyxCord::Internal::WebSocket (async-websocket based)
 require 'socket'
-require 'onyxcord/json'
-
-require 'onyxcord/websocket'
+require_relative '../internal/json'
+require_relative '../internal/websocket'
 require 'onyxcord/voice/opcodes'
 
 begin
@@ -32,357 +31,6 @@ module OnyxCord::Voice
   # Encryption modes supported by Discord
   ENCRYPTION_MODES = %w[aead_xchacha20_poly1305_rtpsize].freeze
 
-  # Represents a UDP connection to a voice server. This connection is used to send the actual audio data.
-  class VoiceUDP
-    # @return [true, false] whether or not UDP communications are encrypted.
-    # @deprecated Discord no longer supports unencrypted voice communication.
-    attr_accessor :encrypted
-    alias_method :encrypted?, :encrypted
-
-    # Sets the secret key used for encryption
-    attr_writer :secret_key
-
-    # The UDP encryption mode
-    attr_reader :mode
-
-    # @!visibility private
-    attr_writer :mode
-
-    # Creates a new UDP connection. Only creates a socket as the discovery reply may come before the data is
-    # initialized.
-    def initialize
-      @socket = UDPSocket.new
-      @encrypted = true
-    end
-
-    # Initializes the UDP socket with data obtained from opcode 2.
-    # @param ip [String] The IP address to connect to.
-    # @param port [Integer] The port to connect to.
-    # @param ssrc [Integer] The Super Secret Relay Code (SSRC). Discord uses this to identify different voice users
-    #   on the same endpoint.
-    def connect(ip, port, ssrc)
-      @ip = ip
-      @port = port
-      @ssrc = ssrc
-    end
-
-    # Waits for a UDP discovery reply, and returns the sent data.
-    # @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(74)
-      ip = message[8..-3].delete("\0")
-      port = message[-2..].unpack1('n')
-      [ip, port]
-    end
-
-    # Makes an audio packet from a buffer and sends it to Discord.
-    # @param buf [String] The audio data to send, must be exactly one Opus frame
-    # @param sequence [Integer] The packet sequence number, incremented by one for subsequent packets
-    # @param time [Integer] When this packet should be played back, in no particular unit (essentially just the
-    #   sequence number multiplied by 960)
-    def send_audio(buf, sequence, time)
-      # Header of the audio packet
-      header = generate_header(sequence, time)
-
-      nonce = generate_nonce
-      buf = encrypt_audio(buf, header, nonce)
-      data = header + buf + nonce.byteslice(0, 4)
-
-      send_packet(data)
-    end
-
-    # 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
-      # Create empty packet
-      discovery_packet = ''
-
-      # 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
-
-    def close
-      @socket.close unless @socket.closed?
-    end
-
-    private
-
-    # Encrypts audio data using libsodium
-    # @param buf [String] The encoded audio data to be encrypted
-    # @param header [String] The RTP header of the packet, used as associated data
-    # @param nonce [String] The nonce to be used to encrypt the data
-    # @return [String] the audio data, encrypted
-    def encrypt_audio(buf, header, nonce)
-      raise 'No secret key found, despite encryption being enabled!' unless @secret_key
-
-      case @mode
-      when 'aead_xchacha20_poly1305_rtpsize'
-        OnyxCord::Voice::XChaCha20AEAD.encrypt(buf, header, nonce, @secret_key)
-      else
-        raise "`#{@mode}' is not a supported encryption mode"
-      end
-    end
-
-    def send_packet(packet)
-      @socket.send(packet, 0, @ip, @port)
-    end
-
-    # @return [String]
-    def generate_nonce
-      case @mode
-      when 'aead_xchacha20_poly1305_rtpsize'
-        case @incremental_nonce
-        when nil, 0xff_ff_ff_ff
-          @incremental_nonce = 0
-        else
-          @incremental_nonce += 1
-        end
-        [@incremental_nonce].pack('N').ljust(24, "\0")
-      else
-        raise "`#{@mode}' is not a supported encryption mode"
-      end
-    end
-
-    # @return [String]
-    def generate_header(sequence, time)
-      [0x80, 0x78, sequence, time, @ssrc].pack('CCnNN')
-    end
-  end
-
-  # Represents a websocket client connection to the voice server. The websocket connection (sometimes called vWS) is
-  # used to manage general data about the connection, such as sending the speaking packet, which determines the green
-  # circle around users on Discord, and obtaining UDP connection info.
-  class VoiceWS
-    # The version of the voice gateway that's supposed to be used.
-    VOICE_GATEWAY_VERSION = 8
-
-    # @return [VoiceUDP] the UDP voice connection over which the actual audio data is sent.
-    attr_reader :udp
-
-    # Makes a new voice websocket client, but doesn't connect it (see {#connect} for that)
-    # @param channel [Channel] The voice channel to connect to
-    # @param bot [Bot] The regular bot to which this vWS is bound
-    # @param token [String] The authentication token which is also used for REST requests
-    # @param session [String] The voice session ID Discord sends over the regular websocket
-    # @param endpoint [String] The endpoint URL to connect to
-    def initialize(channel, bot, token, session, endpoint)
-      raise 'libsodium is unavailable - unable to create voice bot! Please read https://github.com/kruldevb/OnyxCord/wiki/Installing-libsodium' unless LIBSODIUM_AVAILABLE
-
-      @channel = channel
-      @bot = bot
-      @token = token
-      @session = session
-
-      @endpoint = endpoint
-
-      @udp = VoiceUDP.new
-    end
-
-    # Send a connection init packet (op 0)
-    # @param server_id [Integer] The ID of the server to connect to
-    # @param bot_user_id [Integer] The ID of the bot that is connecting
-    # @param session_id [String] The voice session ID
-    # @param token [String] The Discord authentication token
-    def send_init(server_id, bot_user_id, session_id, token)
-      send_opcode(
-        Opcodes::IDENTIFY,
-        {
-          server_id: server_id,
-          user_id: bot_user_id,
-          session_id: session_id,
-          token: token
-        }
-      )
-    end
-
-    # Sends the UDP connection packet (op 1)
-    # @param ip [String] The IP to bind UDP to
-    # @param port [Integer] The port to bind UDP to
-    # @param mode [Object] Which mode to use for the voice connection
-    def send_udp_connection(ip, port, mode)
-      send_opcode(
-        Opcodes::SELECT_PROTOCOL,
-        {
-          protocol: 'udp',
-          data: {
-            address: ip,
-            port: port,
-            mode: mode
-          }
-        }
-      )
-    end
-
-    # Send a heartbeat (op 3), has to be done every @heartbeat_interval seconds or the connection will terminate
-    def send_heartbeat
-      millis = Time.now.strftime('%s%L').to_i
-      @bot.debug("Sending voice heartbeat at #{millis}")
-
-      send_opcode(
-        Opcodes::HEARTBEAT,
-        {
-          t: millis,
-          seq_ack: @seq
-        }
-      )
-    end
-
-    # Send a speaking packet (op 5). This determines the green circle around the avatar in the voice channel
-    # @param value [true, false, Integer] Whether or not the bot should be speaking, can also be a bitmask denoting audio type.
-    def send_speaking(value)
-      @bot.debug("Speaking: #{value}")
-      send_opcode(
-        Opcodes::SPEAKING,
-        {
-          speaking: value,
-          delay: 0
-        }
-      )
-    end
-
-    def send_opcode(opcode, data)
-      @bot.debug("Sending voice opcode #{opcode} with data: #{data}")
-      @client.send({
-        op: opcode,
-        d: data
-      }.to_json)
-    end
-
-    # Event handlers; public for websocket-simple to work correctly
-    # @!visibility private
-    def websocket_open
-      # Give the current thread a name ('Voice Web Socket Internal')
-      Thread.current[:onyxcord_name] = 'vws-i'
-
-      # Send the init packet
-      send_init(@channel.server.id, @bot.profile.id, @session, @token)
-    end
-
-    # @!visibility private
-    def websocket_message(msg)
-      @bot.debug("Received VWS message! #{msg}")
-      packet = JSON.parse(msg)
-
-      @seq = packet['seq'] if packet['seq']
-
-      case packet['op']
-      when OnyxCord::Voice::Opcodes::READY
-        # Opcode 2 contains data to initialize the UDP connection
-        @ws_data = packet['d']
-
-        @ssrc = @ws_data['ssrc']
-        @port = @ws_data['port']
-
-        @udp_mode = (ENCRYPTION_MODES & @ws_data['modes']).first
-
-        @udp.connect(@ws_data['ip'], @port, @ssrc)
-        @udp.send_discovery
-      when OnyxCord::Voice::Opcodes::SESSION_DESCRIPTION
-        # Opcode 4 sends the secret key used for encryption
-        @ws_data = packet['d']
-
-        # Reset the sequence when starting a new session
-        @seq = 0
-
-        @ready = true
-        @udp.secret_key = @ws_data['secret_key'].pack('C*')
-        @udp.mode = @ws_data['mode']
-      when OnyxCord::Voice::Opcodes::HELLO
-        # Opcode 8 contains the heartbeat interval.
-        @heartbeat_interval = packet['d']['heartbeat_interval']
-        send_heartbeat
-      end
-    end
-
-    # Communication goes like this:
-    # me                    discord
-    #   |                      |
-    # websocket connect ->     |
-    #   |                      |
-    #   |     <- websocket opcode 2
-    #   |                      |
-    # UDP discovery ->         |
-    #   |                      |
-    #   |       <- UDP reply packet
-    #   |                      |
-    # websocket opcode 1 ->    |
-    #   |                      |
-    # ...
-    def connect
-      # Connect websocket
-      @thread = Thread.new do
-        Thread.current[:onyxcord_name] = 'vws'
-        init_ws
-      end
-
-      @bot.debug('Started websocket initialization, now waiting for UDP discovery reply')
-
-      # Now wait for opcode 2 and the resulting UDP reply packet
-      ip, port = @udp.receive_discovery_reply
-      @bot.debug("UDP discovery reply received! #{ip} #{port}")
-
-      # Send UDP init packet with received UDP data
-      send_udp_connection(ip, port, @udp_mode)
-
-      @bot.debug('Waiting for op 4 now')
-
-      # Wait for op 4, then finish
-      sleep 0.05 until @ready
-    end
-
-    # Disconnects the websocket and kills the thread
-    def destroy(join_timeout = 1)
-      @heartbeat_running = false
-      @client&.close
-      @udp.close
-      @thread&.join(join_timeout)
-      @thread&.kill if @thread&.alive?
-    end
-
-    private
-
-    def heartbeat_loop
-      @heartbeat_running = true
-      while @heartbeat_running
-        if @heartbeat_interval
-          sleep @heartbeat_interval / 1000.0
-          send_heartbeat
-        else
-          # If no interval has been set yet, sleep a second and check again
-          sleep 1
-        end
-      end
-    end
-
-    def init_ws
-      host = "wss://#{@endpoint}/?v=#{VOICE_GATEWAY_VERSION}"
-      @bot.debug("Connecting VWS to host: #{host}")
-
-      # Connect the WS
-      @client = OnyxCord::WebSocket.new(
-        host,
-        method(:websocket_open),
-        method(:websocket_message),
-        proc { |e| OnyxCord::LOGGER.error "VWS error: #{e}" },
-        proc { |e| OnyxCord::LOGGER.warn "VWS close: #{e}" }
-      )
-
-      @bot.debug('VWS connected')
-
-      # Block any further execution
-      heartbeat_loop
-    end
-  end
+  require 'onyxcord/voice/network/udp'
+  require 'onyxcord/voice/network/websocket'
 end

data/lib/onyxcord/webhooks/builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'onyxcord/webhooks/embeds'
-require 'onyxcord/message_components'
+require 'onyxcord/utils/message_components'
 
 module OnyxCord::Webhooks
   # A class that acts as a builder for a webhook message object.

data/lib/onyxcord/webhooks/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'onyxcord/http'
-require 'onyxcord/json'
+require 'onyxcord/internal/http'
+require 'onyxcord/internal/json'
 
 require 'onyxcord/webhooks/builder'
 
@@ -38,7 +38,7 @@ module OnyxCord::Webhooks
     #       embed.image = OnyxCord::Webhooks::EmbedImage.new(url: 'https://i.imgur.com/PcMltU7.jpg')
     #     end
     #   end
-    # @return [OnyxCord::HTTP::Response] the response returned by Discord.
+    # @return [::OnyxCord::Internal::HTTP::Response] the response returned by Discord.
     def execute(builder = nil, wait = false, components = nil, thread_id: nil, flags: nil, has_components: false, components_v2: false)
       raise TypeError, 'builder needs to be nil or like a OnyxCord::Webhooks::Builder!' unless
         (builder.respond_to?(:file) && builder.respond_to?(:to_multipart_hash)) || builder.respond_to?(:to_json_hash) || builder.nil?
@@ -61,9 +61,9 @@ module OnyxCord::Webhooks
     # @param name [String, nil] The default name.
     # @param avatar [String, #read, nil] The new avatar, in base64-encoded JPG format.
     # @param channel_id [String, Integer, nil] The channel to move the webhook to.
-    # @return [OnyxCord::HTTP::Response] the response returned by Discord.
+    # @return [::OnyxCord::Internal::HTTP::Response] the response returned by Discord.
     def modify(name: nil, avatar: nil, channel_id: nil)
-      OnyxCord::HTTP.patch(
+      ::OnyxCord::Internal::HTTP.patch(
         @url,
         { name: name, avatar: avatarise(avatar), channel_id: channel_id }.compact.to_json,
         'content-type' => 'application/json'
@@ -72,10 +72,10 @@ module OnyxCord::Webhooks
 
     # Delete this webhook.
     # @param reason [String, nil] The reason this webhook was deleted.
-    # @return [OnyxCord::HTTP::Response] the response returned by Discord.
+    # @return [::OnyxCord::Internal::HTTP::Response] the response returned by Discord.
     # @note This is permanent and cannot be undone.
     def delete(reason: nil)
-      OnyxCord::HTTP.delete(@url, 'X-Audit-Log-Reason' => reason)
+      ::OnyxCord::Internal::HTTP.delete(@url, 'X-Audit-Log-Reason' => reason)
     end
 
     # Edit a message from this webhook.
@@ -85,7 +85,7 @@ module OnyxCord::Webhooks
     # @param embeds [Array<Embed, Hash>]
     # @param allowed_mentions [Hash]
     # @param thread_id [String, Integer, nil] The id of the thread in which the message resides
-    # @return [OnyxCord::HTTP::Response] the response returned by Discord.
+    # @return [::OnyxCord::Internal::HTTP::Response] the response returned by Discord.
     # @example Edit message content
     #   client.edit_message(message_id, content: 'goodbye world!')
     # @example Edit a message via builder
@@ -106,7 +106,7 @@ module OnyxCord::Webhooks
       builder_flags = data[:flags] if data.is_a?(Hash)
       flags = View.apply_v2_flag(flags || builder_flags, components, force: has_components || components_v2)
       data = data.merge({ content: content, embeds: embeds, allowed_mentions: allowed_mentions, components: components, flags: flags }.compact)
-      OnyxCord::HTTP.patch(
+      ::OnyxCord::Internal::HTTP.patch(
         "#{@url}/messages/#{message_id}#{(query.empty? ? '' : "?#{query}")}",
         data.compact.to_json,
         'content-type' => 'application/json'
@@ -115,9 +115,9 @@ module OnyxCord::Webhooks
 
     # Delete a message created by this webhook.
     # @param message_id [String, Integer] The ID of the message to delete.
-    # @return [OnyxCord::HTTP::Response] the response returned by Discord.
+    # @return [::OnyxCord::Internal::HTTP::Response] the response returned by Discord.
     def delete_message(message_id)
-      OnyxCord::HTTP.delete("#{@url}/messages/#{message_id}")
+      ::OnyxCord::Internal::HTTP.delete("#{@url}/messages/#{message_id}")
     end
 
     private
@@ -139,7 +139,7 @@ module OnyxCord::Webhooks
       flags = View.apply_v2_flag(flags || builder_flags, components, force: has_components)
       data = data.merge({ components: components })
       data[:flags] = flags unless flags.nil?
-      OnyxCord::HTTP.post(
+      ::OnyxCord::Internal::HTTP.post(
         encode_url(wait, thread_id, with_components: components.any?),
         data.to_json,
         'content-type' => 'application/json'
@@ -153,7 +153,7 @@ module OnyxCord::Webhooks
       flags = View.apply_v2_flag(flags || builder_flags, components, force: has_components)
       data[:components] = components if components.any?
       data[:flags] = flags unless flags.nil?
-      OnyxCord::HTTP.post(
+      ::OnyxCord::Internal::HTTP.post(
         encode_url(wait, thread_id, with_components: components.any?),
         data.compact
       )

data/lib/onyxcord/webhooks/modal/group_builder.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+class OnyxCord::Webhooks::Modal
+  class GroupBuilder
+    # @!visibility private
+    def initialize(type, custom_id, id, options = [], required = nil, min_values = nil, max_values = nil)
+      @id = id
+      @type = type
+      @custom_id = custom_id
+      @options = options
+      @required = required
+      @min_values = min_values
+      @max_values = max_values
+    end
+
+    # Add a checkbox component to the group.
+    # @param value [String] The value that the checkbox represents.
+    # @param label [String] The primary text of the checkbox.
+    # @param description [String, nil] The description of the checkbox.
+    # @param default [true, false, nil] Whether or not the checkbox should be checked by default.
+    def checkbox(value:, label:, description: nil, default: nil)
+      raise "Cannot add a checkbox to a #{@type}" unless @type == :checkbox_group
+
+      @options << { value: value, label: label, description: description, default: default }.compact
+    end
+
+    # Add a radio button component to the group.
+    # @param value [String] The value that the radio button represents.
+    # @param label [String] The primary text of the radio button.
+    # @param description [String, nil] The description of the radio button.
+    # @param default [true, false, nil] Whether or not the radio button should be selected by default.
+    def radio_button(value:, label:, description: nil, default: nil)
+      raise "Cannot add a radio button to a #{@type}" unless @type == :radio_group
+
+      @options << { value: value, label: label, description: description, default: default }.compact
+    end
+
+    alias_method :button, :radio_button
+
+    # @!visibility private
+    def to_h
+      {
+        id: @id,
+        type: COMPONENT_TYPES[@type],
+        custom_id: @custom_id,
+        options: @options.map(&:to_h),
+        required: @required,
+        min_values: @min_values,
+        max_values: @max_values
+      }.compact
+    end
+  end
+
+  # This builder is used when adding a label component to a modal.
+end