revoltrb 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be934ade9a4122fe6ea640bf5aafe2930eb1a11ee2a8f4340d282b3fa99f163c
-  data.tar.gz: 6e384401d88c604fa0bfa05b1a840697c0382a288683ac27db23d98e425b4a25
+  metadata.gz: 4a47d743074af0c8a29f14e720df6488e8db97c325c721e52fa5c110ffc2b8ba
+  data.tar.gz: cc98be2028dd30a7089fd1e0e5ee83fb62a518cac32812184cd6c8e0b6974fe0
 SHA512:
-  metadata.gz: e36bad7e4adec3333f2341b6d1e85aadc1cbab691552d69a1f9e777a7df5722b2fc048e1e98be0e361a4a1447d2597e65f3cc8888d7afb9fb589e9dfa4f79b27
-  data.tar.gz: db5fa947e54394afb19495145a3b3beb8ef50bf6bc17c584fc8369659a281603c48f522fe7a7c0ea4dcf56c7a1f1a35185d5a593ffaea5586951862a19a40535
+  metadata.gz: 014fbf6c33d831f9b7804299454e57017aa684fe84184a8ddbd21711cac2771ca0ef537592bb113d27e2870e9260c2c97eac00dd09d9fba9f579110dcfa69207
+  data.tar.gz: 718a3ad4ca444aa2ca55fd451190ae937e6fbff8f19f22aed7f935869085527279e0a9bb04736f437a9bf9752f7ac1005e21f61148906ed116cb9e1d9e87df80

data/README.md

@@ -1,18 +1,17 @@
 # revoltrb
 
-Revoltrb is a Ruby package (a.k.a. Gem) that allows you to make Revolt.chat bots using the Ruby programming language.
-
-This package (a.k.a. Gem) is not officially endorsed by Revolt.chat amd this is not an official Revolt.chat product.
+Revoltrb is a Ruby package (a.k.a. Gem) that allows you to make Revolt.chat bots using the Ruby programming language. This package (a.k.a. Gem) is not officially endorsed by Revolt.chat amd this is not an official Revolt.chat product.
 
 You need Ruby 3.0 or newer in order to use this package (Ruby 3.2 or newer is recommended)
 
+> [!NOTE]
+> This package (a.k.a. Gem) is in a early alpha state so expect things to be buggy and/or broken.
+
 ## ToDo
 
 This list contains a list of things that I know is broken and gotta fix. Contributing will be super helpful.
 
 - Fix reactions support
-- Fix obtaining server information
-- Fix not being able to have an embed color
 
 ## Setup
 
@@ -20,7 +19,7 @@ You can install Revoltrb through several methods:
 
 #### Method 1: Install from rubygems.org (Bundler)
 
-Add the following to your Gemfile file and run the "bundle install" command:
+Add the following to your Gemfile file and run the "[bundle install](https://rubygems.org/gems/revoltrb)" command:
 
 ```ruby
 gem 'discordrb'
@@ -105,6 +104,21 @@ ensure
 end
 ```
 
