starcraft2 0.0.3 → 0.0.4

data/fixtures/vcr_cassettes/previous_grandmaster.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://us.battle.net/api/sc2/ladder/grandmaster/last
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 14 Aug 2013 03:31:06 GMT
+      Server:
+      - Apache
+      X-Frame-Options:
+      - SAMEORIGIN
+      Content-Language:
+      - en-US
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json;charset=UTF-8
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "status" : "nok",
+          "code" : 500,
+          "message" : "Internal Server Error"
+        }
+    http_version: 
+  recorded_at: Wed, 14 Aug 2013 03:31:05 GMT
+recorded_with: VCR 2.5.0

data/lib/starcraft2.rb

@@ -1 +1 @@
-require File.join('sc2', 'loader.rb')
+require File.join('starcraft2', 'loader.rb')

data/lib/{sc2 → starcraft2}/achievement.rb

@@ -1,18 +1,16 @@
-module SC2
+module Starcraft2
   class Achievement
     attr_accessor :title, :description, :achievement_id, :category_id, :points, :icon
 
     def initialize(options = {})
       options.each do |k,v|
-        self.send(:"#{k}=", v)
+        self.send(:"#{k.to_s.underscore}=", v)
       end
     end
 
-    def self.build_achievements(raw_data)
+    def self.build(raw_data)
       data = JSON.parse(raw_data)
       data['achievements'].map do |achievement|
-        achievement['achievement_id'] = achievement.delete('achievementId')
-        achievement['category_id'] = achievement.delete('categoryId')
         new(achievement)
       end
     end

data/lib/starcraft2/character.rb

@@ -0,0 +1,11 @@
+module Starcraft2
+  class Character
+    attr_accessor :id, :realm, :display_name, :clan_name, :clan_tag, :profile_path
+
+    def initialize(options = {})
+      options.each do |k,v|
+        self.send(:"#{k.to_s.underscore}=", v)
+      end
+    end
+  end
+end

data/lib/{sc2 → starcraft2}/client.rb

@@ -1,7 +1,8 @@
-module SC2
+module Starcraft2
   class Client
     ACHIEVEMENTS_PATH = "/api/sc2/data/achievements"
     REWARDS_PATH = "/api/sc2/data/rewards"
+    LADDER_PATH = "/api/sc2/ladder/"
 
     attr_accessor :locale, :host
 
@@ -12,11 +13,23 @@ module SC2
     end
 
     def achievements
-      Achievement.build_achievements(achievements_data)
+      Achievement.build(achievements_data)
     end
 
     def rewards
-      Reward.build_rewards(rewards_data)
+      Reward.build(rewards_data)
+    end
+
+    def ladder(id)
+      Ladder.build(ladder_data(id))
+    end
+
+    def grandmaster_ladder
+      ladder('grandmaster')
+    end
+
+    def previous_grandmaster_ladder
+      ladder('grandmaster/last')
     end
 
     private
@@ -37,6 +50,14 @@ module SC2
       "http://" + host + REWARDS_PATH + locale_param
     end
 
+    def ladder_data(id)
+      HTTParty.get(ladder_url(id)).body
+    end
+
+    def ladder_url(id)
+      "http://" + host + LADDER_PATH + id.to_s + locale_param
+    end
+
     def locale_param
       locale.nil? ? '' : "?locale=#{locale}"
     end

data/lib/starcraft2/ladder.rb

@@ -0,0 +1,10 @@
+module Starcraft2
+  class Ladder
+    def self.build(raw_data)
+      data = JSON.parse(raw_data)
+      data['ladderMembers'].map do |member|
+        Member.new(member)
+      end
+    end
+  end
+end

data/lib/starcraft2/loader.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+require 'json'
+require File.join('active_support', 'inflector')
+require File.join('starcraft2', 'client')
+require File.join('starcraft2', 'achievement')
+require File.join('starcraft2', 'reward')
+require File.join('starcraft2', 'ladder')
+require File.join('starcraft2', 'member')
+require File.join('starcraft2', 'character')

data/lib/starcraft2/member.rb

@@ -0,0 +1,13 @@
+module Starcraft2
+  class Member
+    attr_accessor :character, :join_timestamp, :points, :wins,
+    :losses, :highest_rank, :previous_rank, :favorite_race_p1, :favorite_race_p2, :favorite_race_p3, :favorite_race_p4
+
+    def initialize(options)
+      options.each do |k,v|
+        v = Starcraft2::Character.new(v) if k.to_sym == :character
+        self.send(:"#{k.to_s.underscore}=", v)
+      end
+    end
+  end
+end

