topgg 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ccf9bfc94f4939b8638002c04189a3ef52caf2d22403ef387b188184e7d0735c
+  data.tar.gz: b66aecd679df93a5db506f83fddfc825872994940f79ddf22e6ab235fa4709fb
+SHA512:
+  metadata.gz: 4913aef45f94f44a694a1b6bd1ff185c5908443dc811b16f7652d4fd5d30c1f81a2821830d1ca61ab2a6994e5307980853d094215044fffb1ca08b351a57d0da
+  data.tar.gz: 8d82c6d6831f29322692d57120b7340ecef95d14962fe49e69946fca92b1f31337cd8a043b8f83bdb9da173de315fb8fa03a7c0e95d12ec00dc821f5247fcdf6

data/.bundle/config

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

data/CHANGELOG.md

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

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in topgg.gemspec
+gemspec
+
+gem 'faraday'
+gem 'rake', '~> 13.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+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,47 @@
+# Top.gg Ruby
+
+This Software Development Kit provides you with a wrapper to the top.gg api, that allows you 
+to fetch data from the top.gg api and post data such as statistics to the website.
+
+## Dependencies
+
+* Ruby 
+* Faraday (The client to automate requests)
+
+## Installation
+
+
+
+## Example
+
+Here's a straightforward example of how to request data with the wrapper.
+
+```ruby
+require 'topgg'
+
+client = Topgg.new("AUTH_TOKEN", "BOTID")
+
+client.getBot("1234").defAvatar
+# returns
+# "6debd47ed13483642cf09e832ed0bc1b"
+
+```
+### AutoPosting
+
+The wrapper provides you with autoposting functionality
+with the wrapper posting bot statistics every 30 minutes.
+Here's how you can enable 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.
+```
+
+# Documentation
+
+Check out the documentation [here](https://discord.com)

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/lib.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+require 'faraday'
+require 'json'
+require_relative 'topgg/bot'
+require_relative 'topgg/botSearch'
+require_relative 'topgg/user'
+require_relative 'topgg/stats'
+require_relative 'topgg/votes'
+# Class Topgg
+# The class instantiates all the methods for api requests and posts.
+class Topgg
+  # initializes the class attributes.
+  # @param token [String] The authorization token from top.gg
+  # @param id [String]  The client id of the bot.
+  def initialize(token, id)
+    @id = id
+    @token = token
+    @conn =  Faraday.new(
+      url: 'https://top.gg/api',
+      headers: { 'authorization' => @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}")
+
+    Spreader::Bot.new(JSON.parse(resp.body))
+  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))
+  end
+
+  # Search for a user on top.gg with id
+  # @param id [String] The id of the user to search for.
+  # @return [Spreader::User]
+  def user(id)
+    resp = @conn.get("users/#{id}")
+
+    Spreader::User.new(JSON.parse(resp.body))
+  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")
+
+    Spreader::Stats.new(JSON.parse(resp.body))
+  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 })
+
+    ret = JSON.parse(resp.body)
+    ret['voted'] == 1
+  end
+
+  # Get the Last 1000 votes of the bot(self)
+  # @return [Spreader::Votes]
+  def votes
+    resp = @conn.get("bots/#{@id}/votes")
+
+    Spreader::Votes.new(JSON.parse(resp.body))
+  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 = {
+      server_count: server_count,
+      shards: shards,
+      shard_count: shard_count
+    }.to_json
+    @conn.post("bots/#{@id}/stats", jsonPost, { 'Content-Type' => 'application/json' })
+  end
+
+  # Autopost stats on to the top.gg website
+  # @param client [Discordrb::Bot] instanceof discordrb client.
+  def autoPostStats(client)
+    serverLen = client.servers.length
+    interval 1800 do
+      postStats(serverLen)
+    end
+  end
+  # Mini-method to get statistics on self
+  # @return [getBot]
+  def self
+    getBot(@id)
+  end
+
+  def interval(seconds)
+    loop do
+      yield
+      sleep seconds
+    end
+  end
+end
+
+

data/lib/topgg/bot.rb

@@ -0,0 +1,175 @@
+module Spreader
+  # The Bot class spreads the json parsed hash into different methods
+  class Bot
+    # Initializes the Bot class
+    # @param obj [Object]
+    def initialize(obj)
+      @obj = obj
+    end
+    # Returns raw hash of the parsed json object
+    # @return [Hash]
+    attr_reader :obj
+
+    # Returns error message, if there's an error
+    # @return [String]
+    def error
+      @obj['error']
+    end
+
+    # Returns the default Avatar of the client
+    # @return [String]
+    def defAvatar
+      @obj['defAvatar']
+    end
+
+    # Returns the invite link of the bot
+    # @return [String]
+    def invite
+      @obj['invite']
+    end
+
+    # Returns the bot website, if configured
+    # @return [String]
+    def website
+      @obj['website']
+    end
+
+    # Returns support server link
+    # @return [String]
+    def support
+      "https://discord.gg/#{@obj['support']}"
+    end
+
+    # Returns github repository link, if any
+    # @return [String]
+    def github
+      @obj['github']
+    end
+
+    # Returns the long Description of the bot
+    # @return [String]
+    def longdesc
+      @obj['longdesc']
+    end
+
+    # Returns the short description of the bot
+    # @return [String]
+    def shortdesc
+      @obj['shortdesc']
+    end
+
+    # Returns the default prefix of the bot
+    # @return [String]
+    def prefix
+      @obj['prefix']
+    end
+
+    # Returns the bot library
+    # @return [String]
+    def lib
+      @obj['lib']
+    end
+
+    # Returns the bot client id
+    # @return [String]
+    def clientid
+      @obj['clientid']
+    end
+
+    # Returns the avatar link of the bot
+    # @return [String]
+    def avatar
+      "https://cdn.discordapp.com/avatars/#{@obj['id']}/#{@obj['avatar']}.webp?size=1024"
+    end
+
+    # Returns the bot id
+    # @return [String]
+    def id
+      @obj['id']
+    end
+
+    # Returns the bot descriminator
+    # @return [String]
+    def descriminator
+      @obj['descriminator']
+    end
+
+    # Returns the bot username
+    # @return [String]
+    def username
+      @obj['username']
+    end
+
+    # Returns the date on which the bot was submitted
+    # @return [Date]
+    def date
+      Date.parse(@obj['date'])
+    end
+
+    # Returns the server count of the bot
+    # @return [Integer]
+    def server_count
+      @obj['server_count'].to_i
+    end
+
+    # Returns the amount of shards
+    # @return [String]
+    def shard_count
+      @obj['shard_count']
+    end
+
+    # Returns configured guilds in which the bot is in
+    # @return [String]
+    def guilds
+      @obj['guilds']
+    end 
+
+    # Returns the amount of guilds per shard of the bot
+    # @return [String]
+    def shards
+      @obj['shards']
+    end
+
+    # Returns the monthyPoints of the bot
+    # @return [String]
+    def monthlyPoints
+      @obj['monthlyPoints']
+    end
+
+    # Returns the total points of the bot
+    # @return [String]
+    def points
+      @obj['points']
+    end
+
+    # Returns true/false depending on if the bot is certified or not
+    # @return [Boolean]
+    def certifiedBot
+      @obj['certifiedBot']
+    end
+
+    # Returns the owner ids
+    # @return [Array<String>]
+    def owners
+      @obj['owners']
+    end
+
+    # Return the bot tags
+    # @return [Array<String>]
+    def tags
+      @obj['tags']
+    end
+
+    # Returns the bot banner url
+    # @return [String]
+    def bannerUrl
+      @obj['bannerUrl']
+    end
+
+    # Returns the donate bot guild ID
+    # @return [String]
+    def donatebotguildid
+      @obj['donatebotguildid']
+    end
+  end
+end

data/lib/topgg/botSearch.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module Spreader
+  # This class spreads the BotSearch Response body into different methods
+  class BotSearch
+    # Initalizes the BotSearch class
+    # @param obj [Object] Response Hash
+    def initialize(obj)
+      @obj = obj
+    end
+    # Get raw hash response
+    # @return [Hash]
+    attr_reader :obj
+
+    # The Total number of results
+    # @return [Integer]
+    def total
+      @obj['total']
+    end
+
+    # The first result
+    # @return [Spreader::Bot]
+    def first
+      Spreader::Bot.new(@obj['results'][0])
+    end
+
+    # The number of bots shown in the first page
+    # @return [Integer]
+    def count
+      @obj['count']
+    end
+
+    # Iterates through the results
+    # @return [Array<Spreader::Bot>]
+    def results
+      arr = []
+      flag = 0 # iteration flag
+      @obj['results'].each do |data|
+        arr[flag] = Spreader::Bot.new(data)
+        flag += 1
+      end
+      arr
+    end
+
+    # Length of the results.
+    # @return [Integer]
+    def size
+      @obj['results'].length
+    end
+  end
+end

data/lib/topgg/stats.rb

@@ -0,0 +1,31 @@
+module Spreader
+  # The Stats class spreads the json response into different methods
+  class Stats
+    # Initializes the Stats class
+    # @param obj [Object] Response Hash
+    def initialize(obj)
+      @obj = obj
+    end
+
+    # Returns raw Hash of the response
+    attr_reader :obj
+
+    # Returns the server Count of the bot
+    # @return [Integer]
+    def server_count
+      @obj['server_count']
+    end
+
+    # The amount of servers per shard
+    # @return [Integer]
+    def shards
+      @obj['shards']
+    end
+
+    # Returns the total number of shards
+    # @return [Integer]
+    def shard_count
+      @obj['shard_count']
+    end
+  end
+end

data/lib/topgg/user.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+module Spreader
+  # The User class, used for Spreading the response body into different methods
+  class User
+    # Instantiates the class variables
+    # @param obj [Object] Response Data Object
+    def initialize(obj)
+      @obj = obj
+    end
+
+    attr_reader :obj
+
+    # Check for errors, if any
+    def error
+      @obj['error']
+    end
+
+    # The Id of the user
+    def id
+      @obj['id']
+    end
+
+    # The username of the user
+    def username
+      @obj['username']
+    end
+
+    # The avatar of the user
+    # @return [String]
+    def avatar
+      "https://cdn.discordapp.com/avatars/#{@obj['id']}/#{@obj['avatar']}.webp?size=1024"
+    end
+
+    # The default avatar of the user
+    # @return [String]
+    def defAvatar
+      @obj['defAvatar']
+    end
+
+    # Returns true/false depending upon if the user is a moderator or not.
+    # @return [Boolean]
+    def mod
+      @obj['mod']
+    end
+
+    # Returns true/false depending upon if the user is a supporter or not.
+    # @return [Boolean]
+    def supporter
+      @obj['supporter']
+    end
+
+    # Returns true/false depending upon if the user is a certified developer or not.
+    # @return [Boolean]
+    def certifiedDev
+      @obj['certifiedDev']
+    end
+
+    # Returns an object containing all user social integrations.
+    # @return [Object]
+    def social
+      @obj['social']
+    end
+
+    # Returns true/false depending on weather the user is an admin or not.
+    # @return [Boolean]
+    def admin
+      @obj['admin']
+    end
+
+    # Returns true/false depending on weather the user is a website Moderator or not.
+    # @return [Boolean]
+    def webMod
+      @obj['webMod']
+    end
+  end
+end

data/lib/topgg/votes.rb

@@ -0,0 +1,26 @@
+module Spreader
+  # This class Spreads the Vote response body into different methods.
+  class Votes
+    # Initializes the votes class
+    # @param obj [Object] JSON parsed object
+    def initialize(obj)
+      @obj = obj
+    end
+
+    # Get raw hash return of the object
+    # @return [Hash]
+    attr_reader :obj
+
+    # Get the first vote amongst all the other votes.
+    # @return [Spreader::User]
+    def first
+      Spreader::User.new(@obj[0])
+    end
+
+    # Get the total number of votes
+    # @return [Integer]
+    def total
+      @obj.length
+    end
+  end
+end

data/topgg.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'topgg'
+  spec.version       = '1.0.1'
+  spec.authors       = ['Adonis Tremblay']
+  spec.email         = ['rhydderchc@gmail.com']
+
+  spec.summary       = 'A top.gg api wrapper for ruby.'
+  spec.description   = 'This is a ruby library of the top.gg API.'
+  spec.homepage      = 'https://github.com/rhydderchc/topgg-ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rhydderchc/topgg-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/rhydderchc/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: topgg
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Adonis Tremblay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-28 00:00:00.000000000 Z
+dependencies: []
+description: This is a ruby library of the top.gg API.
+email:
+- rhydderchc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lib.rb
+- lib/topgg/bot.rb
+- lib/topgg/botSearch.rb
+- 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:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rhydderchc/topgg-ruby
+  source_code_uri: https://github.com/rhydderchc/topgg-ruby
+  changelog_uri: https://github.com/rhydderchc/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A top.gg api wrapper for ruby.
+test_files: []