discorb 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 810e9b14c77e49e9fca7afc4fe6b98389b26cb17dc1617213f38d7655b990a49
-  data.tar.gz: bbaa999265ac212f90ab60d57ec772fe7ade0e47f264a136130c679b85a46952
+  metadata.gz: 497fc76081f6183ccd3ec7c14768e80d81a172c092afa67f26bcec625f7b204f
+  data.tar.gz: 5d0d4070c729b2b63d6a746fa559900b2205d51f737105d8c8653c59eec01e97
 SHA512:
-  metadata.gz: 120828736edcf7eef9d78410914651edeb41ae85eadef012050b105b03c80f07f835d812105d3cfe954c7237e344b3bbc540af8840a7dde1a69f590b008a759e
-  data.tar.gz: f29b0399c65f180b05bf6c0c3d5f253689ff08c734f60ee7681b57c060d99e36dd85fc275f9652354933478b8139aa76c8ad854f6963fd1c074a8a260ffb6bde
+  metadata.gz: bf93daa59116cbd29d408e361b0cebf0e4b681c21eb2e07466f2ea2659f7bec959a58c4bf168c8b5058bb4221bb26352770c94e6bc61a9713a82d72bf98316e8
+  data.tar.gz: aa07fe600a6397f69584a33d4b79dfd2d64952c4c1fff83a08a84418e0547a78c9b2261fce7e96a46bf19d4dab9ff0972ebe09b2ddf59371d5d74a761282c45e

data/.github/workflows/build_version.yml

@@ -33,7 +33,7 @@ jobs:
           git clone git@github.com:discorb-lib/discorb-lib.github.io /tmp/pages
       - name: Install dependencies
         run: |
-          bundle config --local with 'docs development'
+          bundle config --local with 'docs development lint'
           bundle install
           gem update uri
       - name: Generate document

data/.github/workflows/lint-push.yml

@@ -1,6 +1,8 @@
 name: Lint with RuboCop
 on:
-  - push
+  push:
+    branches:
+      - main
 jobs:
   rubocop:
     runs-on: ubuntu-latest
@@ -15,4 +17,4 @@ jobs:
           gem install rubocop
       - name: Run rubocop
         run: |
-          rubocop lib
+          rubocop lib

data/Changelog.md

@@ -4,6 +4,15 @@
 
 # Changelog
 
+## v0.15
+
+### v0.15.0
+
+- Add: Migrate to API v10
+- Add: Add `TextChannel#threads`
+- Add: Support editing attachments
+- Delete!: Delete File class - Use Attachment class instead
+
 ## v0.14
 
 ### v0.14.0

data/docs/faq.md

@@ -62,19 +62,19 @@ client.on :ready do
 end
 ```
 
-### How can I send files?
+### How can I send attachments?
 
-Use {Discorb::File} class.
+Use {Discorb::Attachment} class.
 
 ```ruby
-# Send a file
-message.channel.post file: Discorb::File.new(File.open("./README.md"))
+# Send an attachment
+message.channel.post attachment: Discorb::Attachment.new(File.open("./README.md"))
 
-# Send some files with text
-message.channel.post "File!", files: [Discorb::File.new(File.open("./README.md")), Discorb::File.new(File.open("./License.txt"))]
+# Send some attachment with text
+message.channel.post "File!", attachments: [Discorb::Attachment.new("./README.md"), Discorb::Attachment.new(File.open("./License.txt"))]
 
