discorb 0.13.4 → 0.15.1

data/lib/discorb/app_command.rb

@@ -1,428 +1,4 @@
 # frozen_string_literal: true
-
-module Discorb
-  #
-  # Handles application commands.
-  #
-  module ApplicationCommand
-    #
-    # Module to handle application commands.
-    #
-    module Handler
-      #
-      # Add new top-level command.
-      #
-      # @param [String] command_name Command name.
-      # @param [String] description Command description.
-      # @param [Hash{String => Hash{:description => String, :optional => Boolean, :type => Object}}] options Command options.
-      #   The key is the option name, the value is a hash with the following keys:
-      #
-      #   | Key | Type | Description |
-      #   | --- | --- | --- |
-      #   | `:description` | `String` | Description of the option. |
-      #   | `:required` | Whether the argument is required. `optional` will be used if not specified. |
-      #   | `:optional` | Whether the argument is optional. `required` will be used if not specified. |
-      #   | `:type` | `Object` | Type of the option. |
-      #   | `:choice` | `Hash{String => String, Integer, Float}` | Type of the option. |
-      #   | `:default` | `Object` | Default value of the option. |
-      #   | `:channel_types` | `Array<Class<Discorb::Channel>>` | Type of the channel option. |
-      #   | `:autocomplete` | `Proc` | Autocomplete function. |
-      #   | `:range` | `Range` | Range of the option. Only valid for numeric options. (`:int`, `:float`) |
-      #
-      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
-      # @param [Proc] block Command block.
-      #
-      # @return [Discorb::ApplicationCommand::Command::SlashCommand] Command object.
-      #
-      # @see file:docs/application_command.md#register-slash-command Application Comamnds: Register Slash Command
-      # @see file:docs/cli/setup.md CLI: setup
-      #
-      def slash(command_name, description, options = {}, guild_ids: nil, &block)
-        command = Discorb::ApplicationCommand::Command::SlashCommand.new(command_name, description, options, guild_ids, block, 1, "")
-        @commands << command
-        @bottom_commands << command
-        command
-      end
-
-      #
-      # Add new command with group.
-      #
-      # @param [String] command_name Command name.
-      # @param [String] description Command description.
-      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
-      #
-      # @yield Block to yield with the command.
-      # @yieldparam [Discorb::ApplicationCommand::Command::GroupCommand] group Group command.
-      #
-      # @return [Discorb::ApplicationCommand::Command::GroupCommand] Command object.
-      #
-      # @see file:docs/application_command.md Application Commands
-      # @see file:docs/cli/setup.md CLI: setup
-      #
-      def slash_group(command_name, description, guild_ids: nil, &block)
-        command = Discorb::ApplicationCommand::Command::GroupCommand.new(command_name, description, guild_ids, nil, self)
-        command.yield_self(&block) if block_given?
-        @commands << command
-        command
-      end
-
-      #
-      # Add message context menu command.
-      #
-      # @param [String] command_name Command name.
-      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
-      # @param [Proc] block Command block.
-      # @yield [interaction, message] Block to execute.
-      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] interaction Interaction object.
-      # @yieldparam [Discorb::Message] message Message object.
-      #
-      # @return [Discorb::ApplicationCommand::Command] Command object.
-      #
-      def message_command(command_name, guild_ids: nil, &block)
-        command = Discorb::ApplicationCommand::Command.new(command_name, guild_ids, block, 3)
-        @commands << command
-        command
-      end
-
-      #
-      # Add user context menu command.
-      #
-      # @param [String] command_name Command name.
-      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
-      # @param [Proc] block Command block.
-      # @yield [interaction, user] Block to execute.
-      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] interaction Interaction object.
-      # @yieldparam [Discorb::User] user User object.
-      #
-      # @return [Discorb::ApplicationCommand::Command] Command object.
-      #
-      def user_command(command_name, guild_ids: nil, &block)
-        command = Discorb::ApplicationCommand::Command.new(command_name, guild_ids, block, 2)
-        @commands << command
-        command
-      end
-
-      #
-      # Setup commands.
-      # @async
-      # @see Client#initialize
-      #
-      # @param [String] token Bot token.
-      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to use as default. If `false` is given, it will be global command.
-      #
-      # @note `token` parameter only required if you don't run client.
-      #
-      def setup_commands(token = nil, guild_ids: nil)
-        Async do
-          @token ||= token
-          @http = HTTP.new(self)
-          global_commands = @commands.select { |c| c.guild_ids == false or c.guild_ids == [] }
-          local_commands = @commands.select { |c| c.guild_ids.is_a?(Array) and c.guild_ids.any? }
-          default_commands = @commands.select { |c| c.guild_ids.nil? }
-          if guild_ids.is_a?(Array)
-            default_commands.each do |command|
-              command.instance_variable_set(:@guild_ids, guild_ids)
-            end
-            local_commands += default_commands
-          else
-            global_commands += default_commands
-          end
-          final_guild_ids = local_commands.map(&:guild_ids).flatten.map(&:to_s).uniq
-          app_info = fetch_application.wait
-          @http.request(
-            Route.new(
-              "/applications/#{app_info.id}/commands",
-              "//applications/:application_id/commands",
-              :put
-            ),
-            global_commands.map(&:to_hash)
-          ).wait unless global_commands.empty?
-          if ENV["DISCORB_CLI_FLAG"] == "setup"
-            sputs "Registered commands for global:"
-            global_commands.each do |command|
-              iputs "- #{command.name}"
-            end
-          end
-          final_guild_ids.each do |guild_id|
-            commands = local_commands.select { |c| c.guild_ids.include?(guild_id) }
-            @http.request(
-              Route.new("/applications/#{app_info.id}/guilds/#{guild_id}/commands",
-                        "//applications/:application_id/guilds/:guild_id/commands",
-                        :put),
-              commands.map(&:to_hash)
-            ).wait
-            sputs "Registered commands for #{guild_id}:"
-            commands.each do |command|
-              iputs "- #{command.name}"
-            end
-          end unless final_guild_ids.empty?
-          @log.info "Successfully setup commands"
-        end
-      end
-    end
-
-    #
-    # Represents a application command.
-    # @abstract
-    #
-    class Command < DiscordModel
-      # @return [String] The name of the command.
-      attr_reader :name
-      # @return [Array<#to_s>] The guild ids that the command is enabled in.
-      attr_reader :guild_ids
-      # @return [Proc] The block of the command.
-      attr_reader :block
-      # @return [:chat_input, :user, :message] The type of the command.
-      attr_reader :type
-      # @return [Integer] The raw type of the command.
-      attr_reader :type_raw
-      # @return [Discorb::Dictionary{Discorb::Snowflake, :global => Discorb::Snowflake}] The ID mapping.
-      attr_reader :id_map
-
-      @types = {
-        1 => :chat_input,
-        2 => :user,
-        3 => :message,
-      }.freeze
-
-      # @private
-      def initialize(name, guild_ids, block, type)
-        @name = name
-        @guild_ids = guild_ids&.map(&:to_s)
-        @block = block
-        @raw_type = type
-        @type = Discorb::ApplicationCommand::Command.types[type]
-        @type_raw = type
-        @id_map = Discorb::Dictionary.new
-      end
-
-      # @private
-      def replace_block(instance)
-        current_block = @block.dup
-        @block = Proc.new do |*args|
-          instance.instance_exec(*args, &current_block)
-        end
-      end
-
-      # @private
-      def to_hash
-        {
-          name: @name,
-          default_permission: @default_permission,
-          type: @type_raw,
-        }
-      end
-
-      #
-      # Represents the slash command.
-      #
-      class SlashCommand < Command
-        # @return [String] The description of the command.
-        attr_reader :description
-        # @return [Hash{String => Hash}] The options of the command.
-        attr_reader :options
-
-        # @private
-        def initialize(name, description, options, guild_ids, block, type, parent)
-          super(name, guild_ids, block, type)
-          @description = description
-          @options = options
-          @id = nil
-          @parent = parent
-          @id_map = Discorb::Dictionary.new
-        end
-
-        #
-        # Returns the commands name.
-        #
-        # @return [String] The name of the command.
-        #
-        def to_s
-          (@parent + " " + @name).strip
-        end
-
-        # @private
-        def to_hash
-          options_payload = options.map do |name, value|
-            ret = {
-              type: case value[:type]
-              when String, :string, :str
-                3
-              when Integer, :integer, :int
-                4
-              when TrueClass, FalseClass, :boolean, :bool
-                5
-              when Discorb::User, Discorb::Member, :user, :member
-                6
-              when Discorb::Channel, :channel
-                7
-              when Discorb::Role, :role
-                8
-              when :mentionable
-                9
-              when Float, :float
-                10
-              else
-                raise ArgumentError, "Invalid option type: #{value[:type]}"
-              end,
-              name: name,
-              description: value[:description],
-              required: value[:required].nil? ? !value[:optional] : value[:required],
-            }
-
-            ret[:choices] = value[:choices].map { |t| { name: t[0], value: t[1] } } if value[:choices]
-
-            ret[:channel_types] = value[:channel_types].map(&:channel_type) if value[:channel_types]
-
-            ret[:autocomplete] = !!value[:autocomplete] if value[:autocomplete]
-            if value[:range]
-              ret[:min_value] = value[:range].begin
-              ret[:max_value] = value[:range].end
-            end
-            ret
-          end
-          {
-            name: @name,
-            default_permission: true,
-            description: @description,
-            options: options_payload,
-          }
-        end
-      end
-
-      #
-      # Represents the command with subcommands.
-      #
-      class GroupCommand < Command
-        # @return [Array<Discorb::ApplicationCommand::Command::SlashCommand, Discorb::ApplicationCommand::Command::SubcommandGroup>] The subcommands of the command.
-        attr_reader :commands
-        # @return [String] The description of the command.
-        attr_reader :description
-
-        # @private
-        def initialize(name, description, guild_ids, type, client)
-          super(name, guild_ids, block, type)
-          @description = description
-          @commands = []
-          @client = client
-          @id_map = Discorb::Dictionary.new
-        end
-
-        #
-        # Add new subcommand.
-        #
-        # @param (see Discorb::ApplicationCommand::Handler#slash)
-        # @return [Discorb::ApplicationCommand::Command::SlashCommand] The added subcommand.
-        #
-        def slash(command_name, description, options = {}, &block)
-          command = Discorb::ApplicationCommand::Command::SlashCommand.new(command_name, description, options, [], block, 1, @name)
-          @client.bottom_commands << command
-          @commands << command
-          command
-        end
-
-        #
-        # Add new subcommand group.
-        #
-        # @param [String] command_name Group name.
-        # @param [String] description Group description.
-        #
-        # @yield Block to yield with the command.
-        # @yieldparam [Discorb::ApplicationCommand::Command::SubcommandGroup] group Group command.
-        #
-        # @return [Discorb::ApplicationCommand::Command::SubcommandGroup] Command object.
-        #
-        # @see file:docs/application_command.md Application Commands
-        #
-        def group(command_name, description, &block)
-          command = Discorb::ApplicationCommand::Command::SubcommandGroup.new(command_name, description, @name, @client)
-          command.yield_self(&block) if block_given?
-          @commands << command
-          command
-        end
-
-        #
-        # Returns the command name.
-        #
-        # @return [String] The command name.
-        #
-        def to_s
-          @name
-        end
-
-        # @private
-        def block_replace(instance)
-          super
-          @commands.each { |c| c.replace_block(instance) }
-        end
-
-        # @private
-        def to_hash
-          options_payload = @commands.map do |command|
-            if command.is_a?(SlashCommand)
-              {
-                name: command.name,
-                description: command.description,
-                default_permission: true,
-                type: 1,
-                options: command.to_hash[:options],
-              }
-            else
-              {
-                name: command.name,
-                description: command.description,
-                default_permission: true,
-                type: 2,
-                options: command.commands.map { |c| c.to_hash.merge(type: 1) },
-              }
-            end
-          end
-
-          {
-            name: @name,
-            default_permission: @enabled,
-            description: @description,
-            options: options_payload,
-          }
-        end
-      end
-
-      #
-      # Represents the subcommand group.
-      #
-      class SubcommandGroup < GroupCommand
-        # @return [Array<Discorb::ApplicationCommand::Command::SlashCommand>] The subcommands of the command.
-        attr_reader :commands
-
-        # @private
-        def initialize(name, description, parent, client)
-          super(name, description, [], 1, client)
-
-          @commands = []
-          @parent = parent
-        end
-
-        def to_s
-          @parent + " " + @name
-        end
-
-        #
-        # Add new subcommand.
-        # @param (see Discorb::ApplicationCommand::Handler#slash)
-        # @return [Discorb::ApplicationCommand::Command::SlashCommand] The added subcommand.
-        #
-        def slash(command_name, description, options = {}, &block)
-          command = Discorb::ApplicationCommand::Command::SlashCommand.new(command_name, description, options, [], block, 1, @parent + " " + @name)
-          @commands << command
-          @client.bottom_commands << command
-          command
-        end
-      end
-
-      class << self
-        # @private
-        attr_reader :types
-      end
-    end
-  end
+%w[command handler].each do |file|
+  require_relative "app_command/#{file}.rb"
 end