data/lib/{sc2 → starcraft2}/reward.rb

@@ -1,20 +1,18 @@
-module SC2
+module Starcraft2
   class Reward
     attr_accessor :title, :id, :icon, :achievement_id
 
     def initialize(options = {})
       options.each do |k,v|
-        self.send(:"#{k}=", v)
+        self.send(:"#{k.to_s.underscore}=", v)
       end
     end
 
-    def self.build_rewards(raw_data)
+    def self.build(raw_data)
       data = JSON.parse(raw_data)
       data['portraits'].map do |reward|
-        reward['achievement_id'] = reward.delete('achievementId')
         new(reward)
       end
     end
-
   end
 end

data/spec/spec_helper.rb

@@ -2,9 +2,12 @@ require File.join('bundler', 'setup')
 require 'rspec'
 require 'vcr'
 require 'starcraft2'
+require 'simplecov'
+
+SimpleCov.start
 
 VCR.configure do |c|
-  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.cassette_library_dir = 'fixtures/cassettes'
   c.hook_into :webmock
-  c.default_cassette_options = { :record => :new_episodes, :erb => true }
+  c.default_cassette_options = { :record => :new_episodes, :erb => true, :serialize_with => :yaml }
 end

data/spec/starcraft2/achievement_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Starcraft2::Achievement do
+  describe '#build' do
+    let(:achievements) { Starcraft2::Achievement.build(@raw_achievement_data)}
+
+    before do
+      VCR.use_cassette('achievements') do
+        @raw_achievement_data = HTTParty.get('http://us.battle.net/api/sc2/data/achievements').body
+      end
+    end
+
+    it 'should build an array of achievements' do
+      achievements.class.should == Array
+      achievements.each do |a|
+        a.class.should == Starcraft2::Achievement
+      end
+    end
+  end
+
+  describe '.initialize' do
+    let(:achievement) {Starcraft2::Achievement.new(@options)}
+
+    before do
+      @options = {}
+    end
+
+    it 'should import the first achievement' do
+      VCR.use_cassette('achievements') do
+        @achievement = Starcraft2::Achievement.build(HTTParty.get('http://us.battle.net/api/sc2/data/achievements').body).first
+      end
+
+      @achievement.title.should == "FFA Destroyer"
+      @achievement.description.should == "Win a Free-For-All Unranked game as each race option."
+      @achievement.achievement_id.should == 91475320766632
+      @achievement.category_id.should == 4325391
+      @achievement.points.should == 10
+      @achievement.icon.should == {"x" => 0, "y" => -375, "w" => 75, "h" => 75, "offset" => 45, "url" => "http://media.blizzard.com/sc2/achievements/5-75.jpg"}
+    end
+
+    it 'should store the title' do
+      @options = {:title => 'Test Title'}
+      achievement.title.should == 'Test Title'
+    end
+
+    it 'should store the description' do
+      @options = {:description => 'Description'}
+      achievement.description.should == 'Description'
+    end
+
+    it 'should store the achievement id' do
+      @options = {:achievement_id => 5}
+      achievement.achievement_id.should == 5
+    end
+
+    it 'should store the category id' do
+      @options = {:category_id => 10}
+      achievement.category_id.should == 10
+    end
+
+    it 'should store the points' do
+      @options = {:points => 5}
+      achievement.points.should == 5
+    end
+
+    it 'should store the icon data' do
+      @options = {:icon => {"x" => 1, "y" => 2, "w" => 3, "h" => 4, "offset" => 0, "url" => 'http://example.com'}}
+      achievement.icon.should == {"x" => 1, "y" => 2, "w" => 3, "h" => 4, "offset" => 0, "url" => 'http://example.com'}
+    end
+  end
+end

data/spec/starcraft2/character_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Starcraft2::Character do
+  describe '.initialize' do
+    let(:character) { Starcraft2::Character.new(@options) }
+
+    before do
+      @options = {}
+    end
+
+    it 'should store the id' do
+      @options = {:id => 5}
+      character.id.should == 5
+    end
+
+    it 'should store the realm' do
+      @options = {:realm => "somewhere"}
+      character.realm.should == "somewhere"
+    end
+
+    it 'should store the display_name' do
+      @options = {:display_name => "display me"}
+      character.display_name.should == "display me"
+    end
+
+    it "should store the clan_name" do
+      @options = {:clan_name => "clan name"}
+      character.clan_name.should == "clan name"
+    end
+
+    it "should store the clan_tag" do
+      @options = {:clan_tag => "clan tag"}
+      character.clan_tag.should == "clan tag"
+    end
+
+    it "should store the profile_path" do
+      @options = {:profile_path => "/some/path"}
+      character.profile_path.should == "/some/path"
+    end
+  end
+end

