discorb 0.16.0 → 0.18.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/)
+  - [RubyMine](https://www.jetbrains.com/ruby/)
+  - [Sublime Text](https://www.sublimetext.com/)
+  - [Brackets](https://brackets.io/)
+  - [Notepad++](https://notepad-plus-plus.org/)
+  - [Vim](https://www.vim.org/)
 - Git
 - Bundler
 
@@ -98,10 +98,10 @@ You will get other files if you specify `--git`.
 Open `main.rb`, you will see the following code:
 
 ```ruby
-require "discorb"
-require "dotenv"
+# frozen_string_literal: true
 
-Dotenv.load  # Loads .env file
+require "discorb"
+require "dotenv/load"  # Load environment variables from .env file.
 
 client = Discorb::Client.new  # Create client for connecting to Discord
 
@@ -115,10 +115,10 @@ client.run ENV["TOKEN"]  # Starts client
 Open `.env`, you will see:
 
 ```
-TOKEN=Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng
+TOKEN=
 ```
 
-Replace `Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng` with your bot token.
+Put your token after `TOKEN=`.
 Remember to keep this file secret!
 
 Open terminal and type:
@@ -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)
 
@@ -194,4 +194,4 @@ You did it! Your bot won't respond to bot's messages anymore.
 This is the end of tutorial.
 
 To learn more, check out the [documentation](https://discorb-lib.github.io/).
-You can also check out [Examples](docs/examples).
+You can also check out [Examples](https://github.com/discorb-lib/discorb/tree/main/examples).

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,68 @@
+# 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.text_channels.find { |c| 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, 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|
+  next unless interaction.guild
+
+  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,19 @@
+# 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_permission: 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,48 @@
+# 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.user.to_s),
+    ephemeral: true,
+  )
+end
+
+client.run(ENV.fetch("DISCORD_BOT_TOKEN", nil))

data/examples/commands/user.rb

@@ -0,0 +1,54 @@
+# 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, user|
+  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]),
+             user.to_s),
+      fields: [
+        Discorb::Embed::Field.new(field_name[0], user.to_s),
+        Discorb::Embed::Field.new(field_name[1], user.id),
+        Discorb::Embed::Field.new(
+          field_name[2],
+          (localizations[:info][:yn][locale] || localizations[:info][:yn][:en])[user.bot? ? 0 : 1]
+        ),
+        Discorb::Embed::Field.new(field_name[3], user.joined_at.to_df("F")),
+        Discorb::Embed::Field.new(field_name[4], user.created_at.to_df("F")),
+      ],
+      thumbnail: user.avatar&.url,
+    ), ephemeral: true,
+  )
+end
+
+client.run(ENV.fetch("DISCORD_BOT_TOKEN", nil))