fluxerrb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1afcd0591253a04f54e8458bcb1a51733f78ecf3afdb7a47a3a22fca8f61949
+  data.tar.gz: 34ca494197af5511d3ef6f73c7358f6529a8554d9285701e1272b8bf9b9dce0a
+SHA512:
+  metadata.gz: 924dca7689bbd5ccca3b6c917c520597d0f8e9c266becb438232d1572d2a71b1374b345361eac0b26c0904e1d6731ca63356d91a2379518fe4c5b232f6d5f047
+  data.tar.gz: b56704e5a38fde8f804a0f652f1495c2b6c4b9739e724ed286abf0e908e93e31d8d99f40b4966be4bb9146438ff8b1ebbcd6d42bc116d7ca26ac59b7c33114ac

data/README.md

@@ -0,0 +1,62 @@
+# fluxerrb
+
+Fluxerrb is a Ruby package (a.k.a. Gem) that allows you to make Fluxer.app bots and use Fluxer.app webhooks using the Ruby programming language. This package (a.k.a. Gem) is not officially endorsed by fluxer.app and this is not an official fluxer.app 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 an early alpha state so expect things to be buggy and/or broken.
+
+## Setup
+
+You can install Fluxerrb through the following methods:
+
+#### Method 1: Install from Gemfile
+
+Add the following to your Gemfile file and run the "[bundle install](https://rubygems.org/gems/fluxerrb)" command:
+
+```ruby
+gem 'fluxerrb'
+```
+
+or add the following to your Gemfile file to install with Git.
+
+```ruby
+gem 'fluxerrb', git: 'https://codeberg.org/roxannewolf/fluxerrb'
+```
+
+## Usage
+
+You can make a simple bot like this:
+
+```ruby
+require 'fluxerrb'
+
+bot = Fluxerrb::Bot.new(token: 'YOUR_BOT_TOKEN_HERE', prefix: '!')
+
+bot.on :message do |msg|
+	next if msg['author'].nil? || msg['author']['bot'] == true
+	puts "New Message: #{msg['content']}"
+
+	if msg['content'].downcase == 'ping'
+		bot.send_message(msg['channel_id'], "Pong!")
+	end
+end
+
+bot.start
+```
+
+Webhook example:
+
+```ruby
+require 'fluxerrb'
+
+webhook = Fluxerrb::Webhook.from_url("<WEBHOOK_URL>")
+webhook.send_message("Hello World! This message was sent through a webhook using fluxerrb.")
+```
+
+You can view the examples directory for more examples on using this Gem
+
+## Support and Help
+
+If you need help with this ruby package (a.k.a. Gem), feel free to join the [Roxanne Studios Fluxer Server](https://fluxer.gg/AVbb4B5S) and use the Fluxerrb category to talk about this package.

data/lib/fluxerrb/client.rb

@@ -0,0 +1,208 @@
+# lib/fluxerrb/client.rb
+require 'net/http'
+require 'json'
+require 'websocket-client-simple'
+
+module Fluxerrb
+	class Bot
+		attr_accessor :base_url, :token, :prefix, :reconnect_attempts
+
+		def initialize(config = {})
+			@base_url = config[:base_url] || 'https://api.fluxer.app/v1'
+			@gateway_url = config[:gateway_url] || 'wss://gateway.fluxer.app/?v=1'
+			@token = config[:token]
+			@prefix = config[:prefix] || '!'
+
+			@reconnect_attempts = 0
+			@max_reconnects = 5
+			@event_handlers = { message: [], command: [] }
+			@sequence = nil
+		end
+
+		def on(event_type, &block)
+			@event_handlers[event_type] << block if @event_handlers.key?(event_type)
+		end
+
+		def start
+			raise "[fluxerrb]: Bot token not set" unless @token
+			@running = true
+			connect_gateway
+			while @running
+				sleep 1
+			end
+		end
+
+		private
+
+		def connect_gateway
+			puts "[fluxerrb]: Connecting to gateway: #{@gateway_url}..."
+			ENV['SSL_CERT_FILE'] = nil
+			ENV['OPENSSL_SSL_PROXY_VERIFY'] = 'none'
+			OpenSSL::SSL.send(:remove_const, :VERIFY_PEER) if OpenSSL::SSL.const_defined?(:VERIFY_PEER)
+			OpenSSL::SSL.const_set(:VERIFY_PEER, OpenSSL::SSL::VERIFY_NONE)
+			@ws = WebSocket::Client::Simple.connect(@gateway_url)
+			bot_instance = self
+			@ws.on :open do
+				puts "[fluxerrb]: Connected to Fluxer Gateway!"
+				bot_instance.reconnect_attempts = 0
+			end
+
+			@ws.on :message do |msg|
+				next if msg.data.nil? || msg.data.empty?
+
+				begin
+					payload = JSON.parse(msg.data)
+					bot_instance.send(:handle_gateway_payload, payload)
+				rescue JSON::ParserError => e
+					puts "JSON Parsing Error: #{e.message} | Raw Data: #{msg.data}"
+				end
+			end
+
+			@ws.on :close do |e|
+				puts "[fluxerrb]: Connection closed by gateway. Code: #{e}"
+				bot_instance.send(:stop_heartbeat)
+				bot_instance.send(:handle_reconnect)
+			end
+
+			@ws.on :error do |e|
+				puts "[fluxerrb]: WebSocket Error: #{e}"
+			end
+		end
+
+		def handle_gateway_payload(payload)
+			@sequence = payload['s'] if payload.key?('s')
+
+			case payload['op'].to_i
+			when 10
+				interval = payload['d']['heartbeat_interval'].to_f / 1000.0
+				puts "Received HELLO. Heartbeat interval set to #{interval}s."
+				start_heartbeat(interval)
+				send_identify
+			when 11
+				# Keep silent as the server acknowledges the ping.
+			when 0
+				handle_gateway_event(payload)
+			end
+		end
+
+		def start_heartbeat(interval)
+			stop_heartbeat
+			@heartbeat_thread = Thread.new do
+				loop do
+					sleep interval
+					puts "[fluxerrb]: Sending heartbeat (Sequence: #{@sequence})..."
+					send_payload(1, @sequence)
+				end
+			end
+		end
+
+		def stop_heartbeat
+			@heartbeat_thread&.kill
+			@heartbeat_thread = nil
+		end
+
+		def send_identify
+			identify_data = {
+				token: @token,
+				intents: 0,
+				properties: {os: RUBY_PLATFORM, browser: "fluxerrb", device: "fluxerrb"}
+			}
+			send_payload(2, identify_data)
+		end
+
+		def send_payload(op, data)
+			return unless @ws && @ws.open?
+			@ws.send({ op: op, d: data }.to_json)
+		rescue => e
+			puts "Failed to transmit payload: #{e.message}"
+		end
+
+		def handle_reconnect
+			return unless @running
+			if @reconnect_attempts >= @max_reconnects
+				puts "[fluxerrb]: Reconnection attempts failed. Exiting"
+				@running = false
+				return
+			end
+
+			@reconnect_attempts += 1
+			wait_time = @reconnect_attempts * 3
+			puts "[fluxerrb]: Attempting to reconnect in #{wait_time} seconds..."
+
+			sleep wait_time
+			connect_gateway if @running
+		end
+
+		def handle_gateway_event(payload)
+			case payload['t']
+			when 'READY'
+				puts "Fluxer Bot is ONLINE and READY!"
+			when 'MESSAGE_CREATE'
+				message_data = payload['d']
+				@event_handlers[:message].each { |handler| handler.call(message_data) }
+
+				if message_data['content']&.start_with?(@prefix)
+					raw_content = message_data['content']
+					parts = raw_content.slice(@prefix.length..-1).split(' ')
+					command_name = parts.first
+					args = parts[1..-1] || []
+
+					ctx = { message: message_data, command: command_name, args: args, content: args.join(' '), channel_id: message_data['channel_id'], client: self }
+
+					@event_handlers[:command].each { |handler| handler.call(ctx) }
+				end
+			end
+		end
+
+		public
+
+		def request(method, path, body = nil)
+			uri = URI("#{@base_url}#{path}")
+			http = Net::HTTP.new(uri.host, uri.port)
+			if uri.scheme == 'https'
+				http.use_ssl = true
+				http.verify_mode = OpenSSL::SSL::VERIFY_NONE 
+			end
+
+			req_class = Object.const_get("Net::HTTP::#{method.capitalize}")
+			req = req_class.new(uri.path, {
+				'Authorization' => "Bot #{@token}",
+				'Content-Type'  => 'application/json'
+			})
+			req.body = body.to_json if body
+			response = http.request(req)
+
+			if response.code.to_i == 429
+				puts "[fluxerrb]: AN ERROR HAS OCCURED: 429 Ratelimit."
+				@running = false
+				exit(1)
+			end
+
+			JSON.parse(response.body) rescue response.body
+		end
+
+		def send_message(channel_id, content = "", embed = nil)
+			payload = {}
+			payload[:content] = content unless content.empty?
+			payload[:embed] = embed if embed
+			request('post', "/channels/#{channel_id}/messages", payload)
+		end
+		def get_channel(channel_id)
+			request('get', "/channels/#{channel_id}")
+		end
+		def get_guild(guild_id)
+			request('get', "/guilds/#{guild_id}")
+		end
+		def nsfw?(channel_or_id)
+			channel_data = channel_or_id.is_a?(Hash) ? channel_or_id : get_channel(channel_or_id)
+			!!channel_data['nsfw']
+		end
+		def server_owner?(author_id, guild_or_id)
+			guild_data = guild_or_id.is_a?(Hash) ? guild_or_id : get_guild(guild_or_id)
+			author_id.to_s == guild_data['owner_id'].to_s
+		end
+		def user_id?(author_id, target_id)
+			author_id.to_s == target_id.to_s
+		end
+	end
+end

data/lib/fluxerrb/version.rb

@@ -0,0 +1,3 @@
+module FluxerrbVersion
+	VERSION = "0.0.1"
+end

data/lib/fluxerrb/webhooks.rb

@@ -0,0 +1,48 @@
+# lib/fluxerrb/webhooks.rb
+require 'net/http'
+require 'json'
+
+module Fluxerrb
+	class Webhook
+		attr_accessor :base_url, :webhook_id, :webhook_token
+		def initialize(config = {})
+			@base_url = config[:base_url] || 'https://api.fluxer.app/v1'
+			@webhook_id = config[:id]
+			@webhook_token = config[:token]
+		end
+
+		def self.from_url(url, base_override = nil)
+			uri = URI(url)
+			parts = uri.path.split('/')
+
+			token = parts.pop
+			id = parts.pop 
+
+			base = base_override || "#{uri.scheme}://#{uri.host}/v1"
+			new(base_url: base, id: id, token: token)
+		end
+
+		def send_message(content, extra_params = {})
+			raise "[fluxerrb]: Webhook ID/Token not set" unless @webhook_id && @webhook_token
+
+			path = "/webhooks/#{@webhook_id}/#{@webhook_token}"
+			uri = URI("#{@base_url}#{path}")
+			payload = { content: content }.merge(extra_params)
+			http = Net::HTTP.new(uri.host, uri.port)
+			if uri.scheme == 'https'
+				http.use_ssl = true
+				http.verify_mode = OpenSSL::SSL::VERIFY_NONE 
+			end
+			req = Net::HTTP::Post.new(uri.path, { 'Content-Type' => 'application/json' })
+			req.body = payload.to_json
+			response = http.request(req)
+
+			if response.code.to_i == 429
+				puts "[fluxerrb]: AN ERROR HAS OCCURED: 429 Ratelimit."
+				return false
+			end
+
+			response.code.to_i == 200 || response.code.to_i == 204
+		end
+	end
+end

data/lib/fluxerrb.rb

@@ -0,0 +1,8 @@
+# lib/fluxerrb.rb
+require_relative 'fluxerrb/client'
+require_relative 'fluxerrb/webhooks'
+require_relative 'fluxerrb/version'
+
+module Fluxerrb
+	# This module can serve as a namespace for the gem's classes. For now, it's a direct require.
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: fluxerrb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Roxanne Studios
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: The first Ruby package (a.k.a. gem) to exist for making Fluxer.app bots
+  and using Fluxer.app webhooks. This project is not officially endorsed by Fluxer.app
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/fluxerrb.rb
+- lib/fluxerrb/client.rb
+- lib/fluxerrb/version.rb
+- lib/fluxerrb/webhooks.rb
+homepage: https://codeberg.org/roxannewolf/fluxerrb
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://codeberg.org/roxannewolf/fluxerrb/src/branch/main/CHANGELOG.md
+  documentation_uri: https://codeberg.org/roxannewolf/fluxerrb/src/branch/main/README.md
+  source_code_uri: https://codeberg.org/roxannewolf/fluxerrb
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Ruby gem for making Fluxer.app bots
+test_files: []