dblruby 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4680057787917a041e0979551c47c6e4cdc9f10
-  data.tar.gz: 56b41a0ad44a2b4ec64f59db28ab4bdfbb5331ef
+  metadata.gz: 1c5808b684b56bac44e6b9c2ba59ba492c5c9531
+  data.tar.gz: c8d0caa840944b53f48f8302d8367d0a954ba4a9
 SHA512:
-  metadata.gz: f9821d6aae9167946d150889deb2a540caed370976dd26fff9381374d7dc35e78828c05b63baf1864e8690ed109562ad2a6369163ea7eb301b04de57e0f12958
-  data.tar.gz: 5fa58dd63c36bcde3b661c485dd7d78af563f81baac35e3b66bc9643fe75e583c485fe5b52b2bbdfa810924312dd9b008998976a778995522260f27c591d4df8
+  metadata.gz: b1a9eb06b3ef8f0ac6b49c4161824802af97ba57a15904d10e386631747ec87c596e1f92159c88c73c8d97732bac9251cde336431e0e40fb10bd0b6094a2252b
+  data.tar.gz: eff5eb66093b8e7d96b6db2082b3451b86235aff42c1b5fcadd9ec3dec76a91185bb8daafa194ec109267e049506d04117724bf58e18db06631e67b77aeac46d

data/lib/dblruby/bot.rb

@@ -2,6 +2,7 @@
 class DBLRuby::Bot
   # Initialize the bot
   # @param id [Integer, String] Integer/String ID of bot you're requesting.
+  # @raise [DBLRuby::Errors::InvalidBot] if the DBL returns a 404 error.
   def initialize(id)
     url = "https://discordbots.org/api/bots/#{id}"
     @data = JSON.parse(RestClient.get(url))
@@ -15,43 +16,55 @@ class DBLRuby::Bot
 
   alias to_s data
 
-  # Get the bot's invite link.
+  # Return the error if there is one, nil otherwise.
+  # @return [String, nil] the error.
+  def error
+    @data['error']
+  end
+
+  # Return true if there is an error, false otherwise.
+  # @return [true, false] if there is an error.
+  def error?
+    !@data['error'].nil?
+  end
+
+  # The custom bot invite url of the bot.
   # @return [String] the bot's invite link.
   def invite
     @data['invite']
   end
 
-  # Get the bot's GitHub Repo link.
+  # The link to the github repo of the bot.
   # @return [String] the bot's GitHub Repo link.
   def github
     @data['github']
   end
 
-  # Get the bot's website link.
+  # The website url of the bot.
   # @return [String] the bot's website link.
   def website
     @data['website']
   end
 
-  # Get the bot's Long Description.
+  # The long description of the bot. Can contain HTML and/or Markdown.
   # @return [String] the bot's Long Description.
   def longdesc
     @data['longdesc']
   end
 
-  # Get the bot's Short Description.
+  # The short description of the bot.
   # @return [String] the bot's Short Description.
   def shortdesc
     @data['shortdesc']
   end
 
-  # Get the bot's prefix.
+  # The prefix of the bot.
   # @return [String] the bot's prefix.
   def prefix
     @data['prefix']
   end
 
-  # Get the bot's library.
+  # The library of the bot.
   # @return [String] the bot's library.
   def lib
     @data['lib']
@@ -63,7 +76,13 @@ class DBLRuby::Bot
     @data['clientid'].to_i
   end
 
-  # Get the bot's avatar.
+  # The cdn hash of the bot's avatar if the bot has none.
+  # @return [String] the bot's defAvatar.
+  def defavatar
+    @data['defAvatar']
+  end
+
+  # The avatar hash of the bot's avatar.
   # @return [String] the bot's avatar.
   def avatar
     @data['avatar']
@@ -75,13 +94,13 @@ class DBLRuby::Bot
     "https://cdn.discordapp.com/avatars/#{id}/#{avatar}.webp?size=1024"
   end
 
-  # Get the bot's ID.
+  # The id of the bot.
   # @return [Integer] the bot's id.
   def id
     @data['id'].to_i
   end
 
-  # Get the bot's discriminator.
+  # The discriminator of the bot.
   # @return [Integer] the bot's discriminator without the #.
   def discriminator
     @data['discriminator'].delete('#').to_i
@@ -90,7 +109,7 @@ class DBLRuby::Bot
   alias discrim discriminator
   alias tag discriminator
 
-  # Get the bot's username.
+  # The username of the bot.
   # @return [String] the bot's username.
   def username
     @data['username']
@@ -102,19 +121,26 @@ class DBLRuby::Bot
     "#{username}\##{tag}"
   end
 
-  # Get the bot's creation date (on the list).
-  # @return [String] the bot's date.
+  # The date when the bot was approved.
+  # @return [Date] the bot's approval date.
   def date
-    @data['date']
+    Date.parse(@data['date'])
   end
 
