rubycord 1.0.0

data/lib/rubycord.rb

@@ -0,0 +1,140 @@
+require "rubycord/version"
+require "rubycord/bot"
+require "rubycord/commands/command_bot"
+require "rubycord/logger"
+
+# All rubycord functionality, to be extended by other files
+module Rubycord
+  Thread.current[:rubycord_name] = "main"
+
+  # The default debug logger used by rubycord.
+  LOGGER = Logger.new(ENV.fetch("RUBYCORD_FANCY_LOG", false))
+
+  # The Unix timestamp Discord IDs are based on
+  DISCORD_EPOCH = 1_420_070_400_000
+
+  # Used to declare what events you wish to recieve from Discord.
+  # @see https://discord.com/developers/docs/topics/gateway#gateway-intents
+  INTENTS = {
+    servers: 1 << 0,
+    server_members: 1 << 1,
+    server_moderation: 1 << 2,
+    server_emojis_and_stickers: 1 << 3,
+    server_integrations: 1 << 4,
+    server_webhooks: 1 << 5,
+    server_invites: 1 << 6,
+    server_voice_states: 1 << 7,
+    server_presences: 1 << 8,
+    server_messages: 1 << 9,
+    server_message_reactions: 1 << 10,
+    server_message_typing: 1 << 11,
+    direct_messages: 1 << 12,
+    direct_message_reactions: 1 << 13,
+    direct_message_typing: 1 << 14,
+    message_content: 1 << 15,
+    server_scheduled_events: 1 << 16,
+    auto_moderation_configuration: 1 << 20,
+    auto_moderation_execution: 1 << 21,
+    server_message_polls: 1 << 24,
+    direct_message_polls: 1 << 25
+  }.freeze
+
+  # All available intents
+  ALL_INTENTS = INTENTS.values.reduce(&:|)
+
+  # All unprivileged intents
+  # @see https://discord.com/developers/docs/topics/gateway#privileged-intents
+  UNPRIVILEGED_INTENTS = ALL_INTENTS & ~(INTENTS[:server_members] | INTENTS[:server_presences] | INTENTS[:message_content])
+
+  # No intents
+  NO_INTENTS = 0
+
+  # Compares two objects based on IDs - either the objects' IDs are equal, or one object is equal to the other's ID.
+  def self.id_compare(one_id, other)
+    other.respond_to?(:resolve_id) ? (one_id.resolve_id == other.resolve_id) : (one_id == other)
+  end
+
+  # The maximum length a Discord message can have
+  CHARACTER_LIMIT = 2000
+
+  # For creating timestamps with {timestamp}
+  # @see https://discord.com/developers/docs/reference#message-formatting-timestamp-styles
+  TIMESTAMP_STYLES = {
+    short_time: "t", # 16:20
+    long_time: "T", # 16:20:30
+    short_date: "d", # 20/04/2021
+    long_date: "D", # 20 April 2021
+    short_datetime: "f", # 20 April 2021 16:20
+    long_datetime: "F", # Tuesday, 20 April 2021 16:20
+    relative: "R" # 2 months ago
+  }.freeze
+
+  # Splits a message into chunks of 2000 characters. Attempts to split by lines if possible.
+  # @param msg [String] The message to split.
+  # @return [Array<String>] the message split into chunks
+  def self.split_message(msg)
+    # If the messages is empty, return an empty array
+    return [] if msg.empty?
+
+    # Split the message into lines
+    lines = msg.lines
+
+    # Turn the message into a "triangle" of consecutively longer slices, for example the array [1,2,3,4] would become
+    # [
+    #  [1],
+    #  [1, 2],
+    #  [1, 2, 3],
+    #  [1, 2, 3, 4]
+    # ]
+    tri = (0...lines.length).map { |i| lines.combination(i + 1).first }
+
+    # Join the individual elements together to get an array of strings with consecutively more lines
+    joined = tri.map(&:join)
+
+    # Find the largest element that is still below the character limit, or if none such element exists return the first
+    ideal = joined.max_by { |e| (e.length > CHARACTER_LIMIT) ? -1 : e.length }
+
+    # If it's still larger than the character limit (none was smaller than it) split it into the largest chunk without
+    # cutting words apart, breaking on the nearest space within character limit, otherwise just return an array with one element
+    ideal_ary = (ideal.length > CHARACTER_LIMIT) ? ideal.split(/(.{1,#{CHARACTER_LIMIT}}\b|.{1,#{CHARACTER_LIMIT}})/o).reject(&:empty?) : [ideal]
+
+    # Slice off the ideal part and strip newlines
+    rest = msg[ideal.length..].strip
+
+    # If none remains, return an empty array -> we're done
+    return [] unless rest
+
+    # Otherwise, call the method recursively to split the rest of the string and add it onto the ideal array
+    ideal_ary + split_message(rest)
+  end
+
+  # @param time [Time, Integer] The time to create the timestamp from, or a unix timestamp integer.
+  # @param style [Symbol, String] One of the keys from {TIMESTAMP_STYLES} or a string with the style.
+  # @return [String]
+  # @example
+  #   Rubycord.timestamp(Time.now, :short_time)
+  #   # => "<t:1632146954:t>"
+  def self.timestamp(time, style = nil)
+    if style.nil?
+      "<t:#{time.to_i}>"
+    else
+      "<t:#{time.to_i}:#{TIMESTAMP_STYLES[style] || style}>"
+    end
+  end
+end
+
+# In rubycord, Integer and {String} are monkey-patched to allow for easy resolution of IDs
+class Integer
+  # @return [Integer] The Discord ID represented by this integer, i.e. the integer itself
+  def resolve_id
+    self
+  end
+end
+
+# In rubycord, {Integer} and String are monkey-patched to allow for easy resolution of IDs
+class String
+  # @return [Integer] The Discord ID represented by this string, i.e. the string converted to an integer
+  def resolve_id
+    to_i
+  end
+end

metadata

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: rubycord
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dakurei
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.8
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.24
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.24
+- !ruby/object:Gem::Dependency
+  name: opus-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rubycord-webhooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A Ruby implementation of the Discord (https://discord.com) API.
+email:
+- maxime.palanchini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rubycord.rb
+- lib/rubycord/allowed_mentions.rb
+- lib/rubycord/api.rb
+- lib/rubycord/api/application.rb
+- lib/rubycord/api/channel.rb
+- lib/rubycord/api/interaction.rb
+- lib/rubycord/api/invite.rb
+- lib/rubycord/api/server.rb
+- lib/rubycord/api/user.rb
+- lib/rubycord/api/webhook.rb
+- lib/rubycord/await.rb
+- lib/rubycord/bot.rb
+- lib/rubycord/cache.rb
+- lib/rubycord/colour_rgb.rb
+- lib/rubycord/commands/command_bot.rb
+- lib/rubycord/commands/container.rb
+- lib/rubycord/commands/events.rb
+- lib/rubycord/commands/parser.rb
+- lib/rubycord/commands/rate_limiter.rb
+- lib/rubycord/container.rb
+- lib/rubycord/data.rb
+- lib/rubycord/data/activity.rb
+- lib/rubycord/data/application.rb
+- lib/rubycord/data/attachment.rb
+- lib/rubycord/data/audit_logs.rb
+- lib/rubycord/data/channel.rb
+- lib/rubycord/data/component.rb
+- lib/rubycord/data/embed.rb
+- lib/rubycord/data/emoji.rb
+- lib/rubycord/data/integration.rb
+- lib/rubycord/data/interaction.rb
+- lib/rubycord/data/invite.rb
+- lib/rubycord/data/member.rb
+- lib/rubycord/data/message.rb
+- lib/rubycord/data/overwrite.rb
+- lib/rubycord/data/profile.rb
+- lib/rubycord/data/reaction.rb
+- lib/rubycord/data/recipient.rb
+- lib/rubycord/data/role.rb
+- lib/rubycord/data/server.rb
+- lib/rubycord/data/user.rb
+- lib/rubycord/data/voice_region.rb
+- lib/rubycord/data/voice_state.rb
+- lib/rubycord/data/webhook.rb
+- lib/rubycord/errors.rb
+- lib/rubycord/events/await.rb
+- lib/rubycord/events/bans.rb
+- lib/rubycord/events/channels.rb
+- lib/rubycord/events/generic.rb
+- lib/rubycord/events/guilds.rb
+- lib/rubycord/events/interactions.rb
+- lib/rubycord/events/invites.rb
+- lib/rubycord/events/lifetime.rb
+- lib/rubycord/events/members.rb
+- lib/rubycord/events/message.rb
+- lib/rubycord/events/presence.rb
+- lib/rubycord/events/raw.rb
+- lib/rubycord/events/reactions.rb
+- lib/rubycord/events/roles.rb
+- lib/rubycord/events/threads.rb
+- lib/rubycord/events/typing.rb
+- lib/rubycord/events/voice_server_update.rb
+- lib/rubycord/events/voice_state_update.rb
+- lib/rubycord/events/webhooks.rb
+- lib/rubycord/gateway.rb
+- lib/rubycord/id_object.rb
+- lib/rubycord/light.rb
+- lib/rubycord/light/data.rb
+- lib/rubycord/light/integrations.rb
+- lib/rubycord/light/light_bot.rb
+- lib/rubycord/logger.rb
+- lib/rubycord/paginator.rb
+- lib/rubycord/permissions.rb
+- lib/rubycord/version.rb
+- lib/rubycord/voice/encoder.rb
+- lib/rubycord/voice/network.rb
+- lib/rubycord/voice/sodium.rb
+- lib/rubycord/voice/voice_bot.rb
+- lib/rubycord/webhooks.rb
+- lib/rubycord/webhooks/builder.rb
+- lib/rubycord/webhooks/client.rb
+- lib/rubycord/webhooks/embeds.rb
+- lib/rubycord/webhooks/modal.rb
+- lib/rubycord/webhooks/version.rb
+- lib/rubycord/webhooks/view.rb
+- lib/rubycord/websocket.rb
+homepage: https://github.com/dakurei-gems/rubycord
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dakurei-gems/rubycord
+  source_code_uri: https://github.com/dakurei-gems/rubycord
+  changelog_uri: https://github.com/dakurei-gems/rubycord/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key: 
+specification_version: 4
+summary: Discord API for Ruby
+test_files: []