discorb 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7322e6131e0e5d070df790e4a4b7ea6ea6ea7a286c975b0732c0c7eff2e9903d
-  data.tar.gz: 045ef3ab63628e0e0fe867de4aef8b1f872076cd74912b38e035c8cb6907c731
+  metadata.gz: 26ef2cd9945ad11a9816b4ece328391c265b8f59f8b9a67e66326e21414f083c
+  data.tar.gz: 06662ff1518386e95e615afffc6b8338cb9e337bb0dc36c66f6d1d79fd7a01e8
 SHA512:
-  metadata.gz: f2b045e2b31b6a8fb95d74f87de931b30e67c8f34f647a0994b4feb4f3c3d8c270f2fddab03e995cce4eaf2f770d2698ae537e0e5d328152dc0244f3e6f5c59d
-  data.tar.gz: 3582014d604c85091c3c6180a13766ccab7dce8e0df0319278eb0d89e7cd0d0df2d236b3a58763cc55e5ccf80ef6c46317ad62028c30f0d89002bf48f1bc4b8b
+  metadata.gz: 83ddc5818285d4ed50e08998446a5fa9763cffe9c0a1992a70085af38a323e304851ca4dd77f43a8108e4ece850f097eaca9dc119b83c9bdb9a66e5c32b40f5a
+  data.tar.gz: 8a409f031d896344586bb2001019b9431299683a99df36f090f3a0da748d08bd6b4f2191c0a32823106d5b3b0cd6d22624106367d8e4adc400acf430ddb60370

data/.yardopts

@@ -3,6 +3,7 @@
 --markup markdown
 --tag flags:"Flags"
 --verbose
+--asset docs/assets:assets
 -
 docs/**/*.md
 Changelog.md

data/Changelog.md

@@ -98,4 +98,11 @@
   
 ## 0.4.2
 
-- Fix: Fix error in `discorb run`
+- Fix: Fix error in `discorb run`
+  
+## 0.5.0
+
+- Change: Use zlib stream instead
+- Add: Add tutorials
+- Add: Add ratelimit handler
+- Change: Make `--git` option in `discorb init` false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    discorb (0.4.2)
+    discorb (0.5.0)
       async (~> 1.30.1)
       async-http (~> 0.56.5)
       async-websocket (~> 0.19.0)

data/Rakefile

@@ -117,6 +117,7 @@ namespace :document do
       iputs "Replacing CRLF with LF"
       Dir.glob("doc/**/*.*") do |file|
         next unless File.file?(file)
+        next unless %w[html css js].include? file.split(".").last
 
         content = ""
         File.open(file, "rb") do |f|

data/docs/cli/init.md

@@ -30,7 +30,7 @@ Default to true.
 Whether to initialize git.
 If true, the command will initialize git and commit the initial files with commit message `Initial commit`.
 Use `git commit --amend -m "..."` to change the commit message.
-Default to true.
+Default to false.
 
 ### `-t`, `--token`
 

data/docs/cli.md

@@ -21,5 +21,6 @@ Currently, discorb has the following commands:
 | {file:docs/cli/run.md `run`} | Run a client. |
 | {file:docs/cli/setup.md `setup`} | Setup application commands. |
 | `show` | Show your environment. (No document) |
+| `about` | Show discorb's information. (No document) |
 
 Click the command name to see the document.

data/docs/tutorial.md