+Webhook example:
+
+```ruby
+require 'revoltrb'
+# Webhook url should look like this: https://beta.revolt.chat/api/webhooks/<WEBHOOK_ID>/<WEBHOOK_TOKEN>
+# Webhook urls can be obtained and created through beta.revolt.chat
+WEBHOOK_ID = ''
+WEBHOOK_TOKEN = ''
+webhook = RevoltWebhooks::Webhook.new(WEBHOOK_ID, WEBHOOK_TOKEN)
+
+webhook.send_message(
+	content: "Revoltrb webhook message content",
+)
+```
+
 ## Support and Help
 
 If you need help with this ruby package (a.k.a. Gem), feel free to join the [Roxanne Studios Revolt Server](https://rvlt.gg/r4Ee2R1Z) and use the REVOLTRB category to talk about this package.

data/lib/revoltrb/bot.rb

@@ -1,5 +1,4 @@
 # lib/revoltrb/bot.rb
-
 require 'json'
 require 'net/http'
 require 'websocket-client-simple' # This is required for WebSocket communication
@@ -7,10 +6,26 @@ require 'thread'
 require 'time'
 require_relative 'debuglogger'
 require_relative 'request_queue'
+require_relative 'webhooks'
 
 module Revoltrb
 	class RevoltBot
-		attr_reader :token, :user_id, :bot_name, :servers, :prefix, :bot_owner_id, :bot_discriminator, :bot_discoverable, :bot_creation_date
+		EMOJI_MAP = {
+			':grinning:' => '😀',
+			':heart:' => '❤️',
+			':joy:' => '😂',
+			':unamused:' => '😒',
+			':sunglasses:' => '😎',
+			':thinking:' => '🤔',
+			':clap:' => '👏',
+			':thumbsup:' => '👍',
+			':thumbsdown:' => '👎',
+			':point_up:' => '☝️',
+			':+1:' => '👍',
+			':-1:' => '👎'
+		}.freeze
+
+		attr_reader :token, :user_id, :bot_name, :servers, :prefix, :bot_owner_id, :bot_discriminator, :bot_discoverable, :bot_creation_date, :webhooks
 		attr_accessor :websocket_url, :api_url, :cdn_url
 		# Initializes the bot with the provided token, API endpoints, and configuration.
 		def initialize(token, api_url: 'https://api.revolt.chat', websocket_url: 'wss://app.revolt.chat/events', cdn_url: 'https://cdn.revoltusercontent.com', prefix: nil, debuglogs: false, selfbot: false)
@@ -33,6 +48,7 @@ module Revoltrb
 			@ready_event_received = false
 			@logger = Revoltrb::DebugLogger.new(debuglogs)
 			@request_queue = Revoltrb::RequestQueue.new(500)
+			@webhooks = Revoltrb::Webhooks.new(api_url, @logger, token, selfbot)
 
 			@prefix = "!"
 			@prefix = prefix if prefix
@@ -46,8 +62,11 @@ module Revoltrb
 				'bot_name' => @bot_name,
 				'bot_discriminator' => @bot_discriminator,
 				'bot_ownerid' => @bot_owner_id,
-				'bot_discoverable' => @bot_discoverable,
 				'bot_creationdate' => @bot_creation_date,
+				'bot_flags' => @bot_flags,
+				'bot_discoverable' => @bot_discoverable,
+				'bot_public' => @bot_public,
+				'bot_analytics' => @bot_analytics,
 				'bot_prefix' => @prefix,
 				'bot_token' => @token
 			}
@@ -72,7 +91,10 @@ module Revoltrb
 				@bot_discriminator = bot_user_data&.[]('discriminator')
 				bot_specific_info = bot_user_data&.[]('bot')
 				@bot_owner_id = bot_specific_info&.[]('owner')
+				@bot_flags = bot_specific_info&.[]('flags')
 				@bot_discoverable = nil
+				@bot_public = nil
+				@bot_analytics = nil
 				@bot_creation_date = Time.at(bot_user_data&.[]('created_at').to_i / 1000) rescue nil
 				if @user_id.nil? || @bot_name.nil?
 					@logger.debug "Error: Essential properties (_id, username) missing or nil in API response from /users/@me."
@@ -283,7 +305,6 @@ module Revoltrb
 				@logger.debug "User #{user_id} is not the bot owner. Requires permissions: #{required_permissions.inspect}. (Full permission check for non-owner, server-specific permissions not implemented)."
 				return false
 			end
-
 			@logger.debug "Permission Check: All checks passed. Allowing command."
 			true
 		end
@@ -346,7 +367,7 @@ module Revoltrb
       
 			if embeds && !embeds.empty?
 				filtered_embeds = embeds.map do |embed|
-					supported_keys = ['title', 'description', 'color', 'url', 'image']
+					supported_keys = ['title', 'description', 'colour', 'url', 'icon_url', 'media']
 					embed.select { |k, v| supported_keys.include?(k.to_s) }
 				end
 				payload[:embeds] = filtered_embeds
@@ -381,40 +402,70 @@ module Revoltrb
 			@logger.debug e.backtrace.join("\n")
 		end
 
+		def find_unicode_emoji(shortcode)
+			EMOJI_MAP[shortcode]
+		end
 
 		def add_reaction(channel_id, message_id, emoji_id)
+			if emoji_id.start_with?(':') && emoji_id.end_with?(':')
+				@logger.debug "AN ERROR HAS OCCURED: Cannot add reaction with shortcode '#{emoji_id}'. Please use the actual Unicode emoji or a custom emoji ID."
+				return
+			end
+
 			@request_queue.enqueue do
 				@logger.debug "Attempting to add reaction '#{emoji_id}' to message '#{message_id}' in channel '#{channel_id}' via queue."
