discorb 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b979da1f1325d5d9cae229e0262cce1d6cf16b6aca91feba731ec6a0146fe42
-  data.tar.gz: e6e1fcbe4265cfb54828fef5c7e2d6304dd306544e941cb787233ad563d9abaf
+  metadata.gz: f0bee36d996a7e3108f2d02247a0d7516ade1811aeb5a354d1d41f509373381d
+  data.tar.gz: ce6c4f496b8ed5309cd3798b8cf25e271e77e75617631010d77f5ab3347a26aa
 SHA512:
-  metadata.gz: bb35c0736b2e549964030103dfb1202ef7711fd3c36323710d3f94631b958a9976f7c111f340d03cf2ed67032a8f74f5165f66b5ff92c59d0628af25b4a95e79
-  data.tar.gz: 01d59859fb5e84beaafdc48e333ba841398a8fe5867c52bb9621b2d676493dbc776297c94e303297ffeef591c7f2e527ea30aaae381323e4ed8e8b1ce632b1ef
+  metadata.gz: 514f4b1ce307abe3424fa666a9fab56282e7b3817371411661675507658a42a92c23cda56e6358765fcad25bae69b850e754882576392ddc45da8be08ff3d252
+  data.tar.gz: e11b02e78f5029a0e544a0c7a55d79ee42ee22276160ba0f00dad0bd85c2d5d15109fa28c50dbfccbaf61066e293175e6b38357db396aeaba4b3033e38dbf2c4

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

@@ -4,6 +4,12 @@
 
 ## v0.11
 
+### 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

@@ -8,7 +8,7 @@
 
 ----
 
-discorb is a Discord API wrapper for Ruby.
+discorb is a Discord API wrapper written in Ruby.
 
 ## Installation
 
@@ -98,7 +98,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/client.rb

@@ -446,16 +446,7 @@ module Discorb
                 ::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
+            @log.colorize_log = options[:log_color] == nil ? @log.out.isatty : options[:log_color]
           end
         end
         start_client(token)
@@ -468,6 +459,10 @@ module Discorb
           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
     end
 
@@ -493,7 +488,7 @@ module Discorb
         @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.11.2"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}"
 

data/lib/discorb/gateway.rb

@@ -481,11 +481,10 @@ module Discorb
     module Handler
       private
 
-      def connect_gateway(first)
+      def connect_gateway(reconnect)
         @log.info "Connecting to gateway."
         Async do
-          @http = HTTP.new(self) if first
-          @first = first
+          @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",
@@ -495,38 +494,53 @@ module Discorb
               @connection = connection
               @zlib_stream = Zlib::Inflate.new(Zlib::MAX_WBITS)
               @buffer = +""
-
-              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)
+              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
                 end
+              rescue EOFError, Async::Wrapper::Cancelled, Async::Wrapper::WaitError
+                # Ignore
               end
             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}"
             connect_gateway(false)
@@ -540,15 +554,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 +579,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"

data/lib/discorb/interaction.rb

@@ -458,6 +458,7 @@ module Discorb
     @interaction_type = 4
     @interaction_name = :auto_complete
 
+    # @private
     def _set_data(data)
       super
       Sync do
@@ -511,6 +512,7 @@ module Discorb
       end
     end
 
+    # @private
     def send_complete_result(val)
       @client.http.post("/interactions/#{@id}/#{@token}/callback", {
         type: 8,

data/lib/discorb/log.rb

@@ -65,10 +65,11 @@ module Discorb
         return
       end
 
+      time = Time.now.iso8601
       if @colorize_log
-        @out.puts("\e[2;90m[#{Time.now.iso8601}] #{color}#{name}\e[m -- #{message}")
+        @out.puts("\e[90m#{time}\e[0m #{color}#{name.ljust(5)}\e[0m #{message}")
       else
-        @out.puts("[#{Time.now.iso8601}] #{name} -- #{message}")
+        @out.puts("#{time} #{name.ljust(5)} #{message}")
       end
     end
   end

data/lib/discorb/rate_limit.rb

@@ -24,7 +24,7 @@ module Discorb
       return if path.start_with?("https://")
 
       if @global
-        time = b[:reset_at] - Time.now.to_i
+        time = b[:reset_at] - Time.now.to_f
         @client.log.info("global rate limit reached, waiting #{time} seconds")
         sleep(time)
         @global = false
@@ -54,7 +54,7 @@ module Discorb
     #
     def save(method, path, resp)
       if resp["X-Ratelimit-Global"] == "true"
-        @global = Time.now.to_i + JSON.parse(resp.body, symbolize_names: true)[:retry_after]
+        @global = Time.now.to_f + JSON.parse(resp.body, symbolize_names: true)[:retry_after]
       end
       return unless resp["X-RateLimit-Remaining"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discorb
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - sevenc-nanashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2021-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -79,6 +79,7 @@ files:
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/build_main.yml"
 - ".github/workflows/build_version.yml"
+- ".github/workflows/package_register.yml"
 - ".gitignore"
 - ".yardopts"
 - Changelog.md
@@ -103,8 +104,8 @@ files:
 - docs/assets/08_hello_once.png
 - docs/assets/unused_ping_pong.png
 - docs/cli.md
-- docs/cli/init.md
 - docs/cli/irb.md
+- docs/cli/new.md
 - docs/cli/run.md
 - docs/cli/setup.md
 - docs/events.md
@@ -191,7 +192,6 @@ homepage: https://github.com/discorb-lib/discorb
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/discorb-lib/discorb
   source_code_uri: https://github.com/discorb-lib/discorb
   changelog_uri: https://discorb-lib.github.io/file.Changelog.html