discorb 0.0.1

data/lib/discorb/reaction.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # Represents a reaction to a message.
+  #
+  class Reaction < DiscordModel
+    # @return [Integer] The number of users that have reacted with this emoji.
+    attr_reader :count
+    # @return [Discorb::Emoji] The emoji that was reacted with.
+    attr_reader :emoji
+    # @return [Discorb::Message] The message that this reaction is on.
+    attr_reader :message
+    # @return [Boolean] Whether client user reacted with this emoji.
+    attr_reader :me
+    alias me? me
+    alias reacted? me
+
+    # @!visibility private
+    def initialize(message, data)
+      @message = message
+      _set_data(data)
+    end
+
+    #
+    # Fetch the user that reacted with this emoji.
+    #
+    # @param (see Message#fetch_reacted_users)
+    #
+    # @return [Array<Discorb::User>] The users that reacted with this emoji.
+    #
+    def fetch_users(...)
+      message.fetch_reacted_users(@emoji, ...)
+    end
+
+    private
+
+    def _set_data(data)
+      @count = data[:count]
+      @me = data[:me]
+      @emoji = if data[:emoji][:id].nil?
+          UnicodeEmoji.new(data[:emoji][:name])
+        else
+          PartialEmoji.new(data[:emoji])
+        end
+    end
+  end
+end

data/lib/discorb/role.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # Represents a role in the guild.
+  #
+  class Role < DiscordModel
+    # @return [Discorb::Snowflake] The ID of the role.
+    attr_reader :id
+    # @return [String] The name of the role.
+    attr_reader :name
+    # @return [Discorb::Color] The color of the role.
+    attr_reader :color
+    # @return [Discorb::Permission] The permissions of the role.
+    attr_reader :permissions
+    # @return [Integer] The position of the role.
+    attr_reader :position
+    # @return [Discorb::Guild] The guild this role belongs to.
+    attr_reader :guild
+    # @return [Boolean] Whether the role is hoisted.
+    attr_reader :hoist
+    alias hoist? hoist
+    # @return [Boolean] Whether the role is managed.
+    attr_reader :managed
+    alias managed? managed
+    # @return [Boolean] Whether the role is a default role.
+    attr_reader :mentionable
+    alias mentionable? mentionable
+
+    # @!attribute [r] mention
+    #   @return [String] The mention of the role.
+    # @!attribute [r] color?
+    #   @return [Boolean] Whether the role has a color.
+    # @!attribute [r] tag
+    #   @return [Discorb::Role::Tag] The tag of the role.
+
+    include Comparable
+
+    # @!visibility private
+    def initialize(client, guild, data)
+      @client = client
+      @guild = guild
+      @data = {}
+      _set_data(data)
+    end
+
+    #
+    # Compares two roles by their position.
+    #
+    # @param [Discorb::Role] other The role to compare to.
+    #
+    # @return [Integer] -1 if the other role is higher, 0 if they are equal, 1 if the other role is lower.
+    #
+    def <=>(other)
+      return false unless other.is_a?(Role)
+
+      @position <=> other.position
+    end
+
+    #
+    # Formats the role as a string.
+    #
+    # @return [String] The formatted string.
+    #
+    def to_s
+      "@#{@name}"
+    end
+
+    def mention
+      "<@&#{@id}>"
+    end
+
+    def color?
+      @color != 0
+    end
+
+    def inspect
+      "#<#{self.class} @#{@name} id=#{@id}>"
+    end
+
+    #
+    # Moves the role to a new position.
+    # @macro async
+    # @macro http
+    #
+    # @param [Integer] position The new position.
+    # @param [String] reason The reason for moving the role.
+    #
+    def move(position, reason: nil)
+      Async do
+        @client.internet.patch("/guilds/#{@guild_id}/roles", { id: @id, position: position }, reason: reason).wait
+      end
+    end
+
+    #
+    # Edits the role.
+    # @macro async
+    # @macro http
+    # @macro edit
+    #
+    # @param [String] name The new name of the role.
+    # @param [Integer] position The new position of the role.
+    # @param [Discorb::Color] color The new color of the role.
+    # @param [Boolean] hoist Whether the role should be hoisted.
+    # @param [Boolean] mentionable Whether the role should be mentionable.
+    # @param [String] reason The reason for editing the role.
+    #
+    def edit(name: :unset, position: :unset, color: :unset, hoist: :unset, mentionable: :unset, reason: nil)
+      Async do
+        payload = {}
+        payload[:name] = name if name != :unset
+        payload[:position] = position if position != :unset
+        payload[:color] = color.to_i if color != :unset
+        payload[:hoist] = hoist if hoist != :unset
+        payload[:mentionable] = mentionable if mentionable != :unset
+        @client.internet.patch("/guilds/#{@guild_id}/roles/#{@id}", payload, reason: reason).wait
+      end
+    end
+
+    alias modify edit
+
+    #
+    # Deletes the role.
+    #
+    # @param [String] reason The reason for deleting the role.
+    #
+    def delete!(reason: nil)
+      Async do
+        @client.internet.delete("/guilds/#{@guild_id}/roles/#{@id}", reason: reason).wait
+      end
+    end
+
+    alias destroy! delete!
+
+    def tag
+      Tag.new(@tags)
+    end
+
+    alias tags tag
+
+    #
+    # Represents a tag of a role.
+    #
+    class Tag < DiscordModel
+      # @return [Discorb::Snowflake] The ID of the bot that owns the role.
+      attr_reader :bot_id
+      # @return [Discorb::Snowflake] The ID of the integration.
+      attr_reader :integration_id
+      # @return [Boolean] Whether the tag is a premium subscriber role.
+      attr_reader :premium_subscriber
+      alias premium_subscriber? premium_subscriber
+      # @!attribute [r] bot?
+      #   @return [Boolean] Whether the role is a bot role.
+      # @!attribute [r] integration?
+      #   @return [Boolean] Whether the role is an integration role.
+
+      # @!visibility private
+      def initialize(data)
+        @bot_id = Snowflake.new(data[:bot_id])
+        @integration_id = Snowflake.new(data[:integration_id])
+        @premium_subscriber = data.key?(:premium_subscriber)
+      end
+
+      def bot?
+        !@bot_id.nil?
+      end
+
+      def integration?
+        !@integration_id.nil?
+      end
+    end
+
+    private
+
+    def _set_data(data)
+      @id = Snowflake.new(data[:id])
+      @name = data[:name]
+      @color = Color.new(data[:color])
+      @hoist = data[:hoist]
+      @position = data[:position]
+      @permissions = Permission.new(data[:permissions].to_i)
+      @managed = data[:managed]
+      @mentionable = data[:mentionable]
+      @tags = data[:tags] || {}
+      @guild.roles[@id] = self unless data[:no_cache]
+      @data.update(data)
+    end
+  end
+end

