discorb 0.16.0 → 0.17.0

data/docs/extension.md

@@ -64,7 +64,6 @@ class MyExtension
 end
 ```
 
-
 ## Load extension
 
 Use {Discorb::Client#load_extension} to load extension.
@@ -127,4 +126,4 @@ class MyExtension
     puts "This extension is loaded to #{client}"
   end
 end
-```
+```

data/docs/faq.md

@@ -36,7 +36,6 @@ message = channel.post("Hello world!").wait  # => Message
 message.pin
 ```
 
-
 ### How can I send DM to a user?
 
 Use {Discorb::User#post} method, {Discorb::User} includes {Discorb::Messageable}.

data/docs/tutorial.md

@@ -11,21 +11,21 @@ Let's get started!
 
 - 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/)
+   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/)
-    - [Vim](https://www.vim.org/)
+   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/)
+  - [Vim](https://www.vim.org/)
 - Git
 - Bundler
 
@@ -160,7 +160,7 @@ end
 
 Save your bot and restart it.
 
-You can see your bot's response by typing `hello` in your server...  
+You can see your bot's response by typing `hello` in your server...
 
 ![](./assets/07_hello_infinite.png)
 

data/docs/voice_events.md

@@ -10,35 +10,35 @@
 
 Fires when someone joins a voice channel.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| state | {Discorb::VoiceState} | The voice state of the user that joined. |
+| Parameter | Type                  | Description                              |
+| --------- | --------------------- | ---------------------------------------- |
+| state     | {Discorb::VoiceState} | The voice state of the user that joined. |
 
 #### `voice_channel_disconnect(state)`
 
 Fires when someone leaves a voice channel.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| state | {Discorb::VoiceState} | The voice state of the user that left. |
+| Parameter | Type                  | Description                            |
+| --------- | --------------------- | -------------------------------------- |
+| state     | {Discorb::VoiceState} | The voice state of the user that left. |
 
 #### `voice_channel_move(before, after)`
 
 Fires when someone moves to a different voice channel.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| before | {Discorb::VoiceState} | The voice state of the user before the move. |
-| after | {Discorb::VoiceState} | The voice state of the user after the move. |
+| Parameter | Type                  | Description                                  |
+| --------- | --------------------- | -------------------------------------------- |
+| before    | {Discorb::VoiceState} | The voice state of the user before the move. |
+| after     | {Discorb::VoiceState} | The voice state of the user after the move.  |
 
 #### `voice_channel_update(before, after)`
 
 Fires when a voice channel is connected, disconnected, or updated.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| before | {Discorb::VoiceState} | The voice state before the update. |
-| after | {Discorb::VoiceState} | The voice state after the update. |
+| Parameter | Type                  | Description                        |
+| --------- | --------------------- | ---------------------------------- |
+| before    | {Discorb::VoiceState} | The voice state before the update. |
+| after     | {Discorb::VoiceState} | The voice state after the update.  |
 
 ### Mute Events
 
@@ -46,76 +46,76 @@ Fires when a voice channel is connected, disconnected, or updated.
 
 Fires when a user's voice mute is disabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_mute_enable(state)`
 
 Fires when a user's voice mute is enabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_mute_update(before, after)`
 
 Fires when a user's voice mute is enabled or disabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `before` | {Discorb::VoiceState} | The voice state before the update. |
-| `after` | {Discorb::VoiceState} | The voice state after the update. |
+| Parameter | Type                  | Description                        |
+| --------- | --------------------- | ---------------------------------- |
+| `before`  | {Discorb::VoiceState} | The voice state before the update. |
+| `after`   | {Discorb::VoiceState} | The voice state after the update.  |
 
 #### `voice_server_mute_enable(state)`
 
 Fires when a user's server voice mute is enabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_server_mute_disable(state)`
 
 Fires when a user's server voice mute is disabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_server_mute_update(before, after)`
 
 Fires when a user's server voice mute is enabled or disabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `before` | {Discorb::VoiceState} | The voice state before the update. |
-| `after` | {Discorb::VoiceState} | The voice state after the update. |
+| Parameter | Type                  | Description                        |
+| --------- | --------------------- | ---------------------------------- |
+| `before`  | {Discorb::VoiceState} | The voice state before the update. |
+| `after`   | {Discorb::VoiceState} | The voice state after the update.  |
 
 #### `voice_self_mute_enable(state)`
 
 Fires when a user's self voice mute is enabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_self_mute_disable(state)`
 
 Fires when a user's self voice mute is disabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_self_mute_update(before, after)`
 
 Fires when a user's self voice mute is enabled or disabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `before` | {Discorb::VoiceState} | The voice state before the update. |
-| `after` | {Discorb::VoiceState} | The voice state after the update. |
+| Parameter | Type                  | Description                        |
+| --------- | --------------------- | ---------------------------------- |
+| `before`  | {Discorb::VoiceState} | The voice state before the update. |
+| `after`   | {Discorb::VoiceState} | The voice state after the update.  |
 
 ### Deaf Events
 
@@ -123,74 +123,74 @@ Fires when a user's self voice mute is enabled or disabled.
 
 Fires when a user's voice deaf is enabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_deaf_disable(state)`
 
 Fires when a user's voice deaf is disabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_deaf_update(before, after)`
 
 Fires when a user's voice deaf is enabled or disabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `before` | {Discorb::VoiceState} | The voice state before the update. |
-| `after` | {Discorb::VoiceState} | The voice state after the update. |
+| Parameter | Type                  | Description                        |
+| --------- | --------------------- | ---------------------------------- |
+| `before`  | {Discorb::VoiceState} | The voice state before the update. |
+| `after`   | {Discorb::VoiceState} | The voice state after the update.  |
 
 #### `voice_server_deaf_enable(state)`
 
 Fires when a user's server voice deaf is enabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_server_deaf_disable(state)`
 
 Fires when a user's server voice deaf is disabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_server_deaf_update(before, after)`
 
 Fires when a user's server voice deaf is enabled or disabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `before` | {Discorb::VoiceState} | The voice state before the update. |
-| `after` | {Discorb::VoiceState} | The voice state after the update. |
+| Parameter | Type                  | Description                        |
+| --------- | --------------------- | ---------------------------------- |
+| `before`  | {Discorb::VoiceState} | The voice state before the update. |
+| `after`   | {Discorb::VoiceState} | The voice state after the update.  |
 
 #### `voice_self_deaf_enable(state)`
 
 Fires when a user's self voice deaf is enabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_self_deaf_disable(state)`
 
 Fires when a user's self voice deaf is disabled.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_self_deaf_update(before, after)`
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `before` | {Discorb::VoiceState} | The voice state before the update. |
-| `after` | {Discorb::VoiceState} | The voice state after the update. |
+| Parameter | Type                  | Description                        |
+| --------- | --------------------- | ---------------------------------- |
+| `before`  | {Discorb::VoiceState} | The voice state before the update. |
+| `after`   | {Discorb::VoiceState} | The voice state after the update.  |
 
 ### Stream Events
 
@@ -198,26 +198,26 @@ Fires when a user's self voice deaf is disabled.
 
 Fires when a stream is started.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_stream_end(state)`
 
 Fires when a stream is ended.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_stream_update(before, after)`
 
 Fires when a stream is started or ended.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `before` | {Discorb::VoiceState} | The voice state before the update. |
-| `after` | {Discorb::VoiceState} | The voice state after the update. |
+| Parameter | Type                  | Description                        |
+| --------- | --------------------- | ---------------------------------- |
+| `before`  | {Discorb::VoiceState} | The voice state before the update. |
+| `after`   | {Discorb::VoiceState} | The voice state after the update.  |
 
 ### Video Events
 
@@ -225,26 +225,26 @@ Fires when a stream is started or ended.
 
 Fires when a video is started.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_video_end(state)`
 
 Fires when a video is ended.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `state` | {Discorb::VoiceState} | The voice state. |
+| Parameter | Type                  | Description      |
+| --------- | --------------------- | ---------------- |
+| `state`   | {Discorb::VoiceState} | The voice state. |
 
 #### `voice_video_update(before, after)`
 
 Fires when a video is started or ended.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `before` | {Discorb::VoiceState} | The voice state before the update. |
-| `after` | {Discorb::VoiceState} | The voice state after the update. |
+| Parameter | Type                  | Description                        |
+| --------- | --------------------- | ---------------------------------- |
+| `before`  | {Discorb::VoiceState} | The voice state before the update. |
+| `after`   | {Discorb::VoiceState} | The voice state after the update.  |
 
 ### Stage Instances Events
 
@@ -252,26 +252,26 @@ Fires when a video is started or ended.
 
 Fires when a new stage instance is created.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
+| Parameter  | Type                     | Description           |
+| ---------- | ------------------------ | --------------------- |
 | `instance` | {Discorb::StageInstance} | The created instance. |
 
 #### `stage_instance_delete(instance)`
 
 Fires when a stage instance is deleted.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
+| Parameter  | Type                     | Description           |
+| ---------- | ------------------------ | --------------------- |
 | `instance` | {Discorb::StageInstance} | The deleted instance. |
 
 #### `stage_instance_update(before, after)`
 
 Fires when a stage instance is updated.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `before` | {Discorb::StageInstance} | The instance before the update. |
-| `after` | {Discorb::StageInstance} | The instance after the update. |
+| Parameter | Type                     | Description                     |
+| --------- | ------------------------ | ------------------------------- |
+| `before`  | {Discorb::StageInstance} | The instance before the update. |
+| `after`   | {Discorb::StageInstance} | The instance after the update.  |
 
 ### Misc Events
 
@@ -279,7 +279,7 @@ Fires when a stage instance is updated.
 
 Fired when a user changes voice state.
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| before | {Discorb::VoiceState} | The voice state before the update. |
-| after | {Discorb::VoiceState} | The voice state after the update. |
+| Parameter | Type                  | Description                        |
+| --------- | --------------------- | ---------------------------------- |
+| before    | {Discorb::VoiceState} | The voice state before the update. |
+| after     | {Discorb::VoiceState} | The voice state after the update.  |

data/examples/commands/message.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require "discorb"
+require "json"
+
+localizations = {
+  context_command: {
+    not_found: {
+      en: "Bookmark channel not found. Please create one called `bookmarks`.",
+      ja: "ブックマークチャンネルが見付かりませんでした。`bookmarks`という名前のチャンネルを作成してください。",
+    },
+    done: {
+      en: "Bookmark added.",
+      ja: "ブックマークを追加しました。",
+    },
+  },
+}
+
+client = Discorb::Client.new
+
+client.once :standby do
+  puts "Logged in as #{client.user}"
+end
+
+def bookmark_channel(guild)
+  guild.channels.find { |c| c.is_a?(Discorb::TextChannel) && c.name == "bookmarks" }
+end
+
+def build_embed_from_message(message)
+  embed = Discorb::Embed.new
+  embed.description = message.content
+  embed.author = Discorb::Embed::Author.new(message.author.to_s_user, icon: message.author.avatar.url)
+  embed.timestamp = message.timestamp
+  embed.footer = Discorb::Embed::Footer.new("ID: #{message.id}")
+  embed
+end
+
+client.message_command({
+  default: "Bookmark",
+  ja: "ブックマーク",
+}) do |interaction, message|
+  unless channel = bookmark_channel(interaction.guild)
+    interaction.post(
+      localizations[:context_command][:not_found][interaction.locale] || localizations[:context_command][:not_found][:en],
+      ephemeral: true,
+    )
+    next
+  end
+  channel.post(
+    message.jump_url,
+    embed: build_embed_from_message(message),
+  ).wait
+  interaction.post(
+    localizations[:context_command][:done][interaction.locale] || localizations[:context_command][:done][:en], ephemeral: true,
+  )
+end
+
+client.change_presence(
+  Discorb::Activity.new(
+    "Open message context menu to bookmark"
+  )
+)
+
+client.run(ENV.fetch("DISCORD_BOT_TOKEN", nil))

data/examples/commands/permission.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require "discorb"
+
+client = Discorb::Client.new
+
+client.once :standby do
+  puts "Logged in as #{client.user}"
+end
+
+client.slash(
+  "admin", "You can run this command if you have Administrator permission",
+  dm: false,
+  default_permission: Discorb::Permission.from_keys(:administrator),
+) do |interaction, _name|
+  interaction.post("Hello, admin!")
+end
+
+client.run(ENV.fetch("DISCORD_BOT_TOKEN", nil))

data/examples/commands/slash.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+require "discorb"
+
+client = Discorb::Client.new
+
+localizations = {
+  localized: {
+    text: {
+      en: "Hello, %s!",
+      ja: "%sさん、こんにちは！",
+    },
+  },
+}
+
+client.once :standby do
+  puts "Logged in as #{client.user}"
+end
+
+client.slash({
+  default: "greet",
+  ja: "挨拶",
+}, {
+  default: "Bot greets. Cute OwO",
+  ja: "Botが挨拶します。かわいいね",
+}, {
+  "name" => {
+    name_localizations: {
+      ja: "名前",
+    },
+    description: {
+      default: "The name to greet.",
+      ja: "挨拶する人の名前。",
+    },
+    type: :string,
+    optional: true,
+  },
+}) do |interaction, name|
+  interaction.post(
+    format((localizations[:localized][:text][interaction.locale] || localizations[:localized][:text][:en]), name || interaction.target.to_s_user),
+    ephemeral: true,
+  )
+end
+
+client.run(ENV.fetch("DISCORD_BOT_TOKEN", nil))

data/examples/commands/user.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+require "discorb"
+
+localizations = {
+  info: {
+    title: {
+      en: "%s's info",
+      ja: "%sの詳細",
+    },
+    fields: {
+      en: ["Name", "ID", "Bot", "Joined at", "Account created at"],
+      ja: %w[名前 ID ボット 参加日時 アカウント作成日時],
+    },
+    yn: {
+      en: %w[Yes No],
+      ja: %w[はい いいえ],
+    },
+  },
+}
+
+client = Discorb::Client.new
+
+client.once :standby do
+  puts "Logged in as #{client.user}"
+end
+
+client.user_command({
+  default: "info",
+  ja: "詳細",
+}) do |interaction|
+  field_name = localizations[:info][:fields][interaction.locale] || localizations[:info][:fields][:en]
+  interaction.post(
+    embed: Discorb::Embed.new(
+      format((localizations[:info][:title][interaction.locale] || localizations[:info][:title][:en]), interaction.target.to_s_user),
+      fields: [
+        Discorb::Embed::Field.new(field_name[0], interaction.target.to_s_user),
+        Discorb::Embed::Field.new(field_name[1], interaction.target.id),
+        Discorb::Embed::Field.new(
+          field_name[2],
+          (localizations[:info][:yn][interaction.locale] || localizations[:info][:yn][:en])[interaction.target.bot? ? 0 : 1]
+        ),
+        Discorb::Embed::Field.new(field_name[3], interaction.target.joined_at.to_df("F")),
+        Discorb::Embed::Field.new(field_name[4], interaction.target.created_at.to_df("F")),
+      ],
+      thumbnail: interaction.target.avatar&.url,
+
+    ), ephemeral: true,
+  )
+end
+
+client.run(ENV.fetch("DISCORD_BOT_TOKEN", nil))

data/examples/components/authorization_button.rb

@@ -28,7 +28,7 @@ client.on :message do |message|
     components: [
       Discorb::Button.new(
         "Get role", custom_id: "auth:#{role.id}",
-      )
+      ),
     ],
   )
 end
@@ -41,4 +41,4 @@ client.on :button_click do |response|
   end
 end
 
-client.run(ENV["DISCORD_BOT_TOKEN"])
+client.run(ENV.fetch("DISCORD_BOT_TOKEN", nil))

data/examples/components/select_menu.rb

@@ -22,7 +22,7 @@ SECTIONS = [
     > So I decided to make it.
     Matsumoto describes the design of Ruby as being like a simple Lisp language at its core, with an object system like that of Smalltalk, blocks inspired by higher-order functions, and practical utility like that of Perl.
   WIKI
-  ["First publication", <<~WIKI]
+  ["First publication", <<~WIKI],
     The first public release of Ruby 0.95 was announced on Japanese domestic newsgroups on December 21, 1995.
     Subsequently, three more versions of Ruby were released in two days.
     The release coincided with the launch of the Japanese-language ruby-list mailing list, which was the first mailing list for the new language.
@@ -59,4 +59,4 @@ client.on :select_menu_select do |response|
   )
 end
 
-client.run(ENV["DISCORD_BOT_TOKEN"])
+client.run(ENV.fetch("DISCORD_BOT_TOKEN", nil))

data/examples/extension/main.rb

@@ -10,4 +10,4 @@ end
 
 client.load_extension(MessageExpander)
 
-client.run(ENV["DISCORD_BOT_TOKEN"])
+client.run(ENV.fetch("DISCORD_BOT_TOKEN", nil))