sc2_achievements 0.1.0

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem "nokogiri"
+
+group :development do
+  gem "rspec"
+  gem "vcr"
+  gem "webmock"
+  gem "bundler"
+  gem "jeweler"
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.4)
+    nokogiri (1.5.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    vcr (2.2.5)
+    webmock (1.8.10)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler
+  nokogiri
+  rspec
+  vcr
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+Starcraft II Achievements
+=========================
+
+Download all the achievements of a SC2 player.
+
+This library downloads all the achievements from a player's public profile,
+extracts the relevant data and then convert it all to an array, with the
+most recent earned achievement first and then ordered by date.
+
+I'm planning to use this as a part of a bigger system, so that's why I haven't
+built-in some sort of cache.
+
+## INSTALLATION
+
+Everything is nicely packed as a gem, so all you have to do is:
+
+```
+$ gem install sc2_achievements
+```
+
+## USAGE
+
+```
+>> require 'sc2_achievements'
+=> true
+>> achievements = SC2Achievements.for('/3396700/1/Tato')
+=> [{:date=>"2012-09-20", :points=>10, :title=>"That\342\200\231s Teamwork", ... }]
+```
+
+## TODO
+
+I've opened a couple of tickets with some stuff that needs to be done, in case
+anyone wanna help out.
+
+## CONTRIBUTE
+
+1. Fork it.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Added some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new pull request.
+
+## COPYRIGHT
+
+Copyright (c) 2012 Eduardo Grajeda Blandón. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "sc2_achievements"
+  gem.homepage = "http://github.com/egrajeda/sc2_achievements"
+  gem.license = "MIT"
+  gem.summary = %Q{Download all the achievements of a SC2 player.}
+  gem.description = %Q{This library downloads all the achievements from a Starcraft II player's public profile and package them as an array.}
+  gem.email = "tatofoo@gmail.com"
+  gem.authors = ["Eduardo Grajeda Blandón"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sc2_achievements #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/sc2_achievements/category_page.rb

@@ -0,0 +1,60 @@
+require 'sc2_achievements/page'
+
+module SC2Achievements
+  class CategoryPage < Page
+    def self.get_achievements_for(user_path, category)
+      page = fetch_page_of user_path, :category => category
+      page.css('.achievement.earned', '.series-tiles .series-tile:not(.tile-locked)').inject({}) do |achievements, achievement|
+        achievements[key_for(achievement)] = {
+          :title       => title_of(achievement),
+          :description => description_of(achievement),
+          :category    => category_of(achievement),
+          :points      => points_of(achievement),
+          :date        => date_of(achievement) }
+        achievements
+      end
+    end
+
+  private
+    # See Homepage.key_for
+    def self.key_for(achievement)
+      title_of(achievement)
+    end
+
+    def self.title_of(achievement)
+      if achievement.attr('class') =~ /series-tile/
+        text_of(achievement, achievement.attr('data-tooltip') + ' .tooltip-title')
+      else
+        text_of(achievement, '.desc span')
+      end
+    end
+
+    def self.description_of(achievement)
+      if achievement.attr('class') =~ /series-tile/
+        text_of(achievement, achievement.attr('data-tooltip'))
+      else
+        text_of(achievement, '.desc')
+      end
+    end
+
+    def self.category_of(achievement)
+      wrapper = achievement.ancestors('#profile-wrapper')
+      text_of(wrapper, '#profile-menu .active a')
+    end
+
+    def self.points_of(achievement)
+      if achievement.attr('class') =~ /series-tile/
+        text_of(achievement, '.series-badge').to_i
+      else
+        text_of(achievement, '.meta span').to_i
+      end
+    end
+
+    def self.date_of(achievement)
+      if achievement.attr('class') =~ /series-tile/
+        achievement = achievement.ancestors('.achievement')
+      end
+      date_from(achievement, '.meta')
+    end
+  end
+end

data/lib/sc2_achievements/homepage.rb

@@ -0,0 +1,36 @@
+require 'date'
+require 'sc2_achievements/page'
+
+module SC2Achievements
+  class Homepage < Page
+    def self.get_achievements_for(user_path)
+      page = fetch_page_of user_path
+      page.css('#recent-achievements a').each_with_index.inject({}) do |achievements, (achievement, index)|
+        achievements[key_for(achievement)] = {
+          :title       => title_of(achievement),
+          :description => description_of(achievement),
+          :date        => date_of(achievement),
+          :recentness  => index + 1 }
+        achievements
+      end
+    end
+
+  private
+    # TODO: in the future we might use a real ID, checksum, etc.
+    def self.key_for(achievement)
+      title_of(achievement)
+    end
+
+    def self.title_of(achievement)
+      text_of(achievement)
+    end
+
+    def self.description_of(achievement)
+      text_of(achievement.parent, achievement.attr('data-tooltip'))
+    end
+
+    def self.date_of(achievement)
+      date_from(achievement, 'span')
+    end
+  end
+end

data/lib/sc2_achievements/page.rb

@@ -0,0 +1,67 @@
+require 'open-uri'
+begin
+  require 'nokogiri'
+rescue LoadError
+  require 'rubygems'
+  require 'nokogiri'
+end
+
+module SC2Achievements
+  class Page
+    def self.get_achievements_for(user_path, options = {})
+      if options.has_key? :category
+        CategoryPage.get_achievements_for user_path, options[:category]
+      else
+        Homepage.get_achievements_for user_path
+      end
+    end
+
+    def self.get_categories_for(user_path, options = {})
+      page = fetch_page_of user_path, options
+      page.css('#profile-menu a[href*=category]').collect do |achievement|
+        achievement.attr('href')[/category\/(.*)/, 1]
+      end
+    end
+
+  protected
+    def self.fetch_page_of(user_path, options = {})
+      path = path_for user_path, options
+      if cache_exists? path
+        page = @@cache[path]
+      else
+        page = fetch_page path
+      end
+      @@cache[path] = page
+    end
+
+    def self.cache_exists?(path)
+      @@cache ||= {}
+      @@cache.has_key? path
+    end
+
+    def self.fetch_page(path)
+      html = open(path).read
+      Nokogiri::HTML(html)
+    end
+
+    def self.path_for(user_path, options = {})
+      if options.has_key? :category
+        "http://battle.net/sc2/en/profile#{user_path}/achievements/category/#{options[:category]}"
+      else
+        "http://battle.net/sc2/en/profile#{user_path}/achievements/"
+      end
+    end
+
+    def self.text_of(current_node, css_selector=nil)
+      if css_selector
+        current_node = current_node.css(css_selector)
+      end
+      current_node.xpath('text()').text.strip
+    end
+
+    def self.date_from(current_node, css_selector=nil)
+      date = text_of(current_node, css_selector)
+      Date.strptime(date, '%m/%d/%Y').strftime('%Y-%m-%d')
+    end
+  end
+end

data/lib/sc2_achievements.rb

@@ -0,0 +1,32 @@
+require 'sc2_achievements/homepage'
+require 'sc2_achievements/category_page'
+
+module SC2Achievements
+  def self.for(user_path)
+    achievements = get_achievements_for user_path
+    achievements.sort_by do |title, achievement|
+      [achievement[:date], -(achievement[:recentness] || 7)]
+    end.reverse.collect do |title, achievement|
+      achievement.delete :recentness
+      achievement
+    end
+  end
+
+private
+  def self.get_achievements_for(user_path)
+    achievements = Page.get_achievements_for user_path
+    Page.get_categories_for(user_path).inject(achievements) do |achievements, category|
+      add_subcategories_achievements_to(achievements, user_path, category)
+    end
+  end
+
+  def self.add_subcategories_achievements_to(achievements, user_path, category)
+    Page.get_categories_for(user_path, :category => category).inject(achievements) do |achievements, category|
+      category_achievements = Page.get_achievements_for(user_path, :category => category)
+      achievements.merge(category_achievements) do |title, old_achievement, new_achievement|
+        old_achievement.merge(new_achievement)
+      end
+    end
+  end
+
+end