boston_marathon 0.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.yardoc
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# gem dependencies are specified in boston_marathon.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    boston_marathon (0.0.1)
+      nokogiri (= 1.5.0)
+      rest-client (= 1.6.7)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    fakeweb (1.3.0)
+    mime-types (1.17.2)
+    nokogiri (1.5.0)
+    redgreen (1.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    shoulda-context (1.0.0)
+    vcr (1.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  boston_marathon!
+  fakeweb (= 1.3.0)
+  redgreen (>= 1.2.2)
+  shoulda-context (~> 1.0.0)
+  vcr (= 1.11.3)

data/README.md

@@ -0,0 +1,99 @@
+Boston Marathon
+===============
+
+A Ruby wrapper for race results from the [2011 Boston Marathon](http://www.baa.org/races/boston-marathon/results-commentary/results-search.aspx).
+Result data is retrieved by parsing HTML documents with [Nokogiri](http://nokogiri.org/),
+so this version of the gem will work as long as the format of the site doesn't change.
+
+Install / Getting Started
+-------------------------
+
+    gem install boston_marathon
+
+Usage
+-----
+
+### Look up an athlete's result by their bib number
+
+    result = BostonMarathon.result(43)
+    result.name      # => 'Krah, Nathan M.'
+    result.time      # => '2:22:24'
+    result.pace      # => '0:05:26'
+    result.place     # => '29'
+
+Like ActiveRecord, a RecordNotFound exception is raised when looking up a bib that has no result.
+
+### Search the results
+
+This method will return a maximum of 25 entries, a limit imposed by the Boston Marathon website.
+To specify a smaller limit, use the VarTargetCount param.
+
+    top_20_women = BostonMarathon.results({'GenderID' => 2, 'VarTargetCount' => 20})
+    top_20_women.each do |result|
+      puts "#{result.gender_place.rjust(2)}. #{result.name}"
+    end
+    
+Query Params for #results
+-------------------------
+
+- BibNumber
+- LastName
+- FirstName
+- GenderID
+- City
+- StateID
+- CountryOfResID
+- ReportingSegmentID
+- QualClassID
+- AwardsDivisionID
+- VarTargetCount
+
+### IDs for genders
+
+    {"1" => "M", "2" => "F"}
+
+### IDs for reporting segments
+
+    {"1" => "Runners", "2" => "Wheelchairs", "3" => "Handcycles"}
+
+### IDs for qualification classes
+
+    {"8" => "Handcycle", "2" => "Mobility Impaired", "4" => "Push Rim Wheelchair Class 1 (Quad)", "5" => "Push Rim Wheelchair Class 2 (Quad)", "6" => "Push Rim Wheelchair Class 3 (Open)", "7" => "Push Rim Wheelchair Class 4 (Open)", "1" => "Visually Impaired (B1, B2, B3)"}
+
+### IDs for awards divisions
+
+    {"1" => "18-39 Age Group", "2" => "40-44 Age Group", "9" => "45-49 Age Group", "3" => "50-54 Age Group", "10" => "55-59 Age Group", "4" => "60-64 Age Group", "11" => "65-69 Age Group", "8" => "70-74 Age Group", "12" => "75-79 Age Group", "13" => "80+ Age Group"}
+
+### IDs for states
+
+    {"5" => "Alabama", "4" => "Alaska", "64" => "Alberta", "8" => "American Samoa", "9" => "Arizona", "7" => "Arkansas", "2" => "Armed Forces Americas", "3" => "Armed Forces Europe", "6" => "Armed Forces Pacific", "65" => "British Columbia", "10" => "California", "11" => "Colorado", "12" => "Connecticut", "14" => "Delaware", "13" => "District Of Columbia", "16" => "Federated States of Micronesia", "15" => "Florida", "17" => "Georgia", "18" => "Guam", "19" => "Hawaii", "21" => "Idaho", "22" => "Illinois", "23" => "Indiana", "20" => "Iowa", "24" => "Kansas", "25" => "Kentucky", "26" => "Louisiana", "29" => "Maine", "67" => "Manitoba", "30" => "Marshall Island", "28" => "Maryland", "27" => "Massachusetts", "31" => "Michigan", "32" => "Minnesota", "35" => "Mississippi", "33" => "Missouri", "36" => "Montana", "39" => "Nebraska", "43" => "Nevada", "68" => "New Brunswick", "40" => "New Hampshire", "41" => "New Jersey", "42" => "New Mexico", "44" => "New York", "66" => "Newfoundland and Labrador", "37" => "North Carolina", "38" => "North Dakota", "34" => "Northern Mariana Islands", "71" => "Northwest Territories", "70" => "Nova Scotia", "77" => "Nunavut", "45" => "Ohio", "46" => "Oklahoma", "72" => "Ontario", "47" => "Oregon", "50" => "Palau", "48" => "Pennsylvania", "73" => "Prince Edward Island", "49" => "Puerto Rico", "74" => "Quebec", "51" => "Rhode Island", "75" => "Saskatchewan", "52" => "South Carolina", "53" => "South Dakota", "54" => "Tennessee", "55" => "Texas", "56" => "Utah", "59" => "Vermont", "58" => "Virgin Islands", "57" => "Virginia", "60" => "Washington", "62" => "West Virginia", "61" => "Wisconsin", "63" => "Wyoming", "76" => "Yukon"}
+
+### IDs for countries
+
+    {"196"=>"Venezuela", "168"=>"Saint Lucia", "54"=>"Djibouti", "25"=>"Belize", "82"=>"Hong Kong", "197"=>"Vietnam", "169"=>"Sao Tome and Principe", "26"=>"Burkina Faso", "110"=>"Luxembourg", "83"=>"Honduras", "55"=>"Dominica", "27"=>"Belarus", "84"=>"Hungary", "140"=>"Oman", "56"=>"Dominican Republic", "28"=>"Bolivia", "112"=>"Madagascar", "85"=>"Indonesia", "141"=>"Pakistan", "113"=>"Morocco", "29"=>"Botswana", "86"=>"India", "57"=>"Ecuador", "170"=>"Saint Vincent and the Grenadines", "142"=>"Palestine", "114"=>"Malaysia", "87"=>"Ireland", "58"=>"Egypt", "171"=>"Sudan", "143"=>"Panama", "115"=>"Malawi", "59"=>"El Salvador", "172"=>"Switzerland", "144"=>"Paraguay", "116"=>"Mexico", "30"=>"Brazil", "88"=>"Islamic Republic of Iran", "200"=>"Yugoslavia", "173"=>"Suriname", "145"=>"Peru", "117"=>"Mongolia", "31"=>"Brunei Darussalam", "89"=>"Iraq", "60"=>"Spain", "174"=>"Slovakia", "146"=>"Philippines", "118"=>"Maldives", "32"=>"Bulgaria", "201"=>"Congo, The Democratic Republic of the", "202"=>"Zambia", "175"=>"Sweden", "147"=>"Poland", "119"=>"Mali", "61"=>"Estonia", "203"=>"Zimbabwe", "176"=>"Swaziland", "148"=>"Portugal", "90"=>"Iceland", "62"=>"Ethiopia", "177"=>"Syrian Arab Republic", "34"=>"British Virgin Islands", "91"=>"Israel", "149"=>"Korea, Democratic People's Republic of", "63"=>"Fiji", "204"=>"Burundi", "178"=>"Tanzania, United Republic of", "35"=>"Central African Republic", "64"=>"Finland", "205"=>"Bosnia and Herzegovina", "179"=>"Thailand", "120"=>"Malta", "2"=>"Afghanistan", "93"=>"Italy", "65"=>"France", "206"=>"Eritrea", "36"=>"Canada", "3"=>"Netherlands Antilles", "94"=>"Jamaica", "37"=>"Cayman Islands", "150"=>"Yemen", "122"=>"Moldova, Republic of", "4"=>"Albania", "95"=>"Jordan", "66"=>"Gabon", "208"=>"Lao People's Democratic Republic", "38"=>"Congo", "209"=>"Slovenia", "151"=>"Qatar", "123"=>"Monaco", "5"=>"Algeria", "96"=>"Japan", "67"=>"Gambia", "39"=>"Chad", "68"=>"United Kingdom", "180"=>"Tajikistan", "124"=>"Mozambique", "97"=>"Kenya", "10"=>"Antigua and Barbuda", "181"=>"Turkmenistan", "153"=>"Romania", "125"=>"Mauritius", "7"=>"Andorra", "98"=>"Kyrgyzstan", "69"=>"Guinea-Bissau", "154"=>"South Africa", "11"=>"Argentina", "40"=>"Chile", "8"=>"Angola", "183"=>"Togo", "155"=>"Russian Federation", "12"=>"Armenia", "210"=>"Macedonia, The Former Yugoslav Republic of", "127"=>"Mauritania", "41"=>"China", "99"=>"Cambodia", "184"=>"Tonga", "211"=>"Taiwan", "156"=>"Rwanda", "128"=>"Myanmar", "13"=>"Aruba", "70"=>"Georgia", "42"=>"Cote d'Ivoire (Ivory Coast)", "212"=>"Serbia and Montenegro", "157"=>"Samoa", "129"=>"Namibia", "14"=>"Australia", "71"=>"Equatorial Guinea", "43"=>"Cook Islands", "186"=>"Trinidad and Tobago", "158"=>"Saudi Arabia", "72"=>"Germany", "15"=>"Austria", "187"=>"Tunisia", "159"=>"Senegal", "100"=>"Korea, Republic of", "73"=>"Ghana", "44"=>"Cameroon", "16"=>"Azerbaijan", "188"=>"Turkey", "101"=>"Kuwait", "45"=>"Colombia", "17"=>"Bahamas", "189"=>"United Arab Emirates", "130"=>"Nauru", "75"=>"Greece", "46"=>"Comoros", "18"=>"Bangladesh", "102"=>"Kazakhstan", "131"=>"Nicaragua", "76"=>"Grenada", "47"=>"Costa Rica", "19"=>"Barbados", "103"=>"Latvia", "160"=>"Seychelles", "132"=>"Netherlands", "48"=>"Croatia", "104"=>"Libyan Arab Jamahiriya", "161"=>"Singapore", "133"=>"Nepal", "77"=>"Guatemala", "49"=>"Cuba", "105"=>"Liberia", "190"=>"Uganda", "162"=>"Sierra Leone", "134"=>"Nigeria", "106"=>"Lesotho", "20"=>"Belgium", "78"=>"Guinea", "191"=>"Ukraine", "163"=>"San Marino", "135"=>"Papua New Guinea", "107"=>"Lebanon", "21"=>"Benin", "192"=>"Uruguay", "164"=>"Solomon Islands", "136"=>"Niger", "50"=>"Cape Verde", "108"=>"Liechtenstein", "193"=>"United States of America", "165"=>"Somalia", "51"=>"Cyprus", "109"=>"Lithuania", "22"=>"Bermuda", "194"=>"Uzbekistan", "166"=>"Sri Lanka", "138"=>"Norway", "52"=>"Czech Republic", "23"=>"Bahrain", "80"=>"Guyana", "195"=>"Vanatu", "167"=>"Saint Kitts and Nevis", "139"=>"New Zealand", "53"=>"Denmark", "24"=>"Bhutan", "81"=>"Haiti"}
+
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2011 John B. Hall
+
+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/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+include Rake::DSL
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/boston_marathon.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "boston_marathon/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'boston_marathon'
+  s.version     = BostonMarathon::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.date        = '2011-11-25'
+  s.summary     = "Ruby wrapper for race results from the 2011 Boston Marathon"
+  s.authors     = ["John B. Hall"]
+  s.email       = 'johnbrianhall@gmail.com'
+  
+  s.add_runtime_dependency 'rest-client', '= 1.6.7'
+  s.add_runtime_dependency 'nokogiri', '= 1.5.0'
+  
+  s.add_development_dependency 'redgreen', ">= 1.2.2"
+  s.add_development_dependency 'vcr', '1.11.3'
+  s.add_development_dependency 'fakeweb', '1.3.0'
+  s.add_development_dependency 'shoulda-context', '~> 1.0.0'
+  
+  s.require_paths = ["lib"]
+  
+  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/boston_marathon/record_not_found.rb

@@ -0,0 +1,7 @@
+module BostonMarathon
+  
+  class RecordNotFound < Exception
+    
+  end
+  
+end

data/lib/boston_marathon/result.rb

@@ -0,0 +1,95 @@
+module BostonMarathon
+  
+  class Result
+    
+    ATTR_TRANSLATE = {
+      'm/f' => 'gender',
+      'st' => 'state',
+      'ctry' => 'country',
+      'ctz' => 'citizenship',
+      'proj. time' => 'projected_time',
+      'offl. time' => 'time',
+      'overall' => 'place',
+      'gender' => 'gender_place',
+      'division' => 'division_place'
+    }
+    
+    attr_reader :attrs
+    
+    def initialize(header, infogrid)
+      @header = header        # athlete bib, name, age, gender, city, state, country
+      @infogrid = infogrid    # splits and finish info (pace, time, place, gender_place, division_place)
+      set_attrs
+    end
+    
+    def method_missing(method, *args)
+      m = method.to_s.downcase
+      if @attrs.has_key? m
+        @attrs[m]
+      else
+        super
+      end
+    end
+    
+    private
+    
+    # ATHLETE
+    
+    def athlete_keys
+      ['Bib', 'Name', 'Age', 'M/F', 'City', 'St', 'Ctry', 'Ctz', '']
+    end
+    
+    def athlete_values
+      cleanse(@header.css('td'))
+    end
+    
+    # RESULT (which contains splits and finish info)
+    
+    def results_rows
+      @results_rows ||= @infogrid.css('tr')
+    end
+    
+    # SPLITS
+    
+    def split_keys
+      cleanse(results_rows[0].css('th')[1..-1])
+    end
+    
+    def split_values
+      cleanse(results_rows[1].css('td'))
+    end
+    
+    # FINISH INFO
+    
+    def finish_info_keys
+      cleanse(results_rows[2].css('th')[1..-1])
+    end
+    
+    def finish_info_values
+      cleanse(results_rows[3].css('td'))
+    end
+    
+    def set_attrs
+      athlete = hashify(athlete_keys, athlete_values)
+      splits = {'splits' => hashify(split_keys, split_values)}
+      finish_info = hashify(finish_info_keys, finish_info_values)
+      @attrs = athlete.merge(splits).merge(finish_info)
+    end
+    
+    # hashify does not belong on the result model. Move it later.
+    # usage: hashify(["dog", "cat"], ["woof", "meow"]) # => {"cat"=>"meow", "dog"=>"woof"}
+    def hashify(keys, values)
+      keys = keys.map(&:downcase).map{ |k| ATTR_TRANSLATE.has_key?(k) ? ATTR_TRANSLATE[k] : k }
+      arr_of_arrs = keys.zip(values).delete_if { |arr| arr[0] == "" }
+      Hash[arr_of_arrs]
+    end
+    
+    # cleanse does not belong on the result model. Move it later.
+    # remove whitespaces and instances of  
+    def cleanse(arr)
+      arr.map{|cell| cell.inner_text.gsub(/\302\240/, ' ').strip}
+    end
+    
+  end
+  
+end

data/lib/boston_marathon/result_set.rb

@@ -0,0 +1,18 @@
+module BostonMarathon
+  
+  class ResultSet < Array
+  
+    def initialize(response)
+      noko = Nokogiri::HTML(response.body)
+      results = []
+      headers = noko.css('.tr_header')
+      infogrids = noko.css('.table_infogrid')
+      unless headers.empty? || infogrids.empty?
+        headers.zip(infogrids).map { |arr| results << Result.new(arr[0], arr[1]) }
+      end
+      replace(results)
+    end
+    
+  end
+
+end

data/lib/boston_marathon/version.rb

@@ -0,0 +1,3 @@
+module BostonMarathon
+  VERSION = '0.0.1'
+end

data/lib/boston_marathon.rb

@@ -0,0 +1,40 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'rest_client'
+require 'nokogiri'
+
+require 'boston_marathon/record_not_found'
+require 'boston_marathon/result_set'
+require 'boston_marathon/result'
+
+module BostonMarathon
+  
+  BASE_URL = "http://registration.baa.org/2011/cf/Public/iframe_ResultsSearch.cfm?mode=results"
+  RESULTS_PER_PAGE = 25 # up to 25 results can be retrieved at a time
+  RACE_CAP = 30000      # an arbitrary number that's larger than the number of race participants
+  
+  class << self
+  
+    # returns the result for a specific bib number
+    def result(bib)
+      result_set = fetch({'BibNumber' => bib})
+      raise BostonMarathon::RecordNotFound if result_set.empty?
+      result_set[0]
+    end
+    
+    # returns a max of RESULTS_PER_PAGE results.
+    # see README for list of query params
+    def results(params)
+      fetch({'VarTargetCount' => RACE_CAP}.merge params)
+    end
+    
+    private
+    
+    def fetch(params={})
+      response = RestClient.post BASE_URL, params
+      BostonMarathon::ResultSet.new(response)
+    end
+  
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+# I know it's bad to require rubygems, but I haven't yet figured out how to get around it
+require 'rubygems'
+require 'test/unit'
+require 'redgreen'
+require 'vcr'
+require 'fakeweb'
+require 'shoulda-context'
+require 'boston_marathon'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'test/vcr_cassettes'
+  c.stub_with :fakeweb
+  c.default_cassette_options = { :record => :once }
+end

data/test/test_boston_marathon.rb

@@ -0,0 +1,97 @@
+require 'test/helper'
+
+class TestBostonMarathon < Test::Unit::TestCase
+  
+  context "when looking up a result by an INVALID bib number" do
+    
+    should "raise a RecordNotFound exception" do
+      assert_raise BostonMarathon::RecordNotFound do
+        VCR.use_cassette('bad_bib') do
+          @result = BostonMarathon.result('a')
+        end
+      end
+    end
+    
+  end
+  
+  context "when looking up a result by a VALID bib number" do
+    
+    setup do
+      VCR.use_cassette('bib_43') do
+        @result = BostonMarathon.result(43)
+      end
+    end
+    
+    should "have the correct athlete attributes" do
+      expected = ['43', 'Krah, Nathan M.', '25', 'M', 'Boston', 'MA', 'USA']
+      tested = [@result.bib, @result.name, @result.age, @result.gender, @result.city, @result.state, @result.country]
+      assert_equal expected, tested
+    end
+    
+    should "have the correct splits" do
+      expected = {
+        '5k'  => '0:16:40',
+        '10k' => '0:33:24',
+        '15k' => '0:50:03',
+        '20k' => '1:06:46',
+        'half' => '1:10:25',
+        '25k' => '1:23:42',
+        '30k' => '1:40:39',
+        '35k' => '1:57:52',
+        '40k' => '2:14:53'
+      }
+      assert_equal expected, @result.splits
+    end
+    
+    should "have the correct finish info" do
+      expected = ['0:05:26', '', '2:22:24', '29', '29', '25']
+      tested = [@result.pace, @result.projected_time, @result.time, @result.place, @result.gender_place, @result.division_place]
+      assert_equal expected, tested
+    end
+    
+  end
+  
+  context "when searching for" do
+    
+    context "the top 20 women" do
+      
+      setup do
+        VCR.use_cassette('top_20_women') do
+          @results = BostonMarathon.results({'GenderID' => 2, 'VarTargetCount' => 20})
+        end
+      end
+      
+      should "return the results of the 20 fastest female runners" do
+        assert_equal 20, @results.length
+        assert_equal ["F"], @results.map(&:gender).uniq
+      end
+      
+    end
+    
+    context "someone matching very specific attributes" do
+      
+      setup do
+        VCR.use_cassette('ryan_hall') do
+          @results = BostonMarathon.results({
+            'BibNumber' => 3,
+            'LastName' => 'Hall',
+            'FirstName' => 'Ryan',
+            'ReportingSegmentId' => 1,
+            'GenderID' => 1,
+            'City' => 'Mammoth Lakes',
+            'StateID' => '10',
+            'CountryOfResID' => 193
+          })
+        end
+      end
+      
+      should "return the athlete we're looking for" do
+        assert_equal 1, @results.length
+        assert_equal "Hall, Ryan", @results[0].name
+      end
+      
+    end
+    
+  end
+  
+end