discorb 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2d341757256d728ba6bb750b068a06f859e5d796d9e44bb1e4d616f4b439444
-  data.tar.gz: 3d4f6aaf740f8366a7f714011f60688871a9b4698bce9a37b6fd4c35cd31ab10
+  metadata.gz: eb2e5dd94a2bda9644a1a5679fdab3006bbdb1b10c8bf3780764b7fc115aa002
+  data.tar.gz: 4bfd645c6e39a4f3bd48ed2b2afaaccc8c2cf5702eb6dc675cfb01b17667b09f
 SHA512:
-  metadata.gz: dd2620d3de3cf9e1b024701a9312d63a0990ac5360c9b5e65d096cc3792dd81effb79b26577812e6ac229f155d53ccf4a8f5aa093103e56d05c677eb8904936b
-  data.tar.gz: a04ab3bb0982d21d0d40d132b0b217ee4b95b214c848d970229e8f66bf0a4d5e2d07dce2006822ab07954f5a0de343a7769b1e36181778ccd501e5a02b6456fb
+  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

@@ -202,4 +202,13 @@ end
 
 ## 0.7.6
 
-- Fix: Fix heartbeating error
+- 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/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.6"
+  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
 

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"
 
@@ -610,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
+          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)
@@ -1021,6 +1021,26 @@ 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
 
     #

data/lib/discorb/guild.rb

@@ -502,7 +502,6 @@ module Discorb
     # Fetch a member in the guild.
     # @macro async
     # @macro http
-    # @macro members_intent
     #
     # @param [#to_s] id The ID of the member to fetch.
     #
@@ -519,6 +518,39 @@ module Discorb
       end
     end
 
+    # Fetch members in the guild.
+    # @macro async
+    # @macro http
+    # @macro members_intent
+    #
+    # @param [Integer] limit The maximum number of members to fetch, 0 for all.
+    # @param [Integer] after The ID of the member to start fetching after.
+    #
+    # @return [Async::Task<Array<Discorb::Member>>] The list of members.
+    #
+    def fetch_members(limit: 0, after: nil)
+      Async do
+        unless limit == 0
+          _resp, data = @client.http.get("/guilds/#{@id}/members?#{URI.encode_www_form({ after: after, limit: limit })}").wait
+          next data[:members].map { |m| Member.new(@client, @id, m[:user], m) }
+        end
+        ret = []
+        after = 0
+        loop do
+          params = { after: after, limit: 100 }
+          _resp, data = @client.http.get("/guilds/#{@id}/members?#{URI.encode_www_form(params)}").wait
+          ret += data.map { |m| Member.new(@client, @id, m[:user], m) }
+          after = data.last[:user][:id]
+          if data.length != 1000
+            break
+          end
+        end
+        ret
+      end
+    end
+
+    alias fetch_member_list fetch_members
+
     #
     # Search for members by name in the guild.
     # @macro async

data/lib/discorb/http.rb

@@ -242,12 +242,13 @@ module Discorb
         else
           API_BASE_URL + path
         end
-      URI(full_path).path
+      uri = URI(full_path)
+      full_path.sub(uri.scheme + "://" + uri.host, "")
     end
 
     def get_response_data(resp)
-      if resp["Via"].nil?
-        raise CloudFlareBanError.new(@client, resp)
+      if resp["Via"].nil? && resp.code == "429"
+        raise CloudFlareBanError.new(resp, @client)
       end
       rd = resp.body
       if rd.nil? || rd.empty?

data/lib/discorb/intents.rb

@@ -82,7 +82,7 @@ module Discorb
       if @raw_value.key?(name)
         @raw_value[name]
       elsif name.end_with?("=") && @raw_value.key?(name[0..-2].to_sym)
-        raise ArgumentError, "true/false expected" if (!args.is_a? TrueClass) || args.is_a?(FalseClass)
+        raise ArgumentError, "true/false expected" unless args.is_a? TrueClass or args.is_a?(FalseClass)
 
         @raw_value[name[0..-2].to_sym] = args
       else
@@ -108,6 +108,10 @@ module Discorb
       "#<#{self.class} value=#{value}>"
     end
 
+    def to_h
+      @raw_value
+    end
+
     class << self
       # Create new intent object from raw value.
       # @param value [Integer] The value of the intent.
@@ -121,12 +125,12 @@ module Discorb
 
       # Create new intent object with default values.
       def default
-        from_value(32_509)
+        from_value(32509)
       end
 
       # Create new intent object with all intents.
       def all
-        from_value(32_767)
+        from_value(32767)
       end
 
       # Create new intent object with no intents.

data/po/yard.pot

@@ -203,7 +203,7 @@ msgid "client = Discorb::Client.new"
 msgstr ""
 
 #: ../README.md:35
-msgid "client.once :ready do\n"
+msgid "client.once :standby do\n"
 "  puts \"Logged in as #{client.user}\"\n"
 "end"
 msgstr ""