hqtrivia 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de79073cbcf341d2d04df99305e006ad41a1c4ff80a88178df4317f2db226cd5
+  data.tar.gz: a1809a12979e96b01b768abf1d2287456afb4897751a1a4a0b893b054a58b901
+SHA512:
+  metadata.gz: 4c152b633594fdce2a4597e4b0deb443def346ef3b974ae7bb2c69863245f3b466a4451d5d6bd3d6ae00b2e7ebb2d8e6b9d7047d8e9a3f3b5a635a08cb1c9cc7
+  data.tar.gz: 0cc430e4d02f902c974636265c89b801514b83763b6e1126475269753182bd1997de613a4a0bfeeb23b32c17ad130719c5869de24541c092ba313c6f93181a1b

data/README.md

@@ -0,0 +1,50 @@
+# HQTriviaRB
+
+A ruby library for HQ Trivia.
+
+## What is this for?
+
+I mean, why not.
+
+## Usage
+
+Put this near the top of your ruby whatever:
+
+```ruby
+require 'hqtrivia'
+
+HQ = HQTrivia.new("[your HQ api key]")
+```
+
+Don't have a key? We have a class for that!
+
+```ruby
+require 'hqtrivia'
+
+e = HQTrivia::GenerateKey.new(country_code: code, phone_number: "[number]", method: "sms/call")
+e.verify("code")
+HQ = e.hq
+```
+
+Now, when you need to run a method, run HQ.method.
+
+Example for getting the authed user.
+
+```ruby
+HQ.me.username
+# => "Chewsterchew"
+```
+
+## Documentation
+
+Stuck? Know Ruby? Check out the [documentation](https://rubydocs.chew.pro/docs/hqtrivia).
+
+Still stuck? That Stucks! hey it! Check out our support channels
+
+### Support Channels
+
+nonexistent. :!
+
+## But Ruby sucks
+
+***NO U***

data/lib/hqtrivia.rb

@@ -0,0 +1,52 @@
+# Require external gems
+require 'json'
+require 'rest-client'
+
+# All HQTrivia functionality, whether extended or just here.
+class HQTrivia
+  # Initialize a new HQTrivia Object, via a key.
+  # @param key [String] your API Key.
+  def initialize(key)
+    @key = key
+  end
+
+  # Get the key back. In case you left it at the door.
+  attr_reader :key
+
+  # Get a user by ID
+  # @return [User] the new user
+  def user(id)
+    User.new(id, @key)
+  end
+
+  # Get the authed user's profile
+  # @return [Me] the you
+  def me
+    Me.new(@key)
+  end
+
+  # Get a user's badges (by user ID)
+  # @return [Badges] the badges
+  def badges(id)
+    Badges.new(id, @key)
+  end
+
+  # @return [Schedule] the show schedule
+  def schedule
+    Schedule.new(@key)
+  end
+end
+
+# Require files.
+require 'hqtrivia/badge'
+require 'hqtrivia/badges'
+require 'hqtrivia/user'
+require 'hqtrivia/user/leaderboard'
+require 'hqtrivia/user/streakinfo'
+require 'hqtrivia/user/seasonxp'
+require 'hqtrivia/me'
+require 'hqtrivia/schedule'
+require 'hqtrivia/schedule/announcement'
+require 'hqtrivia/schedule/show'
+require 'hqtrivia/errors'
+require 'hqtrivia/generatekey'

data/lib/hqtrivia/badge.rb

@@ -0,0 +1,65 @@
+# The Badge Class. A very specific badge.
+class HQTrivia::Badge
+  # @!visibility private
+  def initialize(data)
+    @data = data
+  end
+
+  # @return [Integer] the ID of this badge
+  def id
+    @data['achievementId']
+  end
+
+  # @return [String] the name of this badge (shown in the app)
+  def name
+    @data['name']
+  end
+
+  # @return [String] the description of this badge (shown in the app)
+  def description
+    @data['description']
+  end
+
+  # @return [String] the family of this badge
+  def family
+    @data['family']
+  end
+
+  # @return [Integer] the level of this badge
+  def level
+    @data['familyOrder'] + 1
+  end
+
+  # @return [String] the image for this badge
+  def image_url
+    @data['imageUrl']
+  end
+
+  # @return [Float] the progress towards the next level. 100 if achieved.
+  def progress
+    @data['progressPct']
+  end
+
+  # @return [true, false] the completion of this
+  def completed?
+    @data['completed']
+  end
+
+  # @return [Time] the time this progress was last updated
+  def last_updated
+    Time.at(@data['lastUpdated'] / 1000)
+  end
+
+  # @return [Time] the time this progress was last updated
+  def last_updated
+    Time.at(@data['lastUpdated'] / 1000)
+  end
+
+  # HQ API Returns 1/1/1970 if completed? is false. We'll return nil.
+  # @return [Time, nil] the time this was achieved
+  def earned
+    return nil unless completed?
+
+    Time.parse(@data['earnedAt'])
+  end
+end

data/lib/hqtrivia/badges.rb

@@ -0,0 +1,114 @@
+# The Badges Class. A User, but their badges.
+class HQTrivia::Badges
+  # Initialize a new user. Get all their stats. Relax.
+  # @param id [Integer] the ID of the user.
+  # @param key [String] an API key, to get info.
+  # @raise [HQTrivia::Errors::InvalidKey] if the api key is invalid
+  # @raise [HQTrivia::Errors::InvalidUser] if the user id is invalid
+  def initialize(id, key)
+    @data = JSON.parse(RestClient.get("https://api-quiz.hype.space/achievements/v2/#{id}", Authorization: key))
+  rescue RestClient::NotFound
+    raise HQTrivia::Errors::InvalidUser, "This user doesn't exist!"
+  rescue RestClient::Unauthorized
+    raise HQTrivia::Errors::InvalidKey, "This API Key is invalid!"
+  end
+
+  # @see [User#badges_count]
+  # @return [Integer] the amount of badges this person has
+  def badges_count
+    @data['earnedAchievementCount']
+  end
+
+  # @return [Integer] the amount of achievement types
+  def types
+    @data['families'].count
+  end
+
+  # Get badge info for a specific level.
+  # @return [Badge] badge info for this badge
+  def business(level = 3)
+    data = @data['families'].find { |type| type['name'] == 'Business' }
+    badge = data['earnedAchievements'].find { |le| le['familyOrder'] == (level - 1) }
+    HQTrivia::Badge.new(badge)
+  end
+
+  # Get badge info for a specific level.
+  # @return [Badge] badge info for this badge
+  def entertainment(level)
+    data = @data['families'].find { |type| type['name'] == 'Entertainment' }
+    badge = data['earnedAchievements'].find { |le| le['familyOrder'] == (level - 1) }
+    HQTrivia::Badge.new(badge)
+  end
+
+  # Get badge info for a specific level.
+  # @return [Badge] badge info for this badge
+  def geography(level)
+    data = @data['families'].find { |type| type['name'] == 'Geography' }
+    badge = data['earnedAchievements'].find { |le| le['familyOrder'] == (level - 1) }
+    HQTrivia::Badge.new(badge)
+  end
+
+  # Get badge info for a specific level.
+  # @return [Badge] badge info for this badge
+  def history(level)
+    data = @data['families'].find { |type| type['name'] == 'History' }
+    badge = data['earnedAchievements'].find { |le| le['familyOrder'] == (level - 1) }
+    HQTrivia::Badge.new(badge)
+  end
+
+  # Get badge info for a specific level.
+  # @return [Badge] badge info for this badge
+  def literature(level)
+    data = @data['families'].find { |type| type['name'] == 'Literature' }
+    badge = data['earnedAchievements'].find { |le| le['familyOrder'] == (level - 1) }
+    HQTrivia::Badge.new(badge)
+  end
+
+  # Get badge info for a specific level.
+  # @return [Badge] badge info for this badge
+  def movies(level)
+    data = @data['families'].find { |type| type['name'] == 'Movies' }
+    badge = data['earnedAchievements'].find { |le| le['familyOrder'] == (level - 1) }
+    HQTrivia::Badge.new(badge)
+  end
+
+  # Get badge info for a specific level.
+  # @return [Badge] badge info for this badge
+  def music(level)
+    data = @data['families'].find { |type| type['name'] == 'Music' }
+    badge = data['earnedAchievements'].find { |le| le['familyOrder'] == (level - 1) }
+    HQTrivia::Badge.new(badge)
+  end
+
+  # Get badge info for a specific level.
+  # @return [Badge] badge info for this badge
+  def nature(level)
+    data = @data['families'].find { |type| type['name'] == 'Nature' }
+    badge = data['earnedAchievements'].find { |le| le['familyOrder'] == (level - 1) }
+    HQTrivia::Badge.new(badge)
+  end
+
+  # Get badge info for a specific level.
+  # @return [Badge] badge info for this badge
+  def science(level)
+    data = @data['families'].find { |type| type['name'] == 'Science' }
+    badge = data['earnedAchievements'].find { |le| le['familyOrder'] == (level - 1) }
+    HQTrivia::Badge.new(badge)
+  end
+
+  # Get badge info for a specific level.
+  # @return [Badge] badge info for this badge
+  def sports(level)
+    data = @data['families'].find { |type| type['name'] == 'Sports' }
+    badge = data['earnedAchievements'].find { |le| le['familyOrder'] == (level - 1) }
+    HQTrivia::Badge.new(badge)
+  end
+
+  # Get badge info for a specific level.
+  # @return [Badge] badge info for this badge
+  def tv(level)
+    data = @data['families'].find { |type| type['name'] == 'TV' }
+    badge = data['earnedAchievements'].find { |le| le['familyOrder'] == (level - 1) }
+    HQTrivia::Badge.new(badge)
+  end
+end

data/lib/hqtrivia/errors.rb

@@ -0,0 +1,17 @@
+# Errors are cool.
+module HQTrivia::Errors
+  # Raised if a 404 error is returned
+  class InvalidUser < ArgumentError; end
+
+  # Raised if a 401 error is returned
+  class InvalidKey < ArgumentError; end
+
+  # Raised if a 400 error is returned during Phone Verification
+  class InvalidNumber < ArgumentError; end
+
+  # Raised if a 400 error is returned during Code Verification
+  class InvalidCode < ArgumentError; end
+
+  # Raised if a 429 error is returned during Code Verification
+  class TooQuick < ArgumentError; end
+end

data/lib/hqtrivia/generatekey.rb

@@ -0,0 +1,51 @@
+# Require the errors file
+require_relative 'errors'
+
+# The user themselves
+class HQTrivia::GenerateKey
+  # Get that auth key!
+  # @param country_code [Integer] the country code of your number, blank for 1
+  # @param phone [String] the phone actual number
+  # @param method [String] the type of verification method
+  def initialize(country_code: 1, phone: nil, method: "sms")
+    data = {
+      "method" => method,
+      "phone" => "+#{country_code}#{phone}"
+    }
+    @data = JSON.parse(RestClient.post('https://api-quiz.hype.space/verifications', data, 'x-hq-client': 'iOS/1.4.15 b146', 'Content-Type': :json))
+
+    @auth = nil
+
+    @id = @data['verificationId']
+    @retry = Time.now + 20
+    @expires = Time.parse(@data['expires'])
+    @verified = false
+  rescue RestClient::BadRequest
+    raise HQTrivia::Errors::InvalidNumber, "That phone number is invalid."
+  rescue RestClient::TooManyRequests
+    raise HQTrivia::Errors::TooQuick, "You are verifying too fast."
+  end
+
+  # Verify your identity with the code
+  # @param code [Integer, String] the code!
+  def verify(code)
+    @auth = JSON.parse(RestClient.post("https://api-quiz.hype.space/verifications/#{@id}", {"code" => code.to_s}, 'Content-Type': :json))
+    @verified = true
+  rescue RestClient::BadRequest
+    raise HQTrivia::Errors::InvalidCode, "That verification code is incorrect."
+  end
+
+  # @return [String, nil] your API key (once you verify)
+  def key
+    return nil unless @verified
+
+    "Bearer #{@auth['auth']['authToken']}"
+  end
+
+  # @return [HQTrivia, nil] a HQTrivia instance, based on the key
+  def hq
+    return nil unless @verified
+
+    HQTrivia.new("Bearer #{@auth['auth']['authToken']}")
+  end
+end

data/lib/hqtrivia/me.rb

@@ -0,0 +1,78 @@
+# The user themselves
+class HQTrivia::Me < HQTrivia::User
+  # Get that user info!
+  # @param key [String] the key of the user
+  def initialize(key)
+    @key = key
+    @data = JSON.parse(RestClient.get('https://api-quiz.hype.space/users/me', Authorization: key, 'x-hq-client': 'iOS/1.4.15 b146'))
+  end
+
+  # @return [Array<String>] an array of this user's device tokens.
+  def device_tokens
+    @data['deviceTokens']
+  end
+
+  # This is most likely always true, you need one to sign up!
+  # @return [true, false] if this user has a phone number.
+  def phone?
+    @data['hasPhone']
+  end
+
+  # @return [String] your phone number
+  def phone_number
+    @data['phoneNumber']
+  end
+
+  # @return [Integer] how many lives you have
+  def lives
+    @data['lives']
+  end
+
+  # @return [true, false] if you have been referred by someone
+  def referred?
+    @data['referred']
+  end
+
+  # @return [Integer] the user id of the person who referred you.
+  def referring_user_id
+    @data['referringUserId']
+  end
+
+  # Your HQ Preferences
+  # @return [Hash<String, Boolean>] your preferences
+  def preferences
+    @data['preferences']
+  end
+
+  # @return [Array<Integer>] all of your friends. All. Of. Them. Max 50.
+  def friend_ids
+    @data['friendIds']
+  end
+
+  # Base64 for a number between 1-4, this dicates the country you're from.
+  # This doesn't matter anymore, everyone is forced to be American.
+  def stk
+    @data['stk']
+  end
+
+  # @return [StreakInfo] your streak info!
+  def streak_info
+    HQTrivia::User::StreakInfo.new(@data['streakInfo'])
+  end
+
+  # @return [Integer] how many erasers you have
+  def erasers
+    @data['erase1s']
+  end
+
+  # @return [Integer] how many super spins you have
+  def super_spins
+    @data['items']['superSpins']
+  end
+
+  # Your point multipliers. 2x, 3x, 4x.
+  # @return [Hash<Integer, Integer>] your multipliers.
+  def point_multiplier_count
+    @data['pointsMultiplierCounts']
+  end
+end

data/lib/hqtrivia/schedule.rb

@@ -0,0 +1,28 @@
+# The user themselves
+class HQTrivia::Schedule
+  # Get that user info!
+  # @param key [String] the key of the user
+  def initialize(key)
+    @key = key
+    @data = JSON.parse(RestClient.get('https://api-quiz.hype.space/shows/schedule', Authorization: key, 'x-hq-client': 'iOS/1.4.15 b146'))
+  end
+
+  # @return [Array<Show>] all upcoming shows
+  def shows
+    shows = []
+    @data['shows'].each { |show| shows.push(Show.new(show)) }
+    shows
+  end
+
+  # @return [Show] the next game
+  def next
+    Show.new(@data['shows'][0])
+  end
+
+  # @return [Array<Announcement>] all announcements (shown in the schedule tab)
+  def announcements
+    announcements = []
+    @data['tentpoles'].each { |announcement| announcements.push(Announcement.new(announcement)) }
+    announcements
+  end
+end

data/lib/hqtrivia/schedule/announcement.rb

@@ -0,0 +1,80 @@
+# The Schedule Announcement Class. This is an announcement above the schedule
+class HQTrivia::Schedule::Announcement
+  # @param data [JSON] the data.
+  # @!visibility private
+  def initialize(data)
+    @data = data
+  end
+
+  # @return [String] the display name of this announcement
+  def display_name
+    @data['displayName']
+  end
+
+  # @return [String] the accent color
+  def accent_color
+    @data['accentColor']
+  end
+
+  # @return [String] the background color
+  def background_color
+    @data['backgroundColor']
+  end
+
+  # @return [String] the background image
+  def background_image
+    @data['backgroundImage']
+  end
+
+  # @return [String] the background video
+  def background_video
+    @data['backgroundVideo']
+  end
+
+  # @return [String] the color of the text
+  def text_color
+    @data['textColor']
+  end
+
+  # Basically the summary
+  # @return [String] how it works
+  def how_it_works
+    @data['howItWorks']
+  end
+
+  # Basically the description
+  # @return [String] fine print
+  def fine_print
+    @data['finePrint']
+  end
+
+  # @return [Integer] the prize (in cents)
+  def prize_cents
+    @data['prizeCents']
+  end
+
+  # @return [String] the prize currency
+  def prize_currency
+    @data['prizeCurrency']
+  end
+
+  # @return [String] the name of this announcement
+  def name
+    @data['name']
+  end
+
+  # @return [Time] the time of this announcement (countdowns to this)
+  def time
+    Time.parse(@data['time'])
+  end
+
+  # @return [true, false] if this announcement is active
+  def active?
+    @data['active']
+  end
+
+  # @return [String] the state of this announcement
+  def state
+    @data['state']
+  end
+end

data/lib/hqtrivia/schedule/show.rb

@@ -0,0 +1,151 @@
+# The Schedule Show Class. This is a show on the schedule
+class HQTrivia::Schedule::Show
+  # @param data [JSON] the data.
+  # @!visibility private
+  def initialize(data)
+    @data = data
+  end
+
+  # This returns the show type.
+  # "hq" is general trivia.
+  # "hq-sports" is sports
+  # "hq-words" is words.
+  # @see words?
+  # @see general?
+  # @see sports?
+  # @see trivia?
+  # @return [String] the show type
+  def show_type
+    @data['showType']
+  end
+
+  # @return [Integer] the ID of this show
+  def id
+    @data['showId']
+  end
+
+  # This returns the game type.
+  # "trivia" is trivia (general/sports).
+  # "words" is words.
+  # @return [String] the type of this game
+  def game_type
+    @data['gameType']
+  end
+
+  # The "vertical" is a more specific game type.
+  # "general" is normal trivia game
+  # "sports" is a sports trivia game
+  # "words" is a words game.
+  # @return [String] the vertical of this game.
+  def vertical
+    @show['vertical']
+  end
+
+  # The opt is found in preferences.
+  # @see HQTrivia::Me#preferences
+  # @return [String] the opt.
+  def opt
+    @show['vertical']
+  end
+
+  # @return [Time] the start time of this game
+  def start_time
+    Time.parse(@data['startTime'])
+  end
+
+  # The title displayed in the app.
+  # @return [String] the title.
+  def title
+    @data['display']['title']
+  end
+
+  # The summary displayed in the app.
+  # @return [String] the show summary.
+  def summary
+    @data['display']['summary']
+  end
+
+  # The accent color displayed in the app.
+  # @return [String] the accent color.
+  def accent_color
+    @data['display']['accentColor']
+  end
+
+  # The description displayed in the app.
+  # @return [String] the description.
+  def description
+    @data['display']['description']
+  end
+
+  # The image displayed in the app.
+  # @return [String] the image.
+  def image
+    @data['display']['image']
+  end
+
+  # The logo displayed in the app.
+  # @return [String] the logo.
+  def logo
+    @data['display']['logo']
+  end
+
+  # The background image displayed in the app.
+  # @return [String] the background image.
+  def background_image
+    @data['display']['bgImage']
+  end
+
+  # The background video displayed in the app.
+  # @return [String] the background video.
+  def background_video
+    @data['display']['bgVideo']
+  end
+
+  # @return [Integer] the prize in cents.
+  def prize_cents
+    @data['prizeCents']
+  end
+
+  # @return [String] the prize.
+  def prize
+    "$#{(@data['prizeCents'] / 100).to_s.gsub(/(\d)(?=\d{3}+(\.\d*)?$)/, '\1' + ",")}"
+  end
+
+  # @return [String] the currency the prize will be in
+  def currency
+    @data['currency']
+  end
+
+  # @return [String] the season this game will count towards
+  def season_name
+    @data['seasonName']
+  end
+
+  # @return [true, false] if this show is an HQ Words game
+  def words?
+    return true if vertical == 'words'
+
+    false
+  end
+
+  # @return [true, false] if this show is an HQ Trivia game (general or sports)
+  def trivia?
+    return true if game_type == 'trivia'
+
+    false
+  end
+
+  # @return [true, false] if this show is an HQ Sports game
+  def sports?
+    return true if vertical == 'sports'
+
+    false
+  end
+
+  # @return [true, false] if this show is an HQ Trivia (not sports) game
+  def general?
+    return true if vertical == 'general'
+
+    false
+  end
+end

data/lib/hqtrivia/user.rb

@@ -0,0 +1,93 @@
+# The User Class. A User. Your typical, everyday user.
+class HQTrivia::User
+  # Initialize a new user. Get all their stats. Relax.
+  # @param id [Integer] the ID of the user.
+  # @param key [String] an API key, to get info.
+  # @raise [HQTrivia::Errors::InvalidKey] if the api key is invalid
+  # @raise [HQTrivia::Errors::InvalidUser] if the user id is invalid
+  def initialize(id, key)
+    @key = key
+    @data = JSON.parse(RestClient.get("https://api-quiz.hype.space/users/#{id}", Authorization: key))
+  rescue RestClient::NotFound
+    raise HQTrivia::Errors::InvalidUser, "This user doesn't exist!"
+  rescue RestClient::Unauthorized
+    raise HQTrivia::Errors::InvalidKey, "This API Key is invalid!"
+  end
+
+  # @return [Integer] their id
+  def id
+    @data['userId']
+  end
+
+  # @return [String] their username
+  def username
+    @data['username']
+  end
+
+  # A user always has an avatar, whether HQ provided or not.
+  # @return [String] the user's Avatar URL.
+  def avatar_url
+    @data['avatarUrl']
+  end
+
+  # @return [Time] the creation date of this user
+  def created
+    Time.parse(@data['created'])
+  end
+
+  # This user's leaderboard, returned as a UserLeaderboard object
+  # @return [User::Leaderboard] the user's leaderboard standings
+  def leaderboard
+    HQTrivia::User::Leaderboard.new(@data['leaderboard'])
+  end
+
+  # @return [Integer] the user's high score.
+  def high_score
+    @data['highScore']
+  end
+
+  # @return [Integer] the amount of games this user has played
+  def games_played
+    @data['gamesPlayed']
+  end
+
+  # @return [Integer] the amount of games this user has won
+  def win_count
+    @data['winCount']
+  end
+
+  # @see [User#badges]
+  # @return [Integer] the amount of badges this person has
+  def badges_count
+    @data['achievementCount']
+  end
+
+  # @return [Badges] the badges for this user.
+  def badges
+    HQTrivia::Badges.new(id, @key)
+  end
+
+  # @return [User::SeasonXP] the season XP stats of this user
+  def season_xp
+    HQTrivia::User::SeasonXP.new(@data['seasonXp'])
+  end
+
+  # @return [true, false] whether this person has been blocked by the authed user
+  def blocked?
+    @data['blocked']
+  end
+
+  # @return [true, false] whether this person is blocking the authed user
+  def blocking?
+    @data['blocksMe']
+  end
+
+  # If this is true, you should consider HQTrivia#me.
+  # Otherwise, this is just a normal user.
+  # @return [true, false] whether the user is actually the owner of the key
+  def authed_user?
+    return true unless @data['hasPhone'].nil?
+
+    false
+  end
+end

data/lib/hqtrivia/user/leaderboard.rb

@@ -0,0 +1,71 @@
+# The User Leaderboard Class. A user's stats.
+class HQTrivia::User::Leaderboard
+  # @param data [JSON] the data.
+  # @!visibility private
+  def initialize(data)
+    @data = data
+  end
+
+  # @return [String] the total earnings
+  def total
+    @data['total']
+  end
+
+  # @return [Integer] the total earnings, in cents.
+  def total_cents
+    @data['totalCents']
+  end
+
+  # @return [String] the amount of unclaimed money!
+  def unclaimed
+    @data['unclaimed']
+  end
+
+  # @return [Integer] the amount of wins on this week's leaderboard
+  def wins
+    @data['wins']
+  end
+
+  # @return [Integer, nil] the rank of this user this week, nil if no rank
+  def rank
+    return nil if @data['rank'] == 101 && @data['wins'] == 0
+
+    @data['rank']
+  end
+
+  # This is only based on HQ Trivia I believe, and sometimes isn't even accurate!
+  # @return [String] the all time total.
+  def alltime_total
+    @data['alltime']['total']
+  end
+
+  # This is only based on HQ Trivia I believe, and sometimes isn't even accurate!
+  # @return [String] the all time win count.
+  def alltime_wins
+    @data['alltime']['wins']
+  end
+
+  # This is only based on HQ Trivia I believe. Most likely accurate based on the information.
+  # @return [String] the all time ranking.
+  def alltime_rank
+    @data['alltime']['rank']
+  end
+
+  # This is only based on HQ Trivia I believe, and sometimes isn't even accurate!
+  # @return [String] the weekly total.
+  def weekly_total
+    @data['weekly']['total']
+  end
+
+  # This is only based on HQ Trivia I believe, and sometimes isn't even accurate!
+  # @return [String] the weekly win count.
+  def weekly_wins
+    @data['weekly']['wins']
+  end
+
+  # This is only based on HQ Trivia I believe. Most likely accurate based on the information.
+  # @return [String] the weekly ranking.
+  def weekly_rank
+    @data['weekly']['rank']
+  end
+end

data/lib/hqtrivia/user/seasonxp.rb

@@ -0,0 +1,68 @@
+# The User SeasonXP Class. A user's season.
+class HQTrivia::User::SeasonXP
+  # @param data [JSON] the data.
+  # @!visibility private
+  def initialize(data)
+    @data = data[0]
+  end
+
+  # @return [Integer] the user's current points
+  def current_points
+    @data['currentPoints']
+  end
+
+  # @return [Integer] the points this user needs to level up
+  def remaining_points
+    @data['remainingPoints']
+  end
+
+  # @return [String] the name of this season
+  def name
+    @data['name']
+  end
+
+  # @return [true, false] if this season is active.
+  def active?
+    @data['active']
+  end
+
+  # General is HQ Trivia, Sports is HQ Sports, Words is HQ Words
+  # @return [Array<String>] what game modes contribute towards the points
+  def participating_gamemodes
+    @data['verticals']
+  end
+
+  # @return [Integer] the current level this user is on.
+  def current_level
+    @data['currentLevel']['level']
+  end
+
+  # The range of the current level.
+  # This is returned as a range.
+  # Do current_level_range.min to find min
+  # Do current_level_range.max to find max
+  # @return [Range] the range of this level
+  def current_level_range
+    Range.new(@data['currentLevel']['minPoints'], @data['currentLevel']['maxPoints'])
+  end
+
+  # @return [Hash<String, String>] the display, as shown in the app.
+  def display
+    @data['display']
+  end
+
+  # @return [Integer] the amount of referrals
+  def referrals
+    @data['quotas']['currentReferrals']
+  end
+
+  # @return [Integer] the amount of shares to facebook
+  def shares_to_facebook
+    @data['quotas']['currentSharesToFacebook']
+  end
+
+  # @return [Integer] the amount of shares to Twitter
+  def shares_to_twitter
+    @data['quotas']['currentSharesToTwitter']
+  end
+end

data/lib/hqtrivia/user/streakinfo.rb

@@ -0,0 +1,43 @@
+# The User StreakInfo Class. A user's streak information.
+class HQTrivia::User::StreakInfo
+  # @param data [JSON] the data.
+  # @!visibility private
+  def initialize(data)
+    @data = data
+  end
+
+  # @return [Integer] the ID of this streak's user.
+  def id
+    @data['userId']
+  end
+
+  # @return [Integer] the target goals (in consecutive days)
+  def target
+    @data['target']
+  end
+
+  # @return [Time] the date this streak started
+  def start_date
+    Time.parse(@data['startDate'])
+  end
+
+  # @return [Integer] the current streak duration
+  def current
+    @data['current']
+  end
+
+  # @return [Integer] the total streak duration
+  def total
+    @data['total']
+  end
+
+  # @return [Time] when this user last played
+  def last_played
+    Time.parse(@data['lastPlayed'])
+  end
+
+  # @return [true, false] if the user should be notified
+  def notify?
+    @data['notify']
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: hqtrivia
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chew
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-23 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.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0.rc1
+description: An HQ Trivia (https://hqtrivia.com) API Wrapper in Ruby
+email: chew@chew.pw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- README.md
+- lib/hqtrivia.rb
+- lib/hqtrivia/badge.rb
+- lib/hqtrivia/badges.rb
+- lib/hqtrivia/errors.rb
+- lib/hqtrivia/generatekey.rb
+- lib/hqtrivia/me.rb
+- lib/hqtrivia/schedule.rb
+- lib/hqtrivia/schedule/announcement.rb
+- lib/hqtrivia/schedule/show.rb
+- lib/hqtrivia/user.rb
+- lib/hqtrivia/user/leaderboard.rb
+- lib/hqtrivia/user/seasonxp.rb
+- lib/hqtrivia/user/streakinfo.rb
+homepage: https://github.com/Chew/HQTriviaRB
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/Chew/HQTriviaRB/issues
+  changelog_uri: https://github.com/Chew/HQTriviaRB/releases
+  homepage_uri: http://github.com/Chew/HQTriviaRB
+  source_code_uri: http://github.com/Chew/HQTriviaRB
+  wiki_uri: http://github.com/Chew/HQTriviaRB/wiki
+  documentation_uri: https://rubydocs.chew.pro/docs/hqtrivia
+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.2
+signing_key: 
+specification_version: 4
+summary: An HQ Trivia API Wrapper in Ruby
+test_files: []