disrb 0.1.3 → 0.1.4.1

data/lib/disrb.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'uri'
 require 'async'
 require 'async/http/endpoint'
 require 'async/websocket/client'
 require 'faraday'
+require 'faraday/multipart'
+require 'stringio'
 require_relative 'disrb/guild'
 require_relative 'disrb/logger'
 require_relative 'disrb/user'
 require_relative 'disrb/message'
 require_relative 'disrb/application_commands'
+require_relative 'version'
 
 # Contains functions related to Discord snowflakes.
 class Snowflake
@@ -47,7 +51,6 @@ class Snowflake
 end
 
 # Class that contains functions that allow interacting with the Discord API.
-# @version 0.1.3
 class DiscordApi
   # @!attribute [r] base_url
   #   @return [String] the base URL that is used to access the Discord API. ex: "https://discord.com/api/v10"
@@ -55,13 +58,16 @@ class DiscordApi
   #   @return [String] the authorization header that is used to authenticate requests to the Discord API.
   # @!attribute [r] application_id
   #   @return [Integer] the application ID of the bot that has been assigned to the provided authorization token.
-  attr_accessor(:base_url, :authorization_header, :application_id, :logger)
+  attr_accessor(:base_url, :authorization_header, :application_id, :logger, :user_agent)
 
   # Creates a new DiscordApi instance. (required to use most functions)
   #
   # @param authorization_token_type [String] The type of authorization token provided by Discord, 'Bot' or 'Bearer'.
   # @param authorization_token [String] The value of the authorization token provided by Discord.
   # @param verbosity_level [String, Integer, nil] The verbosity level of the logger.
+  # @param user_agent [String, nil] When sending a request to Discord's HTTP API, a valid User-Agent header must be set.
+  #   By setting this parameter, the value of the User-Agent header sent will be equal to the value of this parameter.
+  #   Defaults to 'discord.rb (https://github.com/hoovad/discord.rb, [discord.rb version])'
   # Set verbosity_level to:
   # - 'all' or 5 to log all of the below plus debug messages
   # - 'info', 4 or nil to log all of the below plus info messages [DEFAULT]
@@ -70,7 +76,7 @@ class DiscordApi
   # - 'fatal_error' or 1 to log only fatal errors
   # - 'none' or 0 for no logging
   # @return [DiscordApi] DiscordApi instance.
-  def initialize(authorization_token_type, authorization_token, verbosity_level = nil)
+  def initialize(authorization_token_type, authorization_token, verbosity_level = nil, user_agent = nil)
     @api_version = '10'
     @base_url = "https://discord.com/api/v#{@api_version}"
     @authorization_token_type = authorization_token_type
@@ -108,13 +114,23 @@ class DiscordApi
       @verbosity_level = 4
     end
     @logger = Logger2.new(@verbosity_level)
+    default_user_agent = "discord.rb (https://github.com/hoovad/discord.rb, #{DiscordApi::VERSION})"
+    if user_agent.is_a?(String) && !user_agent.empty?
+      @user_agent = user_agent
+    elsif user_agent.nil?
+      @user_agent = default_user_agent
+    else
+      @logger.warn("Invalid user_agent parameter. It must be a valid non-empty string. \
+                   Defaulting to #{default_user_agent}.")
+      @user_agent = default_user_agent
+    end
     url = "#{@base_url}/applications/@me"
     headers = { 'Authorization': @authorization_header }
-    response = DiscordApi.get(url, headers)
-    if response.status == 200
+    response = get(url, headers)
+    if response.is_a?(Faraday::Response) && response.status == 200
       @application_id = JSON.parse(response.body)['id']
     else
-      @logger.fatal_error("Failed to get application ID with response: #{response.body}")
+      @logger.fatal_error("Failed to get application ID with response: #{response_error_body(response)}")
       exit
     end
   end
@@ -237,11 +253,11 @@ class DiscordApi
       loop do
         recieved_ready = false
         url = if rescue_connection.nil?
-                response = DiscordApi.get("#{@base_url}/gateway")
-                if response.status == 200
+                response = get("#{@base_url}/gateway")
+                if response.is_a?(Faraday::Response) && response.status == 200
                   "#{JSON.parse(response.body)['url']}/?v=#{@api_version}&encoding=json"
                 else
-                  @logger.fatal_error("Failed to get gateway URL. Response: #{response.body}")
+                  @logger.fatal_error("Failed to get gateway URL. Response: #{response_error_body(response)}")
                   exit
                 end
               else
