Welcome!

Ruby-On-Rails Authors: Liz McMillan, Pat Romanski, Elizabeth White, Hovhannes Avoyan, Yeshim Deniz

Related Topics: Ruby-On-Rails, Open Source Cloud

Ruby-On-Rails: Blog Feed Post

How to Generate Boxscores with Ruby from Live MLB Data

As an avid baseball fan, I’ve always been interested in the statistics that surround baseball

As an avid baseball fan, I’ve always been interested in the statistics that surround baseball. More so than in any other sport, baseball is a game ruled by statistics. In this post, I will describe a program that I wrote in the Ruby language to generate box scores for any Major Leage Baseball(MLB) game by using the live XML data provided by MLB. Ruby makes it easy to do using plain Ruby along with just a few libraries.

Live MLB Data
The amount of raw data that MLB makes available is extensive. It includes all of the traditional boxscore statistics plus deep detail on every pitch thrown including its velocity, movement, and location. If you have ever used the Gameday baseball game watcher application than you’ve indirectly been a consumer of this data. All of the data that powers the Gameday application is made available on an MLB server as raw XML files. Also, this is not just historical data. The data is real-time and updated with every pitch thrown during live games. You also have historical data available to you. The data goes back to the 1926 season.

Building a boxscore template with ERb
For those not familiar with ERb, it is a templating engine that allows you to embed Ruby code inside of a document. The Ruby code can then be evaluated at run time and merged with the rest of the document to form a new document. The Rails framework uses ERb to generate HTML content from templates. For the boxscore generator, I used an ERb template to format the layout of the boxscore. This allowed me to keep the presentation seperate from the logic layers of the application. Most Ruby developers are familiar with the ERb templating engine from its usage in Ruby on Rails applications. However, not all developers are aware that ERb can be used very easily outside of a Rails application. ERb is in no way tightly coupled to the Rails framework. ERb is normally included with the standard Ruby distribution. You can use ERb templates by simply requiring ‘erb’ in your Ruby application.

Here is an example of ERb taken from my boxscore template. This section is used to display the linescore of a game:

<div id="linescore">
  <label><%= cities[0] %></label>
  <% (0..8).each do |num| %>
    <%= innings[num][0] %>
  <% end %>
  &nbsp;<b><%= tots[0][0] + '  ' + tots[0][1] + '  ' + tots[0][2] %></b>
  <br/>
  <label><%= cities[1] %></label>
  <% (0..8).each do |num| %>
    <%= innings[num][1] %>
  <% end %>
  &nbsp;<b><%= tots[1][0] + '  ' + tots[1][1] + '  ' + tots[1][2] %></b>
</div>

At the bottom of this post you can find links to download the complete source code for this project including the full boxscore ERb template.

Steps to generate a boxscore
Now that you know about the MLB data source, and ERb, I’ll describe the steps that are used to generate a boxscore in a Ruby application.

  • Find the correct Gameday ID for the game you are interested in.
  • Retreive the correct boxscore.xml file from gd2.mlb.com
  • Parse the boxscore XML to pull out relevant data.
  • Merge the data into the boxscore template and save the result.

The sections below describe each of these steps in more detail.

Find the correct Gameday ID for the game you are interested in

Each MLB game can be identified on the gameday server with a gameday ID. The gameday ID is a string that contains the date of the game concatenated with team information. A gameday ID has the following format:

2009_06_09_chnmlb_houmlb_1

Finding the gameday ID for a game you are interested in is done by looking at the subdirectories contained in a directory that corresponds to the game date you are looking for. That directory will contain a subdirectory for each game played on that date. The game ID can be parsed from the name of that game’s subdirectory. For example, if you were interested in the Detroit Tigers game played on June 6, 2009, you would scan through the subdirectories contained in this directotry:

http://gd2.mlb.com/components/game/mlb/year_2009/month_06/day_21/

Within that directory, you would find a subdirectory named:

