bnet_scraper 0.4.0 → 0.5.0

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog!
 
+## 0.5.0 (Mar 29 2013)
+
+* Adds Heart of the Swarm Portrait Names
+* Updates Achievement Progress Categories for Heart of the Swarm
+* Adds Achievement to replace hash output
+* Replace FakeWeb specs with VCR
+* Typecast numerics to Fixnum instead of strings
+* Typecast dates to Date instead of Strings (`Achievement#earned=`)
+* Fix wins/losses in MatchHistoryScraper
+* Adds Campaign Completion indicators (`Profile#campaign_completion`)
+* Extensive internal refactoring and decoupling
+
 ## 0.4.0 (Feb 22 2013)
 
 * Revamped ProfileScraper API

data/README.md

@@ -1,4 +1,4 @@
-# BnetScraper [![Build Status](https://secure.travis-ci.org/agoragames/bnet_scraper.png)](http://travis-ci.org/agoragames/bnet_scraper)
+# BnetScraper [![Build Status](https://secure.travis-ci.org/agoragames/bnet_scraper.png)](http://travis-ci.org/agoragames/bnet_scraper) [![Code Climate](https://codeclimate.com/github/agoragames/bnet_scraper.png)](https://codeclimate.com/github/agoragames/bnet_scraper)
 
 BnetScraper is a Nokogiri-based scraper of Battle.net profile information.  Currently this only includes Starcraft2.
 

data/bnet_scraper.gemspec

@@ -3,9 +3,9 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "bnet_scraper"
-  s.version     = "0.4.0"
+  s.version     = "0.5.0"
   s.authors     = ["Andrew Nordman"]
-  s.email       = ["anordman@majorleaguegaming.com"]
+  s.email       = ["cadwallion@gmail.com"]
   s.homepage    = "https://github.com/agoragames/bnet_scraper/"
   s.summary     = %q{Battle.net Profile Scraper}
   s.description = %q{BnetScraper is a Nokogiri-based scraper of Battle.net profile information. Currently this only includes Starcraft2.}
@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'nokogiri'
   s.add_runtime_dependency 'faraday'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
   s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'rspec'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'pry'
 end

data/lib/bnet_scraper/starcraft2.rb

@@ -38,47 +38,50 @@ module BnetScraper
     # I decided th pad the arrays even if there are no images to make various
     # helping functionality (e.g. retrieving position for a name) easier.
     # I've also kept them in 6x6 here for better overview.