@@ -353,18 +369,25 @@ class DiscordApi
   # @param interaction [Hash] The interaction payload received from the Gateway.
   # @param response [Hash] The interaction response payload.
   # @param with_response [TrueClass, FalseClass] Whether to request the created message in the response.
+  # @param files [Array] An array of arrays, each inner-array first has its filename (index 0),
+  #   raw file data as a string (index 1), and then the MIME type of the file (index 2).
   # @return [Faraday::Response] The response from the Discord API.
-  def respond_interaction(interaction, response, with_response: false)
+  def respond_interaction(interaction, response, with_response: false, files: nil)
     query_string_hash = {}
     query_string_hash[:with_response] = with_response
     query_string = DiscordApi.handle_query_strings(query_string_hash)
     url = "#{@base_url}/interactions/#{interaction[:d][:id]}/#{interaction[:d][:token]}/callback#{query_string}"
     data = JSON.generate(response)
-    headers = { 'content-type': 'application/json' }
-    response = DiscordApi.post(url, data, headers)
-    return response if (response.status == 204 && !with_response) || (response.status == 200 && with_response)
+    if files
+      response = file_upload(url, files, payload_json: data)
+    else
+      headers = { 'Content-Type' => 'application/json' }
+      response = post(url, data, headers)
+    end
+    return response if response.is_a?(Faraday::Response) &&
+                       ((response.status == 204 && !with_response) || (response.status == 200 && with_response))
 
-    @logger.error("Failed to respond to interaction. Response: #{response.body}")
+    @logger.error("Failed to respond to interaction. Response: #{response_error_body(response)}")
     response
   end
 
@@ -480,91 +503,216 @@ class DiscordApi
     intents.reduce(0) { |acc, n| acc | n }
   end
 
+  private
+
+  # If 'response' is a Faraday::Response object, returns response.body, else, returns 'Empty'
+  # @param response [Object] Any object
+  # @return [String] response.body if response is a Faraday::Response object, else 'Empty'
+  def response_error_body(response)
+    return response.body if response.is_a?(Faraday::Response)
+
+    'Empty'
+  end
+
+  # Parses a full URL and returns connection host and request path.
+  # @param url [String] Full URL.
+  # @param method_name [String] HTTP method name used for logging context.
+  # @return [Hash, nil] { host:, path: } or nil if URL is invalid.
+  def parse_request_url(url, method_name)
+    begin
+      uri = URI.parse(url.to_s)
+    rescue URI::InvalidURIError
+      @logger.error("Empty/invalid URL provided: #{url}. Cannot perform #{method_name} request.")
+      return nil
+    end
+    if uri.scheme.nil? || uri.host.nil?
+      @logger.error("Empty/invalid URL provided: #{url}. Cannot perform #{method_name} request.")
+      return nil
+    end
+
+    host = "#{uri.scheme}://#{uri.host}"
+    host = "#{host}:#{uri.port}" if uri.port && uri.port != uri.default_port
+    { host: host, path: uri.request_uri }
+  end
+
   # Performs an HTTP GET request using Faraday.
   # @param url [String] Full URL including scheme and host; path may be included.
   # @param headers [Hash, nil] Optional request headers.
-  # @return [Faraday::Response] The Faraday response object.
-  def self.get(url, headers = nil)
-    split_url = url.split(%r{(http[^/]+)(/.*)}).reject(&:empty?)
-    @logger.error("Empty/invalid URL provided: #{url}. Cannot perform GET request.") if split_url.empty?
-    host = split_url[0]
-    path = split_url[1] if split_url[1]
-    conn = Faraday.new(url: host, headers: headers)
-    if path
-      conn.get(path)
+  # @return [Faraday::Response, nil] The Faraday response object, or nil if an error was encountered.
+  def get(url, headers = nil)
+    parsed_url = parse_request_url(url, 'GET')
+    return if parsed_url.nil?
+
+    host = parsed_url[:host]
+    path = parsed_url[:path]
+    if headers.is_a?(Hash)
+      headers['User-Agent'] = @user_agent
+    elsif headers.nil?
+      headers = { 'User-Agent' => @user_agent }
     else
-      conn.get
+      @logger.warn('Invalid headers parameter. It will be discarded.')
+      headers = { 'User-Agent' => @user_agent }
     end
+    conn = Faraday.new(url: host, headers: headers)
+    conn.get(path)
   end
 
   # Performs an HTTP DELETE request using Faraday.
   # @param url [String] Full URL including scheme and host; path may be included.
   # @param headers [Hash, nil] Optional request headers.
