discorb 0.4.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e88541a1d18a1ebd262bae5d91bb38c02d91350e1b2cf698c3f491bf58bb5cfa
-  data.tar.gz: dc55e68bea5b74105eb941c8ec50bec6fa6f4bf3dd716a1e505ea6c3ab598725
+  metadata.gz: 3d17006d6ca103247dcf304581c61104054722b1af32bc8b3ec3d23b7f5e8680
+  data.tar.gz: 92c481e5532d3e990ca73b891c71a87f5a4a2e6217ff7d7c5677519dbeaf4259
 SHA512:
-  metadata.gz: 5c5d884643656bca43b2ee1e448c0860f0235f439875cbad59a89c79b5d98c71d7b3f539ab6150a051b262ebb09551cf8f943c090676f0751d5533596bc5aea8
-  data.tar.gz: d4ddfe0faa3c4cdcbc14293216c13017d4c64b7c0f4594e44d5ddb9ab7b9b60ddb4f5acc8a4d06eaec8d1f5e504b13fd43c4f3bc898d787976c617c7509a15dc
+  metadata.gz: b305d2f608c0506b7c84f53d16e4384710d454d5deacc69d51a55dbf81fe25d80ab7226717cb12480e07ba25f069a59a49a50608826d711c2a84edb4ec67258c
+  data.tar.gz: c40281fb460527163504b8fe999f02a57db3190532a47c78ee25d71871372ff4c720a7ec0e17c70853083ad7327ae574e418b080d7379c98d683fcc1ccb0169e

data/.yardopts

@@ -3,6 +3,7 @@
 --markup markdown
 --tag flags:"Flags"
 --verbose
+--asset docs/assets:assets
 -
 docs/**/*.md
 Changelog.md

data/Changelog.md

@@ -94,4 +94,26 @@
 
 ## 0.4.1
 
-- Add: Add `-s` option to `discorb run`
+- Add: Add `-s` option to `discorb run`
+  
+## 0.4.2
+
+- Fix: Fix error in `discorb run`
+  
+## 0.5.0
+
+- Change: Use zlib stream instead
+- Add: Add tutorials
+- Add: Add ratelimit handler
+- 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    discorb (0.4.1)
+    discorb (0.5.2)
       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

@@ -117,6 +117,7 @@ namespace :document do
       iputs "Replacing CRLF with LF"
       Dir.glob("doc/**/*.*") do |file|
         next unless File.file?(file)
+        next unless %w[html css js].include? file.split(".").last
 
         content = ""
         File.open(file, "rb") do |f|
@@ -162,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/cli/init.md

@@ -30,7 +30,7 @@ Default to true.
 Whether to initialize git.
 If true, the command will initialize git and commit the initial files with commit message `Initial commit`.
 Use `git commit --amend -m "..."` to change the commit message.
-Default to true.
+Default to false.
 
 ### `-t`, `--token`
 

data/docs/cli.md

@@ -21,5 +21,6 @@ Currently, discorb has the following commands:
 | {file:docs/cli/run.md `run`} | Run a client. |
 | {file:docs/cli/setup.md `setup`} | Setup application commands. |
 | `show` | Show your environment. (No document) |
+| `about` | Show discorb's information. (No document) |
 
 Click the command name to see the document.

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/docs/tutorial.md

