dblruby 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb8d3b753f0486f2d09ced6e5d2432c9b32584f4
-  data.tar.gz: 6dc1ecdaa199560d8b73925655eadd21971464a5
+  metadata.gz: 26976efdbb810637c0f47ae21edb5905ae183644
+  data.tar.gz: a3efa28a57d5b232f41b2e129c8cde8ead7d7c20
 SHA512:
-  metadata.gz: d1b02c1db54e67035b893409743f8019575aff2354d956c7ebf5346c128826ae0d74182ccd1ff007bb90b3a68708e83093eb1431a7a64349b49a292163416ca5
-  data.tar.gz: ea700ba043738911c3fd51a8718bec70420d3dbffe3dfeeaaf3c175d49070d311442332faac546fbf6f6b945e5b4d23558f0a2198b35f970f07b9ee841845a95
+  metadata.gz: 318b638e5f13794dd4558ead75598248b32786cbd64be498711505e4ee5eaef8c72b11803dc861c5e144176ccdc18d5ac2693ae379746d635be85b31cb47c640
+  data.tar.gz: 734a9d1f29f2ed8364f3648e75cc60d4fe82f2ea0dcf799a61a9bfbf547e4102ca26f1cf417b7d04f391f058774d8ca00e26084d1cbc21bf5ec9a2847dac3caa

data/lib/dblruby.rb

@@ -10,45 +10,58 @@ class DBLRuby
   def initialize(apikey, id)
     @api = apikey
     @id = id
-    makestats
   end
 
   # Initialize stats
-  def makestats
-    @stats = Stats.new(@api, @id)
+  def 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)
+  def bot(id)
+    Bot.new(id: id)
+  end
+
+  alias loadbot bot
+
+  # Get all of the bot's stats as if you just called DBL.bot(id)
+  # @return [Bot] the bot as a bot.
+  def self
+    bot(@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)
+  def user(id)
+    User.new(id)
   end
 
+  alias loaduser user
+
   # Change the API key
   # @param apikey [String] API Key of the bot, taken from the DBL.
-  def updateapi(apikey)
-    @api = apikey
-    makestats
-  end
+  attr_writer :api
 
-  alias updateapikey updateapi
-  alias api= updateapi
-  alias apikey= updateapi
+  alias updateapikey api=
+  alias updateapi api=
+  alias apikey= api=
 
   # Change the bot ID
   # @param id [Integer, String] Integer/String of the bot's id.
-  def updateid(id)
-    @id = id
-    makestats
+  attr_writer :id
+
+  alias updateid id=
+
+  # Define weekend
+  def weekend
+    Weekend.new
   end
 
-  alias id= updateid
+  # @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)
+  end
 
   # Get the ID from instantiation
   attr_reader :id
@@ -57,15 +70,12 @@ class DBLRuby
   attr_reader :api
 
   alias apikey api
-
-  attr_reader :bot
-  attr_reader :user
-  attr_reader :stats
 end
 
 # Require files.
-require 'dblruby/api'
 require 'dblruby/bot'
 require 'dblruby/errors'
 require 'dblruby/user'
+require 'dblruby/search'
 require 'dblruby/stats'
+require 'dblruby/weekend'

data/lib/dblruby/bot.rb

@@ -3,9 +3,13 @@ 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))
+  def initialize(id: nil, data: nil)
+    if id.nil?
+      @data = data
+    else
+      url = "https://discordbots.org/api/bots/#{id}"
+      @data = JSON.parse(RestClient.get(url))
+    end
   rescue RestClient::NotFound
     raise DBLRuby::Errors::InvalidBot,
           'The API returned a 404 error! Is that bot listed?'
@@ -101,9 +105,9 @@ class DBLRuby::Bot
   end
 
   # The discriminator of the bot.
-  # @return [Integer] the bot's discriminator without the #.
+  # @return [String] the bot's discriminator.
   def discriminator
-    @data['discriminator'].delete('#').to_i
+    @data['discriminator']
   end
 
   alias discrim discriminator
@@ -187,13 +191,13 @@ class DBLRuby::Bot
 
   # The certified status of the bot.
   # @return [true, false] the bot's certified status.
-  def certifiedbot
+  def certified?
     @data['certifiedBot']
   end
 