-  # @return [Faraday::Response] The Faraday response object.
-  def self.delete(url, headers = nil)
-    split_url = url.split(%r{(http[^/]+)(/.*)}).reject(&:empty?)
-    @logger.error("Empty/invalid URL provided: #{url}. Cannot perform DELETE request.") if split_url.empty?
-    host = split_url[0]
-    path = split_url[1] if split_url[1]
-    conn = Faraday.new(url: host, headers: headers)
-    if path
-      conn.delete(path)
+  # @return [Faraday::Response, nil] The Faraday response object, or nil if an error was encountered.
+  def delete(url, headers = nil)
+    parsed_url = parse_request_url(url, 'DELETE')
+    return if parsed_url.nil?
+
+    host = parsed_url[:host]
+    path = parsed_url[:path]
+    if headers.is_a?(Hash)
+      headers['User-Agent'] = @user_agent
+    elsif headers.nil?
+      headers = { 'User-Agent' => @user_agent }
     else
-      conn.delete
+      @logger.warn('Invalid headers parameter. It will be discarded.')
+      headers = { 'User-Agent' => @user_agent }
     end
+    conn = Faraday.new(url: host, headers: headers)
+    conn.delete(path)
   end
 
   # Performs an HTTP POST request using Faraday.
   # @param url [String] Full URL including scheme and host; path may be included.
   # @param data [String] Serialized request body (e.g., JSON string).
   # @param headers [Hash, nil] Optional request headers.
-  # @return [Faraday::Response] The Faraday response object.
-  def self.post(url, data, headers = nil)
-    split_url = url.split(%r{(http[^/]+)(/.*)}).reject(&:empty?)
-    @logger.error("Empty/invalid URL provided: #{url}. Cannot perform POST request.") if split_url.empty?
-    host = split_url[0]
-    path = split_url[1] if split_url[1]
-    conn = Faraday.new(url: host, headers: headers)
-    if path
-      conn.post(path, data)
+  # @return [Faraday::Response, nil] The Faraday response object, or nil if an error was encountered.
+  def post(url, data, headers = nil)
+    parsed_url = parse_request_url(url, 'POST')
+    return if parsed_url.nil?
+
+    host = parsed_url[:host]
+    path = parsed_url[:path]
+    if headers.is_a?(Hash)
+      headers['User-Agent'] = @user_agent
+    elsif headers.nil?
+      headers = { 'User-Agent' => @user_agent }
     else
-      conn.post('', data)
+      @logger.warn('Invalid headers parameter. It will be discarded.')
+      headers = { 'User-Agent' => @user_agent }
     end
+    conn = Faraday.new(url: host, headers: headers)
+    conn.post(path, data)
   end
 
   # Performs an HTTP PATCH request using Faraday.
   # @param url [String] Full URL including scheme and host; path may be included.
   # @param data [String] Serialized request body (e.g., JSON string).
   # @param headers [Hash, nil] Optional request headers.
-  # @return [Faraday::Response] The Faraday response object.
-  def self.patch(url, data, headers = nil)
-    split_url = url.split(%r{(http[^/]+)(/.*)}).reject(&:empty?)
-    @logger.error("Empty/invalid URL provided: #{url}. Cannot perform PATCH request.") if split_url.empty?
-    host = split_url[0]
-    path = split_url[1] if split_url[1]
-    conn = Faraday.new(url: host, headers: headers)
-    if path
-      conn.patch(path, data)
+  # @return [Faraday::Response, nil] The Faraday response object, or nil if an error was encountered.
+  def patch(url, data, headers = nil)
+    parsed_url = parse_request_url(url, 'PATCH')
+    return if parsed_url.nil?
+
+    host = parsed_url[:host]
+    path = parsed_url[:path]
+    if headers.is_a?(Hash)
+      headers['User-Agent'] = @user_agent
+    elsif headers.nil?
+      headers = { 'User-Agent' => @user_agent }
     else
-      conn.patch('', data)
+      @logger.warn('Invalid headers parameter. It will be discarded.')
+      headers = { 'User-Agent' => @user_agent }
     end
+    conn = Faraday.new(url: host, headers: headers)
+    conn.patch(path, data)
   end
 
   # Performs an HTTP PUT request using Faraday.
   # @param url [String] Full URL including scheme and host; path may be included.
   # @param data [String] Serialized request body (e.g., JSON string).
   # @param headers [Hash, nil] Optional request headers.
