discorb 0.2.5 → 0.4.1

data/docs/cli/run.md

@@ -0,0 +1,46 @@
+# @title CLI: discorb run
+
+# discorb run
+
+This command will run a client.
+
+
+## Usage
+
+```
+discorb run [options] [script]
+```
+
+### Arguments
+
+#### `script`
+
+The script to run. Defaults to `main.rb`.
+
+#### `-d`, `--deamon`
+
+Run the client in deamon mode.
+
+#### `-l`, `--log-level`
+
+Specify the log level.
+Should be one of the following:
+
+* `none`
+* `debug`
+* `info`
+* `warn`
+* `error`
+* `fatal`
+
+#### `-f`, `--log-file`
+
+Specify the file to write logs to.
+You can use `stdout` to write to the standard output, and `stderr` to write to the standard error.
+
+#### `-c`, `--[no-]log-color`
+
+Whether to colorize the log output.
+If not specified, the default will be:
+- `true` if the file to write logs to is `stdout` or `stderr`.
+- `false` otherwise.

data/docs/cli/setup.md

@@ -0,0 +1,17 @@
+# @title CLI: discorb setup
+
+# discorb setup
+
+This command will setup application commands.
+
+## Usage
+
+```
+discorb setup [script]
+```
+
+### Arguments
+
+#### `script`
+
+The script to setup. Defaults to `main.rb`.

data/docs/cli.md

@@ -0,0 +1,25 @@
+# @title CLI tools
+
+# CLI tools
+
+discorb has a CLI tool for developing.
+
+## Usage
+
+```bash
+bundle exec discorb <command> ...
+```
+
+## Commands
+
+Currently, discorb has the following commands:
+
+| Command | Description |
+|---------|-------------|
+| {file:docs/cli/init.md `init`} | 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. |
+| `show` | Show your environment. (No document) |
+
+Click the command name to see the document.

data/exe/discorb

@@ -0,0 +1,31 @@
+#! /usr/bin/env ruby
+
+script = ARGV[0]
+
+if script.nil?
+  puts "\e[94mThis is a tool for discorb. Currently these tools are available:\e[m"
+
+  discorb_path = $:.find { |path| File.directory?(path + "/discorb") }
+  scripts = {}
+  Dir.glob(discorb_path + "/discorb/exe/*.rb") do |script|
+    name = File.basename(script, ".rb")
+    description = File.read(script).match(/# description: (.+)/)&.[](1) || "No description"
+    scripts[name] = description
+  end
+  max_length = scripts.keys.map { |key| key.length }.max
+  scripts.sort.each do |name, description|
+    puts "\e[90m#{name.rjust(max_length)}\e[m - #{description}"
+  end
+
+  puts "\e[94m\nTo run a tool, type:\e[m\n" +
+         "\e[34m  discorb [script]\e[m"
+
+  exit 1
+end
+
+begin
+  require "discorb/exe/#{script}"
+rescue LoadError
+  puts "\e[91mThis tool is not available: \e[90m#{script}\e[m"
+  exit 1
+end

data/lib/discorb/audit_logs.rb

@@ -279,6 +279,9 @@ module Discorb
           @new_value = data[:new_value].then(&method)
         end
 
+        #
+        # Send a message to the new value.
+        #
         def method_missing(method, ...)
           @new_value.__send__(method, ...)
         end

data/lib/discorb/client.rb

@@ -60,12 +60,11 @@ 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] overwrite_application_commands Whether to overwrite application commands on ready.
     #
     def initialize(
       allowed_mentions: nil, intents: nil, message_caches: 1000,
       log: nil, colorize_log: false, log_level: :info,
-      wait_until_ready: true, overwrite_application_commands: true
+      wait_until_ready: true
     )
       @allowed_mentions = allowed_mentions || AllowedMentions.new(everyone: true, roles: true, users: true)
       @intents = (intents or Intents.default)
@@ -86,7 +85,6 @@ module Discorb
       @tasks = []
       @conditions = {}
       @commands = []
-      @overwrite_application_commands = overwrite_application_commands
       @status = :initialized
     end
 
@@ -384,11 +382,69 @@ module Discorb
 
     #
     # Starts the client.
+    # @note This method behavior will change by CLI.
+    # @see file:docs/cli.md
     #
     # @param [String] token The token to use.
     #
     def run(token)
+      case ENV["DISCORB_CLI_FLAG"]
+      when nil
+        start_client(token)
+      when "run"
+        require "json"
+        options = JSON.parse(ENV["DISCORB_CLI_OPTIONS"], symbolize_names: true)
+        Process.daemon if options[:daemon]
+        setup_commands(token) if options[:setup]
+        if options[:log_level]
+          if options[:log_level] == "none"
+            @log.out = nil
+          else
+            @log.out = case options[:log_file]
+              when nil, "stderr"
+                $stderr
+              when "stdout"
+                $stdout
+              else
+                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
+          end
+        end
+        start_client(token)
+      when "setup_command"
+        setup_commands(token)
+      end
+    end
+
+    #
+    # Stops the client.
+    #
+    def close!
+      @connection.send_close
+      @tasks.each(&:stop)
+      @status = :closed
+      @close_condition.signal
+    end
+
+    private
+
+    def start_client(token)
       Async do |task|
+        trap(:SIGINT) {
+          @log.info "SIGINT received, closing..."
+          close!
+        }
         @token = token.to_s
         @close_condition = Async::Condition.new
         main_task = Async do
@@ -403,15 +459,5 @@ module Discorb
         main_task.stop
       end
     end
-
-    #
-    # Stops the client.
-    #
-    def close!
-      @connection.send_close
-      @tasks.each(&:stop)
-      @status = :closed
-      @close_condition.signal
-    end
   end
 end

data/lib/discorb/command.rb

@@ -92,7 +92,6 @@ module Discorb
 
       #
       # Setup commands.
-      # @note This method is called automatically if overwrite_application_commands is set to true.
       # @see Client#initialize
       #
       # @param [String] token Bot token.

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

data/lib/discorb/dictionary.rb

@@ -93,6 +93,9 @@ module Discorb
       !self[id].nil?
     end
 
+    #
+    # Send a message to the array of values.
+    #
     def method_missing(name, ...)
       if values.respond_to?(name)
         values.send(name, ...)

data/lib/discorb/error.rb

@@ -35,6 +35,7 @@ module Discorb
 
   #
   # Represents a HTTP error.
+  # @abstract
   #
   class HTTPError < DiscorbError
     # @return [String] the HTTP response code.
@@ -78,6 +79,20 @@ module Discorb
   class NotFoundError < HTTPError
   end
 
+  #
+  # Represents a error because of a cloudflare ban.
+  #
+  class CloudFlareBanError < HTTPError
+    def initialize(resp, client)
+      @client = client
+      @client.close!
+      DiscorbError.instance_method(:initialize).bind(self).call(<<~MESSAGE)
+        The client is banned from CloudFlare.
+        Hint: Try to increase the number of requests per second, e.g. Use sleep in between requests.
+      MESSAGE
+    end
+  end
+
   #
   # Represents a error in client-side.
   #

data/lib/discorb/exe/about.rb

@@ -0,0 +1,14 @@
+# description: Show information of discorb.
+
+puts "  disco\e[31mrb\e[m -  A new Discord API wrapper in Ruby.  \n\n"
+
+informations = {
+  "GitHub" => "https://github.com/discorb-lib/discorb",
+  "Documentation" => "https://discorb-lib.github.io",
+  "RubyGems" => "https://rubygems.org/gems/discorb",
+  "Changelog" => "https://discorb-lib.github.io/file.Changelog.html",
+}
+
+informations.each do |key, value|
+  puts "\e[90m#{key}:\e[m #{value}"
+end

data/lib/discorb/exe/init.rb

