ots-data-plugin-mlb

0.4.1 • Public • Published

MLB data plugin

A bunch of helpers that all inherit from a common base class that help us get data out of the mlb_sn database. Each helper is an event emitter with methods that can be called that map to certain database operations. When data is fetched, an event is emitted. This construction allows the entire plugin to be installed in another application (e.g. restify API server, desktop app, TV app, whatever). The calling application can call method helpers and listen for events and act on them when called.

The entire plugin can be thought of as a data adapter for the MLB v2 data. To instantiate the adapter, you would do this:

var
Adapter = require("mlb-data-plugin"),
environment = require("./environment.json")
adapter = new Adapter({db: environment.db, hourOffset: environment.hourOffset});
 
// Now we have all helpers available on the adapter like this:
adapter.helpers.plays({schedule_id:"1234"});
adapter.helpers.on( "plays", function( plays ) {
  // Do something with the plays
});

hourOffset

Every file we get from SportsNetwork has a time_stamp node in it. It is always in this format: November 5, 2013, at 10:11 AM ET. The parser will generate a unix timestamp without milliseconds from this for every file. However, it assumes the server's local time, which is central time, and generates the timestamp from there. Therefore, when you're running the thing in your environment, you need to specify a positive or negative hour offset when requesting time-based data. This is a temporary workaround for the problem and we will rectify the existing timestamps and parsing of new timestamps later.

Unit Tests

This is a TODO item. Having the helpers broken up like this allows for easy unit testing setups though.

Readme

Keywords

Package Sidebar

Install

npm i ots-data-plugin-mlb

Weekly Downloads

0

Version

0.4.1

License

BSD-2-Clause

Last publish

Collaborators

  • cletustboone