nba 0.1.1 → 0.2.0

data/lib/nba/player_index_entry.rb

@@ -0,0 +1,266 @@
+module NBA
+  # Represents a player from the player index endpoint
+  #
+  # @api public
+  class PlayerIndexEntry < Shale::Mapper
+    include Equalizer.new(:id)
+
+    # @!attribute [rw] id
+    #   Returns the player ID
+    #   @api public
+    #   @example
+    #     entry.id #=> 201939
+    #   @return [Integer] the player ID
+    attribute :id, Shale::Type::Integer
+
+    # @!attribute [rw] last_name
+    #   Returns the player's last name
+    #   @api public
+    #   @example
+    #     entry.last_name #=> "Curry"
+    #   @return [String] the last name
+    attribute :last_name, Shale::Type::String
+
+    # @!attribute [rw] first_name
+    #   Returns the player's first name
+    #   @api public
+    #   @example
+    #     entry.first_name #=> "Stephen"
+    #   @return [String] the first name
+    attribute :first_name, Shale::Type::String
+
+    # @!attribute [rw] slug
+    #   Returns the player's URL slug
+    #   @api public
+    #   @example
+    #     entry.slug #=> "stephen-curry"
+    #   @return [String] the slug
+    attribute :slug, Shale::Type::String
+
+    # @!attribute [rw] team_id
+    #   Returns the team ID
+    #   @api public
+    #   @example
+    #     entry.team_id #=> 1610612744
+    #   @return [Integer] the team ID
+    attribute :team_id, Shale::Type::Integer
+
+    # @!attribute [rw] team_slug
+    #   Returns the team's URL slug
+    #   @api public
+    #   @example
+    #     entry.team_slug #=> "warriors"
+    #   @return [String] the team slug
+    attribute :team_slug, Shale::Type::String
+
+    # @!attribute [rw] team_city
+    #   Returns the team's city
+    #   @api public
+    #   @example
+    #     entry.team_city #=> "Golden State"
+    #   @return [String] the team city
+    attribute :team_city, Shale::Type::String
+
+    # @!attribute [rw] team_name
+    #   Returns the team's name
+    #   @api public
+    #   @example
+    #     entry.team_name #=> "Warriors"
+    #   @return [String] the team name
+    attribute :team_name, Shale::Type::String
+
+    # @!attribute [rw] team_abbreviation
+    #   Returns the team's abbreviation
+    #   @api public
+    #   @example
+    #     entry.team_abbreviation #=> "GSW"
+    #   @return [String] the team abbreviation
+    attribute :team_abbreviation, Shale::Type::String
+
+    # @!attribute [rw] jersey_number
+    #   Returns the player's jersey number
+    #   @api public
+    #   @example
+    #     entry.jersey_number #=> "30"
+    #   @return [String] the jersey number
+    attribute :jersey_number, Shale::Type::String
+
+    # @!attribute [rw] position
+    #   Returns the player's position
+    #   @api public
+    #   @example
+    #     entry.position #=> "G"
+    #   @return [String] the position
+    attribute :position, Shale::Type::String
+
+    # @!attribute [rw] height
+    #   Returns the player's height
+    #   @api public
+    #   @example
+    #     entry.height #=> "6-2"
+    #   @return [String] the height
+    attribute :height, Shale::Type::String
+
+    # @!attribute [rw] weight
+    #   Returns the player's weight in pounds
+    #   @api public
+    #   @example
+    #     entry.weight #=> 185
+    #   @return [Integer] the weight
+    attribute :weight, Shale::Type::Integer
+
+    # @!attribute [rw] college
+    #   Returns the player's college
+    #   @api public
+    #   @example
+    #     entry.college #=> "Davidson"
+    #   @return [String] the college
+    attribute :college, Shale::Type::String
+
+    # @!attribute [rw] country
+    #   Returns the player's country
+    #   @api public
+    #   @example
+    #     entry.country #=> "USA"
+    #   @return [String] the country
+    attribute :country, Shale::Type::String
+
+    # @!attribute [rw] draft_year
+    #   Returns the player's draft year
+    #   @api public
+    #   @example
+    #     entry.draft_year #=> 2009
+    #   @return [Integer] the draft year
+    attribute :draft_year, Shale::Type::Integer
+
+    # @!attribute [rw] draft_round
+    #   Returns the player's draft round
+    #   @api public
+    #   @example
+    #     entry.draft_round #=> 1
+    #   @return [Integer] the draft round
+    attribute :draft_round, Shale::Type::Integer
+
+    # @!attribute [rw] draft_number
+    #   Returns the player's draft pick number
+    #   @api public
+    #   @example
+    #     entry.draft_number #=> 7
+    #   @return [Integer] the draft number
+    attribute :draft_number, Shale::Type::Integer
+
+    # @!attribute [rw] roster_status
+    #   Returns the player's roster status
+    #   @api public
+    #   @example
+    #     entry.roster_status #=> 1
+    #   @return [Integer] the roster status
+    attribute :roster_status, Shale::Type::Integer
+
+    # @!attribute [rw] pts
+    #   Returns career points per game
+    #   @api public
+    #   @example
+    #     entry.pts #=> 24.8
+    #   @return [Float] points per game
+    attribute :pts, Shale::Type::Float
+
+    # @!attribute [rw] reb
+    #   Returns career rebounds per game
+    #   @api public
+    #   @example
+    #     entry.reb #=> 4.7
+    #   @return [Float] rebounds per game
+    attribute :reb, Shale::Type::Float
+
+    # @!attribute [rw] ast
+    #   Returns career assists per game
+    #   @api public
+    #   @example
+    #     entry.ast #=> 6.5
+    #   @return [Float] assists per game
+    attribute :ast, Shale::Type::Float
+
+    # @!attribute [rw] stats_timeframe
+    #   Returns the stats timeframe
+    #   @api public
+    #   @example
+    #     entry.stats_timeframe #=> "Season"
+    #   @return [String] the stats timeframe
+    attribute :stats_timeframe, Shale::Type::String
+
+    # @!attribute [rw] from_year
+    #   Returns the first year played
+    #   @api public
+    #   @example
+    #     entry.from_year #=> 2009
+    #   @return [Integer] the first year
+    attribute :from_year, Shale::Type::Integer
+
+    # @!attribute [rw] to_year
+    #   Returns the last year played
+    #   @api public
+    #   @example
+    #     entry.to_year #=> 2024
+    #   @return [Integer] the last year
+    attribute :to_year, Shale::Type::Integer
+
+    # @!attribute [rw] is_defunct
+    #   Returns whether the player's team is defunct
+    #   @api public
+    #   @example
+    #     entry.is_defunct #=> 0
+    #   @return [Integer] defunct flag (0 or 1)
+    attribute :is_defunct, Shale::Type::Integer
+
+    # Returns the player's full name
+    #
+    # @api public
+    # @example
+    #   entry.full_name #=> "Stephen Curry"
+    # @return [String] the full name
+    def full_name
+      "#{first_name} #{last_name}".strip
+    end
+
+    # Returns whether the player is currently on a roster
+    #
+    # @api public
+    # @example
+    #   entry.active? #=> true
+    # @return [Boolean] true if on a roster
+    def active?
+      roster_status.eql?(1)
+    end
+
+    # Returns whether the player's team is defunct
+    #
+    # @api public
+    # @example
+    #   entry.defunct? #=> false
+    # @return [Boolean] true if team is defunct
+    def defunct?
+      is_defunct.eql?(1)
+    end
+
+    # Returns the player object
+    #
+    # @api public
+    # @example
+    #   entry.player #=> #<NBA::Player>
+    # @return [Player, nil] the player object
+    def player
+      Players.find(id)
+    end
+
+    # Returns the team object
+    #
+    # @api public
+    # @example
+    #   entry.team #=> #<NBA::Team>
+    # @return [Team, nil] the team object
+    def team
+      Teams.find(team_id)
+    end
+  end
+end