data/spec/starcraft2/client_spec.rb

@@ -0,0 +1,114 @@
+require "spec_helper"
+
+describe Starcraft2::Client do
+  let(:client) { Starcraft2::Client.new(@options)}
+
+  before do
+    @options = {:host => 'us.battle.net'}
+  end
+
+  context 'url constants' do
+    it 'should store the achievements url' do
+      Starcraft2::Client::ACHIEVEMENTS_PATH.should == '/api/sc2/data/achievements'
+    end
+
+    it 'should store the rewards url' do
+      Starcraft2::Client::REWARDS_PATH.should == '/api/sc2/data/rewards'
+    end
+  end
+
+  describe ".initialize" do
+    it 'should store the locale' do
+      @options = { :locale => 'en_US' }
+      client.locale.should == 'en_US'
+    end
+
+    it 'should store the host' do
+      @options = { :host => 'someserver.com'}
+      client.host.should == 'someserver.com'
+    end
+  end
+
+  describe ".achievements" do
+    it 'should return an array of achievements' do
+      VCR.use_cassette('achievements') do
+        client.achievements.class.should == Array
+      end
+    end
+
+    it 'should return items of type Starcraft2::Achievement' do
+      VCR.use_cassette('achievements') do
+        client.achievements.first.class.should == Starcraft2::Achievement
+      end
+    end
+
+    it "should return achievements in the correct locale" do
+      @options.merge!({:locale => "pt_BR"})
+
+      VCR.use_cassette('achievements') do
+        client.achievements.first.title.should == "TCT Destruidor"
+      end
+    end
+  end
+
+  describe ".rewards" do
+    it 'should return an array of rewards' do
+      VCR.use_cassette('rewards') do
+        client.rewards.class.should == Array
+      end
+    end
+
+    it 'should return items of type Starcraft2::Reward' do
+      VCR.use_cassette('rewards') do
+        client.rewards.first.class.should == Starcraft2::Reward
+      end
+    end
+
+    it "should return rewards in the correct locale" do
+      @options.merge!({:locale => "pt_BR"})
+
+      VCR.use_cassette('rewards') do
+        client.rewards.first.title.should == "Kachinsky"
+      end
+    end
+  end
+
+  describe '.grandmaster_ladder' do
+    let(:ladder) do
+      VCR.use_cassette('grandmaster') do
+        client.grandmaster_ladder
+      end
+    end
+    let(:member) { ladder.first }
+
+    it 'should return an array of members' do
+      ladder.class.should == Array
+      ladder.each do |m|
+        m.class.should == Starcraft2::Member
+      end
+    end
+
+    it 'should build characters within the members' do
+      ladder.each do |m|
+        m.character.class.should == Starcraft2::Character
+      end
+    end
+
+    it 'should return the first grandmaster' do
+      member.character.id == 2778732
+      member.character.realm == 1
+      member.character.display_name == 'lIlIlIlIlIlI'
+      member.character.clan_name == ""
+      member.character.clan_tag == ""
+      member.character.profile_path == "/profile/2778732/1/lIlIlIlIlIlI/"
+
+      member.points.should == 2362.0
+      member.wins.should == 250
+      member.losses.should == 101
+      member.join_timestamp.should == 1373859935
+      member.highest_rank.should == 1
+      member.previous_rank.should == 1
+      member.favorite_race_p1.should == "PROTOSS"
+    end
+  end
+end

data/spec/starcraft2/ladder_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Starcraft2::Ladder do
+  describe '#build' do
+    let(:id) { 148200 }
+    let(:host) { 'us.battle.net' }
+    let(:ladder) { Starcraft2::Ladder.build(@raw_ladder_data) }
+
+    before do
+      VCR.use_cassette("ladder_#{id}") do
+        @raw_ladder_data = HTTParty.get("http://us.battle.net/api/sc2/ladder/#{id}").body
+      end
+    end
+
+    it 'should build an array of members' do
+      ladder.class.should == Array
+      ladder.each do |member|
+        member.class.should == Starcraft2::Member
+      end
+    end
+
+    it 'should build characters within the members' do
+      ladder.each do |member|
+        member.character.class.should == Starcraft2::Character
+      end
+    end
+  end
+end