dblista 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51c3d13971d2263b0c97cf0e6f51d28ca72a870a67a660a6f63807e10f3caaad
-  data.tar.gz: 3628e33de56b321182bd41a05ce771515395d76a3c2e8baf3da8828354c3d516
+  metadata.gz: a75838be15e70b98ad6b8f37c880a53539b82f8e0f11ff433ec7665efb9cb4f7
+  data.tar.gz: cf00504ac704fff20bb6eea3d4c585f7feb1337529aff5bf488e23e15496df18
 SHA512:
-  metadata.gz: 1cbb274d9b3223729e6dcd67ddbb8017b7ab53f5fcce2404a7255fab2ed5bf9945968169865bd9d1e987f285ae78102721868957d7e992a37f35e2849051489e
-  data.tar.gz: 59678c99464e688a1d00d85bbe3a47abf7c1a035cf1348adccba684b321e6feddcd16bcb7e478dcac67d9e6e89c3706dbae5313b277ea0373ebd93c8eb5086ba
+  metadata.gz: e8c280dae3019394510864fb8f8d8ac9f8b7fc59d0ab0278620fd159f64629768088f0654d4d060804a187ff7230cf07ef88819e313dcebd15e8ef70bf587146
+  data.tar.gz: 4de0995b3040d0ef57a8a6f8d3eb07b7e58d931f1a58ae5995944b1f121961bb52d0dbfbabc188b40d4baf076c12e25546dd09930e0c97dd33036dbf1a53ac98

data/Gemfile.lock

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

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,7 @@ 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

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,8 @@ 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 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,7 +8,7 @@ require 'cgi'
 #
 # @example Fetch top 25 bots
 #   top = DBLista::List::Bot.top
-#   puts top['data'].inspect
+#   puts top.inspect
 module DBLista::List
   # Bot lists
   module Bot
@@ -44,6 +44,22 @@ module DBLista::List
       DBLista._get('/bots/list/rejected')
     end
 
+    # Fetches all bots
+    #
+    # @return [Array] array of raw bot data from DBLista
+    def self.all
+      bots = []
+      i = 0
+      loop do
+        page = DBLista::List::Bot.top(i)
+        break if page.length.zero?
+
+        bots += page
+        i += 1
+      end
+      bots
+    end
+
     # Bot search
     #
     # @param query [String] query search
@@ -51,7 +67,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

@@ -23,6 +23,22 @@ module DBLista::List
       DBLista._get("/servers/list/premium/#{page}")
     end
 
+    # Fetches all servers
+    #
+    # @return [Array] array of raw server data from DBLista
+    def self.all
+      servers = []
+      i = 0
+      loop do
+        page = DBLista::List::Server.top(i)
+        break if page.length.zero?
+
+        servers += page
+        i += 1
+      end
+      servers
+    end
+
     # Server search
     #
     # @param query [String] search query
@@ -30,7 +46,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

@@ -2,43 +2,61 @@
 
 require 'json'
 
-# User client - actions
 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
+  # @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 ALLOWED_TYPES.include?(type)
+    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 [Hash] raw data from DBLista
+  # @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 [Hash] raw data from DBLista
+  # @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

@@ -1,31 +1,32 @@
 # frozen_string_literal: true
 
-##
-# User client - boosting
 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
+  # @return [Boolean] true if operation succeded
   def boost(id, type = :bot)
     DBLista._validate_id id
-    raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless ALLOWED_TYPES.include?(type)
+    raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
 
     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
+  # @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)
+    true
   end
   end
 end

data/lib/dblista/user/client.rb

@@ -4,6 +4,8 @@ require_relative './actions'
 require_relative './boosting'
 require_relative './rating'
 require_relative './voting'
+require_relative './notifications'
+require_relative './verification'
 
 # User module - client + client modules
 module DBLista::User
@@ -21,6 +23,8 @@ module DBLista::User
     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
@@ -32,14 +36,21 @@ module DBLista::User
 
       @token = token
 
-      raise DBLista::Error, DBLista::Errors::INVALID_TOKEN unless me['status'] == 'success'
+      me
     end
 
-    # Fetches information about user
+    # Fetches information about current user
     #
     # @return [Hash] raw data from DBLista
     def me
       DBLista._get('/users/me', @token)
     end
+
+    # Fetches current user guilds
+    #
+    # @return [Hash] raw data from DBLista
+    def guilds
+      DBLista._get('/users/me/guilds', @token)
+    end
   end
 end

data/lib/dblista/user/notifications.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+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
+
+  # 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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# User client - rating
 module DBLista::User
+  # User client - rating
   module Rating
   # Sends rate for a selected bot/server
   #
@@ -9,15 +9,16 @@ module DBLista::User
   # @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
+  # @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 ALLOWED_TYPES.include?(type)
+    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)
+    true
   end
 
   # Removes rate for a selected bot/server
@@ -25,12 +26,13 @@ module DBLista::User
   # @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
+  # @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)
+    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

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-# User client - voting
 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
+  # @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)
+    true
   end
   end
 end

data/lib/dblista/version.rb

@@ -2,5 +2,5 @@
 
 module DBLista
   # Wrapper version
-  VERSION = '0.1.3'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dblista
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.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: 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
@@ -78,7 +80,9 @@ files:
 - lib/dblista/user/actions.rb
 - lib/dblista/user/boosting.rb
 - 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