discorb 0.11.2 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0bee36d996a7e3108f2d02247a0d7516ade1811aeb5a354d1d41f509373381d
-  data.tar.gz: ce6c4f496b8ed5309cd3798b8cf25e271e77e75617631010d77f5ab3347a26aa
+  metadata.gz: 2f43c7785e34661458d9837fd1e75877b8d343f8c920021624d92d0fb87c5ee3
+  data.tar.gz: f5b1ed37f600c0b2945d737a154c9d07155d38dad1b8c3da58fc209fa2db99a9
 SHA512:
-  metadata.gz: 514f4b1ce307abe3424fa666a9fab56282e7b3817371411661675507658a42a92c23cda56e6358765fcad25bae69b850e754882576392ddc45da8be08ff3d252
-  data.tar.gz: e11b02e78f5029a0e544a0c7a55d79ee42ee22276160ba0f00dad0bd85c2d5d15109fa28c50dbfccbaf61066e293175e6b38357db396aeaba4b3033e38dbf2c4
+  metadata.gz: 42f7ffe2b1a851123d883f98223b7c8a755d40faff16a29c1eeecc58e3e023817c5a865bd2aaab52001a8311458a656e034de1f3349ed7778b033afd49840634
+  data.tar.gz: 3a6789362788a6c16e38ead2f6d463162f6e852da84df703ef90e32e27477fafb3ce611c931c9f1d9516275f21fb7229e4cec51b0110720b870a2d30f474120d

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+## What does this PR do?
+
+<!--
+Please describe the changes you are making (be as descriptive as possible).
+Ex: Fix `Foo#bar`
+    Add `Hoge#fuga`
+-->
+
+## Information
+
+- [ ] This PR fixes an issue.
+- [ ] This PR adds a new feature.
+- [ ] This PR refactors code.
+- [ ] This PR has breaking changes.
+- [ ] This PR **won't** change the behavior of the code. (e.g. documentation)
+<!-- If you need to add more information, please add it here. -->
+
+
+## Checklist
+
+- [ ] I have reviewed the code and it is clean and well documented.
+- [ ] I have ran bot and it is working as expected.
+- [ ] I have updated the document.
+
+## Related issues
+
+<!--
+If there are any related issues, please add them here.
+If there are no related issues, please write `None`.
+-->

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing to the project
+
+## Submitting a bug report
+
+Please follow these steps to report a bug:
+1. Check if the bug already exists in issue tracker. Don't forget to search closed issues too.
+2. Create issue from [the template](https://github.com/discorb-lib/discorb/issues/new?assignees=&labels=bug&template=bug_report.md).
+3. Fill in the issue with the information about the bug.
+4. Submit the issue.
+
+## Submitting a feature request
+
+Please follow these steps to request a feature:
+1. Check if the feature already exists in main branch.
+2. Check if the request already exists in issue tracker. Don't forget to search closed issues too.
+3. Create issue from [the template](https://github.com/discorb-lib/discorb/issues/new?assignees=&labels=Feature+Request%2CEnhancement&template=feature_request.md).
+4. Fill in the issue with the information about the feature.
+5. Submit the issue.
+
+## Submitting a pull request
+
+Please follow these steps to request a pull request:
+1. Check if the thing you want to request already exists in main branch.
+2. Check if the request already exists and is merged or closed.
+3. [Create a pull request](https://github.com/discorb-lib/discorb/compare).

data/Changelog.md

@@ -2,8 +2,30 @@
 
 # Changelog
 
+## v0.12
+
+### v0.12.1
+
+- Fix: Fix some texts
+- Add: Add `User#mention`
+
+### v0.12.0
+
+- Refactor: Refactor the code
+- Fix: Fix resuming gateway, finally
+- Fix: Fix `@client` in slash command handler in extension
+
 ## v0.11
 
+### v0.11.4
+
+- Fix: Fix unpinning messages
+
+### v0.11.3
+
+- Add: Add `Snowflake#id` as alias for `Snowflake#to_s`
+- Fix: Fix `Message#unpin`
+
 ### v0.11.2
 
 - Add: Add `setup` event

data/README.md

@@ -4,7 +4,8 @@
 <a href="https://rubygems.org/gems/discorb"><img src="https://img.shields.io/gem/dt/discorb?logo=rubygems&logoColor=fff&label=Downloads&style=flat-square&labelColor=2f3136" alt="Gem"></a>
 <a href="https://rubygems.org/gems/discorb"><img src="https://img.shields.io/gem/v/discorb?logo=rubygems&logoColor=fff&label=Version&style=flat-square&labelColor=2f3136" alt="Gem"></a>
 <a href="https://discord.gg/hCP6zq8Vpj"><img src="https://img.shields.io/discord/863581274916913193?logo=discord&logoColor=fff&color=5865f2&label=Discord&style=flat-square&labelColor=2f3136" alt="Discord"></a>
-<a href="https://github.com/discorb-lib/discorb"><img src="https://img.shields.io/github/stars/discorb-lib/discorb?color=24292e&label=Stars&logo=GitHub&logoColor=fff&style=flat-square&labelColor=2f3136" alt="GitHub"></a></div>
+<a href="https://github.com/discorb-lib/discorb"><img src="https://img.shields.io/github/stars/discorb-lib/discorb?color=24292e&label=Stars&logo=GitHub&logoColor=fff&style=flat-square&labelColor=2f3136" alt="GitHub"></a>
+<a href="https://codeclimate.com/github/discorb-lib/discorb"><img alt="Code Climate maintainability" src="https://img.shields.io/codeclimate/maintainability/discorb-lib/discorb?logo=Code%20Climate&logoColor=ffffff&style=flat-square&labelColor=2f3136&label=Maintainability"></a></div>
 
 ----
 

data/lib/discorb/app_command.rb

@@ -172,6 +172,14 @@ module Discorb
         @id_map = Discorb::Dictionary.new
       end
 
+      # @private
+      def replace_block(instance)
+        current_block = @block.dup
+        @block = Proc.new do |*args|
+          instance.instance_exec(*args, &current_block)
+        end
+      end
+
       # @private
       def to_hash
         {
@@ -314,6 +322,12 @@ module Discorb
           @name
         end
 
+        # @private
+        def block_replace(instance)
+          super
+          @commands.each { |c| c.replace_block(instance) }
+        end
+
         # @private
         def to_hash
           options_payload = @commands.map do |command|

data/lib/discorb/channel.rb

@@ -482,48 +482,6 @@ module Discorb
       end
     end
 
-    #
-    # Fetch the pinned messages in the channel.
-    # @macro async
-    # @macro http
-    #
-    # @return [Async::Task<Array<Discorb::Message>>] The pinned messages in the channel.
-    #
-    def fetch_pins
-      Async do
-        _resp, data = @client.http.get("/channels/#{@id}/pins").wait
-        data.map { |pin| Message.new(@client, pin) }
-      end
-    end
-
-    #
-    # Pin a message in the channel.
-    # @macro async
-    # @macro http
-    #
-    # @param [Discorb::Message] message The message to pin.
-    # @param [String] reason The reason of pinning the message.
-    #
-    def pin_message(message, reason: nil)
-      Async do
-        @client.http.put("/channels/#{@id}/pins/#{message.id}", {}, audit_log_reason: reason).wait
-      end
-    end
-
-    #
-    # Unpin a message in the channel.
-    # @macro async
-    # @macro http
-    #
-    # @param [Discorb::Message] message The message to unpin.
-    # @param [String] reason The reason of unpinning the message.
-    #
-    def unpin_message(message, reason: nil)
-      Async do
-        @client.http.delete("/channels/#{@id}/pins/#{message.id}", {}, audit_log_reason: reason).wait
-      end
-    end
-
     #
     # Start thread in the channel.
     # @macro async

data/lib/discorb/client.rb

@@ -395,10 +395,11 @@ module Discorb
         end
       end
       @commands.delete_if do |cmd|
-        cmd.respond_to? :extension and cmd.extension == ins.name
+        cmd.respond_to? :extension and cmd.extension == ins.class.name
       end
       ins.class.commands.each do |cmd|
-        cmd.define_singleton_method(:extension) { ins.name }
+        cmd.define_singleton_method(:extension) { ins.class.name }
+        cmd.replace_block(ins)
         @commands << cmd
       end
 
@@ -419,50 +420,19 @@ module Discorb
     #
     # @param [String, nil] token The token to use.
     #
-    # @note If the token is nil, you should use `discorb run` with the `-t` or `--token` option.
+    # @note If the token is nil, you should use `discorb run` with the `-e` or `--env` option.
     #
     def run(token = nil)
       token ||= ENV["DISCORB_CLI_TOKEN"]
-      raise ArgumentError, "Token is not specified, and -t/--token is not specified" if token.nil?
+      raise ArgumentError, "Token is not specified, and -e/--env is not specified" if token.nil?
       case ENV["DISCORB_CLI_FLAG"]
       when nil
         start_client(token)
       when "run"
-        require "json"
-        options = JSON.parse(ENV["DISCORB_CLI_OPTIONS"], symbolize_names: true)
-        @daemon = options[:daemon]
-
-        setup_commands(token) if options[:setup]
-        if options[:log_level]
-          if options[:log_level] == "none"
-            @log.out = nil
-          else
-            @log.out = case options[:log_file]
-              when nil, "stderr"
-                $stderr
-              when "stdout"
-                $stdout
-              else
-                ::File.open(options[:log_file], "a")
-              end
-            @log.level = options[:log_level].to_sym
-            @log.colorize_log = options[:log_color] == nil ? @log.out.isatty : options[:log_color]
-          end
-        end
+        before_run(token)
         start_client(token)
       when "setup"
-        guild_ids = "global"
-        if guilds = ENV["DISCORB_SETUP_GUILDS"]
-          guild_ids = guilds.split(",")
-        end
-        if guild_ids == ["global"]
-          guild_ids = false
-        end
-        setup_commands(token, guild_ids: guild_ids).wait
-        @events[:setup]&.each do |event|
-          event.call
-        end
-        self.on_setup if respond_to? :on_setup
+        run_setup(token)
       end
     end
 
@@ -478,10 +448,48 @@ module Discorb
 
     private
 
+    def before_run(token)
+      require "json"
+      options = JSON.parse(ENV["DISCORB_CLI_OPTIONS"], symbolize_names: true)
+      setup_commands(token) if options[:setup]
+      if options[:log_level]
+        if options[:log_level] == "none"
+          @log.out = nil
+        else
+          @log.out = case options[:log_file]
+            when nil, "stderr"
+              $stderr
+            when "stdout"
+              $stdout
+            else
+              ::File.open(options[:log_file], "a")
+            end
+          @log.level = options[:log_level].to_sym
+          @log.colorize_log = options[:log_color] == nil ? @log.out.isatty : options[:log_color]
+        end
+      end
+    end
+
+    def run_setup(token)
+      guild_ids = "global"
+      if guilds = ENV["DISCORB_SETUP_GUILDS"]
+        guild_ids = guilds.split(",")
+      end
+      if guild_ids == ["global"]
+        guild_ids = false
+      end
+      setup_commands(token, guild_ids: guild_ids).wait
+      @events[:setup]&.each do |event|
+        event.call
+      end
+      self.on_setup if respond_to? :on_setup
+    end
+
     def start_client(token)
       Async do |task|
-        trap(:SIGINT) {
+        Signal.trap(:SIGINT) {
           @log.info "SIGINT received, closing..."
+          Signal.trap(:SIGINT, "DEFAULT")
           close!
         }
         @token = token.to_s

data/lib/discorb/common.rb

@@ -4,7 +4,7 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v9"
   # @return [String] The version of discorb.
-  VERSION = "0.11.2"
+  VERSION = "0.12.1"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}"
 
@@ -64,6 +64,10 @@ module Discorb
     #   Increment of snowflake.
     #
     #   @return [Integer] Increment of snowflake.
+    # @!attribute [r] id
+    #   Alias of to_s.
+    #
+    #   @return [String] The snowflake.
 
     #
     # Compares snowflake with other object.
@@ -105,5 +109,7 @@ module Discorb
     def increment
       @value & 0xFFF
     end
+
+    alias id to_s
   end
 end

data/lib/discorb/error.rb

@@ -38,7 +38,8 @@ module Discorb
   # @abstract
   #
   class HTTPError < DiscorbError
-    # @return [String] the HTTP response code.
+    # @return [String] the JSON response code.
+    # @see https://discord.com/developers/docs/topics/opcodes-and-status-codes#json-json-error-codes
     attr_reader :code
     # @return [Net::HTTPResponse] the HTTP response.
     attr_reader :response
@@ -47,7 +48,7 @@ module Discorb
     def initialize(resp, data)
       @code = data[:code]
       @response = resp
-      super(data[:message])
+      super(data[:message] + " (#{@code})")
     end
   end
 
@@ -60,9 +61,11 @@ module Discorb
       @code = data[:code]
       @response = resp
       DiscorbError.instance_method(:initialize).bind(self).call(
-        [data[:message], enumerate_errors(data[:errors]).map do |ek, ev|
-          "#{ek}=>#{ev}"
-        end.join("\n")].join("\n")
+        [
+          data[:message] + " (#{@code})", enumerate_errors(data[:errors])
+            .map { |ek, ev| "#{ek}=>#{ev}" }
+            .join("\n"),
+        ].join("\n")
       )
     end
   end

data/lib/discorb/gateway.rb

@@ -482,38 +482,44 @@ module Discorb
       private
 
       def connect_gateway(reconnect)
-        @log.info "Connecting to gateway."
+        if reconnect
+          @log.info "Reconnecting to gateway..."
+        else
+          @log.info "Connecting to gateway..."
+        end
         Async do
+          @connection&.close
           @http = HTTP.new(self)
           _, gateway_response = @http.get("/gateway").wait
           gateway_url = gateway_response[:url]
           endpoint = Async::HTTP::Endpoint.parse("#{gateway_url}?v=9&encoding=json&compress=zlib-stream",
                                                  alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
           begin
-            Async::WebSocket::Client.connect(endpoint, headers: [["User-Agent", Discorb::USER_AGENT]], handler: RawConnection) do |connection|
-              @connection = connection
-              @zlib_stream = Zlib::Inflate.new(Zlib::MAX_WBITS)
-              @buffer = +""
-              begin
-                while (message = @connection.read)
-                  @buffer << message
-                  if message.end_with?((+"\x00\x00\xff\xff").force_encoding("ASCII-8BIT"))
-                    begin
-                      data = @zlib_stream.inflate(@buffer)
-                      @buffer = +""
-                      message = JSON.parse(data, symbolize_names: true)
-                    rescue JSON::ParserError
-                      @buffer = +""
-                      @log.error "Received invalid JSON from gateway."
-                      @log.debug "#{data}"
-                    else
-                      handle_gateway(message, reconnect)
-                    end
+            @connection = Async::WebSocket::Client.connect(endpoint, headers: [["User-Agent", Discorb::USER_AGENT]], handler: RawConnection)
+            @zlib_stream = Zlib::Inflate.new(Zlib::MAX_WBITS)
+            buffer = +""
+            begin
+              while (message = @connection.read)
+                buffer << message
+                if message.end_with?((+"\x00\x00\xff\xff").force_encoding("ASCII-8BIT"))
+                  begin
+                    data = @zlib_stream.inflate(buffer)
+                    buffer = +""
+                    message = JSON.parse(data, symbolize_names: true)
+                  rescue JSON::ParserError
+                    buffer = +""
+                    @log.error "Received invalid JSON from gateway."
+                    @log.debug "#{data}"
+                  else
+                    handle_gateway(message, reconnect)
                   end
                 end
-              rescue EOFError, Async::Wrapper::Cancelled, Async::Wrapper::WaitError
-                # Ignore
               end
+            rescue Async::Wrapper::Cancelled, OpenSSL::SSL::SSLError, Async::Wrapper::WaitError, EOFError => e
+              @log.error "Gateway connection closed: #{e.class}: #{e.message}"
+              connect_gateway(true)
+            else # should never happen
+              connect_gateway(true)
             end
           rescue Protocol::WebSocket::ClosedError => e
             @tasks.map(&:stop)
@@ -542,7 +548,7 @@ module Discorb
               connect_gateway(false)
             end
           rescue => e
-            @log.error "Discord WebSocket error: #{e.message}"
+            @log.error "Discord WebSocket error: #{e.full_message}"
             connect_gateway(false)
           end
         end
@@ -1034,6 +1040,7 @@ module Discorb
           dispatch(interaction.class.event_name, interaction)
         when "RESUMED"
           @log.info("Successfully resumed connection")
+          @tasks << handle_heartbeat
           dispatch(:resumed)
         else
           if respond_to?("event_" + event_name.downcase)

data/lib/discorb/interaction/autocomplete.rb

@@ -0,0 +1,49 @@
+module Discorb
+  #
+  # Represents auto complete interaction.
+  #
+  class AutoComplete < Interaction
+    @interaction_type = 4
+    @interaction_name = :auto_complete
+
+    # @private
+    def _set_data(data)
+      super
+      Sync do
+        name, options = Discorb::CommandInteraction::SlashCommand.get_command_data(data)
+
+        unless (command = @client.bottom_commands.find { |c| c.to_s == name && c.type_raw == 1 })
+          @client.log.warn "Unknown command name #{name}, ignoring"
+          next
+        end
+
+        option_map = command.options.map { |k, v| [k.to_s, v[:default]] }.to_h
+        Discorb::CommandInteraction::SlashCommand.modify_option_map(option_map, options)
+        focused_index = options.find_index { |o| o[:focused] }
+        val = command.options.values[focused_index][:autocomplete]&.call(self, *command.options.map { |k, v| option_map[k.to_s] })
+        send_complete_result(val)
+      end
+    end
+
+    # @private
+    def send_complete_result(val)
+      @client.http.post("/interactions/#{@id}/#{@token}/callback", {
+        type: 8,
+        data: {
+          choices: val.map do |vk, vv|
+            {
+              name: vk,
+              value: vv,
+            }
+          end,
+        },
+      }).wait
+    rescue Discorb::NotFoundError
+      @client.log.warn "Failed to send auto complete result, This may be caused by the suggestion is taking too long (over 3 seconds) to respond", fallback: $stderr
+    end
+
+    class << self
+      alias make_interaction new
+    end
+  end
+end

data/lib/discorb/interaction/command.rb

@@ -0,0 +1,142 @@
+module Discorb
+  #
+  # Represents a command interaction.
+  #
+  class CommandInteraction < Interaction
+    @interaction_type = 2
+    @interaction_name = :application_command
+    include Interaction::SourceResponse
+
+    #
+    # Represents a slash command interaction.
+    #
+    class SlashCommand < CommandInteraction
+      @command_type = 1
+
+      private
+
+      def _set_data(data)
+        super
+
+        name, options = SlashCommand.get_command_data(data)
+
+        unless (command = @client.bottom_commands.find { |c| c.to_s == name && c.type_raw == 1 })
+          @client.log.warn "Unknown command name #{name}, ignoring"
+          return
+        end
+
+        option_map = command.options.map { |k, v| [k.to_s, v[:default]] }.to_h
+        SlashCommand.modify_option_map(option_map, options)
+
+        command.block.call(self, *command.options.map { |k, v| option_map[k.to_s] })
+      end
+
+      class << self
+        # @private
+        def get_command_data(data)
+          name = data[:name]
+          options = nil
+          return name, options unless (option = data[:options]&.first)
+
+          case option[:type]
+          when 1
+            name += " #{option[:name]}"
+            options = option[:options]
+          when 2
+            name += " #{option[:name]}"
+            unless option[:options]&.first&.[](:type) == 1
+              options = option[:options]
+              return name, options
+            end
+            option_sub = option[:options]&.first
+            name += " #{option_sub[:name]}"
+            options = option_sub[:options]
+          else
+            options = data[:options]
+          end
+
+          return name, options
+        end
+
+        # @private
+        def modify_option_map(option_map, options)
+          options ||= []
+          options.each_with_index do |option|
+            val = case option[:type]
+              when 3, 4, 5, 10
+                option[:value]
+              when 6
+                guild.members[option[:value]] || guild.fetch_member(option[:value]).wait
+              when 7
+                guild.channels[option[:value]] || guild.fetch_channels.wait.find { |channel| channel.id == option[:value] }
+              when 8
+                guild.roles[option[:value]] || guild.fetch_roles.wait.find { |role| role.id == option[:value] }
+              when 9
+                guild.members[option[:value]] || guild.roles[option[:value]] || guild.fetch_member(option[:value]).wait || guild.fetch_roles.wait.find { |role| role.id == option[:value] }
+              end
+            option_map[option[:name]] = val
+          end
+        end
+      end
+    end
+
+    #
+    # Represents a user context menu interaction.
+    #
+    class UserMenuCommand < CommandInteraction
+      @command_type = 2
+
+      # @return [Discorb::Member, Discorb::User] The target user.
+      attr_reader :target
+
+      private
+
+      def _set_data(data)
+        @target = guild.members[data[:target_id]] || Discorb::Member.new(@client, @guild_id, data[:resolved][:users][data[:target_id].to_sym], data[:resolved][:members][data[:target_id].to_sym])
+        @client.commands.find { |c| c.name == data[:name] && c.type_raw == 2 }.block.call(self, @target)
+      end
+    end
+
+    #
+    # Represents a message context menu interaction.
+    #
+    class MessageMenuCommand < CommandInteraction
+      @command_type = 3
+
+      # @return [Discorb::Message] The target message.
+      attr_reader :target
+
+      private
+
+      def _set_data(data)
+        @target = Message.new(@client, data[:resolved][:messages][data[:target_id].to_sym].merge(guild_id: @guild_id.to_s))
+        @client.commands.find { |c| c.name == data[:name] && c.type_raw == 3 }.block.call(self, @target)
+      end
+    end
+
+    private
+
+    def _set_data(data)
+      @name = data[:name]
+    end
+
+    class << self
+      # @private
+      attr_reader :command_type
+
+      # @private
+      def make_interaction(client, data)
+        nested_classes.each do |klass|
+          return klass.new(client, data) if !klass.command_type.nil? && klass.command_type == data[:data][:type]
+        end
+        client.log.warn("Unknown command type #{data[:type]}, initialized CommandInteraction")
+        CommandInteraction.new(client, data)
+      end
+
+      # @private
+      def nested_classes
+        constants.select { |c| const_get(c).is_a? Class }.map { |c| const_get(c) }
+      end
+    end
+  end
+end