dblruby 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aa21e5c1f30bbad1a967215c20de21d90dfbec95f09f036fec45761b522f5bf
-  data.tar.gz: 1e951b5136cc05b88d5c476fc802b455cb566e1f66cd87e203e1ad8580632b11
+  metadata.gz: 1e6da53133ead002925bdd344bb9367f2f979dd4b2ab5f1232f2c6e2bd0b46d4
+  data.tar.gz: 340bf140b1aea90cf31dab26088c95235e444038940906645f028261ede5954b
 SHA512:
-  metadata.gz: 803a3e6d36405413cb753efac90a7cd9ca9b51180534b15ec3f746cbf4448463273f73b2910fc2b1bf5e62524a3b2e683173e11b4ebedc10d1a44b009ad5796b
-  data.tar.gz: 2becd6fac4539ecd073ad8135d5c8ae9988ee3c08ed39d7e54c7e2799936e1253aadbe46ad73e109159407cfc92729f00c45acdacd3e5329731a9edef771f858
+  metadata.gz: 45c19410d54c87abdf52b19d805533f4c64d39b1ef23f8090c838a1a986e02da771dd52757419023761bedf2eb0da644f30cd960a9f07a6954012e892defd025
+  data.tar.gz: fafde3a5a440c066f74bf52ff171a21dafcb8f9279d89172a7ab32aa057729f115fc870ca7b29c8da18873af4f45e3e8481cf4b99567074ec3a250ebf96979d4

data/lib/dblruby.rb

@@ -13,14 +13,25 @@ class DBLRuby
   end
 
   # Initialize stats
+  # @return [Stats] the new stats object
   def stats
     Stats.new(@api, @id)
   end
 
   # Load a bot.
   # @param id [Integer, String] Integer/String ID of the bot you're requesting.
+  # @raise [DBLRuby::Errors::InvalidBot] if a 404 error is returned.
+  # @return [Bot] the new Bot object
   def bot(id)
-    Bot.new(id: id, api: @api)
+    url = "https://top.gg/api/bots/#{id}"
+    data = JSON.parse(RestClient.get(url, Authorization: api))
+    Bot.new(data)
+  rescue RestClient::Unauthorized
+    raise DBLRuby::Errors::InvalidAPIKey,
+          'The API returned a 401 error, I believe your token is invalid.'
+  rescue RestClient::NotFound
+    raise DBLRuby::Errors::InvalidBot,
+          'The API returned a 404 error! Is that bot listed?'
   end
 
   alias_method :loadbot, :bot
@@ -33,14 +44,23 @@ class DBLRuby
 
   # Load a user
   # @param id [Integer, String] Integer/String ID of the user you're requesting.
+  # @raise [DBLRuby::Errors::InvalidUser] if a 404 error is returned.
+  # @return [User] the new user object
   def user(id)
-    User.new(id, api)
+    url = "https://top.gg/api/users/#{id}"
+    data = JSON.parse(RestClient.get(url, Authorization: api))
+    User.new(data)
+  rescue RestClient::Unauthorized
+    raise DBLRuby::Errors::InvalidAPIKey,
+          'The API returned a 401 error, I believe your token is invalid.'
+  rescue RestClient::NotFound
+    raise DBLRuby::Errors::InvalidBot,
+          'The API returned a 404 error! Is that bot listed?'
   end
 
   alias_method :loaduser, :user
 
   # Change the API key
-  # @param apikey [String] API Key of the bot, taken from the DBL.
   attr_writer :api
 
   alias_method :updateapikey, :api=
@@ -48,21 +68,27 @@ class DBLRuby
   alias_method :apikey=, :api=
 
   # Change the bot ID
-  # @param id [Integer, String] Integer/String of the bot's id.
   attr_writer :id
 
   alias_method :updateid, :id=
 
-  # Define weekend
+  # The Weekend endpoint only really tells us if it's a weekend
+  # @see [weekend?] for a simplier version.
+  # @return [Weekend] the new Weekend object
   def weekend
-    Weekend.new
+    url = 'https://top.gg/api/weekend'
+    Weekend.new JSON.parse(RestClient.get(url))
   end
 
-  # Skip the middleman, let's just see if it's the weekend!
+  # Returns true or false depending on if it's the "weekend"
+  # Weekend counts as 2 votes instead of one.
+  # @return [true, false] whether it's the weekend or not
   def weekend?
     weekend.weekend?
   end
 
+  # Start a search
+  # @return [Search] the new search object
   # @see Search#initialize
   def search(search: nil, limit: 50, offset: 0, sort: nil, fields: nil)
     Search.new(search: search, limit: limit, offset: offset, sort: sort, fields: fields)

data/lib/dblruby/bot.rb

@@ -1,18 +1,9 @@
 # Find information about bots.
 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: nil, data: nil, api: nil)
-    if id.nil?
-      @data = data
-    else
-      url = "https://discordbots.org/api/bots/#{id}"
-      @data = JSON.parse(RestClient.get(url, Authorization: api))
-    end
-  rescue RestClient::NotFound
-    raise DBLRuby::Errors::InvalidBot,
-          'The API returned a 404 error! Is that bot listed?'
+  # @param data [JSON] Bot object in JSON form.
+  def initialize(data)
+    @data = data
   end
 
   # @return data in raw json form.

data/lib/dblruby/user.rb

@@ -1,14 +1,9 @@
 # Find information about users.
 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, api)
-    url = "https://discordbots.org/api/users/#{id}"
-    @data = JSON.parse(RestClient.get(url, Authorization: api))
-  rescue RestClient::NotFound
-    raise DBLRuby::Errors::InvalidUser,
-          'The API returned a 404 error! Does that user exist?'
+  # @param data [JSON] User object in JSON form.
+  def initialize(data)
+    @data = data
   end
 
   # @return data in raw json form.
@@ -86,7 +81,7 @@ class DBLRuby::User
   end
 
   # The social usernames of the user.
-  # @return [Array<String>] the user's social links.
+  # @return [Hash<String, String>] the user's social links.
   def social
     @data['social']
   end
@@ -94,7 +89,7 @@ class DBLRuby::User
   # 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?
+    @data['social'] != {}
   end
 
   # The youtube channel id of the user.

data/lib/dblruby/weekend.rb

@@ -1,9 +1,9 @@
 # Find information about the weekend.
 class DBLRuby::Weekend
   # Initialize the weekend
-  def initialize
-    url = 'https://discordbots.org/api/weekend'
-    @data = JSON.parse(RestClient.get(url))
+  # @param data [JSON] the weekend response in JSON form
+  def initialize(data)
+    @data = data
   end
 
   # @return data in raw json form.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dblruby
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Chew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-22 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0.rc1
-description: A Ruby library for the Discord Bot List (https://discordbots.org) API.
+description: A Ruby library for the Top.gg (https://top.gg) API.
 email: chew@chew.pw
 executables: []
 extensions: []
@@ -61,6 +61,7 @@ metadata:
   homepage_uri: http://github.com/Chew/DBLRuby
   source_code_uri: http://github.com/Chew/DBLRuby
   wiki_uri: http://github.com/Chew/DBLRuby/wiki
+  documentation_uri: https://rubydocs.chew.pro/docs/dblruby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -76,8 +77,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: Discord Bot List API for Ruby
+summary: Top.gg / Discord Bot List API for Ruby
 test_files: []