dbiorb 0.1.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fc93ac9fc1e4a99dd8f3ee921bf47a8ab9c80acb2826ad75b9c01982bd68fbc
-  data.tar.gz: 2c8c500a671a4b17b03a69544307e6735722e37999ecaa31bceab435631ffe1b
+  metadata.gz: 3565ccefb9e1eb0dc274b71be6fdeb2c454c70621911505e7f2d6fcbf5cb065b
+  data.tar.gz: 0b911b55c964887470ba13c8d232717a0b65b5408f00967aca1168f87217bb01
 SHA512:
-  metadata.gz: e636b2cbe0d4916da8db6240c8dc89beeaf413f2bf9fdd40b3d3c53c0abedb03309c44dc739c13cc1fd196e573792d779febe6da34bb9ecb5265d5fc10f2d10a
-  data.tar.gz: 03d7850c5258d270acafb11a9b601f34c1828e00b09ac8866182521f83e474df1cf9fbd965c77b46d231534908273589bb58dd5484c6dad66c29b811f4f093fe
+  metadata.gz: cfeada1f447ce82cf783f9349c10e881549ed1e1c9aa5caabc15042c4237329f9bc1f7c016a1d22b7b4e35f32e08a648955d6e032670405d5d7e4bb6c30d03b7
+  data.tar.gz: f5c58be8e8f15664e2b0428e8827fc85ca15ff0a6555773058e54d9b6dea7b8c6833570b46c65e6d0b0c108a7cba28964c9c90e64ff9748bbfe13f60ac04a2e5

data/lib/dbio.rb

@@ -12,17 +12,24 @@ class DBio
   # @raise [RestClient::NotFound] if the specified user does not exist
   # @return [User] the new user object
   def user(id)
-    user = JSON.parse(RestClient.get("https://api.discord.bio/v1/user/details/#{id}"))
+    user = JSON.parse(RestClient.get("https://api.discord.bio/user/details/#{id}"))
 
     User.new(user['payload'])
   end
 
-  # Returns the top upvoted users.
+  # Returns the users by most likes.
   # Their data is short, so it's not really worth storing a lot of data
   # @see [SearchResult#user]
   # @return [Array<SearchResult>] the response
-  def top_upvoted
-    JSON.parse(RestClient.get("https://api.discord.bio/v1/topUpvoted"))['payload'].map { |e| SearchResult.new(e) }
+  def top_likes
+    JSON.parse(RestClient.get("https://api.discord.bio/topLikes"))['payload'].map { |e| SearchResult.new(e) }
+  end
+
+  # Searches for a user
+  # This API is not publicly documented and can break at any time. Be careful!
+  # @return [Array<SearchResult>] the response
+  def search(user)
+    JSON.parse(RestClient.get("https://api.discord.bio/user/search/#{user}"))['payload'].map { |e| SearchResult.new(e) }
   end
 end
 

data/lib/dbio/discord_connection.rb

@@ -20,4 +20,14 @@ class DBio::DiscordConnection
   def url
     @data['url']
   end
+
+  # The icon is used on the website, it's a Font Awesome icon code.
+  # Not really useful unless you're making a site with the gem, in which case you'd probably do:
+  # <a href="<%= @connection.url %>"><i class="<%= @connection.icon %>"></i> <%= @connection.name %></a>
+  # Which could return:
+  # <a href="https://twitter.com/twitter"><i class="fab fa-twitter"></i> Twitter</a>
+  # @return [String] the font awesome icon code for this connection
+  def icon
+    @data['icon']
+  end
 end

data/lib/dbio/search_result.rb

@@ -10,6 +10,51 @@ class DBio::SearchResult
     @data['user']['slug']
   end
 
+  # @return [String] this result's discord username
+  def discord_username
+    @data['discord']['username']
+  end
+
+  # @return [String] this result's discord discriminator
+  def discord_discriminator
+    @data['discord']['discriminator']
+  end
+
+  # @return [Integer] this result's discord ID
+  def discord_id
+    @data['discord']['id'].to_i
+  end
+
+  # @return [String] this result's discord avatar hash
+  def discord_avatar
+    @data['discord']['avatar']
+  end
+
+  # @return [Boolean] if this user is verified
+  def verified?
+    @data['user']['verified'] == 1
+  end
+
+  # @return [Boolean] if this user is a discord.bio staff member
+  def staff?
+    @data['user']['staff']
+  end
+
+  # @return [Boolean] if this user is a premium user
+  def premium?
+    @data['user']['premium']
+  end
+
+  # @return [Integer] this user's upvotes
+  def upvotes
+    @data['user']['upvotes']
+  end
+
+  # @return [String] this user's description
+  def description
+    @data['user']['description']
+  end
+
   # The user itself, for more detail
   # @return [User] the user
   def user

data/lib/dbio/user.rb

@@ -14,24 +14,36 @@ class DBio::User
   alias_method :to_s, :data
 
   # The slug of this user. Use: dsc.bio/slug
-  # @see [User#profile_url]
+  # @see User#profile_url
   # @return [String] the slug
   def slug
     @user['slug']
   end
 
+  # The link to this user's profile
+  # @return [String] this user's profile
+  def profile_url
+    "https://dsc.bio/#{slug}"
+  end
+
   # The id of the user.
   # @return [Integer] User ID in integer form.
   def id
     @user['user_id'].to_i
   end
 
-  # @return [Integer] the amount of upvotes this user has.
-  def upvotes
-    @user['upvotes']
+  # @return [Integer] the amount of likes this user has.
+  def likes
+    @user['likes']
   end
 
-  # The flags for this user. Not entirely sure what they mean, but they're there.
+  # This simply returns the likes, switch to likes.
+  # @deprecated
+  # @see [likes]
+  alias_method :upvotes, :likes
+
+  # The oauth flags for this user. Not useful on their own.
+  # @see DBio::DiscordProfile#public_flags
   # @return [Integer] the flags for this user
   def flags
     @user['flags']
@@ -39,7 +51,7 @@ class DBio::User
 
   # @return [boolean] if this user is verified
   def verified?
-    @user['verified'] == 1
+    @user['verified']
   end
 
   # @return [Time] The time this user was created
@@ -104,10 +116,18 @@ class DBio::User
     @user['staff']
   end
 
+  # The premium type as found on Discord.
+  # ezpz way to see if they're Nitro.
+  # For Types, see https://discord.com/developers/docs/resources/user#user-object-premium-types
+  # @return [Integer] this user's premium type
+  def premium_type
+    @user['premium_type']
+  end
+
   # This is the user's Discord connections as they appear on their Discord profile
   # @return [Array<DiscordConnection>] the user's discord connections
   def discord_connections
-    @discord_connections.map{ |e| DBio::DiscordConnection.new(e) }
+    @discord_connections.map { |e| DBio::DiscordConnection.new(e) }
   end
 
   # The user's Discord.Bio connections. Not as specific.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbiorb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Chew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json