triviacrack 0.1.0

data/lib/triviacrack/parsers/profile_parser.rb

@@ -0,0 +1,55 @@
+require "triviacrack/profile"
+require "triviacrack/parsers/category_statistics_parser"
+require "triviacrack/parsers/time_parser"
+
+# Internal: This module is used to parse data returned from the Trivia Crack API
+# into a ruby object that represents a Trivia Crack user profile.
+module TriviaCrack
+  module Parsers
+    module ProfileParser
+
+      # Internal: Parses data returned from the Trivia Crack API to create a
+      # TriviaCrack::Profile object.
+      #
+      # raw_data - A hash of the raw data returned by the Trivia Crack API.
+      #
+      # Examples
+      #
+      #   raw_data = get_raw_data_from_API
+      #   ...
+      #   profile = TriviaCrack::Parsers::ProfileParser.parse raw_data
+      #
+      # Returns a TriviaCrack::Profile.
+      def self.parse(raw_data)
+        stats = raw_data["statistics"]
+        versus = raw_data["versus"]
+
+        categories = CategoryStatisticsParser.parse stats["category_questions"]
+
+        TriviaCrack::Profile.new(
+          id: raw_data["id"],
+          facebook_name: raw_data["facebook_name"],
+          is_friend: raw_data["is_friend"],
+          is_blocked: raw_data["is_blocked"],
+          username: raw_data["username"],
+          country: raw_data["country"].downcase.to_sym,
+          email: raw_data["email"],
+          last_play: TimeParser.parse(raw_data["last_play_date"]),
+          last_login: TimeParser.parse(raw_data["last_log"]),
+          games_won: stats["games_won"],
+          games_lost: stats["games_lost"],
+          games_resigned: stats["games_resigned"],
+          consecutive_games_won: stats["consecutive_games_won"],
+          consecutive_answers_correct: stats["consecutive_answers_correct"],
+          level: raw_data["level_data"]["level"],
+          challenges_won: stats["challenges"]["won"],
+          challenges_lost: stats["challenges"]["lost"],
+          categories: categories,
+          my_wins_vs_user: versus ? versus["won"] : nil,
+          my_losses_vs_user: versus ? versus["lost"] : nil
+        )
+      end
+
+    end
+  end
+end

data/lib/triviacrack/parsers/question_parser.rb

@@ -0,0 +1,36 @@
+require "triviacrack/question"
+
+# Internal: This module is used to parse data returned from the Trivia Crack API
+# into a ruby object that represents a Trivia Crack question.
+module TriviaCrack
+  module Parsers
+    module QuestionParser
+
+      # Internal: Parses data returned from the Trivia Crack API to create a
+      # TriviaCrack::Question object.
+      #
+      # raw_data  - A hash of the raw data returned by the Trivia Crack API.
+      #
+      # Examples
+      #
+      #   raw_data = get_raw_data_from_API
+      #   ...
+      #   question = TriviaCrack::Parsers::QuestionParser.parse raw_data
+      #
+      # Returns a TriviaCrack::Question.
+      def self.parse(raw_data)
+        TriviaCrack::Question.new(
+          id: raw_data["id"],
+          type: raw_data["type"].downcase.to_sym,
+          category: raw_data["category"].downcase.to_sym,
+          text: raw_data["text"],
+          answers: raw_data["answers"],
+          correct_answer: raw_data["correct_answer"],
+          media_type: raw_data["media_type"].downcase.to_sym,
+          image_url: raw_data["base_url"]
+        )
+      end
+
+    end
+  end
+end

data/lib/triviacrack/parsers/session_parser.rb

