discorb 0.10.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f6ee34f3af585d7ddac79ba4a4e27e860d6e9bb5035fba753d05ef9051a33ae
-  data.tar.gz: 6bee85cd879565d96930f9bceecb0dc0f7e0f0f7a2538f95890b65d48289a7a8
+  metadata.gz: 3c80c426387c9e5ba44589c5851e7c1a4d54a5de99c82d5b3571c4200dcaf135
+  data.tar.gz: 2aa6db0900cafe2120793b295b68e5de357e97e0797cd416a06caca9491b09e1
 SHA512:
-  metadata.gz: f9ad567614fd083bf93f84291944196f6d0ef4ff20db5052ab13fef078d0ab50e5be71fb553701c0ff9332da630e6d6d6969371528db6bd8830f2a25542e1837
-  data.tar.gz: 450323783abfcdbdfb9db7517bda56b26c651dd7c4df18212fb11c624ff16016df01d1d8126ac9dc2cff0cd532b07afba406e16db154f917ca85d55f89f41139
+  metadata.gz: afe14b35796820b8b7af5baaab6a79a5a770c55d11d30d25b2a9647034658e27346e918be42fb8d4a30edbf27873bd367cf3551cf1b091e82c49150c886ef03e
+  data.tar.gz: 9c817738b2a4b3763d94182e2b47f583aaa7129a8769cdc9b8f7fc7e10f0656f43183f0d416d72aa20112b6b34addfdd38e36b7710c6405d2f29f658cb238c4c

data/Changelog.md

@@ -2,6 +2,17 @@
 
 # Changelog
 
+## v0.11
+
+### v0.11.0
+
+- Add: Improve documents
+- Add: Implement global rate limits
+- Add: Add support autocomplete
+- Add: Add role icon editting
+- Change: Use `include Discorb::Extension` instead of `< Discorb::Extension`
+- Fix: Fix role operation
+
 ## v0.10
 
 ### v0.10.3

data/docs/application_command.md

@@ -69,6 +69,7 @@ In `options`, hash should be like this:
 | `: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. |
 
 `choices` should be unspecified if you don't want to use it.
 `choices` is hash like this:
@@ -107,7 +108,7 @@ In `type`, You must use one of the following:
 | `:channel` | Channel argument. | None |
 | `:role` | Role argument. | None |
 
-### Group Slash Commands
+#### Group Slash Commands
 
 To register a group of slash commands, use {Discorb::ApplicationCommand::Handler#slash_group}.
 
@@ -239,6 +240,31 @@ end
 
 Same as above, you can use block for register commands since v0.5.1.
 
+#### Use Auto Completing
+
+Since v0.11.0, you can use auto completion by setting Proc to `:autocomplete` in options.
+The proc will be called with interaction object and the argument.
+The proc should return an hash of the autocomplete result.
+
+```ruby
+client.slash("hello2", "Greet for you", {
+  "target" => {
+    type: :string,
+    description: "Person to greet",
+    autocomplete: ->(interaction, target) {
+      {
+        "You" => interaction.target.to_s
+      }
+    },
+  },
+}) do |interaction, target|
+  interaction.post("Hello, #{target}!")
+end
+```
+
+In the above example, `You` will be displayed in the user menu.
+Due to the limitation of Discord API, the proc must return the result in less than 3 second.
+
 ### Register User Context Menu Command
 
 ```ruby

data/docs/extension.md

@@ -2,16 +2,18 @@
 
 # Extension
 
-Extension allows you to seperate your code from the main application.
+Extension allows you to seperate events.
 
 # @since 
 
 ## Make a new extension
 
-Make a new class that extends Extension.
+Make a new class that includes Extension.
 
 ```ruby
-class MyExtension < Discorb::Extension
+class MyExtension
+  include Discorb::Extension
+
   # ...
 end
 ```
@@ -21,7 +23,9 @@ end
 Use {Discorb::Extension.event} to register event, or {Discorb::Extension.once_event} to register event only once.
 
 ```ruby
-class MyExtension < Discorb::Extension
+class MyExtension
+  include Discorb::Extension
+
   event :message do |message|
     # ...
   end
@@ -39,7 +43,9 @@ Note block will be binded to the extension instance.
 Use `Discorb::Extension.command` to register command, see {Discorb::ApplicationCommand::Handler} for more information.
 
 ```ruby
