discorb 0.5.0 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26ef2cd9945ad11a9816b4ece328391c265b8f59f8b9a67e66326e21414f083c
-  data.tar.gz: 06662ff1518386e95e615afffc6b8338cb9e337bb0dc36c66f6d1d79fd7a01e8
+  metadata.gz: 62a9092a32b87c1edbb193c7b3de777b499257a9b08f92f88a741506ecef58fe
+  data.tar.gz: 3df9d14c6c7ec041d9887b3479af2417295e17b148c1aea780230e84b5c0d799
 SHA512:
-  metadata.gz: 83ddc5818285d4ed50e08998446a5fa9763cffe9c0a1992a70085af38a323e304851ca4dd77f43a8108e4ece850f097eaca9dc119b83c9bdb9a66e5c32b40f5a
-  data.tar.gz: 8a409f031d896344586bb2001019b9431299683a99df36f090f3a0da748d08bd6b4f2191c0a32823106d5b3b0cd6d22624106367d8e4adc400acf430ddb60370
+  metadata.gz: f26088e7ce6f9a4bd5877263cc716722ca3523047df3623e49a082940251d3a97cea81c289239a3c9f0b456f9a21ee637f1adcd8e804084550b6af10c2aea02b
+  data.tar.gz: bda9f44c79c089e7cf55eeef4e774c20e3891baf09e0eb73fd2faa6e9337e5abca02b66c0e5e2c2db386d136144441f34afdf306bb427b3fcf40fa8f85f875ae

data/Changelog.md

@@ -105,4 +105,26 @@
 - Change: Use zlib stream instead
 - Add: Add tutorials
 - Add: Add ratelimit handler
-- Change: Make `--git` option in `discorb init` false
+- Change: Make `--git` option in `discorb init` false
+  
+## 0.5.1
+
+- Add: Can use block for defining group commands
+- Fix: Fix bug in subcommands
+- Fix: Fix bug in receiving commands
+
+## 0.5.2
+
+- Fix: Fix bug of registering commands
+- Add: Add way to register commands in Extension
+
+## 0.5.3
+
+- Add: Add way to handle raw events with `event_xxx`
+- Add: Add `Client#session_id`
+- Add: Add `Connectable`
+- Fix: Fix error by sending DM
+
+## 0.5.4
+
+- Fix: Fix issue of receiving component events

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    discorb (0.5.0)
+    discorb (0.5.4)
       async (~> 1.30.1)
       async-http (~> 0.56.5)
       async-websocket (~> 0.19.0)

data/README.md

