quakelive_api 0.0.1

data/test/quakelive_api/profile/statistics_test.rb

@@ -0,0 +1,75 @@
+require "test_helper"
+
+describe "QuakeliveApi::Profile::Statistics" do
+  make_my_diffs_pretty!()
+
+  describe "black box test for" do
+    before  { stub_stats_request(profile, fixture_statistics(profile)) }
+    subject { QuakeliveApi::Profile::Statistics.new(profile) }
+
+    describe "xsi" do
+      let(:profile) { "xsi" }
+
+      it "fetches proper stats for weapons" do
+        [
+          ['Gauntlet', 185, nil, nil, nil, 1],
+          ['Machinegun', 1232, 29, 64253, 225055, 9],
+          ['Shotgun', 2091, 27, 25180, 91693, 9],
+          ['Grenade Launcher', 241, 10, 1383, 14163, 3],
+          ['Rocket Launcher', 4032, 34, 28182, 83256, 39],
+          ['Lightning Gun', 2048, 28, 84326, 304674, 15],
+          ['Railgun', 2368, 38, 8339, 21946, 19],
+          ['Plasma Gun', 708, 13, 10253, 77655, 5],
+          ['BFG', 4, 49, 26, 53, 0],
+          ['Chaingun', 37, 21, 1111, 5358, 0],
+          ['Nailgun', 18, 13, 466, 3495, 0],
+          ['Proximity Mine', 7, 24, 40, 164, 0]
+        ].each_with_index do |weapon, index|
+          assert_equal subject.weapons[index], QuakeliveApi::Items::Weapon.new(*weapon)
+        end
+      end
+
+      it "fetches proper stats for records" do
+        [
+          ['Clan Arena', 13, 13, 7, 0, 100, 54],
+          ['Capture The Flag', 74, 67, 39, 7, 91, 53],
+          ['Free For All', 31, 27, 10, 4, 87, 32],
+          ['Domination', 16, 16, 11, 0, 100, 69],
+          ['Freeze Tag', 1, 0, 0, 1, 0, 0],
+          ['Team Deathmatch', 155, 142, 79, 13, 92, 51],
+          ['Duel', 532, 503, 210, 29, 95, 39],
+          ['Total', 822, 768, 356, 54, 93, 43]
+        ].each_with_index do |record, index|
+          assert_equal subject.records[index], QuakeliveApi::Items::Record.new(*record)
+        end
+      end
+    end
+
+    describe "emqz" do
+      let(:profile) { "emqz" }
+
+      it "fetches proper stats for weapons" do
+        [
+          ['Gauntlet', 0, nil, nil, nil, 0],
+          ['Machinegun', 0, 0, 0, 0, 0],
+          ['Shotgun', 0, 0, 0, 0, 0],
+          ['Grenade Launcher', 0, 0, 0, 0, 0],
+          ['Rocket Launcher', 0, 0, 0, 0, 0],
+          ['Lightning Gun', 0, 0, 0, 0, 0],
+          ['Railgun', 0, 0, 0, 0, 0],
+          ['Plasma Gun', 0, 0, 0, 0, 0],
+          ['BFG', 0, 0, 0, 0, 0],
+          ['Chaingun', 0, 0, 0, 0, 0],
+          ['Nailgun', 0, 0, 0, 0, 0],
+          ['Proximity Mine', 0, 0, 0, 0, 0]
+        ].each_with_index do |weapon, index|
+          assert_equal subject.weapons[index], QuakeliveApi::Items::Weapon.new(*weapon)
+        end
+      end
+
+      it "fetches proper stats for records" do
+        assert_equal subject.records, nil
+      end
+    end
+  end
+end

data/test/quakelive_api/profile/summary_test.rb

