bnet_scraper 0.0.1

data/lib/bnet_scraper/starcraft2/match_history_scraper.rb

@@ -0,0 +1,65 @@
+module BnetScraper
+  module Starcraft2
+    ## BnetScraper::Starcraft2::MatchHistoryScraper
+    #
+    # This pulls the 25 most recent matches played for an account. Note that this is only as up-to-date as battle.net is, and
+    # will likely not be as fast as in-game.
+    # 
+    #   scraper = BnetScraper::Starcraft2::MatchHistoryScraper.new(url: 'http://us.battle.net/sc2/en/profile/2377239/1/Demon/')
+    #   scraper.scrape
+    #   # => {
+    #     wins: '15',
+    #     losses: '10',
+    #     matches: [
+    #       { map_name: 'Bx Monobattle - Sand Canyon (Fix)', outcome: :win, type: 'Custom', date: '3/12/2012' },
+    #       { map_name: 'Deadlock Ridge', outcome: :loss, type: '4v4', date: '3/12/2012' },
+    #       { map_name: 'District 10', outcome: :win, type: '4v4', date: '3/12/2012' },
+    #       # ...
+    #     ]
+    #   }
+    class MatchHistoryScraper < BaseScraper
+      attr_reader :matches, :wins, :losses, :response
+       
+      def match_url
+        profile_url + "matches"
+      end
+
+      def get_response
+        @response = Nokogiri::HTML(open(match_url))
+      end
+
+      def scrape
+        get_response
+        @matches = []
+        @wins = 0
+        @losses = 0
+
+        response.css('.match-row').each do |m|
+          match = {}
+
+          cells = m.css('td')
+          match[:map_name] = cells[1].inner_text
+          match[:type] = cells[2].inner_text
+          match[:outcome] = (cells[3].inner_text.strip == 'Win' ? :win : :loss)
+          match[:date] = cells[4].inner_text.strip
+          @matches << match 
+          if match[:outcome] == :win
+            @wins += 1
+          else
+            @losses += 1
+          end
+          output
+        end
+
+      end
+
+      def output
+        {
+          matches:  @matches,
+          wins:     @wins,
+          losses:   @losses 
+        }
+      end
+    end
+  end
+end

data/lib/bnet_scraper/starcraft2/profile_scraper.rb

@@ -0,0 +1,63 @@
+module BnetScraper
+  module Starcraft2
+    # ProfileScraper
+    #
+    # Scrapes SC2 profile data from battle.net and returns it as a hash.  Example:
+    #   profile_data = BnetScraper::Starcraft2::ProfileScraper.new('2377239', 'Demon')
+    #   profile_data # => { bnet_id: '2377239', account: 'Demon', race: 'Protoss', 
+    #                       wins: '684', achievements: '3260', leagues: [], bnet_index: 1 }
+    #
+    # One thing of note is the bnet_index. In Battle.net URLs, there is a single-digit index
+    # used on accounts (1 or 2).  This index is seemingly arbitrary, but critical to properly
+    # accessing the data.
+    #
+    # ProfileScraper requires that either you pass the URL of the profile, or the bnet_id and
+    # account name of the profile.  The URL scheme is as such:
+    #
+    #   http://<REGION_DOMAIN>/sc2/<REGION_LANG>/profile/<BNET_ID>/<BNET_INDEX>/<ACCOUNT>/
+    #
+    # Using this URL we can extract the critical information.  However, sometimes we do not have
+    # the URL and have to make do with a bnet_id and account.  This is the bare minimum needed,
+    # unless the account is in a region other than 'na'.  In such cases, region all needs to be passed.
+    class ProfileScraper < BaseScraper
+      attr_reader :achievement_points, :wins, :race, :leagues
+      def scrape
+        get_profile_data
+        get_league_list
+        output
+      end
+
+      def get_profile_data
+        response = Nokogiri::HTML(open(profile_url))
+
+        @race = response.css("#season-snapshot .module-footer a").first().inner_html()
+        @wins = response.css("#career-stats h2").inner_html()
+        @achievement_points = response.css("#profile-header h3").inner_html()
+      end
+
+      def get_league_list
+        response = Nokogiri::HTML(open(profile_url + "ladder/leagues"))
+
+        @leagues = response.css("a[href*='#current-rank']").map do |league|
+          {
+            name: league.inner_html().strip,
+            id: league.attr('href').sub('#current-rank',''),
+            href: "#{profile_url}ladder/#{league.attr('href')}"
+          }
+        end
+      end
+
+      def output
+         {
+          bnet_id: @bnet_id,
+          account: @account,
+          bnet_index: @bnet_index,
+          race: @race,
+          wins: @wins,
+          achievement_points: @achievement_points,
+          leagues: @leagues
+        }  
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'bnet_scraper'
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f }
+

