starcraft2 0.2.0 → 0.2.1

data/lib/starcraft2/client.rb

@@ -18,7 +18,7 @@ module Starcraft2
       if (args = [:character_name, :id, :realm] - options.keys).empty?
         Profile.build(self, profile_data(options))
       else
-        raise MissingArgumentsError, "Missing Keys: #{args.map {|i| ":#{i}"}.join(', ')}"
+        raise MissingArgumentsError, "Missing Keys: #{args.map { |i| ":#{i}" }.join(', ')}"
       end
     end
 
@@ -42,6 +42,10 @@ module Starcraft2
       ladder('grandmaster/last')
     end
 
+    def flush_cache
+      @memoizations = {}
+    end
+
     private
 
     def matches(options = {})
@@ -53,8 +57,10 @@ module Starcraft2
     end
 
     def profile_data(options)
-      get_json do
-        HTTParty.get(profile_url(options))
+      memoize(:profile_data, options) do
+        Utils.get_json do
+          HTTParty.get(profile_url(options))
+        end
       end
     end
 
@@ -67,14 +73,18 @@ module Starcraft2
     end
 
     def match_data(options)
-      get_json do
-        HTTParty.get(match_url(options))
+      memoize(:match_data, options) do
+        Utils.get_json do
+          HTTParty.get(match_url(options))
+        end
       end
     end
 
     def ladders_data(options)
-      get_json do
-        HTTParty.get(ladders_url(options))
+      memoize(:ladders_data, options) do
+        Utils.get_json do
+          HTTParty.get(ladders_url(options))
+        end
       end
     end
 
@@ -87,8 +97,10 @@ module Starcraft2
     end
 
     def achievements_data
-      get_json do
-        HTTParty.get(achievements_url)
+      memoize(:achievements_data) do
+        Utils.get_json do
+          HTTParty.get(achievements_url)
+        end
       end
     end
 
@@ -97,8 +109,10 @@ module Starcraft2
     end
 
     def rewards_data
-      get_json do
-        HTTParty.get(rewards_url)
+      memoize(:rewards_data) do
+        Utils.get_json do
+          HTTParty.get(rewards_url)
+        end
       end
     end
 
@@ -107,8 +121,10 @@ module Starcraft2
     end
 
     def ladder_data(id)
-      get_json do
-        HTTParty.get(ladder_url(id))
+      memoize(:ladder_data, id) do
+        Utils.get_json do
+          HTTParty.get(ladder_url(id))
+        end
       end
     end
 
@@ -120,26 +136,14 @@ module Starcraft2
       locale.nil? ? '' : "?locale=#{locale}"
     end
 
-    def get_json
-      response = yield
-      case response.code
-        when 200
-          body = JSON.parse(response.body)
-          case body['code']
-            when 200
-              body
-            when 404
-              raise Starcraft2::NotFoundError, body['message'] || body['reason']
-            when 500
-              raise Starcraft2::ApiError, body['message'] || body['reason']
-            else
-              body
-          end
-        when 404
-          raise Starcraft2::NotFoundError, 'Record not found.'
-        when 500
-          raise Starcraft2::ApiError, 'An API error occurred.'
+    def memoize(name, *args)
+      @memoizations ||= {}
+      @memoizations[name] ||= {}
+      if @memoizations[name].has_key?(args)
+        @memoizations[name][args]
+      else
+        @memoizations[name][args] = yield
       end
     end
   end
-end
+end

data/lib/starcraft2/loader.rb

@@ -1,31 +1,14 @@
-require 'ostruct'
 require 'httparty'
 require 'json'
 