@@ -0,0 +1,97 @@
+require "test_helper"
+
+describe "QuakeliveApi::Profile::Summary" do
+  make_my_diffs_pretty!
+
+  describe "black box test for" do
+    before  { stub_summary_request(profile, fixture_summary(profile)) }
+    subject { QuakeliveApi::Profile::Summary.new(profile) }
+
+    describe "emqz" do
+      let(:profile) { "emqz" }
+
+      its(:country) { must_equal "Poland" }
+      its(:nick)    { must_equal "emqz"}
+      its(:clan)    { must_equal nil }
+
+      its(:model)   { must_equal QuakeliveApi::Items::Model.new(
+        "Major / Default",
+        "http://cdn.quakelive.com/web/2013071600/images/players/body_md/major_default_v2013071600.0.png") }
+
+      its(:member_since)       { must_equal Date.parse('23.06.2013') }
+      its(:last_game)          { must_equal nil }
+      its(:time_played)        { must_equal nil }
+      its(:wins)               { must_equal 0 }
+      its(:losses)             { must_equal 0 }
+      its(:quits)              { must_equal 0 }
+      its(:frags)              { must_equal 0 }
+      its(:deaths)             { must_equal 0 }
+      its(:hits)               { must_equal 0 }
+      its(:shots)              { must_equal 0 }
+      its(:accuracy)           { must_equal 0.0 }
+      its(:favourite)          { must_equal QuakeliveApi::Items::Favourite.new(nil, nil, nil) }
+      its(:recent_awards)      { must_equal nil }
+      its(:recent_games)       { must_equal nil }
+      its(:recent_competitors) { must_equal nil }
+    end
+
+    describe "mariano" do
+      let(:profile){ "mariano" }
+
+      its(:country) { must_equal "Poland" }
+      its(:nick)    { must_equal "Mariano"}
+      its(:clan)    { must_equal nil }
+
+      its(:model)   { must_equal QuakeliveApi::Items::Model.new(
+        "Bitterman / Default",
+        "http://cdn.quakelive.com/web/2013071600/images/players/body_md/bitterman_default_v2013071600.0.png") }
+
+      its(:member_since)  { must_equal Date.parse('7.02.2009') }
+      its(:last_game)     { must_equal Time.parse('11-07-2013 2:59 PM') }
+      its(:time_played)   { must_equal QuakeliveApi::GameTime.new("Ranked Time: 52.19:25:52 Unranked Time: 02:31:02") }
+      its(:wins)          { must_equal 4278 }
+      its(:losses)        { must_equal 3015 }
+      its(:quits)         { must_equal 518 }
+      its(:frags)         { must_equal 97_102 }
+      its(:deaths)        { must_equal 88_381 }
+      its(:hits)          { must_equal 1_960_767 }
+      its(:shots)         { must_equal 6_085_608 }
+      its(:accuracy)      { must_equal 32.22 }
+      its(:favourite)     { must_equal QuakeliveApi::Items::Favourite.new("Furious Heights","Duel","Lightning Gun") }
+      its(:recent_awards) { must_include QuakeliveApi::Items::Award.new(
+        'http://cdn.quakelive.com/web/2013071600/images/awards/md/team_killer_v2013071600.0.png',
+        'Hope you touched the flag first!',
+        'Team Killer',
+        'Awarded 2 months ago',
+        'Kill all players on the opposing team in a single round in Attack & Defend, minimum size 3.') }
+
+      its(:recent_awards)      { must_include QuakeliveApi::Items::Award.new(
+        'http://cdn.quakelive.com/web/2013071600/images/awards/md/pql_1_v2013071600.0.png',
+        'Do you think thats air youre breathing now?',
+        'Too Fast',
+        'Awarded 2 months ago',
+        'Complete 1 online PQL match.') }
+
+      its(:recent_games) { must_be_instance_of Array }
+      its(:recent_games) { wont_include nil }
+      its(:recent_games) { must_include QuakeliveApi::Items::RecentGame.new(
+        'TDM',
+        'Loss',
+        '20 days ago',
+        'http://cdn.quakelive.com/web/2013071600/images/levelshots/lg/hiddenfortress_v2013071600.0.jpg')
+      }
+
+      its(:recent_competitors) { wont_include nil }
+      its(:recent_competitors) { must_be_instance_of Array }
+      its(:recent_competitors) { must_include QuakeliveApi::Items::Competitor.new(
+        'http://cdn.quakelive.com/web/2013071600/images/players/icon_lg/bitterman_red_v2013071600.0.png',
+        'Jeezy',
+        Time.parse('2013-07-11 14:59:00'))}
+    end
+  end
+end
+
+
+
+
+

data/test/quakelive_api/profile_test.rb

