dbiorb 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b597f780c1f5b1c9487454604b48a13b6529c40670657afe01b6bab173ea340
-  data.tar.gz: 558a0217c77fcbbdfa1d281c9e4a3e7655224bbfdf23f4ec91372b98703457d0
+  metadata.gz: 0f740860860737d6b7cc450fb0c27dbdc08756daadeac6248902b0ddbae17c38
+  data.tar.gz: e88c2abc140fee0524897602ff0db19501873a0838aa764b6b43b60e100f79fe
 SHA512:
-  metadata.gz: ba80a4298056afa7a89895f98fabf3235c6e5c72dead03a2d727373de66cdf4c52bfcc8b91e843e7c43cd2e183609e51ed81b9659f49ff25293e476a92573282
-  data.tar.gz: 7487b13123c5ae98c9a7540ccbbe2da85edfa1fd5bb94ede7eb0aaf0d1c474541a0c914501e8c2ce662162e6e00bf6cc752e2da841727ad68436e7375819fbe1
+  metadata.gz: 70af506bd80c55418eeb8fdf2dd71f03948b3b4bf3bf421ba7ec3140a115fb354d75d111b5c1e0bc439c9bcb69a80c5137cebb69a8110c57c5c9487d5092403c
+  data.tar.gz: e92b20fcd04d64bf476210da620c6b43d42dab7d5c20054e623097df9d4d5d94a15c9688875135a030a0c065a7ac7686ea282ea31d6e3e353d06f5a047c99b3c

data/lib/dbio.rb

@@ -12,18 +12,30 @@ 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
 
-  def top_upvoted
+  # 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_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
 
 # Require files.
 require 'dbio/discord_connection'
 require 'dbio/discord_profile'
+require 'dbio/search_result'
 require 'dbio/user_connection'
 require 'dbio/user'

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

@@ -5,14 +5,61 @@ class DBio::SearchResult
     @data = data
   end
 
-  # The type of connection, e.g. Twitter, YouTube, etc.
-  # @return [String] the type of connection
-  def type
-    @data['type']
+  # The slug of this result's user.
+  def slug
+    @data['user']['slug']
   end
 
-  # @return [String] the name as it appears on the User profile
-  def name
-    @data['name']
+  # @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
+    user = JSON.parse(RestClient.get("https://api.discord.bio/v1/user/details/#{slug}"))
+
+    DBio::User.new(user['payload'])
   end
 end

data/lib/dbio/user.rb

@@ -14,19 +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/#{profile_url}"
+  end
+
   # The id of the user.
   # @return [Integer] User ID in integer form.
   def id
     @user['user_id'].to_i
   end
 
-  # The flags for this user. Not entirely sure what they mean, but they're there.
+  # @return [Integer] the amount of likes this user has.
+  def likes
+    @user['likes']
+  end
+
+  # 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']

metadata

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