data/spec/starcraft2/achievement_scraper_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe BnetScraper::Starcraft2::AchievementScraper do
+  let(:url) { 'http://us.battle.net/sc2/en/profile/2377239/1/Demon/achievements/' }
+  subject { BnetScraper::Starcraft2::AchievementScraper.new(url: url) }
+
+  it_behaves_like 'an SC2 Scraper' do
+    let(:scraper_class) { BnetScraper::Starcraft2::AchievementScraper }
+    let(:subject) { scraper_class.new(url: url) }
+  end
+
+  describe '#get_response' do
+    it 'should get the HTML response to be scraped' do
+      subject.response.should be_nil
+      subject.get_response
+      subject.response.should_not be_nil
+    end
+  end
+
+  describe '#scrape' do
+    it 'should call get_response and trigger scraper methods' do
+      subject.should_receive(:get_response)
+      subject.should_receive(:scrape_progress)
+      subject.should_receive(:scrape_recent)
+      subject.should_receive(:scrape_showcase)
+      subject.scrape
+    end
+  end
+
+  describe '#scrape_showcase' do
+    before :each do
+      subject.get_response
+      subject.scrape_showcase
+    end
+
+    it 'should set the showcase' do
+      subject.showcase.should have(5).achievements
+    end
+  end
+
+  describe '#scrape_recent' do
+    before :each do
+      subject.get_response
+      subject.scrape_recent
+    end
+
+    it 'should have the title of the achievement' do
+      subject.recent[0][:title].should == 'Blink of an Eye'  
+    end
+
+    it 'should have the description of the achievement' do
+      # this is a cop-out because the string contains UTF-8. Please fix this. - Cad
+      subject.recent[0][:description].should be_a String 
+    end
+
+    it 'should have the date the achievement was earned' do
+      subject.recent[0][:earned].should == '3/5/2012' 
+    end
+  end
+
+  describe '#scrape_progress' do
+    before :each do
+      subject.get_response
+      subject.scrape_progress
+    end 
+
+    it 'should set the liberty campaign progress' do
+      subject.progress[:liberty_campaign].should == '1580'
+    end
+
+    it 'should set the exploration progress' do
+      subject.progress[:exploration].should == '480'
+    end
+
+    it 'should set the custom game progress' do
+      subject.progress[:custom_game].should == '330'
+    end
+
+    it 'should set the cooperative progress' do
+      subject.progress[:cooperative].should == '660'
+    end
+
+    it 'should set the quick match progress' do
+      subject.progress[:quick_match].should == '170'
+    end
+  end
+
+  describe '#output' do
+    it 'should return the scraped data when scrape has been called' do
+      subject.scrape
+      expected = {
+        recent: subject.recent,
+        showcase: subject.showcase,
+        progress: subject.progress
+      }
+      subject.output.should == expected
+    end
+  end
+end

