nba 0.1.1 → 0.2.0

data/lib/nba/box_score_defensive_player_stat.rb

@@ -0,0 +1,281 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents defensive statistics for a player in a game
+  class BoxScoreDefensivePlayerStat < Shale::Mapper
+    include Equalizer.new(:game_id, :person_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_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] 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_tricode
+    #   Returns the team tricode
+    #   @api public
+    #   @example
+    #     stat.team_tricode #=> "GSW"
+    #   @return [String] the team tricode
+    attribute :team_tricode, Shale::Type::String
+
+    # @!attribute [rw] team_slug
+    #   Returns the team slug
+    #   @api public
+    #   @example
+    #     stat.team_slug #=> "warriors"
+    #   @return [String] the team slug
+    attribute :team_slug, Shale::Type::String
+
+    # @!attribute [rw] person_id
+    #   Returns the person ID
+    #   @api public
+    #   @example
+    #     stat.person_id #=> 201939
+    #   @return [Integer] the person ID
+    attribute :person_id, Shale::Type::Integer
+
+    # @!attribute [rw] first_name
+    #   Returns the player first name
+    #   @api public
+    #   @example
+    #     stat.first_name #=> "Stephen"
+    #   @return [String] the first name
+    attribute :first_name, Shale::Type::String
+
+    # @!attribute [rw] family_name
+    #   Returns the player family name
+    #   @api public
+    #   @example
+    #     stat.family_name #=> "Curry"
+    #   @return [String] the family name
+    attribute :family_name, Shale::Type::String
+
+    # @!attribute [rw] name_i
+    #   Returns the player name initial format
+    #   @api public
+    #   @example
+    #     stat.name_i #=> "S. Curry"
+    #   @return [String] the name initial format
+    attribute :name_i, Shale::Type::String
+
+    # @!attribute [rw] player_slug
+    #   Returns the player slug
+    #   @api public
+    #   @example
+    #     stat.player_slug #=> "stephen-curry"
+    #   @return [String] the player slug
+    attribute :player_slug, Shale::Type::String
+
+    # @!attribute [rw] position
+    #   Returns the player position
+    #   @api public
+    #   @example
+    #     stat.position #=> "G"
+    #   @return [String] the position
+    attribute :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] jersey_num
+    #   Returns the jersey number
+    #   @api public
+    #   @example
+    #     stat.jersey_num #=> "30"
+    #   @return [String] the jersey number
+    attribute :jersey_num, Shale::Type::String
+
+    # @!attribute [rw] matchup_minutes
+    #   Returns the matchup minutes
+    #   @api public
+    #   @example
+    #     stat.matchup_minutes #=> 24.5
+    #   @return [Float] the matchup minutes
+    attribute :matchup_minutes, Shale::Type::Float
+
+    # @!attribute [rw] partial_possessions
+    #   Returns partial possessions
+    #   @api public
+    #   @example
+    #     stat.partial_possessions #=> 15.2
+    #   @return [Float] partial possessions
+    attribute :partial_possessions, Shale::Type::Float
+
+    # @!attribute [rw] switches_on
+    #   Returns number of switches on
+    #   @api public
+    #   @example
+    #     stat.switches_on #=> 8
+    #   @return [Integer] switches on
+    attribute :switches_on, Shale::Type::Integer
+
+    # @!attribute [rw] player_points
+    #   Returns points allowed
+    #   @api public
+    #   @example
+    #     stat.player_points #=> 12
+    #   @return [Integer] player points allowed
+    attribute :player_points, Shale::Type::Integer
+
+    # @!attribute [rw] defensive_rebounds
+    #   Returns defensive rebounds
+    #   @api public
+    #   @example
+    #     stat.defensive_rebounds #=> 5
+    #   @return [Integer] defensive rebounds
+    attribute :defensive_rebounds, Shale::Type::Integer
+
+    # @!attribute [rw] matchup_assists
+    #   Returns matchup assists
+    #   @api public
+    #   @example
+    #     stat.matchup_assists #=> 3
+    #   @return [Integer] matchup assists
+    attribute :matchup_assists, Shale::Type::Integer
+
+    # @!attribute [rw] matchup_turnovers
+    #   Returns matchup turnovers
+    #   @api public
+    #   @example
+    #     stat.matchup_turnovers #=> 2
+    #   @return [Integer] matchup turnovers
+    attribute :matchup_turnovers, Shale::Type::Integer
+
+    # @!attribute [rw] steals
+    #   Returns steals
+    #   @api public
+    #   @example
+    #     stat.steals #=> 2
+    #   @return [Integer] steals
+    attribute :steals, Shale::Type::Integer
+
+    # @!attribute [rw] blocks
+    #   Returns blocks
+    #   @api public
+    #   @example
+    #     stat.blocks #=> 1
+    #   @return [Integer] blocks
+    attribute :blocks, Shale::Type::Integer
+
+    # @!attribute [rw] matchup_field_goals_made
+    #   Returns matchup field goals made
+    #   @api public
+    #   @example
+    #     stat.matchup_field_goals_made #=> 5
+    #   @return [Integer] matchup field goals made
+    attribute :matchup_field_goals_made, Shale::Type::Integer
+
+    # @!attribute [rw] matchup_field_goals_attempted
+    #   Returns matchup field goals attempted
+    #   @api public
+    #   @example
+    #     stat.matchup_field_goals_attempted #=> 12
+    #   @return [Integer] matchup field goals attempted
+    attribute :matchup_field_goals_attempted, Shale::Type::Integer
+
+    # @!attribute [rw] matchup_field_goal_percentage
+    #   Returns matchup field goal percentage
+    #   @api public
+    #   @example
+    #     stat.matchup_field_goal_percentage #=> 0.417
+    #   @return [Float] matchup field goal percentage
+    attribute :matchup_field_goal_percentage, Shale::Type::Float
+
+    # @!attribute [rw] matchup_three_pointers_made
+    #   Returns matchup three pointers made
+    #   @api public
+    #   @example
+    #     stat.matchup_three_pointers_made #=> 2
+    #   @return [Integer] matchup three pointers made
+    attribute :matchup_three_pointers_made, Shale::Type::Integer
+
+    # @!attribute [rw] matchup_three_pointers_attempted
+    #   Returns matchup three pointers attempted
+    #   @api public
+    #   @example
+    #     stat.matchup_three_pointers_attempted #=> 5
+    #   @return [Integer] matchup three pointers attempted
+    attribute :matchup_three_pointers_attempted, Shale::Type::Integer
+
+    # @!attribute [rw] matchup_three_pointer_percentage
+    #   Returns matchup three pointer percentage
+    #   @api public
+    #   @example
+    #     stat.matchup_three_pointer_percentage #=> 0.4
+    #   @return [Float] matchup three pointer percentage
+    attribute :matchup_three_pointer_percentage, Shale::Type::Float
+
+    # Returns the player object
+    #
+    # @api public
+    # @example
+    #   stat.player #=> #<NBA::Player>
+    # @return [Player, nil] the player object
+    def player
+      Players.find(person_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?
+      !position.nil? && !position.empty?
+    end
+  end
+end

data/lib/nba/box_score_defensive_team_stat.rb

@@ -0,0 +1,85 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents defensive statistics for a team in a game
+  class BoxScoreDefensiveTeamStat < 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_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] 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_tricode
+    #   Returns the team tricode
+    #   @api public
+    #   @example
+    #     stat.team_tricode #=> "GSW"
+    #   @return [String] the team tricode
+    attribute :team_tricode, Shale::Type::String
+
+    # @!attribute [rw] team_slug
+    #   Returns the team slug
+    #   @api public
+    #   @example
+    #     stat.team_slug #=> "warriors"
+    #   @return [String] the team slug
+    attribute :team_slug, Shale::Type::String
+
+    # @!attribute [rw] minutes
+    #   Returns minutes played
+    #   @api public
+    #   @example
+    #     stat.minutes #=> "240:00"
+    #   @return [String] the minutes
+    attribute :minutes, Shale::Type::String
+
+    # 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_defensive_v2.rb