@@ -2,7 +2,8 @@
 [![Document](https://img.shields.io/badge/Document-discord--lib.github.io-blue.svg)](https://discorb-lib.github.io/)
 [![Gem](https://img.shields.io/gem/dt/discorb?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/discorb)
 [![Gem](https://img.shields.io/gem/v/discorb?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/discorb)
-[![Discord](https://img.shields.io/discord/863581274916913193?logo=discord&logoColor=fff&color=5865f2&label=Discord)](https://discord.gg/hCP6zq8Vpj)  
+[![Discord](https://img.shields.io/discord/863581274916913193?logo=discord&logoColor=fff&color=5865f2&label=Discord)](https://discord.gg/hCP6zq8Vpj)
+[![GitHub](https://img.shields.io/github/stars/discorb-lib/discorb?color=24292e&label=Stars&logo=GitHub&logoColor=fff)](https://github.com/discorb-lib/discorb)  
 
 discorb is a Discord API wrapper for Ruby.
 

data/Rakefile

@@ -163,13 +163,9 @@ namespace :document do
       FileUtils.cp_r("./doc/.", "./tmp-doc")
       FileUtils.rm_rf("doc")
     end
-    version = "."
-    Rake::Task["document:yard"].execute
-    Rake::Task["document:replace:html"].execute
-    Rake::Task["document:replace:css"].execute
-    Rake::Task["document:replace:eol"].execute
     sh "git switch main -f"
     FileUtils.cp_r("./tmp-doc/.", "./doc")
+    FileUtils.cp_r("./doc/#{tags.last.delete_prefix("v")}/.", "./doc")
     sputs "Successfully built all versions"
   rescue => e
     sh "git switch main -f"

data/docs/application_command.md

@@ -53,11 +53,11 @@ In `options`, hash should be like this:
 
 ```ruby
 {
-    "Name" => {
-        type: :string,
-        required: true,
-        description: "The description of the command."
-    }
+  "Name" => {
+    type: :string,
+    required: true,
+    description: "The description of the command."
+  }
 }
 ```
 
@@ -73,19 +73,19 @@ In `options`, hash should be like this:
 
 ```ruby
 {
-    "vocaloid" => {
-        required: true,
-        description: "The vocaloid which you like.",
-        type: :string,
-        choices: {
-            "Hatsune Miku" => "miku",
-            "Kagamine Rin" => "rin",
-            "Kagamine Len" => "len",
-            "Megurine Luka" => "luka",
-            "MEIKO" => "meiko",
-            "KAITO" => "kaito",
-        }
+  "vocaloid" => {
+    required: true,
+    description: "The vocaloid which you like.",
+    type: :string,
+    choices: {
+      "Hatsune Miku" => "miku",
+      "Kagamine Rin" => "rin",
+      "Kagamine Len" => "len",
+      "Megurine Luka" => "luka",
+      "MEIKO" => "meiko",
+      "KAITO" => "kaito",
     }
+  }
 }
 
 # Note: This aritcle is written in 8/31.
@@ -113,22 +113,47 @@ To register a group of slash commands, use {Discorb::Command::Handler#slash_grou
 group = client.slash_group("settings", "Set settings of bot.")
 
 group.slash("message_expand", "Whether bot should expand message.", {
-    "enabled" => {
-        type: :boolean,
-        description: "Whether bot should expand message."
-    }
+  "enabled" => {
+    type: :boolean,
+    description: "Whether bot should expand message."
+  }
 }) do |interaction|
   # ...
 end
 
 group.slash("bump_alert", "Whether bot should notify DISBOARD bump.", {
-    "enabled" => {
-        type: :boolean,
-        description: "Whether bot should notify DISBOARD bump."
-    }
+  "enabled" => {
+    type: :boolean,
+    description: "Whether bot should notify DISBOARD bump."
+  }
 }) do |interaction|
   # ...
 end
+
+```
+
+Since v0.5.1, You can use block for register commands.
+
+```ruby
+
+client.slash_group("settings", "Set settings of bot.") do
+  slash("message_expand", "Whether bot should expand message.", {
+    "enabled" => {
+      type: :boolean,
+      description: "Whether bot should expand message."
+    }
+  }) do |interaction|
+    # ...
+  end
+  slash("bump_alert", "Whether bot should notify DISBOARD bump.", {
+    "enabled" => {
+      type: :boolean,
+      description: "Whether bot should notify DISBOARD bump."
+    }
+  }) do |interaction|
+    # ...
+  end
+end
 ```
 
 You can make subcommand group by using {Discorb::Command::Command::GroupCommand#group}.
@@ -210,6 +235,8 @@ end
 
 ```
 
+Same as above, you can use block for register commands since v0.5.1.
+
 ### Register User Context Menu Command
 
 ```ruby

data/docs/events.md

@@ -219,14 +219,13 @@ Fires when a guild integration is created.
 | ---------- | ----- | ----------- |
 |`integration`| {Discorb::Integration}| The created integration. |
 
-#### `integration_update(before, after)`
+#### `integration_update(after)`
 
 Fires when a guild integration is updated.
 
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
-|`before`    | {Discorb::Integration}| The integration before the update. |
 |`after`     | {Discorb::Integration}| The integration after the update. |
 
 #### `integration_delete(integration)`

data/docs/extension.md

@@ -34,6 +34,33 @@ module MyExtension
 end
 ```
 
+## Register Command
+
+Since v0.5.2, {Discorb::Extension} includes {Discorb::Command::Handler} module, so you can register command with {Discorb::Command::Handler#slash} and {Discorb::Command::Handler#slash_group}.
+
+```ruby
+module MyExtension
+  extend Discorb::Extension
+
+  slash("command", "Command") do |interaction|
+    # ...
+  end
+
+  slash_group("group", "Group") do
+    slash("subcommand", "Subcommand") do |interaction|
+      # ...
+    end
+
+    group("subgroup", "Subcommand group") do
+      slash("group_subcommand", "Command in Subcommand group") do |interaction|
+        # ...
+      end
+    end
+  end
+end
+```
+
+
 ## Load extension
 
 Use {Discorb::Client#extend} to load extension.

data/lib/discorb/channel.rb

@@ -636,7 +636,6 @@ module Discorb
 
   #
   # Represents a voice channel.
-  # @todo Implement connecting to voice channel.
   #
   class VoiceChannel < GuildChannel
     # @return [Integer] The bitrate of the voice channel.
@@ -645,6 +644,8 @@ module Discorb
     # @return [nil] If the user limit is not set.
     attr_reader :user_limit
 
+    include Connectable
+
     @channel_type = 2
     #
     # Edit the voice channel.
@@ -699,6 +700,8 @@ module Discorb
     # @!visibility private
     attr_reader :stage_instances
 
+    include Connectable
+
     # @!attribute [r] stage_instance
     #   @return [Discorb::StageInstance] The stage instance of the channel.
 

data/lib/discorb/client.rb

@@ -49,6 +49,10 @@ module Discorb
     attr_reader :ping
     # @return [:initialized, :running, :closed] The status of the client.
     attr_reader :status
+    # @return [Integer] The session ID of connection.
+    attr_reader :session_id
+    # @private
+    attr_reader :bottom_commands
 
     #
     # Initializes a new client.
@@ -85,6 +89,7 @@ module Discorb
       @tasks = []
       @conditions = {}
       @commands = []
+      @bottom_commands = []
       @status = :initialized
     end
 
@@ -372,6 +377,14 @@ module Discorb
             @events[name] << event
           end
         end
+        @commands.delete_if do |cmd|
+          cmd.respond_to? :extension and cmd.extension == mod.name
+        end
+        mod.commands.each do |cmd|
+          cmd.define_singleton_method(:extension) { mod.name }
+          @commands << cmd
+        end
+        @bottom_commands += mod.bottom_commands
         mod.client = self
       end
       super(mod)
@@ -422,7 +435,7 @@ module Discorb
           end
         end
         start_client(token)
-      when "setup_command"
+      when "setup"
         setup_commands(token)
       end
     end

data/lib/discorb/command.rb

@@ -34,6 +34,7 @@ module Discorb
       def slash(command_name, description, options = {}, guild_ids: [], &block)
         command = Discorb::Command::Command::SlashCommand.new(command_name, description, options, guild_ids, block, 1, "")
         @commands << command
+        @bottom_commands << command
         command
       end
 
@@ -44,12 +45,16 @@ module Discorb
       # @param [String] description Command description.
       # @param [Array<#to_s>] guild_ids Guild IDs to restrict the command to.
       #
+      # @yield Block to execute as the command. It can be used to define sub-commands.
+      # @yieldself [Discorb::Command::Command::GroupCommand] Group command.
+      #
       # @return [Discorb::Command::Command::GroupCommand] Command object.
       #
       # @see file:docs/slash_command.md
       #
-      def slash_group(command_name, description, guild_ids: [])
-        command = Discorb::Command::Command::GroupCommand.new(command_name, description, guild_ids, nil)
+      def slash_group(command_name, description, guild_ids: [], &block)
+        command = Discorb::Command::Command::GroupCommand.new(command_name, description, guild_ids, nil, self)
+        command.instance_eval(&block) if block_given?
         @commands << command
         command
       end
@@ -174,6 +179,7 @@ module Discorb
           @guild_ids = guild_ids.map(&:to_s)
           @block = block
           @type = Discorb::Command::Command.types[type]
+          @type_raw = 1
           @options = options
           @id = nil
           @parent = parent
@@ -241,10 +247,11 @@ module Discorb
         attr_reader :description
 
         # @!visibility private
-        def initialize(name, description, guild_ids, type)
+        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
 
@@ -256,42 +263,7 @@ module Discorb
         #
         def slash(command_name, description, options = {}, &block)
           command = Discorb::Command::Command::SlashCommand.new(command_name, description, options, [], block, 1, @name)
-          options_payload = options.map do |name, value|
-            ret = {
-              type: case (value[:type].is_a?(Array) ? value[:type].first : value[:type])
-              when String, :string
-                3
-              when Integer
-                4
-              when TrueClass, FalseClass, :boolean
-                5
-              when Discorb::User, Discorb::Member, :user, :member
-                6
-              when Discorb::Channel, :channel
-                7
-              when Discorb::Role, :role
-                8
-              when :mentionable
-                9
-              when Float
-                10
-              end,
-              name: name,
-              description: value[:description],
-              required: !value[:optional],
-            }
-            if value[:type].is_a?(Array)
-              ret[:choices] = value[:type]
-            end
-
-            ret
-          end
-          {
-            name: @name,
-            default_permission: true,
-            description: @description,
-            options: options_payload,
-          }
+          @client.bottom_commands << command
           @commands << command
           command
         end
@@ -302,12 +274,16 @@ module Discorb
         # @param [String] command_name Group name.
         # @param [String] description Group description.
         #
+        # @yield Block to execute as the command. It can be used to define sub-commands.
+        # @yieldself [Discorb::Command::Command::SubcommandGroup] Group command.
+        #
         # @return [Discorb::Command::Command::SubcommandGroup] Command object.
         #
         # @see file:docs/slash_command.md
         #
-        def group(command_name, description)
-          command = Discorb::Command::Command::SubcommandGroup.new(command_name, description, @name)
+        def group(command_name, description, &block)
+          command = Discorb::Command::Command::SubcommandGroup.new(command_name, description, @name, @client)
+          command.instance_eval(&block) if block_given?
           @commands << command
           command
         end
@@ -328,7 +304,7 @@ module Discorb
               {
                 name: command.name,
                 description: command.description,
-                default_permission: command.enabled,
+                default_permission: true,
                 type: 1,
                 options: command.to_hash[:options],
               }
@@ -336,7 +312,7 @@ module Discorb
               {
                 name: command.name,
                 description: command.description,
-                default_permission: command.enabled,
+                default_permission: true,
                 type: 2,
                 options: command.commands.map { |c| c.to_hash.merge(type: 1) },
               }
@@ -360,8 +336,8 @@ module Discorb
         attr_reader :commands
 
         # @!visibility private
-        def initialize(name, description, enabled, parent)
-          super(name, description, [], enabled, 1)
+        def initialize(name, description, parent, client)
+          super(name, description, [], 1, client)
 
           @commands = []
           @parent = parent
@@ -376,9 +352,10 @@ module Discorb
         # @param (see Discorb::Command::Handler#slash)
         # @return [Discorb::Command::Command::SlashCommand] The added subcommand.
         #
-        def slash(command_name, description, options = {}, enabled: true, &block)
-          command = Discorb::Command::Command::SlashCommand.new(command_name, description, options, [], enabled, block, 1, @parent + " " + @name)
+        def slash(command_name, description, options = {}, &block)
+          command = Discorb::Command::Command::SlashCommand.new(command_name, description, options, [], block, 1, @parent + " " + @name)
           @commands << command
+          @client.bottom_commands << command
           command
         end
       end

data/lib/discorb/common.rb

@@ -4,7 +4,7 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v9"
   # @return [String] The version of discorb.
-  VERSION = "0.5.0"
+  VERSION = "0.5.4"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://github.com/discorb-lib/discorb #{VERSION}) Ruby/#{RUBY_VERSION}"
 

data/lib/discorb/extension.rb

@@ -8,6 +8,9 @@ module Discorb
   # @abstract
   #
   module Extension
+    include Discorb::Command::Handler
+    undef setup_commands
+
     @events = {}
     @client = nil
 
@@ -46,12 +49,18 @@ module Discorb
 
     # @return [Hash{Symbol => Array<Discorb::Event>}] The events of the extension.
     attr_reader :events
+    # @return [Array<Discorb::Command::Command] The commands of the extension.
+    attr_reader :commands
+    # @private
+    attr_reader :bottom_commands
 
     # @!visibility private
     attr_accessor :client
 
     def self.extended(obj)
       obj.instance_variable_set(:@events, {})
+      obj.instance_variable_set(:@commands, [])
+      obj.instance_variable_set(:@bottom_commands, [])
     end
   end
 end

data/lib/discorb/gateway.rb

@@ -545,7 +545,7 @@ module Discorb
               connect_gateway(true)
             end
           when 11
-            @log.info "Received opcode 11"
+            @log.debug "Received opcode 11"
             @ping = Time.now.to_f - @heartbeat_before
           when 0
             handle_event(payload[:t], data)
@@ -778,11 +778,9 @@ module Discorb
           dispatch(:integration_create, Integration.new(self, data, data[:guild_id]))
         when "INTEGRATION_UPDATE"
           return @log.warn "Unknown guild id #{data[:guild_id]}, ignoring" unless (guild = @guilds[data[:guild_id]])
-          return @log.warn "Unknown integration id #{data[:id]}, ignoring" unless (integration = guild.integrations[data[:id]])
 
-          before = Integration.new(self, integration.instance_variable_get(:@data), data[:guild_id], no_cache: true)
-          integration.send(:_set_data, data)
-          dispatch(:integration_update, before, integration)
+          before = Integration.new(self, data, data[:guild_id])
+          dispatch(:integration_update, integration)
         when "INTEGRATION_DELETE"
           return @log.warn "Unknown guild id #{data[:guild_id]}, ignoring" unless (guild = @guilds[data[:guild_id]])
           return @log.warn "Unknown integration id #{data[:id]}, ignoring" unless (integration = guild.integrations.delete(data[:id]))
@@ -979,7 +977,11 @@ module Discorb
           @log.info("Successfully resumed connection")
           dispatch(:resumed)
         else
-          @log.warn "Unknown event: #{event_name}\n#{data.inspect}"
+          if respond_to?("event_" + event_name.downcase)
+            __send__("event_" + event_name.downcase, data)
+          else
+            @log.debug "Received unknown event: #{event_name}\n#{data.inspect}"
+          end
         end
       end
     end

data/lib/discorb/http.rb

@@ -5,7 +5,7 @@ require "net/https"
 module Discorb
   #
   # A class to handle http requests.
-  # This class is internal use only.
+  # @private
   #
   class HTTP
     @nil_body = nil

data/lib/discorb/interaction.rb

@@ -297,7 +297,7 @@ module Discorb
             end
           end
 
-          unless (command = @client.commands.find { |c| c.to_s == name })
+          unless (command = @client.bottom_commands.find { |c| c.to_s == name && c.type_raw == 1 })
             @client.log.warn "Unknown command name #{name}, ignoreing"
             next
           end
@@ -393,7 +393,7 @@ module Discorb
       # @!visibility private
       def make_interaction(client, data)
         nested_classes.each do |klass|
-          return klass.new(client, data) if !klass.component_type.nil? && klass.component_type == data[:type]
+          return klass.new(client, data) if !klass.component_type.nil? && klass.component_type == data[:data][:component_type]
         end
         client.log.warn("Unknown component type #{data[:component_type]}, initialized Interaction")
         MessageComponentInteraction.new(client, data)

data/lib/discorb/modules.rb

@@ -208,4 +208,14 @@ module Discorb
       end
     end
   end
+
+  #
+  # Module for connecting to a voice channel.
+  # This will be discord-voice gem.
+  #
+  module Connectable
+    def connect
+      raise NotImplementedError, "This method is implemented by discord-voice gem."
+    end
+  end
 end

data/lib/discorb/rate_limit.rb

@@ -3,14 +3,22 @@
 module Discorb
   #
   # Class to handle rate limiting.
+  # @private
   #
   class RatelimitHandler
+    # @!visibility private
     def initialize(client)
       @client = client
       @ratelimit_hash = {}
       @path_ratelimit_hash = {}
     end
 
+    #
+    # Wait for the rate limit to reset.
+    #
+    # @param [String] method The HTTP method.
+    # @param [String] path The path.
+    #
     def wait(method, path)
       return if path.start_with?("https://")
 
@@ -28,6 +36,13 @@ module Discorb
       sleep(b[:reset_at] - Time.now.to_i)
     end
 
+    #
+    # Save the rate limit.
+    #
+    # @param [String] method The HTTP method.
+    # @param [String] path The path.
+    # @param [Net::HTTPResponse] resp The response.
+    #
     def save(method, path, resp)
       return unless resp["X-RateLimit-Remaining"]
 

data/lib/discorb/user.rb

@@ -78,7 +78,7 @@ module Discorb
       Async do
         next @dm_channel_id if @dm_channel_id
 
-        dm_channel = @client.http.post("/users/#{@id}/channels", { recipient_id: @client.user.id }).wait
+        _resp, dm_channel = @client.http.post("/users/@me/channels", { recipient_id: @id }).wait
         @dm_channel_id = dm_channel[:id]
         @dm_channel_id
       end

data/lib/discorb.rb

@@ -41,11 +41,11 @@ end
 
 require_order = %w[common flag dictionary error rate_limit http intents emoji_table modules] +
                 %w[user member guild emoji channel embed message] +
-                %w[application audit_logs color components event extension] +
+                %w[application audit_logs color components event] +
                 %w[file guild_template image integration interaction invite log permission] +
                 %w[presence reaction role sticker utils voice_state webhook] +
                 %w[gateway_requests gateway command] +
-                %w[asset client extend]
+                %w[asset extension client extend]
 require_order.each do |name|
   require_relative "discorb/#{name}.rb"
 end

data/template-replace/files/css/common.css

@@ -421,7 +421,7 @@ code[class=""] {
 
 .docstring .abstract {
   --dstr-back: var(--background-modifier-hover);
-  --dstr-fore: var(--interactive-hover);
+  --dstr-fore: var(--interactive-muted);
 }
 
 .docstring .note {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discorb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.4
 platform: ruby
 authors:
 - sevenc-nanashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2021-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async