Module: NBA::PlayerVsPlayer

Defined in:
lib/nba/player_vs_player.rb

Overview

Provides methods to retrieve player vs player statistics

Constant Summary collapse

OVERALL =

Result set name for overall comparison

Returns:

  • (String) —

    the result set name

"Overall".freeze
ON_OFF_COURT =

Result set name for on/off court comparison

Returns:

  • (String) —

    the result set name

"OnOffCourt".freeze

Class Method Summary collapse

Class Method Details

.on_off_court(player:, vs_player:, season: Utils.current_season, season_type: "Regular Season", per_mode: "PerGame", client: CLIENT) ⇒ Collection

Retrieves on/off court comparison statistics between two players

Examples:

stats = NBA::PlayerVsPlayer.on_off_court(player: 201939, vs_player: 201566)
stats.each { |s| puts "#{s.court_status}: #{s.pts}" }

Parameters:

  • player (Integer, Player) —

    the player ID or Player object

  • vs_player (Integer, Player) —

    the vs player ID or Player object

  • season (Integer) (defaults to: Utils.current_season) —

    the season year

  • season_type (String) (defaults to: "Regular Season") —

    the season type

  • per_mode (String) (defaults to: "PerGame") —

    the per mode

  • client (Client) (defaults to: CLIENT) —

    the API client to use

Returns:

  • (Collection) —

    a collection of vs player statistics



52
53
54
55
56
 
# File 'lib/nba/player_vs_player.rb', line 52

def self.on_off_court(player:, vs_player:, season: Utils.current_season, season_type: "Regular Season",
  per_mode: "PerGame", client: CLIENT)
  options = {season_type: season_type, per_mode: per_mode, result_set: ON_OFF_COURT}
  fetch_stats(player, vs_player, season, options, client: client)
end

.overall(player:, vs_player:, season: Utils.current_season, season_type: "Regular Season", per_mode: "PerGame", client: CLIENT) ⇒ Collection

Retrieves overall comparison statistics between two players

Examples:

stats = NBA::PlayerVsPlayer.overall(player: 201939, vs_player: 201566)
stats.first.pts #=> 26.4

Parameters:

  • player (Integer, Player) —

    the player ID or Player object

  • vs_player (Integer, Player) —

    the vs player ID or Player object

  • season (Integer) (defaults to: Utils.current_season) —

    the season year

  • season_type (String) (defaults to: "Regular Season") —

    the season type

  • per_mode (String) (defaults to: "PerGame") —

    the per mode

  • client (Client) (defaults to: CLIENT) —

    the API client to use

Returns:

  • (Collection) —

    a collection of vs player statistics



33
34
35
36
37
 
# File 'lib/nba/player_vs_player.rb', line 33

def self.overall(player:, vs_player:, season: Utils.current_season, season_type: "Regular Season",
  per_mode: "PerGame", client: CLIENT)
  options = {season_type: season_type, per_mode: per_mode, result_set: OVERALL}
  fetch_stats(player, vs_player, season, options, client: client)
end