@@ -0,0 +1,190 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "box_score_defensive_player_stat"
+require_relative "box_score_defensive_team_stat"
+require_relative "utils"
+
+module NBA
+  # Provides methods to retrieve defensive statistics for a game
+  module BoxScoreDefensiveV2
+    # 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 defensive statistics for players in a game
+    #
+    # @api public
+    # @example
+    #   stats = NBA::BoxScoreDefensiveV2.player_stats(game: "0022400001")
+    #   stats.each { |s| puts "#{s.name_i}: #{s.steals} steals" }
+    # @param game [String, Game] the game ID or Game object
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of player defensive stats
+    def self.player_stats(game:, client: CLIENT)
+      game_id = Utils.extract_id(game)
+      path = "boxscoredefensivev2?GameID=#{game_id}"
+      response = client.get(path)
+      parse_player_response(response, game_id)
+    end
+
+    # Retrieves defensive statistics for teams in a game
+    #
+    # @api public
+    # @example
+    #   stats = NBA::BoxScoreDefensiveV2.team_stats(game: "0022400001")
+    #   stats.each { |s| puts "#{s.team_name}: #{s.minutes} minutes" }
+    # @param game [String, Game] the game ID or Game object
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of team defensive stats
+    def self.team_stats(game:, client: CLIENT)
+      game_id = Utils.extract_id(game)
+      path = "boxscoredefensivev2?GameID=#{game_id}"
+      response = client.get(path)
+      parse_team_response(response, game_id)
+    end
+
+    # Parses player stats response
+    # @api private
+    # @param response [String, nil] the JSON response
+    # @param game_id [String] the game ID
+    # @return [Collection] collection of player stats
+    def self.parse_player_response(response, game_id)
+      return Collection.new unless response
+
+      data = JSON.parse(response)
+      result_set = find_result_set(data, PLAYER_STATS)
+      return Collection.new unless result_set
+
+      build_player_stats(result_set, game_id)
+    end
+    private_class_method :parse_player_response
+
+    # Parses team stats response
+    # @api private
+    # @param response [String, nil] the JSON response
+    # @param game_id [String] the game ID
+    # @return [Collection] collection of team stats
+    def self.parse_team_response(response, game_id)
+      return Collection.new unless response
+
+      data = JSON.parse(response)
+      result_set = find_result_set(data, TEAM_STATS)
+      return Collection.new unless result_set
+
+      build_team_stats(result_set, game_id)
+    end
+    private_class_method :parse_team_response
+
+    # Finds a result set by name
+    # @api private
+    # @param data [Hash] the parsed JSON
+    # @param name [String] the result set name
+    # @return [Hash, nil] the result set
+    def self.find_result_set(data, name)
+      result_sets = data["resultSets"]
+      return unless result_sets
+
+      result_sets.find { |rs| rs.fetch("name").eql?(name) }
+    end
+    private_class_method :find_result_set
+
+    # Builds player stats collection
+    # @api private
+    # @param result_set [Hash] the result set
+    # @param game_id [String] the game ID
+    # @return [Collection] collection of player stats
+    def self.build_player_stats(result_set, game_id)
+      headers = result_set["headers"]
+      rows = result_set["rowSet"]
+      return Collection.new unless headers && rows
+
+      stats = rows.map { |row| build_player_stat(headers, row, game_id) }
+      Collection.new(stats)
+    end
+    private_class_method :build_player_stats
+
+    # Builds team stats collection
+    # @api private
+    # @param result_set [Hash] the result set
+    # @param game_id [String] the game ID
+    # @return [Collection] collection of team stats
+    def self.build_team_stats(result_set, game_id)
+      headers = result_set["headers"]
+      rows = result_set["rowSet"]
+      return Collection.new unless headers && rows
+
+      stats = rows.map { |row| build_team_stat(headers, row, game_id) }
+      Collection.new(stats)
+    end
+    private_class_method :build_team_stats
+
+    # Builds a player stat
+    # @api private
+    # @return [BoxScoreDefensivePlayerStat] the player stat
+    def self.build_player_stat(headers, row, game_id)
+      data = headers.zip(row).to_h
+      BoxScoreDefensivePlayerStat.new(**player_identity(data, game_id), **defensive_stats(data), **shooting_stats(data))
+    end
+    private_class_method :build_player_stat
+
+    # Builds a team stat
+    # @api private
+    # @return [BoxScoreDefensiveTeamStat] the team stat
+    def self.build_team_stat(headers, row, game_id)
+      data = headers.zip(row).to_h
+      BoxScoreDefensiveTeamStat.new(**team_identity(data, game_id))
+    end
+    private_class_method :build_team_stat
+
+    # Extracts player identity attributes
+    # @api private
+    # @return [Hash] identity attributes
+    def self.player_identity(data, game_id)
+      {game_id: game_id, team_id: data.fetch("teamId"), team_city: data.fetch("teamCity"),
+       team_name: data.fetch("teamName"), team_tricode: data.fetch("teamTricode"), team_slug: data.fetch("teamSlug"),
+       person_id: data.fetch("personId"), first_name: data.fetch("firstName"), family_name: data.fetch("familyName"),
+       name_i: data.fetch("nameI"), player_slug: data.fetch("playerSlug"), position: data.fetch("position"),
+       comment: data.fetch("comment"), jersey_num: data.fetch("jerseyNum")}
+    end
+    private_class_method :player_identity
+
+    # Extracts team identity attributes
+    # @api private
+    # @return [Hash] identity attributes
+    def self.team_identity(data, game_id)
+      {game_id: game_id, team_id: data.fetch("teamId"), team_city: data.fetch("teamCity"),
+       team_name: data.fetch("teamName"), team_tricode: data.fetch("teamTricode"), team_slug: data.fetch("teamSlug"),
+       minutes: data.fetch("minutes")}
+    end
+    private_class_method :team_identity
+
+    # Extracts defensive stats
+    # @api private
+    # @return [Hash] defensive stats
+    def self.defensive_stats(data)
+      {matchup_minutes: data.fetch("matchupMinutes"), partial_possessions: data.fetch("partialPossessions"),
+       switches_on: data.fetch("switchesOn"), player_points: data.fetch("playerPoints"),
+       defensive_rebounds: data.fetch("defensiveRebounds"), matchup_assists: data.fetch("matchupAssists"),
+       matchup_turnovers: data.fetch("matchupTurnovers"), steals: data.fetch("steals"), blocks: data.fetch("blocks")}
+    end
+    private_class_method :defensive_stats
+
+    # Extracts shooting stats
+    # @api private
+    # @return [Hash] shooting stats
+    def self.shooting_stats(data)
+      {matchup_field_goals_made: data.fetch("matchupFieldGoalsMade"),
+       matchup_field_goals_attempted: data.fetch("matchupFieldGoalsAttempted"),
+       matchup_field_goal_percentage: data.fetch("matchupFieldGoalPercentage"),
+       matchup_three_pointers_made: data.fetch("matchupThreePointersMade"),
+       matchup_three_pointers_attempted: data.fetch("matchupThreePointersAttempted"),
+       matchup_three_pointer_percentage: data.fetch("matchupThreePointerPercentage")}
+    end
+    private_class_method :shooting_stats
+  end
+end