-				uri = URI("#{@api_url}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji_id}")
-				req = Net::HTTP::Put.new(uri) # Reactions use PUT
-				req['x-bot-token'] = @token
-				res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-					http.request(req)
+				encoded_emoji_id = CGI.escape(emoji_id)
+
+				uri = URI("#{@api_url}/channels/#{channel_id}/messages/#{message_id}/reactions/#{encoded_emoji_id}")
+				req = Net::HTTP::Put.new(uri)
+				_add_auth_header(req)
+
+				res = nil
+				begin
+					res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https', read_timeout: 10, open_timeout: 10) do |http|
+						http.request(req)
+					end
+				rescue Net::ReadTimeout => e
+					@logger.debug "AN ERROR HAS OCCURED: The network request timed out while waiting for a response after 10 seconds. Error: #{e.message}"
+					return
+				rescue Net::OpenTimeout => e
+					@logger.debug "AN ERROR HAS OCCURED: The network request timed out while trying to open a connection after 10 seconds. Error: #{e.message}"
+					return
+				rescue => e
+					@logger.debug "AN ERROR HAS OCCURED: An unexpected error occurred during the network request. Error: #{e.message}"
+					return
+				ensure
+					@logger.debug "Network request to add reaction finished."
 				end
+
+				@logger.debug "Received response with code: #{res.code}"
 				if res.is_a?(Net::HTTPSuccess) || res.code == '204'
-					@logger.debug "Reaction has been added successfully!"
+					@logger.debug "Reaction added successfully!"
 				else
 					@logger.debug "AN ERROR HAS OCCURED: Failed to add reaction: #{res.message} (Code: #{res.code})"
 					@logger.debug "Response Body: #{res.body}"
+					if res.code == '403'
+						@logger.debug "HINT: The bot may be missing the 'AddReactions' permission in this channel or server."
+					end
 				end
 			end
-		rescue => e
-			@logger.debug "AN ERROR HAS OCCURED: Error enqueuing add reaction: #{e.message}"
-			@logger.debug e.backtrace.join("\n")
 		end
 
 		def remove_reaction(channel_id, message_id, emoji_id, user_id: nil)
-			target_user_id = user_id || @user_id # Default to bot's own ID
+			target_user_id = user_id || @user_id
 			@request_queue.enqueue do
 				@logger.debug "Attempting to remove reaction '#{emoji_id}' from message '#{message_id}' by user '#{target_user_id}' in channel '#{channel_id}' via queue."
-				uri = URI("#{@api_url}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji_id}?user_id=#{target_user_id}")
+
+				encoded_emoji_id = CGI.escape(emoji_id)
+
+				uri = URI("#{@api_url}/channels/#{channel_id}/messages/#{message_id}/reactions/#{encoded_emoji_id}?user_id=#{target_user_id}")
 				req = Net::HTTP::Delete.new(uri)
-				req['x-bot-token'] = @token
+				_add_auth_header(req)
 				res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
 					http.request(req)
 				end
 				if res.is_a?(Net::HTTPSuccess) || res.code == '204'
-					@logger.debug "Reaction has been removed successfully!"
+					@logger.debug "Reaction removed successfully!"
 				else
 					@logger.debug "AN ERROR HAS OCCURED: Failed to remove reaction: #{res.message} (Code: #{res.code})"
 					@logger.debug "Response Body: #{res.body}"

data/lib/revoltrb/version.rb

@@ -2,5 +2,5 @@
 
 module Revoltrb
 	# The current version of revoltrb
-	VERSION = "0.0.1"
+	VERSION = "0.0.3"
 end

data/lib/revoltrb/webhooks.rb

