dbiorb 0.1.0

checksums.yaml

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

data/lib/dbio.rb

@@ -0,0 +1,29 @@
+# Require external gems
+require 'json'
+require 'rest-client'
+
+# All DBio functionality, whether extended or just here.
+class DBio
+  # Initialize the API. Not much here really.
+  def initialize; end
+
+  # Load a user
+  # @param id [Integer, String] the user ID or name of the requested user.
+  # @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.new(user['payload'])
+  end
+
+  def top_upvoted
+
+  end
+end
+
+# Require files.
+require 'dbio/discord_connection'
+require 'dbio/discord_profile'
+require 'dbio/user_connection'
+require 'dbio/user'

data/lib/dbio/discord_connection.rb

@@ -0,0 +1,23 @@
+# Find information about a Discord Connection.
+class DBio::DiscordConnection
+  # Initialize the connection
+  def initialize(data)
+    @data = data
+  end
+
+  # The type of Discord connection, e.g. Twitter, YouTube, etc.
+  # @return [String] the type of connection
+  def type
+    @data['connection_type']
+  end
+
+  # @return [String] the name as it appears on the Discord profile
+  def name
+    @data['name']
+  end
+
+  # @return [String] the URL to the connection as it is on the Discord profile
+  def url
+    @data['url']
+  end
+end

data/lib/dbio/discord_profile.rb

@@ -0,0 +1,38 @@
+# Find information about a Discord Profile.
+class DBio::DiscordProfile
+  # Initialize the profile
+  def initialize(data)
+    @data = data
+  end
+
+  # The id of the user.
+  # @return [Integer] User ID in integer form.
+  def id
+    @user['id'].to_i
+  end
+
+  # @return [String] the username as it appears on Discord
+  def username
+    @data['username']
+  end
+
+  # @return [String] the avatar hash of this user
+  def avatar_hash
+    @data['avatar_hash']
+  end
+
+  # @return [String] this user's discriminator
+  def discriminator
+    @data['discriminator']
+  end
+
+  # @return [Integer] public flags provided via Oauth, not useful on their own.
+  def public_flags
+    @data['public_flags']
+  end
+
+  # @return [String] the user's name+discriminator. Same as it is in discordrb
+  def distinct
+    "#{username}\##{discriminator}"
+  end
+end

data/lib/dbio/search_result.rb

@@ -0,0 +1,18 @@
+# A shorter version of a user's details
+class DBio::SearchResult
+  # Initialize the result
+  def initialize(data)
+    @data = data
+  end
+
+  # The type of connection, e.g. Twitter, YouTube, etc.
+  # @return [String] the type of connection
+  def type
+    @data['type']
+  end
+
+  # @return [String] the name as it appears on the User profile
+  def name
+    @data['name']
+  end
+end

data/lib/dbio/user.rb

@@ -0,0 +1,120 @@
+# Find information about users.
+class DBio::User
+  # Initialize the user
+  def initialize(data)
+    @user = data['user']['details']
+    @discord = data['discord']
+    @discord_connections = data['user']['discordConnections']
+    @user_connections = data['user']['user_connections']
+  end
+
+  # @return data in raw json form.
+  attr_reader :data
+
+  alias_method :to_s, :data
+
+  # The slug of this user. Use: dsc.bio/slug
+  # @see [User#profile_url]
+  # @return [String] the slug
+  def slug
+    @user['slug']
+  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 flags for this user
+  def flags
+    @user['flags']
+  end
+
+  # @return [boolean] if this user is verified
+  def verified?
+    @user['verified'] == 1
+  end
+
+  # @return [Time] The time this user was created
+  def created
+    Time.parse(@user['created_at'])
+  end
+
+  # @return [String, nil] the description for this user, if one is set.
+  def description
+    @user['description']
+  end
+
+  # @return [String, nil] the location for this user, if one is set.
+  def location
+    @user['location']
+  end
+
+  # The API returns an integer, so this is converted to a String.
+  # @return [String, nil] the gender of this user in String form.
+  def gender
+    case @user['gender']
+    when 0
+      "Male"
+    when 1
+      "Female"
+    when 2
+      "Non-Binary"
+    when nil
+      "Undisclosed"
+    else
+      nil
+    end
+  end
+
+  # @return [Date, nil] the birthdate of this user, if one is set
+  def birthday
+    Date.parse(@user['birthday'])
+  end
+
+  # @return [String, nil] the user's email, if one is set
+  def email
+    @user['email']
+  end
+
+  # @return [String, nil] the user's occupation, if one is set
+  def occupation
+    @user['occupation']
+  end
+
+  # @return [String, nil] the user's banner, if one is set
+  def banner_url
+    @user['banner']
+  end
+
+  # @return [Boolean] the user's premium status
+  def premium?
+    @user['premium']
+  end
+
+  # @return [Boolean] the user's staff status
+  def staff?
+    @user['staff']
+  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) }
+  end
+
+  # The user's Discord.Bio connections. Not as specific.
+  # @return [Array<UserConnection>] the user's discord.bio connections
+  def user_connections
+    @user_connections.map { |e, f| DBio::UserConnection.new({ "type": e, "name": f }) }
+  end
+
+  # The user's Discord profile information, not overly specific either.
+  # I instead recommend just getting it though your Discord Library with the ID
+  # @see [User#id]
+  def discord_profile
+    DBio::DiscordProfile.new(@discord)
+  end
+end

data/lib/dbio/user_connection.rb

@@ -0,0 +1,18 @@
+# Find information about a Discord.Bio Connection.
+class DBio::UserConnection
+  # Initialize the connection
+  def initialize(data)
+    @data = data
+  end
+
+  # The type of connection, e.g. Twitter, YouTube, etc.
+  # @return [String] the type of connection
+  def type
+    @data['type']
+  end
+
+  # @return [String] the name as it appears on the User profile
+  def name
+    @data['name']
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: dbiorb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chew
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: A Ruby library for the Discord Bio (https://discord.bio) API.
+email: chew@chew.pw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dbio.rb
+- lib/dbio/discord_connection.rb
+- lib/dbio/discord_profile.rb
+- lib/dbio/search_result.rb
+- lib/dbio/user.rb
+- lib/dbio/user_connection.rb
+homepage: https://github.com/Chew/dbiorb
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/Chew/dbiorb/issues
+  changelog_uri: https://github.com/Chew/dbiorb/releases
+  homepage_uri: http://github.com/Chew/dbiorb
+  source_code_uri: http://github.com/Chew/dbiorb
+  wiki_uri: http://github.com/Chew/dbiorb/wiki
+  documentation_uri: https://rubydocs.chew.pro/docs/dbiorb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Discord Bio API for Ruby
+test_files: []