-require File.join('starcraft2', 'errors', 'missing_arguments_error')
-require File.join('starcraft2', 'errors', 'api_error')
-require File.join('starcraft2', 'errors', 'not_found_error')
-require File.join('starcraft2', 'utils')
-require File.join('starcraft2', 'icon')
-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')
-require File.join('starcraft2', 'profile', 'match')
-require File.join('starcraft2', 'profile', 'swarm_race')
-require File.join('starcraft2', 'profile', 'swarm_levels')
-require File.join('starcraft2', 'profile', 'career')
-require File.join('starcraft2', 'profile', 'campaign')
-require File.join('starcraft2', 'profile', 'season')
-require File.join('starcraft2', 'profile', 'stats')
-require File.join('starcraft2', 'profile', 'rewards')
-require File.join('starcraft2', 'profile', 'achievements')
-require File.join('starcraft2', 'profile', 'points')
-require File.join('starcraft2', 'profile', 'achievement_item')
-require File.join('starcraft2', 'profile', 'ladders')
-require File.join('starcraft2', 'profile', 'detailed_season')
-require File.join('starcraft2', 'profile', 'non_rank')
-require File.join('starcraft2', 'profile', 'ladder')
-require File.join('starcraft2', 'profile')
+Dir[File.join("#{File.expand_path File.dirname(__FILE__)}", 'errors', '*.rb')].each do |file|
+  require file
+end
+
+Dir[File.join("#{File.expand_path File.dirname(__FILE__)}", 'profile', '*.rb')].each do |file|
+  require file
+end
+
+Dir[File.join("#{File.expand_path File.dirname(__FILE__)}", '*.rb')].each do |file|
+  require file
+end

data/lib/starcraft2/utils.rb

@@ -20,5 +20,25 @@ module Starcraft2
         klass.send(:"#{k}=", v)
       end
     end
+
+    def self.get_json
+      response = yield
+      case response.code
+        when 200
+          body = JSON.parse(response.body)
+          case body['code']
+            when 404
+              raise Starcraft2::NotFoundError, body['message'] || body['reason']
+            when 500
+              raise Starcraft2::ApiError, body['message'] || body['reason']
+            else
+              body
+          end
+        when 404
+          raise Starcraft2::NotFoundError, 'Record not found.'
+        when 500
+          raise Starcraft2::ApiError, 'An API error occurred.'
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,10 +1,12 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec'
+end
+
 require File.join('bundler', 'setup')
 require 'rspec'
 require 'vcr'
 require 'starcraft2'
-require 'simplecov'
-
-SimpleCov.start
 
 VCR.configure do |c|
   c.cassette_library_dir = 'fixtures/cassettes'

data/spec/starcraft2/client_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Starcraft2::Client do
   let(:client) { Starcraft2::Client.new(@options) }
@@ -33,9 +33,12 @@ describe Starcraft2::Client do
 
   describe '.profile' do
     it 'should return an sc2 profile' do
-      VCR.use_cassette("profile_#{999000}") do
+      VCR.use_cassette('profile_999000') do
         options = {:character_name => 'DayNine', :id => 999000, :realm => 1}
-        client.profile(options).class.should == Starcraft2::Profile
+        profile = client.profile(options)
+        profile.class.should == Starcraft2::Profile
+        profile.display_name.should == 'DayNine'
+        profile.id.should == 999000
       end
     end
 
@@ -53,13 +56,11 @@ describe Starcraft2::Client do
   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
+        achievements = client.achievements
+        achievements.class.should == Array
+        achievements.each do |a|
+          a.class.should == Starcraft2::Achievement
+        end
       end
     end
 
@@ -75,13 +76,11 @@ describe Starcraft2::Client do
   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
+        rewards = client.rewards
+        rewards.class.should == Array
+        rewards.each do |r|
+          r.class.should == Starcraft2::Reward
+        end
       end
     end
 
@@ -102,15 +101,44 @@ describe Starcraft2::Client do
     end
     let(:member) { ladder.first }
 
-    it 'should return an array of members' do
+    it 'should return an array of members with characters' do
       ladder.class.should == Array
       ladder.each do |m|
         m.class.should == Starcraft2::Member
+        m.character.class.should == Starcraft2::Character
       end
     end
 
