dblista 0.1.5 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8a9f1ef63473322f8f5cfb544e460fe77740bfba0bf6e767be8d583f2906cb6
-  data.tar.gz: 855aeed578c2e189b9c57098e1978b24c1a38a2225ddb232fa84959f6ac2c264
+  metadata.gz: 7a839df00612d366d1a0184c647cdce72895f1ee02d71c25deb2e76ae78c7026
+  data.tar.gz: 4922b94a22e10332f564ef628058664204c3904c794e1381cab452478c24af8f
 SHA512:
-  metadata.gz: cc04945b098ae8850aac02baec8cc6d20fc8f6388ec60e86a8ac6533d00b85d6439613ea7da5ba5a0dc097f95bba79c4f09b3a718fda7954215723d1ab887bb3
-  data.tar.gz: 3c94d344e3c0e5f61a0114daa40845dfd8d83d60baaa2f2ec942b7618e37c0d6bd5143dfaf1b3b110f5721daa6e38b62df84617695f899477eed4119ff0b9723
+  metadata.gz: c9131862894f3adfaba7fb2a0add9f7fb31f423a8a94ebbd19efb8d1f84f8c14e8ee9acec3c1742a3eef0cc2e02cb8f228f5ab3eb98b5e6ebe8de0427b4f2d14
+  data.tar.gz: 3105e3459bea2a2c8f33f1f4470ead0d103d6757396bdde267e4b323cd5839e573d90d63d47ab6b3756083cf0e5f9a18740b2a844629ddc06ceca51ea6ab6150

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dblista (0.1.5)
+    dblista (0.3.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -33,7 +33,7 @@ Pobieranie topki botów:
 
 ```ruby
 top = DBLista::List::Bot.top
-puts top['data'].inspect
+puts top
 ```
 
 ## Licencja

data/lib/dblista.rb

@@ -12,6 +12,8 @@ require_relative 'dblista/errors'
 require_relative 'dblista/list/bot'
 require_relative 'dblista/list/server'
 require_relative 'dblista/user/client'
+require_relative 'dblista/helpers'
+require_relative 'dblista/constants'
 
 # Main module
 module DBLista
@@ -36,7 +38,8 @@ module DBLista
     response = _https(uri).request(req)
     result = JSON.parse response.body
     raise DBLista::Error, result['error'].capitalize unless result['status'] == 'success'
-    result
+
+    result['data']
   end
 
   # @!visibility private
@@ -76,4 +79,9 @@ module DBLista
   def self._page_integer(input)
     raise DBLista::Error, DBLista::Errors::PAGE_INTEGER unless input.is_a?(Integer)
   end
+
+  # @!visibility private
+  def self._limit_integer(input)
+    raise DBLista::Error, DBLista::Errors::LIMIT_INTEGER unless input.is_a?(Integer)
+  end
 end

data/lib/dblista/constants.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module DBLista
+  # Tags
+  module Tags
+    # Bot tags
+    module Bot
+      MODERATION = :moderacja
+      TOOLS = :narzędzia
+      MUSIC = :muzyka
+      DASHBOARD = :panel
+      FUN = :rozrywka
+      LEVELS = :poziomy
+      GAMES = :gry
+      ROLEPLAY = :roleplay
+      ECONOMY = :ekonomia
+      ANIME = :anime
+      NSFW = :nsfw
+      OTHER = :inne
+    end
+    # Server tags
+    module Server
+      COMMUNITY = :community
+      PROGRAMMING = :programowanie
+      GAMES = :gry
+      YOUTUBE = :youtube
+      HOBBY = :hobby
+      ANIME = :anime
+      ROLEPLAY = :roleplay
+      OTHER = :inne
+    end
+  end
+  # Permissions
+  module Permissions
+    USER = 0
+    MODERATOR = 1
+    BIG_MODERATOR = 2
+    ADMINISTRATOR = 3
+  end
+end

data/lib/dblista/errors.rb

@@ -6,6 +6,10 @@ module DBLista::Errors
   ID_NEEDED = 'You need to enter ID'
   # Raised when provided page is not an integer
   PAGE_INTEGER = 'Page must be an integer'
+  # Raised when rank is not an integer
+  RANK_INTEGER = 'Rank must be an integer'
+  # Raised when provided limit is not an integer
+  LIMIT_INTEGER = 'Limit must be an integer'
   # Raised when token is not provided
   TOKEN_NOT_PROVIDED = 'Token is not provided'
   # Raised when type symbol is invalid

data/lib/dblista/helpers.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Helper methods
+module DBLista::Helpers
+  # Crafts avatar url from user ID and avatar hash
+  #
+  # @param id [Integer] user ID
+  # @param hash [String] avatar hash
+  # @param size [Integer] avatar width (defaults to 2048)
+  # @return [Hash] raw data from DBLista
+  def self.get_avatar(id, hash, size = 2048)
+    "https://cdn.discordapp.com/avatars/#{id}/#{hash}?size=#{size}"
+  end
+end

data/lib/dblista/info.rb

@@ -8,7 +8,7 @@ module DBLista
   #
   # @example Checking DBLista user information
   #   info = DBLista::Information.user 123456789012345678
-  #   puts info['data']
+  #   puts info
   module Information
     # Fetches DBLista bot information
     #

data/lib/dblista/list/bot.rb

@@ -8,26 +8,30 @@ require 'cgi'
 #
 # @example Fetch top 25 bots
 #   top = DBLista::List::Bot.top
-#   puts top['data'].inspect
+#   puts top
 module DBLista::List
   # Bot lists
   module Bot
     # Fetches top bots
     #
     # @param page [Integer] page
+    # @param limit [Integer] limit of bots per page
     # @return [Hash] raw data from DBLista
-    def self.top(page = 0)
+    def self.top(page = 0, limit = 10)
       DBLista._page_integer page
-      DBLista._get("/bots/list/top/#{page}")
+      DBLista._limit_integer limit
+      DBLista._get("/bots/list/top/#{page}?limit=#{limit}")
     end
 
     # Fetches premium bots
     #
     # @param page [Integer] page
+    # @param limit [Integer] limit of bots per page
     # @return [Hash] raw data from DBLista
-    def self.premium(page = 0)
+    def self.premium(page = 0, limit = 10)
       DBLista._page_integer page
-      DBLista._get("/bots/list/premium/#{page}")
+      DBLista._limit_integer limit
+      DBLista._get("/bots/list/premium/#{page}?limit=#{limit}")
     end
 
     # Fetches unverified bots
@@ -44,6 +48,13 @@ module DBLista::List
       DBLista._get('/bots/list/rejected')
     end
 
+    # Fetches all bots
+    #
+    # @return [Array] array of raw bot data from DBLista
+    def self.all
+      DBLista::List::Bot.top(0, 100_000_000)
+    end
+
     # Bot search
     #
     # @param query [String] query search
@@ -51,7 +62,7 @@ module DBLista::List
     def self.search(query)
       raise DBLista::Error, DBLista::Errors::QUERY_NOT_PROVIDED unless query
 
-      DBLista._get("/bots/search/#{CGI.escape query}")
+      DBLista._get("/bots/search/#{CGI.escape query.to_s}")
     end
   end
 end

data/lib/dblista/list/server.rb

@@ -8,19 +8,30 @@ module DBLista::List
     # Fetches top servers
     #
     # @param page [Integer] page
+    # @param limit [Integer] limit of servers per page
     # @return [Hash] raw data from DBLista
-    def self.top(page = 0)
+    def self.top(page = 0, limit = 10)
       DBLista._page_integer page
-      DBLista._get("/servers/list/top/#{page}")
+      DBLista._limit_integer limit
+      DBLista._get("/servers/list/top/#{page}?limit=#{limit}")
     end
 
     # Fetches premium servers
     #
     # @param page [Integer] page
+    # @param limit [Integer] limit of servers per page
     # @return [Hash] raw data from DBLista
-    def self.premium(page = 0)
+    def self.premium(page = 0, limit = 10)
       DBLista._page_integer page
-      DBLista._get("/servers/list/premium/#{page}")
+      DBLista._limit_integer limit
+      DBLista._get("/servers/list/premium/#{page}?limit=#{limit}")
+    end
+
+    # Fetches all servers
+    #
+    # @return [Array] array of raw server data from DBLista
+    def self.all
+      DBLista::List::Server.top(0, 100_000_000)
     end
 
     # Server search
@@ -30,7 +41,7 @@ module DBLista::List
     def self.search(query)
       raise DBLista::Error, DBLista::Errors::QUERY_NOT_PROVIDED unless query
 
-      DBLista._get("/servers/search/#{CGI.escape query}")
+      DBLista._get("/servers/search/#{CGI.escape query.to_s}")
     end
   end
 end

data/lib/dblista/user/actions.rb

@@ -5,40 +5,58 @@ require 'json'
 module DBLista::User
   # User client - actions
   module Actions
-  # Adds bot/server to DBLista
-  #
-  # @param body [Hash] raw body to send
-  # @param type [Symbol] type of entity (bot/server)
-  # @return [Hash] raw data from DBLista
-  def add(body, type = 'bot')
-    raise DBLista::Error, DBLista::Errors::BODY_HASH unless body.is_a?(Hash)
-    raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless ALLOWED_TYPES.include?(type)
-
-    DBLista._post("/#{type}s", body, @token)
-  end
+    # Adds bot/server to DBLista
+    #
+    # @param body [Hash] raw body to send
+    # @param type [Symbol] type of entity (bot/server)
+    # @return [Boolean] true if operation succeded
+    def add(body, type = 'bot')
+      raise DBLista::Error, DBLista::Errors::BODY_HASH unless body.is_a?(Hash)
+      raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
 
-  # Edits bot/server in DBLista
-  #
-  # @param body [Hash] raw body to send
-  # @param type [Symbol] type of entity (bot/server)
-  # @return [Hash] raw data from DBLista
-  def edit(body, type = :bot)
-    raise DBLista::Error, DBLista::Errors::BODY_HASH unless body.is_a?(Hash)
-    raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
+      DBLista._post("/#{type}s", body, @token)
+      true
+    end
 
-    DBLista._put("/#{type}s", body, @token)
-  end
+    # Edits bot/server in DBLista
+    #
+    # @param body [Hash] raw body to send
+    # @param type [Symbol] type of entity (bot/server)
+    # @return [Boolean] true if operation succeded
+    def edit(body, type = :bot)
+      raise DBLista::Error, DBLista::Errors::BODY_HASH unless body.is_a?(Hash)
+      raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
 
-  # Deletes bot/server from DBLista
-  #
-  # @param id [Integer] entity ID
-  # @param type [Symbol] type of entity (bot/server)
-  # @return [Hash] raw data from DBLista
-  def delete(id, type = :bot)
-    DBLista._validate_id id
-    raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
+      DBLista._put("/#{type}s", body, @token)
+      true
+    end
 
-    DBLista._delete("/#{type}s/#{id}", nil, @token)
-  end
+    # Deletes bot/server from DBLista
+    #
+    # @param id [Integer] entity ID
+    # @param type [Symbol] type of entity (bot/server)
+    # @return [Boolean] true if operation succeded
+    def delete(id, type = :bot)
+      DBLista._validate_id id
+      raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
+
+      DBLista._delete("/#{type}s/#{id}", nil, @token)
+      true
+    end
+
+    # Manages user (bans or adds premium)
+    # Available only for DBLista staff
+    #
+    # @param id [Integer] user ID
+    # @param banned [Boolean] user ban status
+    # @param premium [Integer] days for premium
+    # @return [Boolean] true if operation succeded
+    def manage_user(id, banned = false, premium = 0)
+      DBLista._post("/users/#{id}/manage", {
+                      premium: premium,
+                      ban: banned
+                    }, @token)
+      true
+    end
   end
 end

data/lib/dblista/user/boosting.rb

@@ -3,28 +3,30 @@
 module DBLista::User
   # User client - boosting
   module Boosting
-  # Boosts selected bot/server
-  #
-  # @param id [Integer] entity ID
-  # @param type [Symbol] type of entity (bot/server)
-  # @return [Hash] raw data from DBLista
-  def boost(id, type = :bot)
-    DBLista._validate_id id
-    raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless ALLOWED_TYPES.include?(type)
+    # Boosts selected bot/server
+    #
+    # @param id [Integer] entity ID
+    # @param type [Symbol] type of entity (bot/server)
+    # @return [Boolean] true if operation succeded
+    def boost(id, type = :bot)
+      DBLista._validate_id id
+      raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
 
-    DBLista._post("/#{type}s/#{id}/boost", nil, @token)
-  end
+      DBLista._post("/#{type}s/#{id}/boost", nil, @token)
+      true
+    end
 
-  # Removes boost from a selected bot/server
-  #
-  # @param id [Integer] entity ID
-  # @param type [Symbol] type of entity (bot/server)
-  # @return [Hash] raw data from DBLista
-  def delete_boost(id, type = :bot)
-    DBLista._validate_id id
-    raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
+    # Removes boost from a selected bot/server
+    #
+    # @param id [Integer] entity ID
+    # @param type [Symbol] type of entity (bot/server)
+    # @return [Boolean] true if operation succeded
+    def delete_boost(id, type = :bot)
+      DBLista._validate_id id
+      raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
 
-    DBLista._delete("/#{type}s/#{id}/boost", nil, @token)
-  end
+      DBLista._delete("/#{type}s/#{id}/boost", nil, @token)
+      true
+    end
   end
 end

data/lib/dblista/user/client.rb

@@ -5,6 +5,7 @@ require_relative './boosting'
 require_relative './rating'
 require_relative './voting'
 require_relative './notifications'
+require_relative './verification'
 
 # User module - client + client modules
 module DBLista::User
@@ -12,17 +13,18 @@ module DBLista::User
   #
   # @example Server voting
   #   client = DBLista::User::Client.new "USER_TOKEN"
-  #   response = client.vote(123456789012345678, :server)
+  #   client.vote(123456789012345678, :server)
   #
   # @example Bot rating
   #   client = DBLista::User::Client.new "USER_TOKEN"
-  #   response = client.rate(123456789012345678, 5, 'Nice bot')
+  #   client.rate(123456789012345678, 5, 'Nice bot')
   class Client
     include DBLista::User::Voting
     include DBLista::User::Actions
     include DBLista::User::Boosting
     include DBLista::User::Rating
     include DBLista::User::Notifications
+    include DBLista::User::Verification
 
     # Allowed entity types to use
     ALLOWED_TYPES = %i[bot server].freeze
@@ -34,7 +36,7 @@ module DBLista::User
 
       @token = token
 
-      raise DBLista::Error, DBLista::Errors::INVALID_TOKEN unless me['status'] == 'success'
+      me
     end
 
     # Fetches information about current user

data/lib/dblista/user/notifications.rb

@@ -3,18 +3,50 @@
 module DBLista::User
   # User client - notifications
   module Notifications
-  # Fetches user notifications
-  #
-  # @return [Hash] raw data from DBLista
-  def notifications
-    DBLista._get('/users/me/notifications/read', @token)
-  end
+    # Fetches user notifications
+    #
+    # @return [Hash] raw data from DBLista
+    def notifications
+      DBLista._get('/users/me/notifications/read', @token)
+    end
 
-  # Clears user notifications
-  #
-  # @return [Hash] raw data from DBLista
-  def clear_notifications
-    DBLista._get('/users/me/notifications/clear', @token)
-  end
+    # Clears user notifications
+    #
+    # @return [Boolean] true if operation succeded
+    def clear_notifications
+      DBLista._get('/users/me/notifications/clear', @token)
+      true
+    end
+
+    # Sends notification to specified user
+    # Available only for DBLista staff
+    #
+    # @param rank [Integer] user ID
+    # @param details [String] details (content)
+    # @param url [String] url to redirect if clicked
+    # @return [Boolean] true if operation succeded
+    def send_notification(id, details, url = '#')
+      DBLista._validate_id id
+      DBLista._post("/users/#{id}/notifications", {
+                      text: details,
+                      url: url || '#'
+                    }, @token)
+      true
+    end
+
+    # Sends notification to specified group (rank)
+    # Available only for DBLista staff
+    #
+    # @param rank [Integer] rank ID
+    # @param details [String] details (content)
+    # @param url [String] url to redirect if clicked
+    # @return [Boolean] true if operation succeded
+    def send_group_notification(rank, details, url = '#')
+      DBLista._post("/users/group/#{rank}/notifications", {
+                      text: details,
+                      url: url || '#'
+                    }, @token)
+      true
+    end
   end
 end

data/lib/dblista/user/rating.rb

@@ -3,34 +3,36 @@
 module DBLista::User
   # User client - rating
   module Rating
-  # Sends rate for a selected bot/server
-  #
-  # @param id [Integer] entity ID
-  # @param rating [Integer] rating from 0 to 5
-  # @param details [String] details (description)
-  # @param type [Symbol] type of entity (bot/server)
-  # @return [Hash] raw data from DBLista
-  def rate(id, rating, details, type = :bot)
-    DBLista._validate_id id
-    raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless ALLOWED_TYPES.include?(type)
+    # Sends rate for a selected bot/server
+    #
+    # @param id [Integer] entity ID
+    # @param rating [Integer] rating from 0 to 5
+    # @param details [String] details (description)
+    # @param type [Symbol] type of entity (bot/server)
+    # @return [Boolean] true if operation succeded
+    def rate(id, rating, details, type = :bot)
+      DBLista._validate_id id
+      raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
 
-    DBLista._post("/#{type}s/#{id}/rate", {
-                    rating: rating,
-                    details: details
-                  }, @token)
-  end
+      DBLista._post("/#{type}s/#{id}/rate", {
+                      rating: rating,
+                      details: details
+                    }, @token)
+      true
+    end
 
-  # Removes rate for a selected bot/server
-  #
-  # @param id [Integer] entity ID
-  # @param target_id [Integer] target user to remove rate from (for owners only)
-  # @param type [Symbol] type of entity (bot/server)
-  # @return [Hash] raw data from DBLista
-  def delete_rate(id, target_id = nil, type = :bot)
-    DBLista._validate_id id
-    raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
+    # Removes rate for a selected bot/server
+    #
+    # @param id [Integer] entity ID
+    # @param target_id [Integer] target user to remove rate from (for owners only)
+    # @param type [Symbol] type of entity (bot/server)
+    # @return [Boolean] true if operation succeded
+    def delete_rate(id, target_id = nil, type = :bot)
+      DBLista._validate_id id
+      raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
 
-    DBLista._delete("/#{type}s/#{id}/rate/#{target_id}", nil, @token)
-  end
+      DBLista._delete("/#{type}s/#{id}/rate/#{target_id}", nil, @token)
+      true
+    end
   end
 end

data/lib/dblista/user/verification.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'cgi'
+
+module DBLista::User
+  # User client - verification (only for staff)
+  module Verification
+    # Approves specified bot
+    #
+    # @param id [Integer] bot ID
+    # @param reason [String] reason for approving
+    # @return [Boolean] true if operation succeded
+    def approve(id, reason = 'Brak powodu')
+      DBLista._validate_id id
+
+      DBLista._post("/bots/#{id}/approve?reason=#{CGI.escape reason}", nil, @token)
+      true
+    end
+
+    # Rejects  specified bot
+    #
+    # @param id [Integer] bot ID
+    # @param reason [String] reason for rejecting
+    # @return [Boolean] true if operation succeded
+    def reject(id, reason = 'Brak powodu')
+      DBLista._validate_id id
+
+      DBLista._post("/bots/#{id}/reject?reason=#{CGI.escape reason}", nil, @token)
+      true
+    end
+
+    # Sets specified bot verification status to pending
+    #
+    # @param id [Integer] bot ID
+    # @return [Boolean] true if operation succeded
+    def set_pending(id)
+      DBLista._validate_id id
+
+      DBLista._post("/bots/#{id}/set-pending", nil, @token)
+      true
+    end
+  end
+end

data/lib/dblista/user/voting.rb

@@ -3,16 +3,17 @@
 module DBLista::User
   # User client - voting
   module Voting
-  # Votes for a selected bot/server
-  #
-  # @param id [Integer] entity ID
-  # @param type [Symbol] type of entity (bot/server)
-  # @return [Hash] raw data from DBLista
-  def vote(id, type = :bot)
-    DBLista._validate_id id
-    raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
+    # Votes for a selected bot/server
+    #
+    # @param id [Integer] entity ID
+    # @param type [Symbol] type of entity (bot/server)
+    # @return [Boolean] true if operation succeded
+    def vote(id, type = :bot)
+      DBLista._validate_id id
+      raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
 
-    DBLista._post("/#{type}s/#{id}/vote", nil, @token)
-  end
+      DBLista._post("/#{type}s/#{id}/vote", nil, @token)
+      true
+    end
   end
 end

data/lib/dblista/version.rb

@@ -2,5 +2,5 @@
 
 module DBLista
   # Wrapper version
-  VERSION = '0.1.5'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dblista
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.3.2
 platform: ruby
 authors:
 - deepivin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-04 00:00:00.000000000 Z
+date: 2020-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,7 +70,9 @@ files:
 - dblista.gemspec
 - example/info.rb
 - lib/dblista.rb
+- lib/dblista/constants.rb
 - lib/dblista/errors.rb
+- lib/dblista/helpers.rb
 - lib/dblista/info.rb
 - lib/dblista/list/bot.rb
 - lib/dblista/list/server.rb
@@ -80,6 +82,7 @@ files:
 - lib/dblista/user/client.rb
 - lib/dblista/user/notifications.rb
 - lib/dblista/user/rating.rb
+- lib/dblista/user/verification.rb
 - lib/dblista/user/voting.rb
 - lib/dblista/version.rb
 homepage: https://github.com/marek12306/dblista-wrapper-ruby