Merge pull request #350 from Droid00000/feat/bot-server-prperties

feat: per-server avatars, banners, and bio for bots

Author: swarley

lib/discordrb/api/server.rb

@@ -147,13 +147,13 @@ def update_member(token, server_id, user_id, nick: :undef, roles: :undef, mute:
 
   # Update the current member's properties.
   # https://discord.com/developers/docs/resources/guild#modify-current-member
-  def update_current_member(token, server_id, nick = :undef, reason = nil)
+  def update_current_member(token, server_id, nick = :undef, reason = nil, bio = :undef, banner = :undef, avatar = :undef)
     Discordrb::API.request(
       :guilds_sid_members_me,
       server_id,
       :patch,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/members/@me",
-      { nick: nick }.reject { |_, v| v == :undef }.to_json,
+      { nick: nick, bio: bio, banner: banner, avatar: avatar }.reject { |_, v| v == :undef }.to_json,
       Authorization: token,
       content_type: :json,
       'X-Audit-Log-Reason': reason

lib/discordrb/api/user.rb

@@ -43,15 +43,21 @@ def change_own_nickname(token, server_id, nick, reason = nil)
     )
   end
 
-  # Update user data
+  # @deprecated Please use {update_current_user} instead.
   # https://discord.com/developers/docs/resources/user#modify-current-user
-  def update_profile(token, email, password, new_username, avatar, new_password = nil)
+  def update_profile(token, _email, _password, new_username, avatar, _new_password = nil)
+    update_current_user(token, new_username, avatar)
+  end
+
+  # Update the properties of the user for the current bot.
+  # https://discord.com/developers/docs/resources/user#modify-current-user
+  def update_current_user(token, username = :undef, avatar = :undef, banner = :undef)
     Discordrb::API.request(
       :users_me,
       nil,
       :patch,
       "#{Discordrb::API.api_base}/users/@me",
-      { avatar: avatar, email: email, new_password: new_password, password: password, username: new_username }.to_json,
+      { username: username, avatar: avatar, banner: banner }.reject { |_, value| value == :undef }.to_json,
       Authorization: token,
       content_type: :json
     )
@@ -119,19 +125,6 @@ def connections(token)
     )
   end
 
-  # Change user status setting
-  def change_status_setting(token, status)
-    Discordrb::API.request(
-      :users_me_settings,
-      nil,
-      :patch,
-      "#{Discordrb::API.api_base}/users/@me/settings",
-      { status: status }.to_json,
-      Authorization: token,
-      content_type: :json
-    )
-  end
-
   # Returns one of the "default" discord avatars from the CDN given a discriminator or id since new usernames
   # TODO: Maybe change this method again after discriminator removal ?
   def default_avatar(discrim_id = 0, legacy: false)

lib/discordrb/data/member.rb

@@ -13,7 +13,8 @@ module MemberAttributes
       started_home_actions: 1 << 5,
       completed_home_actions: 1 << 6,
       automod_quarantined_username: 1 << 7,
-      dm_settings_upsell_acknowledged: 1 << 9
+      dm_settings_upsell_acknowledged: 1 << 9,
+      automod_quarantined_server_tag: 1 << 10
     }.freeze
 
     # @return [Time] when this member joined the server.
@@ -383,6 +384,30 @@ def flags=(flags)
       update_member_data(flags: flags)
     end
 
+    # Set the server banner for the current bot.
+    # @param banner [File, nil] A file like object that responds to read, or `nil`.
+    def server_banner=(banner)
+      raise 'Can only set a banner for the current bot' unless current_bot?
+
+      update_current_member_data(banner: banner.respond_to?(:read) ? Discordrb.encode64(banner) : banner)
+    end
+
+    # Set the server avatar for the current bot.
+    # @param avatar [File, nil] A file like object that responds to read, or `nil`.
+    def server_avatar=(avatar)
+      raise 'Can only set an avatar for the current bot' unless current_bot?
+
+      update_current_member_data(avatar: avatar.respond_to?(:read) ? Discordrb.encode64(avatar) : avatar)
+    end
+
+    # Set the server bio for the current bot.
+    # @param bio [String, nil] The new server bio for the bot, or nil.
+    def server_bio=(bio)
+      raise 'Can only set a bio for the current bot' unless current_bot?
+
+      update_current_member_data(bio: bio)
+    end
+
     # Update this member's roles
     # @note For internal use only.
     # @!visibility private
