discorb 0.0.1

data/docs/voice_events.md

@@ -0,0 +1,283 @@
+# @title Voice Events
+
+# Voice Events
+
+### Voice Channel Events
+
+#### `voice_channel_connect(task, state)`
+
+Fires when someone joins a voice channel.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| state | {Discorb::VoiceState} | The voice state of the user that joined. |
+
+#### `voice_channel_disconnect(task, state)`
+
+Fires when someone leaves a voice channel.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| state | {Discorb::VoiceState} | The voice state of the user that left. |
+
+#### `voice_channel_move(task, 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. |
+
+#### `voice_channel_update(task, 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. |
+
+### Mute Events
+
+#### `voice_mute_disable(task, state)`
+
+Fires when a user's voice mute is disabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_mute_enable(task, state)`
+
+Fires when a user's voice mute is enabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_mute_update(task, 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. |
+
+#### `voice_server_mute_enable(task, state)`
+
+Fires when a user's server voice mute is enabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_server_mute_disable(task, state)`
+
+Fires when a user's server voice mute is disabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_server_mute_update(task, 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. |
+
+#### `voice_self_mute_enable(task, state)`
+
+Fires when a user's self voice mute is enabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_self_mute_disable(task, state)`
+
+Fires when a user's self voice mute is disabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_self_mute_update(task, 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. |
+
+### Deaf Events
+
+#### `voice_deaf_enable(task, state)`
+
+Fires when a user's voice deaf is enabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_deaf_disable(task, state)`
+
+Fires when a user's voice deaf is disabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_deaf_update(task, 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. |
+
+#### `voice_server_deaf_enable(task, state)`
+
+Fires when a user's server voice deaf is enabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_server_deaf_disable(task, state)`
+
+Fires when a user's server voice deaf is disabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_server_deaf_update(task, 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. |
+
+#### `voice_self_deaf_enable(task, state)`
+
+Fires when a user's self voice deaf is enabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_self_deaf_disable(task, state)`
+
+Fires when a user's self voice deaf is disabled.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_self_deaf_update(task, before, after)`
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `before` | {Discorb::VoiceState} | The voice state before the update. |
+| `after` | {Discorb::VoiceState} | The voice state after the update. |
+
+### Stream Events
+
+#### `voice_stream_start(task, state)`
+
+Fires when a stream is started.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_stream_end(task, state)`
+
+Fires when a stream is ended.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_stream_update(task, 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. |
+
+### Video Events
+
+#### `voice_video_start(task, state)`
+
+Fires when a video is started.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_video_end(task, state)`
+
+Fires when a video is ended.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | {Discorb::VoiceState} | The voice state. |
+
+#### `voice_video_update(task, 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. |
+
+### Stage Instances Events
+
+#### `stage_instance_create(task, instance)`
+
+Fires when a new stage instance is created.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `instance` | {Discorb::StageInstance} | The created instance. |
+
+#### `stage_instance_delete(task, instance)`
+
+Fires when a stage instance is deleted.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `instance` | {Discorb::StageInstance} | The deleted instance. |
+
+#### `stage_instance_update(task, 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. |
+
+### Misc Events
+
+#### `voice_state_update(task, before, after)`
+
+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. |

data/examples/components/authorization_button.rb

@@ -0,0 +1,43 @@
+require "discorb"
+
+client = Discorb::Client.new
+
+def convert_role(guild, string)
+  guild.roles.find do |role|
+    role.id == string || role.name == string || role.mention == string
+  end
+end
+
+client.once :ready do
+  puts "Logged in as #{client.user}"
+end
+
+client.on :message do |_task, message|
+  next if message.author.bot?
+  next unless message.content.start_with?("!auth ")
+
+  role_name = message.content.delete_prefix("!auth ")
+  role = convert_role(message.guild, role_name)
+  if role.nil?
+    message.reply("Unknown role: #{role_name}").wait
+    next
+  end
+  message.channel.post(
+    "Click this button if you are human:",
+    components: [
+      Discorb::Button.new(
+        "Get role", custom_id: "auth:#{role.id}",
+      ),
+    ],
+  )
+end
+
+client.on :button_click do |_task, 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)
+  end
+end
+
+client.run(ENV["DISCORD_BOT_TOKEN"])

data/examples/components/select_menu.rb

