dblista 0.3.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a839df00612d366d1a0184c647cdce72895f1ee02d71c25deb2e76ae78c7026
-  data.tar.gz: 4922b94a22e10332f564ef628058664204c3904c794e1381cab452478c24af8f
+  metadata.gz: a670e074610d8c1087fe16c42b0864afe8b29f519092bb71b07ed202cce621f0
+  data.tar.gz: 98dcacb603967baab512b828b5fa34a06c3a528444776b93a0b96035b09db943
 SHA512:
-  metadata.gz: c9131862894f3adfaba7fb2a0add9f7fb31f423a8a94ebbd19efb8d1f84f8c14e8ee9acec3c1742a3eef0cc2e02cb8f228f5ab3eb98b5e6ebe8de0427b4f2d14
-  data.tar.gz: 3105e3459bea2a2c8f33f1f4470ead0d103d6757396bdde267e4b323cd5839e573d90d63d47ab6b3756083cf0e5f9a18740b2a844629ddc06ceca51ea6ab6150
+  metadata.gz: 2a7dc73182643455004db0a1a37a67b6ed5e185c02cea49265d21918ebecc737673a8ea929928cc3821cb17b8e7a4e7fa555da7ae76943530273869ae043a525
+  data.tar.gz: 323fa2c8c12a9cb6849118b4d38844c5c1261fd9a75d1279b0bac100458b318cd0c372011849c905bceff307d7a441d5069a87c252a9850376278cbc606b81d3

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    dblista (0.3.2)
+    dblista (0.6.1)
+      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

@@ -2,7 +2,14 @@
 
 [Dokumentacja](https://www.rubydoc.info/github/marek12306/dblista-wrapper-ruby)
 
-Gem pozwalający na komunikację z API DBListy. Pozwala m.in. na automatyczne wysyłanie statystyk (dla botów napisanych w Discordrb), CRUD botów i serwerów oraz pare innych rzeczy.
+Gem pozwalający na komunikację z API DBListy.
+
+Pozwala na:
+
+- Automatyczne/ręczne wysyłanie statystyk
+- Kontrolowanie kontem użytkownika
+- Pobieranie różnych list botów oraz serwerów oraz wyszukiwanie
+- Pobieranie informacji o botach, serwerach oraz użytkownikach
 
 ## Instalacja
 
@@ -38,4 +45,4 @@ 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'
@@ -24,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
@@ -84,4 +90,8 @@ module DBLista
   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

@@ -35,6 +35,34 @@ module DBLista
     USER = 0
     MODERATOR = 1
     BIG_MODERATOR = 2
-    ADMINISTRATOR = 3
+    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/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

@@ -20,7 +20,9 @@ module DBLista::List
     def self.top(page = 0, limit = 10)
       DBLista._page_integer page
       DBLista._limit_integer limit
-      DBLista._get("/bots/list/top/#{page}?limit=#{limit}")
+      DBLista._cache("botstop#{page}-#{limit}") do
+        DBLista._get("/bots/list/top/#{page}?limit=#{limit}")
+      end
     end
 
     # Fetches premium bots
@@ -31,28 +33,36 @@ module DBLista::List
     def self.premium(page = 0, limit = 10)
       DBLista._page_integer page
       DBLista._limit_integer limit
-      DBLista._get("/bots/list/premium/#{page}?limit=#{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::List::Bot.top(0, 100_000_000)
+      DBLista._cache(:botsall) do
+        DBLista._get('/bots/list/top/0?limit=1000000')
+      end
     end
 
     # Bot search
@@ -62,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.to_s}")
+      DBLista._cache("botsearch#{query}") do
+        DBLista._get("/bots/search/#{CGI.escape query.to_s}")
+      end
     end
   end
 end

data/lib/dblista/list/server.rb

@@ -13,7 +13,9 @@ module DBLista::List
     def self.top(page = 0, limit = 10)
       DBLista._page_integer page
       DBLista._limit_integer limit
-      DBLista._get("/servers/list/top/#{page}?limit=#{limit}")
+      DBLista._cache("serverstop#{page}-#{limit}") do
+        DBLista._get("/servers/list/top/#{page}?limit=#{limit}")
+      end
     end
 
     # Fetches premium servers
@@ -24,14 +26,18 @@ module DBLista::List
     def self.premium(page = 0, limit = 10)
       DBLista._page_integer page
       DBLista._limit_integer limit
-      DBLista._get("/servers/list/premium/#{page}?limit=#{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::List::Server.top(0, 100_000_000)
+      DBLista._cache(:serversall) do
+        DBLista._get('/servers/list/top/0?limit=1000000')
+      end
     end
 
     # Server search
@@ -41,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.to_s}")
+      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

@@ -58,5 +58,23 @@ module DBLista::User
                     }, @token)
       true
     end
