dblruby 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0c726f7da9d2628eb0efcb143338daf975c618c
-  data.tar.gz: 376afe8d73203cdc7ecd957af6be10a67303d53d
+  metadata.gz: 74234c3df2d4ba601ee219351cf3c9a0ec6a5a06
+  data.tar.gz: 64b71fea55fc450f5d35ed5c27e0328ab781ceeb
 SHA512:
-  metadata.gz: ff213aa5f739b3c9a318ab6b99fc6246f3e41abc5209f928af496fd901fc40764df3619e8bffd92931cfc774e7f3159d7ec38979ff36116de17b80d1342567ed
-  data.tar.gz: e4557ab0ee62b5e7464febc20480629030b537940f51480ffa0a1e535b95e05633207b9413debc5ae914ecaaf08a9cbcb8d5929f9c43445f9bba4084f5f12890
+  metadata.gz: efbcc7c1a244954e38460aca78455867ed9d8d8a54846eed6e0831a6349ea18943acf116dfcc67d13ca0573a5cbacc12341ba1b13ceea0a2ddecaa770c6a5be3
+  data.tar.gz: 5ff26982b39589e881e9f79be510a14c757103fe842c979bd713ceed4bc4a7a4d914fb23f16f62d63a29fc5ea3d95f9ac8071785864052aae95b410a0ca1adb8

data/lib/dblruby.rb

@@ -5,6 +5,8 @@ require 'rest-client'
 # All DBLRuby functionality, whether extended or just here.
 class DBLRuby
   # Initialize a new DBL API, via a key.
+  # @param apikey [String] API Key of the bot, taken from the DBL.
+  # @param id [Integer, String] Integer/String of the bot's id.
   def initialize(apikey, id)
     @api = apikey
     @id = id
@@ -16,14 +18,26 @@ class DBLRuby
     @stats = Stats.new(@api, @id)
   end
 
+  # Load a bot.
+  # @param id [Integer, String] Integer/String ID of the bot you're requesting.
   def loadbot(id)
     @bot = Bot.new(id)
   end
 
+  # Load a user
+  # @param id [Integer, String] Integer/String ID of the user you're requesting.
   def loaduser(id)
     @user = User.new(id)
   end
 
+  # Get the ID from instantiation
+  attr_reader :id
+
+  # Get the API Key from instantiation
+  attr_reader :api
+
+  alias apikey api
+
   attr_reader :bot
   attr_reader :user
   attr_reader :stats

data/lib/dblruby/bot.rb

@@ -11,102 +11,121 @@ class DBLRuby::Bot
   attr_reader :data
 
   # Get the bot's invite link.
+  # @return [String] the bot's invite link.
   def invite
     @data['invite']
   end
 
   # Get the bot's GitHub Repo link.
+  # @return [String] the bot's GitHub Repo link.
   def github
     @data['github']
   end
 
   # Get the bot's website link.
+  # @return [String] the bot's website link.
   def website
     @data['website']
   end
 
   # Get the bot's Long Description.
+  # @return [String] the bot's Long Description.
   def longdesc
     @data['longdesc']
   end
 
   # Get the bot's Short Description.
+  # @return [String] the bot's Short Description.
   def shortdesc
     @data['shortdesc']
   end
 
   # Get the bot's prefix.
+  # @return [String] the bot's prefix.
   def prefix
     @data['prefix']
   end
 
   # Get the bot's library.
+  # @return [String] the bot's library.
   def lib
     @data['lib']
   end
 
   # Get the bot's Client ID.
+  # @return [Integer] the bot's client id.
   def clientid
-    @data['clientid']
+    @data['clientid'].to_i
   end
 
   # Get the bot's avatar.
+  # @return [String] the bot's avatar.
   def avatar
     @data['avatar']
   end
 
   # Get's the bot's avatar as an img, ready to be used in image linking.
+  # @return [String] the bot's avatar image url.
   def avatar_img
     "https://cdn.discordapp.com/avatars/#{id}/#{avatar}.webp?size=1024"
   end
 
   # Get the bot's ID.
