discorb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6281613f37f7da894dcdcb0df3070fd7c9efa685cf3a0412b6822fd60124cab9
-  data.tar.gz: b584a8ef44f9f18758c18a8a065c003cac6f54beadb8c3c29081cac7c98fa416
+  metadata.gz: 6bdf66383e4ecb0161c962e9621861a07f49c515ce7754c8f7b630a80acbf009
+  data.tar.gz: 7035f001fd4ffb4523f9ca5b64c9cda440bd3d7e755174264c9f9cd74f8928a1
 SHA512:
-  metadata.gz: 906cc3412b9cb6189947bf3446f3b9129b4665ec4247896f450f4e7bcbab3243764a246956180d5d9dc905ad86132fcadbea0659318d7fd47a30a47a4101f4f0
-  data.tar.gz: 3615cb4feb58e8c5e7c24999a6e6af7596645f3dbebcaafe658c5c0b7c50a9a5aca467160560c316a2a7fa51ab79b6f214da0590d937f0ed2899d9ee79210346
+  metadata.gz: e8101e84ffd48fdf3c20cbef1fe31365f0f606e05d6a031fe38a8810dd51dc5abbccf86416268a07a74b1a57e8623c2c888c9077973f3f44c7e5b15c8fa3aa0c
+  data.tar.gz: 39b55c52514f0c80149f7a4453ea489bd1fb9baf440cfb6fcecd1956d6837d3a666566edeecf2da35e254eab73a7e5c279c225b9937ee2259c1b605b6b94b549

data/Gemfile

@@ -8,7 +8,6 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "async"
-gem "async-http"
 gem "async-websocket"
 
 gem "mime-types", "~> 3.3"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    discorb (0.1.0)
+    discorb (0.2.0)
       async
       async-http
       async-websocket
@@ -57,7 +57,6 @@ PLATFORMS
 
 DEPENDENCIES
   async
-  async-http
   async-websocket
   discorb!
   mime-types (~> 3.3)

data/docs/discord_irb.md

@@ -0,0 +1,39 @@
+# @title discord-irb
+
+# discord-irb
+
+discord-irb is a command line tool for interacting with the Discord API.
+
+
+## Usage
+
+```
+$ bundle exec discord-irb
+```
+
+To start.
+
+### Load a token
+
+discord-irb will load a token from...
+1. the `DISCORD_BOT_TOKEN` environment variable
+2. the `DISCORD_TOKEN` environment variable
+3. `token` file in the current directory(customizable with `-f` option)
+4. your input
+
+### Arguments
+
+#### `-i`, `--intents`
+
+Intents to use.
+Specify intents with integers.
+
+#### `-t`, `--token-file`
+
+Token file to load.
+
+### Variables
+
+#### `message`
+
+Last message received.

data/docs/events.md

@@ -28,11 +28,11 @@ Fires when a event is received.
 |`event_name`| Symbol | The name of the event. |
 |`data`      | Hash   | The data of the event. |
 
-#### `ready(task)`
+#### `ready()`
 
 Fires when the client is ready.
 
-#### `resumed(task)`
+#### `resumed()`
 
 Fires when the client is resumed connection.
 

data/docs/extension.md

