discorb 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b979da1f1325d5d9cae229e0262cce1d6cf16b6aca91feba731ec6a0146fe42
-  data.tar.gz: e6e1fcbe4265cfb54828fef5c7e2d6304dd306544e941cb787233ad563d9abaf
+  metadata.gz: d57f5fd6920be7c5549687ec85d3012dede743981482fc806099789d3d9f4048
+  data.tar.gz: 513c3e45c0da27f8e509c4ed7238c5f6da3cd39b61a0681874a97d507068ffc6
 SHA512:
-  metadata.gz: bb35c0736b2e549964030103dfb1202ef7711fd3c36323710d3f94631b958a9976f7c111f340d03cf2ed67032a8f74f5165f66b5ff92c59d0628af25b4a95e79
-  data.tar.gz: 01d59859fb5e84beaafdc48e333ba841398a8fe5867c52bb9621b2d676493dbc776297c94e303297ffeef591c7f2e527ea30aaae381323e4ed8e8b1ce632b1ef
+  metadata.gz: 7603b6c7017898fbd705ffaa602f370111c6d122a2e68a7b6c017c6fa622d9b6990e684bf574104844e8dc6601176a47894815cfb3756ae16305fe74709da118
+  data.tar.gz: 0fa148e0c26c45a8aa0c3a9e2dbdfb4995bc9e939c9588d93b575b711baccc906b20ba3f8edfe4906ae5838565bd0be6befc5cf7e6b2ca25f1f465e21fa6622a

data/.github/workflows/package_register.yml

@@ -0,0 +1,34 @@
+name: Publish Gem
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.0"
+
+      - name: Setup Release Credentials
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 600 $HOME/.gem/credentials
+          echo "---" >$HOME/.gem/credentials
+          echo ":github: Bearer ${GITHUB_TOKEN}" >> $HOME/.gem/credentials
+      - name: Publish Gem to GitHub Packages
+        run: |
+          export OWNER=$( echo ${{ github.repository }} | cut -d "/" -f 1 )
+          gem build *.gemspec
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem

data/Changelog.md

@@ -2,8 +2,31 @@
 
 # Changelog
 
+## v0.12
+
+### 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
+- Fix: Fix gateway resuming
+- Add: Add GitHub Packages
+
 ### v0.11.1
 
 - Improve: Improve rate limit handling

data/README.md

@@ -4,11 +4,12 @@
 <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>
 
 ----
 
-discorb is a Discord API wrapper for Ruby.
+discorb is a Discord API wrapper written in Ruby.
 
 ## Installation
 
@@ -98,7 +99,7 @@ end
 client.run(ENV["DISCORD_BOT_TOKEN"])
 ```
 
-Note: You must run `discorb setup` before using slash commands.
+Note you must run `discorb setup` before using slash commands.
 
 ## Contributing
 

data/discorb.gemspec

@@ -13,8 +13,6 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/discorb-lib/discorb"
   spec.metadata["changelog_uri"] = "https://discorb-lib.github.io/file.Changelog.html"

data/docs/cli/setup.md

@@ -2,7 +2,7 @@
 
 # discorb setup
 
-This command will setup application commands.
+This command will setup application commands, and call `setup` event.
 
 ## Usage
 

data/docs/cli.md

@@ -16,7 +16,7 @@ Currently, discorb has the following commands:
 
 | Command | Description |
 |---------|-------------|
-| {file:docs/cli/init.md `init`} | Create a new project. |
+| {file:docs/cli/new.md `new`} | Create a new project. |
 | {file:docs/cli/irb.md `irb`} | Start an interactive Ruby shell with connected client. |
 | {file:docs/cli/run.md `run`} | Run a client. |
 | {file:docs/cli/setup.md `setup`} | Setup application commands. |

data/docs/events.md

@@ -88,6 +88,11 @@ Fires when the client is resumed connection.
 Fires when an error occurs during an event.
 Defaults to printing the error to stderr, override to handle it yourself.
 
+#### `setup()`
+
+Fires when `discorb setup` is run.
+This is useful for setting up some dependencies, such as the database.
+
 ### Guild events
 
 #### `guild_join(guild)`

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
 
@@ -428,46 +429,10 @@ module Discorb
       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 = case options[:log_color]
-              when nil
-                if @log.out == $stdout || @log.out == $stderr
-                  true
-                else
-                  false
-                end
-              when true, false
-                options[:log_color]
-              end
-          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
+        run_setup(token)
       end
     end
 
@@ -483,17 +448,55 @@ 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
         @close_condition = Async::Condition.new
         @main_task = Async do
           @status = :running
-          connect_gateway(true).wait
+          connect_gateway(false).wait
         rescue
           @status = :stopped
           @close_condition.signal

data/lib/discorb/color.rb

@@ -130,6 +130,7 @@ module Discorb
     #
     # Create a color from a Discord's color.
     # Currently these colors are supported:
+    #
     # | Color Name | Hexadecimal |
     # |------------|------------|
     # | `:teal` | `#1abc9c` |

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.1"
+  VERSION = "0.12.0"
   # @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

