sports_data_api 0.0.1

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# OSX artifacts
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@sports-data"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.11 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sports_data_api.gemspec
+gemspec

data/Guardfile

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

data/LICENSE.md

@@ -0,0 +1,24 @@
+
+Copyright (c) 2012 Ryan Lovelett ( [@rlovelett](http://twitter.com/#!/rlovelett) )
+=================================================================================================
+
+The "SportsDataApi" RubyGem is released under the **MIT LICENSE**
+----------------------------------------------------------
+
+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,57 @@
+# SportsDataApi [![Build Status](https://travis-ci.org/RLovelett/sports_data_api.png?branch=master)](https://travis-ci.org/RLovelett/sports_data_api)
+
+SportsDataApi is an attempt to make a Ruby interface to the
+[SportsData](http://www.sportsdatallc.com/) API. The goal is to
+eventaully support the full API. Pull requests that extend the API
+support are always welcome.
+
+[SportsData](http://www.sportsdatallc.com/)’s comprehensive data coverage includes all major U.S. sports,
+plus hundreds of leagues throughout the world. Their live game analysts
+capture every possible event of every game, in real time and with
+accuracy standards developed from years of experience.
+
+## Author
+
+[Ryan Lovelett](http://ryan.lovelett.me/) ( [@rlovelett](http://twitter.com/#!/rlovelett) )
+
+Drop me a message for any questions, suggestions, requests, bugs or
+submit them to the [issue
+log](https://github.com/rlovelett/sports_data_api/issues).
+
+## API Support
+
+  * [NFL](http://developer.sportsdatallc.com/docs/NFL_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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sports_data_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sports_data_api
+
+## Usage
+
+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.
+
+## Contributing
+
+1. Fork it
+2. Create a topic branch (`git checkout -b topic`)
+3. Make your changes
+4. Squash your changes into one commit
+5. Create new Pull Request against this squashed commit

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/nfl.rb

@@ -0,0 +1,90 @@
+module SportsDataApi
+  module Nfl
+
+    class Exception < ::Exception
+    end
+
+    class Season
+      attr_reader :year, :type, :weeks
+
+      def initialize(xml)
+        @weeks = []
+        if xml.is_a? Nokogiri::XML::NodeSet
+          @year = xml.first["season"].to_i
+          @type = xml.first["type"].to_sym
+          @weeks = xml.first.xpath("week").map do |week_xml|
+            Week.new(week_xml)
+          end
+        end
+      end
+    end
+
+    class Week
+      attr_reader :number, :games
+
+      def initialize(xml)
+        @games = []
+        if xml.is_a? Nokogiri::XML::Element
+          @number = xml["week"].to_i
+          @games = xml.xpath("game").map do |game_xml|
+            Game.new(game_xml)
+          end
+        end
+      end
+    end
+
+    class Game
+      attr_reader :id, :scheduled, :home, :away, :status
+
+      def initialize(xml)
+        if xml.is_a? Nokogiri::XML::Element
+          @id = xml["id"]
+          @scheduled = Time.parse xml["scheduled"]
+          @home = xml["home"]
+          @away = xml["away"]
+          @status = xml["status"]
+        end
+      end
+    end
+
+    BASE_URL = "http://api.sportsdatallc.org/nfl-%{access_level}%{version}"
+    SEASONS = [:PRE, :REG, :PST]
+
+    def self.schedule(year, season, version = 1)
+      base_url = BASE_URL % { access_level: SportsDataApi.access_level, version: version }
+      season = season.to_s.upcase.to_sym
+      raise SportsDataApi::Nfl::Exception.new("#{season} is not a valid season") unless season?(season)
+      url = "#{base_url}/#{year}/#{season}/schedule.xml"
+
+      begin
+        # Perform the request
+        response = RestClient.get(url, params: { api_key: SportsDataApi.key })
+
+        # Load the XML and ignore namespaces in Nokogiri
+        schedule = Nokogiri::XML(response.to_s)
+        schedule.remove_namespaces!
+
+        return Season.new(schedule.xpath("/season"))
+      rescue RestClient::Exception => e
+        message = if e.response.headers.key? :x_server_error
+                    JSON.parse(error_json, { symbolize_names: true })[:message]
+                  elsif e.response.headers.key? :x_mashery_error_code
+                    e.response.headers[:x_mashery_error_code]
+                  else
+                    "The server did not specify a message"
+                  end
+        raise SportsDataApi::Exception, message
+      end
+    end
+
+    ##
+    # Check if the requested season is a valid
+    # NFL season type.
+    #
+    # The only valid types are: :PRE, :REG, :PST
+    def self.season?(season)
+      SEASONS.include?(season)
+    end
+
+  end
+end

data/lib/sports_data_api/version.rb

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

data/lib/sports_data_api.rb

@@ -0,0 +1,18 @@
+require "sports_data_api/version"
+require "nokogiri"
+require "rest_client"
+require "time"
+
+module SportsDataApi
+  def self.key
+    "garbage"
+  end
+
+  def self.access_level
+    "t"
+  end
+
+  autoload :Nfl, File.join(File.dirname(__FILE__), 'nfl')
+
+  class Exception < ::Exception; end
+end

data/spec/lib/nfl_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe SportsDataApi::Nfl do
+  let(:key) { "1234567890abcdef" }
+  describe ".schedule" do
+    it "creates a valid Sports Data LLC url" do
+      SportsDataApi.stub(:key).and_return(key)
+      RestClient.stub(:get).with("http://api.sportsdatallc.org/nfl-t1/2012/REG/schedule.xml", params: { api_key: key }).and_return(schedule_xml)
+      subject.schedule(2012, :REG)
+    end
+    it "creates a SportsDataApi::Exception when there is no response from the api" do
+      error = RestClient::ResourceNotFound.new
+      error.stub_chain(:response, :headers).and_return(Hash.new)
+      SportsDataApi.stub(:key).and_return(key)
+      RestClient.stub(:get).and_raise(error)
+      expect { subject.schedule(2999, :REG) }.to raise_error(SportsDataApi::Exception)
+    end
+
+    describe "returned data structures" do
+      before(:each) { RestClient.stub(:get).and_return(schedule_xml) }
+      let(:season) { SportsDataApi::Nfl.schedule(2012, :REG) }
+      describe "SportsDataApi::Nfl::Season" do
+        subject { season }
+        it { should be_an_instance_of(SportsDataApi::Nfl::Season) }
+        its(:year) { should eq 2012 }
+        its(:type) { should eq :REG }
+        its(:weeks) { should have(17).weeks }
+      end
+      describe "SportsDataApi::Nfl::Week" do
+        subject { season.weeks.first }
+        it { should be_an_instance_of(SportsDataApi::Nfl::Week) }
+        its(:number) { should eq 1 }
+        its(:games) { should have(16).games }
+      end
+      describe "SportsDataApi::Nfl::Game" do
+        subject { season.weeks.first.games.first }
+        it { should be_an_instance_of(SportsDataApi::Nfl::Game) }
+        its(:id) { should eq "8c0bce5a-7ca2-41e5-9838-d1b8c356ddc3" }
+        its(:scheduled) { should eq Time.new(2012, 9, 5, 19, 30, 00, "-05:00") }
+        its(:home) { should eq "NYG" }
+        its(:away) { should eq "DAL" }
+        its(:status) { should eq "closed" }
+      end
+    end
+  end
+
+  describe ".season?" do
+    context :PRE do
+      it { subject.season?(:PRE).should be_true }
+    end
+    context :REG do
+      it { subject.season?(:REG).should be_true }
+    end
+    context :PST do
+      it { subject.season?(:PST).should be_true }
+    end
+    context :pre do
+      it { subject.season?(:pre).should be_false }
+    end
+    context :reg do
+      it { subject.season?(:reg).should be_false }
+    end
+    context :pst do
+      it { subject.season?(:pst).should be_false }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require "sports_data_api"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+def load_xml(filename)
+  File.read("#{File.dirname(__FILE__)}/xml/#{filename}.xml")
+end
+
+def schedule_xml
+  load_xml("schedule")
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/xml/game.xml

@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generation started at Fri Nov 02 02:27:02 +0000 2012 -->
+<game xmlns="http://feed.elasticstats.com/schema/nfl/boxscore-v1.0.xsd" id="82748625-c24e-437a-b991-cab7f766c249" scheduled="2012-11-02T00:20:00+00:00" home="SD" away="KC" status="inprogress" quarter="3" clock=":53">
+  <team id="SD" name="Chargers" market="San Diego" remaining_challenges="2" remaining_timeouts="3">
+    <scoring points="10">
+      <quarter number="1" points="7"/>
+      <quarter number="2" points="3"/>
+      <quarter number="3" points="0"/>
+    </scoring>
+  </team>
+  <team id="KC" name="Chiefs" market="Kansas City" remaining_challenges="2" remaining_timeouts="3">
+    <scoring points="6">
+      <quarter number="1" points="0"/>
+      <quarter number="2" points="3"/>
+      <quarter number="3" points="3"/>
+    </scoring>
+  </team>
+  <scoring_drives>
+    <drive sequence="1" clock="15:00" quarter="1" team="SD">
+      <score type="touchdown" clock="10:31" quarter="1" points="6">
+        <summary>
+          <![CDATA[17-P.Rivers complete to 85-A.Gates. 85-A.Gates runs 14 yards for a touchdown.]]>
+        </summary>
+        <links>
+          <link rel="summary" href="/2012/REG/9/KC/SD/plays/fb5c3b6f-be0a-4f3f-819e-f1134204e312.xml" type="application/xml"/>
+        </links>
+      </score>
+      <score type="extrapoint" clock="10:24" quarter="1" points="1">
+        <summary>
+          <![CDATA[9-N.Novak extra point is good.]]>
+        </summary>
+        <links>
+          <link rel="summary" href="/2012/REG/9/KC/SD/plays/cecb31f7-febb-470d-b833-b32b9411fa95.xml" type="application/xml"/>
+        </links>
+      </score>
+    </drive>
+    <drive sequence="2" clock="02:18" quarter="1" team="SD">
+      <score type="fieldgoal" clock="09:13" quarter="2" points="3">
+        <summary>
+          <![CDATA[9-N.Novak 25 yards Field Goal is Good.]]>
+        </summary>
+        <links>
+          <link rel="summary" href="/2012/REG/9/KC/SD/plays/2036be2d-f58b-4290-9e45-2e171c37588e.xml" type="application/xml"/>
+        </links>
+      </score>
+    </drive>
+    <drive sequence="3" clock="09:10" quarter="2" team="KC">
+      <score type="fieldgoal" clock="02:56" quarter="2" points="3">
+        <summary>
+          <![CDATA[6-R.Succop 49 yards Field Goal is Good.]]>
+        </summary>
+        <links>
+          <link rel="summary" href="/2012/REG/9/KC/SD/plays/68de7467-99b7-4e87-939d-7dc9b90c0462.xml" type="application/xml"/>
+        </links>
+      </score>
+    </drive>
+    <drive sequence="4" clock="07:09" quarter="3" team="KC">
+      <score type="fieldgoal" clock=":58" quarter="3" points="3">
+        <summary>
+          <![CDATA[6-R.Succop 41 yards Field Goal is Good.]]>
+        </summary>
+        <links>
+          <link rel="summary" href="/2012/REG/9/KC/SD/plays/35b31551-62ce-430b-8d1e-4153a1e81483.xml" type="application/xml"/>
+        </links>
+      </score>
+    </drive>
+  </scoring_drives>
+</game>
+<!-- Generation finished at Fri Nov 02 02:27:02 +0000 2012 -->