+  # @return [Integer] the bot's id.
   def id
-    @data['id']
+    @data['id'].to_i
   end
 
   # Get the bot's discriminator.
+  # @return [Integer] the bot's discriminator without the #.
   def discriminator
-    @data['discriminator']
+    @data['discriminator'].delete('#').to_i
   end
 
   alias discrim discriminator
   alias tag discriminator
 
   # Get the bot's username.
+  # @return [String] the bot's username.
   def username
     @data['username']
   end
 
   # Returns the bot's distinct, which is the Username and Discriminator.
+  # @return [String] the bot's distinct.
   def distinct
-    "#{username}#{tag}"
+    "#{username}\##{tag}"
   end
 
   # Get the bot's creation date (on the list).
+  # @return [String] the bot's date.
   def date
     @data['date']
   end
 
   # Get the bot's support server invite code.
+  # @return [String] the bot's support server code.
   def support
     @data['support']
   end
 
   # Get the bot's support server link, ready for clicking.
+  # @return [String] the bot's support server link.
   def support_link
     "https://discord.gg/#{support}"
   end
 
   # Get the bot's server count
+  # @return [Integer] the bot's server count.
   def server_count
-    @data['server_count']
+    @data['server_count'].to_i
   end
 
   alias guild_count server_count
   alias server server_count
 
   # Get the bot's "This Bot Powers the following Servers"
+  # @return [Array<String>] the bot's guilds.
   def guilds
     @data['guilds']
   end
@@ -114,25 +133,29 @@ class DBLRuby::Bot
   alias servers guilds
 
   # Get the bot's shards.
+  # @return [Array<String>] the bot's shards.
   def shards
     @data['shards']
   end
 
   # Get the bot's monthly votes.
+  # @return [Integer] the bot's monthly points/votes.
   def monthlypoints
-    @data['monthlyPoints']
+    @data['monthlyPoints'].to_i
   end
 
   alias monthlyvotes monthlypoints
 
   # Get the bot's total votes.
+  # @return [Integer] the bot's total points/votes.
   def points
-    @data['points']
+    @data['points'].to_i
   end
 
   alias votes points
 
   # Get the bot's certified status.
+  # @return [true, false] the bot's certified status.
   def certifiedbot
     @data['certifiedBot']
   end
@@ -142,16 +165,19 @@ class DBLRuby::Bot
   alias certifiedbot? certifiedbot
 
   # Get the bot's owners.
+  # @return [Array<String>] the bot's owners in an array.
   def owners
     @data['owners']
   end
 
   # Get the bot's sorting tags.
+  # @return [Array<String>] the bot's tags in an array.
   def tags
     @data['tags']
   end
 
   # Get the bot's legacy status.
+  # @return [true, false] the bot's legacy status.
   def legacy
     @data['legacy']
   end

data/lib/dblruby/stats.rb

@@ -7,17 +7,31 @@ class DBLRuby::Stats
     @id = id
   end
 
-  # Get the server count, returns an int.
+  # Get the bot's server count, returns an int.
+  # @return [Integer] amount of servers the bot is on.
   def servercount
     url = "https://discordbots.org/api/bots/#{@id}"
     JSON.parse(RestClient.get(url))['server_count'].to_i
   end
 
   # Update the bot's server count.
+  # @param id [Integer, String] Integer/String ID of bot server count.
   def updateservercount(count)
     url = "https://discordbots.org/api/bots/#{@id}/stats"
     json = '{"server_count":' + count.to_s + '}'
     RestClient.post(url, json, :Authorization => @api, :'Content-Type' => :json)
     "Successfully set the server count to #{count}"
   end
