triviacrack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac03c72d98815202ea81c52004831d9110177381
+  data.tar.gz: fcb7b96af0d10e97e4fa1410dbb70d6b3da2f5f8
+SHA512:
+  metadata.gz: 8cad6503fb7126a1ac00ebd716b54c2ad6c14432d405f4bcf7600dea9064755d0d69d7a4484ac5de5dbf77512a6eb7181672a4b57e60d6cdda4e636789445df7
+  data.tar.gz: 72abb5306d502187d8ada14bb9b218cefc747120f4815f6deb25c05b8871a85d52ec10190e43050de26a33829f96b1581c855919857c52a7c7d3e890178e34e0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+
+rvm:
+- 2.4.1
+
+env:
+  global:
+  - secure: FBRKEwZitjHKzgrugvvp8RbI6CJvAhChsHiI5NfbD9SIjogfmw38Qj503PvPw1h5hrYtrgeLmgFrve/ridbDDLxhN3voGyZ5ugsPmb5vITRtAi2WTI0b8ylrvKOuf/TsyPoENZ7LzLCbblJpJtREgU8UGosEe3BhZ/h6sy/T07Q=
+
+before_script:
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- "./cc-test-reporter before-build"
+
+script:
+- bundle exec rspec
+
+after_script:
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"

data/Gemfile

