revoltrb 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a423864396d60b962eebc129b294b03f79e812d9b95eb2511f7c4bb2f07cefc
-  data.tar.gz: 142aba7edfce9961c36ff0ab2eaa70eced3e1a55ec64e2f2ae32db345fc30347
+  metadata.gz: e1833048a57c6bd197930741b0d788bd6b416c8ced680b5874e90d0158e8dfdb
+  data.tar.gz: 24a8b1bc143b4e3287c46d066b103abc854905293994ae2f4f35ce1b75ed4f1d
 SHA512:
-  metadata.gz: 1c9fb2983e8cba19aa607218619f5b1c7fc8bc712bba8a3030fb6e460060d60ed89a0493c35329668148542156f0591a5d2bbdf6ed0e1d1f5cd799b547293972
-  data.tar.gz: 8bf120f58d994b0a9617844acbf0b86e0491b85965a228e50e6430ba5402c80ef1c0f22585e9d22558711f4b92255942ca0bca89db9411da924d7523cb4a43f7
+  metadata.gz: 0b5d133303eb069a69c0ee5b09bdf0876256650dfe813cfd1590a4e5a031fa6f0f7df7ab51d2857f6557e60c4e84677eceab860dba6f2ccf7f6d540fe91e5778
+  data.tar.gz: b2dbd9bd8efd009f64d33471a332841513dcc57d45928e742d335a7ffad4ec669b157e41b5dc0f75d01cc6a1860350836214cd00579ef42a59b6940ce0698dfb

data/README.md

@@ -1,5 +1,7 @@
 # revoltrb
 
+![revolt-api](https://img.shields.io/npm/v/revolt-api?label=Revolt%20API)
+
 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)
