nba 0.1.1 → 0.2.0

data/lib/nba/box_score_similarity_score.rb

@@ -0,0 +1,119 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "utils"
+
+require_relative "box_score_similarity_stat"
+
+module NBA
+  # Provides methods to retrieve G League Alum box score similarity scores
+  module BoxScoreSimilarityScore
+    # Result set name for similarity scores
+    # @return [String] the result set name
+    RESULT_SET_NAME = "GLeagueAlumBoxScoreSimilarityScores".freeze
+
+    # Regular season type constant
+    # @return [String] the season type
+    REGULAR_SEASON = "Regular Season".freeze
+
+    # Playoffs season type constant
+    # @return [String] the season type
+    PLAYOFFS = "Playoffs".freeze
+
+    # Retrieves box score similarity scores for two players
+    #
+    # @api public
+    # @example
+    #   stats = NBA::BoxScoreSimilarityScore.find(first_person: 201939, second_person: 203507)
+    #   stats.first.similarity_score #=> 0.85
+    # @param first_person [Integer, Player] the first player ID or Player object
+    # @param second_person [Integer, Player] the second player ID or Player object
+    # @param first_season [Integer] the season year for first player
+    # @param second_season [Integer] the season year for second player
+    # @param first_season_type [String] the season type for first player
+    # @param second_season_type [String] the season type for second player
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of similarity stats
+    def self.find(first_person:, second_person:, first_season: Utils.current_season, second_season: Utils.current_season,
+      first_season_type: REGULAR_SEASON, second_season_type: REGULAR_SEASON, client: CLIENT)
+      first_id = Utils.extract_id(first_person)
+      second_id = Utils.extract_id(second_person)
+      path = build_path(first_id: first_id, second_id: second_id, first_season: first_season, second_season: second_season,
+        first_season_type: first_season_type, second_season_type: second_season_type)
+      response = client.get(path)
+      parse_response(response, first_id)
+    end
+
+    # Builds the API path
+    #
+    # @api private
+    # @return [String] the request path
+    def self.build_path(opts)
+      "glalumboxscoresimilarityscore?Person1Id=#{opts[:first_id]}&Person2Id=#{opts[:second_id]}" \
+        "&Person1LeagueId=00&Person2LeagueId=00" \
+        "&Person1Season=#{Utils.format_season(opts[:first_season])}&Person2Season=#{Utils.format_season(opts[:second_season])}" \
+        "&Person1SeasonType=#{opts[:first_season_type]}&Person2SeasonType=#{opts[:second_season_type]}"
+    end
+    private_class_method :build_path
+
+    # Parses the API response into stat objects
+    #
+    # @api private
+    # @return [Collection] collection of similarity stats
+    def self.parse_response(response, first_person_id)
+      return Collection.new unless response
+
+      data = JSON.parse(response)
+      result_set = find_result_set(data)
+      return Collection.new unless result_set
+
+      build_stats(result_set, first_person_id)
+    end
+    private_class_method :parse_response
+
+    # Finds the result set by name
+    #
+    # @api private
+    # @return [Hash, nil] the result set hash or nil if not found
+    def self.find_result_set(data)
+      result_sets = data["resultSets"]
+      return unless result_sets
+
+      result_sets.find { |rs| rs["name"].eql?(RESULT_SET_NAME) }
+    end
+    private_class_method :find_result_set
+
+    # Builds stats collection from result set
+    #
+    # @api private
+    # @return [Collection] the stats collection
+    def self.build_stats(result_set, first_person_id)
+      headers = result_set["headers"]
+      rows = result_set["rowSet"]
+      return Collection.new unless headers && rows
+
+      Collection.new(rows.map { |row| build_stat(headers.zip(row).to_h, first_person_id) })
+    end
+    private_class_method :build_stats
+
+    # Builds a single stat object from API data
+    #
+    # @api private
+    # @return [BoxScoreSimilarityStat] the stat object
+    def self.build_stat(data, first_person_id)
+      BoxScoreSimilarityStat.new(**stat_attributes(data, first_person_id))
+    end
+    private_class_method :build_stat
+
+    # Extracts stat attributes from data
+    #
+    # @api private
+    # @return [Hash] the stat attributes
+    def self.stat_attributes(data, first_person_id)
+      {first_person_id: first_person_id, second_person_id: data["PERSON_2_ID"],
+       second_person_name: data["PERSON_2"], team_id: data["TEAM_ID"],
+       similarity_score: data["SIMILARITY_SCORE"]}
+    end
+    private_class_method :stat_attributes
+  end
+end

