discorb 0.0.6 → 0.2.0

data/docs/extension.md

@@ -0,0 +1,53 @@
+# @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.
+
+## Access Client from extension
+
+You can access {Client} from extension with `@client`.
+
+```ruby
+module MyExtension
+  extend Discorb::Extension
+
+  event :ready do |message|
+    puts "Logged in as #{client.user}"
+  end
+end
+```

data/docs/voice_events.md

@@ -4,7 +4,7 @@
 
 ### Voice Channel Events
 
-#### `voice_channel_connect(task, state)`
+#### `voice_channel_connect(state)`
 
 Fires when someone joins a voice channel.
 
@@ -12,7 +12,7 @@ Fires when someone joins a voice channel.
 | --- | --- | --- |
 | state | {Discorb::VoiceState} | The voice state of the user that joined. |
 
-#### `voice_channel_disconnect(task, state)`
+#### `voice_channel_disconnect(state)`
 
 Fires when someone leaves a voice channel.
 
@@ -20,7 +20,7 @@ Fires when someone leaves a voice channel.
 | --- | --- | --- |
 | state | {Discorb::VoiceState} | The voice state of the user that left. |
 
-#### `voice_channel_move(task, before, after)`
+#### `voice_channel_move(before, after)`
 
 Fires when someone moves to a different voice channel.
 
@@ -29,7 +29,7 @@ Fires when someone moves to a different voice channel.
 | 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(task, before, after)`
+#### `voice_channel_update(before, after)`
 
 Fires when a voice channel is connected, disconnected, or updated.
 
@@ -40,7 +40,7 @@ Fires when a voice channel is connected, disconnected, or updated.
 
 ### Mute Events
 
-#### `voice_mute_disable(task, state)`
+#### `voice_mute_disable(state)`
 
 Fires when a user's voice mute is disabled.
 
@@ -48,7 +48,7 @@ Fires when a user's voice mute is disabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_mute_enable(task, state)`
+#### `voice_mute_enable(state)`
 
 Fires when a user's voice mute is enabled.
 
@@ -56,7 +56,7 @@ Fires when a user's voice mute is enabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_mute_update(task, before, after)`
+#### `voice_mute_update(before, after)`
 
 Fires when a user's voice mute is enabled or disabled.
 
@@ -65,7 +65,7 @@ Fires when a user's voice mute is enabled or disabled.
 | `before` | {Discorb::VoiceState} | The voice state before the update. |
 | `after` | {Discorb::VoiceState} | The voice state after the update. |
 
-#### `voice_server_mute_enable(task, state)`
+#### `voice_server_mute_enable(state)`
 
 Fires when a user's server voice mute is enabled.
 
@@ -73,7 +73,7 @@ Fires when a user's server voice mute is enabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_server_mute_disable(task, state)`
+#### `voice_server_mute_disable(state)`
 
 Fires when a user's server voice mute is disabled.
 
@@ -81,7 +81,7 @@ Fires when a user's server voice mute is disabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_server_mute_update(task, before, after)`
+#### `voice_server_mute_update(before, after)`
 
 Fires when a user's server voice mute is enabled or disabled.
 
@@ -90,7 +90,7 @@ Fires when a user's server voice mute is enabled or disabled.
 | `before` | {Discorb::VoiceState} | The voice state before the update. |
 | `after` | {Discorb::VoiceState} | The voice state after the update. |
 
-#### `voice_self_mute_enable(task, state)`
+#### `voice_self_mute_enable(state)`
 
 Fires when a user's self voice mute is enabled.
 
@@ -98,7 +98,7 @@ Fires when a user's self voice mute is enabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_self_mute_disable(task, state)`
+#### `voice_self_mute_disable(state)`
 
 Fires when a user's self voice mute is disabled.
 
@@ -106,7 +106,7 @@ Fires when a user's self voice mute is disabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_self_mute_update(task, before, after)`
+#### `voice_self_mute_update(before, after)`
 
 Fires when a user's self voice mute is enabled or disabled.
 
