discorb 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b163ab1659df50cb3b66467a2a70077af84df29c378c339a1a6eb26a45a32b6
-  data.tar.gz: ab25ec2928e9030532e099caa3857ab4852ab3b79d4f9f558f10716e50ebc339
+  metadata.gz: eb2e5dd94a2bda9644a1a5679fdab3006bbdb1b10c8bf3780764b7fc115aa002
+  data.tar.gz: 4bfd645c6e39a4f3bd48ed2b2afaaccc8c2cf5702eb6dc675cfb01b17667b09f
 SHA512:
-  metadata.gz: f43efd7ef3eceddc1d116fd0e6be9655dc1fd489a6d9770411298a3f20f7d4c8f71811679cb865d2ef0baba9929c13b1d29d238b10ba448d440c626274547cce
-  data.tar.gz: e83240f9ce495140613a0777f3c9a5a5a12f35cd8a6c9b39f88f7c080f370af977812d8d7c2fda8acd2a0f62208fd238a101d91998a2e23a12ef18c39373b885
+  metadata.gz: 8c18b4e0b809e66350c952a8d50cb2e4f899e2844cd33b43bfd6120cc4560c6889e2cc8015fe9729ecb84c1af26a434ac566f69baa1a58cfcc5b6e2232b41151
+  data.tar.gz: de89179dffd53f575e148c2240d278eb101dde91f8f2288c9cefcae403eb4ce2f04547a030bebb3912d33df639e8e516c92878d6eb1fe1650cde8dc4c6903d25

data/.github/workflows/build_version.yml

@@ -0,0 +1,53 @@
+name: Build YARD by version
+
+on:
+  workflow_dispatch:
+  push:
+    tags: 
+      - "v*"
+jobs:
+  main:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.2
+          bundler-cache: true
+      - name: Set up git settings
+        run: |
+          git config --global user.email "action@github.com"
+          git config --global user.name "GitHub Action"
+      - name: Clone pages
+        env:
+          SSH_SECRET: ${{ secrets.SSH }}
+          GIT_SSH_COMMAND: ssh -i ~/ssh_secret
+        run: |
+          echo "$SSH_SECRET" > ~/ssh_secret
+          chmod 600 ~/ssh_secret
+          git clone git@github.com:discorb-lib/discorb-lib.github.io /tmp/pages
+      - name: Install dependencies
+        run: |
+          bundle config --local with 'docs'
+          bundle install
+      - name: Generate document
+        run: bundle exec rake document:build_all
+      - name: Push document
+        env:
+          SSH_SECRET: ${{ secrets.SSH }}
+          GIT_SSH_COMMAND: ssh -i ~/ssh_secret
+        run: |
+          echo "$SSH_SECRET" > ~/ssh_secret
+          chmod 600 ~/ssh_secret
+          cp -r ./doc/. /tmp/pages
+          cd /tmp/pages
+          git add -A
+          git commit -m "Update: Update document"
+          git update-ref -d refs/remotes/origin/user
+          git push origin main -f
+        continue-on-error: true

data/Changelog.md

@@ -177,4 +177,38 @@ end
 
 ## 0.7.1
 
-- Fix: Fix error of responding to interaction
+- Fix: Fix error of responding to interaction
+  
+## 0.7.2
+
+- Add: Add `Member#owner?`
+- Fix: Fix `Member#permissions`
+- Add: Add `Member#guild_permissions` as alias of `Member#permissions`
+- Add: Add default role to `Member#roles`
+- Fix: Fix error in `Integration#_set_data`
+- Change: Reverse `Member#roles`
+
+## 0.7.3
+
+- Add: Improve `discorb init`
+
+## 0.7.4 (yanked)
+
+- Fix: Fix disconnected client
+  
+## 0.7.5 (yanked)
+
+- Fix: Fix critical error
+
+## 0.7.6
+
+- Fix: Fix heartbeating error
+
+## 0.8.0
+
+- Add: Add `Guild#fetch_members`
+- Add: Add `Guild#fetch_member_list` as alias of `Guild#fetch_members`
+- Add: Add `Intents#to_h`
+- Add: Add `fetch_member` parameter to `Client#initialize`; Note you should set `false` if your bot doesn't have `GUILD_MEMBERS` intent
+- Change: Change `ready` to `standby` event
+- Change: `ready` will be fired when client receives `READY` event

