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

@ThingsExpo Stories
SYS-CON Events announced today that N3N will exhibit at SYS-CON's @ThingsExpo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. N3N’s solutions increase the effectiveness of operations and control centers, increase the value of IoT investments, and facilitate real-time operational decision making. N3N enables operations teams with a four dimensional digital “big board” that consolidates real-time live video feeds alongside IoT sensor data a...
Mobile device usage has increased exponentially during the past several years, as consumers rely on handhelds for everything from news and weather to banking and purchases. What can we expect in the next few years? The way in which we interact with our devices will fundamentally change, as businesses leverage Artificial Intelligence. We already see this taking shape as businesses leverage AI for cost savings and customer responsiveness. This trend will continue, as AI is used for more sophistica...
Real IoT production deployments running at scale are collecting sensor data from hundreds / thousands / millions of devices. The goal is to take business-critical actions on the real-time data and find insights from stored datasets. In his session at @ThingsExpo, John Walicki, Watson IoT Developer Advocate at IBM Cloud, will provide a fast-paced developer journey that follows the IoT sensor data from generation, to edge gateway, to edge analytics, to encryption, to the IBM Bluemix cloud, to Wa...
What is the best strategy for selecting the right offshore company for your business? In his session at 21st Cloud Expo, Alan Winters, U.S. Head of Business Development at MobiDev, will discuss the things to look for - positive and negative - in evaluating your options. He will also discuss how to maximize productivity with your offshore developers. Before you start your search, clearly understand your business needs and how that impacts software choices.
SYS-CON Events announced today that Massive Networks, that helps your business operate seamlessly with fast, reliable, and secure internet and network solutions, has been named "Exhibitor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. As a premier telecommunications provider, Massive Networks is headquartered out of Louisville, Colorado. With years of experience under their belt, their team of...
SYS-CON Events announced today that Fusic will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Fusic Co. provides mocks as virtual IoT devices. You can customize mocks, and get any amount of data at any time in your test. For more information, visit https://fusic.co.jp/english/.
SYS-CON Events announced today that Enroute Lab will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Enroute Lab is an industrial design, research and development company of unmanned robotic vehicle system. For more information, please visit http://elab.co.jp/.
SYS-CON Events announced today that MIRAI Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MIRAI Inc. are IT consultants from the public sector whose mission is to solve social issues by technology and innovation and to create a meaningful future for people.
SYS-CON Events announced today that Mobile Create USA will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Mobile Create USA Inc. is an MVNO-based business model that uses portable communication devices and cellular-based infrastructure in the development, sales, operation and mobile communications systems incorporating GPS capabi...
There is huge complexity in implementing a successful digital business that requires efficient on-premise and cloud back-end infrastructure, IT and Internet of Things (IoT) data, analytics, Machine Learning, Artificial Intelligence (AI) and Digital Applications. In the data center alone, there are physical and virtual infrastructures, multiple operating systems, multiple applications and new and emerging business and technological paradigms such as cloud computing and XaaS. And then there are pe...
SYS-CON Events announced today that Interface Corporation will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Interface Corporation is a company developing, manufacturing and marketing high quality and wide variety of industrial computers and interface modules such as PCIs and PCI express. For more information, visit http://www.i...
SYS-CON Events announced today that Keisoku Research Consultant Co. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Keisoku Research Consultant, Co. offers research and consulting in a wide range of civil engineering-related fields from information construction to preservation of cultural properties. For more information, vi...
SYS-CON Events announced today that SIGMA Corporation will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. uLaser flow inspection device from the Japanese top share to Global Standard! Then, make the best use of data to flip to next page. For more information, visit http://www.sigma-k.co.jp/en/.
SYS-CON Events announced today that B2Cloud will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. B2Cloud specializes in IoT devices for preventive and predictive maintenance in any kind of equipment retrieving data like Energy consumption, working time, temperature, humidity, pressure, etc.
Agile has finally jumped the technology shark, expanding outside the software world. Enterprises are now increasingly adopting Agile practices across their organizations in order to successfully navigate the disruptive waters that threaten to drown them. In our quest for establishing change as a core competency in our organizations, this business-centric notion of Agile is an essential component of Agile Digital Transformation. In the years since the publication of the Agile Manifesto, the conn...
While some developers care passionately about how data centers and clouds are architected, for most, it is only the end result that matters. To the majority of companies, technology exists to solve a business problem, and only delivers value when it is solving that problem. 2017 brings the mainstream adoption of containers for production workloads. In his session at 21st Cloud Expo, Ben McCormack, VP of Operations at Evernote, will discuss how data centers of the future will be managed, how th...
SYS-CON Events announced today that NetApp has been named “Bronze Sponsor” of SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. NetApp is the data authority for hybrid cloud. NetApp provides a full range of hybrid cloud data services that simplify management of applications and data across cloud and on-premises environments to accelerate digital transformation. Together with their partners, NetApp em...
SYS-CON Events announced today that Nihon Micron will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Nihon Micron Co., Ltd. strives for technological innovation to establish high-density, high-precision processing technology for providing printed circuit board and metal mount RFID tags used for communication devices. For more inf...
SYS-CON Events announced today that Suzuki Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Suzuki Inc. is a semiconductor-related business, including sales of consuming parts, parts repair, and maintenance for semiconductor manufacturing machines, etc. It is also a health care business providing experimental research for...
SYS-CON Events announced today that Ryobi Systems will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Ryobi Systems Co., Ltd., as an information service company, specialized in business support for local governments and medical industry. We are challenging to achive the precision farming with AI. For more information, visit http:...