@@ -0,0 +1,7 @@
+#ruby=ruby-2.4.1
+#ruby-gemset=triviacrack
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in triviacrack.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 David Kus
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# Triviacrack [![Build Status](https://travis-ci.org/davidkus/triviacrack.svg?branch=master)](https://travis-ci.org/davidkus/triviacrack) [![Code Climate](https://codeclimate.com/github/davidkus/triviacrack/badges/gpa.svg)](https://codeclimate.com/github/davidkus/triviacrack) [![Test Coverage](https://codeclimate.com/github/davidkus/triviacrack/badges/coverage.svg)](https://codeclimate.com/github/davidkus/triviacrack)
+
+A Ruby interface for the Trivia Crack API.
+
+The Trivia Crack iOS app uses an undocumented API to store / retrieve
+information about the game state. This Ruby library wraps that API and presents
+it in a clean, documented way.
+
+*Disclaimer*: The Trivia Crack API is undocumented and subject to change at any
+time. Changes in the API _may_ break this library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "triviacrack", github: "davidkus/triviacrack"
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+First, create an instance of the `TriviaCrack::API::Client`.
+
+```ruby
+require "triviacrack"
+
+client = TriviaCrack::API::Client.new
+```
+
+### Logging In
+
+Use the client to log in using your Trivia Crack email and password.
+
+```ruby
+client.login "user@example.com", "password123"
+```
+
+### User Information
+
+You can retrieve information about the currently logged in user.
+
+```ruby
+user = client.get_user
+
+puts "Hello, #{user.username}!"
+ # => Hello, david!
+```
+
+You can also retrieve the user ID of the user with a given username.
+
+```ruby
+user_id = client.get_user_id "david"
+
+puts "david's user id is #{user_id}"
+ # => david's user id is 1
+```
+
+### User Profiles
+
+You can retrieve additional information about a user by fetching their profile.
+
+```ruby
+user_id = 123
+profile = client.get_profile user_id
+```
+
+A user's profile contains their statistics (number of wins / losses, number of
+questions answered correctly, etc), among other things.
+
+### Game Information
+
+You can retrieve the list of games available to the currently logged in user.
+
+```ruby
+games = client.get_games
+```
+
+You can retrieve game information for a specific game (by id).
+
+```ruby
+game = client.get_game 1
+```
+
+You can also start a new game.
+
+```ruby
+game = client.start_new_game
+```
+
+The TriviaCrack::Game object holds information about the opponent, statistics,
+and current questions available to be answered.
+
+### Answering Questions
+
+It is possible to answer questions using the Trivia Crack API.
+
+```ruby
+game = client.get_game 1
+
+client.answer_question game.id, game.question.first, 0
+```
+
+The `answer_question` also returns an updated `TriviaCrack::Game` object, so you
+can avoid making additional API calls to keep the game object up to date.
+
+```ruby
+game = client.answer_question game.id, game.question.first, 0
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/davidkus/triviacrack/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/lib/triviacrack.rb

@@ -0,0 +1,12 @@
+require "triviacrack/category_statistics"
+require "triviacrack/game"
+require "triviacrack/game_statistics"
+require "triviacrack/profile"
+require "triviacrack/question"
+require "triviacrack/user"
+require "triviacrack/version"
+
+require "triviacrack/api/client"
+
+require "triviacrack/errors/parse_error"
+require "triviacrack/errors/request_error"

data/lib/triviacrack/api/client.rb

@@ -0,0 +1,31 @@
+require "triviacrack/api/game"
+require "triviacrack/api/login"
+require "triviacrack/api/profile"
+require "triviacrack/api/question"
+require "triviacrack/api/user"
+
+# Public: Interface for interacting with the Trivia Crack API.
+module TriviaCrack
+  module API
+    class Client
+
+      include TriviaCrack::API::Game
+      include TriviaCrack::API::Login
+      include TriviaCrack::API::User
+      include TriviaCrack::API::Question
+      include TriviaCrack::API::Profile
+
+      # Public: Creates a new TriviaCrack::Session object using the given
+      # session_id and user_id and assigns that session to this
+      # TriviaCrack::API::Client.
+      #
+      # session_id - The Trivia Crack session ID.
+      # user_id    - The Trivia Crack user ID.
+      def set_session(session_id, user_id)
+        @session = TriviaCrack::Session.new session_id: session_id,
+                                            user_id: user_id
+      end
+
+    end
+  end
+end

data/lib/triviacrack/api/common.rb

@@ -0,0 +1,76 @@
+require "unirest"
+
+require "triviacrack/errors/request_error"
+
+# Internal: Common methods used for the Trivia Crack API.
+module TriviaCrack
+  module API
+    module Common
+
+      # Internal: Makes a GET request to the Trivia Crack API using the set of
+      # default headers.
+      #
+      # url        - The URL of the TriviaCrack API resource.
+      # parameters - The parameters to send with the request.
+      #
+      # Returns a Unirest Response object with the server's response.
+      # Raises TriviaCrack:Errors::RequestError if the request fails.
+      def get(url, parameters: nil)
+        response = Unirest.get "#{API_HOST}#{url}", parameters: parameters,
+                                                    headers: default_headers
+
+        check_response response
+      end
+
+      # Internal: Makes a POST request to the Trivia Crack API using the set of
+      # default headers.
+      #
+      # url        - The URL of the TriviaCrack API resource.
+      # parameters - The parameters to send with the request.
+      #
+      # Returns a Unirest Response object with the server's response.
+      # Raises TriviaCrack:Errors::RequestError if the request fails.
+      def post(url, parameters: nil)
+        response = Unirest.post "#{API_HOST}#{url}", parameters: parameters,
+                                                     headers: default_headers
+
+        check_response response
+      end
+
+      private
+
+      # Internal: The host name of the Trivia Crack API.
+      API_HOST = "https://api.preguntados.com"
+
+      # Internal: Constructs the set of headers needed to make requests to the
+      # Trivia Crack API.
+      #
+      # Returns a hash of headers.
+      def default_headers
+        headers = { "Content-Type": "application/json; charset=utf-8" }
+
+        if @session
+          headers["Cookie"] = "ap_session=#{@session.session_id}"
+        end
+
+        headers
+      end
+
+      # Internal: Checks the response's code to see if the request was
+      # successful
+      #
+      # response - Unirest response returned by the API.
+      #
+      # Returns the response object.
+      # Raises TriviaCrack:Errors::RequestError if the request failed.
+      def check_response(response)
+        if not response.code.between? 200, 299
+          raise TriviaCrack::Errors::RequestError.new(response.code),
+            "Request to the Trivia Crack API failed."
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/triviacrack/api/game.rb

@@ -0,0 +1,72 @@
+require "triviacrack/api/common"
+require "triviacrack/parsers/game_parser"
+
+# Public: All methods in this module make requests to the Trivia Crack games
+# API.
+module TriviaCrack
+  module API
+    module Game
+
+      include TriviaCrack::API::Common
+
+      # Public: Uses the Trivia Crack API to fetch the list of games for the
+      # current user.
+      #
+      # Examples
+      #
+      #   get_games
+      #
+      # Returns a list of TriviaCrack::Game.
+      # Raises TriviaCrack:Errors::RequestError if the request fails.
+      def get_games
+        response = get "/api/users/#{@session.user_id}/dashboard"
+
+        games_data = response.body["list"]
+
+        games = []
+        if games_data
+          games_data.each do |game_data|
+            game = TriviaCrack::Parsers::GameParser.parse game_data
+            games << game
+          end
+        end
+
+        games
+      end
+
+      # Public: Uses the Trivia Crack API to fetch the information for the given
+      # game.
+      #
+      # game_id  - The id of a Trivia Crack game.
+      #
+      # Examples
+      #
+      #   get_game 123
+      #
+      # Returns the TriviaCrack::Game for the given game_id.
+      # Raises TriviaCrack:Errors::RequestError if the request fails.
+      def get_game(game_id)
+        response = get "/api/users/#{@session.user_id}/games/#{game_id}"
+
+        TriviaCrack::Parsers::GameParser.parse response.body
+      end
+
+      # Public: Uses the Trivia Crack API to start a new game for the current
+      # user.
+      #
+      # Examples
+      #
+      #   client.start_new_game
+      #
+      # Returns the TriviaCrack::Game that was started.
+      # Raises TriviaCrack::Errors::RequestError if the request fails
+      def start_new_game
+        response = post "/api/users/#{@session.user_id}/games",
+                        parameters: { language: "EN" }.to_json
+
+        TriviaCrack::Parsers::GameParser.parse response.body
+      end
+
+    end
+  end
+end

data/lib/triviacrack/api/login.rb

@@ -0,0 +1,35 @@
+require "triviacrack/api/common"
+require "triviacrack/parsers/session_parser"
+
+# Public: All methods in this module make requests to the Trivia Crack login
+# API.
+module TriviaCrack
+  module API
+    module Login
+
+      include TriviaCrack::API::Common
+
+      # Public: Uses the given email and password to log in to Trivia Crack
+      # and retrieve a session id and user id.
+      #
+      # email     - Email of a Trivia Crack user.
+      # password  - Password of a Trivia Crack user.
+      #
+      # Examples
+      #
+      #   login "user@example.com", "password123"
+      #
+      # Returns the user_id and username of the user that has logged in.
+      # Raises TriviaCrack::Errors::RequestError if the request fails.
+      def login(email, password)
+        response = post "/api/login", parameters: { email: email,
+                                                    password: password,
+                                                    language: "en"
+                                                  }.to_json
+
+        @session = TriviaCrack::Parsers::SessionParser.parse response.body
+      end
+
+    end
+  end
+end

data/lib/triviacrack/api/profile.rb

@@ -0,0 +1,44 @@
+require "triviacrack/api/common"
+
+# Public: Interface to the Trivia Crack Profile API.
+module TriviaCrack
+  module API
+    module Profile
+
+      include TriviaCrack::API::Common
+
+      # Public: Uses the Trivia Crack API to get the profile of the user with
+      # the given user id.
+      #
+      # user_id  - The unique identifier of the user.
+      #
+      # Examples
+      #
+      #   profile = client.get_profile 123
+      #
+      # Returns the TriviaCrack::Profile for the given user.
+      # Raises TriviaCrack::Errors::RequestError if the request fails.
+      def get_profile(user_id)
+        response = get "/api/users/#{@session.user_id}/profiles/#{user_id}"
+
+        TriviaCrack::Parsers::ProfileParser.parse response.body
+      end
+
+      # Public: Uses the Trivia Crack API to get the profile of current user.
+      #
+      # Examples
+      #
+      #   profile = client.get_my_profile
+      #
+      # Returns the TriviaCrack::Profile for the current user.
+      # Raises TriviaCrack::Errors::RequestError if the request fails.
+      def get_my_profile
+        response =
+          get "/api/users/#{@session.user_id}/profiles/#{@session.user_id}"
+
+        TriviaCrack::Parsers::ProfileParser.parse response.body
+      end
+
+    end
+  end
+end