radarcordrb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8cee9ff34c9b47e7e1746ad9b0e9d0923af629eab2e1520e88ca80ec6edaa379
+  data.tar.gz: b606a508af4cfb19c9b5d147408b7035853a7fe2ca11e2f4d6c73c52e6de64cf
+SHA512:
+  metadata.gz: 6a479e5c501ee2c3943e630b7ebb1530e08371f7c25b0d76a5ce4139741c8f97d317eb5ff4f9e0b7e4ea2cddefa2eef31ffa1922bf1c57801ccb2a8143612c3b
+  data.tar.gz: 1fbb25c672505837a9e74386781ed266f1dacb98b1321d7686d0f2444769025814c642715087881e71ae8f73ff3595a2365859552244c178681046c94564261a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Roxanne Wolf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# radarcordrb
+
+Radarcordrb is a Ruby package (a.k.a. Gem) that allows you to easily interact with the radarcord.net API with the Ruby programming language.
+
+Features include posting your Discord bot's stats (guilds/shards) and pinging your bot's uptime to radarcord.
+
+## Setup
+
+You can install radarcordrb 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/radarcordrb)" command:
+
+```ruby
+gem 'radarcordrb'
+```
+
+or add the following to your Gemfile file and run the "bundle install" command:.
+
+```ruby
+gem 'radarcordrb', git: 'https://gitlab.com/roxannewolf/radarcordrb'
+```
+
+## Usage
+
+Here is a basic example of posting your Discord bot's server count to the radarcord.net website through the radarcord API
+
+```ruby
+require 'radarcordrb'
+radarcordapikey = 'RADARCORD_APIKEY'
+bot_id = 'DISCORD_BOTID_HERE'
+client = Radarcord::Client.new(api_key: radarcordapikey)
+
+begin
+	response = client.poststats(bot_id, guilds: 100)
+	puts "Stats updated successfully: #{response}"
+rescue Radarcord::APIError => e
+	puts "Error posting stats: #{e.message}"
+end
+```
+
+Here is a basic example for sending an uptime ping through the radarcord API
+
+```ruby
+require 'radarcordrb'
+radarcordapikey = 'RADARCORD_APIKEY'
+bot_id = 'DISCORD_BOTID_HERE'
+client = Radarcord::Client.new(api_key: radarcordapikey)
+
+begin
+	response = radarclient.postuptime(bot_id)
+	puts "Uptime ping successful: #{response}"
+rescue Radarcord::APIError => e
+	puts "An error has occured: #{e.message}"
+end
+```
+
+> [!NOTE]
+> Sending the uptime ping to radarcord's API is manual. Keep in mind of radarcord's ratelimit of 2 minutes for the uptime endpoint. Guard rails are added to the package to respect this limit.
+
+## Support and Help
+
+If you need help with this ruby package (a.k.a. Gem), feel free to open an issue on our [Gitlab repo](https://gitlab.com/roxannewolf/radarcordrb) or [Codeberg repo](https://codeberg.org/roxannewolf/radarcordrb)

data/lib/radarcordrb.rb

@@ -0,0 +1,105 @@
+require 'json'
+require 'net/http'
+require 'uri'
+require 'time'
+
+module Radarcord
+	VERSION = '1.0.0'.freeze
+	class APIError < StandardError; end
+
+	class Client
+		BASE_URL = 'https://api.radarcord.net'.freeze
+		UPTIMEPING_RATELIMIT_SECONDS = 120
+
+		def initialize(api_key:)
+			@api_key = api_key.to_s
+			@last_uptime_post_time = nil
+			raise ArgumentError, '[Radarcordrb] API key is not provided' if @api_key.empty?
+		end
+
+		def poststats(bot_id, guilds:, shards: nil)
+			raise ArgumentError, '[Radarcordrb] Guilds count is required.' unless guilds
+			path = "/bot/#{bot_id}/stats"
+			body = { guilds: guilds }
+			body[:shards] = shards if shards
+			_authorized_post(path, body)
+		end
+
+		def postuptime(bot_id)
+			if @last_uptime_post_time && (Time.now - @last_uptime_post_time) < UPTIMEPING_RATELIMIT_SECONDS
+				seconds_to_wait = (UPTIMEPING_RATELIMIT_SECONDS - (Time.now - @last_uptime_post_time)).ceil
+				puts "[Radarcordrb] WARNING: Uptime post was recently called. Skipping request to respect the 2-minute rate limit (wait #{seconds_to_wait}s)."
+				return true
+			end
+
+			path = "/bot/#{bot_id}/uptime"
+			response = _authorized_post(path, {})
+			@last_uptime_post_time = Time.now
+			response
+		end
+
+		def post_commands(bot_id, commands)
+			path = "/bot/#{bot_id}/commands"
+			body = { commands: commands }
+			_authorized_post(path, body)
+		end
+
+		def get_botinfo(id_or_vanity)
+			path = "/bot/#{id_or_vanity}/"
+			_get(path)
+		end
+
+		def get_userinfo(user_id)
+			path = "/user/#{user_id}"
+			_get(path)
+		end
+
+		def has_voted(user_id, bot_id)
+			path = "/hasvoted/#{user_id}/#{bot_id}"
+			_get(path)
+		end
+
+		def get_last_voted(user_id, bot_id)
+			path = "/lastvoted/#{user_id}/#{bot_id}"
+			_get(path)
+		end
+
+		private
+
+		def _authorized_post(path, body)
+			uri = URI.parse("#{BASE_URL}#{path}")
+			http = Net::HTTP.new(uri.host, uri.port)
+			http.use_ssl = true
+			request = Net::HTTP::Post.new(uri.request_uri, 'Content-Type' => 'application/json')
+			auth_header = "Bearer #{@api_key}"
+			request['Authorization'] = auth_header
+			request.body = body.to_json
+			_send_request(http, request)
+		end
+
+		def _get(path)
+			uri = URI.parse("#{BASE_URL}#{path}")
+			http = Net::HTTP.new(uri.host, uri.port)
+			http.use_ssl = true
+			request = Net::HTTP::Get.new(uri.request_uri)
+			_send_request(http, request)
+		end
+
+		def _send_request(http, request)
+			response = http.request(request)
+			if response.is_a?(Net::HTTPSuccess)
+				return JSON.parse(response.body)
+			end
+
+			error_message = "#{response.code} #{response.message}"
+			begin
+				error_details = JSON.parse(response.body)
+				error_message += ": #{error_details['message'] || response.body}"
+			rescue JSON::ParserError
+				error_message += ": #{response.body}" unless response.body.empty?
+			end
+
+			raise Radarcord::Error, "[Radarcordrb] radarcord API request failed for #{request.path}: #{error_message}"
+		end
+	end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: radarcordrb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Roxanne Studios
+bindir: bin
+cert_chain: []
+date: 1980-01-02 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
+description: radarcordrb is a Ruby gem made to help Ruby bot developers with interacting
+  with the radarcord botlist API.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/radarcordrb.rb
+homepage: https://gitlab.com/roxannewolf/radarcordrb
+licenses:
+- MIT
+metadata: {}
+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.6.9
+specification_version: 4
+summary: Ruby gem for interacting with the radarcord API.
+test_files: []