discorb 0.0.8 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b247a62629770b82d8326ac69507603a27bc8cf31bcf7c06a7aa9d546b7e80a
-  data.tar.gz: ec2416663ce7d90e2023c648a115e6a2691f4557394770274dcf4a25489aad36
+  metadata.gz: 1381542f36d691bc8c16bbca477f7dbc034d18d4308c6e51689e02d766af9fac
+  data.tar.gz: 611e01c698fbb0c19f7a37cad66faddf5dfbba860b59dc2a140c3a3b7d85dd9e
 SHA512:
-  metadata.gz: 511985823e749cec350e08f98cd9b7f05172d00fb02e63756b4c8dadd65657c9a68d775a1309190c14ec72c12ed955a6bfbd7bc23d55307fc90165b5a9d81c63
-  data.tar.gz: ba547c5dc8a1558654ae860be8f426255bf633809acb82b853a14b72ffbbda9b58a6d0bc50c6e2b656233b08672ec78be07a4899436f5c90e162b3a06aa45c5f
+  metadata.gz: eab30f2c135c3a1dd63fc36cea26df4035f57da50e96fbc52e74d207248599dd0d50d7df9379bf20b906b128aa3e7abd47f637c7cd56662a991c7feb7cd7944e
+  data.tar.gz: e9b03bd76e066037ef98480c9952bbfe6a0d7d039199e5d2a804bac49e550d03b74c1596847e485f2ba13b935012c80fb39a356df21f0d154b981f705807a113

data/.yardopts

@@ -3,4 +3,5 @@
 --markup markdown
 --tag flags:"Flags"
 -