gid_2009_06_21_milmlb_detmlb_1/

and from that you can find the game id by stripping off the leading ‘gid_’ from the directory name.

Retreive the correct boxscore.xml file from gd2.mlb.com
After you have identified the correct gameday ID, you have to make an HTTP call to retrieve the boxscore.xml file from the gd2.mlb.com server. This is a fairly simple task in Ruby done using the Net::HTTP library.

I have defined a constant to represent the root path for the gameday server.

GD2_MLB_BASE = "http://gd2.mlb.com/components/game"

Below is the ruby code used to retrieve the boxscore.xml file.

def get_boxscore(year, month, day, gid)
  url = "#{GD2_MLB_BASE}/mlb/year_" + year +
             "/month_" + month + "/day_" + day +
             "/gid_"+gid+"/boxscore.xml"
  xml_data = Net::HTTP.get_response(URI.parse(url)).body
  return xml_data
end

Parse the boxscore XML to pull out relevant data
Now that you have the boxscore.xml file, the next thing that you’ll want to do is parse this file to pull out data that you’ll want to use in your formatted boxscore. There are several XML parsing libraries available for ruby. I chose to use the REXML library to do this parsing. REXML is easy to work with and made the task relatively simple to code. In the sample shown below, I am parsing the boxscore XML file to find all of the batter statistics and pushing those into an array of batters. I will then use that array of batters from my boxscore ERb template to display the batters section of the boxscore.

# Returns an array of hashes where each hash holds data
# for a batter whom appeared in the game.  Specify either
# home or away team batters.
def get_batters(home_or_away)
  doc = REXML::Document.new(@xml_data)
  batters = []
  doc.elements.each(
    "boxscore/batting[@team_flag='#{home_or_away}']/batter")
    { |element|
      batter = {}
      batter['name'] = element.attributes['name']
      batter['pos'] = element.attributes['pos']
      batter['ab'] = element.attributes['ab']
      batter['r'] = element.attributes['r']
      batter['bb'] = element.attributes['bb']
      batter['sf'] = element.attributes['sf']
      batter['h'] = element.attributes['h']
      batter['e'] = element.attributes['e']
      batter['d'] = element.attributes['d']
      batter['t'] = element.attributes['t']
      batter['hbp'] = element.attributes['hbp']
      batter['so'] = element.attributes['so']
      batter['hr'] = element.attributes['hr']
      batter['rbi'] = element.attributes['rbi']
      batter['sb'] = element.attributes['sb']
      batter['avg'] = element.attributes['avg']
      batters.push batter
  }
  return batters
end

Merge the data into the boxscore template and save the result
After you have parsed all of the relevant data out of the boxscore XML, you are ready to use that data to build the final boxscore presentation. The code below is a method in the BoxScore class that I created. This method converts the boxscore into a formatted HTML representation. The first few lines call methods which parse the boxscore XML and setup the corect data variables. After that I create a new ERb instance and load the boxscore.html.erb template into it. This is the template that I created to display the boxscore. The next line binds the template to the variables previously defined in this method and returns the result of the template bound with the variables. This produces the resultant boxscore HTML file.

  # Converts the boxscore into a formatted HTML representation.
  def to_html
    cities = get_cities
    innings = get_innings
    tots =  get_linescore_totals
    home_pitchers = get_pitchers('home')
    away_pitchers = get_pitchers('away')
    home_batters = get_batters('home')
    away_batters = get_batters('away')
    home_batters_text = get_batting_text('home')
    away_batters_text = get_batting_text('away')
    game_info = get_game_info

    gameday_info = parse_gameday_id('gid_' + gid)
    template = ERB.new File.new("boxscore.html.erb").read, nil, "%"
    return template.result(binding)
  end

View the results and download the code
Here are links to download the complete sourcecode for my gameday API in ruby. I’ve also provided a link to a boxscore that has been generated using this code.
Full sourcecode
Generated boxscore

