discorb 0.3.1 → 0.5.0

data/lib/discorb/exe/run.rb

@@ -0,0 +1,49 @@
+# description: Run a client.
+require "optparse"
+require "json"
+require "discorb/utils/colored_puts"
+
+ARGV.delete_at 0
+# @!visibility private
+LOG_LEVELS = %w[none debug info warn error fatal]
+
+opt = OptionParser.new <<~BANNER
+                         This command will run a client.
+
+                         Usage: discorb run [options] [script]
+
+                                   script                     The script to run. Defaults to 'main.rb'.
+                       BANNER
+options = {
+  deamon: false,
+  log_level: nil,
+  log_file: nil,
+  log_color: nil,
+  setup: nil,
+}
+opt.on("-d", "--deamon", "Run as a daemon.") { |v| options[:daemon] = v }
+opt.on("-l", "--log-level LEVEL", "Log level.") do |v|
+  unless LOG_LEVELS.include? v.downcase
+    eputs "Invalid log level: \e[31m#{v}\e[91m"
+    eputs "Valid log levels: \e[31m#{LOG_LEVELS.join("\e[91m, \e[31m")}\e[91m"
+    exit 1
+  end
+  options[:log_level] = v.downcase
+end
+opt.on("-f", "--log-file FILE", "File to write log to.") { |v| options[:log_file] = v }
+opt.on("-c", "--[no-]log-color", "Whether to colorize log output.") { |v| options[:log_color] = v }
+opt.on("-s", "--setup", "Whether to setup application commands.") { |v| options[:setup] = v }
+opt.parse!(ARGV)
+
+script = ARGV[0]
+
+script ||= "main.rb"
+
+ENV["DISCORB_CLI_FLAG"] = "run"
+ENV["DISCORB_CLI_OPTIONS"] = JSON.generate(options)
+
+begin
+  load script
+rescue LoadError
+  eputs "Could not load script: \e[31m#{script}\e[91m"
+end

data/lib/discorb/exe/setup.rb

@@ -0,0 +1,26 @@
+# description: Setup application commands.
+require "optparse"
+require "discorb/utils/colored_puts"
+
+ARGV.delete_at 0
+
+opt = OptionParser.new <<~BANNER
+                         This command will setup application commands.
+
+                         Usage: discorb setup [script]
+
+                                   script                     The script to setup.
+                       BANNER
+opt.parse!(ARGV)
+
+script = ARGV[0]
+script ||= "main.rb"
+ENV["DISCORB_CLI_FLAG"] = "setup"
+
+begin
+  load script
+rescue LoadError
+  eputs "Could not load script: \e[31m#{script}\e[m"
+else
+  sputs "Successfully set up commands for \e[32m#{script}\e[m."
+end

data/lib/discorb/gateway.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "async/http"
+require "async/websocket"
+require "json"
+require "zlib"
 
 module Discorb
   #
@@ -464,13 +467,20 @@ module Discorb
           @first = first
           _, gateway_response = @http.get("/gateway").wait
           gateway_url = gateway_response[:url]
-          endpoint = Async::HTTP::Endpoint.parse("#{gateway_url}?v=9&encoding=json",
+          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]]) do |connection|
+            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 = +""
               while (message = @connection.read)
-                handle_gateway(message)
+                @buffer << message
+                if message.end_with?((+"\x00\x00\xff\xff").force_encoding("ASCII-8BIT"))
+                  message = JSON.parse(@zlib_stream.inflate(@buffer), symbolize_names: true)
+                  @buffer = +""
+                  handle_gateway(message)
+                end
               end
             end
           rescue Protocol::WebSocket::ClosedError => e
@@ -490,7 +500,7 @@ module Discorb
       end
 
       def send_gateway(opcode, **value)
-        @connection.write({ op: opcode, d: value })
+        @connection.write({ op: opcode, d: value }.to_json)
         @connection.flush
         @log.debug "Sent message with opcode #{opcode}: #{value.to_json.gsub(@token, "[Token]")}"
       end
@@ -548,7 +558,7 @@ module Discorb
           task.sleep((interval / 1000.0 - 1) * rand)
           loop do
             @heartbeat_before = Time.now.to_f