data/lib/nba/box_score_similarity_stat.rb

@@ -0,0 +1,76 @@
+module NBA
+  # Represents a G League Alum box score similarity score
+  class BoxScoreSimilarityStat < Shale::Mapper
+    include Equalizer.new(:first_person_id, :second_person_id)
+
+    # @!attribute [rw] first_person_id
+    #   Returns the first player ID
+    #   @api public
+    #   @example
+    #     stat.first_person_id #=> 201939
+    #   @return [Integer] the first player ID
+    attribute :first_person_id, Shale::Type::Integer
+
+    # @!attribute [rw] second_person_id
+    #   Returns the second player ID
+    #   @api public
+    #   @example
+    #     stat.second_person_id #=> 203507
+    #   @return [Integer] the second player ID
+    attribute :second_person_id, Shale::Type::Integer
+
+    # @!attribute [rw] second_person_name
+    #   Returns the second player name
+    #   @api public
+    #   @example
+    #     stat.second_person_name #=> "Giannis Antetokounmpo"
+    #   @return [String] the second player name
+    attribute :second_person_name, Shale::Type::String
+
+    # @!attribute [rw] team_id
+    #   Returns the team ID
+    #   @api public
+    #   @example
+    #     stat.team_id #=> 1610612749
+    #   @return [Integer] the team ID
+    attribute :team_id, Shale::Type::Integer
+
+    # @!attribute [rw] similarity_score
+    #   Returns the similarity score between the two players
+    #   @api public
+    #   @example
+    #     stat.similarity_score #=> 0.85
+    #   @return [Float] the similarity score
+    attribute :similarity_score, Shale::Type::Float
+
+    # Returns the first player object
+    #
+    # @api public
+    # @example
+    #   stat.first_person #=> #<NBA::Player>
+    # @return [Player, nil] the first player object
+    def first_person
+      Players.find(first_person_id)
+    end
+
+    # Returns the second player object
+    #
+    # @api public
+    # @example
+    #   stat.second_person #=> #<NBA::Player>
+    # @return [Player, nil] the second player object
+    def second_person
+      Players.find(second_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
+  end
+end

data/lib/nba/box_score_starter_bench_stat.rb

@@ -0,0 +1,257 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents starter vs bench aggregate statistics for a team in a game
+  class BoxScoreStarterBenchStat < Shale::Mapper
+    include Equalizer.new(:game_id, :team_id, :starters_bench)
+
+    # @!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] starters_bench
+    #   Returns whether this is starters or bench stats
+    #   @api public
+    #   @example
+    #     stat.starters_bench #=> "starters"
+    #   @return [String] "starters" or "bench"
+    attribute :starters_bench, Shale::Type::String
+
+    # @!attribute [rw] min
+    #   Returns minutes played
+    #   @api public
+    #   @example
+    #     stat.min #=> "PT120M00.00S"
+    #   @return [String] minutes played
+    attribute :min, Shale::Type::String
+
+    # @!attribute [rw] fgm
+    #   Returns field goals made
+    #   @api public
+    #   @example
+    #     stat.fgm #=> 35
+    #   @return [Integer] field goals made
+    attribute :fgm, Shale::Type::Integer
+
+    # @!attribute [rw] fga
+    #   Returns field goals attempted
+    #   @api public
+    #   @example
+    #     stat.fga #=> 70
+    #   @return [Integer] field goals attempted
+    attribute :fga, Shale::Type::Integer
+
+    # @!attribute [rw] fg_pct
+    #   Returns field goal percentage
+    #   @api public
+    #   @example
+    #     stat.fg_pct #=> 0.5
+    #   @return [Float] field goal percentage
+    attribute :fg_pct, Shale::Type::Float
+
+    # @!attribute [rw] fg3m
+    #   Returns three-pointers made
+    #   @api public
+    #   @example
+    #     stat.fg3m #=> 10
+    #   @return [Integer] three-pointers made
+    attribute :fg3m, Shale::Type::Integer
+
+    # @!attribute [rw] fg3a
+    #   Returns three-pointers attempted
+    #   @api public
+    #   @example
+    #     stat.fg3a #=> 25
+    #   @return [Integer] three-pointers attempted
+    attribute :fg3a, Shale::Type::Integer
+
+    # @!attribute [rw] fg3_pct
+    #   Returns three-point percentage
+    #   @api public
+    #   @example
+    #     stat.fg3_pct #=> 0.4
+    #   @return [Float] three-point percentage
+    attribute :fg3_pct, Shale::Type::Float
+
+    # @!attribute [rw] ftm
+    #   Returns free throws made
+    #   @api public
+    #   @example
+    #     stat.ftm #=> 15
+    #   @return [Integer] free throws made
+    attribute :ftm, Shale::Type::Integer
+
+    # @!attribute [rw] fta
+    #   Returns free throws attempted
+    #   @api public
+    #   @example
+    #     stat.fta #=> 18
+    #   @return [Integer] free throws attempted
+    attribute :fta, Shale::Type::Integer
+
+    # @!attribute [rw] ft_pct
+    #   Returns free throw percentage
+    #   @api public
+    #   @example
+    #     stat.ft_pct #=> 0.833
+    #   @return [Float] free throw percentage
+    attribute :ft_pct, Shale::Type::Float
+
+    # @!attribute [rw] oreb
+    #   Returns offensive rebounds
+    #   @api public
+    #   @example
+    #     stat.oreb #=> 8
+    #   @return [Integer] offensive rebounds
+    attribute :oreb, Shale::Type::Integer
+
+    # @!attribute [rw] dreb
+    #   Returns defensive rebounds
+    #   @api public
+    #   @example
+    #     stat.dreb #=> 22
+    #   @return [Integer] defensive rebounds
+    attribute :dreb, Shale::Type::Integer
+
+    # @!attribute [rw] reb
+    #   Returns total rebounds
+    #   @api public
+    #   @example
+    #     stat.reb #=> 30
+    #   @return [Integer] total rebounds
+    attribute :reb, Shale::Type::Integer
+
+    # @!attribute [rw] ast
+    #   Returns assists
+    #   @api public
+    #   @example
+    #     stat.ast #=> 20
+    #   @return [Integer] assists
+    attribute :ast, Shale::Type::Integer
+
+    # @!attribute [rw] stl
+    #   Returns steals
+    #   @api public
+    #   @example
+    #     stat.stl #=> 6
+    #   @return [Integer] steals
+    attribute :stl, Shale::Type::Integer
+
+    # @!attribute [rw] blk
+    #   Returns blocks
+    #   @api public
+    #   @example
+    #     stat.blk #=> 4
+    #   @return [Integer] blocks
+    attribute :blk, Shale::Type::Integer
+
+    # @!attribute [rw] tov
+    #   Returns turnovers
+    #   @api public
+    #   @example
+    #     stat.tov #=> 10
+    #   @return [Integer] turnovers
+    attribute :tov, Shale::Type::Integer
+
+    # @!attribute [rw] pf
+    #   Returns personal fouls
+    #   @api public
+    #   @example
+    #     stat.pf #=> 12
+    #   @return [Integer] personal fouls
+    attribute :pf, Shale::Type::Integer
+
+    # @!attribute [rw] pts
+    #   Returns points
+    #   @api public
+    #   @example
+    #     stat.pts #=> 95
+    #   @return [Integer] points
+    attribute :pts, Shale::Type::Integer
+
+    # @!attribute [rw] plus_minus
+    #   Returns plus/minus
+    #   @api public
+    #   @example
+    #     stat.plus_minus #=> 15
+    #   @return [Integer] plus/minus
+    attribute :plus_minus, Shale::Type::Integer
+
+    # Returns whether this is starter stats
+    #
+    # @api public
+    # @example
+    #   stat.starters? #=> true
+    # @return [Boolean] true if starters
+    def starters?
+      starters_bench.eql?("starters")
+    end
+
+    # Returns whether this is bench stats
+    #
+    # @api public
+    # @example
+    #   stat.bench? #=> true
+    # @return [Boolean] true if bench
+    def bench?
+      starters_bench.eql?("bench")
+    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
+  end
+end