data/lib/discorb/sticker.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # Represents a sticker.
+  #
+  class Sticker < DiscordModel
+    # @return [Discorb::Snowflake] The ID of the sticker.
+    attr_reader :id
+    # @return [String] The name of the sticker.
+    attr_reader :name
+    # @return [Array<String>] The tags of the sticker.
+    attr_reader :tags
+    # @return [:official, :guild] The type of sticker.
+    attr_reader :type
+    # @return [:png, :apng, :lottie] The format of the sticker.
+    attr_reader :format
+    # @return [String] The URL of the sticker.
+    attr_reader :description
+    # @return [Discorb::Sticker] The ID of the sticker pack.
+    attr_reader :pack_id
+    # @return [Integer] The sort value of the sticker.
+    attr_reader :sort_value
+    # @return [Discorb::Snowflake] The ID of the guild the sticker is in.
+    attr_reader :guild_id
+    # @return [Discorb::User] The user who created the sticker.
+    attr_reader :user
+    # @return [Boolean] Whether the sticker is available.
+    attr_reader :available
+    alias available? available
+
+    @sticker_type = {
+      1 => :official,
+      2 => :guild,
+    }.freeze
+    @sticker_format = {
+      1 => :png,
+      2 => :apng,
+      3 => :lottie,
+    }
+    # @!visibility private
+    def initialize(client, data)
+      @client = client
+      _set_data(data)
+    end
+
+    #
+    # Represents a sticker of guilds.
+    #
+    class GuildSticker < Sticker
+      # @!attribute [r] guild
+      #   @macro client_cache
+      #   @return [Discorb::Guild] The guild the sticker is in.
+
+      def guild
+        @client.guilds[@guild_id]
+      end
+
+      #
+      # Edits the sticker.
+      # @macro async
+      # @macro http
+      # @macro edit
+      #
+      # @param [String] name The new name of the sticker.
+      # @param [String] description The new description of the sticker.
+      # @param [Discorb::Emoji] tag The new tags of the sticker.
+      # @param [String] reason The reason for the edit.
+      #
+      def edit(name: :unset, description: :unset, tag: :unset, reason: :unset)
+        Async do
+          payload = {}
+          payload[:name] = name unless name == :unset
+          payload[:description] = description unless description == :unset
+          payload[:tags] = tag.name unless tag == :unset
+          @client.internet.patch("/guilds/#{@guild_id}/stickers/#{@id}", payload, audit_log_reason: reason).wait
+        end
+      end
+
+      alias modify edit
+
+      #
+      # Deletes the sticker.
+      # @macro async
+      # @macro http
+      #
+      # @param [String] reason The reason for the deletion.
+      #
+      def delete!(reason: nil)
+        Async do
+          @client.internet.delete("/guilds/#{@guild_id}/stickers/#{@id}", audit_log_reason: reason).wait
+        end
+      end
+
+      alias destroy! delete!
+    end
+
+    #
+    # Represents a sticker pack.
+    #
+    class Pack < DiscordModel
+      # @return [Discorb::Snowflake] The ID of the sticker pack.
+      attr_reader :id
+      # @return [String] The name of the sticker pack.
+      attr_reader :name
+      # @return [Discorb::Snowflake] The ID of the SKU.
+      attr_reader :sku_id
+      # @return [Discorb::Snowflake] The cover sticker of the pack.
+      attr_reader :cover_sticker_id
+      # @return [String] The description of the pack.
+      attr_reader :description
+      # @return [Discorb::Store::SKU] The banner asset ID of the pack.
+      attr_reader :banner_asset_id
+      # @return [Array<Discorb::Sticker>] The stickers in the pack.
+      attr_reader :stickers
+      # @return [Discorb::Asset] The banner of the pack.
+      attr_reader :banner
+
+      # @!visibility private
+      def initialize(client, data)
+        @client = client
+        @id = Snowflake.new(data[:id])
+        @name = data[:name]
+        @sku_id = Snowflake.new(data[:sku_id])
+        @cover_sticker_id = Snowflake.new(data[:cover_sticker_id])
+        @description = data[:description]
+        @banner_asset_id = Snowflake.new(data[:banner_asset_id])
+        @banner = Asset.new(self, data[:banner_asset_id], path: "app-assets/710982414301790216/store")
+        @stickers = data[:stickers].map { |s| Sticker.new(@client, s) }
+      end
+    end
+
+    private
+
+    def _set_data(data)
+      @id = Snowflake.new(data[:id])
+      @name = data[:name]
+      @tags = data[:tags].split(",")
+      @type = self.class.sticker_type[data[:type]]
+      @format = self.class.sticker_format[data[:format]]
+      @description = data[:description]
+      @available = data[:available]
+      if @type == :official
+        @pack_id = Snowflake.new(data[:guild_id])
+        @sort_value = data[:sort_value]
+      else
+        @guild_id = Snowflake.new(data[:guild_id])
+        @user = data[:user] && (@client.users[data[:user][:id]] || User.new(@client, data[:user]))
+      end
+    end
+
+    class << self
+      # @!visibility private
+      attr_reader :sticker_type, :sticker_format
+    end
+  end
+end

