dblista 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fa0b18a050a6369352d032a11be2497c207a8f16a4456c11aa2be79695d3738
-  data.tar.gz: c46e76121ccf62a37004db3c867f421d02ce12c4b0516a73e1d37e00f88cdc54
+  metadata.gz: 20bc126654c09a9c27d1a5601a5fd6ca6f78d97b434c4c72d0f053b790a55bcf
+  data.tar.gz: b37f3e82284ca081f443422a5b2b1a34c2beafa3ae5233f5533e2b2ce557e87d
 SHA512:
-  metadata.gz: 9940f8419b0c118ffb071640481ef77d87479e66cc0a723d9ff8f03a365207d4f419779b2cd77646309ac584b2f8e9ada0147a74bf3b1cd5db613a5839445b33
-  data.tar.gz: 8dea89026931f27610552e00dc2a008ee1a02df08777661964bfb244d90400d7e95b27cce6e7142bd64a3e9cc9258583823fa254e687baa3cb34141a0fd439ee
+  metadata.gz: 2e8c060120beae4594c8b5e9faa0b81bbc29dbe08c4fb0f27a61afe7816092594dc5ef205565538599aa17a97352b53b853c256b5faa5dca68c6dcbce11c613d
+  data.tar.gz: 6992b4c8b78a17f307d2ed2c2225c5e333cee7630c9cbf485af5c661fc89b89348c595848a8ea205e0435136555a3dcbbf85cbca0505fce87d603126b2987073

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    dblista (0.2.0)
+    dblista (0.4.0)
+      zache
 
 GEM
   remote: https://rubygems.org/
@@ -21,6 +22,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    zache (0.12.0)
 
 PLATFORMS
   x86-mingw32

data/README.md

@@ -33,9 +33,9 @@ Pobieranie topki botów:
 
 ```ruby
 top = DBLista::List::Bot.top
-puts top['data'].inspect
+puts top
 ```
 
 ## Licencja
 