-class MyExtension < Discorb::Extension
+class MyExtension
+  include Discorb::Extension
+
   slash("command", "Command") do |interaction|
     # ...
   end
@@ -64,7 +70,9 @@ end
 Use {Discorb::Client#load_extension} to load extension.
 
 ```ruby
-class MyExtension < Discorb::Extension
+class MyExtension
+  include Discorb::Extension
+
   event :message do |message|
     # ...
   end
@@ -78,7 +86,9 @@ client.load_extension(MyExtension)
 You can access {Discorb::Client} from extension with `@client`.
 
 ```ruby
-class MyExtension < Discorb::Extension
+class MyExtension
+  include Discorb::Extension
+
   event :standby do |message|
     puts "Logged in as #{@client.user}"
   end
@@ -90,7 +100,9 @@ end
 You can receive arguments by adding some arguments to `#initialize`.
 
 ```ruby
-class MyExtension < Discorb::Extension
+class MyExtension
+  include Discorb::Extension
+
   def initialize(client, arg1, arg2)
     super(client)
     # @client = client will also work, but it's not recommended.
@@ -108,7 +120,9 @@ client.load_extension(MyExtension, "arg1", "arg2")
 You can do something on load by overriding `.loaded`. Client and arguments will be passed to it.
 
 ```ruby
-class MyExtension < Discorb::Extension
+class MyExtension
+  include Discorb::Extension
+
   def self.loaded(client)
     puts "This extension is loaded to #{client}"
   end

data/docs/faq.md

@@ -2,13 +2,25 @@
 
 # Fequently asked questions
 
-## What is `Async::Task`?
+## What is ...?
+
+### What is `Async::Task`?
 
 Async::Task is a object for asynchronous tasks.
 
 https://socketry.github.io/async/ for more information.
 
-## How do I do something with sent messages?
+### What is `Guild`?
+
+It means a `server` of Discord.
+
+### What is difference between `User` and `Member`?
+
+`User` is a object for account, `Member` is a object for user in guild.
+
+## How can I ...?
+
+### How can I do something with sent messages?
 
 Use `Async::Task#wait` method.
 
@@ -22,11 +34,12 @@ message = channel.post("Hello world!").wait  # => Message
 message.pin
 ```
 
-## How can I send DM to a user?
+
+### How can I send DM to a user?
 
 Use {Discorb::User#post} method, {Discorb::User} includes {Discorb::Messageable}.
 
-## How can I edit status?
+### How can I edit status?
 
 Use {Discorb::Client#update_presence} method.
 
@@ -47,7 +60,7 @@ client.on :ready do
 end
 ```
 
-## How can I send files?
+### How can I send files?
 
 Use {Discorb::File} class.
 
@@ -62,6 +75,15 @@ message.channel.post "File!", files: [Discorb::File.new(File.open("./README.md")
 message.channel.post file: Discorb::File.from_string("Hello world!", "hello.txt")
 ```
 
+### How can I add reactions?
+
+Use {Discorb::Message#add_reaction} method.
+
+```ruby
+message.add_reaction Discorb::UnicodeEmoji["🤔"]
+message.add_reaction Discorb::UnicodeEmoji["thinking"]
+```
+
 # Not fequently asked questions
 
 ## How can I pronounce `discorb`?

data/docs/tutorial.md

@@ -2,7 +2,8 @@
 
 # Tutorial
 
-Welcome to discorb! This lib allows you to create a discord bot with ease. So, let's get started!
+Welcome to discorb! This lib allows you to create a discord bot with Ruby.
+Let's get started!
 
 ## Requirements
 
@@ -22,6 +23,7 @@ Welcome to discorb! This lib allows you to create a discord bot with ease. So, l
     - [Sublime Text](https://www.sublimetext.com/)
     - [Brackets](https://brackets.io/)
     - [Notepad++](https://notepad-plus-plus.org/)
+    - [Vim](https://www.vim.org/)
 - Git
 - Bundler
 

data/examples/extension/message_expander.rb

@@ -1,6 +1,8 @@
 require "discorb"
 
-class MessageExpander < Discorb::Extension
+class MessageExpander
+  include Discorb::Extension
+
   @@message_regex = Regexp.new(
     '(?!<)https://(?:ptb\.|canary\.)?discord(?:app)?\.com/channels/' \
     "(?<guild>[0-9]{18})/(?<channel>[0-9]{18})/(?<message>[0-9]{18})(?!>)"

data/lib/discorb/app_command.rb

@@ -26,6 +26,7 @@ module Discorb
       #   | `: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. |
       #
       # @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.
@@ -236,12 +237,12 @@ module Discorb
               description: value[:description],
               required: value[:required].nil? ? !value[:optional] : value[:required],
             }
-            if value[:choices]
-              ret[:choices] = value[:choices].map { |t| { name: t[0], value: t[1] } }
-            end
-            if value[:channel_types]
-              ret[:channel_types] = value[:channel_types].map(&:channel_type)
-            end
+
+            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]
             ret
           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.10.3"
+  VERSION = "0.11.0"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}"
 