data/lib/discorb/user.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # Represents a user of discord.
+  #
+  class User < DiscordModel
+    # @return [Boolean] Whether the user is verified.
+    attr_reader :verified
+    # @return [String] The user's username.
+    attr_reader :username
+    alias name username
+    # @return [Discorb::Snowflake] The user's ID.
+    attr_reader :id
+    # @return [Discorb::User::Flag] The user's flags.
+    attr_reader :flag
+    # @return [String] The user's discriminator.
+    attr_reader :discriminator
+    # @return [Discorb::Asset] The user's avatar.
+    attr_reader :avatar
+    # @return [Boolean] Whether the user is a bot.
+    attr_reader :bot
+    alias bot? bot
+
+    include Discorb::Messageable
+
+    # @!visibility private
+    def initialize(client, data)
+      @client = client
+      @data = {}
+      @dm_channel_id = nil
+      _set_data(data)
+    end
+
+    #
+    # Format the user as `Username#Discriminator` style.
+    #
+    # @return [String] The formatted username.
+    #
+    def to_s
+      "#{@username}##{@discriminator}"
+    end
+
+    def inspect
+      "#<#{self.class} #{self}>"
+    end
+
+    #
+    # Whether the user is a owner of the client.
+    # @macro async
+    # @macro http
+    #
+    # @param [Boolean] strict Whether don't allow if the user is a member of the team.
+    #
+    # @return [Boolean] Whether the user is a owner of the client.
+    #
+    def bot_owner?(strict: false)
+      Async do
+        app = @client.fetch_application.wait
+        if app.team.nil?
+          app.owner == self
+        elsif strict
+          app.team.owner == self
+        else
+          app.team.members.any? { |m| m.user == self }
+        end
+      end
+    end
+
+    alias app_owner? bot_owner?
+
+    # @!visibility private
+    def base_url
+      Async do
+        next @dm_channel_id if @dm_channel_id
+
+        dm_channel = @client.internet.post("/users/#{@id}/channels", { recipient_id: @client.user.id }).wait
+        @dm_channel_id = dm_channel[:id]
+        "/channels/#{@dm_channel_id}"
+      end
+    end
+
+    #
+    # Represents the user's flags.
+    # ## Flag fields
+    # |`1 << 0`|`:discord_employee`|
+    # |`1 << 1`|`:partnered_server_owner`|
+    # |`1 << 2`|`:hypesquad_events`|
+    # |`1 << 3`|`:bug_hunter_level_1`|
+    # |`1 << 6`|`:house_bravery`|
+    # |`1 << 7`|`:house_brilliance`|
+    # |`1 << 8`|`:house_balance`|
+    # |`1 << 9`|`:early_supporter`|
+    # |`1 << 10`|`:team_user`|
+    # |`1 << 14`|`:bug_hunter_level_2`|
+    # |`1 << 16`|`:verified_bot`|
+    # |`1 << 17`|`:early_verified_bot_developer`|
+    # |`1 << 18`|`:discord_certified_moderator`|
+    #
+    class Flag < Discorb::Flag
+      @bits = {
+        discord_employee: 0,
+        partnered_server_owner: 1,
+        hypesquad_events: 2,
+        bug_hunter_level_1: 3,
+        house_bravery: 6,
+        house_brilliance: 7,
+        house_balance: 8,
+        early_supporter: 9,
+        team_user: 10,
+        bug_hunter_level_2: 14,
+        verified_bot: 16,
+        early_verified_bot_developer: 17,
+        discord_certified_moderator: 18,
+      }.freeze
+    end
+
+    private
+
+    def _set_data(data)
+      @username = data[:username]
+      @verified = data[:verified]
+      @id = Snowflake.new(data[:id])
+      @flag = User::Flag.new(data[:public_flags] | (data[:flags] || 0))
+      @discriminator = data[:discriminator]
+      @avatar = Asset.new(self, data[:avatar])
+      @bot = data[:bot]
+      @raw_data = data
+      @client.users[@id] = self if !data[:no_cache] && data.is_a?(User)
+      @data.update(data)
+    end
+  end
+
+  #
+  # Represents a client user.
+  #
+  class ClientUser < User
+    #
+    # Edit the client user.
+    # @macro async
+    # @macro http
+    # @macro edit
+    #
+    # @param [String] name The new username.
+    # @param [Discorb::Image] avatar The new avatar.
+    #
+    def edit(name: :unset, avatar: :unset)
+      Async do
+        payload = {}
+        payload[:username] = name unless name == :unset
+        if avatar == :unset
+          # Nothing
+        elsif avatar.nil?
+          payload[:avatar] = nil
+        else
+          payload[:avatar] = avatar.to_s
+        end
+        @client.internet.patch("/users/@me", payload).wait
+        self
+      end
+    end
+  end
+end