@@ -0,0 +1,67 @@
+require "test_helper"
+
+describe "QuakeliveApi::Profile" do
+
+  describe "on error" do
+    it "raises an exception on non existing profiles" do
+      stub_summary_request "not-here", fixture_profile("not_found")
+      profile = QuakeliveApi::Profile.new('not-here')
+      assert_raises(QuakeliveApi::Error::PlayerNotFound) { profile.summary }
+    end
+
+    it "raises an exception on request error response from ql" do
+      stub_summary_request "error-profile", fixture_profile("error")
+      profile = QuakeliveApi::Profile.new('error-profile')
+      assert_raises(QuakeliveApi::Error::RequestError) { profile.summary }
+    end
+  end
+
+  describe "on success" do
+    it "returns an instance of summary class on 'summary' call" do
+      stub_summary_request "all-good", fixture_summary("emqz")
+      profile = QuakeliveApi::Profile.new('all-good')
+      assert_instance_of QuakeliveApi::Profile::Summary, profile.summary
+    end
+
+    it "returns an instance of statistics class on 'statistics' call" do
+      stub_stats_request "stats-test", fixture_statistics("xsi")
+      profile = QuakeliveApi::Profile.new('stats-test')
+      assert_instance_of QuakeliveApi::Profile::Statistics, profile.statistics
+    end
+
+    it "returns an instance of career milestones class on 'awards_milestones' call" do
+      profile = QuakeliveApi::Profile.new('awards-test')
+      stub_request(:get, "http://www.quakelive.com/profile/awards/awards-test/3")
+      assert_instance_of QuakeliveApi::Profile::Awards::CareerMilestones, profile.awards_milestones
+    end
+
+    it "returns an instance of experience class on 'awards_experience' call" do
+      profile = QuakeliveApi::Profile.new('awards-test')
+      stub_request(:get, "http://www.quakelive.com/profile/awards/awards-test/1")
+      assert_instance_of QuakeliveApi::Profile::Awards::Experience, profile.awards_experience
+    end
+
+    it "returns an instance of mad skillz class on 'awards_skillz' call" do
+      profile = QuakeliveApi::Profile.new('awards-test')
+      stub_request(:get, "http://www.quakelive.com/profile/awards/awards-test/2")
+      assert_instance_of QuakeliveApi::Profile::Awards::MadSkillz, profile.awards_skillz
+    end
+
+    it "returns an instance of social life class on 'awards_social' call" do
+      profile = QuakeliveApi::Profile.new('awards-test')
+      stub_request(:get, "http://www.quakelive.com/profile/awards/awards-test/5")
+      assert_instance_of QuakeliveApi::Profile::Awards::SocialLife, profile.awards_social
+    end
+
+    it "returns an instance of sweet success class on 'awards_success' call" do
+      profile = QuakeliveApi::Profile.new('awards-test')
+      stub_request(:get, "http://www.quakelive.com/profile/awards/awards-test/4")
+      assert_instance_of QuakeliveApi::Profile::Awards::SweetSuccess, profile.awards_success
+    end
+
+    it "responds to each_award" do
+      profile = QuakeliveApi::Profile.new('awards-test')
+      assert_respond_to(profile, :each_award)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,47 @@
+require 'simplecov'
+SimpleCov.start
+require "minitest/autorun"
+require "webmock/minitest"
+
+require "#{File.dirname(__FILE__)}/../lib/quakelive_api"
+
+def fixtures_path
+  "#{File.dirname(__FILE__)}/fixtures"
+end
+
+def fixture_profile(name)
+  File.read "#{fixtures_path}/profile/#{name}.txt"
+end
+
+def fixture_summary(name)
+  File.read "#{fixtures_path}/summary/#{name}.txt"
+end
+
+def fixture_statistics(name)
+  File.read "#{fixtures_path}/statistics/#{name}.txt"
+end
+
+def fixture_awards(name)
+  File.read "#{fixtures_path}/awards/#{name}.txt"
+end
+
+def stub_summary_request(profile_name, content)
+  stub_request(:get, "#{QuakeliveApi.site}/profile/summary/#{profile_name}").to_return(content)
+end
+
+def stub_stats_request(profile_name, content)
+  stub_request(:get, "#{QuakeliveApi.site}/profile/statistics/#{profile_name}").to_return(content)
+end
+
+# taken from its-minitest gem, as I'm used to rspec syntax (and it's quite convenient for blackbox testing)
+class MiniTest::Spec
+  def self.its attribute, &block
+    describe "verify subject.#{attribute} for" do
+      let(:inner_subject) { subject.send(attribute) }
+
+      it "verify subject.#{attribute} for" do
+        inner_subject.instance_eval &block
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: quakelive_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rafal Wojsznis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0.pre
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0.pre
+description: Pseudo API for QuakeLive
+email:
+- rafal.wojsznis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quakelive_api.rb
+- lib/quakelive_api/base.rb
+- lib/quakelive_api/error/player_not_found.rb
+- lib/quakelive_api/error/request_error.rb
+- lib/quakelive_api/game_time.rb
+- lib/quakelive_api/items/award.rb
+- lib/quakelive_api/items/competitor.rb
+- lib/quakelive_api/items/favourite.rb
+- lib/quakelive_api/items/model.rb
+- lib/quakelive_api/items/recent_game.rb
+- lib/quakelive_api/items/record.rb
+- lib/quakelive_api/items/structurable.rb
+- lib/quakelive_api/items/weapon.rb
+- lib/quakelive_api/parser/awards.rb
+- lib/quakelive_api/parser/base.rb
+- lib/quakelive_api/parser/statistics.rb
+- lib/quakelive_api/parser/summary.rb
+- lib/quakelive_api/profile.rb
+- lib/quakelive_api/profile/awards/base.rb
+- lib/quakelive_api/profile/awards/career_milestones.rb
+- lib/quakelive_api/profile/awards/experience.rb
+- lib/quakelive_api/profile/awards/mad_skillz.rb
+- lib/quakelive_api/profile/awards/social_life.rb
+- lib/quakelive_api/profile/awards/sweet_success.rb
+- lib/quakelive_api/profile/statistics.rb
+- lib/quakelive_api/profile/summary.rb
+- lib/quakelive_api/version.rb
+- quakelive_api.gemspec
+- test/fixtures/awards/career.txt
+- test/fixtures/awards/experience.txt
+- test/fixtures/awards/mad_skillz.txt
+- test/fixtures/awards/social_life.txt
+- test/fixtures/awards/sweet_success.txt
+- test/fixtures/profile/error.txt
+- test/fixtures/profile/not_found.txt
+- test/fixtures/profile/summary.txt
+- test/fixtures/statistics/emqz.txt
+- test/fixtures/statistics/xsi.txt
+- test/fixtures/summary/emqz.txt
+- test/fixtures/summary/mariano.txt
+- test/quakelive_api/game_time_test.rb
+- test/quakelive_api/profile/awards/career_milestones_test.rb
+- test/quakelive_api/profile/awards/experience_test.rb
+- test/quakelive_api/profile/awards/mad_skillz_test.rb
+- test/quakelive_api/profile/awards/social_life_test.rb
+- test/quakelive_api/profile/awards/sweet_success_test.rb
+- test/quakelive_api/profile/statistics_test.rb
+- test/quakelive_api/profile/summary_test.rb
+- test/quakelive_api/profile_test.rb
+- test/test_helper.rb
+homepage: https://github.com/emq/quakelive_api
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Fetch some basic information from QuakeLive site
+test_files:
+- test/fixtures/awards/career.txt
+- test/fixtures/awards/experience.txt
+- test/fixtures/awards/mad_skillz.txt
+- test/fixtures/awards/social_life.txt
+- test/fixtures/awards/sweet_success.txt
+- test/fixtures/profile/error.txt
+- test/fixtures/profile/not_found.txt
+- test/fixtures/profile/summary.txt
+- test/fixtures/statistics/emqz.txt
+- test/fixtures/statistics/xsi.txt
+- test/fixtures/summary/emqz.txt
+- test/fixtures/summary/mariano.txt
+- test/quakelive_api/game_time_test.rb
+- test/quakelive_api/profile/awards/career_milestones_test.rb
+- test/quakelive_api/profile/awards/experience_test.rb
+- test/quakelive_api/profile/awards/mad_skillz_test.rb
+- test/quakelive_api/profile/awards/social_life_test.rb
+- test/quakelive_api/profile/awards/sweet_success_test.rb
+- test/quakelive_api/profile/statistics_test.rb
+- test/quakelive_api/profile/summary_test.rb
+- test/quakelive_api/profile_test.rb
+- test/test_helper.rb