discorb 0.0.1

data/lib/discorb/guild_template.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # Represents a guild template.
+  #
+  class GuildTemplate < DiscordModel
+    # @return [String] The code of the template.
+    attr_reader :code
+    # @return [String] The name of the template.
+    attr_reader :name
+    # @return [String] The description of the template.
+    attr_reader :description
+    # @return [Integer] The number of times this template has been used.
+    attr_reader :usage_count
+    # @return [Discorb::User] The user who created this template.
+    attr_reader :creator
+    # @return [Time] The time this template was created.
+    attr_reader :created_at
+    # @return [Time] The time this template was last updated.
+    attr_reader :updated_at
+    # @return [Discorb::Guild] The guild where the template was created.
+    attr_reader :source_guild_id
+    # @return [Discorb::GuildTemplate::TemplateGuild] The guild where the template was created.
+    attr_reader :serialized_source_guild
+    alias content serialized_source_guild
+    # @return [Boolean] Whether this template is dirty.
+    attr_reader :is_dirty
+    alias dirty? is_dirty
+
+    # @!attribute [r] source_guild
+    #   @macro client_cache
+    #   @return [Discorb::Guild] The guild this template is based on.
+    #   @return [nil] Client wasn't able to find the guild this template is based on.
+
+    # @!visibility private
+    def initialize(client, data)
+      @client = client
+      _set_data(data)
+    end
+
+    def source_guild
+      @client.guilds[@source_guild_id]
+    end
+
+    #
+    # Edit the template.
+    # @macro async
+    # @macro http
+    # @macro edit
+    #
+    # @param [String] name The new name of the template.
+    # @param [String] description The new description of the template.
+    #
+    def edit(name = nil, description = :unset)
+      Async do
+        payload = {}
+        payload[:name] = name if name
+        payload[:description] = description if description != :unset
+        @client.internet.patch("/guilds/#{@source_guild_id}/templates/#{@code}", payload).wait
+      end
+    end
+
+    alias modify edit
+
+    #
+    # Update the template.
+    # @macro async
+    # @macro http
+    #
+    def update
+      Async do
+        _resp, data = @client.internet.put("/guilds/#{@source_guild_id}/templates/#{@code}").wait
+        _set_data(data)
+      end
+    end
+
+    #
+    # Delete the template.
+    # @macro async
+    # @macro http
+    #
+    def delete!
+      Async do
+        @client.internet.delete("/guilds/#{@source_guild_id}/templates/#{@code}").wait
+      end
+    end
+
+    alias destroy! delete!
+
+    #
+    # Represents a guild in guild template.
+    #
+    class TemplateGuild < DiscordModel
+      # @return [String] The name of the guild.
+      attr_reader :name
+      # @return [Integer] The AFK timeout of the guild.
+      attr_reader :afk_timeout
+      # @return [Discorb::Dictionary{Discorb::Snowflake => Discorb::Role}] A dictionary of roles in the guild.
+      attr_reader :roles
+      # @return [Discorb::Guild::SystemChannelFlag] The flag for the system channel.
+      attr_reader :system_channel_flags
+      # @return [Discorb::Dictionary{Discorb::Snowflake => Discorb::GuildChannel}] A dictionary of channels in the guild.
+      attr_reader :channels
+      # @return [String] The description of the guild.
+      attr_reader :description
+      # @return [Symbol] The preffered language of the guild.
+      # @note This modifies the language code, `-` will be replaced with `_`.
+      attr_reader :preferred_locale
+      # @return [:none, :low, :medium, :high, :very_high] The verification level of the guild.
+      attr_reader :verification_level
+      # @return [:all_messages, :only_mentions] The default message notification level of the guild.
+      attr_reader :default_message_notifications
+      # @return [:disabled_in_text, :members_without_roles, :all_members] The explict content filter level of the guild.
+      attr_reader :explicit_content_filter
+      # @return [Boolean] Whether the guild enabled the widget.
+      attr_reader :widget_enabled
+      alias widget_enabled? widget_enabled
+
+      # @!visibility private
+      def initialize(data)
+        @name = data[:name]
+        @description = data[:description]
+        @region = data[:region]
+        @verification_level = Discorb::Guild.mfa_levels[data[:verification_level]]
+        @default_message_notifications = Discorb::Guild.notification_levels[data[:default_message_notifications]]
+        @explicit_content_filter = Discorb::Guild.explicit_content_filter[data[:explicit_content_filter]]
+        @preferred_locale = data[:preferred_locale]
+        @afk_timeout = data[:afk_timeout]
+        @roles = data[:roles].map { |r| Role.new(r) }
+        @channels = data[:channels].map { |c| Channel.new(c) }
+        @system_channel_flags = Discorb::SystemChannelFlag.new(data[:system_channel_flags])
+      end
+
+      #
+      # Represents a role in guild template.
+      #
+      class Role < DiscordModel
+        # @return [String] The name of the role.
+        attr_reader :name
+        # @return [Discorb::Permission] The permissions of the role.
+        attr_reader :permissions
+        # @return [Discorb::Color] The color of the role.
+        attr_reader :color
+
+        # @!visibility private
+        def initialize(data)
+          @name = data[:name]
+          @permissions = Permission.new(data[:permissions])
+          @color = Color.new(data[:color])
+          @hoist = data[:hoist]
+          @mentionable = data[:mentionable]
+        end
+      end
+
+      #
+      # Represents a channel in guild template.
+      #
+      class Channel < DiscordModel
+        # @return [String] The name of the channel.
+        attr_reader :name
+        # @return [Integer] The position of the channel.
+        attr_reader :position
+        # @return [String] The type of the channel.
+        attr_reader :topic
+        # @return [Integer] The bitrate of the channel.
+        attr_reader :bitrate
+        # @return [Integer] The user limit of the channel.
+        attr_reader :user_limit
+        # @return [Boolean] Whether the channel is nsfw.
+        attr_reader :nsfw
+        # @return [Integer] The rate limit of the channel.
+        attr_reader :rate_limit_per_user
+        # @return [Class] The class of the channel.
+        attr_reader :type
+
+        # @!visibility private
+        def initialize(data)
+          @name = data[:name]
+          @position = data[:position]
+          @topic = data[:topic]
+          @bitrate = data[:bitrate]
+          @user_limit = data[:user_limit]
+          @nsfw = data[:nsfw]
+          @rate_limit_per_user = data[:rate_limit_per_user]
+          @parent_id = data[:parent_id]
+          @permission_overwrites = data[:permission_overwrites].map do |ow|
+            [Snowflake.new(ow[:id]), PermissionOverwrite.new(ow[:allow], ow[:deny])]
+          end.to_h
+          @type = Discorb::Channel.descendants.find { |c| c.channel_type == data[:type] }
+        end
+      end
+    end
+
+    private
+
+    def _set_data(data)
+      @code = data[:code]
+      @name = data[:name]
+      @description = data[:description]
+      @usage_count = data[:usage_count]
+      @creator_id = Snowflake.new(data[:creator_id])
+      @creator = @client.users[@creator_id] || User.new(@client, data[:creator])
+      @created_at = Time.iso8601(data[:created_at])
+      @updated_at = Time.iso8601(data[:updated_at])
+      @source_guild_id = Snowflake.new(data[:source_guild_id])
+      @serialized_source_guild = data[:serialized_source_guild]
+      @is_dirty = data[:is_dirty]
+    end
+  end
+end