-            @connection.write({ op: 1, d: @last_s })
+            @connection.write({ op: 1, d: @last_s }.to_json)
             @connection.flush
             @log.debug "Sent opcode 1."
             @log.debug "Waiting for heartbeat."
@@ -574,7 +584,6 @@ module Discorb
             @uncached_guilds.delete(data[:id])
             if @uncached_guilds == []
               @ready = true
-              setup_commands.wait if @overwrite_application_commands
               dispatch(:ready)
               @log.info("Guilds were cached")
             end
@@ -974,5 +983,25 @@ module Discorb
         end
       end
     end
+    
+    #
+    # A class for connecting websocket with raw bytes data.
+    # @private
+    #
+    class RawConnection < Async::WebSocket::Connection		
+      def initialize(...)
+        super
+      end
+    
+			def parse(buffer)
+				# noop
+        buffer.to_s
+			end
+			
+			def dump(object)
+				# noop
+        object.to_s
+			end
+    end
   end
 end

data/lib/discorb/http.rb

@@ -13,6 +13,7 @@ module Discorb
     # @!visibility private
     def initialize(client)
       @client = client
+      @ratelimit_handler = RatelimitHandler.new(client)
     end
 
     #
@@ -31,13 +32,10 @@ module Discorb
     #
     def get(path, headers: nil, audit_log_reason: nil, **kwargs)
       Async do |task|
+        @ratelimit_handler.wait("GET", path)
         resp = http.get(get_path(path), get_headers(headers, "", audit_log_reason), **kwargs)
