topgg 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7df2047fafadab0512acb6dea7eaf26340c7287d0b6be8b4a194e2a3876b676
-  data.tar.gz: af78cad719c0a3a58b36800fb045ce53fd28dbfc31095ba8f7d29caccab80716
+  metadata.gz: efdefad75123d5205da0ca899e47fe4f3c0c3a3269b7dfd7a68697f206bf36ec
+  data.tar.gz: 99703e90fe21baa924be88ea389ddf0bfb8a90e2580ef29138e350784feab723
 SHA512:
-  metadata.gz: 60061b954b40cf38adc64eda4fceb34682a62c511041bbd01090a911215c6df63316be05a7008f75231bd0f7a3f12fc4f47794142e69668e9679e1cedfd1e1f3
-  data.tar.gz: 36c8e67ceebae7723932f9b43972ce8647c3d0d346e0e9e8ff22185ddd7f89d1b9d2f90cd8d62a91f15cfa59086c0ab5d124726288c050ce56a06950a8c83e2b
+  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,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'faraday'
+require_relative 'topgg/utils/request'
 require 'json'
 require_relative 'topgg/bot'
 require_relative 'topgg/botSearch'
@@ -16,64 +16,61 @@ 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
+  # @return [Dbl::Bot] The Bot Object
   def get_bot(id)
-    resp = @conn.get("bots/#{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 [Object] params The parameters that can be used to query a search
   # To know what the parameters are check it out here
-  # @return [Spreader::BotSearch] The BotSearch Object
+  # @return [Dbl::BotSearch] The BotSearch Object
   def search_bot(params)
-    resp = @conn.get('bots', params)
-    Spreader::BotSearch.new(JSON.parse(resp.body))
+    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]
+  # @return [Dbl::Stats]
   def get_stats(id)
-    resp = @conn.get("bots/#{id}/stats")
+    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
@@ -86,7 +83,7 @@ class Topgg
       shards: shards,
       shard_count: shard_count
     }.to_json
-    @conn.post("bots/#{@id}/stats", json_post, { 'Content-Type' => 'application/json' })
+    @request.post("bots/#{@id}/stats", json_post, { 'Content-Type' => 'application/json' })
   end
 
   # Auto-posts stats on to the top.gg website
@@ -120,3 +117,4 @@ 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
@@ -11,6 +11,8 @@ module Spreader
     attr_reader :obj
 
     alias :raw :obj
+
+    alias data obj
     # Returns error message, if there's an error
     # @return [String]
     def error

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,6 +10,10 @@ module Spreader
     # Get raw hash response
     # @return [Hash]
     attr_reader :obj
+    
+    alias raw obj
+
+    alias data obj
 
     # The Total number of results
     # @return [Integer]

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.5'
+  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.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Adonis Tremblay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-11 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,8 +28,6 @@ files:
 - lib/topgg/stats.rb
 - lib/topgg/user.rb
 - lib/topgg/votes.rb
-- pkg/topgg-1.0.1.gem
-- pkg/topgg-1.0.2.gem
 - topgg.gemspec
 homepage: https://github.com/rhydderchc/topgg-ruby
 licenses:
@@ -55,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