data/lib/nba/box_score_four_factors.rb

@@ -0,0 +1,91 @@
+require_relative "client"
+require_relative "response_parser"
+require_relative "box_score_four_factors_player_stat"
+require_relative "box_score_four_factors_team_stat"
+require_relative "utils"
+
+module NBA
+  # Provides methods to retrieve four factors box score statistics
+  module BoxScoreFourFactors
+    # 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 four factors box score stats for a game
+    #
+    # @api public
+    # @example
+    #   stats = NBA::BoxScoreFourFactors.player_stats(game: "0022400001")
+    #   stats.each { |s| puts "#{s.player_name}: #{s.efg_pct}% eFG" }
+    # @param game [String, Game] the game ID or Game object
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of player four factors box score stats
+    def self.player_stats(game:, client: CLIENT)
+      path = "boxscorefourfactorsv2?GameID=#{Utils.extract_id(game)}"
+      ResponseParser.parse(client.get(path), result_set: PLAYER_STATS) { |data| build_player_stat(data) }
+    end
+
+    # Retrieves team four factors box score stats for a game
+    #
+    # @api public
+    # @example
+    #   stats = NBA::BoxScoreFourFactors.team_stats(game: "0022400001")
+    #   stats.each { |s| puts "#{s.team_name}: #{s.tov_pct}% TOV" }
+    # @param game [String, Game] the game ID or Game object
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of team four factors box score stats
+    def self.team_stats(game:, client: CLIENT)
+      path = "boxscorefourfactorsv2?GameID=#{Utils.extract_id(game)}"
+      ResponseParser.parse(client.get(path), result_set: TEAM_STATS) { |data| build_team_stat(data) }
+    end
+
+    # Builds a player four factors stat from API data
+    # @api private
+    # @return [BoxScoreFourFactorsPlayerStat]
+    def self.build_player_stat(data)
+      BoxScoreFourFactorsPlayerStat.new(**player_identity(data), **four_factors(data))
+    end
+    private_class_method :build_player_stat
+
+    # Builds a team four factors stat from API data
+    # @api private
+    # @return [BoxScoreFourFactorsTeamStat]
+    def self.build_team_stat(data)
+      BoxScoreFourFactorsTeamStat.new(**team_identity(data), **four_factors(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 four factors statistics from data
+    # @api private
+    # @return [Hash]
+    def self.four_factors(data)
+      {efg_pct: data["EFG_PCT"], fta_rate: data["FTA_RATE"], tov_pct: data["TM_TOV_PCT"],
+       oreb_pct: data["OREB_PCT"], opp_efg_pct: data["OPP_EFG_PCT"], opp_fta_rate: data["OPP_FTA_RATE"],
+       opp_tov_pct: data["OPP_TOV_PCT"], opp_oreb_pct: data["OPP_OREB_PCT"]}
+    end
+    private_class_method :four_factors
+  end
+end