-# Send a string as a file
-message.channel.post file: Discorb::File.from_string("Hello world!", "hello.txt")
+# Send a string as an attachment
+message.channel.post attachments: Discorb::Attachment.from_string("Hello world!", "hello.txt")
 ```
 
 ### How can I add reactions?

data/lib/discorb/{file.rb → attachment.rb}

@@ -7,15 +7,17 @@ module Discorb
   #
   # Represents a attachment file.
   #
-  class Attachment < DiscordModel
+  class Attachment
     # @return [#read] The file content.
     attr_reader :io
-    # @return [Discorb::Snowflake] The attachment id.
-    attr_reader :id
     # @return [String] The attachment filename.
     attr_reader :filename
     # @return [String] The attachment content type.
     attr_reader :content_type
+    # @return [String] The attachment description.
+    attr_reader :description
+    # @return [Discorb::Snowflake] The attachment id.
+    attr_reader :id
     # @return [Integer] The attachment size in bytes.
     attr_reader :size
     # @return [String] The attachment url.
@@ -28,12 +30,40 @@ module Discorb
     # @return [Integer] The image width.
     # @return [nil] If the attachment is not an image.
     attr_reader :width
+    # @return [:client, :discord] The attachment was created by.
+    attr_reader :created_by
+    # @private
+    attr_reader :will_close
 
     # @!attribute [r] image?
     #   @return [Boolean] whether the file is an image.
 
+    #
+    # Creates a new attachment.
+    #
+    # @param [#read, String] source The Source of the attachment.
+    # @param [String] filename The filename of the attachment. If not set, path or object_id of the IO is used.
+    # @param [String] description The description of the attachment.
+    # @param [String] content_type The content type of the attachment. If not set, it is guessed from the filename.
+    #   If failed to guess, it is set to `application/octet-stream`.
+    # @param [Boolean] will_close Whether the IO will be closed after the attachment is sent.
+    #
+    def initialize(source, filename = nil, description: nil, content_type: nil, will_close: true)
+      @io = if source.respond_to?(:read)
+          source
+        else
+          File.open(source, "rb")
+        end
+      @filename = filename || (@io.respond_to?(:path) ? @io.path : @io.object_id)
+      @description = description
+      @content_type = content_type || MIME::Types.type_for(@filename.to_s)[0].to_s
+      @content_type = "application/octet-stream" if @content_type == ""
+      @will_close = will_close
+      @created_by = :client
+    end
+
     # @private
-    def initialize(data)
+    def initialize_hash(data)
       @id = Snowflake.new(data[:id])
       @filename = data[:filename]
       @content_type = data[:content_type]
@@ -42,37 +72,18 @@ module Discorb
       @proxy_url = data[:proxy_url]
       @height = data[:height]
       @width = data[:width]
+      @created_by = :discord
     end
 
     def image?
       @content_type.start_with? "image/"
     end
-  end
 
-  #
-  # Represents a file to send as an attachment.
-  #
-  class File
-    # @return [#read] The IO of the file.
-    attr_accessor :io
-    # @return [String] The filename of the file. If not set, path or object_id of the IO is used.
-    attr_accessor :filename
-    # @return [String] The content type of the file. If not set, it is guessed from the filename.
-    attr_accessor :content_type
-
-    #
-    # Creates a new file from IO.
-    #
-    # @param [#read] io The IO of the file.
-    # @param [String] filename The filename of the file. If not set, path or object_id of the IO is used.
-    # @param [String] content_type The content type of the file. If not set, it is guessed from the filename.
-    #   If failed to guess, it is set to `application/octet-stream`.
-    #
-    def initialize(io, filename = nil, content_type: nil)
-      @io = io
-      @filename = filename || (io.respond_to?(:path) ? io.path : io.object_id)
-      @content_type = content_type || MIME::Types.type_for(@filename.to_s)[0].to_s
-      @content_type = "application/octet-stream" if @content_type == ""
+    # @private
+    def self.from_hash(data)
+      inst = allocate
+      inst.initialize_hash(data)
+      inst
     end
 
     #
@@ -84,14 +95,10 @@ module Discorb
     #
     # @return [File] The new file.
     #
-    def self.from_string(string, filename: nil, content_type: nil)
+    def self.from_string(string, filename = nil, content_type: nil, description: nil)
       io = StringIO.new(string)
       filename ||= string.object_id.to_s + ".txt"
-      new(io, filename, content_type: content_type)
-    end
-
-    def inspect
-      "#<#{self.class} filename=#{@filename} content_type=#{@content_type}>"
+      new(io, filename, content_type: content_type, description: description, will_close: true)
     end
   end
 end

data/lib/discorb/channel.rb

@@ -239,17 +239,15 @@ module Discorb
     # @return [Time] The time when the last pinned message was pinned.
     attr_reader :last_pin_timestamp
     alias last_pinned_at last_pin_timestamp
-    # @return [Array<Discorb::ThreadChannel>] The threads in the channel.
-    attr_reader :threads
 
     include Messageable
 
     @channel_type = 0
 
-    # @private
-    def initialize(client, data, no_cache: false)
-      super
-      @threads = Dictionary.new
+    # @!attribute [r] threads
+    #   @return [Array<Discorb::ThreadChannel>] The threads in the channel.
+    def threads
+      guild.threads.select { |thread| thread.parent == self }
     end
 
     #
@@ -829,8 +827,6 @@ module Discorb
     def initialize(client, data, no_cache: false)
       @members = Dictionary.new
       super
-      @client.channels[@parent_id].threads[@id] = self
-
       @client.channels[@id] = self unless no_cache
     end
 

data/lib/discorb/common.rb

@@ -2,9 +2,9 @@
 
 module Discorb
   # @return [String] The API base URL.
-  API_BASE_URL = "https://discord.com/api/v9"
+  API_BASE_URL = "https://discord.com/api/v10"
   # @return [String] The version of discorb.
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}".freeze
 

data/lib/discorb/embed.rb

@@ -45,37 +45,38 @@ module Discorb
     # @param [Discorb::Embed::Thumbnail, String] thumbnail The thumbnail of embed.
     #
     def initialize(title = nil, description = nil, color: nil, url: nil, timestamp: nil, author: nil,
-                                                   fields: nil, footer: nil, image: nil, thumbnail: nil, data: nil)
-      if data.nil?
-        @title = title
-        @description = description
-        @url = url
-        @timestamp = timestamp
-        @color = color
-        @author = author
-        @fields = fields || []
-        @footer = footer
-        @image = image && (image.is_a?(String) ? Image.new(image) : image)
-        @thumbnail = thumbnail && (thumbnail.is_a?(String) ? Thumbnail.new(thumbnail) : thumbnail)
-        @type = "rich"
-      else
-        @title = data[:title]
-        @description = data[:description]
-        @url = data[:url]
-        @timestamp = data[:timestamp] && Time.iso8601(data[:timestamp])
-        @type = data[:type]
-        @color = data[:color] && Color.new(data[:color])
-        @footer = data[:footer] && Footer.new(data[:footer][:text], icon: data[:footer][:icon_url])
-        @author = if data[:author]
-            Author.new(data[:author][:name], icon: data[:author][:icon_url],
-                                             url: data[:author][:url])
-          end
-        @thumbnail = data[:thumbnail] && Thumbnail.new(data[:thumbnail])
-        @image = data[:image] && Image.new(data[:image])
-        @video = data[:video] && Video.new(data[:video])
-        @provider = data[:provider] && Provider.new(data[:provider])
-        @fields = data[:fields] ? data[:fields].map { |f| Field.new(f[:name], f[:value], inline: f[:inline]) } : []
-      end
+                                                   fields: nil, footer: nil, image: nil, thumbnail: nil)
+      @title = title
+      @description = description
+      @url = url
+      @timestamp = timestamp
+      @color = color
+      @author = author
+      @fields = fields || []
+      @footer = footer
+      @image = image && (image.is_a?(String) ? Image.new(image) : image)
+      @thumbnail = thumbnail && (thumbnail.is_a?(String) ? Thumbnail.new(thumbnail) : thumbnail)
+      @type = "rich"
+    end
+
+    # @private
+    def initialize_hash(data)
+      @title = data[:title]
+      @description = data[:description]
+      @url = data[:url]
+      @timestamp = data[:timestamp] && Time.iso8601(data[:timestamp])
+      @type = data[:type]
+      @color = data[:color] && Color.new(data[:color])
+      @footer = data[:footer] && Footer.new(data[:footer][:text], icon: data[:footer][:icon_url])
+      @author = if data[:author]
+          Author.new(data[:author][:name], icon: data[:author][:icon_url],
+                                           url: data[:author][:url])
+        end
+      @thumbnail = data[:thumbnail] && Thumbnail.new(data[:thumbnail])
+      @image = data[:image] && Image.new(data[:image])
+      @video = data[:video] && Video.new(data[:video])
+      @provider = data[:provider] && Provider.new(data[:provider])
+      @fields = data[:fields] ? data[:fields].map { |f| Field.new(f[:name], f[:value], inline: f[:inline]) } : []
     end
 
     def image=(value)
@@ -111,6 +112,12 @@ module Discorb
       ret
     end
 
+    def self.from_hash(data)
+      inst = allocate
+      inst.initialize_hash(data)
+      inst
+    end
+
     #
     # Represents an author of embed.
     #

data/lib/discorb/gateway.rb

@@ -305,8 +305,8 @@ module Discorb
         @timestamp = Time.iso8601(data[:edited_timestamp])
         @mention_everyone = data[:mention_everyone]
         @mention_roles = data[:mention_roles].map { |r| guild.roles[r] } if data.key?(:mention_roles)
-        @attachments = data[:attachments].map { |a| Attachment.new(a) } if data.key?(:attachments)
-        @embeds = data[:embeds] ? data[:embeds].map { |e| Embed.new(data: e) } : [] if data.key?(:embeds)
+        @attachments = data[:attachments].map { |a| Attachment.from_hash(a) } if data.key?(:attachments)
+        @embeds = data[:embeds] ? data[:embeds].map { |e| Embed.from_hash(e) } : [] if data.key?(:embeds)
       end
 
       def channel
@@ -545,7 +545,13 @@ module Discorb
           @http = HTTP.new(self)
           _, gateway_response = @http.request(Route.new("/gateway", "//gateway", :get)).wait
           gateway_url = gateway_response[:url]
-          endpoint = Async::HTTP::Endpoint.parse("#{gateway_url}?v=9&encoding=json&compress=zlib-stream",
+          gateway_version = if @intents.to_h[:message_content].nil?
+              warn "message_content intent not set, using gateway version 9. You should specify `message_content` intent for preventing unexpected changes in the future."
+              9
+            else
+              10
+            end
+          endpoint = Async::HTTP::Endpoint.parse("#{gateway_url}?v=#{gateway_version}&encoding=json&compress=zlib-stream",
                                                  alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
           begin
             @connection = Async::WebSocket::Client.connect(endpoint, headers: [["User-Agent", Discorb::USER_AGENT]], handler: RawConnection)

data/lib/discorb/http.rb

@@ -70,12 +70,23 @@ module Discorb
         ]
         files&.each_with_index do |file, i|
           next if file.nil?
-          data << ["files[#{i}]", file.io, { filename: file.filename, content_type: file.content_type }]
+          if file.created_by == :discord
+            request_io = StringIO.new(
+              cdn_http.get(URI.parse(file.url).path, {
+                "Content-Type" => nil,
+                "User-Agent" => Discorb::USER_AGENT,
+              }).body
+            )
+            data << ["files[#{i}]", request_io, { filename: file.filename, content_type: file.content_type }]
+          else
+            data << ["files[#{i}]", file.io, { filename: file.filename, content_type: file.content_type }]
+          end
         end
         req.set_form(data, "multipart/form-data")
         session = Net::HTTP.new("discord.com", 443)
         session.use_ssl = true
         resp = session.request(req)
+        files&.then { _1.filter(&:will_close).each { |f| f.io.close } }
         data = get_response_data(resp)
         @ratelimit_handler.save(path, resp)
         handle_response(resp, data, path, body, headers, audit_log_reason, kwargs)
@@ -159,6 +170,12 @@ module Discorb
       https
     end
 
+    def cdn_http
+      https = Net::HTTP.new("cdn.discordapp.com", 443)
+      https.use_ssl = true
+      https
+    end
+
     def recr_utf8(data)
       case data
       when Hash

data/lib/discorb/intents.rb

@@ -19,6 +19,7 @@ module Discorb
       dm_messages: 1 << 12,
       dm_reactions: 1 << 13,
       dm_typing: 1 << 14,
+      message_content: 1 << 15,
       scheduled_events: 1 << 16,
     }.freeze
 
@@ -39,9 +40,13 @@ module Discorb
     # @param dm_messages [Boolean] Whether dm messages related events are enabled.
     # @param dm_reactions [Boolean] Whether dm reactions related events are enabled.
     # @param dm_typing [Boolean] Whether dm typing related events are enabled.
+    # @param message_content [Boolean] Whether message content will be sent with events.
     # @param scheduled_events [Boolean] Whether events related scheduled events are enabled.
     #
     # @note You must enable privileged intents to use `members` and/or `presences` intents.
+    # @note Message Content Intent is not required to use `message_content` intents for now,
+    #   this will be required in April 30, 2022. [Learn More](https://support-dev.discord.com/hc/en-us/articles/4404772028055).
+    #   You should specify `message_content` intent for preventing unexpected changes in the future.
     #
     def initialize(guilds: true,
                    members: false,
@@ -58,6 +63,7 @@ module Discorb
                    dm_messages: true,
                    dm_reactions: true,
                    dm_typing: true,
+                   message_content: nil,
                    scheduled_events: true)
       @raw_value = {
         guilds: guilds,
@@ -75,6 +81,7 @@ module Discorb
         dm_messages: dm_messages,
         dm_reactions: dm_reactions,
         dm_typing: dm_typing,
+        message_content: message_content,
         scheduled_events: scheduled_events,
       }
     end
@@ -129,9 +136,7 @@ module Discorb
 
       # Create new intent object with default values.
       # This will return intents without members and presence.
-      def default
-        from_value(@intent_bits.values.reduce(:+) - @intent_bits[:members] - @intent_bits[:presences])
-      end
+      alias default new
 
       # Create new intent object with all intents.
       def all

data/lib/discorb/message.rb

@@ -244,16 +244,17 @@ module Discorb
     # @param [Discorb::Embed] embed The embed to send.
     # @param [Array<Discorb::Embed>] embeds The embeds to send.
     # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions.
+    # @param [Array<Discorb::Attachment>] attachments The new attachments.
     # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
     # @param [Boolean] supress Whether to supress embeds.
     #
     # @return [Async::Task<void>] The task.
     #
-    def edit(content = nil, embed: nil, embeds: nil, allowed_mentions: nil,
-                            components: nil, supress: nil)
+    def edit(content = Discorb::Unset, embed: Discorb::Unset, embeds: Discorb::Unset, allowed_mentions: Discorb::Unset,
+                                       attachments: Discorb::Unset, components: Discorb::Unset, supress: Discorb::Unset)
       Async do
         channel.edit_message(@id, content, embed: embed, embeds: embeds, allowed_mentions: allowed_mentions,
-                                           components: components, supress: supress).wait
+                                           attachments: attachments, components: components, supress: supress).wait
       end
     end
 
@@ -445,6 +446,53 @@ module Discorb
       "#<#{self.class} #{@content.inspect} id=#{@id}>"
     end
 
+    # @private
+    def _set_data(data)
+      @id = Snowflake.new(data[:id])
+      @channel_id = data[:channel_id]
+
+      if data[:guild_id]
+        @guild_id = data[:guild_id]
+        @dm = nil
+      else
+        @dm = Discorb::DMChannel.new(@client, data[:channel_id])
+        @guild_id = nil
+      end
+
+      if data[:member].nil? && data[:webhook_id]
+        @webhook_id = Snowflake.new(data[:webhook_id])
+        @author = Webhook::Message::Author.new(data[:author])
+      elsif data[:guild_id].nil? || data[:guild_id].empty? || data[:member].nil?
+        @author = @client.users[data[:author][:id]] || User.new(@client, data[:author])
+      else
+        @author = guild&.members&.get(data[:author][:id]) || Member.new(@client,
+                                                                        @guild_id, data[:author], data[:member])
+      end
+      @content = data[:content]
+      @created_at = Time.iso8601(data[:timestamp])
+      @updated_at = data[:edited_timestamp].nil? ? nil : Time.iso8601(data[:edited_timestamp])
+
+      @tts = data[:tts]
+      @mention_everyone = data[:mention_everyone]
+      @mention_roles = data[:mention_roles].map { |r| guild.roles[r] }
+      @attachments = data[:attachments].map { |a| Attachment.from_hash(a) }
+      @embeds = data[:embeds] ? data[:embeds].map { |e| Embed.from_hash(e) } : []
+      @reactions = data[:reactions] ? data[:reactions].map { |r| Reaction.new(self, r) } : []
+      @pinned = data[:pinned]
+      @type = self.class.message_type[data[:type]]
+      @activity = data[:activity] && Activity.new(data[:activity])
+      @application_id = data[:application_id]
+      @message_reference = data[:message_reference] && Reference.from_hash(data[:message_reference])
+      @flag = Flag.new(0b111 - data[:flags])
+      @sticker_items = data[:sticker_items] ? data[:sticker_items].map { |s| Message::Sticker.new(s) } : []
+      # @referenced_message = data[:referenced_message] && Message.new(@client, data[:referenced_message])
+      @interaction = data[:interaction] && Message::Interaction.new(@client, data[:interaction])
+      @thread = data[:thread] && Channel.make_channel(@client, data[:thread])
+      @components = data[:components].map { |c| c[:components].map { |co| Component.from_hash(co) } }
+      @data.update(data)
+      @deleted = false
+    end
+
     class << self
       # @private
       attr_reader :message_type

data/lib/discorb/message_meta.rb

@@ -103,54 +103,6 @@ module Discorb
       end
     end
 
-    private
-
-    def _set_data(data)
-      @id = Snowflake.new(data[:id])
-      @channel_id = data[:channel_id]
-
-      if data[:guild_id]
-        @guild_id = data[:guild_id]
-        @dm = nil
-      else
-        @dm = Discorb::DMChannel.new(@client, data[:channel_id])
-        @guild_id = nil
-      end
-
-      if data[:member].nil? && data[:webhook_id]
-        @webhook_id = Snowflake.new(data[:webhook_id])
-        @author = Webhook::Message::Author.new(data[:author])
-      elsif data[:guild_id].nil? || data[:guild_id].empty? || data[:member].nil?
-        @author = @client.users[data[:author][:id]] || User.new(@client, data[:author])
-      else
-        @author = guild&.members&.get(data[:author][:id]) || Member.new(@client,
-                                                                        @guild_id, data[:author], data[:member])
-      end
-      @content = data[:content]
-      @created_at = Time.iso8601(data[:timestamp])
-      @updated_at = data[:edited_timestamp].nil? ? nil : Time.iso8601(data[:edited_timestamp])
-
-      @tts = data[:tts]
-      @mention_everyone = data[:mention_everyone]
-      @mention_roles = data[:mention_roles].map { |r| guild.roles[r] }
-      @attachments = data[:attachments].map { |a| Attachment.new(a) }
-      @embeds = data[:embeds] ? data[:embeds].map { |e| Embed.new(data: e) } : []
-      @reactions = data[:reactions] ? data[:reactions].map { |r| Reaction.new(self, r) } : []
-      @pinned = data[:pinned]
-      @type = self.class.message_type[data[:type]]
-      @activity = data[:activity] && Activity.new(data[:activity])
-      @application_id = data[:application_id]
-      @message_reference = data[:message_reference] && Reference.from_hash(data[:message_reference])
-      @flag = Flag.new(0b111 - data[:flags])
-      @sticker_items = data[:sticker_items] ? data[:sticker_items].map { |s| Message::Sticker.new(s) } : []
-      # @referenced_message = data[:referenced_message] && Message.new(@client, data[:referenced_message])
-      @interaction = data[:interaction] && Message::Interaction.new(@client, data[:interaction])
-      @thread = data[:thread] && Channel.make_channel(@client, data[:thread])
-      @components = data[:components].map { |c| c[:components].map { |co| Component.from_hash(co) } }
-      @data.update(data)
-      @deleted = false
-    end
-
     #
     # Represents a interaction of message.
     #