-docs/*.md
+docs/*.md
+Changelog.md

data/Changelog.md

@@ -14,4 +14,54 @@
 
 ## v0.0.4
 
-- Fix: Fix NoMethodError by webhook message
+- Fix: Fix NoMethodError by webhook message
+- Add: Add `#author` to webhook message
+- Fix: Add `#bot?` to webhook author
+
+## v0.0.5
+
+- Fix: Fix GitHub link
+- Change: Internet to HTTP
+
+## v0.0.6
+
+- Fix: Fix error in client without members intent
+- Add: Add ThreadChannel::News
+- Add: Add official discord link
+
+## v0.0.7
+
+- Fix: Fix `member_xxx` event
+
+## 0.0.8
+
+- Delete: Delete task parameter
+
+## 0.1.0
+
+- Add: Add `User#created_at`
+- Add: Add `Member#to_s_user`
+- Add: Add `DefaultAvatar`
+- Add: Support application commands
+- Add: Add `Client#ping`
+- Add: Allow `String` for `Embed#initialize`
+- Change: Change log format
+
+## 0.2.0
+
+- Fix: Fix unused dependency
+- Add: Add `Client#close!`
+- Add: Add discord-irb
+
+## 0.2.1
+
+- Fix: Fix NoMethodError in reaction event
+- Add: Add Changelog.md to document
+
+## 0.2.2 (yanked)
+
+- Add: Add `Snowflake#to_str`
+
+## 0.2.3
+
+- Fix: Fix critical error

data/Gemfile

@@ -7,12 +7,6 @@ gemspec
 
 gem "rake", "~> 13.0"
 
-gem "async"
-gem "async-http"
-gem "async-websocket"
-
-gem "mime-types", "~> 3.3"
-
 group :debug, optional: true do
   gem "rufo", "~> 0.13.0"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    discorb (0.0.8)
+    discorb (0.2.3)
       async
       async-http
       async-websocket
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    async (1.30.0)
+    async (1.30.1)
       console (~> 1.10)
       nio4r (~> 2.3)
       timers (~> 4.1)
@@ -56,11 +56,7 @@ PLATFORMS
   x86-mingw32
 
 DEPENDENCIES
-  async
-  async-http
-  async-websocket
   discorb!
-  mime-types (~> 3.3)
   rake (~> 13.0)
   redcarpet
   rufo (~> 0.13.0)

data/docs/application_command.md

@@ -0,0 +1,251 @@
+# @title Application Commands
+
+# Application Commands
+
+## What is an application command?
+
+> Application commands are commands that an application can register to Discord. They provide users a first-class way of interacting directly with your application that feels deeply integrated into Discord.
+
+From: [Discord API docs](https://discord.com/developers/docs/interactions/application-commands#application-commands)
+
+## How do I register an application command?
+
+Use {Discorb::Command::Handler#slash}, {Discorb::Command::Handler#group} for slash commands, {Discorb::Command::Handler#user_command} for user menu commands, and {Discorb::Command::Handler#message_command} for message menu commands.
+
+### Note
+
+To register a global command, it will take 1 hour to be registered.
+Guild commands will be registered immediately.
+
+### Register Slash Commands
+
+This example registers a slash command that says "Hello, world!" when the user types `/hello`.
+
+```ruby
+require "discorb"
+
+client = Discorb::Client.new
+
+client.slash("hello", "Greet for you") do |interaction|
+  interaction.post("Hello World!", ephemeral: true)
+end
+
+client.run(ENV["DISCORD_BOT_TOKEN"])
+```
+
+{Discorb::Command::Handler#slash} takes 5 arguments:
+
+| Argument | Description |
+|---------|-------------|
+| `command_name` | The name of the command. |
+| `description` | The description of the command. |
+| `options` | A hash of options. |
+| `guild_ids` | The ID of the guild to register the command in. |
+| `block` | A block that will be called when the command is invoked. |
+
+In `options`, hash should be like this:
+
+```ruby
+{
+    "Name" => {
+        type: :string,
+        required: true,
+        description: "The description of the command."
+    }
+}
+```
+
+| Key | Description |
+| --- | --- |
+| `type` | The type of the argument. |
+| `required` | Whether the argument is required. |
+| `description` | The description of the argument. |
+| `choices` | The choices of the argument. |
+
+`choices` should be unspecified if you don't want to use it.
+`choices` is hash 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",
+        }
+    }
+}
+
+# Note: This aritcle is written in 8/31.
+```
+
+The key will be displayed in the user menu, and the value will be used as the argument.
+
+In `type`, You must use one of the following:
+
+| Name | Description | Aliases|
+| --- | --- | --- |
+| `:string` | String argument. | `:str` |
+| `:integer` | Integer argument. | `:int` |
+| `:float` | Float argument. | None |
+| `:boolean` | Boolean argument. | `:bool` |
+| `:user` | User argument. | `:member` |
+| `:channel` | Channel argument. | None |
+| `:role` | Role argument. | None |
+
+### Group Slash Commands
+
+To register a group of slash commands, use {Discorb::Command::Handler#slash_group}.
+
+```ruby
+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."
+    }
+}) do |interaction|
+  # ...
+end
+
+group.slash("bump_alert", "Whether bot should notify DISBOARD bump.", {
+    "enabled" => {
+        type: :boolean,
+        description: "Whether bot should notify DISBOARD bump."
+    }
+}) do |interaction|
+  # ...
+end
+```
+
+You can make subcommand group by using {Discorb::Command::GroupCommand#group}.
+
+```ruby
+group = client.slash_group("permission", "Set/Get command permissions.")
+
+group_user = group.group("user", "Set/Get user's command permissions.")
+
+group_user.slash("set", "Set user's command permissions.", {
+    "user_id" => {
+        type: :user,
+        description: "The user."
+    },
+    "value" => {
+        type: :boolean,
+        description: "Whether the user can use the command."
+    }
+}) do |interaction, user|
+  # ...
+end
+
+group_user.slash("get", "Set user's command permissions.", {
+    "user_id" => {
+        type: :user,
+        description: "The user."
+    },
+}) do |interaction, user|
+  # ...
+end
+
+group_user = group.group("user", "Set/Get user's command permissions.")
+
+group_user.slash("set", "Set user's command permissions.", {
+    "user_id" => {
+        type: :user,
+        description: "The user."
+    },
+    "value" => {
+        type: :boolean,
+        description: "Whether the user can use the command."
+    }
+}) do |interaction, user|
+  # ...
+end
+
+group_user.slash("get", "Set user's command permissions.", {
+    "user_id" => {
+        type: :user,
+        description: "The user."
+    },
+}) do |interaction, user|
+  # ...
+end
+
+group_role = group.group("role", "Set/Get role's command permissions.")
+
+group_role.slash("set", "Set role's command permissions.", {
+    "role_id" => {
+        type: :role,
+        description: "The role."
+    },
+    "value" => {
+        type: :boolean,
+        description: "Whether the role can use the command."
+    }
+}) do |interaction, role|
+  # ...
+end
+
+group_role.slash("get", "Set role's command permissions.", {
+    "role_id" => {
+        type: :role,
+        description: "The role."
+    },
+}) do |interaction, role|
+  # ...
+end
+
+```
+
+### Register User Context Menu Command
+
+```ruby
+client.user_command("hello") do |interaction, user|
+  interaction.post("Hello, #{user.name}!")
+end
+```
+{Discorb::Command::Handler#user_command} takes 3 arguments:
+
+| Parameter | Description |
+| --- | --- |
+| `command_name` | The name of the command. |
+| `guild_ids` | The ID of the guild to register the command in. |
+| `block` | A block that will be called when the command is invoked. |
+
+`block` will be called with two arguments:
+
+| Parameter | Description |
+| --- | --- |
+| `interaction` | The interaction object. |
+| `user` | The user object. |
+
+
+### Register Message Context Menu Command
+
+```ruby
+client.message_command("Bookmark") do |interaction, message|
+  # ...
+end
+```
+
+{Discorb::Command::Handler#message_command} takes 3 arguments:
+
+| Parameter | Description |
+| --- | --- |
+| `command_name` | The name of the command. |
+| `guild_ids` | The ID of the guild to register the command in. |
+| `block` | A block that will be called when the command is invoked. |
+
+`block` will be called with two arguments:
+
+| Parameter | Description |
+| --- | --- |
+| `interaction` | The interaction object. |
+| `message` | The message object. |

data/docs/discord_irb.md

@@ -0,0 +1,39 @@
+# @title discord-irb
+
+# discord-irb
+
+discord-irb is a command line tool for interacting with the Discord API.
+
+
+## Usage
+
+```
+$ bundle exec discord-irb
+```
+
+To start.
+
+### Load a token
+
+discord-irb will load a token from...
+1. the `DISCORD_BOT_TOKEN` environment variable
+2. the `DISCORD_TOKEN` environment variable
+3. `token` file in the current directory(customizable with `-f` option)
+4. your input
+
+### Arguments
+
+#### `-i`, `--intents`
+
+Intents to use.
+Specify intents with integers.
+
+#### `-t`, `--token-file`
+
+Token file to load.
+
+### Variables
+
+#### `message`
+
+Last message received.

data/docs/events.md

@@ -28,11 +28,11 @@ Fires when a event is received.
 |`event_name`| Symbol | The name of the event. |
 |`data`      | Hash   | The data of the event. |
 
-#### `ready(task)`
+#### `ready()`
 
 Fires when the client is ready.
 
-#### `resumed(task)`
+#### `resumed()`
 
 Fires when the client is resumed connection.
 
@@ -239,7 +239,7 @@ Fires when a message is updated.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
-|`event`     | {Discorb::GatewayHandler::MessageUpdateEvent}| The message after the update. |
+|`event`     | {Discorb::Gateway::MessageUpdateEvent}| The message after the update. |
 
 #### `message_delete(message, channel, guild)`
 
@@ -272,7 +272,7 @@ Fires when a bulk of messages are deleted.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
-|`messages`  | Array<{Discorb::Message}, {Discorb::GatewayHandler::UnknownDeleteBulkMessage}> | The deleted messages. |
+|`messages`  | Array<{Discorb::Message}, {Discorb::Gateway::UnknownDeleteBulkMessage}> | The deleted messages. |
 
 #### `message_pin_update(event)`
 
@@ -280,7 +280,7 @@ Fires when a message is pinned or unpinned.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
-|`event`     | {Discorb::GatewayHandler::MessagePinUpdateEvent}| The event object. |
+|`event`     | {Discorb::Gateway::MessagePinUpdateEvent}| The event object. |
 
 #### `typing_start(event)`
 
@@ -288,7 +288,7 @@ Fires when a user starts typing.
 
 | Parameter | Type  | Description |
 | --------- | ----- | ----------- |
-|`event`    | {Discorb::GatewayHandler::TypingStartEvent}| The event object. |
+|`event`    | {Discorb::Gateway::TypingStartEvent}| The event object. |
 
 ### Reaction events
 
@@ -298,7 +298,7 @@ Fires when a reaction is added to a message.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
-|`event`     | {Discorb::GatewayHandler::ReactionEvent}| The event object. |
+|`event`     | {Discorb::Gateway::ReactionEvent}| The event object. |
 
 #### `reaction_remove(event)`
 
@@ -306,7 +306,7 @@ Fires when someone removes a reaction from a message.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
-|`event`     | {Discorb::GatewayHandler::ReactionEvent}| The event object. |
+|`event`     | {Discorb::Gateway::ReactionEvent}| The event object. |
 
 #### `reaction_remove_all(event)`
 
@@ -314,7 +314,7 @@ Fires when all reactions are removed from a message.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
-|`event`     | {Discorb::GatewayHandler::ReactionRemoveAllEvent}| The event object. |
+|`event`     | {Discorb::Gateway::ReactionRemoveAllEvent}| The event object. |
 
 #### `reaction_remove_emoji(event)`
 
@@ -322,7 +322,7 @@ Fires when a reaction is removed from a message.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
-|`event`     | {Discorb::GatewayHandler::ReactionRemoveEmojiEvent}| The event object. |
+|`event`     | {Discorb::Gateway::ReactionRemoveEmojiEvent}| The event object. |
 
 ### Role events