nba 0.1.1 → 0.2.0

data/lib/nba/box_score_player_track_stat.rb

@@ -0,0 +1,273 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents player tracking statistics for a player in a game
+  class BoxScorePlayerTrackStat < Shale::Mapper
+    include Equalizer.new(:game_id, :player_id)
+
+    # @!attribute [rw] game_id
+    #   Returns the game ID
+    #   @api public
+    #   @example
+    #     stat.game_id #=> "0022400001"
+    #   @return [String] the game ID
+    attribute :game_id, Shale::Type::String
+
+    # @!attribute [rw] team_id
+    #   Returns the team ID
+    #   @api public
+    #   @example
+    #     stat.team_id #=> 1610612744
+    #   @return [Integer] the team ID
+    attribute :team_id, Shale::Type::Integer
+
+    # @!attribute [rw] team_abbreviation
+    #   Returns the team abbreviation
+    #   @api public
+    #   @example
+    #     stat.team_abbreviation #=> "GSW"
+    #   @return [String] the team abbreviation
+    attribute :team_abbreviation, Shale::Type::String
+
+    # @!attribute [rw] team_city
+    #   Returns the team city
+    #   @api public
+    #   @example
+    #     stat.team_city #=> "Golden State"
+    #   @return [String] the team city
+    attribute :team_city, Shale::Type::String
+
+    # @!attribute [rw] player_id
+    #   Returns the player ID
+    #   @api public
+    #   @example
+    #     stat.player_id #=> 201939
+    #   @return [Integer] the player ID
+    attribute :player_id, Shale::Type::Integer
+
+    # @!attribute [rw] player_name
+    #   Returns the player name
+    #   @api public
+    #   @example
+    #     stat.player_name #=> "Stephen Curry"
+    #   @return [String] the player name
+    attribute :player_name, Shale::Type::String
+
+    # @!attribute [rw] start_position
+    #   Returns the starting position
+    #   @api public
+    #   @example
+    #     stat.start_position #=> "G"
+    #   @return [String] the starting position
+    attribute :start_position, Shale::Type::String
+
+    # @!attribute [rw] comment
+    #   Returns any comment about the player
+    #   @api public
+    #   @example
+    #     stat.comment #=> "DNP - Rest"
+    #   @return [String] the comment
+    attribute :comment, Shale::Type::String
+
+    # @!attribute [rw] min
+    #   Returns minutes played
+    #   @api public
+    #   @example
+    #     stat.min #=> "32:45"
+    #   @return [String] the minutes
+    attribute :min, Shale::Type::String
+
+    # @!attribute [rw] speed
+    #   Returns average speed in miles per hour
+    #   @api public
+    #   @example
+    #     stat.speed #=> 4.52
+    #   @return [Float] average speed
+    attribute :speed, Shale::Type::Float
+
+    # @!attribute [rw] distance
+    #   Returns distance traveled in miles
+    #   @api public
+    #   @example
+    #     stat.distance #=> 2.67
+    #   @return [Float] distance traveled
+    attribute :distance, Shale::Type::Float
+
+    # @!attribute [rw] oreb_chances
+    #   Returns offensive rebound chances
+    #   @api public
+    #   @example
+    #     stat.oreb_chances #=> 5
+    #   @return [Integer] offensive rebound chances
+    attribute :oreb_chances, Shale::Type::Integer
+
+    # @!attribute [rw] dreb_chances
+    #   Returns defensive rebound chances
+    #   @api public
+    #   @example
+    #     stat.dreb_chances #=> 12
+    #   @return [Integer] defensive rebound chances
+    attribute :dreb_chances, Shale::Type::Integer
+
+    # @!attribute [rw] reb_chances
+    #   Returns total rebound chances
+    #   @api public
+    #   @example
+    #     stat.reb_chances #=> 17
+    #   @return [Integer] total rebound chances
+    attribute :reb_chances, Shale::Type::Integer
+
+    # @!attribute [rw] touches
+    #   Returns total touches
+    #   @api public
+    #   @example
+    #     stat.touches #=> 65
+    #   @return [Integer] total touches
+    attribute :touches, Shale::Type::Integer
+
+    # @!attribute [rw] secondary_ast
+    #   Returns secondary assists
+    #   @api public
+    #   @example
+    #     stat.secondary_ast #=> 2
+    #   @return [Integer] secondary assists
+    attribute :secondary_ast, Shale::Type::Integer
+
+    # @!attribute [rw] ft_ast
+    #   Returns free throw assists
+    #   @api public
+    #   @example
+    #     stat.ft_ast #=> 1
+    #   @return [Integer] free throw assists
+    attribute :ft_ast, Shale::Type::Integer
+
+    # @!attribute [rw] passes
+    #   Returns total passes
+    #   @api public
+    #   @example
+    #     stat.passes #=> 42
+    #   @return [Integer] total passes
+    attribute :passes, Shale::Type::Integer
+
+    # @!attribute [rw] ast
+    #   Returns assists
+    #   @api public
+    #   @example
+    #     stat.ast #=> 8
+    #   @return [Integer] assists
+    attribute :ast, Shale::Type::Integer
+
+    # @!attribute [rw] cfgm
+    #   Returns contested field goals made
+    #   @api public
+    #   @example
+    #     stat.cfgm #=> 3
+    #   @return [Integer] contested field goals made
+    attribute :cfgm, Shale::Type::Integer
+
+    # @!attribute [rw] cfga
+    #   Returns contested field goals attempted
+    #   @api public
+    #   @example
+    #     stat.cfga #=> 8
+    #   @return [Integer] contested field goals attempted
+    attribute :cfga, Shale::Type::Integer
+
+    # @!attribute [rw] cfg_pct
+    #   Returns contested field goal percentage
+    #   @api public
+    #   @example
+    #     stat.cfg_pct #=> 0.375
+    #   @return [Float] contested field goal percentage
+    attribute :cfg_pct, Shale::Type::Float
+
+    # @!attribute [rw] ufgm
+    #   Returns uncontested field goals made
+    #   @api public
+    #   @example
+    #     stat.ufgm #=> 5
+    #   @return [Integer] uncontested field goals made
+    attribute :ufgm, Shale::Type::Integer
+
+    # @!attribute [rw] ufga
+    #   Returns uncontested field goals attempted
+    #   @api public
+    #   @example
+    #     stat.ufga #=> 6
+    #   @return [Integer] uncontested field goals attempted
+    attribute :ufga, Shale::Type::Integer
+
+    # @!attribute [rw] ufg_pct
+    #   Returns uncontested field goal percentage
+    #   @api public
+    #   @example
+    #     stat.ufg_pct #=> 0.833
+    #   @return [Float] uncontested field goal percentage
+    attribute :ufg_pct, Shale::Type::Float
+
+    # @!attribute [rw] dfgm
+    #   Returns defended field goals made
+    #   @api public
+    #   @example
+    #     stat.dfgm #=> 4
+    #   @return [Integer] defended field goals made
+    attribute :dfgm, Shale::Type::Integer
+
+    # @!attribute [rw] dfga
+    #   Returns defended field goals attempted
+    #   @api public
+    #   @example
+    #     stat.dfga #=> 10
+    #   @return [Integer] defended field goals attempted
+    attribute :dfga, Shale::Type::Integer
+
+    # @!attribute [rw] dfg_pct
+    #   Returns defended field goal percentage
+    #   @api public
+    #   @example
+    #     stat.dfg_pct #=> 0.400
+    #   @return [Float] defended field goal percentage
+    attribute :dfg_pct, Shale::Type::Float
+
+    # Returns the player object
+    #
+    # @api public
+    # @example
+    #   stat.player #=> #<NBA::Player>
+    # @return [Player, nil] the player object
+    def player
+      Players.find(player_id)
+    end
+
+    # Returns the team object
+    #
+    # @api public
+    # @example
+    #   stat.team #=> #<NBA::Team>
+    # @return [Team, nil] the team object
+    def team
+      Teams.find(team_id)
+    end
+
+    # Returns the game object
+    #
+    # @api public
+    # @example
+    #   stat.game #=> #<NBA::Game>
+    # @return [Game, nil] the game object
+    def game
+      Games.find(game_id)
+    end
+
+    # Returns whether the player started
+    #
+    # @api public
+    # @example
+    #   stat.starter? #=> true
+    # @return [Boolean] true if starter
+    def starter?
+      !start_position.nil? && !start_position.empty?
+    end
+  end
+end