data/README.md

@@ -35,7 +35,7 @@ require "discorb"
 
 client = Discorb::Client.new
 
-client.once :ready do
+client.once :standby do
   puts "Logged in as #{client.user}"
 end
 

data/docs/cli/init.md

@@ -32,6 +32,18 @@ If true, the command will initialize git and commit the initial files with commi
 Use `git commit --amend -m "..."` to change the commit message.
 Default to false.
 
+### `--[no-]desc`
+
+Whether to create a description file.
+If true, the command will create a `.env.sample` and `README.md` file.
+Default to false.
+
+### `-n` `--name`
+
+The name of the project.
+It will be used in the `README.md` file.
+Default to the directory name.
+
 ### `-t`, `--token`
 
 The name of token environment variable.
@@ -49,7 +61,9 @@ The following files will be created:
 | File | Description |
 | ---- | ----------- |
 | `.env` | Environment variables. |
+| `main.rb` | Main script. |
 | `.gitignore` | Git ignore file. Won't be created if `--git` is false. |
 | `Gemfile` | Gemfile. Won't be created if `--bundle` is false. |
 | `Gemfile.lock` | Gemfile lock file. Won't be created if `--bundle` is false. |
-| `main.rb` | Main script. |
+| `README.md` | Readme file. Won't be created if `--desc` is false. |
+| `.env.sample` | Sample environment variables. Won't be created if `--desc` is false. |

data/docs/events.md

@@ -22,7 +22,7 @@ Since v0.2.5, you can also register event handlers by adding a method to the cli
 client = Discorb::Client.new
 
 class << client
-  def on_ready
+  def on_standby
     puts "Ready!"
   end
 end
@@ -43,7 +43,7 @@ end
 ```
 
 This example will print `Override!`, but not `This event handler is overrideable!`.
-This is useful for registering event handlers for default behaviour on errors.
+This is useful for registering event handlers as default behaviour, such as error handlers.
 
 ```ruby
 # In the library...
@@ -55,7 +55,7 @@ end
 # In your code...
 
 client.on :command_error do |event, error|