@@ -481,54 +481,74 @@ module Discorb
     module Handler
       private
 
-      def connect_gateway(first)
-        @log.info "Connecting to gateway."
+      def connect_gateway(reconnect)
+        if reconnect
+          @log.info "Reconnecting to gateway..."
+        else
+          @log.info "Connecting to gateway..."
+        end
         Async do
-          @http = HTTP.new(self) if first
-          @first = first
+          @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 = +""
-
+            @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
+                buffer << message
                 if message.end_with?((+"\x00\x00\xff\xff").force_encoding("ASCII-8BIT"))
                   begin
-                    data = @zlib_stream.inflate(@buffer)
-                    @buffer = +""
+                    data = @zlib_stream.inflate(buffer)
+                    buffer = +""
                     message = JSON.parse(data, symbolize_names: true)
                   rescue JSON::ParserError
-                    @buffer = +""
+                    buffer = +""
                     @log.error "Received invalid JSON from gateway."
                     @log.debug "#{data}"
                   else
-                    handle_gateway(message)
+                    handle_gateway(message, reconnect)
                   end
                 end
               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
-            case e.message
-            when "Authentication failed."
-              @tasks.map(&:stop)
-              raise ClientError.new("Authentication failed."), cause: nil
-            when "Discord WebSocket requesting client reconnect."
-              @log.info "Discord WebSocket requesting client reconnect"
-              connect_gateway(false)
+            @tasks.map(&:stop)
+            case e.code
+            when 4004
+              raise ClientError.new("Authentication failed"), cause: nil
+            when 4009
+              @log.info "Session timed out, reconnecting."
+              connect_gateway(true)
+            when 4014
+              raise ClientError.new("Disallowed intents were specified"), cause: nil
+            when 4002, 4003, 4005, 4007
+              raise ClientError.new(<<~EOS), cause: e
+                                               Disconnected from gateway, probably due to library issues.
+                                               #{e.message}
+
+                                               Please report this to the library issue tracker.
+                                               https://github.com/discorb-lib/discorb/issues
+                                             EOS
+            when 1001
+              @log.info "Gateway closed with code 1001, reconnecting."
+              connect_gateway(true)
             else
-              @log.error "Discord WebSocket closed: #{e.message}"
+              @log.error "Discord WebSocket closed with code #{e.code}."
+              @log.debug "#{e.message}"
               connect_gateway(false)
             end
-          rescue EOFError, Async::Wrapper::Cancelled, Async::Wrapper::WaitError
-            connect_gateway(false)
           rescue => e
-            @log.error "Discord WebSocket error: #{e.message}"
+            @log.error "Discord WebSocket error: #{e.full_message}"
             connect_gateway(false)
           end
         end
@@ -540,15 +560,23 @@ module Discorb
         @log.debug "Sent message #{{ op: opcode, d: value }.to_json.gsub(@token, "[Token]")}"
       end
 
-      def handle_gateway(payload)
+      def handle_gateway(payload, reconnect)
         Async do |task|
           data = payload[:d]
           @last_s = payload[:s] if payload[:s]
-          @log.debug "Received message with opcode #{payload[:op]} from gateway: #{data}"
+          @log.debug "Received message with opcode #{payload[:op]} from gateway:"
+          @log.debug "#{payload.to_json.gsub(@token, "[Token]")}"
           case payload[:op]
           when 10
             @heartbeat_interval = data[:heartbeat_interval]
-            if @first
+            if reconnect
+              payload = {
+                token: @token,
+                session_id: @session_id,
+                seq: @last_s,
+              }
+              send_gateway(6, **payload)
+            else
               payload = {
                 token: @token,
                 intents: @intents.value,
@@ -557,38 +585,22 @@ module Discorb
               }
               payload[:presence] = @identify_presence if @identify_presence
               send_gateway(2, **payload)
-              Async do
-                sleep 2
-                next unless @uncached_guilds.nil?
-
-                raise ClientError, "Failed to connect to gateway.\nHint: This usually means that your intents are invalid."
-                exit 1
-              end
-            else
-              payload = {
-                token: @token,
-                session_id: @session_id,
-                seq: @last_s,
-              }
-              send_gateway(6, **payload)
             end
           when 7
             @log.info "Received opcode 7, reconnecting"
             @tasks.map(&:stop)
-            @connection.close
-            connect_gateway(false)
           when 9
             @log.warn "Received opcode 9, closed connection"
             @tasks.map(&:stop)
             if data
               @log.info "Connection is resumable, reconnecting"
               @connection.close
-              connect_gateway(false)
+              connect_gateway(true)
             else
               @log.info "Connection is not resumable, reconnecting with opcode 2"
-              sleep(2)
               @connection.close
-              connect_gateway(true)
+              sleep(2)
+              connect_gateway(false)
             end
           when 11
             @log.debug "Received opcode 11"
@@ -1028,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