-  # Get the bot's support server invite code.
+  # The time when the bot was approved.
+  # This is compatiable with embed.timestamp, unlike #date
+  # @return [Time] the bot's approval time.
+  def time
+    Time.parse(@data['date'])
+  end
+
+  # The support server invite code of the bot.
   # @return [String] the bot's support server code.
   def support
     @data['support']
   end
 
-  # Get the bot's support server link, ready for clicking.
+  # The bot's support server link, ready for clicking.
   # @return [String] the bot's support server link.
   def support_link
     "https://discord.gg/#{support}"
@@ -143,7 +169,7 @@ class DBLRuby::Bot
     @data['shards']
   end
 
-  # Get the bot's monthly votes.
+  # The amount of upvotes the bot has this month.
   # @return [Integer] the bot's monthly points/votes.
   def monthlypoints
     @data['monthlyPoints'].to_i
@@ -151,7 +177,7 @@ class DBLRuby::Bot
 
   alias monthlyvotes monthlypoints
 
-  # Get the bot's total votes.
+  # The amount of upvotes the bot has.
   # @return [Integer] the bot's total points/votes.
   def points
     @data['points'].to_i
@@ -159,7 +185,7 @@ class DBLRuby::Bot
 
   alias votes points
 
-  # Get the bot's certified status.
+  # The certified status of the bot.
   # @return [true, false] the bot's certified status.
   def certifiedbot
     @data['certifiedBot']
@@ -169,18 +195,24 @@ class DBLRuby::Bot
   alias certified certifiedbot
   alias certifiedbot? certifiedbot
 
-  # Get the bot's owners.
+  # The owners of the bot. First one in the array is the main owner.
   # @return [Array<String>] the bot's owners in an array.
   def owners
     @data['owners']
   end
 
-  # Get the bot's sorting tags.
+  # The tags of the bot.
   # @return [Array<String>] the bot's tags in an array.
   def tags
     @data['tags']
   end
 
+  # The vanity url of the bot.
+  # @return [String] the bot's vanity url.
+  def vanity
+    @data['vanity']
+  end
+
   # Get the bot's legacy status.
   # @return [true, false] the bot's legacy status.
   def legacy
@@ -188,9 +220,4 @@ class DBLRuby::Bot
   end
 
   alias legacy? legacy
-
-  # Debug method to force a bot error.
-  def fail
-    raise DBLRuby::Errors::NoData, 'The API didn\'t return anything!'
-  end
 end

data/lib/dblruby/errors.rb

@@ -1,8 +1,5 @@
 # Errors are cool.
 module DBLRuby::Errors
-  # Ran if No Data is returned.
-  class NoData < RuntimeError; end
-
   # Ran if a 404 error is returned in #loadbot
   class InvalidBot < RuntimeError; end
 
@@ -11,4 +8,7 @@ module DBLRuby::Errors
 
   # Ran if a 401 unauthorized error is returned in stats.
   class InvalidAPIKey < RuntimeError; end
+
+  # Ran if a 404 unknown error is returned in stats.
+  class InvalidID < RuntimeError; end
 end

data/lib/dblruby/stats.rb

@@ -9,15 +9,20 @@ class DBLRuby::Stats
 
   # Get the bot's server count, returns an int.
   # @return [Integer] amount of servers the bot is on.
+  # @raise [DBLRuby::Errors::InvalidID] if the DBL returns a 404 error.
   def servercount
     url = "https://discordbots.org/api/bots/#{@id}"
     JSON.parse(RestClient.get(url))['server_count'].to_i
+  rescue RestClient::NotFound
+    raise DBLRuby::Errors::InvalidID,
+          'DBL Returned a 404 unknown error! Did you enter the correct ID?'
   end
 
   alias servers servercount
 
   # Update the bot's server count.
   # @param id [Integer, String] Integer/String ID of bot server count.
+  # @raise [DBLRuby::Errors::InvalidAPIKey] if the DBL returns a 401 error.
   def updateservercount(count)
     url = "https://discordbots.org/api/bots/#{@id}/stats"
     json = '{"server_count":' + count.to_s + '}'
@@ -33,6 +38,7 @@ class DBLRuby::Stats
   # 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.
