discorb 0.11.0 → 0.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c80c426387c9e5ba44589c5851e7c1a4d54a5de99c82d5b3571c4200dcaf135
-  data.tar.gz: 2aa6db0900cafe2120793b295b68e5de357e97e0797cd416a06caca9491b09e1
+  metadata.gz: 3154cd1b844888bec798cdead182285e335733206758fddea8c2fd8e0015499e
+  data.tar.gz: 9d0ba163982a7676045dce791409227f2c99c3e28bce29cae25033b85f7485a5
 SHA512:
-  metadata.gz: afe14b35796820b8b7af5baaab6a79a5a770c55d11d30d25b2a9647034658e27346e918be42fb8d4a30edbf27873bd367cf3551cf1b091e82c49150c886ef03e
-  data.tar.gz: 9c817738b2a4b3763d94182e2b47f583aaa7129a8769cdc9b8f7fc7e10f0656f43183f0d416d72aa20112b6b34addfdd38e36b7710c6405d2f29f658cb238c4c
+  metadata.gz: 20ee7dd354fc5be471617ed61367ceb85bad364cd8e2afd95df9c46453665b61c15d387c2bafb36b295836f5cb02f699edfc3118af4fa6c39e30a52f72904e6d
+  data.tar.gz: c860a7fa1335a7be40dafa7e9bda5bbfd6a7d7e7790ece875db350b154f3e7ab7f523387b5be4a77f4cae7f43c01b3a726f2c917dd81c2b97502f0097b9b5ecc

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,28 @@
 
 ## 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
+- Fix: Fix bug in Integration initalization
+- Change: Change log style
+- Add: Support OP code 7
+
 ### v0.11.0
 
 - Add: Improve documents

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/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

@@ -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.0"
+  VERSION = "0.11.4"
   # @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/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,36 +494,55 @@ 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
+          rescue => e
+            @log.error "Discord WebSocket error: #{e.message}"
             connect_gateway(false)
           end
         end
@@ -533,18 +551,26 @@ module Discorb
       def send_gateway(opcode, **value)
         @connection.write({ op: opcode, d: value }.to_json)
         @connection.flush
-        @log.debug "Sent message: #{{ op: opcode, d: value }.to_json.gsub(@token, "[Token]")}"
+        @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,
@@ -553,33 +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)
           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"
@@ -1024,7 +1039,7 @@ module Discorb
           if respond_to?("event_" + event_name.downcase)
             __send__("event_" + event_name.downcase, data)
           else
-            @log.debug "Received unknown event: #{event_name}\n#{data.inspect}"
+            @log.debug "#{event_name}\n#{data.inspect}"
           end
         end
       end

data/lib/discorb/http.rb

@@ -175,6 +175,7 @@ module Discorb
     def handle_response(method, resp, data, path, body, headers, audit_log_reason, kwargs)
       case resp.code
       when "429"
+        @client.log.info("Rate limit exceeded for #{method} #{path}, waiting #{data[:retry_after]} seconds")
         sleep(data[:retry_after])
         if body
           __send__(method, path, body, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait
@@ -227,15 +228,19 @@ module Discorb
     end
 
     def get_response_data(resp)
-      if resp["Via"].nil? && resp.code == "429"
-        raise CloudFlareBanError.new(resp, @client)
+      begin
+        data = JSON.parse(resp.body, symbolize_names: true)
+      rescue JSON::ParserError, TypeError
+        if resp.body.nil? || resp.body.empty?
+          data = nil
+        else
+          data = resp.body
+        end
       end
-      rd = resp.body
-      if rd.nil? || rd.empty?
-        nil
-      else
-        JSON.parse(rd, symbolize_names: true)
+      if resp["Via"].nil? && resp.code == "429" && data.is_a?(String)
+        raise CloudFlareBanError.new(resp, @client)
       end
+      data
     end
 
     def http

data/lib/discorb/integration.rb

@@ -80,7 +80,7 @@ module Discorb
       @enable_emoticons = data[:enable_emoticons]
       @expire_behavior = self.class.expire_behavior[data[:expire_behavior]]
       @expire_grace_period = data[:expire_grace_period]
-      @user = @client.users[data[:user].to_i]
+      @user = @client.users[data[:user][:id]] or Discorb::User.new(@client, data[:user])
       @account = Account.new(data[:account])
       @subscriber_count = data[:subscriber_count]
       @revoked = data[:revoked]

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/message.rb

@@ -455,7 +455,9 @@ module Discorb
     # @macro async
     # @macro http
     #
-    def unpin
+    # @param [String] reason The reason for unpinning the message.
+    #
+    def unpin(reason: nil)
       Async do
         channel.unpin_message(self, reason: reason).wait
       end

data/lib/discorb/modules.rb

@@ -142,6 +142,48 @@ 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/#{channel_id.wait}/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/#{channel_id.wait}/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/#{channel_id.wait}/pins/#{message.id}", audit_log_reason: reason).wait
+      end
+    end
+
     #
     # Trigger the typing indicator in the channel.
     # @macro async

data/lib/discorb/rate_limit.rb

@@ -9,8 +9,8 @@ module Discorb
     # @private
     def initialize(client)
       @client = client
-      @ratelimit_hash = {}
-      @path_ratelimit_hash = {}
+      @current_ratelimits = {}
+      @path_ratelimit_bucket = {}
       @global = false
     end
 
@@ -24,25 +24,24 @@ module Discorb
       return if path.start_with?("https://")
 
       if @global
-        time = b[:reset_at] - Time.now.to_i
-        @client.log.info("Global ratelimit reached, waiting #{time} seconds")
+        time = b[:reset_at] - Time.now.to_f
+        @client.log.info("global rate limit reached, waiting #{time} seconds")
         sleep(time)
         @global = false
-        
       end
 
-      return unless hash = @path_ratelimit_hash[method + path]
+      return unless hash = @path_ratelimit_bucket[method + path]
 
-      return unless b = @ratelimit_hash[hash]
+      return unless b = @current_ratelimits[hash]
 
-      if b[:reset_at] < Time.now.to_i
-        @ratelimit_hash.delete(hash)
+      if b[:reset_at] < Time.now.to_f
+        @current_ratelimits.delete(hash)
         return
       end
       return if b[:remaining] > 0
 
-      time = b[:reset_at] - Time.now.to_i
-      @client.log.info("Ratelimit reached, waiting #{time} seconds")
+      time = b[:reset_at] - Time.now.to_f
+      @client.log.info("rate limit for #{method} #{path} reached, waiting #{time} seconds")
       sleep(time)
     end
 
@@ -55,14 +54,14 @@ 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"]
 
-      @path_ratelimit_hash[method + path] = resp["X-RateLimit-Bucket"]
-      @ratelimit_hash[resp["X-RateLimit-Bucket"]] = {
+      @path_ratelimit_bucket[method + path] = resp["X-RateLimit-Bucket"]
+      @current_ratelimits[resp["X-RateLimit-Bucket"]] = {
         remaining: resp["X-RateLimit-Remaining"].to_i,
-        reset_at: resp["X-RateLimit-Reset"].to_i,
+        reset_at: Time.now.to_f + resp["X-RateLimit-Reset-After"].to_f,
       }
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discorb
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.4
 platform: ruby
 authors:
 - sevenc-nanashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-10 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