Adds AchievementScraper

Author: cadwallion

lib/bnet_scraper/starcraft2.rb

@@ -1,5 +1,6 @@
 require 'bnet_scraper/starcraft2/profile_scraper'
 require 'bnet_scraper/starcraft2/league_scraper'
+require 'bnet_scraper/starcraft2/achievement_scraper'
 
 module BnetScraper
   # This module contains everything about scraping Starcraft 2 Battle.net accounts.

lib/bnet_scraper/starcraft2/achievement_scraper.rb

@@ -0,0 +1,79 @@
+module BnetScraper
+  module Starcraft2
+    class AchievementScraper
+      attr_reader :region, :bnet_id, :account, :bnet_index, :recent, :progress, :showcase
+      def initialize options = {}
+        if options[:url]
+          extracted_data = options[:url].match(/http:\/\/(.+)\/sc2\/(.+)\/profile\/(.+)\/(\d{1})\/(.+)\/achievements\//)
+          @region = REGIONS.key({ domain: extracted_data[1], dir: extracted_data[2] })
+          @bnet_id = extracted_data[3]
+          @bnet_index = extracted_data[4]
+          @account = extracted_data[5]
+        elsif options[:bnet_id] && options[:account]
+          @account = options[:account]
+          @bnet_id = options[:bnet_id]
+          @region  = options[:region] || 'na'
+
+          if options[:bnet_index]
+            @bnet_index = options[:bnet_index]
+          else
+            set_bnet_index
+          end
+        end
+      end  
+
+      # set_bnet_index
+      # 
+      # Because profile URLs have to have a specific bnet_index that is seemingly incalculable,
+      # we must ping both variants to determine the correct bnet_index. We then store that value.
+      def set_bnet_index
+        [1,2].each do |idx|
+          res = Net::HTTP.get_response URI achievement_url idx 
+          if res.is_a? Net::HTTPSuccess
+            @bnet_index = idx
+            return
+          end
+        end
+      end
+
+      def achievement_url bnet_index = @bnet_index
+        "http://#{region_info[:domain]}/sc2/#{region_info[:dir]}/profile/#{bnet_id}/#{bnet_index}/#{account}/achievements/"
+      end
+
+      def region_info
+        REGIONS[region] 
+      end
+
+      def scrape
+        response = Nokogiri::HTML(open(achievement_url)) 
+        @showcase = response.css("#showcase-module .progress-tile").map do |achievement|
+          hsh = { title: achievement.css('.tooltip-title').inner_text.strip }
+          hsh[:description] = achievement.css('div').inner_text.gsub(hsh[:title], '').strip
+          hsh
+        end
+        
+        @recent = []
+        6.times do |num|
+          achievement = {}
+          div = response.css("#achv-recent-#{num}")
+          if div
+            achievement[:title] = div.css("div").inner_text.strip
+            achievement[:description] = div.inner_text.gsub(achievement[:title], '').strip
+            achievement[:earned] = response.css("#recent-achievements a:nth(#{num}) span:nth(1)").inner_text
+
+            @recent << achievement
+          end
+        end
+
+        progress_ach = response.css("#progress-module .achievements-progress:nth(2) span")
+        @progress = {
+          liberty_campaign: progress_ach[0].inner_text,
+          exploration:      progress_ach[1].inner_text,
+          custom_game:      progress_ach[2].inner_text,
+          cooperative:      progress_ach[3].inner_text,
+          quick_match:      progress_ach[4].inner_text,
+        }
+      end
+    end
+  end
+end

spec/starcraft2/achievement_scraper_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe BnetScraper::Starcraft2::AchievementScraper do
+  describe '#initialize' do
+    context 'with url parameter passed' do
+      subject { BnetScraper::Starcraft2::AchievementScraper.new(url: 'http://us.battle.net/sc2/en/profile/2377239/1/Demon/achievements/') }
+
+      it 'should extract bnet_id from the URL' do
+        subject.bnet_id.should == '2377239' 
+      end
+
+      it 'should extract account from the URL' do
+        subject.account.should == 'Demon'
+      end
+
+      it 'should extract the bnet_index from the URL' do
+        subject.bnet_index.should == '1'
+      end
+
+      it 'should extract the region from the URL' do
+        subject.region.should == 'na'
+      end
+    end
+
+    context 'when bnet_id and account parameters are passed' do
+      subject { BnetScraper::Starcraft2::AchievementScraper.new(bnet_id: '2377239', account: 'Demon') }
+      it 'should set the bnet_id and account parameters' do
+        subject.bnet_id.should == '2377239'
+        subject.account.should == 'Demon'
+      end
+
+      it 'should default the region to na' do
+        subject.region.should == 'na'
+      end
+
+      it 'should assign region if passed' do
+        BnetScraper::Starcraft2::AchievementScraper.any_instance.should_receive(:set_bnet_index)
+        scraper = BnetScraper::Starcraft2::AchievementScraper.new(bnet_id: '2377239', account: 'Demon', region: 'fea')
+        scraper.region.should == 'fea'
+      end
+
+      it 'should not call set_bnet_index if bnet_index is passed' do
+        BnetScraper::Starcraft2::AchievementScraper.any_instance.should_not_receive(:set_bnet_index)
+        scraper = BnetScraper::Starcraft2::AchievementScraper.new(bnet_id: '2377239', account: 'Demon', region: 'fea', bnet_index: '1')
+      end
+
+      it 'should call set_bnet_index_if bnet_index is not passed' do
+        BnetScraper::Starcraft2::AchievementScraper.any_instance.should_receive(:set_bnet_index)
+        scraper = BnetScraper::Starcraft2::AchievementScraper.new(bnet_id: '2377239', account: 'Demon', region: 'fea')
+      end
+    end
+  end
+
+  describe '#scrape' do
+    subject { BnetScraper::Starcraft2::AchievementScraper.new(url: 'http://us.battle.net/sc2/en/profile/2377239/1/Demon/achievements/') }
+    before :each do
+      subject.scrape
+    end
+
+    it 'should set the showcase' do
+      subject.showcase.should have(5).achievements
+    end
+
+    it 'should set the recently earned' do
+      subject.recent.should have(6).achievements
+    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
+end