yahoo_sports 0.1.0 → 0.2.0

data/Rakefile

@@ -26,3 +26,7 @@ Rake::TestTask.new("test") { |t|
     t.verbose = false
     t.warning = false
 }
+
+require "yard"
+YARD::Rake::YardocTask.new("docs") do |t|
+end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/yahoo_sports/base.rb

@@ -15,12 +15,29 @@ require 'htmlentities'
 
 module YahooSports
 
-# little helper method i wrote to retry the fetch a few times
+# Fetches the given URL and returns the body
+#
+# @param [String] URL
+# @return [String] contents of response body
 def self.fetchurl(url)
     #puts "FETCHING #{url}"
     return Net::HTTP.get_response(URI.parse(URI.escape(url))).body    
 end
 
+# Strip HTML tags from the given string. Also performs some common entity
+# substitutions. 
+#
+# List of entity codes:
+# *  
+# * &
+# * "
+# * <
+# * >
+# * &ellip;
+# * '
+#
+# @param [String] html text to be filtered
+# @return [String] original string with HTML tags filtered out and entities replaced
 def self.strip_tags(html)
 		
     HTMLEntities.new.decode(
@@ -39,7 +56,28 @@ end
 
 class Base
 
-    def self.get_homepage_games(sport, state = '')
+    # Get the scoreboard games for the given sport. Includes recently completed,
+    # live and upcoming games.
+    #
+    # Source: http://sports.yahoo.com/<sport>
+    # 
+    # Game struct has the following keys: 
+    #   game.date   # date of game; includes time if preview
+    #   game.team1  # visiting team
+    #   game.team2  # home team
+    #   game.score1 # team1's score, if live or final
+    #   game.score2 # team2's score, if live or final
+    #   game.state  # live, final or preview
+    #   game.tv     # TV station showing the game, if preview and available
+    #
+    # Example:
+    #   #<OpenStruct state="final", score1="34", date=Thu Nov 26 00:00:00 -0500 2009, score2="12", team1="Green Bay", team2="Detroit">
+    #        
+    #
+    # @param [String] sport         sport to list, can be one of ["mlb", "nba", "nfl", "nhl"]
+    # @param [String] state         Optionally filter for the given state ("live", "final", or "preview")
+    # @return [Array<OpenStruct>] list of games
+    def self.get_homepage_games(sport, state = "")
 
         sport.downcase!
         if sport !~ /^(nba|nhl|nfl|mlb)$/ then
@@ -94,25 +132,27 @@ class Base
         games_temp.each { |g|
         
             gm = OpenStruct.new
-            gm.status = g.status.strip if g.status
             gm.team1 = g.teams[0].strip if g.teams[0]
             gm.team2 = g.teams[1].strip if g.teams[1]
             gm.score1 = g.scores[0].strip if g.scores[0]
             gm.score2 = g.scores[1].strip if g.scores[1]
-                                 
-            if sport == 'mlb' then
-                gm.date = Time.parse(Time.new.strftime('%Y') + g.date_src[2,4])
-            else
-                gm.date = Time.parse(g.date_src[0,8])
-            end
-            
+
             if g.class_src.include? ' ' then
                 gm.state = g.class_src[ g.class_src.index(' ')+1, g.class_src.length ].strip
             else
                 gm.state = g.class_src.strip
             end
             
-            gm.extra = $1 if g.extra_src =~ /TV: (.*)/
+            gm.tv = $1 if g.extra_src =~ /TV: (.*)/
+
+            status = g.status.strip if g.status
+            time_str = (gm.state == "preview" ? " #{status}" : "")
+                                 
+            if sport == 'mlb' then
+                gm.date = Time.parse(Time.new.strftime('%Y') + g.date_src[2,4] + time_str)
+            else
+                gm.date = Time.parse(g.date_src[0,8] + time_str)
+            end
             
             next if not state.empty? and state != gm.state
             games << gm
@@ -123,6 +163,28 @@ class Base
     
     end
     
+    # Retrieves team information for the team in the given sport
+    #
+    # Source: http://sports.yahoo.com/<sport>/teams/<team>
+    #
+    # Team struct has the following keys:
+    #   team.name       # full team name
+    #   team.standing   # current standing
+    #   team.position   # position in the conference
+    #   team.last5      # previous games results
+    #   team.next5      # upcoming scheduled games
+    #   team.live       # struct describing in-progress game, if available
+    #
+    #
+    # Games in the last5 and next5 lists have the following keys:
+    #   game.date       # date of game
+    #   game.team       # full team name
+    #   game.status     # score for completed games (e.g. "L 20 - 23") or "preview"
+    #   game.away       # boolean value indicating an away game
+    #
+    # @param [String] sport         sport to list, can be one of ["mlb", "nba", "nfl", "nhl"]
+    # @param [String] str           3-letter team code or partial team name
+    # @return [OpenStruct] team info
     def self.get_team_stats(sport, str)
         
         sport.downcase!
@@ -173,8 +235,7 @@ class Base
         info.position = info_temp.position        
         return info        
     end
-    
-    
+        
     def self.get_scores_and_schedule(html)
 
         last5 = []
@@ -197,13 +258,15 @@ class Base
         return [last5, next5] if games_temp.nil?
                 
         bye = false # bye week support for nfl
+        bye_added = false # help us put it in the right place (hopefully)
         
         games_temp.games.each_index { |i|
             
             info = games_temp.games[i].split("\n").slice(1, 3)
             if info[0] == "Bye"
+                # team is in a bye week
                 bye = true
-                team = nil
+                next
             else
                 t = (bye ? i - 1 : i)
                 team = games_temp.teams[t].strip
@@ -211,32 +274,35 @@ class Base
             
             gm = OpenStruct.new
             
-            if bye then
-                # team is in a bye week
-                gm.bye = true
-                next5 << gm
-                next
-            end
-            
-            date = Time.parse(info[0])
             info[1] =~ /(\([\d-]+\))/
             record = $1
             status = info[2]
             
-            gm.date = date
-            gm.team = "#{team} #{record}"
-            gm.status = status
+            preview = (status !~ /^(W|L)/)
+            date_str = (preview ? "#{info[0]} #{status}" : info[0])
+            gm.date = Time.parse(date_str) 
+            
+            gm.team = "#{team} #{record}".strip
+            gm.status = (preview ? "preview" : status)
 
-            if info[1] =~ / at / then
-                gm.away = 1
-            else
-                gm.away = 0
-            end
+            gm.away = (info[1] =~ / at / ? true : false)
                         
-            if gm.status =~ /^(W|L)/
-                last5 << gm 
+            if preview then
+                if bye and not bye_added then
+                    gmb = OpenStruct.new
+                    gmb.bye = true
+                    next5 << gmb
+                    bye_added = true
+                end
+                next5 << gm 
             else
-                next5 << gm
+                if bye and not bye_added then
+                    gmb = OpenStruct.new
+                    gmb.bye = true
+                    last5 << gmb
+                    bye_added = true
+                end
+                last5 << gm
             end
             
         }

data/lib/yahoo_sports/mlb.rb

@@ -3,10 +3,48 @@ module YahooSports
 
 class MLB < Base
 
+    # Get the MLB scoreboard games. Includes recently completed,
+    # live and upcoming games.
+    #
+    # Source: http://sports.yahoo.com/mlb
+    # 
+    # Game struct has the following keys: 
+    #   game.date   # date of game; includes time if preview
+    #   game.team1  # visiting team
+    #   game.team2  # home team
+    #   game.score1 # team1's score, if live or final
+    #   game.score2 # team2's score, if live or final
+    #   game.state  # live, final or preview
+    #   game.tv     # TV station showing the game, if preview and available
+    #        
+    #
+    # @param [String] state         Optionally filter for the given state ("live", "final", or "preview")
+    # @return [Array<OpenStruct>] list of games
     def self.get_homepage_games(state = "")
         super("mlb", state)
     end
     
+    # Retrieves team information for the team
+    #
+    # Source: http://sports.yahoo.com/mlb/teams/<team>
+    #
+    # Team struct has the following keys:
+    #   team.name       # full team name
+    #   team.standing   # current standing
+    #   team.position   # position in the conference
+    #   team.last5      # previous games results
+    #   team.next5      # upcoming scheduled games
+    #   team.live       # struct describing in-progress game, if available
+    #
+    #
+    # Games in the last5 and next5 lists have the following keys:
+    #   game.date       # date of game
+    #   game.team       # full team name
+    #   game.status     # score for completed games (e.g. "L 20 - 23")
+    #   game.away       # boolean value indicating an away game
+    #
+    # @param [String] str           3-letter team code or partial team name
+    # @return [OpenStruct] team info
     def self.get_team_stats(str)
         super("mlb", str)
     end

data/lib/yahoo_sports/nba.rb

@@ -2,11 +2,49 @@
 module YahooSports
 
 class NBA < Base
-
+    
+    # Get the NBA scoreboard games. Includes recently completed,
+    # live and upcoming games.
+    #
+    # Source: http://sports.yahoo.com/nba
+    # 
+    # Game struct has the following keys: 
+    #   game.date   # date of game; includes time if preview
+    #   game.team1  # visiting team
+    #   game.team2  # home team
+    #   game.score1 # team1's score, if live or final
+    #   game.score2 # team2's score, if live or final
+    #   game.state  # live, final or preview
+    #   game.tv     # TV station showing the game, if preview and available
+    #        
+    #
+    # @param [String] state         Optionally filter for the given state ("live", "final", or "preview")
+    # @return [Array<OpenStruct>] list of games
     def self.get_homepage_games(state = "")
         super("nba", state)
     end
     
+    # Retrieves team information for the team
+    #
+    # Source: http://sports.yahoo.com/nba/teams/<team>
+    #
+    # Team struct has the following keys:
+    #   team.name       # full team name
+    #   team.standing   # current standing
+    #   team.position   # position in the conference
+    #   team.last5      # previous games results
+    #   team.next5      # upcoming scheduled games
+    #   team.live       # struct describing in-progress game, if available
+    #
+    #
+    # Games in the last5 and next5 lists have the following keys:
+    #   game.date       # date of game
+    #   game.team       # full team name
+    #   game.status     # score for completed games (e.g. "L 20 - 23")
+    #   game.away       # boolean value indicating an away game
+    #
+    # @param [String] str           3-letter team code or partial team name
+    # @return [OpenStruct] team info
     def self.get_team_stats(str)
         super("nba", str)
     end

data/lib/yahoo_sports/nfl.rb

@@ -3,10 +3,48 @@ module YahooSports
 
 class NFL < Base
 
+    # Get the NFL scoreboard games. Includes recently completed,
+    # live and upcoming games.
+    #
+    # Source: http://sports.yahoo.com/nfl
+    # 
+    # Game struct has the following keys: 
+    #   game.date   # date of game; includes time if preview
+    #   game.team1  # visiting team
+    #   game.team2  # home team
+    #   game.score1 # team1's score, if live or final
+    #   game.score2 # team2's score, if live or final
+    #   game.state  # live, final or preview
+    #   game.tv     # TV station showing the game, if preview and available
+    #        
+    #
+    # @param [String] state         Optionally filter for the given state ("live", "final", or "preview")
+    # @return [Array<OpenStruct>] list of games
     def self.get_homepage_games(state = "")
-        return super("nfl", state)
+        super("nfl", state)
     end
     
+    # Retrieves team information for the team
+    #
+    # Source: http://sports.yahoo.com/nfl/teams/<team>
+    #
+    # Team struct has the following keys:
+    #   team.name       # full team name
+    #   team.standing   # current standing
+    #   team.position   # position in the conference
+    #   team.last5      # previous games results
+    #   team.next5      # upcoming scheduled games
+    #   team.live       # struct describing in-progress game, if available
+    #
+    #
+    # Games in the last5 and next5 lists have the following keys:
+    #   game.date       # date of game
+    #   game.team       # full team name
+    #   game.status     # score for completed games (e.g. "L 20 - 23")
+    #   game.away       # boolean value indicating an away game
+    #
+    # @param [String] str           3-letter team code or partial team name
+    # @return [OpenStruct] team info
     def self.get_team_stats(str)
         super("nfl", str)
     end

data/lib/yahoo_sports/nhl.rb

@@ -3,10 +3,48 @@ module YahooSports
 
 class NHL < Base
 
+    # Get the NHL scoreboard games. Includes recently completed,
+    # live and upcoming games.
+    #
+    # Source: http://sports.yahoo.com/nhl
+    # 
+    # Game struct has the following keys: 
+    #   game.date   # date of game; includes time if preview
+    #   game.team1  # visiting team
+    #   game.team2  # home team
+    #   game.score1 # team1's score, if live or final
+    #   game.score2 # team2's score, if live or final
+    #   game.state  # live, final or preview
+    #   game.tv     # TV station showing the game, if preview and available
+    #        
+    #
+    # @param [String] state         Optionally filter for the given state ("live", "final", or "preview")
+    # @return [Array<OpenStruct>] list of games
     def self.get_homepage_games(state = "")
         super("nhl", state)
     end
     
+    # Retrieves team information for the team
+    #
+    # Source: http://sports.yahoo.com/nhl/teams/<team>
+    #
+    # Team struct has the following keys:
+    #   team.name       # full team name
+    #   team.standing   # current standing
+    #   team.position   # position in the conference
+    #   team.last5      # previous games results
+    #   team.next5      # upcoming scheduled games
+    #   team.live       # struct describing in-progress game, if available
+    #
+    #
+    # Games in the last5 and next5 lists have the following keys:
+    #   game.date       # date of game
+    #   game.team       # full team name
+    #   game.status     # score for completed games (e.g. "L 20 - 23")
+    #   game.away       # boolean value indicating an away game
+    #
+    # @param [String] str           3-letter team code or partial team name
+    # @return [OpenStruct] team info
     def self.get_team_stats(str)
         super("nhl", str)
     end

data/yahoo_sports.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{yahoo_sports}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chetan Sarva"]
-  s.date = %q{2009-11-18}
+  s.date = %q{2009-11-30}
   s.description = %q{Ruby library for parsing stats from Yahoo! Sports pages. Currently supports MLB, NBA, NFL and NHL stats and info.}
   s.email = %q{chetan@pixelcop.net}
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yahoo_sports
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Chetan Sarva
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-18 00:00:00 -05:00
+date: 2009-11-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency