discordrb 3.7.2 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2229818c42fe455f937dceb0463ddb7489cd79058d6d617f0483ad8c287309ac
-  data.tar.gz: a0e966d6f85306b413cd8d7aad14f7746517fe4f241621c7ee84c0ac676e66f1
+  metadata.gz: 15353f4dac7b2532ca9fe369b46689c312b0df92951ff32c372abc38b0cc5ebc
+  data.tar.gz: e6c1ade2c4f550d4fff676ad8b0fcc88463af023343bc2d0af45b3e8f87d5c4a
 SHA512:
-  metadata.gz: c535560deb7c130f75292caa6dd31cbfeefcf553ac2b584de7e6346a1e6d84a09252990a4a46e21162e4fc6600eb31402abaea8985ecdfc317b700b819aa72b8
-  data.tar.gz: 2ba9ec20ad47028f5137fe025f443e6dd6b64d36ed85a996de499372179897ce75cf8c446c3eb7d5a6181d645dc948285606ef133a55e5d33ea7ad667d963848
+  metadata.gz: 9a9628272b84421103bbc2505d1af71d3f2b0012231d6d37f22897b00b832122200092a4022a8d3218608aa30ee593f0345a8c9c18104f69349dc0fb4aa5ba1b
+  data.tar.gz: 41b15bd52e42175ec8ebe9a3f21c264c236549609df6032e0ec73a172e692f1827710ab025e6b277d40d2b1bb78a4be6cf38aaebc19cc880629c1abb1df86484

data/CHANGELOG.md

