Class: MLB::LiveFeed

Inherits:

Shale::Mapper

• Object
• Shale::Mapper
• MLB::LiveFeed

Defined in:

lib/mlb/live_feed.rb

Overview

Represents the live game feed data

Instance Attribute Summary

• #game_data ⇒ GameData

  Returns the game metadata.

• #game_pk ⇒ Integer

  Returns the game primary key.

• #link ⇒ String

  Returns the API link.

• #live_data ⇒ LiveData

  Returns the live game data.

Class Method Summary

• .find(game:) ⇒ LiveFeed

  Retrieves the live feed for a game.

Instance Attribute Details

#game_data ⇒ GameData

Returns the game metadata

Examples:

feed.game_data #=> #<MLB::GameData>

Returns:

• (GameData) —

  the game data

# File 'lib/mlb/live_feed.rb', line 98

attribute :game_data, GameData

#game_pk ⇒ Integer

Returns the game primary key

Examples:

feed.game_pk #=> 745571

Returns:

• (Integer) —

  the game PK

# File 'lib/mlb/live_feed.rb', line 82

attribute :game_pk, Shale::Type::Integer

#link ⇒ String

Returns the API link

Examples:

feed.link #=> "/api/v1.1/game/745571/feed/live"

Returns:

• (String) —

  the link

# File 'lib/mlb/live_feed.rb', line 90

attribute :link, Shale::Type::String

#live_data ⇒ LiveData

Returns the live game data

Examples:

feed.live_data #=> #<MLB::LiveData>

Returns:

• (LiveData) —

  the live data

# File 'lib/mlb/live_feed.rb', line 106

attribute :live_data, LiveData

Class Method Details

.find(game:) ⇒ LiveFeed

Retrieves the live feed for a game

Examples:

Get live feed for a game

MLB::LiveFeed.find(game: 745571)

Get live feed using a ScheduledGame object

MLB::LiveFeed.find(game: scheduled_game)

Parameters:

• game (Integer, ScheduledGame) —

  the game ID or game object

Returns:

• (LiveFeed) —

  the live feed

# File 'lib/mlb/live_feed.rb', line 124

def self.find(game:)
  game_pk = game.respond_to?(:game_pk) ? game.game_pk : game
  response = CLIENT.get("game/#{game_pk}/feed/live")
  from_json(response)
end