@@ -0,0 +1,36 @@
+require "triviacrack/session"
+require "triviacrack/parsers/time_parser"
+
+# Internal: This module is used to parse data returned from the Trivia Crack API
+# into a ruby object that represents a Trivia Crack session.
+module TriviaCrack
+  module Parsers
+    module SessionParser
+
+      # Internal: Parses data returned from the Trivia Crack API to create a
+      # TriviaCrack::Session object.
+      #
+      # raw_data  - A hash of the raw data returned by the Trivia Crack API.
+      #
+      # Examples
+      #
+      #   raw_data = get_raw_data_from_API
+      #   ...
+      #   session = TriviaCrack::Parsers::SessionParser.parse raw_data
+      #
+      # Returns a TriviaCrack::Session.
+      def self.parse(raw_data)
+        expiration = TimeParser.parse raw_data["session"]["expirationTime"]
+
+        TriviaCrack::Session.new(
+          session_id: raw_data["session"]["session"],
+          user_id: raw_data["id"],
+          username: raw_data["username"],
+          device_key: raw_data["session"]["deviceKey"],
+          expiration: expiration
+        )
+      end
+
+    end
+  end
+end

data/lib/triviacrack/parsers/time_parser.rb

@@ -0,0 +1,26 @@
+require "time"
+
+# Internal: This module is used to parse date_time strings returned by the
+# Trivia Crack API.
+module TriviaCrack
+  module Parsers
+    module TimeParser
+
+      TIME_FORMAT = "%m/%d/%Y %H:%M:%S"
+
+      # Internal: Parses a date_time string returned by the Trivia Crack API.
+      #
+      # raw_data - The date_time string.
+      #
+      # Examples
+      #
+      #   TriviaCrack::Parsers::TimeParser.parse "02/17/2015 21:47:19 EST"
+      #
+      # Returns a Time object representation of the given string.
+      def self.parse(raw_data)
+        Time.strptime(raw_data, TIME_FORMAT)
+      end
+
+    end
+  end
+end

data/lib/triviacrack/parsers/user_parser.rb

@@ -0,0 +1,47 @@
+require "triviacrack/user"
+
+# Internal: This module is used to parse data returned from the Trivia Crack API
+# into a ruby object that represents a Trivia Crack user.
+module TriviaCrack
+  module Parsers
+    module UserParser
+
+      # Internal: Parses data returned from the Trivia Crack API to create a
+      # TriviaCrack::User object.
+      #
+      # raw_data  - A hash of the raw data returned by the Trivia Crack API.
+      #
+      # Examples
+      #
+      #   raw_data = get_raw_data_from_API
+      #   ...
+      #   user = TriviaCrack::Parsers::UserParser.parse raw_data
+      #
+      # Returns a TriviaCrack::User.
+      def self.parse(raw_data)
+        lives = raw_data["lives"]
+        level_data = raw_data["level_data"]
+        country = raw_data["country"]
+
+        TriviaCrack::User.new(
+          id: raw_data["id"],
+          username: raw_data["username"],
+          facebook_id: raw_data["facebook_id"],
+          facebook_name: raw_data["facebook_name"],
+          coins: raw_data["coins"],
+          lives: lives ? lives["quantity"] : nil,
+          max_lives: lives ? lives["max"] : nil,
+          unlimited_lives: lives ? lives["unlimited"] : nil,
+          country: country ? country.downcase.to_sym : nil,
+          extra_shots: raw_data["extra_shots"],
+          level: level_data ? level_data["level"] : nil,
+          level_points: level_data ? level_data["points"] : nil,
+          level_progress: level_data ? level_data["progress"] : nil,
+          goal_points: level_data ? level_data["goal_points"] : nil,
+          level_up: level_data ? level_data["level_up"] : nil
+        )
+      end
+
+    end
+  end
+end

data/lib/triviacrack/profile.rb