@@ -117,7 +117,7 @@ Fires when a user's self voice mute is enabled or disabled.
 
 ### Deaf Events
 
-#### `voice_deaf_enable(task, state)`
+#### `voice_deaf_enable(state)`
 
 Fires when a user's voice deaf is enabled.
 
@@ -125,7 +125,7 @@ Fires when a user's voice deaf is enabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_deaf_disable(task, state)`
+#### `voice_deaf_disable(state)`
 
 Fires when a user's voice deaf is disabled.
 
@@ -133,7 +133,7 @@ Fires when a user's voice deaf is disabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_deaf_update(task, before, after)`
+#### `voice_deaf_update(before, after)`
 
 Fires when a user's voice deaf is enabled or disabled.
 
@@ -142,7 +142,7 @@ Fires when a user's voice deaf is enabled or disabled.
 | `before` | {Discorb::VoiceState} | The voice state before the update. |
 | `after` | {Discorb::VoiceState} | The voice state after the update. |
 
-#### `voice_server_deaf_enable(task, state)`
+#### `voice_server_deaf_enable(state)`
 
 Fires when a user's server voice deaf is enabled.
 
@@ -150,7 +150,7 @@ Fires when a user's server voice deaf is enabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_server_deaf_disable(task, state)`
+#### `voice_server_deaf_disable(state)`
 
 Fires when a user's server voice deaf is disabled.
 
@@ -158,7 +158,7 @@ Fires when a user's server voice deaf is disabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_server_deaf_update(task, before, after)`
+#### `voice_server_deaf_update(before, after)`
 
 Fires when a user's server voice deaf is enabled or disabled.
 
@@ -167,7 +167,7 @@ Fires when a user's server voice deaf is enabled or disabled.
 | `before` | {Discorb::VoiceState} | The voice state before the update. |
 | `after` | {Discorb::VoiceState} | The voice state after the update. |
 
-#### `voice_self_deaf_enable(task, state)`
+#### `voice_self_deaf_enable(state)`
 
 Fires when a user's self voice deaf is enabled.
 
@@ -175,7 +175,7 @@ Fires when a user's self voice deaf is enabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_self_deaf_disable(task, state)`
+#### `voice_self_deaf_disable(state)`
 
 Fires when a user's self voice deaf is disabled.
 
@@ -183,7 +183,7 @@ Fires when a user's self voice deaf is disabled.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_self_deaf_update(task, before, after)`
+#### `voice_self_deaf_update(before, after)`
 
 | Parameter | Type | Description |
 | --- | --- | --- |
@@ -192,7 +192,7 @@ Fires when a user's self voice deaf is disabled.
 
 ### Stream Events
 
-#### `voice_stream_start(task, state)`
+#### `voice_stream_start(state)`
 
 Fires when a stream is started.
 
@@ -200,7 +200,7 @@ Fires when a stream is started.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_stream_end(task, state)`
+#### `voice_stream_end(state)`
 
 Fires when a stream is ended.
 
@@ -208,7 +208,7 @@ Fires when a stream is ended.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_stream_update(task, before, after)`
+#### `voice_stream_update(before, after)`
 
 Fires when a stream is started or ended.
 
@@ -219,7 +219,7 @@ Fires when a stream is started or ended.
 
 ### Video Events
 
-#### `voice_video_start(task, state)`
+#### `voice_video_start(state)`
 
 Fires when a video is started.
 