data/lib/nba/box_score_player_track_team_stat.rb

@@ -0,0 +1,229 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents player tracking statistics for a team in a game
+  class BoxScorePlayerTrackTeamStat < Shale::Mapper
+    include Equalizer.new(:game_id, :team_id)
+
+    # @!attribute [rw] game_id
+    #   Returns the game ID
+    #   @api public
+    #   @example
+    #     stat.game_id #=> "0022400001"
+    #   @return [String] the game ID
+    attribute :game_id, Shale::Type::String
+
+    # @!attribute [rw] team_id
+    #   Returns the team ID
+    #   @api public
+    #   @example
+    #     stat.team_id #=> 1610612744
+    #   @return [Integer] the team ID
+    attribute :team_id, Shale::Type::Integer
+
+    # @!attribute [rw] team_name
+    #   Returns the team name
+    #   @api public
+    #   @example
+    #     stat.team_name #=> "Warriors"
+    #   @return [String] the team name
+    attribute :team_name, Shale::Type::String
+
+    # @!attribute [rw] team_abbreviation
+    #   Returns the team abbreviation
+    #   @api public
+    #   @example
+    #     stat.team_abbreviation #=> "GSW"
+    #   @return [String] the team abbreviation
+    attribute :team_abbreviation, Shale::Type::String
+
+    # @!attribute [rw] team_city
+    #   Returns the team city
+    #   @api public
+    #   @example
+    #     stat.team_city #=> "Golden State"
+    #   @return [String] the team city
+    attribute :team_city, Shale::Type::String
+
+    # @!attribute [rw] min
+    #   Returns minutes played
+    #   @api public
+    #   @example
+    #     stat.min #=> "240:00"
+    #   @return [String] the minutes
+    attribute :min, Shale::Type::String
+
+    # @!attribute [rw] speed
+    #   Returns team average speed in miles per hour
+    #   @api public
+    #   @example
+    #     stat.speed #=> 4.38
+    #   @return [Float] average speed
+    attribute :speed, Shale::Type::Float
+
+    # @!attribute [rw] distance
+    #   Returns total team distance traveled in miles
+    #   @api public
+    #   @example
+    #     stat.distance #=> 24.5
+    #   @return [Float] distance traveled
+    attribute :distance, Shale::Type::Float
+
+    # @!attribute [rw] oreb_chances
+    #   Returns offensive rebound chances
+    #   @api public
+    #   @example
+    #     stat.oreb_chances #=> 35
+    #   @return [Integer] offensive rebound chances
+    attribute :oreb_chances, Shale::Type::Integer
+
+    # @!attribute [rw] dreb_chances
+    #   Returns defensive rebound chances
+    #   @api public
+    #   @example
+    #     stat.dreb_chances #=> 45
+    #   @return [Integer] defensive rebound chances
+    attribute :dreb_chances, Shale::Type::Integer
+
+    # @!attribute [rw] reb_chances
+    #   Returns total rebound chances
+    #   @api public
+    #   @example
+    #     stat.reb_chances #=> 80
+    #   @return [Integer] total rebound chances
+    attribute :reb_chances, Shale::Type::Integer
+
+    # @!attribute [rw] touches
+    #   Returns total touches
+    #   @api public
+    #   @example
+    #     stat.touches #=> 350
+    #   @return [Integer] total touches
+    attribute :touches, Shale::Type::Integer
+
+    # @!attribute [rw] secondary_ast
+    #   Returns secondary assists
+    #   @api public
+    #   @example
+    #     stat.secondary_ast #=> 12
+    #   @return [Integer] secondary assists
+    attribute :secondary_ast, Shale::Type::Integer
+
+    # @!attribute [rw] ft_ast
+    #   Returns free throw assists
+    #   @api public
+    #   @example
+    #     stat.ft_ast #=> 5
+    #   @return [Integer] free throw assists
+    attribute :ft_ast, Shale::Type::Integer
+
+    # @!attribute [rw] passes
+    #   Returns total passes
+    #   @api public
+    #   @example
+    #     stat.passes #=> 285
+    #   @return [Integer] total passes
+    attribute :passes, Shale::Type::Integer
+
+    # @!attribute [rw] ast
+    #   Returns assists
+    #   @api public
+    #   @example
+    #     stat.ast #=> 28
+    #   @return [Integer] assists
+    attribute :ast, Shale::Type::Integer
+
+    # @!attribute [rw] cfgm
+    #   Returns contested field goals made
+    #   @api public
+    #   @example
+    #     stat.cfgm #=> 18
+    #   @return [Integer] contested field goals made
+    attribute :cfgm, Shale::Type::Integer
+
+    # @!attribute [rw] cfga
+    #   Returns contested field goals attempted
+    #   @api public
+    #   @example
+    #     stat.cfga #=> 45
+    #   @return [Integer] contested field goals attempted
+    attribute :cfga, Shale::Type::Integer
+
+    # @!attribute [rw] cfg_pct
+    #   Returns contested field goal percentage
+    #   @api public
+    #   @example
+    #     stat.cfg_pct #=> 0.400
+    #   @return [Float] contested field goal percentage
+    attribute :cfg_pct, Shale::Type::Float
+
+    # @!attribute [rw] ufgm
+    #   Returns uncontested field goals made
+    #   @api public
+    #   @example
+    #     stat.ufgm #=> 24
+    #   @return [Integer] uncontested field goals made
+    attribute :ufgm, Shale::Type::Integer
+
+    # @!attribute [rw] ufga
+    #   Returns uncontested field goals attempted
+    #   @api public
+    #   @example
+    #     stat.ufga #=> 35
+    #   @return [Integer] uncontested field goals attempted
+    attribute :ufga, Shale::Type::Integer
+
+    # @!attribute [rw] ufg_pct
+    #   Returns uncontested field goal percentage
+    #   @api public
+    #   @example
+    #     stat.ufg_pct #=> 0.686
+    #   @return [Float] uncontested field goal percentage
+    attribute :ufg_pct, Shale::Type::Float
+
+    # @!attribute [rw] dfgm
+    #   Returns defended field goals made
+    #   @api public
+    #   @example
+    #     stat.dfgm #=> 25
+    #   @return [Integer] defended field goals made
+    attribute :dfgm, Shale::Type::Integer
+
+    # @!attribute [rw] dfga
+    #   Returns defended field goals attempted
+    #   @api public
+    #   @example
+    #     stat.dfga #=> 55
+    #   @return [Integer] defended field goals attempted
+    attribute :dfga, Shale::Type::Integer
+
+    # @!attribute [rw] dfg_pct
+    #   Returns defended field goal percentage
+    #   @api public
+    #   @example
+    #     stat.dfg_pct #=> 0.455
+    #   @return [Float] defended field goal percentage
+    attribute :dfg_pct, Shale::Type::Float
+
+    # Returns the team object
+    #
+    # @api public
+    # @example
+    #   stat.team #=> #<NBA::Team>
+    # @return [Team, nil] the team object
+    def team
+      Teams.find(team_id)
+    end
+
+    # Returns the game object
+    #
+    # @api public
+    # @example
+    #   stat.game #=> #<NBA::Game>
+    # @return [Game, nil] the game object
+    def game
+      Games.find(game_id)
+    end
+  end
+end