@@ -489,7 +514,10 @@ def update_member_data(new_data)
     def update_current_member_data(new_data)
       update_data(JSON.parse(API::Server.update_current_member(@bot.token, @server_id,
                                                                new_data.key?(:nick) ? new_data[:nick] : :undef,
-                                                               new_data[:reason])))
+                                                               new_data[:reason],
+                                                               new_data.key?(:bio) ? new_data[:bio] : :undef,
+                                                               new_data.key?(:banner) ? new_data[:banner] : :undef,
+                                                               new_data.key?(:avatar) ? new_data[:avatar] : :undef)))
     end
   end
 end

lib/discordrb/data/profile.rb

@@ -19,8 +19,8 @@ def username=(username)
     alias_method :name=, :username=
 
     # Changes the bot's avatar.
-    # @param avatar [String, #read] A JPG file to be used as the avatar, either
-    #  something readable (e.g. File Object) or as a data URL.
+    # @param avatar [String, File, #read, nil] A file to be used as the avatar, either
+    #  something readable (e.g. File Object) or a data URI.
     def avatar=(avatar)
       if avatar.respond_to?(:read)
         update_profile_data(avatar: Discordrb.encode64(avatar))
@@ -29,38 +29,24 @@ def avatar=(avatar)
       end
     end
 
+    # Changes the bot's banner.
+    # @param banner [String, File, #read, nil] A file to be used as the banner, either
+    #  something readable (e.g. File Object) or a data URI.
+    def banner=(banner)
+      if banner.respond_to?(:read)
+        update_profile_data(banner: Discordrb.encode64(banner))
+      else
+        update_profile_data(banner: banner)
+      end
+    end
+
     # Updates the cached profile data with the new one.
     # @note For internal use only.
     # @!visibility private
     def update_data(new_data)
-      @username = new_data[:username] || @username
-      @avatar_id = new_data[:avatar_id] || @avatar_id
-    end
-
-    # Sets the user status setting to Online.
-    # @note Only usable on User accounts.
-    def online
-      update_profile_status_setting('online')
-    end
-
-    # Sets the user status setting to Idle.
-    # @note Only usable on User accounts.
-    def idle
-      update_profile_status_setting('idle')
-    end
-
-    # Sets the user status setting to Do Not Disturb.
-    # @note Only usable on User accounts.
-    def dnd
-      update_profile_status_setting('dnd')
-    end
-
-    alias_method(:busy, :dnd)
-
-    # Sets the user status setting to Invisible.
-    # @note Only usable on User accounts.
-    def invisible
-      update_profile_status_setting('invisible')
+      @username = new_data['username']
+      @avatar_id = new_data['avatar']
+      @banner_id = new_data['banner']
     end
 
     # The inspect method is overwritten to give more useful output
@@ -70,17 +56,12 @@ def inspect
 
     private
 
-    # Internal handler for updating the user's status setting
-    def update_profile_status_setting(status)
-      API::User.change_status_setting(@bot.token, status)
-    end
-
+    # @!visibility private
     def update_profile_data(new_data)
-      API::User.update_profile(@bot.token,
-                               nil, nil,
-                               new_data[:username] || @username,
-                               new_data.key?(:avatar) ? new_data[:avatar] : @avatar_id)
-      update_data(new_data)
+      update_data(JSON.parse(API::User.update_current_user(@bot.token,
+                                                           new_data[:username] || :undef,
+                                                           new_data.key?(:avatar) ? new_data[:avatar] : :undef,
+                                                           new_data.key?(:banner) ? new_data[:banner] : :undef)))
     end
   end
 end