+
+    # Generates token for bot
+    #
+    # @param id [Integer] bot ID
+    # @return [Hash] raw data from DBLista
+    def generate_token(id)
+      DBLista._validate_id id
+      DBLista._get("/bots/stats/#{id}?token=#{@token}")
+    end
+
+    # Resets token for bot
+    #
+    # @param id [Integer] bot ID
+    # @return [Hash] raw data from DBLista
+    def reset_token(id)
+      DBLista._validate_id id
+      DBLista._post("/bots/stats/#{id}/reset", nil, @token)
+    end
   end
 end

data/lib/dblista/user/client.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require 'zache'
+
 require_relative './actions'
 require_relative './boosting'
 require_relative './rating'
 require_relative './voting'
 require_relative './notifications'
 require_relative './verification'
+require_relative './info'
 
 # User module - client + client modules
 module DBLista::User
@@ -25,6 +28,7 @@ module DBLista::User
     include DBLista::User::Rating
     include DBLista::User::Notifications
     include DBLista::User::Verification
+    include DBLista::User::Information
 
     # Allowed entity types to use
     ALLOWED_TYPES = %i[bot server].freeze
@@ -35,6 +39,7 @@ module DBLista::User
       raise DBLista::Error, DBLista::Errors::TOKEN_NOT_PROVIDED unless token
 
       @token = token
+      @cache = Zache.new
 
       me
     end
@@ -43,14 +48,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)
+    def joined_guilds
+      @cache.get(:guilds, lifetime: DBLista::CACHE_LIFETIME) do
+        DBLista._get('/users/me/guilds', @token)
+      end
     end
   end
 end

data/lib/dblista/user/info.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DBLista::User
+  # User client - information
+  module Information
+    # Fetches your servers
+    #
+    # @return [Hash] raw data from DBLista
+    def servers
+      DBLista._get('/servers/user/me', nil, @token)
+    end
+
+    # Fetches your bots
+    #
+    # @return [Hash] raw data from DBLista
+    def bots
+      DBLista._get('/bots/user/me', nil, @token)
+    end
+  end
+end

data/lib/dblista/user/rating.rb

@@ -34,5 +34,40 @@ module DBLista::User
       DBLista._delete("/#{type}s/#{id}/rate/#{target_id}", nil, @token)
       true
     end
+
+    # Reports rate of a selected bot/server
+    #
+    # @param id [Integer] ID
+    # @param target_id [Integer] target user to remove rate from (for owners only)
+    # @param report_reason [String] reason of report (details)
+    # @param type [Symbol] type of entity (bot/server)
+    # @return [Boolean] true if operation succeded
+    def report_rate(id, rate_id, report_reason = 'Brak powodu', 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}/ratings/#{rate_id}/report", {
+                                                                   reportReason: report_reason.to_s
+                                                                 }, @token)
+      true
+    end
+
+    # Fetches all rate reports
+    #
+    # @return [Hash] raw data from DBLista
+    def reports
+      DBLista._get('/reports')
+    end
+
+    # Deletes rate report
+    #
+    # @param id [Integer] report ID
+    # @return [Hash] raw data from DBLista
+    def delete_report(id, type = :bot)
+      raise DBLista::Error, DBLista::Errors::TYPE_NOT_ALLOWED unless DBLista::User::Client::ALLOWED_TYPES.include?(type)
+
+      DBLista._delete("/reports/#{id}", nil, @token)
+      true
+    end
   end
 end

data/lib/dblista/user/verification.rb

@@ -13,7 +13,7 @@ module DBLista::User
     def approve(id, reason = 'Brak powodu')
       DBLista._validate_id id
 
-      DBLista._post("/bots/#{id}/approve?reason=#{CGI.escape reason}", nil, @token)
+      DBLista._post("/bots/verify/#{id}/approve?reason=#{CGI.escape reason}", nil, @token)
       true
     end
 
@@ -25,7 +25,7 @@ module DBLista::User
     def reject(id, reason = 'Brak powodu')
       DBLista._validate_id id
 
-      DBLista._post("/bots/#{id}/reject?reason=#{CGI.escape reason}", nil, @token)
+      DBLista._post("/bots/verify/#{id}/reject?reason=#{CGI.escape reason}", nil, @token)
       true
     end
 

data/lib/dblista/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dblista
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.6.1
 platform: ruby
 authors:
 - deepivin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-05 00:00:00.000000000 Z
+date: 2020-07-06 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,7 +82,12 @@ 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
@@ -80,6 +99,7 @@ files:
 - lib/dblista/user/actions.rb
 - lib/dblista/user/boosting.rb
 - lib/dblista/user/client.rb
+- lib/dblista/user/info.rb
 - lib/dblista/user/notifications.rb
 - lib/dblista/user/rating.rb
 - lib/dblista/user/verification.rb

data/example/info.rb

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