sports_data_api 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d8be1761997f03cc4d7aa1b666c29982fbbb2e2
+  data.tar.gz: ae0d4e0bee91e4549235ad79c196fccead66a429
+SHA512:
+  metadata.gz: 1bfc851b3033f99db197871765983dc185aeddba7636e284efb150c3eb3af6eeb83b5000b08a57e3d4bbde38abeec0b3195029646ceced18fd3d307226240d04
+  data.tar.gz: 255550917ad90c562706c64d36d9a01344ce37657db4afeb41e6e30ca045947bd620ef12e625872dcd70512ca0465b573b83f13a25fb9a7cddab31444d2433af

data/.gitignore

@@ -16,6 +16,10 @@ test/tmp
 test/version_tmp
 tmp
 
+# RVM
+.rvmrc
+.ruby-gemset
+
 # YARD artifacts
 .yardoc
 _yardoc
@@ -23,3 +27,6 @@ doc/
 
 # OSX artifacts
 .DS_Store
+
+# RubyMine
+.idea/

data/.ruby-gemset

@@ -0,0 +1 @@
+sports_data_api

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Guardfile

@@ -1,7 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec' do
+guard 'rspec', all_after_pass: true, keep_failed: false do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/README.md

@@ -1,4 +1,4 @@
-# SportsDataApi [![Build Status](https://travis-ci.org/RLovelett/sports_data_api.png?branch=master)](https://travis-ci.org/RLovelett/sports_data_api)
+# SportsDataApi [![Build Status](https://travis-ci.org/RLovelett/sports_data_api.png?branch=master)](https://travis-ci.org/RLovelett/sports_data_api) [![Coverage Status](https://coveralls.io/repos/RLovelett/sports_data_api/badge.png?branch=master)](https://coveralls.io/r/RLovelett/sports_data_api?branch=master)
 
 SportsDataApi is an attempt to make a Ruby interface to the
 [SportsData](http://www.sportsdatallc.com/) API. The goal is to
@@ -21,12 +21,12 @@ log](https://github.com/rlovelett/sports_data_api/issues).
 ## API Support
 
   * [NFL](http://developer.sportsdatallc.com/docs/NFL_API)
+  * [NBA](http://developer.sportsdatallc.com/docs/NBA_API)
   * TODO
     1. [MLB](http://developer.sportsdatallc.com/docs/MLB_API)
     2. [NHL](http://developer.sportsdatallc.com/docs/NHL_API)
-    3. [NBA](http://developer.sportsdatallc.com/docs/NBA_API)
-    4. [NCAA Basketball](http://developer.sportsdatallc.com/docs/NCAA_Mens_Backetball)
-    5. [NCAA Football](http://developer.sportsdatallc.com/docs/NCAA_Football_API)
+    3. [NCAA Basketball](http://developer.sportsdatallc.com/docs/NCAA_Mens_Basketball)
+    4. [NCAA Football](http://developer.sportsdatallc.com/docs/NCAA_Football_API)
 
 ## Installation
 
@@ -46,7 +46,22 @@ Or install it yourself as:
 
 The specs for this Gem should give you some idea of how to make use of
 the API. For now they will be the usage information. As always Pull
-Requests for better documentation are always welcome.
+Requests for better documentation are welcome.
+
+## Testing
+
+The tests for the API have been mocked using [VCR](https://github.com/vcr/vcr) and [WebMock](https://github.com/bblimke/webmock).
+
+Actual calls to the Sports Data LLC have been mocked out to prevent storage of valid API credentials and making
+superflous API calls while testing. As such, in order to generically run the tests (without actually hitting)
+the server the only thing that needs to be done is to run the specs (e.g., `bundle exec rake spec` or
+`bundle exec guard start`).
+
+However, if you want to refresh the actual server API responses you will need to re-record all of the VCR cassettes.
+This can be achieved simply by performing the following two steps:
+
+1. Delete all the cassettes (`rm spec/cassettes/*.yml`)
+2. Run specs passing the API key as environment variable (`SPORTS_DATA_<NBA|NFL>_API_KEY=realapikey bundle exec rake spec`)
 
 ## Contributing
 

data/lib/sports_data_api/exception.rb

@@ -0,0 +1,5 @@
+module SportsDataApi
+  class Exception < ::Exception
+    # To change this template use File | Settings | File Templates.
+  end
+end

data/lib/sports_data_api/mlb/boxscore.rb

@@ -0,0 +1,36 @@
+module SportsDataApi
+  module Mlb
+    class Boxscore
+      VALID_GAME_STATUSES = ['closed', 'inprogress']
+
+      def initialize(xml)
+        self.class.class_eval { attr_reader :"game_state" }
+
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        return unless VALID_GAME_STATUSES.include? xml['status'].to_s.downcase
+
+        boxscore_ivar = self.instance_variable_set("@game_state", {})
+        visitor = xml.xpath("visitor").first
+        boxscore_ivar[:visitor_score] = visitor.attributes["runs"].value
+
+        home = xml.xpath("home").first
+        boxscore_ivar[:home_score] = home.attributes["runs"].value
+        boxscore_ivar[:status] = xml['status'].to_s.downcase
+        if xml['status'] == 'closed'
+          inning = xml.xpath('final').first
+          if inning
+            inning.attributes.each do | attr_name, attr_value|
+              boxscore_ivar[attr_name.to_sym] = attr_value.value
+            end
+          end
+        elsif xml['status'] == 'inprogress'
+          inning = xml.xpath('outcome').first
+          if inning
+            boxscore_ivar[:inning] = inning.attributes['current_inning'].value
+            boxscore_ivar[:inning_half] = inning.attributes['current_inning_half'].value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/broadcast.rb

@@ -0,0 +1,14 @@
+module SportsDataApi
+  module Mlb
+    class Broadcast
+      attr_reader :network, :satellite
+      def initialize(xml)
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        if xml.is_a? Nokogiri::XML::Element
+          @network = xml['network']
+          @satellite = xml['satellite']
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/game.rb

@@ -0,0 +1,30 @@
+module SportsDataApi
+  module Mlb
+    class Game
+      attr_reader :id, :scheduled, :home, :home_team, :away,
+        :away_team, :status, :venue, :broadcast, :year, :season,
+        :date, :quarter, :clock, :rescheduled_reason, :rescheduled_from
+
+      def initialize(args={})
+        xml = args.fetch(:xml)
+        @year = args[:year] ? args[:year].to_i : nil
+
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        if xml.is_a? Nokogiri::XML::Element
+          @id = xml['id']
+          @scheduled = Time.parse(xml.xpath('scheduled_start').children.first.to_s)
+          @home = xml['home']
+          @away = xml['visitor']
+          @status = xml['status']
+          @venue = xml['venue']
+          @broadcast = Broadcast.new(xml.xpath('broadcast'))
+          rescheduled_from = xml.xpath('rescheduled_from')
+          if rescheduled_from.count > 0
+            @rescheduled_reason = rescheduled_from.first['reason']
+            @rescheduled_from = Time.parse(rescheduled_from.first.children.first.to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/game_stat.rb

@@ -0,0 +1,26 @@
+module SportsDataApi
+  module Mlb
+    class GameStat
+      attr_reader :player_id
+      def initialize(xml)
+        if xml.is_a? Nokogiri::XML::Element
+          stat_ivar = self.instance_variable_set("@#{xml.name}", {})
+          self.class.class_eval { attr_reader :"#{xml.name}" }
+
+          xml.attributes.each do | attr_name, attr_value|
+            stat_ivar[attr_name.to_sym] = attr_value.value
+          end
+
+          xml.xpath('.//*').each do |other_stat|
+            if other_stat.is_a? Nokogiri::XML::Element
+              stat_ivar[other_stat.name.to_sym] = {}
+              other_stat.attributes.each do | attr_name, attr_value|
+                stat_ivar[other_stat.name.to_sym][attr_name.to_sym] = attr_value.value
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/game_stats.rb

@@ -0,0 +1,44 @@
+module SportsDataApi
+  module Mlb
+    class GameStats
+      include Enumerable
+
+      def initialize(xml)
+        @stats = {}
+        @stats[:hitting] = []
+        @stats[:pitching] = []
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        @stats[:status] = xml['status']
+        xml.children.each do |child|
+          next unless child.is_a? Nokogiri::XML::Element
+          child.xpath("hitting").xpath("players").xpath("player").each do |player|
+            @stats[:hitting] << GameStat.new(player)
+          end
+
+          child.xpath("pitching").xpath("players").xpath("player").each do |player|
+            @stats[:pitching] << GameStat.new(player)
+          end
+        end
+        @stats
+      end
+
+      def [](search_index)
+        if @stats.has_key?(search_index)
+          @stats[search_index]
+        end
+      end
+
+      ##
+      # Make the class Enumerable
+      def each(&block)
+        @stats.each do |stat|
+          if block_given?
+            block.call stat
+          else
+            yield stat
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/games.rb

@@ -0,0 +1,29 @@
+module SportsDataApi
+  module Mlb
+    class Games
+      include Enumerable
+      attr_reader :games, :year
+
+      def initialize(xml)
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        @year = xml['season_year']
+        @games = []
+        if xml.is_a? Nokogiri::XML::Element
+          xml.xpath('event').each do |event|
+            @games << Game.new(year: @year, xml: event)
+          end
+        end
+      end
+
+      def each &block
+        @games.each do |game|
+          if block_given?
+            block.call game
+          else
+            yield game
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/player.rb

@@ -0,0 +1,17 @@
+module SportsDataApi
+  module Mlb
+    class Player
+      attr_reader :team_id
+      def initialize(xml, team_id)
+        if xml.is_a? Nokogiri::XML::Element
+          player_ivar = self.instance_variable_set("@#{xml.name}", {})
+          self.class.class_eval { attr_reader :"#{xml.name}" }
+          player_ivar[:team_id] = team_id
+          xml.attributes.each do | attr_name, attr_value|
+            player_ivar[attr_name.to_sym] = attr_value.value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/players.rb

@@ -0,0 +1,42 @@
+module SportsDataApi
+  module Mlb
+    class Players
+      include Enumerable
+
+      ##
+      # Initialize by passing the raw XML returned from the API
+      def initialize(xml)
+        @players = []
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        if xml.is_a? Nokogiri::XML::Element
+          xml.xpath('team').each do |team|
+            team.xpath('players').xpath('player').each do |player|
+              p = Player.new(player, team['id'])
+              @players << p
+            end
+          end
+        end
+        @players
+      end
+
+      def [](search_index)
+        found_index = @teams.index(search_index)
+        unless found_index.nil?
+          @teams[found_index]
+        end
+      end
+
+      ##
+      # Make the class Enumerable
+      def each(&block)
+        @players.each do |player|
+          if block_given?
+            block.call player
+          else
+            yield player
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/season.rb

@@ -0,0 +1,18 @@
+module SportsDataApi
+  module Mlb
+    class Season
+      attr_reader :year, :games
+
+      def initialize(xml)
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        @year = xml['season_year']
+        @games = []
+        if xml.is_a? Nokogiri::XML::Element
+          xml.xpath('event').each do |event|
+            @games << Game.new(year: @year, xml: event)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/team.rb

@@ -0,0 +1,35 @@
+module SportsDataApi
+  module Mlb
+    class Team
+      attr_reader :id, :name, :market, :alias, :league, :division
+
+      def initialize(xml)
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        if xml.is_a? Nokogiri::XML::Element
+          @id = xml['id']
+          @name = xml['name']
+          @market = xml['market']
+          @alias = xml['abbr']
+          @league = xml['league']
+          @division = xml['division']
+        end
+      end
+
+      ##
+      # Compare the Team with another team
+      def ==(other)
+        # Must have an id to compare
+        return false if self.id.nil?
+
+        if other.is_a? SportsDataApi::Mlb::Team
+          return false if other.id.nil?
+          self.id === other.id
+        elsif other.is_a? Symbol
+          self.id.to_sym === other
+        else
+          super(other)
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/teams.rb

@@ -0,0 +1,42 @@
+module SportsDataApi
+  module Mlb
+    class Teams
+      include Enumerable
+
+      attr_reader :leagues, :divisions
+
+      ##
+      # Initialize by passing the raw XML returned from the API
+      def initialize(xml)
+        @teams = []
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        if xml.is_a? Nokogiri::XML::Element
+          xml.xpath('//team').each do |team|
+            @teams << Team.new(team) if !team['league'].empty?
+          end
+        end
+
+        @teams
+      end
+
+      def [](search_index)
+        found_index = @teams.index(search_index)
+        unless found_index.nil?
+          @teams[found_index]
+        end
+      end
+
+      ##
+      # Make the class Enumerable
+      def each(&block)
+        @teams.each do |team|
+          if block_given?
+            block.call team
+          else
+            yield team
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/venue.rb

@@ -0,0 +1,15 @@
+module SportsDataApi
+  module Mlb
+    class Venue
+      def initialize(xml)
+        if xml.is_a? Nokogiri::XML::Element
+          venue_ivar = self.instance_variable_set("@#{xml.name}", {})
+          self.class.class_eval { attr_reader :"#{xml.name}" }
+          xml.attributes.each do | attr_name, attr_value|
+            venue_ivar[attr_name.to_sym] = attr_value.value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/mlb/venues.rb

@@ -0,0 +1,37 @@
+module SportsDataApi
+  module Mlb
+    class Venues
+      include Enumerable
+
+      def initialize(xml)
+        @venues = []
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        xml.children.each do |venue|
+          next unless venue.is_a? Nokogiri::XML::Element
+          @venues << Venue.new(venue)
+        end
+        @venues
+      end
+
+      def [](search_index)
+        found_index = @venues.index(search_index)
+        unless found_index.nil?
+          @venues[found_index]
+        end
+      end
+
+      ##
+      # Make the class Enumerable
+      def each(&block)
+        @venues.each do |venue|
+          if block_given?
+            block.call venue
+          else
+            yield venue
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/sports_data_api/mlb.rb

@@ -0,0 +1,82 @@
+module SportsDataApi
+  module Mlb
+
+    class Exception < ::Exception
+    end
+
+    DIR = File.join(File.dirname(__FILE__), 'mlb')
+    BASE_URL = 'http://api.sportsdatallc.org/mlb-%{access_level}%{version}'
+    DEFAULT_VERSION = 4
+    SPORT = :mlb
+
+    autoload :Team, File.join(DIR, 'team')
+    autoload :Teams, File.join(DIR, 'teams')
+    autoload :Player, File.join(DIR, 'player')
+    autoload :Players, File.join(DIR, 'players')
+    autoload :Game, File.join(DIR, 'game')
+    autoload :Games, File.join(DIR, 'games')
+    autoload :Season, File.join(DIR, 'season')
+    autoload :Broadcast, File.join(DIR, 'broadcast')
+    autoload :GameStat, File.join(DIR,'game_stat')
+    autoload :GameStats, File.join(DIR, 'game_stats')
+    autoload :Boxscore, File.join(DIR, 'boxscore')
+    autoload :Venue, File.join(DIR, 'venue')
+    autoload :Venues, File.join(DIR, 'venues')
+
+    ##
+    # Fetches all NBA teams
+    def self.teams(year=Date.today.year, version = DEFAULT_VERSION)
+      response = self.response_xml(version, "/teams/#{year}.xml")
+      return Teams.new(response.xpath('/teams'))
+    end
+
+    ##
+    # Fetches MLB season schedule for a given year and season
+    def self.schedule(year=Date.today.year, version = DEFAULT_VERSION)
+      response = self.response_xml(version, "/schedule/#{year}.xml")
+      return Season.new(response.xpath("calendars"))
+    end
+
+    ##
+    # Fetches MLB daily schedule for a given date
+    def self.daily(year, month, day, version = DEFAULT_VERSION)
+      response = self.response_xml(version, "/daily/schedule/#{year}/#{month}/#{day}.xml")
+      return Games.new(response.xpath("calendars"))
+    end
+
+    ##
+    # Fetches MLB venues
+    def self.venues(version = DEFAULT_VERSION)
+      response = self.response_xml(version, "/venues/venues.xml")
+      return Venues.new(response.xpath("venues"))
+    end
+
+    ##
+    # Fetch MLB game stats
+    def self.game_statistics(event_id, version = DEFAULT_VERSION )
+      response = self.response_xml(version, "/statistics/#{event_id}.xml")
+      return GameStats.new(response.xpath("/statistics"))
+    end
+
+    ##
+    # Fetch MLB Game Boxscore
+    def self.game_boxscore(event_id, version = DEFAULT_VERSION )
+      response = self.response_xml(version, "/boxscore/#{event_id}.xml")
+      return Boxscore.new(response.xpath("/boxscore"))
+    end
+
+    ##
+    # Fetches MLB team roster
+    def self.team_roster(year=Date.today.year, version = DEFAULT_VERSION)
+      response = self.response_xml(version, "/rosters-full/#{year}.xml")
+      return Players.new(response.xpath("rosters"))
+    end
+
+    private
+    def self.response_xml(version, url)
+      base_url = BASE_URL % { access_level: SportsDataApi.access_level(SPORT), version: version }
+      response = SportsDataApi.generic_request("#{base_url}#{url}", SPORT)
+      Nokogiri::XML(response.to_s).remove_namespaces!
+    end
+  end
+end

data/lib/sports_data_api/nba/broadcast.rb

@@ -0,0 +1,14 @@
+module SportsDataApi
+  module Nba
+    class Broadcast
+      attr_reader :network, :satellite
+      def initialize(xml)
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        if xml.is_a? Nokogiri::XML::Element
+          @network = xml['network']
+          @satellite = xml['satellite']
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/nba/game.rb

@@ -0,0 +1,54 @@
+module SportsDataApi
+  module Nba
+    class Game
+      attr_reader :id, :scheduled, :home, :home_team, :away,
+        :away_team, :status, :venue, :broadcast, :year, :season,
+        :date, :quarter, :clock
+
+      def initialize(args={})
+        xml = args.fetch(:xml)
+        @year = args[:year] ? args[:year].to_i : nil
+        @season = args[:season] ? args[:season].to_sym : nil
+        @date = args[:date]
+
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        if xml.is_a? Nokogiri::XML::Element
+          @id = xml['id']
+          @scheduled = Time.parse xml['scheduled']
+          @home = xml['home_team']
+          @away = xml['away_team']
+          @status = xml['status']
+          @clock = xml['clock']
+          @quarter = xml['quarter'] ? xml['quarter'].to_i : nil
+
+          team_xml = xml.xpath('team')
+          @home_team = Team.new(team_xml.first)
+          @away_team = Team.new(team_xml.last)
+          @venue = Venue.new(xml.xpath('venue'))
+          @broadcast = Broadcast.new(xml.xpath('broadcast'))
+        end
+      end
+
+      ##
+      # Wrapper for Nba.game_summary
+      # TODO
+      def summary
+        Nba.game_summary(@id)
+      end
+
+      ##
+      # Wrapper for Nba.pbp (Nba.play_by_play)
+      # TODO
+      def pbp
+        raise NotImplementedError
+      end
+
+      ##
+      # Wrapper for Nba.boxscore
+      # TODO
+      def boxscore
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/sports_data_api/nba/games.rb

@@ -0,0 +1,26 @@
+module SportsDataApi
+  module Nba
+    class Games
+      include Enumerable
+      attr_reader :games, :date
+
+      def initialize(xml)
+        @date = xml.first['date']
+
+        @games = xml.xpath("games/game").map do |game_xml|
+          Game.new(date: @date, xml: game_xml)
+        end
+      end
+
+      def each &block
+        @games.each do |game|
+          if block_given?
+            block.call game
+          else
+            yield game
+          end
+        end
+      end
+    end
+  end
+end