@@ -37,3 +37,17 @@ end
 ## Load extension
 
 Use {Client#extend} to load extension.
+
+## Access Client from extension
+
+You can access {Client} from extension with `@client`.
+
+```ruby
+module MyExtension
+  extend Discorb::Extension
+
+  event :ready do |message|
+    puts "Logged in as #{client.user}"
+  end
+end
+```

data/exe/discord-irb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+require "io/console"
+require "discorb"
+require "optparse"
+
+intents_value = Discorb::Intents.all.value
+token_file = "token"
+
+opt = OptionParser.new
+opt.on("-i", "--intents", "intents to use, default to all") { |v| intents_value = v }
+opt.on("-t", "--token-file", "token file to load, default to \"token\"") { |v| token_file = v }
+opt.parse(ARGV)
+
+client = Discorb::Client.new(intents: Discorb::Intents.from_value(intents_value))
+$messages = []
+
+client.on :ready do
+  puts "\e[96mLogged in as #{client.user}\e[m"
+
+  def message
+    $messages.last
+  end
+
+  def dirb_help
+    puts <<~EOS
+           \e[96mDiscord-IRB\e[m
+           This is a debug client for Discord.
+           \e[90mmessage\e[m to get latest message.
+
+           \e[36mhttps://rubydoc.info/gems/discorb/file/docs/discord_irb.md\e[m for more information.
+         EOS
+  end
+
+  puts <<~FIRST_MESSAGE
+         Running on \e[31mRuby #{RUBY_VERSION}\e[m, disco\e[31mrb #{Discorb::VERSION}\e[m
+         Type \e[90mdirb_help\e[m to help.
+       FIRST_MESSAGE
+
+  binding.irb
+
+  client.close!
+end
+
+client.on :message do |message|
+  $messages << message
+end
+
+token = ENV["DISCORD_BOT_TOKEN"] || ENV["DISCORD_TOKEN"]
+if token.nil?
+  if File.exists?(token_file)
+    token = File.read(token_file)
+  else
+    print "\e[90mToken?\e[m : "
+    token = $stdin.noecho(&:gets).chomp
+    puts
+  end
+end
+
+client.run token

data/lib/discorb/channel.rb

@@ -68,9 +68,9 @@ module Discorb
     end
 
     # @!visibility private
-    def base_url
+    def channel_id
       Async do
-        "/channels/#{@id}"
+        @id
       end
     end
 
@@ -1090,9 +1090,9 @@ module Discorb
     include Messageable
 
     # @!visibility private
-    def base_url
+    def channel_id
       Async do
-        "/channels/#{@id}"
+        @id
       end
     end
 

data/lib/discorb/client.rb

@@ -47,6 +47,8 @@ module Discorb
     #   @note This will be calculated from heartbeat and heartbeat_ack.
     # @return [nil] If not connected to the gateway.
     attr_reader :ping
+    # @return [:initialized, :running, :closed] The status of the client.
+    attr_reader :status
 
     #
     # Initializes a new client.
@@ -85,6 +87,7 @@ module Discorb
       @conditions = {}
       @commands = []
       @overwrite_application_commands = overwrite_application_commands
+      @status = :initialized
     end
 
     #
@@ -177,16 +180,6 @@ module Discorb
       end
     end
 
-    #
-    # Starts the client.
-    #
-    # @param [String] token The token to use.
-    #
-    def run(token)
-      @token = token.to_s
-      connect_gateway(true)
-    end
-
     #
     # Fetch user from ID.
     # @macro async
@@ -376,5 +369,37 @@ module Discorb
 
     include Discorb::Gateway::Handler
     include Discorb::Command::Handler
+
+    #
+    # Starts the client.
+    #
+    # @param [String] token The token to use.
+    #
+    def run(token)
+      Async do |task|
+        @token = token.to_s
+        @close_condition = Async::Condition.new
+        main_task = Async do
+          @status = :running
+          connect_gateway(true).wait
+        rescue
+          @status = :stopped
+          @close_condition.signal
+          raise
+        end
+        @close_condition.wait
+        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/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.1.0"
+  VERSION = "0.2.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/message.rb

@@ -213,6 +213,33 @@ module Discorb
       !@updated_at.nil?
     end
 
+    #
+    # Edit the message.
+    #
+    # @param [String] content The message content.
+    # @param [Discorb::Embed] embed The embed to send.
+    # @param [Array<Discord::Embed>] embeds The embeds to send.
+    # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions.
+    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
+    # @param [Boolean] supress Whether to supress embeds.
+    #
+    def edit(...)
+      Async do
+        channel.edit_message(@id, ...).wait
+      end
+    end
+
+    #
+    # Delete the message.
+    #
+    # @param [String] reason The reason for deleting the message.
+    #
+    def delete!(reason: nil)
+      Async do
+        channel.delete_message!(@id, reason: reason).wait
+      end
+    end
+
     #
     # Convert the message to reference object.
     #

data/lib/discorb/modules.rb

@@ -7,6 +7,8 @@ module Discorb
   module Messageable
     #
     # Post a message to the channel.
+    # @macro async
+    # @macro http
     #
     # @param [String] content The message content.
     # @param [Boolean] tts Whether the message is tts.
@@ -61,13 +63,82 @@ module Discorb
         else
           headers = {}
         end
-        _resp, data = @client.http.post("#{base_url.wait}/messages", payload, headers: headers).wait
+        _resp, data = @client.http.post("/channels/#{channel_id.wait}/messages", payload, headers: headers).wait
         Message.new(@client, data.merge({ guild_id: @guild_id.to_s }))
       end
     end
 
+    #
+    # Edit a message.
+    # @macro async
+    # @macro http
+    #
+    # @param [#to_s] message_id The message id.
+    # @param [String] content The message content.
+    # @param [Discorb::Embed] embed The embed to send.
+    # @param [Array<Discord::Embed>] embeds The embeds to send.
+    # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions.
+    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
+    # @param [Boolean] supress Whether to supress embeds.
+    #
+    def edit_message(message_id, content = nil, embed: nil, embeds: nil, allowed_mentions: nil,
+                                                components: nil, supress: nil)
+      Async do
+        payload = {}
+        payload[:content] = content if content
+        tmp_embed = if embed
+            [embed]
+          elsif embeds
+            embeds
+          end
+        payload[:embeds] = tmp_embed.map(&:to_hash) if tmp_embed
+        payload[:allowed_mentions] =
+          allowed_mentions ? allowed_mentions.to_hash(@client.allowed_mentions) : @client.allowed_mentions.to_hash
+        if components
+          tmp_components = []
+          tmp_row = []
+          components.each do |c|
+            case c
+            when Array
+              tmp_components << tmp_row
+              tmp_row = []
+              tmp_components << c
+            when SelectMenu
+              tmp_components << tmp_row
+              tmp_row = []
+              tmp_components << [c]
+            else
+              tmp_row << c
+            end
+          end
+          tmp_components << tmp_row
+          payload[:flags] = (supress ? 1 << 2 : 0) unless flags.nil?
+          payload[:components] = tmp_components.filter { |c| c.length.positive? }.map { |c| { type: 1, components: c.map(&:to_hash) } }
+        end
+        @client.http.patch("/channels/#{channel_id.wait}/messages/#{message_id}", payload).wait
+      end
+    end
+
+    #
+    # Delete a message.
+    # @macro async
+    # @macro http
+    #
+    # @param [#to_s] message_id The message id.
+    # @param [String] reason The reason for deleting the message.
+    #
+    def delete_message!(message_id, reason: nil)
+      Async do
+        @client.http.delete("/channels/#{channel_id.wait}/messages/#{message_id}", reason: reason).wait
+      end
+    end
+
+    alias destroy_message! delete_message!
+
     #
     # Fetch a message from ID.
+    # @macro async
+    # @macro http
     #
     # @param [Discorb::Snowflake] id The ID of the message.
     #
@@ -76,13 +147,15 @@ module Discorb
     #
     def fetch_message(id)
       Async do
-        _resp, data = @client.http.get("#{base_url.wait}/messages/#{id}").wait
+        _resp, data = @client.http.get("/channels/#{channel_id.wait}/messages/#{id}").wait
         Message.new(@client, data.merge({ guild_id: @guild_id.to_s }))
       end
     end
 
     #
     # Fetch a message history.
+    # @macro async
+    # @macro http
     #
     # @param [Integer] limit The number of messages to fetch.
     # @param [Discorb::Snowflake] before The ID of the message to fetch before.
@@ -99,7 +172,7 @@ module Discorb
           after: Discorb::Utils.try(around, :id),
           around: Discorb::Utils.try(before, :id),
         }.filter { |_k, v| !v.nil? }.to_h
-        _resp, messages = @client.http.get("#{base_url.wait}/messages?#{URI.encode_www_form(params)}").wait
+        _resp, messages = @client.http.get("/channels/#{channel_id.wait}/messages?#{URI.encode_www_form(params)}").wait
         messages.map { |m| Message.new(@client, m.merge({ guild_id: @guild_id.to_s })) }
       end
     end

data/lib/discorb/user.rb

@@ -74,13 +74,13 @@ module Discorb
     alias app_owner? bot_owner?
 
     # @!visibility private
-    def base_url
+    def channel_id
       Async do
         next @dm_channel_id if @dm_channel_id
 
         dm_channel = @client.http.post("/users/#{@id}/channels", { recipient_id: @client.user.id }).wait
         @dm_channel_id = dm_channel[:id]
-        "/channels/#{@dm_channel_id}"
+        @dm_channel_id
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discorb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - sevenc-nanashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-31 00:00:00.000000000 Z
+date: 2021-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -69,7 +69,8 @@ dependencies:
 description:
 email:
 - sevenc-nanashi@sevenbot.jp
-executables: []
+executables:
+- discord-irb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -86,6 +87,7 @@ files:
 - discorb.gemspec
 - docs/Examples.md
 - docs/application_command.md
+- docs/discord_irb.md
 - docs/events.md
 - docs/extension.md
 - docs/voice_events.md
@@ -100,6 +102,7 @@ files:
 - examples/simple/ping_pong.rb
 - examples/simple/rolepanel.rb
 - examples/simple/wait_for_message.rb
+- exe/discord-irb
 - lib/discorb.rb
 - lib/discorb/application.rb
 - lib/discorb/asset.rb