data/lib/discorb/application.rb

@@ -29,7 +29,13 @@ module Discorb
     alias bot_require_code_grant? bot_require_code_grant
     # @return [Discorb::Application::Flag] The application's flags.
     attr_reader :flags
+    #
+    # Initializes a new instance of the Application class.
     # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    #
     def initialize(client, data)
       @client = client
       @data = data
@@ -97,7 +103,13 @@ module Discorb
       # @return [Discorb::Application::Team::Member] The team's member.
       attr_reader :members
 
+      #
+      # Initializes a new instance of the Team class.
       # @private
+      #
+      # @param [Discorb::Client] client The client that instantiated the object.
+      # @param [Hash] data The data of the object.
+      #
       def initialize(client, data)
         @client = client
         @id = Snowflake.new(data[:id])
@@ -142,7 +154,9 @@ module Discorb
         # @!attribute [r] owner?
         #   @return [Boolean] Whether the member is the team's owner.
 
-        @membership_state = {
+        # @private
+        # @return [{Integer => Symbol}] The permission map.
+        MEMBERSHIP_STATE = {
           1 => :invited,
           2 => :accepted,
         }.freeze
@@ -153,7 +167,7 @@ module Discorb
           @team = team
           @user = client.users[data[:user][:id]] || User.new(client, data[:user])
           @team_id = Snowflake.new(data[:team_id])
-          @membership_state = self.class.membership_state[data[:membership_state]]
+          @membership_state = MEMBERSHIP_STATE[data[:membership_state]]
           @permissions = data[:permissions].map(&:to_sym)
         end
 
@@ -176,11 +190,6 @@ module Discorb
         def ==(other)
           super || @user == other
         end
-
-        class << self
-          # @private
-          attr_reader :membership_state
-        end
       end
     end
   end

data/lib/discorb/asset.rb

@@ -11,7 +11,13 @@ module Discorb
     # @!attribute [r] animated?
     #   @return [Boolean] Whether the asset is animated.
 
+    #
+    # Initialize a new instance of the Asset class.
     # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    #
     def initialize(target, hash, path: nil)
       @hash = hash
       @target = target
@@ -63,7 +69,10 @@ module Discorb
     # @!attribute [r] animated?
     #   @return [false] For compatibility with {Asset}, always `false`.
 
+    #
+    # Initialize a new instance of the DefaultAvatar class.
     # @private
+    #
     def initialize(discriminator)
       @discriminator = discriminator.to_s.rjust(4, "0")
     end
@@ -80,7 +89,9 @@ module Discorb
     #
     # @return [String] URL of the avatar.
     #
+    # rubocop: disable Lint/UnusedMethodArgument
     def url(image_format: nil, size: 1024)
+      # rubocop: enable Lint/UnusedMethodArgument
       "https://cdn.discordapp.com/embed/avatars/#{@discriminator.to_i % 5}.png"
     end
 

data/lib/discorb/{file.rb → attachment.rb}

@@ -7,15 +7,17 @@ module Discorb
   #
   # Represents a attachment file.
   #
-  class Attachment < DiscordModel
+  class Attachment
     # @return [#read] The file content.
     attr_reader :io
-    # @return [Discorb::Snowflake] The attachment id.
-    attr_reader :id
     # @return [String] The attachment filename.
     attr_reader :filename
     # @return [String] The attachment content type.
     attr_reader :content_type
+    # @return [String] The attachment description.
+    attr_reader :description
+    # @return [Discorb::Snowflake] The attachment id.
+    attr_reader :id
     # @return [Integer] The attachment size in bytes.
     attr_reader :size
     # @return [String] The attachment url.
@@ -28,12 +30,44 @@ module Discorb
     # @return [Integer] The image width.
     # @return [nil] If the attachment is not an image.
     attr_reader :width
+    # @return [:client, :discord] The attachment was created by.
+    attr_reader :created_by
+    # @private
+    # @return [Boolean] Whether the attachment will be closed after it is sent.
+    attr_reader :will_close
 
     # @!attribute [r] image?
     #   @return [Boolean] whether the file is an image.
 
+    #
+    # Creates a new attachment.
+    #
+    # @param [#read, String] source The Source of the attachment.
+    # @param [String] filename The filename of the attachment. If not set, path or object_id of the IO is used.
+    # @param [String] description The description of the attachment.
+    # @param [String] content_type The content type of the attachment. If not set, it is guessed from the filename.
+    #   If failed to guess, it is set to `application/octet-stream`.
+    # @param [Boolean] will_close Whether the IO will be closed after the attachment is sent.
+    #
+    def initialize(source, filename = nil, description: nil, content_type: nil, will_close: true)
+      @io = if source.respond_to?(:read)
+          source
+        else
+          File.open(source, "rb")
+        end
+      @filename = filename || (@io.respond_to?(:path) ? @io.path : @io.object_id)
+      @description = description
+      @content_type = content_type || MIME::Types.type_for(@filename.to_s)[0].to_s
+      @content_type = "application/octet-stream" if @content_type == ""
+      @will_close = will_close
+      @created_by = :client
+    end
+
+    #
+    # Initializes the object from a hash.
     # @private
-    def initialize(data)
+    #
+    def initialize_hash(data)
       @id = Snowflake.new(data[:id])
       @filename = data[:filename]
       @content_type = data[:content_type]
@@ -42,37 +76,29 @@ module Discorb
       @proxy_url = data[:proxy_url]
       @height = data[:height]
       @width = data[:width]
+      @created_by = :discord
     end
 
     def image?
       @content_type.start_with? "image/"
     end
-  end
 
-  #
-  # Represents a file to send as an attachment.
-  #
-  class File
-    # @return [#read] The IO of the file.
-    attr_accessor :io
-    # @return [String] The filename of the file. If not set, path or object_id of the IO is used.
-    attr_accessor :filename
-    # @return [String] The content type of the file. If not set, it is guessed from the filename.
-    attr_accessor :content_type
+    def inspect
+      if @created_by == :discord
+        "<#{self.class} #{@id}: #{@filename}>"
+      else
+        "<#{self.class} #{io.fileno}: #{@filename}>"
+      end
+    end
 
     #
-    # Creates a new file from IO.
-    #
-    # @param [#read] io The IO of the file.
-    # @param [String] filename The filename of the file. If not set, path or object_id of the IO is used.
-    # @param [String] content_type The content type of the file. If not set, it is guessed from the filename.
-    #   If failed to guess, it is set to `application/octet-stream`.
+    # Creates a new file from a hash.
+    # @private
     #
-    def initialize(io, filename = nil, content_type: nil)
-      @io = io
-      @filename = filename || (io.respond_to?(:path) ? io.path : io.object_id)
-      @content_type = content_type || MIME::Types.type_for(@filename.to_s)[0].to_s
-      @content_type = "application/octet-stream" if @content_type == ""
+    def self.from_hash(data)
+      inst = allocate
+      inst.initialize_hash(data)
+      inst
     end
 
     #
@@ -82,16 +108,12 @@ module Discorb
     # @param [String] filename The filename of the file. object_id of the string is used if not set.
     # @param [String] content_type The content type of the file. If not set, it is guessed from the filename.
     #
-    # @return [File] The new file.
+    # @return [Discorb::Attachment] The new file.
     #
-    def self.from_string(string, filename: nil, content_type: nil)
+    def self.from_string(string, filename = nil, content_type: nil, description: nil)
       io = StringIO.new(string)
       filename ||= string.object_id.to_s + ".txt"
-      new(io, filename, content_type: content_type)
-    end
-
-    def inspect
-      "#<#{self.class} filename=#{@filename} content_type=#{@content_type}>"
+      new(io, filename, content_type: content_type, description: description, will_close: true)
     end
   end
 end