topgg 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cbae83079b3b78337e9006b5850b43a609d5b14f95d05a0a8c30e16a7a1075e
-  data.tar.gz: 89d011bb153dbab77d40a5c2fb2afb09c8345f14807acb5593746280fd25ca56
+  metadata.gz: efdefad75123d5205da0ca899e47fe4f3c0c3a3269b7dfd7a68697f206bf36ec
+  data.tar.gz: 99703e90fe21baa924be88ea389ddf0bfb8a90e2580ef29138e350784feab723
 SHA512:
-  metadata.gz: 242cdd6fbce9eea79010911afc0223d5611a65689e3332d2ff7d2cbc050e431ce138b77617e6d4c53e38f43e1f6452bd09165be7edcf2374e1bd05ae7a18d76d
-  data.tar.gz: 7d2fe752e4f83879594909fd6d96fa699227b9bb4c9e3bfa851c28341739365f170a3825304155c0c17bb86df95d369bda42467d72d388822b76f58a0a6d61bb
+  metadata.gz: a31882f04bd664e714198254b4338fe5d8c68503fba6b0ae83f71d0e36dff130052c6f9c06dfd9eeef8c0abd384e750173f359a84746d73819d3083397cfad0b
+  data.tar.gz: 3f70900291e2d8fe4f7a574eda247281bb4f7e295286cea11f256f2648348e67c9d48aa7ba4966cef3ccefe6f8bd78c538840cdea4ceac49f509dd3c3ffcf323

data/Gemfile

@@ -5,5 +5,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in topgg.gemspec
 gemspec
 
-gem 'faraday'
 gem 'rake', '~> 13.0'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 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
+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

@@ -1,17 +1,27 @@
-# Top.gg Ruby
+# [Top.gg](https://top.gg) Ruby
 
-This Software Development Kit provides you with a wrapper to the top.gg api, that allows you 
+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.
 
+It provides you with numerous methods to interact with the API.
 ## Dependencies
 
 * Ruby 
-* Faraday (The client to automate requests)
 
 ## Installation
 