-  alias certified? certifiedbot
-  alias certified certifiedbot
-  alias certifiedbot? certifiedbot
+  alias certifiedbot certified?
+  alias certified certified?
+  alias certifiedbot? certified?
 
   # The owners of the bot. First one in the array is the main owner.
   # @return [Array<String>] the bot's owners in an array.
@@ -207,17 +211,11 @@ class DBLRuby::Bot
     @data['tags']
   end
 
-  # The vanity url of the bot.
-  # @return [String] the bot's vanity url.
-  def vanity
-    @data['vanity']
+  # Get the bot's donate bot guild ID.
+  # @return [String] the bot's donate bot guild ID.
+  def donatebotguildid
+    @data['donatebotguildid']
   end
 
-  # Get the bot's legacy status.
-  # @return [true, false] the bot's legacy status.
-  def legacy
-    @data['legacy']
-  end
-
-  alias legacy? legacy
+  alias donatebotserverid donatebotguildid
 end

data/lib/dblruby/search.rb

@@ -0,0 +1,92 @@
+# A search for the bots
+class DBLRuby::Search
+  # Start a new search
+  # @param limit [Integer] The amount of bots to return. Max. 500
+  # @param offset [Integer] Amount of bots to skip
+  # @param search [String] A search string in the format of field: value field2: value2
+  # @param sort [String] The field to sort by. Prefix with - to reverse the order
+  # @param fields [String] A comma separated list of fields to show.
+  def initialize(search: nil, limit: 50, offset: 0, sort: nil, fields: nil)
+    url = 'https://discordbots.org/api/bots'
+    @search = search
+    @limit = limit
+    @offset = offset
+    @sort = sort
+    @fields = fields
+    @data = JSON.parse(RestClient.get(url, params: { search: search,
+                                                     limit: limit,
+                                                     offset: offset,
+                                                     sort: sort,
+                                                     fields: fields }))
+  end
+
+  # @return data in raw json form.
+  attr_reader :data
+
+  alias to_s data
+
+  # @return [String] the search query
+  attr_reader :search
+
+  # @return [Integer] the limit query
+  attr_reader :limit
+
+  # @return [Integer] the offset query
+  attr_reader :offset
+
+  # @return [String] the sort query
+  attr_reader :sort
+
+  # @return [String] the fields query
+  attr_reader :fields
+
+  # The amount of results returned
+  # @return [String] The amount of bots
+  # @see #count
+  def size
+    @data['results'].length
+  end
+
+  # Gets all the bots
+  # @return [Array<Bot>] a list of the bots
+  def results
+    output = Array.new(size)
+    cur = 0
+    @data['results'].each do |e|
+      output[cur] = DBLRuby::Bot.new(data: e)
+      cur += 1
+    end
+    output
+  end
+
+  # Return only the first bot
+  # @return [Bot] the first bot.
+  def first
+    DBLRuby::Bot.new(data: @data['results'][0])
+  end
+
+  # Get the next page
+  # @return [Search] next page of results
+  def next
+    DBLRuby::Search.new(
+      search: search,
+      limit: limit,
+      offset: limit + offset,
+      sort: sort,
+      fields: fields
+    )
+  end
+
+  # Get the bot count in this result
+  # @return [Integer] total bots returned
+  # @see #size
+  def count
+    @data['count']
+  end
+
+  # Get the total possible amount of bots there are for this query
+  # @return [Integer] the total amount of bots
+  def total
+    @data['total']
+  end
+end

data/lib/dblruby/weekend.rb

@@ -0,0 +1,21 @@
+# 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))
+  end
+
+  # @return data in raw json form.
+  attr_reader :data
+
+  alias to_s data
+
+  # Return the whether it's the weekend.
+  # @return [true, false] the weekend status.
+  def weekend?
+    @data['is_weekend']
+  end
+
+  alias isweekend weekend?
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dblruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chewsterchew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2018-11-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -34,8 +48,10 @@ files:
 - lib/dblruby/api.rb
 - lib/dblruby/bot.rb
 - lib/dblruby/errors.rb
+- lib/dblruby/search.rb
 - lib/dblruby/stats.rb
 - lib/dblruby/user.rb
+- lib/dblruby/weekend.rb
 homepage: http://github.com/Chewsterchew/DBLRuby
 licenses:
 - MIT