+  # @raise [DBLRuby::Errors::InvalidAPIKey] if the DBL returns a 401 error.
   def verifyvote(id)
     r = RestClient.get('https://discordbots.org/api/bots/check',
                        params: { userId: id },

data/lib/dblruby/user.rb

@@ -2,6 +2,7 @@
 class DBLRuby::User
   # Initialize the user
   # @param id [Integer, String] Integer/String ID of user you're requesting.
+  # @raise [DBLRuby::Errors::InvalidUser] if the DBL returns a 404 error.
   def initialize(id)
     url = "https://discordbots.org/api/users/#{id}"
     @data = JSON.parse(RestClient.get(url))
@@ -15,19 +16,31 @@ class DBLRuby::User
 
   alias to_s data
 
-  # Get the user's ID.
+  # Return the error if there is one, nil otherwise.
+  # @return [String, nil] the error.
+  def error
+    @data['error']
+  end
+
+  # Return true if there is an error, false otherwise.
+  # @return [true, false] if there is an error.
+  def error?
+    !@data['error'].nil?
+  end
+
+  # The id of the user.
   # @return [Integer] User ID in integer form.
   def id
     @data['id'].to_i
   end
 
-  # Get the user's username.
+  # The username of the user.
   # @return [String] the user's username.
   def username
     @data['username']
   end
 
-  # Get the user's discriminator.
+  # The discriminator of the user.
   # @return [Integer] the user's discriminator without the #.
   def discriminator
     @data['discriminator'].delete('#').to_i
@@ -42,7 +55,13 @@ class DBLRuby::User
     "#{username}\##{tag}"
   end
 
-  # Get the user's avatar.
+  # The cdn hash of the user's avatar if the user has none.
+  # @return [String] the user's defAvatar.
+  def defavatar
+    @data['defAvatar']
+  end
+
+  # The avatar hash of the user's avatar.
   # @return [String] the user's avatar hash.
   def avatar
     @data['avatar']
@@ -54,13 +73,19 @@ class DBLRuby::User
     "https://cdn.discordapp.com/avatars/#{id}/#{avatar}.webp?size=1024"
   end
 
-  # Get the user's bio.
+  # The bio of the user.
   # @return [String] the user's bio.
   def bio
     @data['bio']
   end
 
-  # Get a list of social links for the user
+  # The banner image url of the user
+  # @return [String] the banner image url.
+  def banner
+    @data['banner']
+  end
+
+  # The social usernames of the user.
   # @return [Array<String>] the user's social links.
   def social
     @data['social']
@@ -72,37 +97,37 @@ class DBLRuby::User
     !@data['social'].nil?
   end
 
-  # Get the user's YouTube channel link.
+  # The youtube channel id of the user.
   # @return [String] the user's youtube channel link.
   def youtube
     @data['social']['youtube']
   end
 
-  # Get the user's Reddit link.
+  # The reddit username of the user.
   # @return [String] the user's reddit link.
   def reddit
     @data['social']['reddit']
   end
 
-  # Get the user's Twitter link.
+  # The twitter username of the user.
   # @return [String] the user's twitter link.
   def twitter
     @data['social']['twitter']
   end
 
-  # Get the user's Instagram link.
+  # The instagram username of the user.
   # @return [String] the user's instagram link.
   def instagram
     @data['social']['instagram']
   end
 
-  # Get the user's Github link.
+  # The github username of the user.
   # @return [String] the user's github link.
   def github
     @data['social']['github']
   end
 
-  # Get the user's Hex Colour.
+  # The custom hex color of the user.
   # @return [String] the user's hex code for their page.
   def color
     @data['color']
@@ -110,7 +135,7 @@ class DBLRuby::User
 
   alias colour color
 
-  # Get the user's supporter status.
+  # The supporter status of the user.
   # @return [true, false] the user's supporter status.
   def supporter?
     @data['supporter']
@@ -118,7 +143,7 @@ class DBLRuby::User
 
   alias supporter supporter?
 
-  # Get the user's certified developer status.
+  # The certified status of the user.
   # @return [true, false] the user's certified status.
   def certified?
     @data['lib']
@@ -128,7 +153,7 @@ class DBLRuby::User
   alias certifieddev certified
   alias certifieddev? certified
 
-  # Get the user's mod status.
+  # The mod status of the user.
   # @return [true, false] the user's mod status.
   def mod?
     @data['mod']
@@ -136,7 +161,7 @@ class DBLRuby::User
 
   alias mod mod?
 
-  # Get the user's website moderator status.
+  # The website moderator status of the user.
   # @return [true, false] the user's website mod status.
   def webmod?
     @data['webMod']
@@ -144,16 +169,11 @@ class DBLRuby::User
 
   alias webmod webmod?
 
-  # Get the user's admin status.
+  # The admin status of the user.
   # @return [true, false] the user's admin status.
   def admin?
     @data['admin']
   end
 
   alias admin admin?
-
-  # Debug method to force a bot error.
-  def fail
-    raise DBLRuby::Errors::NoData, 'The API didn\'t return anything!'
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dblruby
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Chewsterchew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-25 00:00:00.000000000 Z
+date: 2018-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -38,7 +38,12 @@ files:
 homepage: http://github.com/Chewsterchew/DBLRuby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/Chewsterchew/DBLRuby/issues
+  changelog_uri: https://github.com/Chewsterchew/DBLRuby/releases
+  homepage_uri: http://github.com/Chewsterchew/DBLRuby
+  source_code_uri: http://github.com/Chewsterchew/DBLRuby
+  wiki_uri: http://github.com/Chewsterchew/DBLRuby/wiki
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -55,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Discord Bot List API for Ruby