Module: ESPN::Client::Headlines

Included in:

ESPN::Client

Defined in:

lib/espn/client/headlines.rb

Overview

Public: The mapping to the HEADLINES API of the ESPN developer API.

Examples

class Client
  include ESPN::Client::Headlines
end

Instance Method Summary

• #headline(id, opts = {}) ⇒ Object

  Public: Get a specific headline from the ESPN API.

• #headlines(*args) ⇒ Object

  Public: Get latest sports news and analysis from the ESPN API.

Instance Method Details

#headline(id, opts = {}) ⇒ Object

Public: Get a specific headline from the ESPN API.

id - The id of the headline to get. opts - Hash options used to refine the selection. You can find the full

list of options on the ESPN developer API website (default: {}).

Examples:

client.headline(12345)
# Request made to 'sports/news/12345'

Returns a Hashie::Mash.

# File 'lib/espn/client/headlines.rb', line 25

def headline(id, opts={})
  get("sports/news/#{id}", opts).headlines.first
end

#headlines(*args) ⇒ Object

Public: Get latest sports news and analysis from the ESPN API.

sport - A Symbol or String of the sport (optional). league - A Symbol or String of the league. If a league is passed, but

not a sport, an attempt will be made to map the league to a
sport (optional).

opts - Hash options used to refine the selection. If sport and/or

league are passed in, they will override the mapped values
You can find a full list of options on the ESPN developer API
website (default: {}).
:section  - The news section (default: 'sports').
:sport    - Name of the sport (default: nil, optional).
:league   - Name of the league (default: nil, optional).
:method   - Method of headlines (default: nil, optional).

Examples

client.headlines(:mlb)
# Request made to 'sports/baseball/mlb/news'

client.headlines('baseball')
# Request will be made to 'sports/baseball/news'

client.headlines('horse-racing', :mlb)
# Request will be made to 'sports/horse-racing/mlb/news'

client.headlines(:mlb, sport: 'basketball')
# Request will be made to 'sports/basketball/mlb/news'

client.headlines(:baseball, :mlb, sport: 'basketball', league: 'nba')
# Request will be made to 'sports/basketball/nba/news'

Returns an Array of Hashie::Mash.

# File 'lib/espn/client/headlines.rb', line 62

def headlines(*args)
  arguments = ESPN::Arguments.new(args, section: 'sports')
  pattern = arguments.options[:section]
  pattern += '/:sport/:league/news/headlines/:method/:id'
  get(pattern, arguments.options).headlines
end