@@ -0,0 +1,61 @@
+require "discorb"
+
+client = Discorb::Client.new
+
+SECTIONS = [
+  ["About", <<~WIKI],
+    Ruby is an interpreted, high-level, general-purpose programming language.
+    It was designed and developed in the mid-1990s by Yukihiro "Matz" Matsumoto in Japan.\n\n
+    Ruby is dynamically typed and uses garbage collection and just-in-time compilation.
+    It supports multiple programming paradigms, including procedural, object-oriented, and functional programming.
+    According to the creator, Ruby was influenced by Perl, Smalltalk, Eiffel, Ada, BASIC, and Lisp.
+  WIKI
+  ["Early concept", <<~WIKI],
+    Matsumoto has said that Ruby was conceived in 1993.
+    In a 1999 post to the ruby-talk mailing list, he describes some of his early ideas about the language:
+    > I was talking with my colleague about the possibility of an object-oriented scripting language.
+    > I knew Perl (Perl4, not Perl5), but I didn't like it really, because it had the smell of a toy language (it still has).
+    > The object-oriented language seemed very promising. I knew Python then.
+    > But I didn't like it, because I didn't think it was a true object-oriented language - OO features appeared to be add-on to the language.
+    > As a language maniac and OO fan for 15 years, I really wanted a genuine object-oriented, easy-to-use scripting language. I looked for but couldn't find one.
+    > 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],
+    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.
+
+    Already present at this stage of development were many of the features familiar in later releases of Ruby, including object-oriented design, classes with inheritance, mixins, iterators, closures, exception handling and garbage collection.
+  WIKI
+].freeze
+
+WIKIPEDIA_CREDIT = "(From: [Wikipedia](https://en.wikipedia.org/wiki/Ruby_(programming_language)))"
+
+client.once :ready do
+  puts "Logged in as #{client.user}"
+end
+
+client.on :message do |_task, message|
+  next if message.author.bot?
+  next unless message.content == "!ruby"
+
+  options = SECTIONS.map.with_index { |section, i| Discorb::SelectMenu::Option.new("Page #{i + 1}", "sections:#{i}", description: section[0]) }
+  message.channel.post(
+    "Select a section", components: [Discorb::SelectMenu.new("sections", options)],
+  )
+end
+
+client.on :select_menu_select do |_task, response|
+  next unless response.custom_id == "sections"
+
+  id = response.value.delete_prefix("sections:")
+  selected_section = SECTIONS[id.to_i]
+  response.post(
+    "**#{selected_section[0]}**\n" \
+    "#{selected_section[1].strip}\n\n" \
+    "#{WIKIPEDIA_CREDIT}", hide: true,
+  )
+end
+
+client.run(ENV["DISCORD_BOT_TOKEN"])

data/examples/extension/main.rb

@@ -0,0 +1,12 @@
+require "discorb"
+require_relative "message_expander"
+
+client = Discorb::Client.new
+
+client.once :ready do
+  puts "Logged in as #{client.user}"
+end
+
+client.extend(MessageExpander)
+
+client.run(ENV["DISCORD_BOT_TOKEN"])

data/examples/extension/message_expander.rb

@@ -0,0 +1,41 @@
+require "discorb"
+
+module MessageExpander
+  extend Discorb::Extension
+
+  @message_regex = Regexp.new(
+    '(?!<)https://(?:ptb\.|canary\.)?discord(?:app)?\.com/channels/' \
+    "(?<guild>[0-9]{18})/(?<channel>[0-9]{18})/(?<message>[0-9]{18})(?!>)"
+  )
+
+  event :message do |_task, message|
+    next if message.author.bot?
+
+    message.content.to_enum(:scan, @message_regex).map { Regexp.last_match }.each do |match|
+      ch = @client.channels[match[:channel]]
+      next if ch.nil?
+
+      begin
+        url_message = ch.fetch_message(match[:message]).wait
+      rescue Discorb::NotFoundError
+        url_message.add_reaction(Discorb::UnicodeEmoji["x"])
+      else
+        embed = Discorb::Embed.new(
+          nil, url_message.content,
+          color: Discorb::Color[:blurple],
+          timestamp: url_message.created_at,
+          author: Discorb::Embed::Author.new(
+            url_message.author.name,
+            url: url_message.jump_url,
+            icon: url_message.author.display_avatar.url,
+          ),
+          footer: Discorb::Embed::Footer.new(
+            "#{url_message.guild.name} / #{ch.name}",
+            icon: url_message.guild.icon&.url,
+          ),
+        )
+        message.reply embed: embed
+      end
+    end
+  end
+end

data/examples/simple/eval.rb

@@ -0,0 +1,32 @@
+require "discorb"
+
+client = Discorb::Client.new
+
+client.once :ready do |_task|
+  puts "Logged in as #{client.user}"
+end
+
+client.on :message do |_task, message|
+  next if message.author.bot?
+  next unless message.content.start_with?("eval ")
+
+  unless message.author.bot_owner?.wait
+    message.reply("You don't have permission to use this command.")
+    next
+  end
+
+  code = message.content.delete_prefix("eval ").delete_prefix("```rb").delete_suffix("```")
+  message.add_reaction(Discorb::UnicodeEmoji["clock3"])
+  res = eval("Async { |task| #{code} }.wait", binding, __FILE__, __LINE__) # rubocop:disable Security/Eval
+  message.remove_reaction(Discorb::UnicodeEmoji["clock3"])
+  message.add_reaction(Discorb::UnicodeEmoji["white_check_mark"])
+  unless res.nil?
+    res = res.wait if res.is_a? Async::Task
+    message.channel.post("```rb\n#{res.inspect[...1990]}\n```")
+  end
+rescue Exception => error
+  message.reply embed: Discorb::Embed.new("Error!", "```rb\n#{error.full_message(highlight: false)[...1990]}\n```",
+                                          color: Discorb::Color[:red])
+end
+
+client.run(ENV["discord_bot_token"])