-        rd = resp.body
-        data = if rd.nil? || rd.empty?
-            nil
-          else
-            JSON.parse(rd, symbolize_names: true)
-          end
+        data = get_response_data(resp)
+        @ratelimit_handler.save("GET", path, resp)
         test_error(if resp.code == "429"
           @client.log.warn "Ratelimit exceeded for #{path}, trying again in #{data[:retry_after]} seconds."
           task.sleep(data[:retry_after])
@@ -65,13 +63,10 @@ module Discorb
     #
     def post(path, body = "", headers: nil, audit_log_reason: nil, **kwargs)
       Async do |task|
+        @ratelimit_handler.wait("POST", path)
         resp = http.post(get_path(path), get_body(body), get_headers(headers, body, audit_log_reason), **kwargs)
-        rd = resp.body
-        data = if rd.nil? || rd.empty?
-            nil
-          else
-            JSON.parse(rd, symbolize_names: true)
-          end
+        data = get_response_data(resp)
+        @ratelimit_handler.save("POST", path, resp)
         test_error(if resp.code == "429"
           task.sleep(data[:retry_after])
           post(path, body, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait
@@ -98,13 +93,10 @@ module Discorb
     #
     def patch(path, body = "", headers: nil, audit_log_reason: nil, **kwargs)
       Async do |task|
+        @ratelimit_handler.wait("PATCH", path)
         resp = http.patch(get_path(path), get_body(body), get_headers(headers, body, audit_log_reason), **kwargs)
-        rd = resp.body
-        data = if rd.nil? || rd.empty?
-            nil
-          else
-            JSON.parse(rd, symbolize_names: true)
-          end
+        data = get_response_data(resp)
+        @ratelimit_handler.save("PATCH", path, resp)
         test_error(if resp.code == "429"
           task.sleep(data[:retry_after])
           patch(path, body, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait
@@ -131,13 +123,10 @@ module Discorb
     #
     def put(path, body = "", headers: nil, audit_log_reason: nil, **kwargs)
       Async do |task|
+        @ratelimit_handler.wait("PUT", path)
         resp = http.put(get_path(path), get_body(body), get_headers(headers, body, audit_log_reason), **kwargs)
-        rd = resp.body
-        data = if rd.nil? || rd.empty?
-            nil
-          else
-            JSON.parse(rd, symbolize_names: true)
-          end
+        data = get_response_data(resp)
+        @ratelimit_handler.save("PUT", path, resp)
         test_error(if resp.code == "429"
           task.sleep(data[:retry_after])
           put(path, body, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait
@@ -163,13 +152,10 @@ module Discorb
     #
     def delete(path, headers: nil, audit_log_reason: nil, **kwargs)
       Async do |task|
+        @ratelimit_handler.wait("DELETE", path)
         resp = http.delete(get_path(path), get_headers(headers, "", audit_log_reason))
-        rd = resp.body
-        data = if rd.nil? || rd.empty?
-            nil
-          else
-            JSON.parse(rd, symbolize_names: true)
-          end
+        data = get_response_data(resp)
+        @ratelimit_handler.save("DELETE", path, resp)
         test_error(if resp.code == "429"
           task.sleep(data[:retry_after])
           delete(path, headers: headers, audit_log_reason: audit_log_reason, **kwargs).wait
@@ -257,6 +243,18 @@ module Discorb
       URI(full_path).path
     end
 
+    def get_response_data(resp)
+      if resp["Via"].nil?
+        raise CloudFlareBanError.new(@client, resp)
+      end
+      rd = resp.body
+      if rd.nil? || rd.empty?
+        nil
+      else
+        JSON.parse(rd, symbolize_names: true)
+      end
+    end
+
     def http
       https = Net::HTTP.new("discord.com", 443)
       https.use_ssl = true

data/lib/discorb/log.rb

@@ -3,7 +3,7 @@
 module Discorb
   # @!visibility private
   class Logger
-    attr_reader :out, :colorize_log
+    attr_accessor :out, :colorize_log
 
     @levels = %i[debug info warn error fatal].freeze
 
@@ -14,11 +14,12 @@ module Discorb
     end
 
     def level
-      @levels[@level]
+      self.class.levels[@level]
     end
 
     def level=(level)
-      @level = @levels.index(level)
+      @level = self.class.levels.index(level)
+      raise ArgumentError, "Invalid log level: #{level}" unless @level
     end
 
     def debug(message)

data/lib/discorb/rate_limit.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # Class to handle rate limiting.
+  #
+  class RatelimitHandler
+    def initialize(client)
+      @client = client
+      @ratelimit_hash = {}
+      @path_ratelimit_hash = {}
+    end
+
+    def wait(method, path)
+      return if path.start_with?("https://")
+
+      return unless hash = @path_ratelimit_hash[method + path]
+
+      return unless b = @ratelimit_hash[hash]
+
+      if b[:reset_at] < Time.now.to_i
+        @ratelimit_hash.delete(hash)
+        return
+      end
+      return if b[:remaining] > 0
+
+      @client.log.info("Ratelimit reached, waiting for #{b[:reset_at] - Time.now.to_i} seconds")
+      sleep(b[:reset_at] - Time.now.to_i)
+    end
+
+    def save(method, path, resp)
+      return unless resp["X-RateLimit-Remaining"]
+
+      @path_ratelimit_hash[method + path] = resp["X-RateLimit-Bucket"]
+      @ratelimit_hash[resp["X-RateLimit-Bucket"]] = {
+        remaining: resp["X-RateLimit-Remaining"].to_i,
+        reset_at: resp["X-RateLimit-Reset"].to_i,
+      }
+    end
+  end
+end

data/lib/discorb.rb

@@ -39,7 +39,7 @@ module Discorb
   end
 end
 
-require_order = %w[common flag dictionary error http intents emoji_table modules] +
+require_order = %w[common flag dictionary error rate_limit http intents emoji_table modules] +
                 %w[user member guild emoji channel embed message] +
                 %w[application audit_logs color components event extension] +
                 %w[file guild_template image integration interaction invite log permission] +

data/template-replace/files/css/common.css

@@ -216,8 +216,8 @@ tt {
   font-family: var(--monospace-font);
 }
 
-pre.code {
-  color: var(--header-secondary);
+pre.code code {
+  color: var(--header-secondary) !important;
   tab-size: 2;
 }
 
@@ -310,6 +310,11 @@ li.even {
   background: var(--background-secondary);
 }
 
+li.current {
+  background: var(--background-tertiary);
+}
+
+
 .item:hover {
   background: var(--background-secondary-alt);
 }
@@ -516,4 +521,10 @@ li.r2 {
   border-color: var(--background-tertiary);
   color: var(--interactive-active);
   fill: var(--interactive-active);
+}
+
+dd pre.code {
+  padding: 9px 14px;
+  border-radius: 4px;
+  border: 1px solid var(--background-tertiary);
 }

data/template-replace/resources/version_list.html

@@ -47,9 +47,9 @@
     <ul id="full_list" class="method">
       <!--replace-->
       <!--template-->
-      <li class="!eo!">
+      <li class="!class!">
         <div class="item">
-          <span class='object_link'><a href="../!version!/index.html" title="!version!">!version!</a></span>
+          <span class='object_link'><a href="!path!/index.html" title="!version!">!version!</a></span>
           <small class='git_sha'>!sha!</small>
         </div>
       </li>

data/template-replace/scripts/version.rb

@@ -1,12 +1,24 @@
-def build_version_sidebar(dir)
+def build_version_sidebar(dir, version)
   raw = File.read("template-replace/resources/version_list.html")
   template = raw.match(/<!--template-->(.*)<!--endtemplate-->/m)[1]
   raw.gsub!(template, "")
   res = +""
-  `git tag`.force_encoding("utf-8").split("\n").each.with_index do |tag, i|
+  i = 0
+  `git tag`.force_encoding("utf-8").split("\n").each.with_index do |tag|
+    i += 1
     sha = `git rev-parse #{tag}`.force_encoding("utf-8").strip
     version = tag.delete_prefix("v")
-    res += template.gsub("!version!", version).gsub("!eo!", i % 2 == 0 ? "even" : "odd").gsub("!sha!", sha)
+    cls = i % 2 == 0 ? "even" : "odd"
+    if version == "."
+      cls += " current"
+    end
+    res += template.gsub("!version!", version).gsub("!path!", "../" + version).gsub("!class!", cls).gsub("!sha!", sha)
   end
+  i += 1
+  cls = i % 2 == 0 ? "even" : "odd"
+  if version == "main"
+    cls += " current"
+  end
+  res += template.gsub("!version!", "main").gsub("!path!", "../main").gsub("!class!", cls).gsub("!sha!", "(Latest on GitHub)")
   File.write(dir + "/version_list.html", raw.gsub("<!--replace-->", res))
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: discorb
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - sevenc-nanashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-05 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.30.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.30.1
 - !ruby/object:Gem::Dependency
   name: async-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.56.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.56.5
 - !ruby/object:Gem::Dependency
   name: async-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +74,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build_main.yml"
 - ".gitignore"
 - ".yardopts"
 - Changelog.md
@@ -88,11 +89,23 @@ files:
 - discorb.gemspec
 - docs/Examples.md
 - docs/application_command.md
+- docs/assets/01_new_app.png
+- docs/assets/02_bot_name.png
+- docs/assets/03_add_bot.png
+- docs/assets/04_token_copy.png
+- docs/assets/05_oauth.png
+- docs/assets/06_online.png
+- docs/assets/07_hello_infinite.png
+- 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/run.md
+- docs/cli/setup.md
 - docs/events.md
 - docs/extension.md
+- docs/tutorial.md
 - docs/voice_events.md
 - examples/commands/bookmarker.rb
 - examples/commands/hello.rb
@@ -122,8 +135,11 @@ files:
 - lib/discorb/emoji_table.rb
 - lib/discorb/error.rb
 - lib/discorb/event.rb
+- lib/discorb/exe/about.rb
 - lib/discorb/exe/init.rb
 - lib/discorb/exe/irb.rb
+- lib/discorb/exe/run.rb
+- lib/discorb/exe/setup.rb
 - lib/discorb/exe/show.rb
 - lib/discorb/extend.rb
 - lib/discorb/extension.rb
@@ -145,6 +161,7 @@ files:
 - lib/discorb/modules.rb
 - lib/discorb/permission.rb
 - lib/discorb/presence.rb
+- lib/discorb/rate_limit.rb
 - lib/discorb/reaction.rb
 - lib/discorb/role.rb
 - lib/discorb/sticker.rb
@@ -167,7 +184,7 @@ 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://github.com/discorb-lib/discorb/blob/main/Changelog.md
+  changelog_uri: https://discorb-lib.github.io/file.Changelog.html
   documentation_uri: https://discorb-lib.github.io
 post_install_message:
 rdoc_options: []