-  # @return [Faraday::Response] The Faraday response object.
-  def self.put(url, data, headers = nil)
-    split_url = url.split(%r{(http[^/]+)(/.*)}).reject(&:empty?)
-    @logger.error("Empty/invalid URL provided: #{url}. Cannot perform PUT request.") if split_url.empty?
-    host = split_url[0]
-    path = split_url[1] if split_url[1]
+  # @return [Faraday::Response, nil] The Faraday response object, or nil if an error was encountered.
+  def put(url, data, headers = nil)
+    parsed_url = parse_request_url(url, 'PUT')
+    return if parsed_url.nil?
+
+    host = parsed_url[:host]
+    path = parsed_url[:path]
+    if headers.is_a?(Hash)
+      headers['User-Agent'] = @user_agent
+    elsif headers.nil?
+      headers = { 'User-Agent' => @user_agent }
+    else
+      @logger.warn('Invalid headers parameter. It will be discarded.')
+      headers = { 'User-Agent' => @user_agent }
+    end
     conn = Faraday.new(url: host, headers: headers)
-    if path
-      conn.put(path, data)
+    conn.put(path, data)
+  end
+
+  # Sends a HTTP POST/PATCH request to the specified URL, containing multipart/form-data data structured
+  #   according to Discord documentation.
+  # See https://docs.discord.com/developers/reference#uploading-files
+  # @param url [String] Full URL including scheme and host; path may be included.
+  # @param payload_json [String] JSON data which will be included in the request under the 'payload_json'
+  #   Content-Disposition.
+  # @param files [Array] An array of arrays, each inner-array first has its filename (index 0),
+  #   raw file data as a string (index 1), and then the MIME type of the file (index 2).
+  # @param headers [Hash, nil] Optional request headers.
+  # @param request_type [Symbol, nil] Specify whether to make a POST (:post) or PATCH (:patch) request. POST by default.
+  # @return [Faraday::Response, nil] The Faraday response object, or nil if an error was encountered.
+  def file_upload(url, files, payload_json: nil, headers: nil, request_type: :post)
+    parsed_url = parse_request_url(url, 'multipart/form-data')
+    return if parsed_url.nil?
+
+    host = parsed_url[:host]
+    path = parsed_url[:path]
+    if headers.is_a?(Hash)
+      headers['User-Agent'] = @user_agent
+    elsif headers.nil?
+      headers = { 'User-Agent' => @user_agent }
+    else
+      @logger.warn('Invalid headers parameter. It will be discarded.')
+      headers = { 'User-Agent' => @user_agent }
+    end
+    conn = Faraday.new(url: host, headers: headers) do |faraday|
+      faraday.request :multipart
+    end
+    payload = {}
+    payload['payload_json'] = Faraday::Multipart::ParamPart.new(payload_json, 'application/json') if payload_json
+    files.each_with_index do |(filename, raw_bytes, mime_type), i|
+      payload["files[#{i}]"] = Faraday::Multipart::FilePart.new(
+        StringIO.new(raw_bytes),
+        mime_type,
+        filename
+      )
+    end
+    if payload.empty?
+      @logger.warn("Payload empty, not sending Discord multipart/form-data POST request to #{url}.")
+      nil
     else
-      conn.put('', data)
+      case request_type
+      when :post
+        conn.post(path, payload)
+      when :patch
+        conn.patch(path, payload)
+      end
+    end
+  end
+
+  # Generates an array of attachments objects (hashes) according to
+  #   https://docs.discord.com/developers/resources/message#attachment-object.
+  # @param attachments_array [Array] An array of arrays, each inner-array first has its filename (index 0),
+  #   raw file data as a string (index 1), and then the MIME type of the file (index 2).
+  # @return [Array] An array formed of Discord attachment objects (hashes)
+  def generate_attachment_object_array(attachments_array)
+    final_array = []
+    attachments_array.each_with_index do |(filename, raw_bytes, mime_type), i|
+      final_array << {
+        'id' => i,
+        'filename' => filename,
+        'content_type' => mime_type,
+        'size' => raw_bytes.bytesize
+      }
     end
+    final_array
   end
 end

data/lib/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# @version 0.1.4.1
+class DiscordApi
+  VERSION = '0.1.4.1'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: disrb
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4.1
 platform: ruby
 authors:
 - hoovad
@@ -65,6 +65,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.13.3
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: stringio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +138,7 @@ files:
 - lib/disrb/logger.rb
 - lib/disrb/message.rb
 - lib/disrb/user.rb
+- lib/version.rb
 homepage: https://github.com/hoovad/discord.rb
 licenses:
 - MIT