-    it 'should build characters within the members' do
+    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 == 2374.0
+      member.wins.should == 253
+      member.losses.should == 102
+      member.join_timestamp.should == 1373859935
+      member.highest_rank.should == 1
+      member.previous_rank.should == 1
+      member.favorite_race_p1.should == 'PROTOSS'
+    end
+  end
+
+  describe '.last_grandmaster_ladder' do
+    let(:ladder) do
+      VCR.use_cassette('last_grandmaster') do
+        client.last_grandmaster_ladder
+      end
+    end
+    let(:member) { ladder.first }
+
+    it 'should return an array of members with characters' do
+      ladder.class.should == Array
       ladder.each do |m|
+        m.class.should == Starcraft2::Member
         m.character.class.should == Starcraft2::Character
       end
     end
@@ -132,4 +160,12 @@ describe Starcraft2::Client do
       member.favorite_race_p1.should == 'PROTOSS'
     end
   end
-end
+
+  describe '.flush_cache' do
+    it 'should clear out all memoizations' do
+      client.instance_variable_set('@memoizations', {:foo => 'bar'})
+      client.flush_cache
+      client.instance_variable_get('@memoizations').should == {}
+    end
+  end
+end

data/spec/starcraft2/profile_spec.rb

@@ -8,13 +8,14 @@ describe Starcraft2::Profile do
     let(:profile) { Starcraft2::Profile.build(client, @profile) }
 
     before do
-      VCR.use_cassette("profile_999000") do
+      VCR.use_cassette('profile_999000') do
         @profile = JSON.parse(HTTParty.get('https://us.battle.net/api/sc2/profile/999000/1/DayNine/').body)
       end
     end
 
     it 'should build a profile' do
       profile.class.should == Starcraft2::Profile
+      profile.display_name.should == 'DayNine'
     end
   end
 

data/spec/starcraft2/reward_spec.rb

@@ -1,12 +1,38 @@
 require 'spec_helper'
 
 describe Starcraft2::Reward do
+  describe '.initialize' do
+    let(:reward) { Starcraft2::Reward.new(@options) }
+
+    before do
+      @options = {
+        'title' => 'Test Title',
+        'id' => 3,
+        'icon' => {'x' => 1, 'y' => 2, 'w' => 3, 'h' => 4, 'offset' => 0, 'url' => 'https://example.com'},
+        'achievement_id' => 5
+      }
+    end
+
+    it 'should store attributes as underscored' do
+      reward.title.should == 'Test Title'
+      reward.id.should == 3
+      reward.icon.class.should == Starcraft2::Icon
+      reward.icon.x.should == 1
+      reward.icon.y.should == 2
+      reward.icon.w.should == 3
+      reward.icon.h.should == 4
+      reward.icon.offset.should == 0
+      reward.icon.url.should == 'https://example.com'
+      reward.achievement_id.should == 5
+    end
+  end
+
   describe '#build' do
-    let(:rewards) { Starcraft2::Reward.build(@raw_reward_data) }
+    let(:rewards) { Starcraft2::Reward.build(@rewards) }
 
     before do
       VCR.use_cassette('rewards') do
-        @raw_reward_data = JSON.parse(HTTParty.get('https://us.battle.net/api/sc2/data/rewards').body)
+        @rewards = JSON.parse(HTTParty.get('https://us.battle.net/api/sc2/data/rewards').body)
       end
     end
 
@@ -19,7 +45,6 @@ describe Starcraft2::Reward do
 
     it 'should import the first reward' do
       reward = rewards.first
-
       reward.title.should == 'Kachinsky'
       reward.id.should == 2951153716
       reward.icon.x.should == 0
@@ -31,30 +56,4 @@ describe Starcraft2::Reward do
       reward.achievement_id.should == 0
     end
   end