data/lib/discorb/components.rb

@@ -214,6 +214,7 @@ module Discorb
         placeholder: @placeholder,
         min_values: @min_values,
         max_values: @max_values,
+        disabled: @disabled,
       }
     end
 

data/lib/discorb/extension.rb

@@ -3,15 +3,11 @@
 module Discorb
   #
   # Abstract class to make extension.
-  # Inherit from this class to make your own extension.
+  # Include from this module to make your own extension.
   # @see file:docs/extension.md
   # @abstract
   #
-  class Extension
-    extend Discorb::ApplicationCommand::Handler
-
-    @events = {}
-
+  module Extension
     def initialize(client)
       @client = client
     end
@@ -27,7 +23,12 @@ module Discorb
       @events = ret
     end
 
-    class << self
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include Discorb::ApplicationCommand::Handler
       undef setup_commands
 
       #
@@ -69,7 +70,7 @@ module Discorb
       # @private
       attr_reader :bottom_commands
 
-      def inherited(klass)
+      def self.extended(klass)
         klass.instance_variable_set(:@commands, [])
         klass.instance_variable_set(:@bottom_commands, [])
         klass.instance_variable_set(:@events, {})

data/lib/discorb/http.rb

@@ -36,13 +36,7 @@ module Discorb
         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])
-          get(path, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait
-        else
-          [resp, data]
-        end)
+        handle_response(:patch, resp, data, path, nil, headers, audit_log_reason, kwargs)
       end
     end
 
@@ -67,12 +61,7 @@ module Discorb
         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
-        else
-          [resp, data]
-        end)
+        handle_response(:post, resp, data, path, body, headers, audit_log_reason, kwargs)
       end
     end
 
@@ -97,12 +86,7 @@ module Discorb
         resp = http.patch(get_path(path), get_body(body), get_headers(headers, body, audit_log_reason), **kwargs)
         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
-        else
-          [resp, data]
-        end)
+        handle_response(:patch, resp, data, path, body, headers, audit_log_reason, kwargs)
       end
     end
 
@@ -127,12 +111,7 @@ module Discorb
         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
-        else
-          [resp, data]
-        end)
+        handle_response(:put, resp, data, path, body, headers, audit_log_reason, kwargs)
       end
     end
 
@@ -151,17 +130,12 @@ module Discorb
     # @raise [Discorb::HTTPError] The request was failed.
     #
     def delete(path, headers: nil, audit_log_reason: nil, **kwargs)
-      Async do |task|
+      Async do
         @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
-        else
-          [resp, data]
-        end)
+        handle_response(:delete, resp, data, path, nil, headers, audit_log_reason, kwargs)
       end
     end
 
@@ -198,9 +172,15 @@ module Discorb
 
     private
 
-    def test_error(ary)
-      resp, data = *ary
+    def handle_response(method, resp, data, path, body, headers, audit_log_reason, kwargs)
       case resp.code