data/lib/discorb/image.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "base64"
+require "mime/types"
+
+module Discorb
+  #
+  # Represents an image.
+  #
+  class Image
+    #
+    # Initializes a new Image.
+    #
+    # @param [#read] source The source of the image.
+    # @param [String] type The MIME type of the image.
+    # @overload
+    #   @param [String] source The file path of the source.
+    #   @param [String] type The MIME type of the image.
+    #
+    def initialize(source, type = nil)
+      if source.respond_to?(:read)
+        @bytes = source.read
+        @type = type || MIME::Types.type_for(source.path).first.content_type
+      elsif ::File.exist?(source)
+        ::File.open(source, "rb") do |file|
+          @bytes = file.read
+        end
+        @type = MIME::Types.type_for(source).first.to_s
+      else
+        raise ArgumentError, "Couldn't read file."
+      end
+    end
+
+    #
+    # Formats the image as a Discord style.
+    #
+    # @return [String] The image as a Discord style.
+    #
+    def to_s
+      "data:#{@type};base64,#{Base64.strict_encode64(@bytes)}"
+    end
+  end
+end

data/lib/discorb/integration.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # Represents a integration.
+  #
+  class Integration < DiscordModel
+    # @return [Discorb::Snowflake] The ID of the integration.
+    attr_reader :id
+    # @return [Symbol] The type of integration.
+    attr_reader :type
+    # @return [Boolean] Whether the integration is enabled.
+    attr_reader :enabled
+    alias enabled? enabled
+    # @return [Boolean] Whether the integration is syncing.
+    attr_reader :syncing
+    alias syncing? syncing
+    # @return [Boolean] Whether the integration is enabled emoticons.
+    attr_reader :enable_emoticons
+    alias enable_emoticons? enable_emoticons
+    # @return [:remove_role, :kick] The behavior of the integration when it expires.
+    attr_reader :expire_behavior
+    # @return [Integer] The grace period of the integration.
+    attr_reader :expire_grace_period
+    # @return [Discorb::User] The user for the integration.
+    attr_reader :user
+    # @return [Discorb::Integration::Account] The account for the integration.
+    attr_reader :account
+    # @return [Integer] The number of subscribers for the integration.
+    attr_reader :subscriber_count
+    # @return [Boolean] Whether the integration is revoked.
+    attr_reader :revoked
+    alias revoked? revoked
+    # @return [Discorb::Application] The application for the integration.
+    attr_reader :application
+
+    # @!attribute [r] guild
+    #   @macro client_cache
+    #   @return [Discorb::Guild] The guild this integration is in.
+
+    @expire_behavior = {
+      0 => :remove_role,
+      1 => :kick,
+    }
+
+    # @!visibility private
+    def initialize(client, data, guild_id, no_cache: false)
+      @client = client
+      @data = data
+      @guild_id = guild_id
+      _set_data(data)
+      guild.integrations[@id] = self unless no_cache
+    end
+
+    def guild
+      @client.guilds[@guild_id]
+    end
+
+    #
+    # Delete the integration.
+    #
+    # @param [String] reason The reason for deleting the integration.
+    #
+    def delete!(reason: nil)
+      Async do
+        @client.internet.delete("/guilds/#{@guild}/integrations/#{@id}", reason: reason).wait
+      end
+    end
+
+    alias destroy! delete!
+
+    private
+
+    def _set_data(data)
+      @id = Snowflake.new(data[:id])
+      @type = data[:type].to_sym
+      @enabled = data[:enabled]
+      @syncing = data[:syncing]
+      @role_id = Snowflake.new(data[:role_id])
+      @enable_emoticons = data[:enable_emoticons]
+      @expire_behavior = self.class.expire_behavior[data[:expire_behavior]]
+      @expire_grace_period = data[:expire_grace_period]
+      @user = client.users[data[:user].to_i]
+      @account = Account.new(data[:account])
+      @subscriber_count = data[:subscriber_count]
+      @revoked = data[:revoked]
+      @application = Application.new(@client, data[:application])
+    end
+
+    class << self
+      # @!visibility private
+      attr_reader :expire_behavior
+    end
+
+    #
+    # Represents an account for an integration.
+    #
+    class Account < DiscordModel
+      # @return [String] The ID of the account.
+      attr_reader :id
+      # @return [String] The name of the account.
+      attr_reader :name
+
+      # @!visibility private
+      def initialize(data)
+        @id = data[:id]
+        @name = data[:name]
+      end
+    end
+  end
+end