-  event.message.reply "An error occurred while executing that command!\n#{error.full_message}"
+  event.message.reply "An error occurred while executing the command!\n#{error.full_message}"
 end
 ```
 
@@ -73,7 +73,11 @@ Fires when a event is received.
 
 #### `ready()`
 
-Fires when the client is ready.
+Fires when the client receives the `READY` event.
+
+#### `standby()`
+
+Fires when the client is standby. (When the client connects to Discord, and has cached guilds and members.)
 
 #### `resumed()`
 

data/docs/tutorial.md

@@ -101,7 +101,7 @@ Dotenv.load  # Loads .env file
 
 client = Discorb::Client.new  # Create client for connecting to Discord
 
-client.once :ready do
+client.once :standby do
   puts "Logged in as #{client.user}"  # Prints username of logged in user
 end
 

data/examples/commands/bookmarker.rb

@@ -3,7 +3,7 @@ require "json"
 
 client = Discorb::Client.new
 
-client.once :ready do
+client.once :standby do
   puts "Logged in as #{client.user}"
 end
 

data/examples/commands/inspect.rb

@@ -2,7 +2,7 @@ require "discorb"
 
 client = Discorb::Client.new
 
-client.once :ready do
+client.once :standby do
   puts "Logged in as #{client.user}"
 end
 

data/examples/components/authorization_button.rb

@@ -8,7 +8,7 @@ def convert_role(guild, string)
   end
 end
 
-client.once :ready do
+client.once :standby do
   puts "Logged in as #{client.user}"
 end
 

data/examples/components/select_menu.rb

@@ -32,7 +32,7 @@ SECTIONS = [
 
 WIKIPEDIA_CREDIT = "(From: [Wikipedia](https://en.wikipedia.org/wiki/Ruby_(programming_language)))"
 
-client.once :ready do
+client.once :standby do
   puts "Logged in as #{client.user}"
 end
 

data/examples/extension/main.rb

@@ -3,7 +3,7 @@ require_relative "message_expander"
 
 client = Discorb::Client.new
 
-client.once :ready do
+client.once :standby do
   puts "Logged in as #{client.user}"
 end
 

data/examples/simple/eval.rb

@@ -2,7 +2,7 @@ require "discorb"
 
 client = Discorb::Client.new
 
-client.once :ready do
+client.once :standby do
   puts "Logged in as #{client.user}"
 end
 

data/examples/simple/ping_pong.rb

@@ -2,7 +2,7 @@ require "discorb"
 
 client = Discorb::Client.new
 
-client.once :ready do
+client.once :standby do
   puts "Logged in as #{client.user}"
 end
 

data/examples/simple/rolepanel.rb

@@ -9,7 +9,7 @@ def convert_role(guild, string)
   end
 end
 
-client.once :ready do
+client.once :standby do
   puts "Logged in as #{client.user}"
 end
 

data/examples/simple/wait_for_message.rb

@@ -2,7 +2,7 @@ require "discorb"
 
 client = Discorb::Client.new
 
-client.once :ready do
+client.once :standby do
   puts "Logged in as #{client.user}"
 end
 

data/lib/discorb/client.rb

@@ -64,11 +64,13 @@ module Discorb
     # @param [Boolean] colorize_log Whether to colorize the log.
     # @param [:debug, :info, :warn, :error, :critical] log_level The log level.
     # @param [Boolean] wait_until_ready Whether to delay event dispatch until ready.
+    # @param [Boolean] fetch_member Whether to fetch member on ready. This may slow down the client.
+    #   Defaultly, it's `false` if {Discorb::Intents#members} is false. Otherwise, it's `true`.
     #
     def initialize(
       allowed_mentions: nil, intents: nil, message_caches: 1000,
       log: nil, colorize_log: false, log_level: :info,
-      wait_until_ready: true
+      wait_until_ready: true, fetch_member: nil
     )
       @allowed_mentions = allowed_mentions || AllowedMentions.new(everyone: true, roles: true, users: true)
       @intents = (intents or Intents.default)
@@ -91,6 +93,7 @@ module Discorb
       @commands = []
       @bottom_commands = []
       @status = :initialized
+      @fetch_member = fetch_member.nil? ? !(intents&.members) : fetch_member
       set_default_events
     end
 

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.7.1"
+  VERSION = "0.8.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/error.rb

@@ -92,10 +92,12 @@ module Discorb
     def initialize(resp, client)
       @client = client
       @client.close!
-      DiscorbError.instance_method(:initialize).bind(self).call(<<~MESSAGE)
+      message = <<~MESSAGE
         The client is banned from CloudFlare.
         Hint: Try to decrease the number of requests per second, e.g. Use sleep in between requests.
       MESSAGE
+      $stderr.puts message
+      DiscorbError.instance_method(:initialize).bind(self).call(message)
     end
   end
 

data/lib/discorb/exe/init.rb

@@ -16,7 +16,7 @@ FILES = {
 
     client = Discorb::Client.new  # Create client for connecting to Discord
 
-    client.once :ready do
+    client.once :standby do
       puts "Logged in as #{client.user}"  # Prints username of logged in user
     end
 
@@ -96,11 +96,46 @@ FILES = {
     gem "discorb", "~> #{Discorb::VERSION}"
     gem "dotenv", "~> 2.7"
   RUBY
+  ".env.sample" => <<~BASH,
+    %<token>s=
+  BASH
+  "README.md" => <<~MARKDOWN,
+    # %<name>s
+
+    Welcome to your bot: %<name>s!
+
+    TODO: Write your bot's description here.
+
+    ## Usage
+
+    TODO: Write your bot's usage here.
+
+    ## Features
+
+    TODO: Write your bot's features here.
+
+    ## How to host
+
+    1. Clone the repository.
+    2. Run `bundle install`.
+    3. Get your bot's token from the Discord developer portal.
+    4. Copy `.env.sample` to `.env` and fill in the token.
+    5. Run `bundle exec discorb run`.
+
+    TODO: Write your own customizations here.
+
+    ## License
+
+    TODO: Write your bot's license here.
+      See https://choosealicense.com/ for more information.
+      https://rubygems.org/gems/license-cli may be useful.
+
+  MARKDOWN
 }
 
 # @!visibility private
 def create_file(name)
-  File.write($path + "/#{name}", format(FILES[name], token: $values[:token]), mode: "wb")
+  File.write($path + "/#{name}", format(FILES[name], token: $values[:token], name: $values[:name]), mode: "wb")
 end
 
 # @!visibility private
@@ -132,6 +167,14 @@ def git_init
           " to change commit message of initial commit.\n"
 end
 
+# @!visibility private
+def make_descs
+  iputs "Making descriptions..."
+  create_file(".env.sample")
+  create_file("README.md")
+  sputs "Made descriptions.\n"
+end
+
 opt = OptionParser.new <<~BANNER
                          A tool to make a new project.
 
@@ -145,6 +188,8 @@ $values = {
   git: false,
   force: false,
   token: "TOKEN",
+  descs: false,
+  name: nil,
 }
 
 opt.on("--[no-]bundle", "Whether to use bundle. Default to true.") do |v|
@@ -155,10 +200,18 @@ opt.on("--[no-]git", "Whether to initialize git. Default to false.") do |v|
   $values[:git] = v
 end
 
+opt.on("--[no-]descs", "Whether to put some file for description. Default to false.") do |v|
+  $values[:descs] = v
+end
+
 opt.on("-t NAME", "--token NAME", "The name of token environment variable. Default to TOKEN.") do |v|
   $values[:token] = v
 end
 
+opt.on("-n NAME", "--name NAME", "The name of your project. Default to the directory name.") do |v|
+  $values[:name] = v
+end
+
 opt.on("-f", "--force", "Whether to force use directory. Default to false.") do |v|
   $values[:force] = v
 end
@@ -187,10 +240,14 @@ if (dir = ARGV[0])
   Dir.chdir($path)
 end
 
+$values[:name] ||= Dir.pwd.split("/").last
+
 bundle_init if $values[:bundle]
 
 make_files
 
 git_init if $values[:git]
 
+make_descs if $values[:descs]
+
 sputs "\nSuccessfully made a new project at \e[32m#{$path}\e[92m."

data/lib/discorb/exe/irb.rb

@@ -23,7 +23,7 @@ opt.parse!(ARGV)
 client = Discorb::Client.new(intents: Discorb::Intents.from_value(intents_value))
 $messages = []
 
-client.on :ready do
+client.on :standby do
   puts "\e[96mLogged in as #{client.user}\e[m"
 
   def message

data/lib/discorb/flag.rb

@@ -8,6 +8,7 @@ module Discorb
   class Flag
     # @return [Hash{Symbol => Boolean}] the values of the flag.
     attr_reader :values
+    alias to_h values
     # @return [Integer] the value of the flag.
     attr_reader :value
 

data/lib/discorb/gateway.rb

@@ -2,6 +2,8 @@
 
 require "async/http"
 require "async/websocket"
+require "async/barrier"
+require "async/semaphore"
 require "json"
 require "zlib"
 
@@ -488,7 +490,7 @@ module Discorb
           _, 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)
+                                                 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
@@ -510,7 +512,9 @@ module Discorb
               raise ClientError.new("Authentication failed."), cause: nil
             when "Discord WebSocket requesting client reconnect."
               @log.info "Discord WebSocket requesting client reconnect"
-              @tasks.map(&:stop)
+              connect_gateway(false)
+            else
+              @log.error "Discord WebSocket closed: #{e.message}"
               connect_gateway(false)
             end
           rescue EOFError, Async::Wrapper::Cancelled
@@ -579,15 +583,18 @@ module Discorb
         end
       end
 
-      def handle_heartbeat(interval)
+      def handle_heartbeat
         Async do |task|
+          interval = @heartbeat_interval
           sleep((interval / 1000.0 - 1) * rand)
           loop do
-            @heartbeat_before = Time.now.to_f
-            @connection.write({ op: 1, d: @last_s }.to_json)
-            @connection.flush
-            @log.debug "Sent opcode 1."
-            @log.debug "Waiting for heartbeat."
+            unless @connection.closed?
+              @heartbeat_before = Time.now.to_f
+              @connection.write({ op: 1, d: @last_s }.to_json)
+              @connection.flush
+              @log.debug "Sent opcode 1."
+              @log.debug "Waiting for heartbeat."
+            end
             sleep(interval / 1000.0 - 1)
           end
         end
@@ -605,19 +612,17 @@ module Discorb
           @user = ClientUser.new(self, data[:user])
           @uncached_guilds = data[:guilds].map { |g| g[:id] }
           if @uncached_guilds == [] or !@intents.guilds
-            @ready = true
-            dispatch(:ready)
-            @log.info("Successfully connected to Discord.")
+            ready
           end
-          @tasks << handle_heartbeat(@heartbeat_interval)
+          dispatch(:ready)
+          @tasks << handle_heartbeat
         when "GUILD_CREATE"
           if @uncached_guilds.include?(data[:id])
             Guild.new(self, data, true)
             @uncached_guilds.delete(data[:id])
             if @uncached_guilds == []
-              @ready = true
-              dispatch(:ready)
-              @log.info("Successfully connected to Discord, and cached all guilds.")
+              @log.debug "All guilds cached"
+              ready
             end
           elsif @guilds.has?(data[:id])
             @guilds[data[:id]].send(:_set_data, data)
@@ -839,12 +844,12 @@ module Discorb
           dispatch(:voice_state_update, old, current)
           if old&.channel != current&.channel
             dispatch(:voice_channel_update, old, current)
-            case [old&.channel, current&.channel]
-            in [nil, _]
+            case [old&.channel.nil?, current&.channel.nil?]
+            when [true, false]
               dispatch(:voice_channel_connect, current)
-            in [_, nil]
+            when [false, true]
               dispatch(:voice_channel_disconnect, old)
-            in _
+            when [false, false]
               dispatch(:voice_channel_move, old, current)
             end
           end
@@ -980,9 +985,9 @@ module Discorb
           dispatch(:reaction_add, ReactionEvent.new(self, data))
         when "MESSAGE_REACTION_REMOVE"
           if (target_message = @messages[data[:message_id]]) &&
-            (target_reaction = target_message.reactions.find do |r|
-              data[:emoji][:id].nil? ? r.emoji.name == data[:emoji][:name] : r.emoji.id == data[:emoji][:id]
-            end)
+             (target_reaction = target_message.reactions.find do |r|
+               data[:emoji][:id].nil? ? r.emoji.name == data[:emoji][:name] : r.emoji.id == data[:emoji][:id]
+             end)
             target_reaction.instance_variable_set(:@count, target_reaction.count - 1)
             target_message.reactions.delete(target_reaction) if target_reaction.count.zero?
           end
@@ -994,7 +999,7 @@ module Discorb
           dispatch(:reaction_remove_all, ReactionRemoveAllEvent.new(self, data))
         when "MESSAGE_REACTION_REMOVE_EMOJI"
           if (target_message = @messages[data[:message_id]]) &&
-            (target_reaction = target_message.reactions.find { |r| data[:emoji][:id].nil? ? r.name == data[:emoji][:name] : r.id == data[:emoji][:id] })
+             (target_reaction = target_message.reactions.find { |r| data[:emoji][:id].nil? ? r.name == data[:emoji][:name] : r.id == data[:emoji][:id] })
             target_message.reactions.delete(target_reaction)
           end
           dispatch(:reaction_remove_emoji, ReactionRemoveEmojiEvent.new(data))
@@ -1016,26 +1021,56 @@ module Discorb
           end
         end
       end
+
+      def ready
+        Async do
+          if @fetch_member
+            @log.debug "Fetching members"
+            barrier = Async::Barrier.new
+            semaphore = Async::Semaphore.new(@guilds.length)
+
+            @guilds.each do |guild|
+              semaphore.async(parent: barrier) do
+                guild.fetch_members
+              end
+            end
+            semaphore.__send__(:wait)
+          end
+          @ready = true
+          dispatch(:standby)
+          @log.info("Client is ready!")
+        end
+      end
     end
-    
+
     #
     # A class for connecting websocket with raw bytes data.
     # @private
     #
-    class RawConnection < Async::WebSocket::Connection		
-      def initialize(...)
+    class RawConnection < Async::WebSocket::Connection
+      def initialize(*, **)
+        super
+        @closed = false
+      end
+
+      def closed?
+        @closed
+      end
+
+      def close
         super
+        @closed = true
       end
-    
-			def parse(buffer)
-				# noop
+
+      def parse(buffer)
+        # noop
         buffer.to_s
-			end
-			
-			def dump(object)
-				# noop
+      end
+
+      def dump(object)
+        # noop
         object.to_s
-			end
+      end
     end
   end
-end
+end