feat: adapt to v1

.gitignore

@@ -1 +1,2 @@
-.bundle
+.bundle
+*.gem

Gemfile

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in topgg.gemspec
 gemspec
 
-gem 'rake', '~> 13.0'
+gem "rack"
+gem "rake"
+gem "ostruct"
+gem "cgi"

Gemfile.lock

@@ -1,19 +1,27 @@
 PATH
   remote: .
   specs:
-    topgg (1.1.0)
+    topgg (1.2.0)
+      rack (~> 3.0.9.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    cgi (0.5.0)
+    ostruct (0.6.1)
+    rack (3.0.9.1)
     rake (13.0.6)
 
 PLATFORMS
+  x64-mingw-ucrt
   x86_64-linux
 
 DEPENDENCIES
-  rake (~> 13.0)
+  cgi (~> 0.5.0)
+  ostruct
+  rack
+  rake
   topgg!
 
 BUNDLED WITH
-   2.2.22
+   2.6.9

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 rhydderchc
+Copyright (c) 2021-2025 rhydderchc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE.txt

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2021 TODO: Write your name
+Copyright (c) 2021-2025 rhydderchc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,57 +1,220 @@
-# [Top.gg](https://top.gg) Ruby
+# Top.gg Ruby SDK
+
+The community-maintained Ruby library for Top.gg.
+
+## Chapters
+
+- [Installation](#installation)
+- [Setting up](#setting-up)
+- [Usage](#usage)
+  - [API v1](#api-v1-1)
+    - [Getting your project's vote information of a user](#getting-your-projects-vote-information-of-a-user)
+    - [Posting your bot's application commands list](#posting-your-bots-application-commands-list)
+  - [API v0](#api-v0-1)
+    - [Getting a bot](#getting-a-bot)
+    - [Getting several bots](#getting-several-bots)
+    - [Getting your project's voters](#getting-your-projects-voters)
+    - [Check if a user has voted for your project](#check-if-a-user-has-voted-for-your-project)
+    - [Getting your bot's statistics](#getting-your-bots-statistics)
+    - [Posting your bot's statistics](#posting-your-bots-statistics)
+    - [Automatically posting your bot's statistics every few minutes](#automatically-posting-your-bots-statistics-every-few-minutes)
+    - [Checking if the weekend vote multiplier is active](#checking-if-the-weekend-vote-multiplier-is-active)
+    - [Generating widget URLs](#generating-widget-urls)
+  - [Webhooks](#webhooks)
+    - [Being notified whenever someone voted for your project](#being-notified-whenever-someone-voted-for-your-project)
 
-The Top.gg Ruby SDK is a lighweight package, that allows you 
-to fetch data from the top.gg api and post data such as statistics to the website.
+## Installation
 
-It provides you with numerous methods to interact with the API.
-## Dependencies
+```sh
+$ gem install topgg
+```
 
-* Ruby 
+## Setting up
 
-## Installation
+### API v1
+
+> **NOTE**: API v1 also includes API v0.
+
+```rb
+require "topgg"
+
+client = V1Topgg.new(ENV["TOPGG_TOKEN"])
+```
+
+### API v0
+
+```rb
+require "topgg"
+
+client = Topgg.new(ENV["TOPGG_TOKEN"])
+```
+
+## Usage
+
+### API v1
+
+#### Getting your project's vote information of a user
+
+```rb
+vote = client.vote("661200758510977084")
+```
+
+#### Posting your bot's application commands list
+
+##### Discordrb
+
+```rb
+commands = bot.rest.api.get_global_application_commands(bot.application_id).to_json
+
+client.post_commands(commands)
+```
+
+##### Raw
+
+```rb
+commands = "[{\"options\":[],\"name\":\"test\",\"name_localizations\":null,\"description\":\"command description\",\"description_localizations\":null,\"contexts\":[],\"default_permission\":null,\"default_member_permissions\":null,\"dm_permission\":false,\"integration_types\":[],\"nsfw\":false}]"
+
+client.post_commands(commands)
+```
+
+### API v0
+
+#### Getting a bot
+
+```rb
+bot = client.get_bot("264811613708746752")
+```
+
+#### Getting several bots
+
+```rb
+bots = client.search_bot({ sort: "id", limit: 50, offset: 0 })
+
+for bot in bots.results do
+  puts bot.username
+end
+```
+
+#### Getting your project's voters
 
-``` bash
+##### First page
 
-gem install topgg
+```rb
+voters = client.votes
 
+for voter in voters.results do
+  puts voter.username
+end
 ```
-## Note
 
-You require a Token to interact with the Api.
-The token can be found at `https://top.gg/bot/[YOUR_BOT_ID]/webhooks` 
+##### Subsequent pages
 
-## Example
+```rb
+voters = client.votes(2)
 
-Here's a straightforward example of how to request data with the wrapper.
+for voter in voters.results do
+  puts voter.username
+end
+```
 
-```ruby
-require 'topgg'
+#### Check if a user has voted for your project
 
-client = Topgg.new("AUTH_TOKEN", "BOTID")
+```rb
+has_voted = client.voted?("8226924471638491136")
+```
 
-client.get_bot("1234").defAvatar
-# returns
-# "6debd47ed13483642cf09e832ed0bc1b"
+#### Getting your bot's statistics
 
+```rb
+stats = client.get_stats
 ```
-### Auto Posting
 
-The library provides you with autoposting functionality, and autoposts at an interval of 30 minutes.
-Here's how you can use it
+#### Posting your bot's statistics
 
-```ruby
-require 'topgg'
-require 'discordrb'
+```rb
+client.post_stats(bot.server_count)
+```
 
-bot = Discordrb::Bot.new token: "TOKEN"
+#### Automatically posting your bot's statistics every few minutes
 
-client = Topgg.new("AUTH_TOKEN", "BOTID")
- bot.ready do |event|
- client.auto_post_stats(bot) # The discordrb bot client.
+With Discordrb:
+
+```rb
+require "discordrb"
+
+bot = Discordrb::Bot.new(token: env["BOT_TOKEN"], intents: [:servers])
+
+bot.ready do |event|
+  client.auto_post_stats(bot)
+
+  puts("Bot is now ready!")
 end
+
 bot.run
 ```
 
-# Documentation
+#### Checking if the weekend vote multiplier is active
+
+```rb
+is_weekend = client.is_weekend?
+```
+
+#### Generating widget URLs
+
+##### Large
+
+```rb
+widget_url = Dbl::Widget.large(:discord_bot, "574652751745777665")
+```
+
+##### Votes
+
+```rb
+widget_url = Dbl::Widget.votes(:discord_bot, "574652751745777665")
+```
 
-Check out the api reference [here](https://rubydoc.info/gems/topgg/)
+##### Owner
+
+```rb
+widget_url = Dbl::Widget.owner(:discord_bot, "574652751745777665")
+```
+
+##### Social
+
+```rb
+widget_url = Dbl::Widget.social(:discord_bot, "574652751745777665")
+```
+
+### Webhooks
+
+#### Being notified whenever someone voted for your project
+
+##### Ruby on Rails
+
+In your `config/application.rb`:
+
+```rb
+module MyServer
+  class Application < Rails::Application
+    # ...
+
+    config.middleware.use Dbl::Webhook,
+    type: Dbl::Webhook::VOTE,
+    path: "/votes",
+    auth: ENV["MY_TOPGG_WEBHOOK_SECRET"] do |vote|
+      Rails.logger.info "A user with the ID of #{vote.voter_id} has voted us on Top.gg!"
+    end
+  end
+end
+```
+
+##### Sinatra
+
+```rb
+use Dbl::Webhook,
+type: Dbl::Webhook::VOTE,
+path: "/votes",
+auth: ENV["MY_TOPGG_WEBHOOK_SECRET"] do |vote|
+  puts "A user with the ID of #{vote.voter_id} has voted us on Top.gg!"
+end
+```