@@ -0,0 +1,108 @@
+# lib/revoltrb/webhooks.rb
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Revoltrb
+	class Webhooks
+		attr_reader :api_url, :logger, :token, :selfbot
+		def initialize(api_url, logger, token, selfbot)
+			@api_url = api_url
+			@logger = logger
+			@token = token
+			@selfbot = selfbot
+		end
+
+		def create_webhook(channel_id, name, avatar_url: nil)
+			@logger.debug "Attempting to create a webhook for channel '#{channel_id}' with name '#{name}'."
+
+			uri = URI("#{@api_url}/channels/#{channel_id}/webhooks")
+			req = Net::HTTP::Post.new(uri)
+			if @selfbot
+				req['Authorization'] = @token
+			else
+				req['x-bot-token'] = @token
+			end
+			req['Content-Type'] = 'application/json'
+
+			payload = {
+				name: name
+			}
+			payload[:avatar] = avatar_url unless avatar_url.nil?
+			req.body = payload.to_json
+
+			res = nil
+			begin
+				res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https', read_timeout: 10, open_timeout: 10) do |http|
+					http.request(req)
+				end
+			rescue Net::ReadTimeout => e
+				@logger.debug "AN ERROR HAS OCCURED: Network request timed out while reading: #{e.message}"
+				return nil
+			rescue Net::OpenTimeout => e
+				@logger.debug "AN ERROR HAS OCCURED: Network request timed out while connecting: #{e.message}"
+				return nil
+			rescue => e
+				@logger.debug "AN ERROR HAS OCCURED: An unexpected error occurred while creating the webhook: #{e.message}"
+				return nil
+			end
+
+			if res.is_a?(Net::HTTPSuccess)
+				webhook_data = JSON.parse(res.body)
+				@logger.debug "Webhook created successfully! Details: #{res.body}"
+				@logger.debug "--- Webhook Created ---"
+				@logger.debug "Name: #{webhook_data['name']} | ID: #{webhook_data['id']}"
+				@logger.debug "Channel ID: #{webhook_data['channel_id']} | Permissions: #{webhook_data['permissions']}"
+				@logger.debug "Token: #{webhook_data['token'].inspect}"
+				@logger.debug "--- End Webhook Details ---"
+				return webhook_data
+			else
+				@logger.debug "AN ERROR HAS OCCURED: Failed to create webhook. (Code: #{res.code}) Response: #{res.message}"
+				@logger.debug "Response Body: #{res.body}"
+				return nil
+			end
+		end
+	end
+end
+
+module RevoltWebhooks
+	class Webhook
+		DEFAULT_API_URL = 'https://beta.revolt.chat/api'.freeze
+		def initialize(webhook_id, webhook_token, api_url: DEFAULT_API_URL)
+			@webhook_id = webhook_id
+			@webhook_token = webhook_token
+			@api_url = api_url
+			@uri = URI("#{@api_url}/webhooks/#{@webhook_id}/#{@webhook_token}")
+		end
+
+		def send_message(content:, embeds: nil)
+			payload = {
+				content: content
+			}
+
+			if embeds
+				payload[:embeds] = Array(embeds)
+			end
+
+			http = Net::HTTP.new(@uri.host, @uri.port)
+			http.use_ssl = true
+			request = Net::HTTP::Post.new(@uri.path, 'Content-Type' => 'application/json')
+			request.body = payload.to_json
+
+			begin
+				response = http.request(request)
+
+				if response.code.to_i == 204 || response.code.to_i == 200
+					return true
+				else
+					puts "AN ERROR HAS OCCURED: Status code: #{response.code}"
+					puts "Response body: #{response.body}"
+					return false
+				end
+			rescue StandardError => e
+				puts "AN ERROR HAS OCCURED: #{e.message}"
+				return false
+			end
+		end
+	end
+end

data/lib/revoltrb.rb

@@ -1,8 +1,14 @@
+# lib/revoltrb.rb
 require_relative 'revoltrb/bot'
 require_relative 'revoltrb/version'
 require_relative 'revoltrb/debuglogger'
 require_relative 'revoltrb/request_queue'
+require_relative 'revoltrb/webhooks'
 
 module Revoltrb
 	# This module can serve as a namespace for the gem's classes. For now, it's a direct require.
+end
+
+module RevoltWebhooks
+	# This module can serve as a namespace for the gem's classes. For now, it's a direct require.
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: revoltrb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Roxanne Studios
@@ -13,30 +13,30 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.13.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.13.2
 - !ruby/object:Gem::Dependency
   name: net-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: thread
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +79,7 @@ files:
 - lib/revoltrb/debuglogger.rb
 - lib/revoltrb/request_queue.rb
 - lib/revoltrb/version.rb
+- lib/revoltrb/webhooks.rb
 homepage: https://gitlab.com/roxannewolf/revoltrb
 licenses:
 - MIT