@@ -227,7 +227,7 @@ Fires when a video is started.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_video_end(task, state)`
+#### `voice_video_end(state)`
 
 Fires when a video is ended.
 
@@ -235,7 +235,7 @@ Fires when a video is ended.
 | --- | --- | --- |
 | `state` | {Discorb::VoiceState} | The voice state. |
 
-#### `voice_video_update(task, before, after)`
+#### `voice_video_update(before, after)`
 
 Fires when a video is started or ended.
 
@@ -246,7 +246,7 @@ Fires when a video is started or ended.
 
 ### Stage Instances Events
 
-#### `stage_instance_create(task, instance)`
+#### `stage_instance_create(instance)`
 
 Fires when a new stage instance is created.
 
@@ -254,7 +254,7 @@ Fires when a new stage instance is created.
 | --- | --- | --- |
 | `instance` | {Discorb::StageInstance} | The created instance. |
 
-#### `stage_instance_delete(task, instance)`
+#### `stage_instance_delete(instance)`
 
 Fires when a stage instance is deleted.
 
@@ -262,7 +262,7 @@ Fires when a stage instance is deleted.
 | --- | --- | --- |
 | `instance` | {Discorb::StageInstance} | The deleted instance. |
 
-#### `stage_instance_update(task, before, after)`
+#### `stage_instance_update(before, after)`
 
 Fires when a stage instance is updated.
 
@@ -273,7 +273,7 @@ Fires when a stage instance is updated.
 
 ### Misc Events
 
-#### `voice_state_update(task, before, after)`
+#### `voice_state_update(before, after)`
 
 Fired when a user changes voice state.
 

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"])

data/examples/commands/hello.rb

@@ -0,0 +1,9 @@
+require "discorb"
+
+client = Discorb::Client.new
+
+client.slash("hello", "Greet for you") do |interaction|
+  interaction.post("Hello!", ephemeral: true)
+end
+
+client.run(ENV["DISCORD_BOT_TOKEN"])

data/examples/commands/inspect.rb

@@ -0,0 +1,24 @@
+require "discorb"
+
+client = Discorb::Client.new
+
+client.once :ready do
+  puts "Logged in as #{client.user}"
+end
+
+client.user_command("Info", guild_ids: [857373681096327180]) do |interaction|
+  interaction.post(embed: Discorb::Embed.new(
+                     "Information of #{interaction.target.to_s_user}",
+                     fields: [
+                       Discorb::Embed::Field.new("User", interaction.target.to_s_user),
+                       Discorb::Embed::Field.new("ID", interaction.target.id),
+                       Discorb::Embed::Field.new("Bot", interaction.target.bot? ? "Yes" : "No"),
+                       Discorb::Embed::Field.new("Joined at", interaction.target.joined_at.to_df("F")),
+                       Discorb::Embed::Field.new("Created at", interaction.target.created_at.to_df("F")),
+                     ],
+                     thumbnail: interaction.target.avatar&.url,
+
+                   ), hide: true)
+end
+
+client.run(ENV["DISCORD_BOT_TOKEN"])

data/examples/components/authorization_button.rb

@@ -12,7 +12,7 @@ client.once :ready do
   puts "Logged in as #{client.user}"
 end
 
-client.on :message do |_task, message|
+client.on :message do |message|
   next if message.author.bot?
   next unless message.content.start_with?("!auth ")
 
@@ -32,11 +32,11 @@ client.on :message do |_task, message|
   )
 end
 
-client.on :button_click do |_task, response|
+client.on :button_click do |response|
   if response.custom_id.start_with?("auth:")
     id = response.custom_id.delete_prefix("auth:")
     response.fired_by.add_role(id).wait
-    response.post("You got your role!\nHere's your role: <@&#{id}>", hide: true)
+    response.post("You got your role!\nHere's your role: <@&#{id}>", ephemeral: true)
   end
 end
 

data/examples/components/select_menu.rb

@@ -36,7 +36,7 @@ client.once :ready do
   puts "Logged in as #{client.user}"
 end
 
-client.on :message do |_task, message|
+client.on :message do |message|
   next if message.author.bot?
   next unless message.content == "!ruby"
 
@@ -46,7 +46,7 @@ client.on :message do |_task, message|
   )
 end
 
-client.on :select_menu_select do |_task, response|
+client.on :select_menu_select do |response|
   next unless response.custom_id == "sections"
 
   id = response.value.delete_prefix("sections:")
@@ -54,7 +54,7 @@ client.on :select_menu_select do |_task, response|
   response.post(
     "**#{selected_section[0]}**\n" \
     "#{selected_section[1].strip}\n\n" \
-    "#{WIKIPEDIA_CREDIT}", hide: true,
+    "#{WIKIPEDIA_CREDIT}", ephemeral: true,
   )
 end