-
-  describe '.initialize' do
-    let(:reward) { Starcraft2::Reward.new(@options) }
-
-    before do
-      @options = {
-        'title' => 'Test Title',
-        'id' => 3,
-        'icon' => {'x' => 1, 'y' => 2, 'w' => 3, 'h' => 4, 'offset' => 0, 'url' => 'https://example.com'},
-        'achievement_id' => 5
-      }
-    end
-
-    it 'should store attributes as underscored' do
-      reward.title.should == 'Test Title'
-      reward.id.should == 3
-      reward.icon.class.should == Starcraft2::Icon
-      reward.icon.x.should == 1
-      reward.icon.y.should == 2
-      reward.icon.w.should == 3
-      reward.icon.h.should == 4
-      reward.icon.offset.should == 0
-      reward.icon.url.should == 'https://example.com'
-      reward.achievement_id.should == 5
-    end
-  end
 end

data/spec/starcraft2/utils_spec.rb

@@ -55,4 +55,82 @@ describe Starcraft2::Utils do
       ladders.current_season.last.ladder.first.ladder_name.should == 'Torrasque Upsilon'
     end
   end
+
+  describe '#get_json' do
+    let(:success) { {'code' => 200, 'message' => 'success', 'status' => 'nok'} }
+    let(:error) { {'code' => 500, 'message' => 'error', 'status' => 'nok'} }
+    let(:not_found) { {'code' => 404, 'message' => 'not found', 'status' => 'nok'} }
+
+    describe 'HTTP 200' do
+      let(:request) { HTTParty::Request.new Net::HTTP::Get, '/' }
+      let(:response) { Net::HTTPOK.new('1.1', 200, 'OK') }
+
+      it 'should return the parsed json body' do
+        response.stub(:body).and_return(success.to_json)
+        response_lambda = lambda { success.to_json }
+
+        Starcraft2::Utils.get_json do
+          HTTParty::Response.new(request, response, response_lambda)
+        end.should == success
+      end
+
+      context 'json contains code 404' do
+        it 'should throw a NotFoundError' do
+          response.stub(:body).and_return(not_found.to_json)
+          response_lambda = lambda { not_found.to_json }
+
+          expect {
+            Starcraft2::Utils.get_json do
+              HTTParty::Response.new(request, response, response_lambda)
+            end
+          }.to raise_error(Starcraft2::NotFoundError, anything)
+        end
+      end
+
+      context 'json contains code 500' do
+        it 'should throw an ApiError' do
+          response.stub(:body).and_return(error.to_json)
+          response_lambda = lambda { error.to_json }
+
+          expect {
+            Starcraft2::Utils.get_json do
+              HTTParty::Response.new(request, response, response_lambda)
+            end
+          }.to raise_error(Starcraft2::ApiError, anything)
+        end
+      end
+    end
+
+    describe 'HTTP 404' do
+      let(:request) { HTTParty::Request.new Net::HTTP::Get, '/' }
+      let(:response) { Net::HTTPNotFound.new('1.1', 404, 'OK') }
+
+      it 'should throw a NotFoundError' do
+        response.stub(:body).and_return(not_found.to_json)
+        response_lambda = lambda { not_found.to_json }
+
+        expect {
+          Starcraft2::Utils.get_json do
+            HTTParty::Response.new(request, response, response_lambda)
+          end
+        }.to raise_error(Starcraft2::NotFoundError, anything)
+      end
+    end
+
+    describe 'HTTP 500' do
+      let(:request) { HTTParty::Request.new Net::HTTP::Get, '/' }
+      let(:response) { Net::HTTPInternalServerError.new('1.1', 500, 'OK') }
+
+      it 'should throw an ApiError' do
+        response.stub(:body).and_return(error.to_json)
+        response_lambda = lambda { error.to_json }
+
+        expect {
+          Starcraft2::Utils.get_json do
+            HTTParty::Response.new(request, response, response_lambda)
+          end
+        }.to raise_error(Starcraft2::ApiError, anything)
+      end
+    end
+  end
 end