discorb 0.18.0 → 0.20.0

data/lib/discorb/modules.rb

@@ -1,290 +1,371 @@
-# frozen_string_literal: true
-
-module Discorb
-  #
-  # Module for sending and reading messages.
-  #
-  module Messageable
-    #
-    # Post a message to the channel.
-    # @async
-    #
-    # @param [String] content The message content.
-    # @param [Boolean] tts Whether the message is tts.
-    # @param [Discorb::Embed] embed The embed to send.
-    # @param [Array<Discorb::Embed>] embeds The embeds to send.
-    # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions.
-    # @param [Discorb::Message, Discorb::Message::Reference] reference The message to reply to.
-    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
-    # @param [Discorb::Attachment] attachment The attachment to send.
-    # @param [Array<Discorb::Attachment>] attachments The attachments to send.
-    #
-    # @return [Async::Task<Discorb::Message>] The message sent.
-    #
-    def post(
-      content = nil,
-      tts: false,
-      embed: nil,
-      embeds: nil,
-      allowed_mentions: nil,
-      reference: nil,
-      components: nil,
-      attachment: nil,
-      attachments: nil
-    )
-      Async do
-        payload = {}
-        payload[:content] = content if content
-        payload[:tts] = tts
-        tmp_embed = if embed
-            [embed]
-          elsif embeds
-            embeds
-          end
-        payload[:embeds] = tmp_embed.map(&:to_hash) if tmp_embed
-        payload[:allowed_mentions] =
-          allowed_mentions ? allowed_mentions.to_hash(@client.allowed_mentions) : @client.allowed_mentions.to_hash
-        payload[:message_reference] = reference.to_reference.to_hash if reference
-        payload[:components] = Component.to_payload(components) if components
-        attachments ||= attachment ? [attachment] : []
-
-        payload[:attachments] = attachments.map.with_index do |a, i|
-          {
-            id: i,
-            filename: a.filename,
-            description: a.description,
-          }
-        end
-
-        _resp, data = @client.http.multipart_request(
-          Route.new("/channels/#{channel_id.wait}/messages", "//channels/:channel_id/messages",
-                    :post), payload, attachments
-        ).wait
-        Message.new(@client, data.merge({ guild_id: @guild_id.to_s }))
-      end
-    end
-
-    alias send_message post
-
-    #
-    # Edit a message.
-    # @async
-    # @!macro edit
-    #
-    # @param [#to_s] message_id The message id.
-    # @param [String] content The message content.
-    # @param [Discorb::Embed] embed The embed to send.
-    # @param [Array<Discorb::Embed>] embeds The embeds to send.
-    # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions.
-    # @param [Array<Discorb::Attachment>] attachments The new attachments.
-    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
-    # @param [Boolean] supress Whether to supress embeds.
-    #
-    # @return [Async::Task<void>] The task.
-    #
-    def edit_message(
-      message_id,
-      content = Discorb::Unset,
-      embed: Discorb::Unset,
-      embeds: Discorb::Unset,
-      allowed_mentions: Discorb::Unset,
-      attachments: Discorb::Unset,
-      components: Discorb::Unset,
-      supress: Discorb::Unset
-    )
-      Async do
-        payload = {}
-        payload[:content] = content if content != Discorb::Unset
-        tmp_embed = if embed != Discorb::Unset
-            [embed]
-          elsif embeds != Discorb::Unset
-            embeds
-          end
-        payload[:embeds] = tmp_embed.map(&:to_hash) if tmp_embed
-        payload[:allowed_mentions] = if allowed_mentions == Discorb::Unset
-            @client.allowed_mentions.to_hash
-          else
-            allowed_mentions.to_hash(@client.allowed_mentions)
-          end
-        payload[:components] = Component.to_payload(components) if components != Discorb::Unset
-        payload[:flags] = (supress ? 1 << 2 : 0) if supress != Discorb::Unset
-        if attachments != Discorb::Unset
-          payload[:attachments] = attachments.map.with_index do |a, i|
-            {
-              id: i,
-              filename: a.filename,
-              description: a.description,
-            }
-          end
-        end
-        @client.http.multipart_request(
-          Route.new("/channels/#{channel_id.wait}/messages/#{message_id}",
-                    "//channels/:channel_id/messages/:message_id", :patch),
-          payload,
-          attachments == Discorb::Unset ? [] : attachments
-        ).wait
-      end
-    end
-
-    #
-    # Delete a message.
-    # @async
-    #
-    # @param [#to_s] message_id The message id.
-    # @param [String] reason The reason for deleting the message.
-    #
-    # @return [Async::Task<void>] The task.
-    #
-    def delete_message!(message_id, reason: nil)
-      Async do
-        @client.http.request(
-          Route.new(
-            "/channels/#{channel_id.wait}/messages/#{message_id}", "//channels/:channel_id/messages/:message_id",
-            :delete
-          ), {}, audit_log_reason: reason,
-        ).wait
-      end
-    end
-
-    alias destroy_message! delete_message!
-
-    #
-    # Fetch a message from ID.
-    # @async
-    #
-    # @param [Discorb::Snowflake] id The ID of the message.
-    #
-    # @return [Async::Task<Discorb::Message>] The message.
-    # @raise [Discorb::NotFoundError] If the message is not found.
-    #
-    def fetch_message(id)
-      Async do
-        _resp, data = @client.http.request(Route.new("/channels/#{channel_id.wait}/messages/#{id}",
-                                                     "//channels/:channel_id/messages/:message_id", :get)).wait
-        Message.new(@client, data.merge({ guild_id: @guild_id.to_s }))
-      end
-    end
-
-    #
-    # Fetch a message history.
-    # @async
-    #
-    # @param [Integer] limit The number of messages to fetch.
-    # @param [Discorb::Snowflake] before The ID of the message to fetch before.
-    # @param [Discorb::Snowflake] after The ID of the message to fetch after.
-    # @param [Discorb::Snowflake] around The ID of the message to fetch around.
-    #
-    # @return [Async::Task<Array<Discorb::Message>>] The messages.
-    #
-    def fetch_messages(limit = 50, before: nil, after: nil, around: nil)
-      Async do
-        params = {
-          limit: limit,
-          before: Discorb::Utils.try(after, :id),
-          after: Discorb::Utils.try(around, :id),
-          around: Discorb::Utils.try(before, :id),
-        }.filter { |_k, v| !v.nil? }.to_h
-        _resp, messages = @client.http.request(
-          Route.new(
-            "/channels/#{channel_id.wait}/messages?#{URI.encode_www_form(params)}", "//channels/:channel_id/messages",
-            :get
-          )
-        ).wait
-        messages.map { |m| Message.new(@client, m.merge({ guild_id: @guild_id.to_s })) }
-      end
-    end
-
-    #
-    # Fetch the pinned messages in the channel.
-    # @async
-    #
-    # @return [Async::Task<Array<Discorb::Message>>] The pinned messages in the channel.
-    #
-    def fetch_pins
-      Async do
-        _resp, data = @client.http.request(Route.new("/channels/#{channel_id.wait}/pins",
-                                                     "//channels/:channel_id/pins", :get)).wait
-        data.map { |pin| Message.new(@client, pin) }
-      end
-    end
-
-    #
-    # Pin a message in the channel.
-    # @async
-    #
-    # @param [Discorb::Message] message The message to pin.
-    # @param [String] reason The reason of pinning the message.
-    #
-    # @return [Async::Task<void>] The task.
-    #
-    def pin_message(message, reason: nil)
-      Async do
-        @client.http.request(
-          Route.new("/channels/#{channel_id.wait}/pins/#{message.id}", "//channels/:channel_id/pins/:message_id",
-                    :put), {}, audit_log_reason: reason,
-        ).wait
-      end
-    end
-
-    #
-    # Unpin a message in the channel.
-    # @async
-    #
-    # @param [Discorb::Message] message The message to unpin.
-    # @param [String] reason The reason of unpinning the message.
-    #
-    # @return [Async::Task<void>] The task.
-    #
-    def unpin_message(message, reason: nil)
-      Async do
-        @client.http.request(
-          Route.new("/channels/#{channel_id.wait}/pins/#{message.id}", "//channels/:channel_id/pins/:message_id",
-                    :delete), {}, audit_log_reason: reason,
-        ).wait
-      end
-    end
-
-    #
-    # Trigger the typing indicator in the channel.
-    # @async
-    #
-    # If block is given, trigger typing indicator during executing block.
-    # @example
-    #   channel.typing do
-    #     channel.post("Waiting for 60 seconds...")
-    #     sleep 60
-    #     channel.post("Done!")
-    #   end
-    #
-    def typing
-      if block_given?
-        begin
-          post_task = Async do
-            loop do
-              @client.http.request(Route.new("/channels/#{@id}/typing", "//channels/:channel_id/typing", :post), {})
-              sleep(5)
-            end
-          end
-          ret = yield
-        ensure
-          post_task.stop
-        end
-        ret
-      else
-        Async do |_task|
-          @client.http.request(Route.new("/channels/#{@id}/typing", "//channels/:channel_id/typing", :post), {})
-        end
-      end
-    end
-  end
-
-  #
-  # Module for connecting to a voice channel.
-  # This will be discord-voice gem.
-  #
-  module Connectable
-    def connect
-      raise NotImplementedError, "This method is implemented by discord-voice gem."
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # Module for sending and reading messages.
+  #
+  module Messageable
+    #
+    # Post a message to the channel.
+    # @async
+    #
+    # @param [String] content The message content.
+    # @param [Boolean] tts Whether the message is tts.
+    # @param [Discorb::Embed] embed The embed to send.
+    # @param [Array<Discorb::Embed>] embeds The embeds to send.
+    # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions.
+    # @param [Discorb::Message, Discorb::Message::Reference] reference The message to reply to.
+    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
+    # @param [Discorb::Attachment] attachment The attachment to send.
+    # @param [Array<Discorb::Attachment>] attachments The attachments to send.
+    #
+    # @return [Async::Task<Discorb::Message>] The message sent.
+    #
+    def post(
+      content = nil,
+      tts: false,
+      embed: nil,
+      embeds: nil,
+      allowed_mentions: nil,
+      reference: nil,
+      components: nil,
+      attachment: nil,
+      attachments: nil
+    )
+      Async do
+        payload = {}
+        payload[:content] = content if content
+        payload[:tts] = tts
+        tmp_embed =
+          if embed
+            [embed]
+          elsif embeds
+            embeds
+          end
+        payload[:embeds] = tmp_embed.map(&:to_hash) if tmp_embed
+        payload[:allowed_mentions] = (
+          if allowed_mentions
+            allowed_mentions.to_hash(@client.allowed_mentions)
+          else
+            @client.allowed_mentions.to_hash
+          end
+        )
+        payload[
+          :message_reference
+        ] = reference.to_reference.to_hash if reference
+        payload[:components] = Component.to_payload(components) if components
+        attachments ||= attachment ? [attachment] : []
+
+        payload[:attachments] = attachments.map.with_index do |a, i|
+          { id: i, filename: a.filename, description: a.description }
+        end
+
+        _resp, data =
+          @client
+            .http
+            .multipart_request(
+              Route.new(
+                "/channels/#{channel_id.wait}/messages",
+                "//channels/:channel_id/messages",
+                :post
+              ),
+              payload,
+              attachments
+            )
+            .wait
+        Message.new(@client, data.merge({ guild_id: @guild_id.to_s }))
+      end
+    end
+
+    alias send_message post
+
+    #
+    # Edit a message.
+    # @async
+    # @!macro edit
+    #
+    # @param [#to_s] message_id The message id.
+    # @param [String] content The message content.
+    # @param [Discorb::Embed] embed The embed to send.
+    # @param [Array<Discorb::Embed>] embeds The embeds to send.
+    # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions.
+    # @param [Array<Discorb::Attachment>] attachments The new attachments.
+    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
+    # @param [Boolean] supress Whether to supress embeds.
+    #
+    # @return [Async::Task<void>] The task.
+    #
+    def edit_message(
+      message_id,
+      content = Discorb::Unset,
+      embed: Discorb::Unset,
+      embeds: Discorb::Unset,
+      allowed_mentions: Discorb::Unset,
+      attachments: Discorb::Unset,
+      components: Discorb::Unset,
+      supress: Discorb::Unset
+    )
+      Async do
+        payload = {}
+        payload[:content] = content if content != Discorb::Unset
+        tmp_embed =
+          if embed != Discorb::Unset
+            [embed]
+          elsif embeds != Discorb::Unset
+            embeds
+          end
+        payload[:embeds] = tmp_embed.map(&:to_hash) if tmp_embed
+        payload[:allowed_mentions] = if allowed_mentions == Discorb::Unset
+          @client.allowed_mentions.to_hash
+        else
+          allowed_mentions.to_hash(@client.allowed_mentions)
+        end
+        payload[:components] = Component.to_payload(components) if components !=
+          Discorb::Unset
+        payload[:flags] = (supress ? 1 << 2 : 0) if supress != Discorb::Unset
+        if attachments != Discorb::Unset
+          payload[:attachments] = attachments.map.with_index do |a, i|
+            { id: i, filename: a.filename, description: a.description }
+          end
+        end
+        @client
+          .http
+          .multipart_request(
+            Route.new(
+              "/channels/#{channel_id.wait}/messages/#{message_id}",
+              "//channels/:channel_id/messages/:message_id",
+              :patch
+            ),
+            payload,
+            attachments == Discorb::Unset ? [] : attachments
+          )
+          .wait
+      end
+    end
+
+    #
+    # Delete a message.
+    # @async
+    #
+    # @param [#to_s] message_id The message id.
+    # @param [String] reason The reason for deleting the message.
+    #
+    # @return [Async::Task<void>] The task.
+    #
+    def delete_message(message_id, reason: nil)
+      Async do
+        @client
+          .http
+          .request(
+            Route.new(
+              "/channels/#{channel_id.wait}/messages/#{message_id}",
+              "//channels/:channel_id/messages/:message_id",
+              :delete
+            ),
+            {},
+            audit_log_reason: reason
+          )
+          .wait
+      end
+    end
+
+    alias destroy_message delete_message
+
+    #
+    # Fetch a message from ID.
+    # @async
+    #
+    # @param [Discorb::Snowflake] id The ID of the message.
+    #
+    # @return [Async::Task<Discorb::Message>] The message.
+    # @raise [Discorb::NotFoundError] If the message is not found.
+    #
+    def fetch_message(id)
+      Async do
+        _resp, data =
+          @client
+            .http
+            .request(
+              Route.new(
+                "/channels/#{channel_id.wait}/messages/#{id}",
+                "//channels/:channel_id/messages/:message_id",
+                :get
+              )
+            )
+            .wait
+        Message.new(@client, data.merge({ guild_id: @guild_id.to_s }))
+      end
+    end
+
+    #
+    # Fetch a message history.
+    # @async
+    #
+    # @param [Integer] limit The number of messages to fetch.
+    # @param [Discorb::Snowflake] before The ID of the message to fetch before.
+    # @param [Discorb::Snowflake] after The ID of the message to fetch after.
+    # @param [Discorb::Snowflake] around The ID of the message to fetch around.
+    #
+    # @return [Async::Task<Array<Discorb::Message>>] The messages.
+    #
+    def fetch_messages(limit = 50, before: nil, after: nil, around: nil)
+      Async do
+        params =
+          {
+            limit: limit,
+            before: Discorb::Utils.try(after, :id),
+            after: Discorb::Utils.try(around, :id),
+            around: Discorb::Utils.try(before, :id)
+          }.filter { |_k, v| !v.nil? }.to_h
+        _resp, messages =
+          @client
+            .http
+            .request(
+              Route.new(
+                "/channels/#{channel_id.wait}/messages?#{URI.encode_www_form(params)}",
+                "//channels/:channel_id/messages",
+                :get
+              )
+            )
+            .wait
+        messages.map do |m|
+          Message.new(@client, m.merge({ guild_id: @guild_id.to_s }))
+        end
+      end
+    end
+
+    #
+    # Fetch the pinned messages in the channel.
+    # @async
+    #
+    # @return [Async::Task<Array<Discorb::Message>>] The pinned messages in the channel.
+    #
+    def fetch_pins
+      Async do
+        _resp, data =
+          @client
+            .http
+            .request(
+              Route.new(
+                "/channels/#{channel_id.wait}/pins",
+                "//channels/:channel_id/pins",
+                :get
+              )
+            )
+            .wait
+        data.map { |pin| Message.new(@client, pin) }
+      end
+    end
+
+    #
+    # Pin a message in the channel.
+    # @async
+    #
+    # @param [Discorb::Message] message The message to pin.
+    # @param [String] reason The reason of pinning the message.
+    #
+    # @return [Async::Task<void>] The task.
+    #
+    def pin_message(message, reason: nil)
+      Async do
+        @client
+          .http
+          .request(
+            Route.new(
+              "/channels/#{channel_id.wait}/pins/#{message.id}",
+              "//channels/:channel_id/pins/:message_id",
+              :put
+            ),
+            {},
+            audit_log_reason: reason
+          )
+          .wait
+      end
+    end
+
+    #
+    # Unpin a message in the channel.
+    # @async
+    #
+    # @param [Discorb::Message] message The message to unpin.
+    # @param [String] reason The reason of unpinning the message.
+    #
+    # @return [Async::Task<void>] The task.
+    #
+    def unpin_message(message, reason: nil)
+      Async do
+        @client
+          .http
+          .request(
+            Route.new(
+              "/channels/#{channel_id.wait}/pins/#{message.id}",
+              "//channels/:channel_id/pins/:message_id",
+              :delete
+            ),
+            {},
+            audit_log_reason: reason
+          )
+          .wait
+      end
+    end
+
+    #
+    # Trigger the typing indicator in the channel.
+    # @async
+    #
+    # If block is given, trigger typing indicator during executing block.
+    # @example
+    #   channel.typing do
+    #     channel.post("Waiting for 60 seconds...")
+    #     sleep 60
+    #     channel.post("Done!")
+    #   end
+    #
+    def typing
+      if block_given?
+        begin
+          post_task =
+            Async do
+              loop do
+                @client.http.request(
+                  Route.new(
+                    "/channels/#{@id}/typing",
+                    "//channels/:channel_id/typing",
+                    :post
+                  ),
+                  {}
+                )
+                sleep(5)
+              end
+            end
+          ret = yield
+        ensure
+          post_task.stop
+        end
+        ret
+      else
+        Async do |_task|
+          @client.http.request(
+            Route.new(
+              "/channels/#{@id}/typing",
+              "//channels/:channel_id/typing",
+              :post
+            ),
+            {}
+          )
+        end
+      end
+    end
+  end
+
+  #
+  # Module for connecting to a voice channel.
+  # This will be discord-voice gem.
+  #
+  module Connectable
+    def connect
+      raise NotImplementedError,
+            "This method is implemented by discord-voice gem."
+    end
+  end
+end