@@ -11,7 +13,6 @@ You need Ruby 3.0 or newer in order to use this package (Ruby 3.2 or newer is re
 
 This list contains a list of things that I know is broken and gotta fix. Contributing will be super helpful.
 
-- Fix obtaining server information
 - Fix reactions support
 
 ## Setup
@@ -20,10 +21,10 @@ 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'
+gem 'revoltrb'
 ```
 
 #### Method 2: Install via Git
@@ -38,6 +39,8 @@ gem 'revoltrb', git: 'https://gitlab.com/roxannewolf/revoltrb'
 
 If you encounter the "Exited with code: 16 output:Ignoring debug-1.7.1 because its extensions are not built." error, most likely, there is something wrong with the parser package. This can be fixed by installing parser manually (gem install parser)
 
+On the v0.0.x releases, you would need to install websocket-client-simple from your Gemfile. Now this is included within the package as of v0.1.0
+
 ## Usage
 
 You can make a simple bot like this:
@@ -57,22 +60,7 @@ bot.on_message do |message|
 	end
 end
 
-begin
-	unless bot.login
-		puts "Bot failed to log in. Exiting."
-		exit(1)
-	end
-	puts "Bot is ONLINE and READY! Press Ctrl+C to stop."
-	bot.instance_variable_get(:@websocket_thread).join
-rescue Interrupt
-	puts "\nCtrl+C detected. Shutting down bot"
-rescue => e
-	puts "An unhandled error occurred in the main script loop: #{e.message}"
-	puts e.backtrace.join("\n")
-ensure
-	bot.stop
-	puts "Bot process ended."
-end
+bot.run
 ```
 
 or you can make a bot with full prefix commands like this:
@@ -87,22 +75,22 @@ bot.command(:ping) do |message, args|
 	bot.send_message(channel_id, text: "Pong! You sent: #{args.join(' ')}")
 end
 
-begin
-	unless bot.login
-		puts "Bot failed to log in. Exiting."
-		exit(1)
-	end
-	puts "Bot is online and running. Press Ctrl+C to stop."
-	bot.instance_variable_get(:@websocket_thread).join
-rescue Interrupt
-	puts "\nCtrl+C detected. Shutting down bot gracefully..."
-rescue => e
-	puts "An unhandled error occurred in the main script loop: #{e.message}"
-	puts e.backtrace.join("\n")
-ensure
-	bot.stop
-	puts "Bot process ended."
-end
+bot.run
+```
+
+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

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,6 +6,7 @@ require 'thread'
 require 'time'
 require_relative 'debuglogger'
 require_relative 'request_queue'
+require_relative 'webhooks'
 
 module Revoltrb
 	class RevoltBot
@@ -25,7 +25,7 @@ module Revoltrb
 			':-1:' => '👎'
 		}.freeze
 
-		attr_reader :token, :user_id, :bot_name, :servers, :prefix, :bot_owner_id, :bot_discriminator, :bot_discoverable, :bot_creation_date
+		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)
@@ -48,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
@@ -96,18 +97,15 @@ module Revoltrb
 				@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."
-					@logger.debug "Please inspect the 'Response Body' above for unexpected format."
+					@logger.debug "AN ERROR HAS OCCURED: Essential properties (_id, username) missing or nil in API response from /users/@me. Please inspect the 'Response Body' above for unexpected format."
 					return false
 				end
 
 				@logger.debug "Successfully identified as #{@bot_name} (ID: #{@user_id}) via REST API."
-				@logger.debug "Bot owner ID after parsing: #{@bot_owner_id}"
-				@logger.debug "Owner ID: #{@bot_owner_id}, Discoverable: #{@bot_discoverable.inspect}, Created: #{@bot_creation_date}"
+				@logger.debug "Bot Owner ID: #{@bot_owner_id}, Owner ID: #{@bot_owner_id}, Discoverable: #{@bot_discoverable.inspect}, Created: #{@bot_creation_date}"
 			else
-				@logger.debug "Initial REST API call failed: #{res.message} (Code: #{res.code})"
-				@logger.debug "Response Body: #{res.body}"
-				@logger.debug "Please check your bot token. Cannot proceed with WebSocket connection."
+				@logger.debug "AN ERROR HAS OCCURED: Initial REST API call failed.... #{res.message} (Code: #{res.code})"
+				@logger.debug "Please check your bot token. Cannot proceed with WebSocket connection. Response Body: #{res.body}"
 				return false
 			end
 			# Step 2: Connect to the WebSocket
@@ -116,6 +114,60 @@ module Revoltrb
 			@request_queue.start_processing
 			true
 		end
+		def run
+			begin
+				unless login
+					puts "Bot failed to log in. Exiting."
+					exit(1)
+				end
+				puts "Bot is online and running. Press Ctrl+C to stop."
+				@websocket_thread.join
+			rescue Interrupt
+				puts "\nCtrl+C detected. Shutting down bot gracefully..."
+			rescue => e
+				puts "An unhandled error occurred in the main script loop: #{e.message}"
+				puts e.backtrace.join("\n")
+			ensure
+				stop
+				puts "Bot process ended."
+			end
+		end
+
+		def set_presence(status)
+			valid_statuses = ['Online', 'Idle', 'Dnd', 'Focus', 'Invisible']
+			unless valid_statuses.include?(status)
+				@logger.debug "AN ERROR HAS OCCURED: Invalid status '#{status}'. Must be one of the following choices: #{valid_statuses.join(', ')}."
+				return false
+			end
+
+			@logger.debug "Attempting to set bot presence to '#{status}'."
+			uri = URI("#{@api_url}/users/@me")
+			req = Net::HTTP::Patch.new(uri)
+			_add_auth_header(req)
+			req['Content-Type'] = 'application/json'
+			payload = {
+				status: {
+					presence: status
+				}
+			}
+			req.body = payload.to_json
+			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)
+				@logger.debug "BOT: Presence has been changed to '#{status}'."
+				true
+			else
+				@logger.debug "AN ERROR HAS OCCURED: Failed to update presence. Response: #{res.message} (Code: #{res.code})"
+				@logger.debug "Response Body: #{res.body}"
+				false
+			end
+		rescue => e
+			@logger.debug "AN ERROR HAS OCCURED: Error setting presence: #{e.message}"
+			@logger.debug e.backtrace.join("\n")
+			false
+		end
 
 		def connect_websocket
 			if @websocket && @websocket.open? && @running
@@ -126,7 +178,7 @@ module Revoltrb
 			@logger.debug "Connecting to WebSocket: #{@websocket_url}"
 			ws_url_with_token = "#{@websocket_url}?token=#{@token}"
 			bot_instance = self
-			thread_logger = @logger 
+			thread_logger = @logger
 
 			@websocket_thread = Thread.new do
 				begin
@@ -186,7 +238,7 @@ module Revoltrb
 				@last_heartbeat_sent = Time.now.to_i
 			end
 		rescue OpenSSL::SSL::SSLError => e
-			@logger.debug "AN ERROR HAS OCCURED: Error sending heartbeat (SSL): #{e.message}" 
+			@logger.debug "AN ERROR HAS OCCURED: Error sending heartbeat (SSL): #{e.message}"
 			@websocket&.close
 		rescue => e
 			@logger.debug "AN ERROR HAS OCCURED: Error sending heartbeat: #{e.message}"
@@ -228,10 +280,10 @@ module Revoltrb
 					# @logger.debug "AN ERROR HAS OCCURED: Unhandled WebSocket event type: #{event_type}"
 				end
 			rescue JSON::ParserError => e
-				@logger.debug "Failed to parse WebSocket message as JSON: #{e.message}"
+				@logger.debug "AN ERROR HAS OCCURED: Failed to parse WebSocket message as JSON: #{e.message}"
 				@logger.debug "Raw message: #{raw_data}"
 			rescue => e
-				@logger.debug "Error processing WebSocket message: #{e.message}"
+				@logger.debug "AN ERROR HAS OCCURED: Error processing WebSocket message: #{e.message}"
 				@logger.debug e.backtrace.join("\n")
 			end
 		end
@@ -246,7 +298,7 @@ module Revoltrb
 				'permissions' => required_permissions,
 				'nsfw_cmd' => nsfw_channel_required
 			}
-			@logger.debug "Command '#{command_name}' registered with permissions: #{required_permissions.inspect}, NSFW required: #{nsfw_channel_required}."
+			@logger.debug "Command '#{command_name}' registered! Permissions: #{required_permissions.inspect}, NSFW required: #{nsfw_channel_required}."
 		end
 
 		def check_permissions(message, required_permissions, nsfw_channel_required)
@@ -262,12 +314,11 @@ module Revoltrb
 			end
 			user_id = message['author']
 
-			@logger.debug "\n--- PERMISSION DEBUG START ---"
-			@logger.debug "User ID from message (user_id): '#{user_id}' | Bot Owner ID stored (@bot_owner_id): '#{@bot_owner_id}'"
+			# --- Permission Check ---
+			@logger.debug "PERMISSION DEBUG: User ID from message (user_id): '#{user_id}' | Bot Owner ID stored (@bot_owner_id): '#{@bot_owner_id}'"
 			@logger.debug "Are they equal? (user_id == @bot_owner_id): #{user_id == @bot_owner_id}"
 			# @logger.debug "User ID char codes: #{user_id.each_char.map(&:ord).join(', ')}"
 			# @logger.debug "Bot Owner ID char codes: #{@bot_owner_id.each_char.map(&:ord).join(', ')}"
-			@logger.debug "--- PERMISSION DEBUG END ---\n"
 			# --- BotOwner Check ---
 			if required_permissions.include?('BotOwner')
 				if user_id == @bot_owner_id
@@ -288,7 +339,7 @@ module Revoltrb
 			else
 				channel_details = get_channel_details(channel_id)
 				if channel_details.nil?
-					@logger.debug "Permission Check: Command requires NSFW channel but could not retrieve channel details. Denying command to be safe."
+					@logger.debug "Permission Check: Command requires NSFW channel but could not retrieve channel details. Denying command."
 					return false
 				end
 				is_channel_nsfw = channel_details['nsfw'] || false
@@ -535,4 +586,4 @@ module Revoltrb
 			end
 		end
 	end
-end
+end

data/lib/revoltrb/version.rb

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

data/lib/revoltrb/webhooks.rb

@@ -0,0 +1,104 @@
+# 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 Name: #{webhook_data['name']} | Webhook ID: #{webhook_data['id']}"
+				@logger.debug "Webhook Channel ID: #{webhook_data['channel_id']}"
+				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 "[Revoltrb Webhooks] AN ERROR HAS OCCURED: Status code: #{response.code}"
+					puts "[Revoltrb Webhooks] Response body: #{response.body}"
+					return false
+				end
+			rescue StandardError => e
+				puts "[Revoltrb Webhooks] 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.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Roxanne Studios
@@ -37,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: thread
   requirement: !ruby/object:Gem::Requirement
@@ -55,16 +69,16 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.9.0
 description: The first Ruby package (a.k.a. gem) to exist for making Revolt.chat bots.
   This project is not officially endorsed by revolt.chat
 email:
@@ -79,6 +93,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