+
+  # Check to see if a user really voted, via an ID.
+  # @param id [Integer, String] Integer/String ID of user you're requesting.
+  # @return [true, false] if the user voted or not.
+  def verifyvote(id)
+    r = RestClient.get('https://discordbots.org/api/bots/check',
+                       params: { userId: id },
+                       :Authorization => @api,
+                       :'Content-Type' => :json)
+    o = JSON.parse(r)['voted'].to_i
+    !o.zero?
+  end
 end

data/lib/dblruby/user.rb

@@ -13,80 +13,94 @@ class DBLRuby::User
   alias to_s data
 
   # Get the user's ID.
-  # @return User ID in integer form.
+  # @return [Integer] User ID in integer form.
   def id
     @data['id'].to_i
   end
 
   # Get the user's username.
+  # @return [String] the user's username.
   def username
     @data['username']
   end
 
   # Get the user's discriminator.
+  # @return [Integer] the user's discriminator without the #.
   def discriminator
-    @data['discriminator']
+    @data['discriminator'].delete('#').to_i
   end
 
   alias discrim discriminator
   alias tag discriminator
 
   # Returns the user's distinct, which is the Username and Discriminator.
+  # @return [String] the user's username + discrim.
   def distinct
-    "#{username}#{tag}"
+    "#{username}\##{tag}"
   end
 
   # Get the user's avatar.
+  # @return [String] the user's avatar hash.
   def avatar
     @data['avatar']
   end
 
   # Get's the user's avatar as an img, ready to be used in image linking.
+  # @return [String] the user's avatar link.
   def avatar_img
     "https://cdn.discordapp.com/avatars/#{id}/#{avatar}.webp?size=1024"
   end
 
   # Get the user's bio.
+  # @return [String] the user's bio.
   def bio
     @data['bio']
   end
 
   # Get a list of social links for the user
+  # @return [Array<String>] the user's social links.
   def social
     @data['social']
   end
 
   # Does the user have any social links? True if so, false if not.
+  # @return [true, false] if the user has any social links.
   def social?
     !@data['social'].nil?
   end
 
   # Get the user's YouTube channel link.
+  # @return [String] the user's youtube channel link.
   def youtube
     @data['social']['youtube']
   end
 
   # Get the user's Reddit link.
+  # @return [String] the user's reddit link.
   def reddit
     @data['social']['reddit']
   end
 
   # Get the user's Twitter link.
+  # @return [String] the user's twitter link.
   def twitter
     @data['social']['twitter']
   end
 
   # Get the user's Instagram link.
+  # @return [String] the user's instagram link.
   def instagram
     @data['social']['instagram']
   end
 
   # Get the user's Github link.
+  # @return [String] the user's github link.
   def github
     @data['social']['github']
   end
 
   # Get the user's Hex Colour.
+  # @return [String] the user's hex code for their page.
   def color
     @data['color']
   end
@@ -94,41 +108,46 @@ class DBLRuby::User
   alias colour color
 
   # Get the user's supporter status.
-  def supporter
+  # @return [true, false] the user's supporter status.
+  def supporter?
     @data['supporter']
   end
 
-  alias supporter? supporter
+  alias supporter supporter?
 
   # Get the user's certified developer status.
-  def certified
+  # @return [true, false] the user's certified status.
+  def certified?
     @data['lib']
   end
 
-  alias certified? certified
+  alias certified certified?
   alias certifieddev certified
   alias certifieddev? certified
 
   # Get the user's mod status.
-  def mod
+  # @return [true, false] the user's mod status.
+  def mod?
     @data['mod']
   end
 
-  alias mod? mod
+  alias mod mod?
 
   # Get the user's website moderator status.
-  def webmod
+  # @return [true, false] the user's website mod status.
+  def webmod?
     @data['webMod']
   end
 
-  alias webmod? webmod
+  alias webmod webmod?
 
   # Get the user's admin status.
-  def admin
+  # @return [true, false] the user's admin status.
+  def admin?
     @data['admin']
   end
 
-  alias admin? admin
+  alias admin admin?
 
   # Debug method to force a bot error.
   def fail

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dblruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Chewsterchew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-22 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A gem made for DBL in ruby.