discorb 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b247a62629770b82d8326ac69507603a27bc8cf31bcf7c06a7aa9d546b7e80a
-  data.tar.gz: ec2416663ce7d90e2023c648a115e6a2691f4557394770274dcf4a25489aad36
+  metadata.gz: 6281613f37f7da894dcdcb0df3070fd7c9efa685cf3a0412b6822fd60124cab9
+  data.tar.gz: b584a8ef44f9f18758c18a8a065c003cac6f54beadb8c3c29081cac7c98fa416
 SHA512:
-  metadata.gz: 511985823e749cec350e08f98cd9b7f05172d00fb02e63756b4c8dadd65657c9a68d775a1309190c14ec72c12ed955a6bfbd7bc23d55307fc90165b5a9d81c63
-  data.tar.gz: ba547c5dc8a1558654ae860be8f426255bf633809acb82b853a14b72ffbbda9b58a6d0bc50c6e2b656233b08672ec78be07a4899436f5c90e162b3a06aa45c5f
+  metadata.gz: 906cc3412b9cb6189947bf3446f3b9129b4665ec4247896f450f4e7bcbab3243764a246956180d5d9dc905ad86132fcadbea0659318d7fd47a30a47a4101f4f0
+  data.tar.gz: 3615cb4feb58e8c5e7c24999a6e6af7596645f3dbebcaafe658c5c0b7c50a9a5aca467160560c316a2a7fa51ab79b6f214da0590d937f0ed2899d9ee79210346

data/Changelog.md

@@ -14,4 +14,35 @@
 
 ## 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: Suppot application commands
+- Add: Add `Client#ping`
+- Add: Allow `String` for `Embed#initialize`
+- Change: Change log format

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    discorb (0.0.8)
+    discorb (0.1.0)
       async
       async-http
       async-websocket

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/events.md

@@ -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
 

data/docs/extension.md

@@ -0,0 +1,39 @@
+# @title Extension
+
+# Extension
+
+Extension allows you to split your code into multiple files.
+
+## Make a new extension
+
+Make a new module, and extend {Discorb::Extension}.
+
+```ruby
+module MyExtension
+  extend Discorb::Extension
+  
+  # ...
+end
+```
+
+## Register Event
+
+Use {Extension#event} to register event, or {Extension#once_event} to register event only once.
+
+```ruby
+module MyExtension
+  extend Discorb::Extension
+
+  event :message do |message|
+    # ...
+  end
+
+  once_event :ready do |message|
+    # ...
+  end
+end
+```
+
+## Load extension
+
+Use {Client#extend} to load extension.

data/examples/commands/bookmarker.rb

@@ -0,0 +1,41 @@
+require "discorb"
+require "json"
+
+client = Discorb::Client.new
+
+client.once :ready 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("Message ID: #{message.id}")
+  embed
+end
+
+client.message_command("Bookmark", guild_ids: [857373681096327180]) do |interaction, message|
+  unless channel = bookmark_channel(interaction.guild)
+    interaction.post("Bookmark channel not found. Please create one called `bookmarks`.", ephemeral: true)
+    next
+  end
+  channel.post(
+    message.jump_url,
+    embed: build_embed_from_message(message),
+  ).wait
+  interaction.post("Bookmarked!", ephemeral: true)
+end
+
+client.change_presence(
+  Discorb::Activity.new(
+    "Open message context menu to bookmark"
+  )
+)
+
+client.run(ENV["DISCORD_BOT_TOKEN"])