MLB copyright notice
If you decide to do something with my api or the MLB data, be sure that you understand the limitations of using the data. MLB provides the data for experimental usage only. You are not permitted to use it for a commercial application. Below is a line taken from their copyright notice covering all of the data available from their gameday server:
“Only individual, non-commercial, non-bulk use of the Materials is permitted and any other use of the Materials is prohibited without prior written authorization from MLBAM.”

Read the original blog entry...

More Stories By Timothy Fisher

Timothy Fisher has recognized expertise in the areas of Java, Ruby, Rails, Social Media, Web 2.0, and Enterprise 2.o. He has served in technical leadership and senior architecture roles with companies such as Motorola, Cyclone Commerce, and Compuware. He is the author of the Java Phrasebook, and the Ruby on Rails Bible. Currently he is employed as a senior web architect with Compuware in Detroit, Michigan.

Follow Timothy on Twitter at http://twitter.com/tfisher

IoT & Smart Cities Stories
Druva is the global leader in Cloud Data Protection and Management, delivering the industry's first data management-as-a-service solution that aggregates data from endpoints, servers and cloud applications and leverages the public cloud to offer a single pane of glass to enable data protection, governance and intelligence-dramatically increasing the availability and visibility of business critical information, while reducing the risk, cost and complexity of managing and protecting it. Druva's...
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
BMC has unmatched experience in IT management, supporting 92 of the Forbes Global 100, and earning recognition as an ITSM Gartner Magic Quadrant Leader for five years running. Our solutions offer speed, agility, and efficiency to tackle business challenges in the areas of service management, automation, operations, and the mainframe.
The Jevons Paradox suggests that when technological advances increase efficiency of a resource, it results in an overall increase in consumption. Writing on the increased use of coal as a result of technological improvements, 19th-century economist William Stanley Jevons found that these improvements led to the development of new ways to utilize coal. In his session at 19th Cloud Expo, Mark Thiele, Chief Strategy Officer for Apcera, compared the Jevons Paradox to modern-day enterprise IT, examin...
With 10 simultaneous tracks, keynotes, general sessions and targeted breakout classes, @CloudEXPO and DXWorldEXPO are two of the most important technology events of the year. Since its launch over eight years ago, @CloudEXPO and DXWorldEXPO have presented a rock star faculty as well as showcased hundreds of sponsors and exhibitors! In this blog post, we provide 7 tips on how, as part of our world-class faculty, you can deliver one of the most popular sessions at our events. But before reading...
DSR is a supplier of project management, consultancy services and IT solutions that increase effectiveness of a company's operations in the production sector. The company combines in-depth knowledge of international companies with expert knowledge utilising IT tools that support manufacturing and distribution processes. DSR ensures optimization and integration of internal processes which is necessary for companies to grow rapidly. The rapid growth is possible thanks, to specialized services an...
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
There are many examples of disruption in consumer space – Uber disrupting the cab industry, Airbnb disrupting the hospitality industry and so on; but have you wondered who is disrupting support and operations? AISERA helps make businesses and customers successful by offering consumer-like user experience for support and operations. We have built the world’s first AI-driven IT / HR / Cloud / Customer Support and Operations solution.
Codete accelerates their clients growth through technological expertise and experience. Codite team works with organizations to meet the challenges that digitalization presents. Their clients include digital start-ups as well as established enterprises in the IT industry. To stay competitive in a highly innovative IT industry, strong R&D departments and bold spin-off initiatives is a must. Codete Data Science and Software Architects teams help corporate clients to stay up to date with the mod...
Scala Hosting is trusted by 50 000 customers from 120 countries and hosting 700 000+ websites. The company has local presence in the United States and Europe and runs an internal R&D department which focuses on changing the status quo in the web hosting industry. Imagine every website owner running their online business on a fully managed cloud VPS platform at an affordable price that's very close to the price of shared hosting. The efforts of the R&D department in the last 3 years made that pos...