-    PORTRAITS = [
-      # http://eu.battle.net/sc2/static/local-common/images/sc2/portraits/0-75.jpg?v42
-      ['Kachinsky', 'Cade', 'Thatcher', 'Hall', 'Tiger Marine', 'Panda Marine', 
-      'General Warfield', 'Jim Raynor', 'Arcturus Mengsk', 'Sarah Kerrigan', 'Kate Lockwell', 'Rory Swann', 
-      'Egon Stetmann', 'Hill', 'Adjutant', 'Dr. Ariel Hanson', 'Gabriel Tosh', 'Matt Horner', 
-      # Could not identify in order: Raynor in a Suit? Bullmarine? Nova? 
-      # Fiery Marine?
-      'Tychus Findlay', 'Zeratul', 'Valerian Mengsk', 'Spectre', '?', '?',
-      '?', '?', 'SCV', 'Firebat', 'Vulture', 'Hellion', 
-      'Medic', 'Spartan Company', 'Wraith', 'Diamondback', 'Probe', 'Scout'],
-
-      # http://eu.battle.net/sc2/static/local-common/images/sc2/portraits/1-75.jpg?v42
-      # Special Rewards - couldn't identify most of these.
-      ['?', '?', '?', '?', '?', 'PanTerran Marine', 
-      '?', '?', '?', '?', '', '',
-      '', '', '', '', '', '',
-      '', '', '', '', '', '',
-      '', '', '', '', '', '',
-      '', '', '', '', '', ''],
-
-      # http://eu.battle.net/sc2/static/local-common/images/sc2/portraits/2-75.jpg?v42
-      ['Ghost', 'Thor', 'Battlecruiser', 'Nova', 'Zealot', 'Stalker', 
-      'Phoenix', 'Immortal', 'Void Ray', 'Colossus', 'Carrier', 'Tassadar',
-      'Reaper', 'Sentry', 'Overseer', 'Viking', 'High Templar', 'Mutalisk',
-      # Unidentified: Bird? Dog? Robot?
-      'Banshee', 'Hybrid Destroyer', 'Dark Voice', '?', '?', '?',
-      # Unidentified: Worgen? Goblin? Chef?
-      'Orian', 'Wolf Marine', 'Murloc Marine', '?', '?', 'Zealot Chef', 
-      # Unidentified: KISS Marine? Dragon Marine? Dragon? Another Raynor?
-      'Stank', 'Ornatus', '?', '?', '?', '?'],
 
-      # http://eu.battle.net/sc2/static/local-common/images/sc2/portraits/3-75.jpg?v42
-      ['Urun', 'Nyon', 'Executor', 'Mohandar', 'Selendis', 'Artanis', 
-      'Drone', 'Infested Colonist', 'Infested Marine', 'Corruptor', 'Aberration', 'Broodlord', 
-      'Overmind', 'Leviathan', 'Overlord', 'Hydralisk Marine', "Zer'atai Dark Templar", 'Goliath', 
-      # Unidentified: Satan Marine?
-      'Lenassa Dark Templar', 'Mira Han', 'Archon', 'Hybrid Reaver', 'Predator', '?',
-      'Zergling', 'Roach', 'Baneling', 'Hydralisk', 'Queen', 'Infestor', 
-      'Ultralisk', 'Queen of Blades', 'Marine', 'Marauder', 'Medivac', 'Siege Tank']
+    PORTRAITS = [
+      [
+        'Kachinsky', 'Cade', 'Thatcher', 'Hall', 'Tiger Marine', 'Panda Marine', 
+        'General Warfield', 'Jim Raynor', 'Arcturus Mengsk', 'Sarah Kerrigan', 'Kate Lockwell', 'Rory Swann',
+        'Egon Stetmann', 'Hill', 'Adjutant', 'Dr. Ariel Hanson', 'Gabriel Tosh', 'Matt Horner', 
+        'Tychus Findlay', 'Zeratul', 'Valerian Mengsk', 'Spectre', 'Raynor Marine', 'Tauren Marine',
+        'Night Elf Banshee', 'Diablo Marine', 'SCV', 'Firebat', 'Vulture', 'Hellion', 
+        'Medic', 'Spartan Company', 'Wraith', 'Diamondback', 'Probe', 'Scout'
+      ],
+      [
+        'Tauren Marine', 'Night Elf Banshee', 'Diablo Marine', 'Worgen Marine', 'Goblin Marine', 'PanTerran Marine', 
+        'Wizard Templar', 'Tyrael Marine', 'Witch Doctor Zergling', 'Stank', 'Night Elf Templar', 'Infested Orc',
+        '', 'Diablo Marine', '', 'Pandaren Firebat', 'Prince Valerian', 'Zagara',
+        'Lasarra', 'Dehaka', 'Infested Stukov', 'Mira Horner', 'Primal Queen', 'Izsha',
+        'Abathur', 'Ghost Kerrigan', 'Zurvan', 'Narud', '', '',
+        '', '', '', '', '', ''
+      ],
+      [
+        'Ghost', 'Thor', 'Battlecruiser', 'Nova', 'Zealot', 'Stalker', 
+        'Phoenix', 'Immortal', 'Void Ray', 'Colossus', 'Carrier', 'Tassadar',
+        'Reaper', 'Sentry', 'Overseer', 'Viking', 'High Templar', 'Mutalisk',
+        'Banshee', 'Hybrid Destroyer', 'Dark Voice', 'Urubu', 'Lyote', 'Automaton 2000',
+        'Orian', 'Wolf Marine', 'Murloc Marine', 'Worgen Marine', 'Goblin Marine', 'Zealot Chef', 
+        'Stank', 'Ornatus', 'Facebook Corps Members', 'Lion Marines', 'Dragons', 'Raynor Marine'
+      ],
+      [
+        'Urun', 'Nyon', 'Executor', 'Mohandar', 'Selendis', 'Artanis', 
+        'Drone', 'Infested Colonist', 'Infested Marine', 'Corruptor', 'Aberration', 'Broodlord', 
+        'Overmind', 'Leviathan', 'Overlord', 'Hydralisk Marine', "Zer'atai Dark Templar", 'Goliath', 
+        'Lenassa Dark Templar', 'Mira Han', 'Archon', 'Hybrid Reaver', 'Predator', 'Unknown',
+        'Zergling', 'Roach', 'Baneling', 'Hydralisk', 'Queen', 'Infestor', 
+        'Ultralisk', 'Queen of Blades', 'Marine', 'Marauder', 'Medivac', 'Siege Tank'
+      ],
+      [
+        'Level 3 Zealot', 'Level 5 Stalker', 'Level 8 Sentinel', 'Level 11 Immortal', 'Level 14 Oracle', 'Level 17 High Templar',
+        'Level 21 Tempest', 'Level 23 Colossus', 'Level 27 Carrier', 'Level 29 Zeratul', 'Level 3 Marine', 'Level 5 Marauder',
+        'Level 8 Hellbat', 'Level 11 Widow Mine', 'Level 14 Medivac', 'Level 17 Banshee', 'Level 21 Ghost', 'Level 23 Thor',
+        'Level 27 Battlecruiser', 'Level 29 Raynor', 'Level 3 Zergling', 'Level 5 Roach', 'Level 8 Hydralisk', 'Level 11 Locust',
+        'Level 14 Swarm Host', 'Level 17 Infestor', 'Level 21 Viper', 'Level 23 Broodlord', 'Level 27 Ultralisk', 'Level 29 Kerrigan',
+        'Protoss Champion',' Terran Champion', 'Zerg Champion', '', '', ''
+      ]
     ]
-
+      
     # This is a convenience method that chains calls to ProfileScraper,
     # followed by a scrape of each league returned in the `leagues` array
     # in the profile_data.  The end result is a fully scraped profile with

data/lib/bnet_scraper/starcraft2/achievement.rb

@@ -0,0 +1,24 @@
+require 'date'
+module BnetScraper
+  module Starcraft2
+    class Achievement
+      attr_accessor :title, :description
+      attr_reader :earned
+
+      def initialize options = {}
+        options.each_key do |key|
+          self.send "#{key}=", options[key]
+        end
+      end
+
+      def earned= date
+        @earned = convert_date date
+      end
+
+      def convert_date date
+        month, day, year = date.scan(/(\d+)\/(\d+)\/(\d+)/).first.map(&:to_i)
+        Date.new year, month, day
+      end
+    end
+  end
+end

data/lib/bnet_scraper/starcraft2/achievement_scraper.rb

@@ -1,3 +1,5 @@
+require 'bnet_scraper/starcraft2/achievement'
+
 module BnetScraper
   module Starcraft2
     # This pulls achievement information for an account.  Note that currently only returns the overall achievements,
@@ -24,10 +26,11 @@ module BnetScraper
     #    ],
     #    progress: {
     #      liberty_campaign: '1580',
-    #      exploration: '480',
+    #      swarm_campaign: '480',
+    #      matchmaking: '1100',
     #      custom_game: '330',
-    #      cooperative: '660',
-    #      quick_match: '170'
+    #      arcade: '660',
+    #      exploration: '170'
     #    }
     #  }
     class AchievementScraper < BaseScraper
@@ -42,6 +45,8 @@ module BnetScraper
       end
 
       # retrieves the account's achievements overview page HTML for scraping
+      #
+      # @return [Nokogiri::HTML] The parsed HTML document
       def get_response
         response = Faraday.get "#{profile_url}achievements/"
         if response.success?
@@ -52,40 +57,59 @@ module BnetScraper
       end
 
       # scrapes the recent achievements from the account's achievements overview page
+      #
+      # @return [Array<Achievement>] Array of recent achievements
       def scrape_recent
         @recent = []
-        6.times do |num|
-          achievement = {}
-          div = response.css("#achv-recent-#{num}")
-          if div
-            achievement[:title] = div.css("div > div").inner_text.strip
-            achievement[:description] = div.inner_text.gsub(achievement[:title], '').strip
-            achievement[:earned] = response.css("#recent-achievements span")[(num*3)+1].inner_text
-
-            @recent << achievement
-          end
+        response.css(".recent-tile").size.times do |num|
+          achievement = extract_recent_achievement num
+          @recent.push(achievement) if achievement
         end
+
         @recent
       end
 
-      # scrapes the progress of each achievement category from the account's achievements overview page
+      # Scrapes recent achievement by position in the sidebar
+      #
+      # @param [Fixnum] achievement position number, top-down
+      # @return [Achievement] achievement object containing all achievement information
+      def extract_recent_achievement num
+        if div = response.css("#achv-recent-#{num}")
+          Achievement.new({
+            title: div.children[1].inner_text,
+            description: div.children[2].inner_text.strip,
+            earned: response.css(".recent-tile")[num].css('span')[1].inner_text
+          })
+        end
+      end
+
+
+
+      # Scrapes the progress of each achievement category from the account's achievements
+      # overview page and returns them as a hash
+      #
+      # @return [Hash] Hash of achievement indicators broken down by category
       def scrape_progress
-        progress_ach = response.css("#progress-module .achievements-progress:nth(2) span")
-        @progress = {
-          liberty_campaign: response.css(".progress-tile:nth-child(1) .profile-progress span").inner_text,
-          exploration:      response.css(".progress-tile:nth-child(2) .profile-progress span").inner_text,
-          custom_game:      response.css(".progress-tile:nth-child(3) .profile-progress span").inner_text,
-          cooperative:      response.css(".progress-tile:nth-child(4) .profile-progress span").inner_text,
-          quick_match:      response.css(".progress-tile:nth-child(5) .profile-progress span").inner_text,
-        }
+        keys = [:liberty_campaign, :swarm_campaign, :matchmaking, :custom_game, :arcade, :exploration]
+        index = 1
+
+        @progress = keys.inject({}) do |hash, key|
+          hash[key] = response.css(".progress-tile:nth-child(#{index}) .profile-progress span").inner_text.to_i
+          index += 1
+
+          hash
+        end
       end
 
-      # scrapes the showcase achievements from the account's achievements overview page
+      # Scrapes the showcase achievements from the account's achievements overview page
+      #
+      # @return [Array<Achievement>] Array containing all the showcased achievements
       def scrape_showcase
         @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
+          Achievement.new({
+            title: achievement.css('.tooltip-title').inner_text.strip,
+            description: achievement.children[3].children[2].inner_text.strip
+          })
         end
         @showcase
       end

data/lib/bnet_scraper/starcraft2/base_scraper.rb

@@ -19,25 +19,41 @@ module BnetScraper
 
       def initialize options = {}
         if options[:url]
-          extracted_data = options[:url].match(/http:\/\/(.+)\/sc2\/(.+)\/profile\/(.+)\/(\d{1})\/(.[^\/]+)\//)
-          if extracted_data
-            @region     = REGION_DOMAINS[extracted_data[1]]
-            @bnet_id    = extracted_data[3]
-            @bnet_index = extracted_data[4]
-            @account    = extracted_data[5]
-            @url        = options[:url]
-          else
-            raise BnetScraper::InvalidProfileError, "URL provided does not match Battle.net format"
-          end
+          extract_data_from_url options[:url]
         elsif options[:bnet_id] && options[:account]
-          @bnet_id  = options[:bnet_id]
-          @account  = options[:account]
-          @region   = options[:region] || 'na'
-          if options[:bnet_index]
-            @bnet_index = options[:bnet_index]
-          else
-            set_bnet_index
-          end
+          extract_data_from_options options
+        end
+      end
+
+      # Extracts information about the account from the URL string
+      #
+      # @param [String] url of the Battle.net profile page
+      def extract_data_from_url url
+        extracted_data = url.match(/http:\/\/(.+)\/sc2\/(.+)\/profile\/(.+)\/(\d{1})\/(.[^\/]+)\//)
+        if extracted_data
+          @region     = REGION_DOMAINS[extracted_data[1]]
+          @language   = extracted_data[2]
+          @bnet_id    = extracted_data[3]
+          @bnet_index = extracted_data[4]
+          @account    = extracted_data[5]
+          @url        = url
+        else
+          raise BnetScraper::InvalidProfileError, "URL provided does not match Battle.net format"
+        end
+      end
+
+      # Extracts information about the account from an options hash
+      #
+      # @param [Hash] hash of Battle.net account infomation
+      def extract_data_from_options options
+        @bnet_id  = options[:bnet_id]
+        @account  = options[:account]
+        @region   = options[:region] || 'na'
+
+        if options[:bnet_index]
+          @bnet_index = options[:bnet_index]
+        else
+          set_bnet_index
         end
       end
 

data/lib/bnet_scraper/starcraft2/match_history_scraper.rb

@@ -18,7 +18,7 @@ module BnetScraper
     #     ]
     #   }
     class MatchHistoryScraper < BaseScraper
-      attr_reader :matches, :wins, :losses, :response
+      attr_reader :matches, :response
        
       # account's match history URL
       def match_url
@@ -39,24 +39,33 @@ module BnetScraper
       def scrape
         get_response
         @matches = []
-        @wins = 0
-        @losses = 0
 
         response.css('.match-row').each do |m|
-          match = {}
-          match = Match.new
-
-          cells = m.css('td')
-          match.map_name = cells[1].inner_text
-          match.type = cells[2].inner_text
-          match.outcome = (cells.css('.match-loss') ? :win : :loss)
-          match.date = cells[4].inner_text.strip
-
-          @matches << match 
+          @matches.push extract_match_info m
         end
 
         @matches
       end
+
+      def wins
+        @wins ||= @matches.count { |m| m.outcome == :win }
+      end
+
+      def losses
+        @losses ||= @matches.count { |m| m.outcome == :loss }
+      end
+
+      def extract_match_info m
+        match = Match.new
+
+        cells = m.css('td')
+        match.map_name = cells[1].inner_text
+        match.type = cells[2].inner_text
+        match.outcome = (cells.css('.match-win')[0] ? :win : :loss)
+        match.date = cells[4].inner_text.strip
+
+        match
+      end
     end
   end
 end

data/lib/bnet_scraper/starcraft2/profile.rb

@@ -5,7 +5,8 @@ module BnetScraper
       attr_accessor :portrait, :url, :achievement_points, :current_solo_league, 
         :highest_solo_league, :current_team_league, :highest_team_league,
         :career_games, :games_this_season, :terran_swarm_level, :protoss_swarm_level,
-        :zerg_swarm_level, :leagues, :swarm_levels
+        :zerg_swarm_level, :leagues, :swarm_levels, :terran_campaign_completion,
+        :zerg_campaign_completion
 
       def initialize options = {}
         options.each_key do |key|
@@ -40,6 +41,23 @@ module BnetScraper
           terran: @terran_swarm_level
         }
       end
+
+      def campaign_completion
+        {
+          terran: @terran_campaign_completion,
+          zerg: @zerg_campaign_completion
+        }
+      end
+
+      def completed_campaign campaign, difficulty = :normal
+        difficulties = [:unearned, :normal, :hard, :brutal]
+        ranking = campaign_completion[campaign]
+        if difficulties.index(ranking) >= difficulties.index(difficulty)
+          true
+        else
+          false
+        end
+      end
     end
   end
 end

data/lib/bnet_scraper/starcraft2/profile_scraper.rb

@@ -42,84 +42,148 @@ module BnetScraper
       end
 
       def scrape
-        get_profile_data
+        html = retrieve_data
+
+        get_profile_data html
+        get_portrait html
+        get_solo_league_info html
+        get_team_league_info html
+        get_swarm_levels html
+        get_campaign_completion html
         get_league_list
 
         @profile
       end
 
-      # scrapes the profile page for basic account information
-      def get_profile_data
+      # Retrieves the HTML document and feed into Nokogiri
+      #
+      # @return [Nokogiri::HTML] HTML document of Profile
+      def retrieve_data
         response = Faraday.get profile_url
 
         if response.success?
-          html = Nokogiri::HTML(response.body)
-
-          @profile.achievement_points = html.css("#profile-header h3").inner_html()
-          @profile.career_games = html.css(".career-stat-block:nth-child(4) .stat-value").inner_html()
-          @profile.games_this_season = html.css(".career-stat-block:nth-child(5) .stat-value").inner_html()
-
-          get_portrait html
-          get_solo_league_info html
-          get_team_league_info html
-          get_swarm_levels html
+          Nokogiri::HTML(response.body)
         else
           raise BnetScraper::InvalidProfileError
         end
       end
 
+      # Scrapes the Achievement Points, Career Games, and Games this Season from Profile
+      #
+      # @param [Nokogiri::HTML] Profile html object to scrape from
+      def get_profile_data html
+        @profile.achievement_points = html.css("#profile-header h3").inner_html()
+        @profile.career_games = html.css(".career-stat-block:nth-child(4) .stat-value").inner_html()
+        @profile.games_this_season = html.css(".career-stat-block:nth-child(5) .stat-value").inner_html()
+      end
+
+      # Extracts background spritesheet and sprite coordinates to map to a multidimensional 
+      # array of portrait names. The first index is the spritesheet page, the second index 
+      # is the position within the spritesheet
+      #
+      # @param [Nokogiri::XML] html node
+      # @return [String] Portrait name
       def get_portrait html
-        # Portraits use spritemaps, so we extract positions and map to 
-        # PORTRAITS.
         @profile.portrait = begin
-          portrait = html.css("#profile-header #portrait span").attr('style').to_s.scan(/url\('(.*?)'\) ([\-\d]+)px ([\-\d]+)px/).flatten
-          portrait_map, portrait_size = portrait[0].scan(/(\d)\-(\d+)\.jpg/)[0]
-          portrait_position = (((0-portrait[2].to_i) / portrait_size.to_i) * 6) + ((0-portrait[1].to_i) / portrait_size.to_i + 1)
-          PORTRAITS[portrait_map.to_i][portrait_position-1]
+          portrait_info = extract_portrait_info html
+          position = get_portrait_position html, portrait_info
+          PORTRAITS[portrait_info[0].to_i][position-1]
         rescue 
           nil
         end
       end
 
+      # Extracts portrait information (spritesheet page, portsize size, X, Y) from HTML page
+      #
+      # @param [Nokogiri::XML] html node
+      # @return [Fixnum, Fixnum, Fixnum, Fixnum] Array of sprite information
+      def extract_portrait_info html
+        html.css("#portrait .icon-frame").attr('style').to_s.scan(/url\('.+(\d+)-(\d+)\.jpg'\) ([\-\d]+)px ([\-\d]+)px/).flatten
+      end
+
+      # Translates x/y positions of the background spritesheet into an array index. There are
+      # 6 pictures per row, but X/Y is in pixels, so account for portrait size in the incrementor
+      #
+      # @param [Nokogiri::HTML] html node
+      # @param [Fixnum] size of portrait in pixels
+      # @return [Fixnum] index position of portrait spritesheet
+      def get_portrait_position html, portrait_info
+        size = portrait_info[1].to_i
+        x = portrait_info[2].to_i
+        y = portrait_info[3].to_i
+
+        ((-y/size) * 6) + (-x/size + 1)
+      end
+
+      # Extracts the current and highest ever solo league achieved
+      #
+      # @param [Nokogiri::XML] html node
       def get_solo_league_info html
-        if html.css("#best-finish-SOLO div")[0]
-          @profile.highest_solo_league = html.css("#best-finish-SOLO div")[0].children[2].inner_text.strip
-          if html.css("#best-finish-SOLO div")[0].children[8]
-            @profile.current_solo_league = html.css("#best-finish-SOLO div")[0].children[8].inner_text.strip
-          else
-            @profile.current_solo_league = "Not Yet Ranked"
-          end
+        @profile.highest_solo_league = get_highest_league_info :solo, html
+        @profile.current_solo_league = get_current_league_info :solo, html
+      end
+
+      # Extracts the current and highest ever team league achieved
+      #
+      # @param [Nokogiri::XML] html node
+      def get_team_league_info html
+        @profile.highest_team_league = get_highest_league_info :team, html
+        @profile.current_team_league = get_current_league_info :team, html
+      end
+
+      # Extracts the highest league achieved for a given league type
+      #
+      # @param [Symbol] league to be scraped. Values: :solo or :team
+      # @param [Nokogiri::HTML] html ode to scrape
+      # @return [String] League of Ladder
+      def get_highest_league_info league_type, html
+        if div = html.css("#best-finish-#{league_type.upcase} div")[0]
+          div.children[2].inner_text.strip
         else
-          @profile.highest_solo_league = "Not Yet Ranked"
-          @profile.current_solo_league = "Not Yet Ranked"
+          "Not Yet Ranked"
         end
       end
 
-      def get_team_league_info html
-        if html.css("#best-finish-TEAM div")[0] 
-          @profile.highest_team_league = html.css("#best-finish-TEAM div")[0].children[2].inner_text.strip
-          if html.css("#best-finish-TEAM div")[0].children[8]
-            @profile.current_team_league = html.css("#best-finish-TEAM div")[0].children[8].inner_text.strip
-          else
-            @profile.current_team_league = "Not Yet Ranked"
-          end
+      # Extracts the current league achieved for a given league type
+      #
+      # @param [Symbol] league to be scraped. Values: :solo or :team
+      # @param [Nokogiri::HTML] html node to scrape
+      # @return [String] League of Ladder
+      def get_current_league_info league_type, html
+        if div = html.css("#best-finish-#{league_type.upcase} div")[0].children[8]
+          div.inner_text.strip
         else
-          @profile.highest_team_league = "Not Yet Ranked"
-          @profile.current_team_league = "Not Yet Ranked"
+          "Not Yet Ranked"
         end
       end
 
+      # Extracts the HotS Swarm Levels for each race
+      #
+      # @param [Nokogiri::HTML] html node to scrape
       def get_swarm_levels html
         @profile.protoss_swarm_level = get_swarm_level :protoss, html
         @profile.terran_swarm_level = get_swarm_level :terran, html
         @profile.zerg_swarm_level = get_swarm_level :zerg, html
       end
 
+      # Extracts the swarm level for a given race
+      #
+      # @param [Symbol] race to determine the swarm level of
+      # @param [Nokogiri::HTML] html node to scrape from
+      # @return [Fixnum] Swarm Level
       def get_swarm_level race, html
         level = html.css(".race-level-block.#{race} .level-value").inner_html
         level.match(/Level (\d+)/)[1].to_i
       end
 
+      # Extracts completion level of the SC2 Campaigns
+      # 
+      # @param [Nokogiri::HTML] html node to scrape
+      def get_campaign_completion html
+        @profile.terran_campaign_completion = html.css('.campaign-wings-of-liberty .badge')[0].attr('class').split[1].to_sym
+        @profile.zerg_campaign_completion = html.css('.campaign-heart-of-the-swarm .badge')[0].attr('class').split[1].to_sym
+      end
+
       # scrapes the league list from account's league page and sets an array of URLs
       def get_league_list
         response = Faraday.get profile_url + "ladder/leagues"