+      when "429"
+        sleep(data[:retry_after])
+        if body
+          __send__(method, path, body, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait
+        else
+          __send__(method, path, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait
+        end
       when "400"
         raise BadRequestError.new(resp, data)
       when "401"

data/lib/discorb/integration.rb

@@ -63,7 +63,7 @@ module Discorb
     #
     def delete!(reason: nil)
       Async do
-        @client.http.delete("/guilds/#{@guild}/integrations/#{@id}", reason: reason).wait
+        @client.http.delete("/guilds/#{@guild}/integrations/#{@id}", audit_log_reason: reason).wait
       end
     end
 

data/lib/discorb/interaction.rb

@@ -364,7 +364,7 @@ module Discorb
           end
 
           unless (command = @client.bottom_commands.find { |c| c.to_s == name && c.type_raw == 1 })
-            @client.log.warn "Unknown command name #{name}, ignoreing"
+            @client.log.warn "Unknown command name #{name}, ignoring"
             next
           end
 
@@ -451,6 +451,87 @@ module Discorb
     end
   end
 
+  #
+  # Represents auto complete interaction.
+  #
+  class AutoComplete < Interaction
+    @interaction_type = 4
+    @interaction_name = :auto_complete
+
+    def _set_data(data)
+      super
+      Sync do
+        name = data[:name]
+        options = nil
+        if (option = data[:options]&.first)
+          case option[:type]
+          when 1
+            name += " #{option[:name]}"
+            options = option[:options]
+          when 2
+            name += " #{option[:name]}"
+            if (option_sub = option[:options]&.first)
+              if option_sub[:type] == 1
+                name += " #{option_sub[:name]}"
+                options = option_sub[:options]
+              else
+                options = option[:options]
+              end
+            end
+          else
+            options = data[:options]
+          end
+        end
+
+        unless (command = @client.bottom_commands.find { |c| c.to_s == name && c.type_raw == 1 })
+          @client.log.warn "Unknown command name #{name}, ignoring"
+          next
+        end
+
+        option_map = command.options.map { |k, v| [k.to_s, v[:default]] }.to_h
+        options ||= []
+        options.each_with_index do |option|
+          val = case option[:type]
+            when 3, 4, 5, 10
+              option[:value]
+            when 6
+              guild.members[option[:value]] || guild.fetch_member(option[:value]).wait
+            when 7
+              guild.channels[option[:value]] || guild.fetch_channels.wait.find { |channel| channel.id == option[:value] }
+            when 8
+              guild.roles[option[:value]] || guild.fetch_roles.wait.find { |role| role.id == option[:value] }
+            when 9
+              guild.members[option[:value]] || guild.roles[option[:value]] || guild.fetch_member(option[:value]).wait || guild.fetch_roles.wait.find { |role| role.id == option[:value] }
+            end
+          option_map[option[:name]] = val
+        end
+        focused_index = options.find_index { |o| o[:focused] }
+        val = command.options.values[focused_index][:autocomplete]&.call(self, *command.options.map { |k, v| option_map[k.to_s] })
+        send_complete_result(val)
+      end
+    end
+
+    def send_complete_result(val)
+      @client.http.post("/interactions/#{@id}/#{@token}/callback", {
+        type: 8,
+        data: {
+          choices: val.map do |vk, vv|
+            {
+              name: vk,
+              value: vv,
+            }
+          end,
+        },
+      }).wait
+    rescue Discorb::NotFoundError
+      @client.log.warn "Failed to send auto complete result, This may be caused by the suggestion is taking too long (over 3 seconds) to respond", fallback: $stderr
+    end
+
+    class << self
+      alias make_interaction new
+    end
+  end
+
   #
   # Represents a message component interaction.
   # @abstract

data/lib/discorb/member.rb

@@ -71,21 +71,12 @@ module Discorb
       _set_data(user_data, member_data)
     end
 
-    #
-    # Format the member to `@name` style.
-    #
-    # @return [String] The formatted member.
-    #
-    def to_s
-      "@#{name}"
-    end
-
     #
     # Format the member to `Username#Discriminator` style.
     #
     # @return [String] The formatted member.
     #
-    def to_s_user
+    def to_s
       "#{username}##{discriminator}"
     end
 

data/lib/discorb/modules.rb

@@ -94,7 +94,7 @@ module Discorb
     #
     def delete_message!(message_id, reason: nil)
       Async do
-        @client.http.delete("/channels/#{channel_id.wait}/messages/#{message_id}", reason: reason).wait
+        @client.http.delete("/channels/#{channel_id.wait}/messages/#{message_id}", audit_log_reason: reason).wait
       end
     end
 

data/lib/discorb/rate_limit.rb

@@ -11,6 +11,7 @@ module Discorb
       @client = client
       @ratelimit_hash = {}
       @path_ratelimit_hash = {}
+      @global = false
     end
 
     #
@@ -22,6 +23,14 @@ module Discorb
     def wait(method, path)
       return if path.start_with?("https://")
 
+      if @global
+        time = b[:reset_at] - Time.now.to_i
+        @client.log.info("Global ratelimit reached, waiting #{time} seconds")
+        sleep(time)
+        @global = false
+        
+      end
+
       return unless hash = @path_ratelimit_hash[method + path]
 
       return unless b = @ratelimit_hash[hash]
@@ -32,8 +41,9 @@ module Discorb
       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)
+      time = b[:reset_at] - Time.now.to_i
+      @client.log.info("Ratelimit reached, waiting #{time} seconds")
+      sleep(time)
     end
 
     #
@@ -44,6 +54,9 @@ module Discorb
     # @param [Net::HTTPResponse] resp The response.
     #
     def save(method, path, resp)
+      if resp["X-Ratelimit-Global"] == "true"
+        @global = Time.now.to_i + JSON.parse(resp.body, symbolize_names: true)[:retry_after]
+      end
       return unless resp["X-RateLimit-Remaining"]
 
       @path_ratelimit_hash[method + path] = resp["X-RateLimit-Bucket"]

data/lib/discorb/role.rb

@@ -98,7 +98,7 @@ module Discorb
     #
     def move(position, reason: nil)
       Async do
-        @client.http.patch("/guilds/#{@guild_id}/roles", { id: @id, position: position }, reason: reason).wait
+        @client.http.patch("/guilds/#{@guild.id}/roles", { id: @id, position: position }, audit_log_reason: reason).wait
       end
     end
 
@@ -113,9 +113,10 @@ module Discorb
     # @param [Discorb::Color] color The new color of the role.
     # @param [Boolean] hoist Whether the role should be hoisted.
     # @param [Boolean] mentionable Whether the role should be mentionable.
+    # @param [Discorb::Image, Discorb::UnicodeEmoji] icon The new icon or emoji of the role.
     # @param [String] reason The reason for editing the role.
     #
-    def edit(name: :unset, position: :unset, color: :unset, hoist: :unset, mentionable: :unset, reason: nil)
+    def edit(name: :unset, position: :unset, color: :unset, hoist: :unset, mentionable: :unset, icon: :unset, reason: nil)
       Async do
         payload = {}
         payload[:name] = name if name != :unset
@@ -123,7 +124,14 @@ module Discorb
         payload[:color] = color.to_i if color != :unset
         payload[:hoist] = hoist if hoist != :unset
         payload[:mentionable] = mentionable if mentionable != :unset
-        @client.http.patch("/guilds/#{@guild_id}/roles/#{@id}", payload, reason: reason).wait
+        if icon != :unset
+          if icon.is_a?(Discorb::Image)
+            payload[:icon] = icon.to_s
+          else
+            payload[:unicode_emoji] = icon.to_s
+          end
+        end
+        @client.http.patch("/guilds/#{@guild.id}/roles/#{@id}", payload, audit_log_reason: reason).wait
       end
     end
 
@@ -136,7 +144,7 @@ module Discorb
     #
     def delete!(reason: nil)
       Async do
-        @client.http.delete("/guilds/#{@guild_id}/roles/#{@id}", reason: reason).wait
+        @client.http.delete("/guilds/#{@guild.id}/roles/#{@id}", audit_log_reason: reason).wait
       end
     end
 

data/lib/discorb/voice_state.rb

@@ -193,7 +193,7 @@ module Discorb
     #
     def delete!(reason: nil)
       Async do
-        @client.http.delete("/stage-instances/#{@channel_id}", reason: reason).wait
+        @client.http.delete("/stage-instances/#{@channel_id}", audit_log_reason: reason).wait
         self
       end
     end

metadata

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