board_game_geek 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.rvmrc
+spec/vcr_cassettes/*

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    board_game_geek (0.0.1)
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    crack (0.3.1)
+    minitest (2.8.0)
+    nokogiri (1.5.0)
+    rake (0.9.2.2)
+    vcr (1.11.3)
+    webmock (1.7.7)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  board_game_geek!
+  minitest
+  rake
+  vcr
+  webmock

data/Rakefile

@@ -0,0 +1,14 @@
+### Gem Development/Management
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+
+### Spec Runner
+require 'rake/testtask'
+Rake::TestTask.new :spec do |t|
+  t.libs << "spec"
+  t.pattern = "spec/*_spec.rb"
+  t.verbose = true
+end
+
+task :default => :spec

data/board_game_geek.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "board_game_geek/version"
+
+Gem::Specification.new do |s|
+  s.name        = "board_game_geek"
+  s.version     = BoardGameGeek::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Loren Norman"]
+  s.email       = ["lorennorman@gmail.com"]
+  s.homepage    = "http://github.com/lorennorman/board_game_geek"
+  s.summary     = %q{BoardGameGeek.com scraper}
+  s.description = %q{We love board games. We love coding. Let's code against the data from BoardGameGeek.com!}
+
+  s.rubyforge_project = "board_game_geek"
+
+  s.add_dependency "nokogiri"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "rake"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  # s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/board_game_geek/version.rb

@@ -0,0 +1,3 @@
+module BoardGameGeek
+  VERSION = "0.0.1"
+end

data/lib/board_game_geek.rb

@@ -0,0 +1,56 @@
+require "bundler/setup"
+require "nokogiri"
+require "open-uri"
+require "ostruct"
+
+module BoardGameGeek
+  class Scraper
+    RANKED_GAMES_URI = 'http://boardgamegeek.com/browse/boardgame/page/'
+    GAMES_PER_PAGE   = 100
+
+    def self.top_games how_many
+      # break total into pages + remainder
+      full_pages, remainder = self.break_down_total(how_many)
+      # accumulate #{pages} calls to bgg
+      # accumulate one more call(#{remainder}) to bgg
+
+      Array.new.tap do |games|
+        (1..(full_pages)).each do |page_number|
+          how_many = GAMES_PER_PAGE
+          how_many = remainder if page_number == full_pages && remainder > 0
+
+          doc = Nokogiri::HTML(open "#{RANKED_GAMES_URI}#{page_number}.html")
+
+          doc.css('table#collectionitems tr').each_with_index do |game_row, idx|
+            next  if idx == 0
+            break if idx > how_many
+
+            cells = game_row.css("td").map(&:inner_text).map(&:strip)
+
+            name_and_date = cells[2].to_s.split("\n")
+
+            ranking      = cells[0]
+            name         = name_and_date[0]
+            release_date = name_and_date[2].to_s.strip[1..-2]
+            rating       = cells[3]
+
+            image_url = game_row.css(".collection_thumbnail img").first["src"]
+            image_url.sub!("_mt", "_t")
+
+            games << OpenStruct.new(name:         name,
+                                    ranking:      ranking,
+                                    rating:       rating,
+                                    release_date: release_date,
+                                    image_url:    image_url)
+          end
+        end
+      end
+    end
+
+    def self.break_down_total total
+      [(total.to_f/GAMES_PER_PAGE).ceil, total%GAMES_PER_PAGE]
+    end
+  end
+end
+
+BGG = BoardGameGeek

data/spec/scraper_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+describe BGG::Scraper do
+  subject { BGG::Scraper }
+
+  after do
+    VCR.eject_cassette
+  end
+
+  describe "breaking a total into pages and remainder" do
+    data = { 1    => [ 1,  1 ],
+             50   => [ 1,  50 ],
+             100  => [ 1,  0 ],
+             101  => [ 2,  1 ],
+             199  => [ 2,  99 ],
+             200  => [ 2,  0 ],
+             201  => [ 3,  1 ],
+             999  => [ 10, 99 ],
+             1000 => [ 10, 0 ],
+             1001 => [ 11, 1 ] }
+
+    data.each do |total, desired_results|
+      pages, remainder = desired_results
+
+      it "breaks a total of #{total} into #{pages} pages and #{remainder} remainder" do
+        final_pages, final_remainder = subject.break_down_total(total)
+        final_pages.must_be :==, pages
+        final_remainder.must_be :==, remainder
+      end
+    end
+  end
+
+  describe "a game record" do
+    before do
+      VCR.insert_cassette('board_game_geek_1')
+    end
+
+    let(:first_game) { subject.top_games(1).first }
+
+    it "exposes some handy attributes" do
+      first_game.must_respond_to :name
+      first_game.must_respond_to :image_url
+      first_game.must_respond_to :rating
+      first_game.must_respond_to :ranking
+      first_game.must_respond_to :release_date
+    end
+
+    it "correctly parses the image source" do
+      first_game.image_url.must_be :==, "http://cf.geekdo-images.com/images/pic361592_t.jpg"
+    end
+  end
+
+  it "gets the top 100 games" do
+    VCR.insert_cassette('board_game_geek_100')
+    subject.top_games(100).length.must_be :==, 100
+  end
+
+  it "gets the top 1000 games" do
+    VCR.insert_cassette('board_game_geek_1000')
+    subject.top_games(1000).length.must_be :==, 1000
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "bundler/setup"
+
+# MiniTest
+require "minitest/autorun"
+# require 'minitest/reporters'
+# MiniTest::Unit.runner = MiniTest::SuiteRunner.new
+# MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new
+
+# VCR
+require "vcr"
+
+VCR.config do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.stub_with :webmock
+end
+
+# System Under Test
+require "board_game_geek"
+
+

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: board_game_geek
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Loren Norman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2153892060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153892060
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2153891500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153891500
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &2153891040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153891040
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2153890620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153890620
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153890200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153890200
+description: We love board games. We love coding. Let's code against the data from
+  BoardGameGeek.com!
+email:
+- lorennorman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- board_game_geek.gemspec
+- lib/board_game_geek.rb
+- lib/board_game_geek/version.rb
+- pkg/board_game_geek-0.0.1.gem
+- spec/scraper_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/lorennorman/board_game_geek
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2103976381804118628
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2103976381804118628
+requirements: []
+rubyforge_project: board_game_geek
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: BoardGameGeek.com scraper
+test_files:
+- spec/scraper_spec.rb
+- spec/spec_helper.rb