data/lib/nba/player_info.rb

@@ -0,0 +1,225 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents detailed player biographical information
+  class PlayerInfo < Shale::Mapper
+    include Equalizer.new(:player_id)
+
+    # @!attribute [rw] player_id
+    #   Returns the player ID
+    #   @api public
+    #   @example
+    #     info.player_id #=> 201939
+    #   @return [Integer] the player ID
+    attribute :player_id, Shale::Type::Integer
+
+    # @!attribute [rw] first_name
+    #   Returns the player's first name
+    #   @api public
+    #   @example
+    #     info.first_name #=> "Stephen"
+    #   @return [String] the player's first name
+    attribute :first_name, Shale::Type::String
+
+    # @!attribute [rw] last_name
+    #   Returns the player's last name
+    #   @api public
+    #   @example
+    #     info.last_name #=> "Curry"
+    #   @return [String] the player's last name
+    attribute :last_name, Shale::Type::String
+
+    # @!attribute [rw] display_name
+    #   Returns the player's display name
+    #   @api public
+    #   @example
+    #     info.display_name #=> "Stephen Curry"
+    #   @return [String] the player's display name
+    attribute :display_name, Shale::Type::String
+
+    # @!attribute [rw] birthdate
+    #   Returns the player's birthdate
+    #   @api public
+    #   @example
+    #     info.birthdate #=> "1988-03-14"
+    #   @return [String] the player's birthdate
+    attribute :birthdate, Shale::Type::String
+
+    # @!attribute [rw] school
+    #   Returns the player's school
+    #   @api public
+    #   @example
+    #     info.school #=> "Davidson"
+    #   @return [String] the player's school
+    attribute :school, Shale::Type::String
+
+    # @!attribute [rw] country
+    #   Returns the player's country
+    #   @api public
+    #   @example
+    #     info.country #=> "USA"
+    #   @return [String] the player's country
+    attribute :country, Shale::Type::String
+
+    # @!attribute [rw] height
+    #   Returns the player's height
+    #   @api public
+    #   @example
+    #     info.height #=> "6-2"
+    #   @return [String] the player's height
+    attribute :height, Shale::Type::String
+
+    # @!attribute [rw] weight
+    #   Returns the player's weight in pounds
+    #   @api public
+    #   @example
+    #     info.weight #=> 185
+    #   @return [Integer] the player's weight
+    attribute :weight, Shale::Type::Integer
+
+    # @!attribute [rw] season_exp
+    #   Returns the player's years of experience
+    #   @api public
+    #   @example
+    #     info.season_exp #=> 15
+    #   @return [Integer] years of experience
+    attribute :season_exp, Shale::Type::Integer
+
+    # @!attribute [rw] jersey
+    #   Returns the player's jersey number
+    #   @api public
+    #   @example
+    #     info.jersey #=> "30"
+    #   @return [String] the jersey number
+    attribute :jersey, Shale::Type::String
+
+    # @!attribute [rw] position
+    #   Returns the player's position
+    #   @api public
+    #   @example
+    #     info.position #=> "Guard"
+    #   @return [String] the player's position
+    attribute :position, Shale::Type::String
+
+    # @!attribute [rw] team_id
+    #   Returns the player's team ID
+    #   @api public
+    #   @example
+    #     info.team_id #=> 1610612744
+    #   @return [Integer] the team ID
+    attribute :team_id, Shale::Type::Integer
+
+    # @!attribute [rw] team_name
+    #   Returns the player's team name
+    #   @api public
+    #   @example
+    #     info.team_name #=> "Warriors"
+    #   @return [String] the team name
+    attribute :team_name, Shale::Type::String
+
+    # @!attribute [rw] team_abbreviation
+    #   Returns the player's team abbreviation
+    #   @api public
+    #   @example
+    #     info.team_abbreviation #=> "GSW"
+    #   @return [String] the team abbreviation
+    attribute :team_abbreviation, Shale::Type::String
+
+    # @!attribute [rw] team_city
+    #   Returns the player's team city
+    #   @api public
+    #   @example
+    #     info.team_city #=> "Golden State"
+    #   @return [String] the team city
+    attribute :team_city, Shale::Type::String
+
+    # @!attribute [rw] draft_year
+    #   Returns the year the player was drafted
+    #   @api public
+    #   @example
+    #     info.draft_year #=> 2009
+    #   @return [Integer] the draft year
+    attribute :draft_year, Shale::Type::Integer
+
+    # @!attribute [rw] draft_round
+    #   Returns the round the player was drafted
+    #   @api public
+    #   @example
+    #     info.draft_round #=> 1
+    #   @return [Integer] the draft round
+    attribute :draft_round, Shale::Type::Integer
+
+    # @!attribute [rw] draft_number
+    #   Returns the pick number
+    #   @api public
+    #   @example
+    #     info.draft_number #=> 7
+    #   @return [Integer] the draft number
+    attribute :draft_number, Shale::Type::Integer
+
+    # @!attribute [rw] from_year
+    #   Returns the player's first NBA year
+    #   @api public
+    #   @example
+    #     info.from_year #=> 2009
+    #   @return [Integer] the first year
+    attribute :from_year, Shale::Type::Integer
+
+    # @!attribute [rw] to_year
+    #   Returns the player's most recent NBA year
+    #   @api public
+    #   @example
+    #     info.to_year #=> 2024
+    #   @return [Integer] the most recent year
+    attribute :to_year, Shale::Type::Integer
+
+    # @!attribute [rw] greatest_75_flag
+    #   Returns whether the player is in the NBA 75 greatest
+    #   @api public
+    #   @example
+    #     info.greatest_75_flag #=> "Y"
+    #   @return [String] Y or N
+    attribute :greatest_75_flag, Shale::Type::String
+
+    # Returns the player object
+    #
+    # @api public
+    # @example
+    #   info.player #=> #<NBA::Player>
+    # @return [Player, nil] the player object
+    def player
+      Players.find(player_id)
+    end
+
+    # Returns the team object
+    #
+    # @api public
+    # @example
+    #   info.team #=> #<NBA::Team>
+    # @return [Team, nil] the team object
+    def team
+      Teams.find(team_id)
+    end
+
+    # Returns the player's full name
+    #
+    # @api public
+    # @example
+    #   info.full_name #=> "Stephen Curry"
+    # @return [String] the full name
+    def full_name
+      display_name || "#{first_name} #{last_name}".strip
+    end
+
+    # Returns whether the player is in the NBA 75 greatest
+    #
+    # @api public
+    # @example
+    #   info.greatest_75? #=> true
+    # @return [Boolean] true if in NBA 75
+    def greatest_75?
+      greatest_75_flag.eql?("Y")
+    end
+  end
+end