@@ -5,6 +5,34 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.8.0] - 2026-02-04
+
+[3.8.0]: https://github.com/shardlab/discordrb/releases/tag/v3.8.0
+[View diff for this release.](https://github.com/shardlab/discordrb/compare/v3.7.2..v3.8.0)
+
+
+### Summary
+
+## What's Changed
+* Fix wrong wording in `#voice_state_update` documentation by @gitnickolson in https://github.com/shardlab/discordrb/pull/411
+* feat: integration events by @Droid00000 in https://github.com/shardlab/discordrb/pull/418
+* feat: optimize Bot#emoji by @Droid00000 in https://github.com/shardlab/discordrb/pull/417
+* feat: replied user in allowed mentions by @Droid00000 in https://github.com/shardlab/discordrb/pull/415
+* feat: emoji serialization helper by @Droid00000 in https://github.com/shardlab/discordrb/pull/405
+* feat: delegate more interaction methods by @Droid00000 in https://github.com/shardlab/discordrb/pull/414
+* fix: Secret -> Secrets by @Droid00000 in https://github.com/shardlab/discordrb/pull/392
+* feat: followed channels by @Droid00000 in https://github.com/shardlab/discordrb/pull/328
+* fix: errors on :THREAD_LIST_SYNC by @Droid00000 in https://github.com/shardlab/discordrb/pull/320
+* style: message initializer by @Droid00000 in https://github.com/shardlab/discordrb/pull/382
+* bump: copyright version by @Droid00000 in https://github.com/shardlab/discordrb/pull/424
+* feat: new components by @Droid00000 in https://github.com/shardlab/discordrb/pull/297
+
+## New Contributors
+* @gitnickolson made their first contribution in https://github.com/shardlab/discordrb/pull/411
+
+**Full Changelog**: https://github.com/shardlab/discordrb/compare/v3.7.2...v3.8.0
+
+
 ## [3.7.2] 2025-12-24
 
 [View diff for this release](https://github.com/shardlab/discordrb/compare/v3.7.1...v3.7.2)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2023 meew0
+Copyright (c) 2015-2026 meew0
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,7 +3,7 @@
 [![Gem](https://img.shields.io/gem/v/discordrb.svg)](https://rubygems.org/gems/discordrb)
 [![Gem](https://img.shields.io/gem/dt/discordrb.svg)](https://rubygems.org/gems/discordrb)
 [![CircleCI](https://circleci.com/gh/shardlab/discordrb.svg?style=svg)](https://circleci.com/gh/shardlab/discordrb)
-[![Inline docs](https://inch-ci.org/github/shardlab/discordrb.svg?branch=main)](https://drb.shardlab.dev/v3.6.0/)
+[![Inline docs](https://inch-ci.org/github/shardlab/discordrb.svg?branch=main)](https://drb.shardlab.dev/v3.8.0/)
 [![Join Discord](https://img.shields.io/badge/discord-join-7289DA.svg)](https://discord.gg/cyK3Hjm)
 
 An implementation of the [Discord](https://discord.com/) API using Ruby.
@@ -19,7 +19,7 @@ An implementation of the [Discord](https://discord.com/) API using Ruby.
 - [Development](https://github.com/shardlab/discordrb#development), [Contributing](https://github.com/shardlab/discordrb#contributing)
 - [License](https://github.com/shardlab/discordrb#license)
 
-See also: [Documentation](https://drb.shardlab.dev/v3.6.0/), [Tutorials](https://github.com/shardlab/discordrb/wiki)
+See also: [Documentation](https://drb.shardlab.dev/v3.8.0/), [Tutorials](https://github.com/shardlab/discordrb/wiki)
 
 ## Introduction
 
@@ -131,7 +131,7 @@ If you've made an open source project on GitHub that uses discordrb, consider ad
 
 Also included is a webhooks client, which can be used as a separate gem `discordrb-webhooks`. This special client can be used to form requests to Discord webhook URLs in a high-level manner.
 
-- [`discordrb-webhooks` documentation](https://drb.shardlab.dev/v3.6.0/Discordrb/Webhooks.html)
+- [`discordrb-webhooks` documentation](https://drb.shardlab.dev/v3.8.0/Discordrb/Webhooks.html)
 - [More information about webhooks](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
 - [Embed visualizer tool](https://leovoel.github.io/embed-visualizer/) - Includes a discordrb code generator for forming embeds
 

data/discordrb.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.2'
 
-  spec.add_development_dependency 'bundler', '>= 1.10', '< 3'
+  spec.add_development_dependency 'bundler', '>= 1.10', '< 5'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'redcarpet', '~> 3.5' # YARD markdown formatting
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/discordrb/allowed_mentions.rb

@@ -14,14 +14,20 @@ module Discordrb
     # @return [Array<String, Integer>, nil]
     attr_accessor :roles
 
+    # @return [true, false, nil]
+    attr_accessor :replied_user
+    alias_method :replied_user?, :replied_user
+
     # @param parse [Array<"users", "roles", "everyone">] Mention types that can be inferred from the message.
     #   `users` and `roles` allow for all mentions of the respective type to ping. `everyone` allows usage of `@everyone` and `@here`
     # @param users [Array<User, String, Integer>] Users or user IDs that can be pinged. Cannot be used in conjunction with `"users"` in `parse`
     # @param roles [Array<Role, String, Integer>] Roles or role IDs that can be pinged. Cannot be used in conjunction with `"roles"` in `parse`
-    def initialize(parse: nil, users: nil, roles: nil)
+    # @param replied_user [true, false, nil] For replies, whether to mention the author of the message being replied to. Defaults to no mention
+    def initialize(parse: nil, users: nil, roles: nil, replied_user: nil)
       @parse = parse
       @users = users
       @roles = roles
+      @replied_user = replied_user
     end
 
     # @!visibility private
@@ -29,7 +35,8 @@ module Discordrb
       {
         parse: @parse,
         users: @users&.map { |user| user.is_a?(IDObject) ? user.id : user },
-        roles: @roles&.map { |role| role.is_a?(IDObject) ? role.id : role }
+        roles: @roles&.map { |role| role.is_a?(IDObject) ? role.id : role },
+        replied_user: @replied_user
       }.compact
     end
   end

data/lib/discordrb/api/channel.rb

@@ -464,6 +464,21 @@ module Discordrb::API::Channel
     )
   end
 
+  # Follow an annoucement channel.
+  # https://discord.com/developers/docs/resources/channel#follow-announcement-channel
+  def follow_channel(token, channel_id, webhook_channel_id, reason = nil)
+    Discordrb::API.request(
+      :channels_cid_followers,
+      channel_id,
+      :post,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/followers",
+      { webhook_channel_id: webhook_channel_id }.to_json,
+      Authorization: token,
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
   # Start a thread based off a channel message.
   # https://discord.com/developers/docs/resources/channel#start-thread-with-message
   def start_thread_with_message(token, channel_id, message_id, name, auto_archive_duration)

data/lib/discordrb/api/interaction.rb

@@ -51,8 +51,8 @@ module Discordrb::API::Interaction
 
   # Edit the original response to an interaction.
   # https://discord.com/developers/docs/interactions/slash-commands#edit-original-interaction-response
-  def edit_original_interaction_response(interaction_token, application_id, content = nil, embeds = nil, allowed_mentions = nil, components = nil, attachments = nil)
-    Discordrb::API::Webhook.token_edit_message(interaction_token, application_id, '@original', content, embeds, allowed_mentions, components, attachments)
+  def edit_original_interaction_response(interaction_token, application_id, content = nil, embeds = nil, allowed_mentions = nil, components = nil, attachments = nil, flags = nil)
+    Discordrb::API::Webhook.token_edit_message(interaction_token, application_id, '@original', content, embeds, allowed_mentions, components, attachments, flags)
   end
 
   # Delete the original response to an interaction.

data/lib/discordrb/api/webhook.rb

@@ -120,8 +120,8 @@ module Discordrb::API::Webhook
 
   # Edit a webhook message via webhook token
   # https://discord.com/developers/docs/resources/webhook#edit-webhook-message
-  def token_edit_message(webhook_token, webhook_id, message_id, content = nil, embeds = nil, allowed_mentions = nil, components = nil, attachments = nil)
-    body = { content: content, embeds: embeds, allowed_mentions: allowed_mentions, components: components }
+  def token_edit_message(webhook_token, webhook_id, message_id, content = nil, embeds = nil, allowed_mentions = nil, components = nil, attachments = nil, flags = nil)
+    body = { content: content, embeds: embeds, allowed_mentions: allowed_mentions, components: components, flags: flags }
 
     body = if attachments
              files = [*0...attachments.size].zip(attachments).to_h

data/lib/discordrb/bot.rb

@@ -20,6 +20,7 @@ require 'discordrb/events/webhooks'
 require 'discordrb/events/invites'
 require 'discordrb/events/interactions'
 require 'discordrb/events/threads'
+require 'discordrb/events/integrations'
 
 require 'discordrb/api'
 require 'discordrb/api/channel'
@@ -199,12 +200,18 @@ module Discordrb
     #   The list of emoji the bot can use.
     #   @return [Array<Emoji>] the emoji available.
     def emoji(id = nil)
-      emoji_hash = servers.values.map(&:emoji).reduce(&:merge)
-      if id
-        id = id.resolve_id
-        emoji_hash[id]
+      if (id = id&.resolve_id)
+        @servers.each_value do |server|
+          emoji = server.emojis[id]
+          return emoji if emoji
+        end
       else
-        emoji_hash.values
+        hash = {}
+        @servers.each_value do |server|
+          hash.merge!(server.emojis)
+        end
+
+        hash
       end
     end
 
@@ -939,6 +946,11 @@ module Discordrb
       API::Application.delete_application_emoji(@token, profile.id, emoji_id.resolve_id)
     end
 
+    # @!visibility private
+    def inspect
+      "<Bot client_id=#{@client_id.inspect} redact_token=#{@redact_token.inspect}>"
+    end
+
     private
 
     # Throws a useful exception if there's currently no gateway connection.
@@ -1579,6 +1591,15 @@ module Discordrb
 
         event = ServerRoleDeleteEvent.new(data, self)
         raise_event(event)
+      when :INTEGRATION_CREATE
+        event = IntegrationCreateEvent.new(data, self)
+        raise_event(event)
+      when :INTEGRATION_UPDATE
+        event = IntegrationUpdateEvent.new(data, self)
+        raise_event(event)
+      when :INTEGRATION_DELETE
+        event = IntegrationDeleteEvent.new(data, self)
+        raise_event(event)
       when :GUILD_CREATE
         create_guild(data)
 
@@ -1718,8 +1739,25 @@ module Discordrb
 
         # raise ThreadDeleteEvent
       when :THREAD_LIST_SYNC
-        data['members'].map { |member| ensure_thread_member(member) }
-        data['threads'].map { |channel| ensure_channel(channel, data['guild_id']) }
+        server_id = data['guild_id'].to_i
+        server = @servers[server_id]
+
+        # The `channel_ids` field has two meanings:
+        #
+        # 1. If the field is not present, the thread list is being synced for the whole server.
+        #
+        # 2. We are syncing the threads for a specific channel. This can happen when gaining access
+        #    to a channel.
+        if (ids = data['channel_ids']&.map(&:to_i))
+          @channels.delete_if { |_, channel| channel.thread? && ids.any?(channel.parent&.id) }
+          server&.clear_threads(ids)
+        else
+          @channels.delete_if { |_, channel| channel.server.id == server_id && channel.thread? }
+          server&.clear_threads
+        end
+
+        data['members'].each { |member| ensure_thread_member(member) }
+        data['threads'].each { |channel| ensure_channel(channel) }
 
         # raise ThreadListSyncEvent?
       when :THREAD_MEMBER_UPDATE

data/lib/discordrb/container.rb

@@ -14,6 +14,7 @@ require 'discordrb/events/await'
 require 'discordrb/events/bans'
 require 'discordrb/events/reactions'
 require 'discordrb/events/interactions'
+require 'discordrb/events/integrations'
 
 require 'discordrb/await'
 
@@ -290,7 +291,7 @@ module Discordrb
     # This **event** is raised when a user's voice state changes. This includes when a user joins, leaves, or
     # moves between voice channels, as well as their mute and deaf status for themselves and on the server.
     # @param attributes [Hash] The event's attributes.
-    # @option attributes [String, Integer, User] :from Matches the user that sent the message.
+    # @option attributes [String, Integer, User] :from Matches the user that raised the event.
     # @option attributes [String, Integer, Channel] :channel Matches the voice channel the user has joined.
     # @option attributes [String, Integer, Channel] :old_channel Matches the voice channel the user was in previously.
     # @option attributes [true, false] :mute Matches whether or not the user is muted server-wide.
@@ -696,6 +697,42 @@ module Discordrb
       register_event(ApplicationCommandPermissionsUpdateEvent, attributes, block)
     end
 
+    # This **event** is raised whenever an integration is added to a server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Integration] :id An integration to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Application] :application An application to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [IntegrationCreateEvent] The event that was raised.
+    # @return [IntegrationCreateEventHandler] The event handler that was registered.
+    def integration_create(attributes = {}, &block)
+      register_event(IntegrationCreateEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an integration is updated in a server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Integration] :id An integration to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Application] :application An application to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [IntegrationUpdateEvent] The event that was raised.
+    # @return [IntegrationUpdateEventHandler] The event handler that was registered.
+    def integration_update(attributes = {}, &block)
+      register_event(IntegrationUpdateEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an integration is removed from a server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Integration] :id An integration to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Application] :application An application to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [IntegrationDeleteEvent] The event that was raised.
+    # @return [IntegrationDeleteEventHandler] The event handler that was registered.
+    def integration_delete(attributes = {}, &block)
+      register_event(IntegrationDeleteEvent, attributes, block)
+    end
+
     # This **event** is raised for every dispatch received over the gateway, whether supported by discordrb or not.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String, Symbol, Regexp] :type Matches the event type of the dispatch.

data/lib/discordrb/data/activity.rb

@@ -83,7 +83,7 @@ module Discordrb
       @created_at = Time.at(data['created_at'].to_i)
 
       @timestamps = Timestamps.new(data['timestamps']) if data['timestamps']
-      @secrets = Secret.new(data['secrets']) if data['secrets']
+      @secrets = Secrets.new(data['secrets']) if data['secrets']
       @assets = Assets.new(data['assets'], @application_id) if data['assets']
       @party = Party.new(data['party']) if data['party']
       @emoji = Emoji.new(data['emoji'], bot, nil) if data['emoji']

data/lib/discordrb/data/audit_logs.rb

@@ -157,7 +157,7 @@ module Discordrb
       def channel
         return nil unless @channel_id
 
-        @channel ||= @bot.channel(@channel_id, @server, bot, self)
+        @channel ||= @bot.channel(@channel_id)
       end
 
       # @!visibility private

data/lib/discordrb/data/channel.rb

@@ -478,7 +478,7 @@ module Discordrb
     # @param allowed_mentions [Hash, Discordrb::AllowedMentions, false, nil] Mentions that are allowed to ping on this message. `false` disables all pings
     # @param message_reference [Message, String, Integer, nil] The message, or message ID, to reply to if any.
     # @param components [View, Array<Hash>] Interaction components to associate with this message.
-    # @param flags [Integer] Flags for this message. Currently only SUPPRESS_EMBEDS (1 << 2) and SUPPRESS_NOTIFICATIONS (1 << 12) can be set.
+    # @param flags [Integer] Flags for this message. Currently only SUPPRESS_EMBEDS (1 << 2), SUPPRESS_NOTIFICATIONS (1 << 12), and IS_COMPONENTS_V2 (1 << 15) can be set.
     # @return [Message] the message that was sent.
     def send_message(content, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil, flags = 0)
       @bot.send_message(@id, content, tts, embed, attachments, allowed_mentions, message_reference, components, flags)
@@ -495,7 +495,7 @@ module Discordrb
     # @param allowed_mentions [Hash, Discordrb::AllowedMentions, false, nil] Mentions that are allowed to ping on this message. `false` disables all pings
     # @param message_reference [Message, String, Integer, nil] The message, or message ID, to reply to if any.
     # @param components [View, Array<Hash>] Interaction components to associate with this message.
-    # @param flags [Integer] Flags for this message. Currently only SUPPRESS_EMBEDS (1 << 2) and SUPPRESS_NOTIFICATIONS (1 << 12) can be set.
+    # @param flags [Integer] Flags for this message. Currently only SUPPRESS_EMBEDS (1 << 2), SUPPRESS_NOTIFICATIONS (1 << 12), and IS_COMPONENTS_V2 (1 << 15) can be set.
     def send_temporary_message(content, timeout, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil, flags = 0)
       @bot.send_temporary_message(@id, content, timeout, tts, embed, attachments, allowed_mentions, message_reference, components, flags)
     end
@@ -513,7 +513,7 @@ module Discordrb
     # @param allowed_mentions [Hash, Discordrb::AllowedMentions, false, nil] Mentions that are allowed to ping on this message. `false` disables all pings
     # @param message_reference [Message, String, Integer, nil] The message, or message ID, to reply to if any.
     # @param components [View, Array<Hash>] Interaction components to associate with this message.
-    # @param flags [Integer] Flags for this message. Currently only SUPPRESS_EMBEDS (1 << 2) and SUPPRESS_NOTIFICATIONS (1 << 12) can be set.
+    # @param flags [Integer] Flags for this message. Currently only SUPPRESS_EMBEDS (1 << 2), SUPPRESS_NOTIFICATIONS (1 << 12), and IS_COMPONENTS_V2 (1 << 15) can be set.
     # @yield [embed] Yields the embed to allow for easy building inside a block.
     # @yieldparam embed [Discordrb::Webhooks::Embed] The embed from the parameters, or a new one.
     # @return [Message] The resulting message.
@@ -963,6 +963,16 @@ module Discordrb
       invites.map { |invite_data| Invite.new(invite_data, @bot) }
     end
 
+    # Follow the announcement (news) channel to send crossposted messages to a target channel.
+    # @param target [Channel, Integer, String] The target channel to send crossposted messages to.
+    # @param reason [String, nil] The audit log reason shown for the created webhook in the target channel.
+    # @return [Integer] the ID of the created webhook in the target channel.
+    def follow(target, reason: nil)
+      raise 'Cannot follow a non-announcement channel' unless news?
+
+      JSON.parse(API::Channel.follow_channel(@bot.token, @id, target.resolve_id, reason))['webhook_id'].to_i
+    end
+
     # Returns the last message or forum post created in this channel.
     # @return [Message, Channel, nil] the last message sent in this channel,
     #   the most recent forum post if this is a forum or media channel, or `nil`.