data/lib/nba/box_score_scoring.rb

@@ -0,0 +1,103 @@
+require_relative "client"
+require_relative "response_parser"
+require_relative "box_score_scoring_player_stat"
+require_relative "box_score_scoring_team_stat"
+require_relative "utils"
+
+module NBA
+  # Provides methods to retrieve scoring box score statistics
+  module BoxScoreScoring
+    # Result set name for player stats
+    # @return [String] the result set name
+    PLAYER_STATS = "PlayerStats".freeze
+
+    # Result set name for team stats
+    # @return [String] the result set name
+    TEAM_STATS = "TeamStats".freeze
+
+    # Retrieves player scoring box score stats for a game
+    #
+    # @api public
+    # @example
+    #   stats = NBA::BoxScoreScoring.player_stats(game: "0022400001")
+    #   stats.each { |s| puts "#{s.player_name}: #{s.pct_pts_3pt}% from 3PT" }
+    # @param game [String, Game] the game ID or Game object
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of player scoring box score stats
+    def self.player_stats(game:, client: CLIENT)
+      path = "boxscorescoringv2?GameID=#{Utils.extract_id(game)}"
+      ResponseParser.parse(client.get(path), result_set: PLAYER_STATS) { |data| build_player_stat(data) }
+    end
+
+    # Retrieves team scoring box score stats for a game
+    #
+    # @api public
+    # @example
+    #   stats = NBA::BoxScoreScoring.team_stats(game: "0022400001")
+    #   stats.each { |s| puts "#{s.team_name}: #{s.pct_pts_paint}% in paint" }
+    # @param game [String, Game] the game ID or Game object
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of team scoring box score stats
+    def self.team_stats(game:, client: CLIENT)
+      path = "boxscorescoringv2?GameID=#{Utils.extract_id(game)}"
+      ResponseParser.parse(client.get(path), result_set: TEAM_STATS) { |data| build_team_stat(data) }
+    end
+
+    # Builds a player scoring stat from API data
+    # @api private
+    # @return [BoxScoreScoringPlayerStat]
+    def self.build_player_stat(data)
+      BoxScoreScoringPlayerStat.new(**player_identity(data), **shot_distribution(data), **assist_stats(data))
+    end
+    private_class_method :build_player_stat
+
+    # Builds a team scoring stat from API data
+    # @api private
+    # @return [BoxScoreScoringTeamStat]
+    def self.build_team_stat(data)
+      BoxScoreScoringTeamStat.new(**team_identity(data), **shot_distribution(data), **assist_stats(data))
+    end
+    private_class_method :build_team_stat
+
+    # Extracts player identity attributes from data
+    # @api private
+    # @return [Hash]
+    def self.player_identity(data)
+      {game_id: data["GAME_ID"], team_id: data["TEAM_ID"], team_abbreviation: data["TEAM_ABBREVIATION"],
+       team_city: data["TEAM_CITY"], player_id: data["PLAYER_ID"], player_name: data["PLAYER_NAME"],
+       start_position: data["START_POSITION"], comment: data["COMMENT"], min: data["MIN"]}
+    end
+    private_class_method :player_identity
+
+    # Extracts team identity attributes from data
+    # @api private
+    # @return [Hash]
+    def self.team_identity(data)
+      {game_id: data["GAME_ID"], team_id: data["TEAM_ID"], team_name: data["TEAM_NAME"],
+       team_abbreviation: data["TEAM_ABBREVIATION"], team_city: data["TEAM_CITY"], min: data["MIN"]}
+    end
+    private_class_method :team_identity
+
+    # Extracts shot distribution statistics from data
+    # @api private
+    # @return [Hash]
+    def self.shot_distribution(data)
+      {pct_fga_2pt: data["PCT_FGA_2PT"], pct_fga_3pt: data["PCT_FGA_3PT"],
+       pct_pts_2pt: data["PCT_PTS_2PT"], pct_pts_2pt_mr: data["PCT_PTS_2PT_MR"],
+       pct_pts_3pt: data["PCT_PTS_3PT"], pct_pts_fb: data["PCT_PTS_FB"],
+       pct_pts_ft: data["PCT_PTS_FT"], pct_pts_off_tov: data["PCT_PTS_OFF_TOV"],
+       pct_pts_paint: data["PCT_PTS_PAINT"]}
+    end
+    private_class_method :shot_distribution
+
+    # Extracts assist statistics from data
+    # @api private
+    # @return [Hash]
+    def self.assist_stats(data)
+      {pct_ast_2pm: data["PCT_AST_2PM"], pct_uast_2pm: data["PCT_UAST_2PM"],
+       pct_ast_3pm: data["PCT_AST_3PM"], pct_uast_3pm: data["PCT_UAST_3PM"],
+       pct_ast_fgm: data["PCT_AST_FGM"], pct_uast_fgm: data["PCT_UAST_FGM"]}
+    end
+    private_class_method :assist_stats
+  end
+end