data/lib/nba/player_next_n_games.rb

@@ -0,0 +1,64 @@
+require_relative "client"
+require_relative "response_parser"
+require_relative "upcoming_game"
+require_relative "utils"
+
+module NBA
+  # Provides methods to retrieve a player's upcoming games
+  #
+  # @api public
+  module PlayerNextNGames
+    # Result set name
+    # @return [String] the result set name
+    RESULT_SET_NAME = "NextNGames".freeze
+
+    # Retrieves upcoming games for a player
+    #
+    # @api public
+    # @example
+    #   games = NBA::PlayerNextNGames.find(player: 201939, number_of_games: 5)
+    #   games.each { |g| puts "#{g.game_date}: vs #{g.visitor_team_name}" }
+    # @param player [Integer, Player] the player ID or Player object
+    # @param number_of_games [Integer] the number of games to return
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of upcoming games
+    def self.find(player:, number_of_games: 5, client: CLIENT)
+      id = Utils.extract_id(player)
+      path = "playernextngames?PlayerID=#{id}&NumberOfGames=#{number_of_games}&LeagueID=00"
+      ResponseParser.parse(client.get(path), result_set: RESULT_SET_NAME) { |data| build_game(data) }
+    end
+
+    # Builds an upcoming game from API data
+    #
+    # @api private
+    # @return [UpcomingGame]
+    def self.build_game(data)
+      UpcomingGame.new(**game_info(data), **team_info(data))
+    end
+    private_class_method :build_game
+
+    # Extracts game information from data
+    #
+    # @api private
+    # @return [Hash]
+    def self.game_info(data)
+      {game_id: data["GAME_ID"], game_date: data["GAME_DATE"],
+       game_time: data["GAME_TIME"]}
+    end
+    private_class_method :game_info
+
+    # Extracts team information from data
+    #
+    # @api private
+    # @return [Hash]
+    def self.team_info(data)
+      {home_team_id: data["HOME_TEAM_ID"], visitor_team_id: data["VISITOR_TEAM_ID"],
+       home_team_name: data["HOME_TEAM_NAME"], visitor_team_name: data["VISITOR_TEAM_NAME"],
+       home_team_abbreviation: data["HOME_TEAM_ABBREVIATION"],
+       visitor_team_abbreviation: data["VISITOR_TEAM_ABBREVIATION"],
+       home_team_nickname: data["HOME_TEAM_NICKNAME"],
+       visitor_team_nickname: data["VISITOR_TEAM_NICKNAME"]}
+    end
+    private_class_method :team_info
+  end
+end