dblista 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03552046ae51c948da59280f1f33b786b5fb504365a5cc055756039e927b1db1
-  data.tar.gz: b3c8a8ecf6f040e27ed63692969b8b966a561badd09ca69bf32b16bd81583d52
+  metadata.gz: 1fa0b18a050a6369352d032a11be2497c207a8f16a4456c11aa2be79695d3738
+  data.tar.gz: c46e76121ccf62a37004db3c867f421d02ce12c4b0516a73e1d37e00f88cdc54
 SHA512:
-  metadata.gz: f748d302a492e25be43ffa01a74b4d8066bf82f7a0006188e93371c5db46dec7c5ceb38119bd92cebeb9889fd33ea02fa93c9e70890a8091f20de8711963ff33
-  data.tar.gz: 8fd35536aa122579ab14c8014e3022f9289e3f489b294087a6ff9789d9d1c5700e11ed63edd60b6c8de94e542b8fde9efc91a64f179a441448bcd81f3d4c07a9
+  metadata.gz: 9940f8419b0c118ffb071640481ef77d87479e66cc0a723d9ff8f03a365207d4f419779b2cd77646309ac584b2f8e9ada0147a74bf3b1cd5db613a5839445b33
+  data.tar.gz: 8dea89026931f27610552e00dc2a008ee1a02df08777661964bfb244d90400d7e95b27cce6e7142bd64a3e9cc9258583823fa254e687baa3cb34141a0fd439ee

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,8 @@
-# DBLista
+# DBLista Ruby wrapper [![Gem Version](https://badge.fury.io/rb/dblista.svg)](https://badge.fury.io/rb/dblista)
 
 [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) oraz na CRUD botów oraz serwerów.
+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.
 
 ## Instalacja
 
@@ -36,6 +36,6 @@ top = DBLista::List::Bot.top
 puts top['data'].inspect
 ```
 
-## License
+## Licencja
 
 Ten gem jest dostępny na licencji [MIT License](https://opensource.org/licenses/MIT). Rób z nim co chcesz.

data/lib/dblista.rb

@@ -12,6 +12,7 @@ require_relative 'dblista/errors'
 require_relative 'dblista/list/bot'
 require_relative 'dblista/list/server'
 require_relative 'dblista/user/client'
+require_relative 'dblista/helpers'
 
 # Main module
 module DBLista
@@ -22,12 +23,6 @@ module DBLista
   # Regexp for checking if string is a number
   IS_NUMBER = /^\d+$/.freeze
 
-  # @!visibility private
-  def self._get(path)
-    req = URI.open("#{DBLista::API_PATH}#{path}")
-    JSON.parse req.read
-  end
-
   def self._https(uri)
     Net::HTTP.new(uri.host, uri.port).tap do |http|
       http.use_ssl = true
@@ -40,7 +35,16 @@ module DBLista
     req['Content-Type'] = 'application/json'
     req['Authorization'] = token if token
     response = _https(uri).request(req)
-    JSON.parse response.body
+    result = JSON.parse response.body
+    raise DBLista::Error, result['error'].capitalize unless result['status'] == 'success'
+    result['data']
+  end
+
+  # @!visibility private
+  def self._get(path, token = nil)
+    uri = URI("#{DBLista::API_PATH}#{path}")
+    req = Net::HTTP::Get.new(uri)
+    _handle_request(req, uri, token, nil)
   end
 
   # @!visibility private

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
@@ -14,4 +16,6 @@ module DBLista::Errors
   QUERY_NOT_PROVIDED = 'Search query is not provided'
   # Raised when body is not a hash
   BODY_HASH = 'Body must be a hash'
+  # Raised when token is invalid or expired
+  INVALID_TOKEN = 'Invalid or expired token'
 end

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

data/lib/dblista/user/actions.rb

@@ -2,8 +2,8 @@
 
 require 'json'
 
-# User client - actions
 module DBLista::User
+  # User client - actions
   module Actions
   # Adds bot/server to DBLista
   #
@@ -40,5 +40,19 @@ module DBLista::User
 
     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
   end
 end

data/lib/dblista/user/boosting.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-##
-# User client - boosting
 module DBLista::User
+  # User client - boosting
   module Boosting
   # Boosts selected bot/server
   #

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
@@ -31,6 +35,22 @@ module DBLista::User
       raise DBLista::Error, DBLista::Errors::TOKEN_NOT_PROVIDED unless token
 
       @token = token
+
+      me
+    end
+
+    # 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,49 @@
+# 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 [Hash] raw data from DBLista
+  def clear_notifications
+    DBLista._get('/users/me/notifications/clear', @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 [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 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
+  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
   #

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,7 +1,7 @@
 # frozen_string_literal: true
 
-# User client - voting
 module DBLista::User
+  # User client - voting
   module Voting
   # Votes for a selected bot/server
   #

data/lib/dblista/version.rb

@@ -2,5 +2,5 @@
 
 module DBLista
   # Wrapper version
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dblista
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - deepivin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2020-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - example/info.rb
 - lib/dblista.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 +79,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