+``` bash
 
+gem install topgg
 
+```
+## Note
+
+You require a Token to interact with the Api.
+The token can be found at `https://top.gg/bot/[YOUR_BOT_ID]/webhooks` 
+
+
+![page](https://i.ibb.co/txp0ghr/Screenshot-from-2021-10-31-00-59-39.png)
 ## Example
 
 Here's a straightforward example of how to request data with the wrapper.
@@ -21,27 +31,29 @@ require 'topgg'
 
 client = Topgg.new("AUTH_TOKEN", "BOTID")
 
-client.getBot("1234").defAvatar
+client.get_bot("1234").defAvatar
 # returns
 # "6debd47ed13483642cf09e832ed0bc1b"
 
 ```
-### AutoPosting
+### Auto Posting
 
-The wrapper provides you with autoposting functionality
-with the wrapper posting bot statistics every 30 minutes.
-Here's how you can enable it
+The library provides you with autoposting functionality, and autoposts at an interval of 30 minutes.
+Here's how you can use it
 
 ```ruby
 require 'topgg'
 require 'discordrb'
 
 bot = Discordrb::Bot.new token: "TOKEN"
-client = Topgg.new("AUTH_TOKEN", "BOTID")
 
-client.autoPostStats(bot) # The discordrb bot client.
+client = Topgg.new("AUTH_TOKEN", "BOTID")
+ bot.ready do |event|
+ client.auto_post_stats(bot) # The discordrb bot client.
+end
+bot.run
 ```
 
 # Documentation
 
-Check out the documentation [here](https://discord.com)
+Check out the api reference [here](https://rubydoc.info/gems/topgg/)

data/lib/lib.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'faraday'
+
+require_relative 'topgg/utils/request'
 require 'json'
 require_relative 'topgg/bot'
 require_relative 'topgg/botSearch'
@@ -15,90 +16,85 @@ class Topgg
   def initialize(token, id)
     @id = id
     @token = token
-    @conn =  Faraday.new(
-      url: 'https://top.gg/api',
-      headers: { 'authorization' => @token }
-    )
+    @request = Dbl::Utils::Request.new(token)
   end
 
   # The method fetches bot statistics from top.gg
   # @param id [String] The id of the bot you want to fetch statistics from.
-  # @return [Spreader::Bot] The Bot Object
-  def getBot(id)
-    resp = @conn.get("bots/#{id}")
+  # @return [Dbl::Bot] The Bot Object
+  def get_bot(id)
+    resp = @request.get("bots/#{id}")
 
-    Spreader::Bot.new(JSON.parse(resp.body))
+    Dbl::Bot.new(resp)
   end
 
   # The method searches bots from top.gg using a keyword query.
-  # @param query [String] the search term
-  # @param limit [Integer] the amount of results to return
-  # @param offset [Integer] The Amount of bots to skip
-  # @param sort [Boolean] The fields to sort by.
-  # @return [Spreader::BotSearch] The BotSearch Object
-  def searchBot(query, limit: 50, offset: 0, sort: nil, fields: nil)
-    resp = @conn.get('bots', { search: query, limit: limit, offset: offset, sort: sort, fields: fields })
-    Spreader::BotSearch.new(JSON.parse(resp.body))
+  # @param [Object] params The parameters that can be used to query a search
+  # To know what the parameters are check it out here
+  # @return [Dbl::BotSearch] The BotSearch Object
+  def search_bot(params)
+    resp = @request.get('bots/search', params)
+    Dbl::BotSearch.new(resp)
   end
 
   # Search for a user on top.gg with id
   # @param id [String] The id of the user to search for.
-  # @return [Spreader::User]
+  # @return [Dbl::User]
   def user(id)
-    resp = @conn.get("users/#{id}")
+    resp = @request.get("users/#{id}")
 
-    Spreader::User.new(JSON.parse(resp.body))
+    Dbl::User.new(resp)
   end
 
   # Get Bot statistics.
   # @param id [String] Id of the bot you want to get statistics of
-  # @return [Spreader::Stats]
-  def getStats(id)
-    resp = @conn.get("bots/#{id}/stats")
+  # @return [Dbl::Stats]
+  def get_stats(id)
+    resp = @request.get("bots/#{id}/stats")
 
-    Spreader::Stats.new(JSON.parse(resp.body))
+    Dbl::Stats.new(resp)
   end
 
   # Mini-method to query if the bot(self) was voted by the user.
   # @param userid [String] The user id.
   # @return [Boolean]
   def voted?(userid)
-    resp = @conn.get("bots/#{@id}/check", { userId: userid })
+    resp = @request.get("bots/#{@id}/check", { userId: userid })
 
-    ret = JSON.parse(resp.body)
+    ret = resp
     ret['voted'] == 1
   end
 
   # Get the Last 1000 votes of the bot(self)
-  # @return [Spreader::Votes]
+  # @return [Dbl::Votes]
   def votes
-    resp = @conn.get("bots/#{@id}/votes")
+    resp = @request.get("bots/#{@id}/votes")
 
-    Spreader::Votes.new(JSON.parse(resp.body))
+    Dbl::Votes.new(resp)
   end
 
   # Post Bot Statistics to the website
   # @param server_count [Integer] The amount of servers the bot is in.
   # @param shards [Integer] The amount of servers the bot is in per shard
   # @param shard_count [Integer] The total number of shards.
-  def postStats(server_count, shards: nil, shard_count: nil)
-    jsonPost = {
+  def post_stats(server_count, shards: nil, shard_count: nil)
+    json_post = {
       server_count: server_count,
       shards: shards,
       shard_count: shard_count
     }.to_json
-    @conn.post("bots/#{@id}/stats", jsonPost, { 'Content-Type' => 'application/json' })
+    @request.post("bots/#{@id}/stats", json_post, { 'Content-Type' => 'application/json' })
   end
 
-  # Autopost stats on to the top.gg website
+  # Auto-posts stats on to the top.gg website
   # @param client [Discordrb::Bot] instanceof discordrb client.
-  def autoPostStats(client)
+  def auto_post_stats(client)
     semaphore = Mutex.new
     Thread.new do
       semaphore.synchronize do
         interval 1800 do
-          serverLen = client.servers.length
-          postStats(serverLen)
+          server_len = client.servers.length
+          post_stats(server_len)
           print("[TOPGG] : \033[31;1;4m Bot statistics has been successfully posted!\033[0m")
         end
       end
@@ -106,18 +102,19 @@ class Topgg
   end
 
   # Mini-method to get statistics on self
-  # @return [getBot]
+  # @return [get_bot]
   def self
-    getBot(@id)
+    get_bot(@id)
   end
 
   def interval(seconds)
     loop do
       yield
-     sleep seconds
-
+       sleep seconds
     end
   end
 end
 
 
+
+

data/lib/topgg/bot.rb

@@ -1,4 +1,4 @@
-module Spreader
+module Dbl
   # The Bot class spreads the json parsed hash into different methods
   class Bot
     # Initializes the Bot class
@@ -10,28 +10,31 @@ module Spreader
     # @return [Hash]
     attr_reader :obj
 
+    alias :raw :obj
+
+    alias data obj
     # Returns error message, if there's an error
     # @return [String]
     def error
-      @obj['error']
+      @obj['error'].to_str
     end
 
     # Returns the default Avatar of the client
     # @return [String]
     def defAvatar
-      @obj['defAvatar']
+      @obj['defAvatar'].to_str
     end
 
     # Returns the invite link of the bot
     # @return [String]
     def invite
-      @obj['invite']
+      @obj['invite'].to_str
     end
 
     # Returns the bot website, if configured
     # @return [String]
     def website
-      @obj['website']
+      @obj['website'].to_str
     end
 
     # Returns support server link
@@ -43,37 +46,37 @@ module Spreader
     # Returns github repository link, if any
     # @return [String]
     def github
-      @obj['github']
+      @obj['github'].to_str
     end
 
     # Returns the long Description of the bot
     # @return [String]
     def longdesc
-      @obj['longdesc']
+      @obj['longdesc'].to_str
     end
 
     # Returns the short description of the bot
     # @return [String]
     def shortdesc
-      @obj['shortdesc']
+      @obj['shortdesc'].to_str
     end
 
     # Returns the default prefix of the bot
     # @return [String]
     def prefix
-      @obj['prefix']
+      @obj['prefix'].to_str
     end
 
     # Returns the bot library
     # @return [String]
     def lib
-      @obj['lib']
+      @obj['lib'].to_str
     end
 
     # Returns the bot client id
     # @return [String]
     def clientid
-      @obj['clientid']
+      @obj['clientid'].to_str
     end
 
     # Returns the avatar link of the bot
@@ -85,19 +88,19 @@ module Spreader
     # Returns the bot id
     # @return [String]
     def id
-      @obj['id']
+      @obj['id'].to_str
     end
 
     # Returns the bot descriminator
     # @return [String]
     def descriminator
-      @obj['descriminator']
+      @obj['descriminator'].to_str
     end
 
     # Returns the bot username
     # @return [String]
     def username
-      @obj['username']
+      @obj['username'].to_str
     end
 
     # Returns the date on which the bot was submitted
@@ -115,61 +118,61 @@ module Spreader
     # Returns the amount of shards
     # @return [String]
     def shard_count
-      @obj['shard_count']
+      @obj['shard_count'].to_str
     end
 
     # Returns configured guilds in which the bot is in
     # @return [String]
     def guilds
-      @obj['guilds']
+      @obj['guilds'].to_str
     end 
 
     # Returns the amount of guilds per shard of the bot
     # @return [String]
     def shards
-      @obj['shards']
+      @obj['shards'].to_str
     end
 
     # Returns the monthyPoints of the bot
     # @return [String]
     def monthlyPoints
-      @obj['monthlyPoints']
+      @obj['monthlyPoints'].to_str
     end
 
     # Returns the total points of the bot
     # @return [String]
     def points
-      @obj['points']
+      @obj['points'].to_str
     end
 
     # Returns true/false depending on if the bot is certified or not
     # @return [Boolean]
     def certifiedBot
-      @obj['certifiedBot']
+      @obj['certifiedBot'].to_str
     end
 
     # Returns the owner ids
     # @return [Array<String>]
     def owners
-      @obj['owners']
+      @obj['owners'].to_str
     end
 
     # Return the bot tags
     # @return [Array<String>]
     def tags
-      @obj['tags']
+      @obj['tags'].to_str
     end
 
     # Returns the bot banner url
     # @return [String]
     def bannerUrl
-      @obj['bannerUrl']
+      @obj['bannerUrl'].to_str
     end
 
     # Returns the donate bot guild ID
     # @return [String]
     def donatebotguildid
-      @obj['donatebotguildid']
+      @obj['donatebotguildid'].to_str
     end
   end
 end

data/lib/topgg/botSearch.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module Spreader
+module Dbl
   # This class spreads the BotSearch Response body into different methods
   class BotSearch
     # Initalizes the BotSearch class
@@ -10,11 +10,15 @@ module Spreader
     # Get raw hash response
     # @return [Hash]
     attr_reader :obj
+    
+    alias raw obj
+
+    alias data obj
 
     # The Total number of results
     # @return [Integer]
     def total
-      @obj['total']
+      @obj['total'].to_i
     end
 
     # The first result
@@ -26,7 +30,7 @@ module Spreader
     # The number of bots shown in the first page
     # @return [Integer]
     def count
-      @obj['count']
+      @obj['count'].to_i
     end
 
     # Iterates through the results

data/lib/topgg/stats.rb

@@ -1,4 +1,4 @@
-module Spreader
+module Dbl
   # The Stats class spreads the json response into different methods
   class Stats
     # Initializes the Stats class
@@ -9,7 +9,10 @@ module Spreader
 
     # Returns raw Hash of the response
     attr_reader :obj
+    
+    alias raw obj 
 
+    alias data obj
     # Returns the server Count of the bot
     # @return [Integer]
     def server_count

data/lib/topgg/user.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module Spreader
+module Dbl
   # The User class, used for Spreading the response body into different methods
   class User
     # Instantiates the class variables
@@ -10,6 +10,9 @@ module Spreader
 
     attr_reader :obj
 
+    alias raw obj
+
+    alias data obj
     # Check for errors, if any
     def error
       @obj['error']

data/lib/topgg/votes.rb

@@ -1,4 +1,4 @@
-module Spreader
+module Dbl
   # This class Spreads the Vote response body into different methods.
   class Votes
     # Initializes the votes class
@@ -10,7 +10,10 @@ module Spreader
     # Get raw hash return of the object
     # @return [Hash]
     attr_reader :obj
+    
+    alias raw obj
 
+    alias data obj
     # Get the first vote amongst all the other votes.
     # @return [Spreader::User]
     def first

data/topgg.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'topgg'
-  spec.version       = '1.0.2'
+  spec.version       = '1.1.0'
   spec.authors       = ['Adonis Tremblay']
   spec.email         = ['rhydderchc@gmail.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: topgg
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Adonis Tremblay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-10-31 00:00:00.000000000 Z
 dependencies: []
 description: This is a ruby library of the top.gg API.
 email:
@@ -17,9 +17,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".bundle/config"
-- CHANGELOG.md
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -29,7 +28,6 @@ files:
 - lib/topgg/stats.rb
 - lib/topgg/user.rb
 - lib/topgg/votes.rb
-- pkg/topgg-1.0.1.gem
 - topgg.gemspec
 homepage: https://github.com/rhydderchc/topgg-ruby
 licenses:
@@ -54,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: A top.gg api wrapper for ruby.

data/.bundle/config

@@ -1,2 +0,0 @@
----
-BUNDLE_WITHOUT: "test"

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2021-06-24
-
-- Initial release