-Ten gem jest dostępny na licencji [MIT License](https://opensource.org/licenses/MIT). Rób z nim co chcesz.
+Ten gem jest dostępny na licencji [MIT License](https://opensource.org/licenses/MIT). Rób z tym co chcesz.

data/dblista.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "zache"
+
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.2"

data/examples/auto_stats.rb

@@ -0,0 +1,11 @@
+require 'dblista'
+require 'discordrb'
+
+bot = Discordrb::Bot.new token: 'TOKEN'
+dbl = DBLista::Stats.new 'DBLISTA_TOKEN', bot
+
+bot.message(content: 'Ping!') do |event|
+  event.respond 'Pong!'
+end
+
+bot.run

data/examples/bot_add.rb

@@ -0,0 +1,26 @@
+require 'dblista'
+
+client = DBLista::User::Client.new('TOKEN')
+
+client.add({
+  id: 'id',
+  info: {
+    library: 'NiceBot',
+    tags: [
+      DBLista::Tags::Bot::FUN,
+      DBLista::Tags::Bot::TOOLS
+    ],
+    prefix: '!',
+    fullDescription: 'long description',
+    shortDescription: 'summary'
+  },
+  links: {
+    gitRepository: 'http://github.com/example/example',
+    website: 'http://example.com',
+    discordServer: 'discord server'
+  },
+  owners: [
+    'id 1',
+    'id 2'
+  ]
+})

data/examples/full_bot_name_list.rb

@@ -0,0 +1,5 @@
+require 'dblista'
+
+DBLista::List::Bot.all.each do |server|
+  puts server['name']
+end

data/examples/notifications.rb

@@ -0,0 +1,6 @@
+require 'dblista'
+
+client = DBLista::User::Client.new('TOKEN')
+
+puts client.notifications
+client.clear_notifications

data/examples/tag_search.rb

@@ -0,0 +1,5 @@
+require 'dblista'
+
+results = DBLista::List::Bot.search(DBLista::Tags::Bot::MUSIC)
+
+puts results

data/examples/user_avatar.rb

@@ -0,0 +1,5 @@
+require 'dblista'
+
+user = DBLista::Information.user('ID')
+
+puts DBLista::Helpers.get_avatar(user['id'], user['avatar'], 1024)

data/lib/dblista.rb

@@ -4,6 +4,7 @@ require 'net/http'
 require 'net/https'
 require 'open-uri'
 require 'json'
+require 'zache'
 
 require_relative 'dblista/version'
 require_relative 'dblista/info'
@@ -13,6 +14,7 @@ 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
@@ -23,6 +25,11 @@ module DBLista
   # Regexp for checking if string is a number
   IS_NUMBER = /^\d+$/.freeze
 
+  # Cache
+  Cache = Zache.new
+  # Cache entry lifetime
+  CACHE_LIFETIME = 15
+
   def self._https(uri)
     Net::HTTP.new(uri.host, uri.port).tap do |http|
       http.use_ssl = true
@@ -37,6 +44,7 @@ module DBLista
     response = _https(uri).request(req)
     result = JSON.parse response.body
     raise DBLista::Error, result['error'].capitalize unless result['status'] == 'success'
+
     result['data']
   end
 
@@ -77,4 +85,13 @@ 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
+
+  def self._cache(name)
+    DBLista::Cache.get(name.to_sym, lifetime: DBLista::CACHE_LIFETIME) { yield }
+  end
 end

data/lib/dblista/constants.rb

@@ -0,0 +1,68 @@
+# 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 = 10
+  end
+  # Bot libraries
+  module Libraries
+    DISCORD_JS = :'discord.js'
+    ERIS = :eris
+    DSHARP_PLUS = :DSharpPlus
+    DISCORD_NET = :'Discord.Net'
+    DISCORDGO = :DiscordGo
+    DISGORD = :DisGord
+    JDA = :JDA
+    DISCORD4J = :Discord4J
+    JAVACORD = :Javacord
+    AEGIS_CPP = :'aegis.cpp'
+    NYXX = :nyxx
+    RESTCORD = :RestCord
+    DISCORD_PY = :'discord.py'
+    DISCO = :disco
+    DISCORDRB = :discordrb
+    DISCORDRS = :'discord-rs'
+    SERENITY = :serenity
+    INNA = :inna
+  end
+  # Card style
+  module CardStyle
+    GREEN = :green
+    ORANGE = :orange
+    PINK = :pink
+    BLUE = :blue
+  end
+end

data/lib/dblista/errors.rb

@@ -8,6 +8,8 @@ module DBLista::Errors
   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/info.rb

@@ -16,7 +16,9 @@ module DBLista
     # @return [Hash] raw data from DBLista
     def self.bot(id)
       DBLista._validate_id id
-      DBLista._get("/bots/#{id}")
+      DBLista._cache(id.to_s.to_sym) do
+        DBLista._get("/bots/#{id}")
+      end
     end
 
     # Fetches DBLista server information
@@ -25,7 +27,9 @@ module DBLista
     # @return [Hash] raw data from DBLista
     def self.server(id)
       DBLista._validate_id id
-      DBLista._get("/servers/#{id}")
+      DBLista._cache(id.to_s.to_sym) do
+        DBLista._get("/servers/#{id}")
+      end
     end
 
     # Fetches DBLista user information
@@ -34,7 +38,9 @@ module DBLista
     # @return [Hash] raw data from DBLista
     def self.user(id)
       DBLista._validate_id id
-      DBLista._get("/users/#{id}")
+      DBLista._cache(id.to_s.to_sym) do
+        DBLista._get("/users/#{id}")
+      end
     end
   end
 end

data/lib/dblista/list/bot.rb

@@ -8,40 +8,61 @@ require 'cgi'
 #
 # @example Fetch top 25 bots
 #   top = DBLista::List::Bot.top
-#   puts top.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._cache("botstop#{page}-#{limit}") do
+        DBLista._get("/bots/list/top/#{page}?limit=#{limit}")
+      end
     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._cache("botspremium#{page}-#{limit}") do
+        DBLista._get("/bots/list/premium/#{page}?limit=#{limit}")
+      end
     end
 
     # Fetches unverified bots
     #
     # @return [Hash] raw data from DBLista
     def self.unverified
-      DBLista._get('/bots/list/unverified')
+      DBLista._cache(:botsunverified) do
+        DBLista._get('/bots/list/unverified')
+      end
     end
 
     # Fetches rejected bots
     #
     # @return [Hash] raw data from DBLista
     def self.rejected
-      DBLista._get('/bots/list/rejected')
+      DBLista._cache(:botsrejected) do
+        DBLista._get('/bots/list/rejected')
+      end
+    end
+
+    # Fetches all bots
+    #
+    # @return [Array] array of raw bot data from DBLista
+    def self.all
+      DBLista._cache(:botsall) do
+        DBLista::List::Bot.top(0, 100_000_000)
+      end
     end
 
     # Bot search
@@ -51,7 +72,9 @@ 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._cache("botsearch#{query}") do
+        DBLista._get("/bots/search/#{CGI.escape query.to_s}")
+      end
     end
   end
 end

data/lib/dblista/list/server.rb

@@ -8,19 +8,36 @@ 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._cache("serverstop#{page}-#{limit}") do
+        DBLista._get("/servers/list/top/#{page}?limit=#{limit}")
+      end
     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._cache("serverspremium#{page}-#{limit}") do
+        DBLista._get("/servers/list/premium/#{page}?limit=#{limit}")
+      end
+    end
+
+    # Fetches all servers
+    #
+    # @return [Array] array of raw server data from DBLista
+    def self.all
+      DBLista._cache(:serversall) do
+        DBLista::List::Server.top(0, 100_000_000)
+      end
     end
 
     # Server search
@@ -30,7 +47,9 @@ 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._cache("serversearch#{query}") do
+        DBLista._get("/servers/search/#{CGI.escape query.to_s}")
+      end
     end
   end
 end

data/lib/dblista/stats.rb

@@ -42,12 +42,13 @@ module DBLista
     #
     # @param members [Integer] member count
     # @param servers [Integer] server count
-    # @return [Hash] raw data from DBLista
+    # @return [Boolean] true if operation succeded
     def update_stats(members, servers)
       DBLista._post('/bots/stats', {
                       'servers' => servers,
                       'members' => members
                     }, @token)
+      true
     end
   end
 end

data/lib/dblista/user/actions.rb

@@ -5,54 +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
-
-  # 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._put("/#{type}s", body, @token)
-  end
-
-  # 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._delete("/#{type}s/#{id}", nil, @token)
-  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 [Hash] raw data from DBLista
-  def manage_user(id, banned = false, premium = 0)
-    DBLista._post("/users/#{id}/manage", {
-                    premium: premium,
-                    ban: banned
-                  }, @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)
+
+      DBLista._post("/#{type}s", body, @token)
+      true
+    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)
+
+      DBLista._put("/#{type}s", body, @token)
+      true
+    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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'zache'
+
 require_relative './actions'
 require_relative './boosting'
 require_relative './rating'
@@ -13,11 +15,11 @@ 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
@@ -35,6 +37,7 @@ module DBLista::User
       raise DBLista::Error, DBLista::Errors::TOKEN_NOT_PROVIDED unless token
 
       @token = token
+      @cache = Zache.new
 
       me
     end
@@ -43,14 +46,18 @@ module DBLista::User
     #
     # @return [Hash] raw data from DBLista
     def me
-      DBLista._get('/users/me', @token)
+      @cache.get(:guilds, lifetime: DBLista::CACHE_LIFETIME) do
+        DBLista._get('/users/me', @token)
+      end
     end
 
     # Fetches current user guilds
     #
     # @return [Hash] raw data from DBLista
     def guilds
-      DBLista._get('/users/me/guilds', @token)
+      @cache.get(:guilds, lifetime: DBLista::CACHE_LIFETIME) do
+        DBLista._get('/users/me/guilds', @token)
+      end
     end
   end
 end

data/lib/dblista/user/notifications.rb

@@ -3,47 +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 [Hash] raw data from DBLista
-  def send_notification(id, details, url = '#')
-    DBLista._validate_id id
-    DBLista._post("/users/#{id}/notifications", {
-                    text: details,
-                    url: url || '#'
-                  }, @token)
-  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 [Hash] raw data from DBLista
-  def send_group_notification(rank, details, url = '#')
-    DBLista._post("/users/group/#{rank}/notifications", {
-                    text: details,
-                    url: url || '#'
-                  }, @token)
-  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

@@ -5,39 +5,39 @@ 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
+    # 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
+      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
+    # 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
+      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
+    # 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
+      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.2.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dblista
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 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: zache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -68,8 +82,14 @@ files:
 - bin/console
 - bin/setup
 - dblista.gemspec
-- example/info.rb
+- examples/auto_stats.rb
+- examples/bot_add.rb
+- examples/full_bot_name_list.rb
+- examples/notifications.rb
+- examples/tag_search.rb
+- examples/user_avatar.rb
 - lib/dblista.rb
+- lib/dblista/constants.rb
 - lib/dblista/errors.rb
 - lib/dblista/helpers.rb
 - lib/dblista/info.rb

data/example/info.rb

@@ -1,3 +0,0 @@
-require 'dblista'
-
-puts DBLista::Information.bot('594589970740543490')