data/lib/discorb/intents.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Discorb
+  # Represents intents.
+  class Intents
+    @intent_bits = {
+      guilds: 1 << 0,
+      members: 1 << 1,
+      bans: 1 << 2,
+      emojis: 1 << 3,
+      integrations: 1 << 4,
+      webhooks: 1 << 5,
+      invites: 1 << 6,
+      voice_states: 1 << 7,
+      presences: 1 << 8,
+      messages: 1 << 9,
+      reactions: 1 << 10,
+      typing: 1 << 11,
+      dm_messages: 1 << 12,
+      dm_reactions: 1 << 13,
+      dm_typing: 1 << 14,
+    }.freeze
+
+    #
+    # Create new intents object with default (no members and presence) intents.
+    #
+    # @param guilds [Boolean] Whether guild related events are enabled.
+    # @param members [Boolean] Whether guild members related events are enabled.
+    #   @note You must enable members intent on developers portal.
+    # @param bans [Boolean] Whether guild ban related events are enabled.
+    # @param emojis [Boolean] Whether guild emojis related events are enabled.
+    # @param integrations [Boolean] Whether guild integration related events are enabled.
+    # @param webhooks [Boolean] Whether guild webhooks related events are enabled.
+    # @param invites [Boolean] Whether guild invite related events are enabled.
+    # @param voice_states [Boolean] Whether guild voice state related events are enabled.
+    # @param presences [Boolean] Whether guild presences related events are enabled.
+    #   @note You must enable members intent on developers portal.
+    # @param messages [Boolean] Whether guild messages related events are enabled.
+    # @param reactions [Boolean] Whether guild reaction related events are enabled.
+    # @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.
+    #
+    def initialize(guilds: true,
+                   members: false,
+                   bans: true,
+                   emojis: true,
+                   integrations: true,
+                   webhooks: true,
+                   invites: true,
+                   voice_states: true,
+                   presences: false,
+                   messages: true,
+                   reactions: true,
+                   typing: true,
+                   dm_messages: true,
+                   dm_reactions: true,
+                   dm_typing: true)
+      @raw_value = {
+        guilds: guilds,
+        members: members,
+        bans: bans,
+        emojis: emojis,
+        integrations: integrations,
+        webhooks: webhooks,
+        invites: invites,
+        voice_states: voice_states,
+        presences: presences,
+        messages: messages,
+        reactions: reactions,
+        typing: typing,
+        dm_messages: dm_messages,
+        dm_reactions: dm_reactions,
+        dm_typing: dm_typing,
+      }
+    end
+
+    def method_missing(name, args = nil)
+      if @raw_value.key?(name)
+        @raw_value[name]
+      elsif name.end_with?("=") && @raw_value.key?(name[0..-2].to_sym)
+        raise ArgumentError, "true/false expected" if (!args.is_a? TrueClass) || args.is_a?(FalseClass)
+
+        @raw_value[name[0..-2].to_sym] = args
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(sym, include_private)
+      @raw_value.key?(name) ? true : super
+    end
+
+    # Returns value of the intent.
+    # @return [Integer] The value of the intent.
+    def value
+      res = 0
+      self.class.intent_bits.each do |intent, bit|
+        res += bit if @raw_value[intent]
+      end
+      res
+    end
+
+    def inspect
+      "#<#{self.class} value=#{value}>"
+    end
+
+    class << self
+      # Create new intent object from raw value.
+      # @param value [Integer] The value of the intent.
+      def from_value(value)
+        raw_value = {}
+        @intent_bits.each do |intent, bit|
+          raw_value[intent] = value & bit != 0
+        end
+        new(**raw_value)
+      end
+
+      # Create new intent object with default values.
+      def default
+        from_value(32_509)
+      end
+
+      # Create new intent object with all intents.
+      def all
+        from_value(32_767)
+      end
+
+      # Create new intent object with no intents.
+      def none
+        from_value(0)
+      end
+
+      attr_reader :intent_bits
+    end
+  end
+end