data/spec/starcraft2/base_scraper_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe BnetScraper::Starcraft2::BaseScraper do
+  it_behaves_like 'an SC2 Scraper' do
+    let(:scraper_class) { BnetScraper::Starcraft2::BaseScraper }
+    let(:subject) { scraper_class.new(url: 'http://us.battle.net/sc2/en/profile/2377239/1/Demon/') }
+  end
+
+  describe '#scrape' do
+    it 'should raise an error calling scrape' do
+      expect { subject.scrape }.to raise_error NotImplementedError
+    end
+  end
+end

data/spec/starcraft2/league_scraper_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe BnetScraper::Starcraft2::LeagueScraper do
+  let(:url) { "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/12345" }
+  subject { BnetScraper::Starcraft2::LeagueScraper.new(url: url) }
+
+  it_behaves_like 'an SC2 Scraper' do
+    let(:scraper_class) { BnetScraper::Starcraft2::LeagueScraper }
+    let(:subject) { scraper_class.new(url: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/12345") }
+  end
+
+  describe '#initialize' do
+    it 'should dissect the league_id from the URL' do
+      subject.league_id.should == '12345'
+    end
+  end
+
+  describe '#scrape' do
+    it 'should set the season value' do
+      subject.season.should be_nil
+      subject.scrape
+      subject.season.should == '6'
+    end
+
+    it 'should set the name' do
+      subject.name.should be_nil 
+      subject.scrape
+      subject.name.should == 'Aleksander Pepper'
+    end
+
+    it 'should set the divison' do
+      subject.division.should be_nil
+      subject.scrape
+      subject.division.should == 'Diamond'
+    end
+
+    it 'should set the size' do
+      subject.size.should be_nil
+      subject.scrape
+      subject.size.should == '4v4'
+    end
+
+    it 'should set if player is random' do
+      subject.random.should be_nil
+      subject.scrape
+      subject.random.should be_false 
+    end
+
+    it 'should call output' do
+      subject.should_receive(:output)
+      subject.scrape
+    end
+  end
+
+  describe '#output' do
+    it 'should return a hash of league data' do
+      expected = {
+        season: '6',
+        name: 'Aleksander Pepper',
+        division: 'Diamond',
+        size: '4v4',
+        random: false,
+        bnet_id: '2377239',
+        account: 'Demon'
+      }
+
+      subject.scrape
+      subject.output.should == expected
+    end
+  end
+end

data/spec/starcraft2/match_history_scraper_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe BnetScraper::Starcraft2::MatchHistoryScraper do
+  let(:url) { 'http://us.battle.net/sc2/en/profile/2377239/1/Demon/matches' }
+  subject { BnetScraper::Starcraft2::MatchHistoryScraper.new(url: url) }
+
+  it_behaves_like 'an SC2 Scraper' do
+    let(:scraper_class) { BnetScraper::Starcraft2::MatchHistoryScraper }
+    let(:scraper) { scraper_class.new(url: 'http://us.battle.net/sc2/en/profile/2377239/1/Demon/matches') }
+  end
+
+  describe '#scrape' do
+
+    before :each do
+      subject.scrape
+    end
+
+    it 'sets the matches to an array of match data' do
+      subject.matches.should have(25).matches
+    end
+
+    it 'should set the name of the map for each match' do
+      subject.matches[0][:map_name].should == 'Bx Monobattle - Sand Canyon (Fix)'
+    end
+
+    it 'should set the type of the match for each match' do
+      subject.matches[0][:type].should == 'Custom'
+    end
+
+    it 'should set the outcome of each match' do
+      subject.matches[0][:outcome].should == :win
+    end
+
+    it 'should set the match date of each match' do
+      subject.matches[0][:date].should == '3/12/2012'
+    end
+  end
+
+  describe '#output' do
+    before :each do
+      subject.scrape
+    end
+
+    it 'should return a hash of the scraped match data' do
+      expected = {
+        matches:  subject.matches,
+        wins:     subject.wins,
+        losses:   subject.losses
+      }
+      subject.output.should == expected
+    end
+  end
+end

data/spec/starcraft2/profile_scraper_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+describe BnetScraper::Starcraft2::ProfileScraper do
+  it_behaves_like 'an SC2 Scraper' do
+    let(:scraper_class) { BnetScraper::Starcraft2::BaseScraper }
+    let(:subject) { scraper_class.new(url: 'http://us.battle.net/sc2/en/profile/2377239/1/Demon/') }
+  end
+
+  subject { BnetScraper::Starcraft2::ProfileScraper.new(bnet_id: '2377239', account: 'Demon') }
+
+  describe '#get_profile_data' do
+    it 'should set the race, wins, and achievements attributes' do
+      subject.instance_variable_get(:@race).should be_nil
+      subject.instance_variable_get(:@achievement_points).should be_nil
+      subject.instance_variable_get(:@wins).should be_nil
+
+      subject.get_profile_data
+      
+      subject.instance_variable_get(:@race).should == 'Protoss'
+      subject.instance_variable_get(:@achievement_points).should == '3630'
+      subject.instance_variable_get(:@wins).should == '684'
+    end
+  end
+
+  describe 'get_league_list' do
+    it 'should set an array of leagues' do
+      subject.instance_variable_get(:@leagues).should be_nil
+      subject.get_league_list
+
+      subject.instance_variable_get(:@leagues).should have(12).leagues
+    end
+  end
+
+  describe '#scrape' do
+    it 'should call get_profile_data' do
+      subject.should_receive(:get_profile_data)
+      subject.scrape
+    end
+    it 'should call get_league_list' do
+      subject.should_receive(:get_league_list)
+      subject.scrape
+    end
+
+    it 'should call output' do
+      subject.should_receive(:output)
+      subject.scrape
+    end
+  end
+
+  describe '#output' do
+    it 'should extract profile data from the response' do
+      expected = {
+        bnet_id: '2377239',
+        account: 'Demon',
+        bnet_index: 1,
+        race: 'Protoss',
+        wins: '684',
+        achievement_points: '3630',
+        leagues: [
+          {
+            name: "1v1 Platinum Rank 95",
+            id:   "96905",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/96905#current-rank"
+          },
+          {
+            name: "2v2 Random Platinum ...",
+            id:   "96716",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/96716#current-rank"
+          },
+          {
+            name: "2v2 Diamond Rank 45",
+            id:   "98162",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/98162#current-rank"
+          },
+          {
+            name: "2v2 Silver Rank 8",
+            id:   "97369",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/97369#current-rank"
+          },
+          {
+            name: "3v3 Random Gold Rank...",
+            id:   "96828",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/96828#current-rank"
+          },
+          {
+            name: "3v3 Diamond Rank 56",
+            id:   "97985",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/97985#current-rank"
+          },
+          {
+            name: "3v3 Silver Rank 5",
+            id:   "98523",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/98523#current-rank"
+          },
+          {
+            name: "3v3 Platinum Rank 88",
+            id:   "96863",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/96863#current-rank"
+          },
+          {
+            name: "3v3 Gold Rank 75",
+            id:   "97250",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/97250#current-rank"
+          },
+          {
+            name: "4v4 Random Platinum ...",
+            id:   "96830",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/96830#current-rank"
+          },
+          {
+            name: "4v4 Gold Rank 38",
+            id:   "98336",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/98336#current-rank"
+          },
+          {
+            name: "4v4 Diamond Rank 54",
+            id:   "98936",
+            href: "http://us.battle.net/sc2/en/profile/2377239/1/Demon/ladder/98936#current-rank"
+          }
+        ]
+      }
+
+      subject.output.should == { bnet_id: '2377239', account: 'Demon', bnet_index: 1, race: nil, wins: nil, achievement_points: nil, leagues: nil }
+      subject.scrape
+      subject.output.should == expected
+    end
+  end
+end