@@ -0,0 +1,194 @@
+# @title Tutorial
+
+# Tutorial
+
+Welcome to discorb! This lib allows you to create a discord bot with ease. So, let's get started!
+
+## Requirements
+
+- Ruby 3.0.0+
+- Basic knowledge of ruby  
+    These documents will help you:
+    - [Ruby in Twenty Minutes](https://www.ruby-lang.org/en/documentation/quickstart/)
+    - [Ruby from other languages](https://www.ruby-lang.org/en/documentation/ruby-from-other-languages/)
+    - [Try ruby!](https://try.ruby-lang.org/)
+
+### Recommended
+
+- Good editor  
+    They are recommended:
+    - [VSCode](https://code.visualstudio.com/)
+    - [Atom](https://atom.io/)
+    - [Sublime Text](https://www.sublimetext.com/)
+    - [Brackets](https://brackets.io/)
+    - [Notepad++](https://notepad-plus-plus.org/)
+- Git
+- Bundler
+
+Once you have all of these, you can start coding!
+
+## Start creating your bot
+
+### Create a Bot account
+
+You must have a bot account to use this lib. First, go to [Discord Developer Portal](https://discord.com/developers/applications) and click on `New Application`.  
+![](./assets/01_new_app.png)
+
+And then type a name for your bot, and click `Create`.  
+![](./assets/02_bot_name.png)
+
+You will be redirected to the `General Information` page.
+Then, click `Bot` and then `Add Bot` and then `Yes, do it!`.  
+![](./assets/03_add_bot.png)
+
+You will see bot information, and click `Copy` button in TOKEN section.  
+![](./assets/04_token_copy.png)
+
+**DO NOT SHARE THIS TOKEN, OR YOUR BOT BAN EVERYONE IN EVERY SERVER!**
+This is serious security risk.
+
+Click `Regenerate` button to regenerate your token. Do this immediately when you accidentally share your token.
+
+You did it! Now, you have a bot account.
+
+#### Invite your bot to a server
+
+Go to `OAuth2` page and scroll down, and check `bot` and `applications.commands` permissions.  
+![](./assets/05_oauth.png)
+Then, click `Copy` button and paste it to your browser.
+Choose a server you want to invite your bot to, and follow the instructions.
+
+### Code your bot
+
+#### Install gems
+
+Open terminal and type:
+
+```
+gem install bundler discorb
+```
+
+#### Setup files
+
+Create a new directory and go to it.
+Open terminal and type:
+
+```
+discorb init
+```
+
+Specify `--git` if you want to use git.
+
+You will get some files in your directory.
+
+- `main.rb`: The main file of your bot.
+- `.env`: The environment variables of your bot. **You must keep this file secret!**
+- `Gemfile`: Gemfile for bundler.
+- `Gemfile.lock`: Gemfile.lock for bundler.
+
+You will get other files if you specify `--git`.
+{file:docs/cli/init.md Learn more here}.
+
+#### Start your bot
+
+Open `main.rb`, you will see the following code:
+
+```ruby
+require "discorb"
+require "dotenv"
+
+Dotenv.load  # Loads .env file
+
+client = Discorb::Client.new  # Create client for connecting to Discord
+
+client.once :ready do
+  puts "Logged in as #{client.user}"  # Prints username of logged in user
+end
+
+client.run ENV["TOKEN"]  # Starts client
+```
+
+Open `.env`, you will see:
+
+```
+TOKEN=Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng
+```
+
+Replace `Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng` with your bot token.
+Remember to keep this file secret!
+
+Open terminal and type:
+
+```sh
+bundle exec ruby main.rb
+# or
+bundle exec discorb run main.rb
+```
+
+Yay! Your bot is online!  
+![](./assets/06_online.png)
+
+But your bot won't do anything.
+So add your bot some greetings!
+`Ctrl + C` to stop your bot.
+
+#### Add a greeting
+
+You can do some action on message by typing like this:
+
+```ruby
+client.on :message do |message|
+  # ...
+end
+```
+
+`message` is a {Discorb::Message} object. It contains information about the message.
+You can get the message content by {Discorb::Message#content}.
+Add `if` statement, and reply to the message with {Discorb::Message#reply}.
+
+```ruby
+client.on :message do |message|
+  if message.content.downcase.include? "hello"
+    message.reply "Hello!"
+  end
+end
+```
+
+Save your bot and restart it.
+
+You can see your bot's response by typing `hello` in your server...  
+
+![](./assets/07_hello_infinite.png)
+
+Oh no! Your bot is responding to bot's messages, and it doesn't stop!
+
+Terminate your bot by typing `Ctrl + C` in terminal.
+
+#### Ignore bot's messages
+
+You can access author information by {Discorb::Message#author}, and it has {Discorb::User#bot?}.
+So, you can ignore bot's messages by adding `if` statement:
+
+```ruby
+client.on :message do |message|
+  next if message.author.bot?
+
+  # ...
+end
+```
+
+Note you must use `next` to exit the block.
+
+Save your bot and start it.
+
+![](./assets/08_hello_once.png)
+
+You did it! Your bot won't respond to bot's messages anymore.
+
+## Finally
+
+This is the end of tutorial.
+
+To learn more, check out the [documentation](https://discorb-lib.github.io/).
+
+We hope you enjoy this lib! Thanks for reading!

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.4.2"
+  VERSION = "0.5.0"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://github.com/discorb-lib/discorb #{VERSION}) Ruby/#{RUBY_VERSION}"
 

data/lib/discorb/exe/about.rb

@@ -7,6 +7,7 @@ informations = {
   "Documentation" => "https://discorb-lib.github.io",
   "RubyGems" => "https://rubygems.org/gems/discorb",
   "Changelog" => "https://discorb-lib.github.io/file.Changelog.html",
+  "License" => "MIT License",
 }
 
 informations.each do |key, value|

data/lib/discorb/exe/init.rb

@@ -1,6 +1,7 @@
 # description: Make files for the discorb project.
 
 require "optparse"
+require "discorb"
 require_relative "../utils/colored_puts"
 
 $path = Dir.pwd
@@ -11,15 +12,15 @@ FILES = {
     require "discorb"
     require "dotenv"
 
-    Dotenv.load
+    Dotenv.load  # Loads .env file
 
-    client = Discorb::Client.new
+    client = Discorb::Client.new  # Create client for connecting to Discord
 
     client.once :ready do
-      puts "Logged in as #{client.user}"
+      puts "Logged in as #{client.user}"  # Prints username of logged in user
     end
 
-    client.run ENV["%<token>s"]
+    client.run ENV["%<token>s"]  # Starts client
   RUBY
   ".env" => <<~BASH,
     %<token>s=Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng
@@ -90,9 +91,9 @@ FILES = {
 
     source "https://rubygems.org"
 
-    git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+    git_source(:github) { |repo_name| "https://github.com/\#{repo_name}" }
 
-    gem "discorb", "~> 0.2.5"
+    gem "discorb", "~> #{Discorb::VERSION}"
     gem "dotenv", "~> 2.7"
   RUBY
 }
@@ -141,7 +142,7 @@ opt = OptionParser.new <<~BANNER
 
 $values = {
   bundle: true,
-  git: true,
+  git: false,
   force: false,
   token: "TOKEN",
 }
@@ -150,7 +151,7 @@ opt.on("--[no-]bundle", "Whether to use bundle. Default to true.") do |v|
   $values[:bundle] = v
 end
 
-opt.on("--[no-]git", "Whether to initialize git. Default to true.") do |v|
+opt.on("--[no-]git", "Whether to initialize git. Default to false.") do |v|
   $values[:git] = v
 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."
@@ -973,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,8 +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)
         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])
@@ -60,8 +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)
         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
@@ -88,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
@@ -121,8 +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)
         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
@@ -148,8 +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))
         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

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] +

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discorb
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - sevenc-nanashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -89,6 +89,15 @@ 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
@@ -96,6 +105,7 @@ files:
 - 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
@@ -151,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