@@ -0,0 +1,194 @@
+# @title Tutorial
+
+# Tutorial
+
+Welcome to discorb! This lib allows you to create a discord bot with ease. So, let's get started!
+
+## Requirements
+
+- Ruby 3.0.0+
+- Basic knowledge of ruby  
+    These documents will help you:
+    - [Ruby in Twenty Minutes](https://www.ruby-lang.org/en/documentation/quickstart/)
+    - [Ruby from other languages](https://www.ruby-lang.org/en/documentation/ruby-from-other-languages/)
+    - [Try ruby!](https://try.ruby-lang.org/)
+
+### Recommended
+
+- Good editor  
+    They are recommended:
+    - [VSCode](https://code.visualstudio.com/)
+    - [Atom](https://atom.io/)
+    - [Sublime Text](https://www.sublimetext.com/)
+    - [Brackets](https://brackets.io/)
+    - [Notepad++](https://notepad-plus-plus.org/)
+- Git
+- Bundler
+
+Once you have all of these, you can start coding!
+
+## Start creating your bot
+
+### Create a Bot account
+
+You must have a bot account to use this lib. First, go to [Discord Developer Portal](https://discord.com/developers/applications) and click on `New Application`.  
+![](./assets/01_new_app.png)
+
+And then type a name for your bot, and click `Create`.  
+![](./assets/02_bot_name.png)
+
+You will be redirected to the `General Information` page.
+Then, click `Bot` and then `Add Bot` and then `Yes, do it!`.  
+![](./assets/03_add_bot.png)
+
+You will see bot information, and click `Copy` button in TOKEN section.  
+![](./assets/04_token_copy.png)
+
+**DO NOT SHARE THIS TOKEN, OR YOUR BOT BAN EVERYONE IN EVERY SERVER!**
+This is serious security risk.
+
+Click `Regenerate` button to regenerate your token. Do this immediately when you accidentally share your token.
+
+You did it! Now, you have a bot account.
+
+#### Invite your bot to a server
+
+Go to `OAuth2` page and scroll down, and check `bot` and `applications.commands` permissions.  
+![](./assets/05_oauth.png)
+Then, click `Copy` button and paste it to your browser.
+Choose a server you want to invite your bot to, and follow the instructions.
+
+### Code your bot
+
+#### Install gems
+
+Open terminal and type:
+
+```
+gem install bundler discorb
+```
+
+#### Setup files
+
+Create a new directory and go to it.
+Open terminal and type:
+
+```
+discorb init
+```
+
+Specify `--git` if you want to use git.
+
+You will get some files in your directory.
+
+- `main.rb`: The main file of your bot.
+- `.env`: The environment variables of your bot. **You must keep this file secret!**
+- `Gemfile`: Gemfile for bundler.
+- `Gemfile.lock`: Gemfile.lock for bundler.
+
+You will get other files if you specify `--git`.
+{file:docs/cli/init.md Learn more here}.
+
+#### Start your bot
+
+Open `main.rb`, you will see the following code:
+
+```ruby
+require "discorb"
+require "dotenv"
+
+Dotenv.load  # Loads .env file
+
+client = Discorb::Client.new  # Create client for connecting to Discord
+
+client.once :ready do
+  puts "Logged in as #{client.user}"  # Prints username of logged in user
+end
+
+client.run ENV["TOKEN"]  # Starts client
+```
+
+Open `.env`, you will see:
+
+```
+TOKEN=Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng
+```
+
+Replace `Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng` with your bot token.
+Remember to keep this file secret!
+
+Open terminal and type:
+
+```sh
+bundle exec ruby main.rb
+# or
+bundle exec discorb run main.rb
+```
+
+Yay! Your bot is online!  
+![](./assets/06_online.png)
+
+But your bot won't do anything.
+So add your bot some greetings!
+`Ctrl + C` to stop your bot.
+
+#### Add a greeting
+
+You can do some action on message by typing like this:
+
+```ruby
+client.on :message do |message|
+  # ...
+end
+```
+
+`message` is a {Discorb::Message} object. It contains information about the message.
+You can get the message content by {Discorb::Message#content}.
+Add `if` statement, and reply to the message with {Discorb::Message#reply}.
+
+```ruby
+client.on :message do |message|
+  if message.content.downcase.include? "hello"
+    message.reply "Hello!"
+  end
+end
+```
+
+Save your bot and restart it.
+
+You can see your bot's response by typing `hello` in your server...  
+
+![](./assets/07_hello_infinite.png)
+
+Oh no! Your bot is responding to bot's messages, and it doesn't stop!
+
+Terminate your bot by typing `Ctrl + C` in terminal.
+
+#### Ignore bot's messages
+
+You can access author information by {Discorb::Message#author}, and it has {Discorb::User#bot?}.
+So, you can ignore bot's messages by adding `if` statement:
+
+```ruby
+client.on :message do |message|
+  next if message.author.bot?
+
+  # ...
+end
+```
+
+Note you must use `next` to exit the block.
+
+Save your bot and start it.
+
+![](./assets/08_hello_once.png)
+
+You did it! Your bot won't respond to bot's messages anymore.
+
+## Finally
+
+This is the end of tutorial.
+
+To learn more, check out the [documentation](https://discorb-lib.github.io/).
+
+We hope you enjoy this lib! Thanks for reading!

data/lib/discorb/client.rb

@@ -49,6 +49,8 @@ module Discorb
     attr_reader :ping
     # @return [:initialized, :running, :closed] The status of the client.
     attr_reader :status
+    # @private
+    attr_reader :bottom_commands
 
     #
     # Initializes a new client.
@@ -85,6 +87,7 @@ module Discorb
       @tasks = []
       @conditions = {}
       @commands = []
+      @bottom_commands = []
       @status = :initialized
     end
 
@@ -372,6 +375,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)
@@ -406,7 +417,7 @@ module Discorb
               when "stdout"
                 $stdout
               else
-                File.open(options[:log_file], "a")
+                ::File.open(options[:log_file], "a")
               end
             @log.level = options[:log_level].to_sym
             @log.colorize_log = case options[:log_color]
@@ -422,7 +433,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.4.1"
+  VERSION = "0.5.2"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://github.com/discorb-lib/discorb #{VERSION}) Ruby/#{RUBY_VERSION}"
 

data/lib/discorb/exe/about.rb

@@ -7,6 +7,7 @@ informations = {
   "Documentation" => "https://discorb-lib.github.io",
   "RubyGems" => "https://rubygems.org/gems/discorb",
   "Changelog" => "https://discorb-lib.github.io/file.Changelog.html",
+  "License" => "MIT License",
 }
 
 informations.each do |key, value|

data/lib/discorb/exe/init.rb

@@ -1,6 +1,7 @@
 # description: Make files for the discorb project.
 
 require "optparse"
+require "discorb"
 require_relative "../utils/colored_puts"
 
 $path = Dir.pwd
@@ -11,15 +12,15 @@ FILES = {
     require "discorb"
     require "dotenv"
 
-    Dotenv.load
+    Dotenv.load  # Loads .env file
 
-    client = Discorb::Client.new
+    client = Discorb::Client.new  # Create client for connecting to Discord
 
     client.once :ready do
-      puts "Logged in as #{client.user}"
+      puts "Logged in as #{client.user}"  # Prints username of logged in user
     end
 
-    client.run ENV["%<token>s"]
+    client.run ENV["%<token>s"]  # Starts client
   RUBY
   ".env" => <<~BASH,
     %<token>s=Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng
@@ -90,9 +91,9 @@ FILES = {
 
     source "https://rubygems.org"
 
-    git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+    git_source(:github) { |repo_name| "https://github.com/\#{repo_name}" }
 
-    gem "discorb", "~> 0.2.5"
+    gem "discorb", "~> #{Discorb::VERSION}"
     gem "dotenv", "~> 2.7"
   RUBY
 }
@@ -141,7 +142,7 @@ opt = OptionParser.new <<~BANNER
 
 $values = {
   bundle: true,
-  git: true,
+  git: false,
   force: false,
   token: "TOKEN",
 }
@@ -150,7 +151,7 @@ opt.on("--[no-]bundle", "Whether to use bundle. Default to true.") do |v|
   $values[:bundle] = v
 end
 
-opt.on("--[no-]git", "Whether to initialize git. Default to true.") do |v|
+opt.on("--[no-]git", "Whether to initialize git. Default to false.") do |v|
   $values[:git] = v
 end
 

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

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "async/http"
+require "async/websocket"
+require "json"
+require "zlib"
 
 module Discorb
   #
@@ -464,13 +467,20 @@ module Discorb
           @first = first
           _, gateway_response = @http.get("/gateway").wait
           gateway_url = gateway_response[:url]
-          endpoint = Async::HTTP::Endpoint.parse("#{gateway_url}?v=9&encoding=json",
+          endpoint = Async::HTTP::Endpoint.parse("#{gateway_url}?v=9&encoding=json&compress=zlib-stream",
                                                 alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
           begin
-            Async::WebSocket::Client.connect(endpoint, headers: [["User-Agent", Discorb::USER_AGENT]]) do |connection|
+            Async::WebSocket::Client.connect(endpoint, headers: [["User-Agent", Discorb::USER_AGENT]], handler: RawConnection) do |connection|
               @connection = connection
+              @zlib_stream = Zlib::Inflate.new(Zlib::MAX_WBITS)
+              @buffer = +""
               while (message = @connection.read)
-                handle_gateway(message)
+                @buffer << message
+                if message.end_with?((+"\x00\x00\xff\xff").force_encoding("ASCII-8BIT"))
+                  message = JSON.parse(@zlib_stream.inflate(@buffer), symbolize_names: true)
+                  @buffer = +""
+                  handle_gateway(message)
+                end
               end
             end
           rescue Protocol::WebSocket::ClosedError => e
@@ -490,7 +500,7 @@ module Discorb
       end
 
       def send_gateway(opcode, **value)
-        @connection.write({ op: opcode, d: value })
+        @connection.write({ op: opcode, d: value }.to_json)
         @connection.flush
         @log.debug "Sent message with opcode #{opcode}: #{value.to_json.gsub(@token, "[Token]")}"
       end
@@ -535,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)
@@ -548,7 +558,7 @@ module Discorb
           task.sleep((interval / 1000.0 - 1) * rand)
           loop do
             @heartbeat_before = Time.now.to_f
-            @connection.write({ op: 1, d: @last_s })
+            @connection.write({ op: 1, d: @last_s }.to_json)
             @connection.flush
             @log.debug "Sent opcode 1."
             @log.debug "Waiting for heartbeat."
@@ -768,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]))
@@ -973,5 +981,25 @@ module Discorb
         end
       end
     end
+    
+    #
+    # A class for connecting websocket with raw bytes data.
+    # @private
+    #
+    class RawConnection < Async::WebSocket::Connection		
+      def initialize(...)
+        super
+      end
+    
+			def parse(buffer)
+				# noop
+        buffer.to_s
+			end
+			
+			def dump(object)
+				# noop
+        object.to_s
+			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
@@ -13,6 +13,7 @@ module Discorb
     # @!visibility private
     def initialize(client)
       @client = client
+      @ratelimit_handler = RatelimitHandler.new(client)
     end
 
     #
@@ -31,8 +32,10 @@ module Discorb
     #
     def get(path, headers: nil, audit_log_reason: nil, **kwargs)
       Async do |task|
+        @ratelimit_handler.wait("GET", path)
         resp = http.get(get_path(path), get_headers(headers, "", audit_log_reason), **kwargs)
         data = get_response_data(resp)
+        @ratelimit_handler.save("GET", path, resp)
         test_error(if resp.code == "429"
           @client.log.warn "Ratelimit exceeded for #{path}, trying again in #{data[:retry_after]} seconds."
           task.sleep(data[:retry_after])
@@ -60,8 +63,10 @@ module Discorb
     #
     def post(path, body = "", headers: nil, audit_log_reason: nil, **kwargs)
       Async do |task|
+        @ratelimit_handler.wait("POST", path)
         resp = http.post(get_path(path), get_body(body), get_headers(headers, body, audit_log_reason), **kwargs)
         data = get_response_data(resp)
+        @ratelimit_handler.save("POST", path, resp)
         test_error(if resp.code == "429"
           task.sleep(data[:retry_after])
           post(path, body, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait
@@ -88,13 +93,10 @@ module Discorb
     #
     def patch(path, body = "", headers: nil, audit_log_reason: nil, **kwargs)
       Async do |task|
+        @ratelimit_handler.wait("PATCH", path)
         resp = http.patch(get_path(path), get_body(body), get_headers(headers, body, audit_log_reason), **kwargs)
-        rd = resp.body
-        data = if rd.nil? || rd.empty?
-            nil
-          else
-            JSON.parse(rd, symbolize_names: true)
-          end
+        data = get_response_data(resp)
+        @ratelimit_handler.save("PATCH", path, resp)
         test_error(if resp.code == "429"
           task.sleep(data[:retry_after])
           patch(path, body, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait
@@ -121,8 +123,10 @@ module Discorb
     #
     def put(path, body = "", headers: nil, audit_log_reason: nil, **kwargs)
       Async do |task|
+        @ratelimit_handler.wait("PUT", path)
         resp = http.put(get_path(path), get_body(body), get_headers(headers, body, audit_log_reason), **kwargs)
         data = get_response_data(resp)
+        @ratelimit_handler.save("PUT", path, resp)
         test_error(if resp.code == "429"
           task.sleep(data[:retry_after])
           put(path, body, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait
@@ -148,8 +152,10 @@ module Discorb
     #
     def delete(path, headers: nil, audit_log_reason: nil, **kwargs)
       Async do |task|
+        @ratelimit_handler.wait("DELETE", path)
         resp = http.delete(get_path(path), get_headers(headers, "", audit_log_reason))
         data = get_response_data(resp)
+        @ratelimit_handler.save("DELETE", path, resp)
         test_error(if resp.code == "429"
           task.sleep(data[:retry_after])
           delete(path, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait

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

data/lib/discorb/rate_limit.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+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://")
+
+      return unless hash = @path_ratelimit_hash[method + path]
+
+      return unless b = @ratelimit_hash[hash]
+
+      if b[:reset_at] < Time.now.to_i
+        @ratelimit_hash.delete(hash)
+        return
+      end
+      return if b[:remaining] > 0
+
+      @client.log.info("Ratelimit reached, waiting for #{b[:reset_at] - Time.now.to_i} seconds")
+      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"]
+
+      @path_ratelimit_hash[method + path] = resp["X-RateLimit-Bucket"]
+      @ratelimit_hash[resp["X-RateLimit-Bucket"]] = {
+        remaining: resp["X-RateLimit-Remaining"].to_i,
+        reset_at: resp["X-RateLimit-Reset"].to_i,
+      }
+    end
+  end
+end

data/lib/discorb.rb

@@ -39,13 +39,13 @@ module Discorb
   end
 end
 
-require_order = %w[common flag dictionary error http intents emoji_table modules] +
+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.4.1
+  version: 0.5.2
 platform: ruby
 authors:
 - sevenc-nanashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -89,6 +89,15 @@ files:
 - discorb.gemspec
 - docs/Examples.md
 - docs/application_command.md
+- docs/assets/01_new_app.png
+- docs/assets/02_bot_name.png
+- docs/assets/03_add_bot.png
+- docs/assets/04_token_copy.png
+- docs/assets/05_oauth.png
+- docs/assets/06_online.png
+- docs/assets/07_hello_infinite.png
+- docs/assets/08_hello_once.png
+- docs/assets/unused_ping_pong.png
 - docs/cli.md
 - docs/cli/init.md
 - docs/cli/irb.md
@@ -96,6 +105,7 @@ files:
 - docs/cli/setup.md
 - docs/events.md
 - docs/extension.md
+- docs/tutorial.md
 - docs/voice_events.md
 - examples/commands/bookmarker.rb
 - examples/commands/hello.rb
@@ -151,6 +161,7 @@ files:
 - lib/discorb/modules.rb
 - lib/discorb/permission.rb
 - lib/discorb/presence.rb
+- lib/discorb/rate_limit.rb
 - lib/discorb/reaction.rb
 - lib/discorb/role.rb
 - lib/discorb/sticker.rb