@@ -0,0 +1,96 @@
+# Public: An object containing the Trivia Crack profile information of a user.
+module TriviaCrack
+  class Profile
+
+    # Public: The unique identifier of the user.
+    attr_reader :id
+
+    # Public: The user's Facebook name.
+    attr_reader :facebook_name
+
+    # Public: Boolean indicating whether the user is your friend.
+    attr_reader :is_friend
+
+    # Public: Boolean indicating whether you have blocked the user.
+    attr_reader :is_blocked
+
+    # Public: The user's username.
+    attr_reader :username
+
+    # Public: The user's country (e.g. :ca, :us).
+    attr_reader :country
+
+    # Public: The user's email address.
+    attr_reader :email
+
+    # Public: The datetime of the user's last play.
+    attr_reader :last_play
+
+    # Public: The datetime of the user's last login.
+    attr_reader :last_login
+
+    # Public: Number of games won by the user.
+    attr_reader :games_won
+
+    # Public: Number of games lost by the user.
+    attr_reader :games_lost
+
+    # Public: Number of games resigned by the user.
+    attr_reader :games_resigned
+
+    # Public: Number of consecutive games won by the user.
+    attr_reader :consecutive_games_won
+
+    # Public: Number of consecutive correctly answered questions by the user.
+    attr_reader :consecutive_answers_correct
+
+    # Public: The user's level.
+    attr_reader :level
+
+    # Public: Number of challenges won by the user.
+    attr_reader :challenges_won
+
+    # Public: Number of challenges lost by the user.
+    attr_reader :challenges_lost
+
+    # Public: A hash of TriviaCrack::CategoryStatistics, containing the user's
+    # statistics for individual categories.
+    attr_reader :categories
+
+    # Public: Number of games won against the requesting user.
+    attr_reader :my_wins_vs_user
+
+    # Public: Number of games lost against the requesting user.
+    attr_reader :my_losses_vs_user
+
+    def initialize(id: nil, facebook_name: nil, is_friend: nil, is_blocked: nil,
+                   username: nil, country: nil, email: nil, last_play: nil,
+                   last_login: nil, games_won: nil, games_lost: nil,
+                   games_resigned: nil, consecutive_games_won: nil,
+                   consecutive_answers_correct: nil, level: nil,
+                   challenges_won: nil, challenges_lost: nil, categories: nil,
+                   my_wins_vs_user: nil, my_losses_vs_user: nil)
+      @id                           = id
+      @facebook_name                = facebook_name
+      @is_friend                    = is_friend
+      @is_blocked                   = is_blocked
+      @username                     = username
+      @country                      = country
+      @email                        = email
+      @last_play                    = last_play
+      @last_login                   = last_login
+      @games_won                    = games_won
+      @games_lost                   = games_lost
+      @games_resigned               = games_resigned
+      @consecutive_games_won        = consecutive_games_won
+      @consecutive_answers_correct  = consecutive_answers_correct
+      @level                        = level
+      @challenges_won               = challenges_won
+      @challenges_lost              = challenges_lost
+      @categories                   = categories
+      @my_wins_vs_user              = my_wins_vs_user
+      @my_losses_vs_user            = my_losses_vs_user
+    end
+
+  end
+end

data/lib/triviacrack/question.rb

@@ -0,0 +1,43 @@
+# Public: An object representing a Trivia Crack Question, including the list of
+# available answers as well as the correct answer.
+module TriviaCrack
+  class Question
+
+    # Public: The unique identifier of the question.
+    attr_reader :id
+
+    # Public: The type of the question (e.g. :normal, :crown, :duel).
+    attr_reader :type
+
+    # Public: The category of the question (e.g. :arts, :geography, etc).
+    attr_reader :category
+
+    # Public: The question text.
+    attr_reader :text
+
+    # Public: The list of possible answers to the question.
+    attr_reader :answers
+
+    # Public: The index of the correct answer (based on the :answers property).
+    attr_reader :correct_answer
+
+    # Public: The type of media used by the question (e.g. :normal, :image).
+    attr_reader :media_type
+
+    # Public: The URL for the image.
+    attr_reader :image_url
+
+    def initialize(id:, type: nil, category: nil, text: nil, answers: nil,
+                   correct_answer: nil, media_type: nil, image_url: nil)
+      @id             = id
+      @type           = type
+      @category       = category
+      @text           = text
+      @answers        = answers
+      @correct_answer = correct_answer
+      @media_type     = media_type
+      @image_url      = image_url
+    end
+
+  end
+end