@@ -0,0 +1,195 @@
+# description: Make files for the discorb project.
+
+require "optparse"
+require_relative "../utils/colored_puts"
+
+$path = Dir.pwd
+
+# @!visibility private
+FILES = {
+  "main.rb" => <<~'RUBY',
+    require "discorb"
+    require "dotenv"
+
+    Dotenv.load
+
+    client = Discorb::Client.new
+
+    client.once :ready do
+      puts "Logged in as #{client.user}"
+    end
+
+    client.run ENV["%<token>s"]
+  RUBY
+  ".env" => <<~BASH,
+    %<token>s=Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng
+  BASH
+  ".gitignore" => <<~GITIGNORE,
+    *.gem
+    *.rbc
+    /.config
+    /coverage/
+    /InstalledFiles
+    /pkg/
+    /spec/reports/
+    /spec/examples.txt
+    /test/tmp/
+    /test/version_tmp/
+    /tmp/
+    
+    # Used by dotenv library to load environment variables.
+    .env
+    
+    # Ignore Byebug command history file.
+    .byebug_history
+    
+    ## Specific to RubyMotion:
+    .dat*
+    .repl_history
+    build/
+    *.bridgesupport
+    build-iPhoneOS/
+    build-iPhoneSimulator/
+    
+    ## Specific to RubyMotion (use of CocoaPods):
+    #
+    # We recommend against adding the Pods directory to your .gitignore. However
+    # you should judge for yourself, the pros and cons are mentioned at:
+    # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+    #
+    # vendor/Pods/
+    
+    ## Documentation cache and generated files:
+    /.yardoc/
+    /_yardoc/
+    /doc/
+    /rdoc/
+    
+    ## Environment normalization:
+    /.bundle/
+    /vendor/bundle
+    /lib/bundler/man/
+    
+    # for a library or gem, you might want to ignore these files since the code is
+    # intended to run in multiple environments; otherwise, check them in:
+    # Gemfile.lock
+    # .ruby-version
+    # .ruby-gemset
+    
+    # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+    .rvmrc
+    
+    # Used by RuboCop. Remote config files pulled in from inherit_from directive.
+    # .rubocop-https?--*
+
+    # This gitignore is from github/gitignore.
+    # https://github.com/github/gitignore/blob/master/Ruby.gitignore
+  GITIGNORE
+  "Gemfile" => <<~RUBY,
+    # frozen_string_literal: true
+
+    source "https://rubygems.org"
+
+    git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+    gem "discorb", "~> 0.2.5"
+    gem "dotenv", "~> 2.7"
+  RUBY
+}
+
+# @!visibility private
+def create_file(name)
+  File.write($path + "/#{name}", format(FILES[name], token: $values[:token]), mode: "wb")
+end
+
+# @!visibility private
+def make_files
+  iputs "Making files..."
+  create_file("main.rb")
+  create_file(".env")
+  sputs "Made files.\n"
+end
+
+# @!visibility private
+def bundle_init
+  iputs "Initializing bundle..."
+  create_file("Gemfile")
+  iputs "Installing gems..."
+  system "bundle install"
+  sputs "Installed gems.\n"
+end
+
+# @!visibility private
+def git_init
+  create_file(".gitignore")
+  iputs "Initializing git repository..."
+  system "git init"
+  system "git add ."
+  system "git commit -m \"Initial commit\""
+  sputs "Initialized repository, use " +
+          "\e[32mgit commit --amend -m '...'\e[92m" +
+          " to change commit message of initial commit.\n"
+end
+
+opt = OptionParser.new <<~BANNER
+                         A tool to make a new project.
+
+                         Usage: discorb init [options] [dir]
+
+                                   dir                        The directory to make the files in.
+                       BANNER
+
+$values = {
+  bundle: true,
+  git: true,
+  force: false,
+  token: "TOKEN",
+}
+
+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|
+  $values[:git] = 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("-f", "--force", "Whether to force use directory. Default to false.") do |v|
+  $values[:force] = v
+end
+
+ARGV.delete_at(0)
+
+opt.parse!(ARGV)
+
+if (dir = ARGV[0])
+  $path += "/#{dir}"
+  if Dir.exist?($path)
+    if Dir.empty?($path)
+      gputs "Found \e[30m#{dir}\e[90m and empty, using this directory."
+    else
+      if $values[:force]
+        gputs "Found \e[30m#{dir}\e[90m and not empty, but force is on, using this directory."
+      else
+        eputs "Directory \e[31m#{dir}\e[91m already exists and not empty. Use \e[31m-f\e[91m to force."
+        exit
+      end
+    end
+  else
+    Dir.mkdir($path)
+    gputs "Couldn't find \e[30m#{dir}\e[90m, created directory."
+  end
+  Dir.chdir($path)
+end
+
+bundle_init if $values[:bundle]
+
+make_files
+
+git_init if $values[:git]
+
+sputs "\nSuccessfully made a new project at \e[32m#{$path}\e[92m."