ProfileScraper now takes a hash of options

ProfileScraper.new takes a hash for parsing.  Among them, :url is
now accepted. If :url is passed, it will dissect the URL into the
relevant information.  Additionally, :bnet_index can now be passed,
which means saving 1-2 HTTP calls to determine the index.

Author: cadwallion

lib/bnet_scraper/starcraft2.rb

@@ -28,7 +28,7 @@ module Starcraft2
     # @return profile_data - Hash containing complete profile and league data
     #   scraped from the website
     def self.full_profile_scrape bnet_id, account, region = 'na'
-      profile_scraper = ProfileScraper.new bnet_id, account, region
+      profile_scraper = ProfileScraper.new bnet_id: bnet_id, account: account, region: region
       profile_output  = profile_scraper.scrape
 
       parsed_leagues = []

lib/bnet_scraper/starcraft2/profile_scraper.rb

@@ -10,22 +10,37 @@ module Starcraft2
     # 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
       attr_reader :bnet_id, :account, :region, :agent, :bnet_index
 
-      # @param bnet_id - The unique ID for each battle.net account. in the URL scheme, it immediately
-      #   follows the /profile/ directive.
-      # @param account - The account name.  This is a non-unique string that immediately follows the
-      #   bnet_index
-      # @oaram region - The region of the account.  This defaults to 'na' for North America. This
-      #   uses the bnet region codes instead of the full names. The region is used to determine the
-      #   domain to find the profile, as well as teh default language code to use.
+      # @param options - Hash of options to parse.
       # @return profile_data - The hash of profile data scraped, including array of leagues to scrape
-      def initialize bnet_id, account, region = 'na'
-        @bnet_id  = bnet_id
-        @account  = account
-        @region   = region
-        set_bnet_index
+      def initialize options = {}
+        if options[:url]
+          extracted_data = options[:url].match(/http:\/\/(.+)\/sc2\/(.+)\/profile\/(.+)\/(\d{1})\/(.+)\//)
+          @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]
+          @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
       end
 
       # set_bnet_index

spec/starcraft2/profile_scraper_spec.rb

@@ -1,22 +1,53 @@
 require 'spec_helper'
 
 describe BnetScraper::Starcraft2::ProfileScraper do
-  subject { BnetScraper::Starcraft2::ProfileScraper.new('2377239', 'Demon') }
+  subject { BnetScraper::Starcraft2::ProfileScraper.new(bnet_id: '2377239', account: 'Demon') }
 
   describe '#initialize' do
-    it 'should take bnet_id and account parameters' do
-      subject.bnet_id.should == '2377239'
-      subject.account.should == 'Demon'
+    context 'when bnet_id and account parameters are passed' do
+      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::ProfileScraper.any_instance.should_receive(:set_bnet_index)
+        scraper = BnetScraper::Starcraft2::ProfileScraper.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::ProfileScraper.any_instance.should_not_receive(:set_bnet_index)
+        scraper = BnetScraper::Starcraft2::ProfileScraper.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::ProfileScraper.any_instance.should_receive(:set_bnet_index)
+        scraper = BnetScraper::Starcraft2::ProfileScraper.new(bnet_id: '2377239', account: 'Demon', region: 'fea')
+      end
     end
 
-    it 'should default the region to na' do
-      subject.region.should == 'na'
-    end
+    context 'when url is passed' do
+      subject { BnetScraper::Starcraft2::ProfileScraper.new(url: 'http://us.battle.net/sc2/en/profile/2377239/1/Demon/') }
+      it 'should extract the bnet_id from the url' do
+        subject.bnet_id.should == '2377239' 
+      end
+
+      it 'should extract the account from the url' do
+        subject.account.should == 'Demon'
+      end
+
+      it 'should extract the region from the url' do
+        subject.region.should == 'na'
+      end
 
-    it 'should assign region if passed' do
-      BnetScraper::Starcraft2::ProfileScraper.any_instance.should_receive(:set_bnet_index)
-      scraper = BnetScraper::Starcraft2::ProfileScraper.new('2377239', 'Demon', 'fea')
-      scraper.region.should == 'fea'
+      it 'should extract the bnet_index from the url' do
+        subject.bnet_index.should == '1'
+      end
     end
   end