data/lib/triviacrack/session.rb

@@ -0,0 +1,30 @@
+# Public: An object representing a Trivia Crack Session.
+module TriviaCrack
+  class Session
+
+    # Public: The session id.
+    attr_reader :session_id
+
+    # Public: The id of the User associated with this session.
+    attr_reader :user_id
+
+    # Public: The username of the User associated with this session.
+    attr_reader :username
+
+    # Public: The device key.
+    attr_reader :device_key
+
+    # Public: The time at which the session will expire.
+    attr_reader :expiration
+
+    def initialize(session_id:, user_id: nil, username: nil, device_key: nil,
+                   expiration: nil)
+      @session_id     = session_id
+      @user_id        = user_id
+      @username       = username
+      @device_key     = device_key
+      @expiration     = expiration
+    end
+
+  end
+end

data/lib/triviacrack/user.rb

@@ -0,0 +1,91 @@
+# Public: An object representing a Trivia Crack User, including information
+# about the user's level, lives and coins.
+module TriviaCrack
+  class User
+
+    # Public: The unique identifier of the user.
+    attr_reader :id
+
+    # Public: The unique username of the user.
+    attr_reader :username
+
+    # Public: The Facebook ID of the user (nil if the user has not linked their
+    # Facebook account).
+    attr_reader :facebook_id
+
+    # Public: The Facebook name of the user (nil if the user has not linked
+    # their Facebook account).
+    attr_reader :facebook_name
+
+    # Public: The amount of coins that the user has accumulated.
+    attr_reader :coins
+
+    # Public: The amount of lives available to the user.
+    attr_reader :lives
+
+    # Public: The maximum number of lives that the user can have.
+    attr_reader :max_lives
+
+    # Public: Boolean indicating whether the user has unlimited lives.
+    attr_reader :unlimited_lives
+
+    # Public: The country code of the user's country.
+    attr_reader :country
+
+    # Public: The number of extra shots available to the user.
+    attr_reader :extra_shots
+
+    # Public: The user's level.
+    attr_reader :level
+
+    # Public: The experience points that the user has accumulated towards their
+    # next level.
+    attr_reader :level_points
+
+    # Public: The percentage progress towards the next level.
+    attr_reader :level_progress
+
+    # Public: The user's goal points.
+    attr_reader :goal_points
+
+    # Public: Boolean indicating whether the user has leveled up.
+    attr_reader :level_up
+
+    def initialize(id:, username: nil, facebook_id: nil, facebook_name: nil,
+                   coins: nil, lives: nil, max_lives: nil, unlimited_lives: nil,
+                   country: nil, extra_shots: nil, level: nil,
+                   level_points: nil, level_progress: nil, goal_points: nil,
+                   level_up: nil)
+      @id               = id
+      @username         = username
+      @facebook_id      = facebook_id
+      @facebook_name    = facebook_name
+      @coins            = coins
+      @lives            = lives
+      @max_lives        = max_lives
+      @unlimited_lives  = unlimited_lives
+      @country          = country
+      @extra_shots      = extra_shots
+      @level            = level
+      @level_points     = level_points
+      @level_progress   = level_progress
+      @goal_points      = goal_points
+      @level_up         = level_up
+    end
+
+    # Public: Returns true if the user has one or more lives, or has unlimited
+    # lives.
+    #
+    # Examples
+    #
+    #   if user.start_new_game?
+    #      ... start a new game ...
+    #   end
+    #
+    # Returns true if the user can start a new game, false otherwise.
+    def start_new_game?
+      @lives >= 1 || @unlimited_lives
+    end
+
+  end
+end