nba 0.1.1 → 0.2.0

data/lib/nba/synergy_play_types.rb

@@ -0,0 +1,211 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "utils"
+
+require_relative "play_type_stat"
+
+module NBA
+  # Provides methods to retrieve Synergy play type data
+  module SynergyPlayTypes
+    # Result set name for play types
+    # @return [String] the result set name
+    SYNERGY_PLAY_TYPE = "SynergyPlayType".freeze
+
+    # Season type constant for regular season
+    # @return [String] the season type
+    REGULAR_SEASON = "Regular Season".freeze
+
+    # Season type constant for playoffs
+    # @return [String] the season type
+    PLAYOFFS = "Playoffs".freeze
+
+    # Type grouping for offensive
+    # @return [String] the type grouping
+    OFFENSIVE = "offensive".freeze
+
+    # Type grouping for defensive
+    # @return [String] the type grouping
+    DEFENSIVE = "defensive".freeze
+
+    # Per mode constant for per game stats
+    # @return [String] the per mode
+    PER_GAME = "PerGame".freeze
+
+    # Per mode constant for totals
+    # @return [String] the per mode
+    TOTALS = "Totals".freeze
+
+    # Play type constant for isolation plays
+    # @return [String] the play type
+    ISOLATION = "Isolation".freeze
+    # Play type constant for transition plays
+    # @return [String] the play type
+    TRANSITION = "Transition".freeze
+    # Play type constant for pick and roll ball handler plays
+    # @return [String] the play type
+    PICK_AND_ROLL_BALL_HANDLER = "PRBallHandler".freeze
+    # Play type constant for pick and roll roll man plays
+    # @return [String] the play type
+    PICK_AND_ROLL_ROLL_MAN = "PRRollman".freeze
+    # Play type constant for post up plays
+    # @return [String] the play type
+    POST_UP = "Postup".freeze
+    # Play type constant for spot up plays
+    # @return [String] the play type
+    SPOT_UP = "Spotup".freeze
+    # Play type constant for handoff plays
+    # @return [String] the play type
+    HANDOFF = "Handoff".freeze
+    # Play type constant for cut plays
+    # @return [String] the play type
+    CUT = "Cut".freeze
+    # Play type constant for off screen plays
+    # @return [String] the play type
+    OFF_SCREEN = "OffScreen".freeze
+    # Play type constant for putback plays
+    # @return [String] the play type
+    PUTBACKS = "OffRebound".freeze
+    # Play type constant for miscellaneous plays
+    # @return [String] the play type
+    MISCELLANEOUS = "Misc".freeze
+
+    # Retrieves synergy play type stats for players
+    #
+    # @api public
+    # @example
+    #   stats = NBA::SynergyPlayTypes.player_stats(play_type: "Isolation", type_grouping: "offensive")
+    #   stats.each { |s| puts "#{s.player_name}: #{s.ppp} PPP" }
+    # @param play_type [String] the play type
+    # @param type_grouping [String] offensive or defensive
+    # @param season [Integer] the season year
+    # @param season_type [String] the season type
+    # @param per_mode [String] the per mode
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of play type stats
+    def self.player_stats(play_type:, type_grouping: OFFENSIVE, season: Utils.current_season,
+      season_type: REGULAR_SEASON, per_mode: PER_GAME, client: CLIENT)
+      path = build_path("player", play_type, type_grouping, season, season_type: season_type, per_mode: per_mode)
+      response = client.get(path)
+      parse_response(response, play_type, type_grouping)
+    end
+
+    # Retrieves synergy play type stats for teams
+    #
+    # @api public
+    # @example
+    #   stats = NBA::SynergyPlayTypes.team_stats(play_type: "Transition", type_grouping: "offensive")
+    #   stats.each { |s| puts "#{s.team_abbreviation}: #{s.ppp} PPP" }
+    # @param play_type [String] the play type
+    # @param type_grouping [String] offensive or defensive
+    # @param season [Integer] the season year
+    # @param season_type [String] the season type
+    # @param per_mode [String] the per mode
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of play type stats
+    def self.team_stats(play_type:, type_grouping: OFFENSIVE, season: Utils.current_season,
+      season_type: REGULAR_SEASON, per_mode: PER_GAME, client: CLIENT)
+      path = build_path("team", play_type, type_grouping, season, season_type: season_type, per_mode: per_mode)
+      response = client.get(path)
+      parse_response(response, play_type, type_grouping)
+    end
+
+    # Builds the API path
+    #
+    # @api private
+    # @return [String] the request path
+    def self.build_path(player_or_team, play_type, type_grouping, season, season_type:, per_mode:)
+      season_str = Utils.format_season(season)
+      "synergyplaytypes?LeagueID=00&SeasonYear=#{season_str}&SeasonType=#{season_type}" \
+        "&PerMode=#{per_mode}&PlayerOrTeam=#{player_or_team.capitalize}" \
+        "&PlayType=#{play_type}&TypeGrouping=#{type_grouping}"
+    end
+    private_class_method :build_path
+
+    # Parses the API response into play type stat objects
+    #
+    # @api private
+    # @return [Collection] collection of play type stats
+    def self.parse_response(response, play_type, type_grouping)
+      return Collection.new unless response
+
+      data = JSON.parse(response)
+      result_set = find_result_set(data)
+      return Collection.new unless result_set
+
+      headers = result_set["headers"]
+      rows = result_set["rowSet"]
+      return Collection.new unless headers && rows
+
+      stats = rows.map { |row| build_play_type_stat(headers, row, play_type, type_grouping) }
+      Collection.new(stats)
+    end
+    private_class_method :parse_response
+
+    # Finds the result set in the response
+    #
+    # @api private
+    # @return [Hash, nil] the result set hash
+    def self.find_result_set(data)
+      result_sets = data["resultSets"]
+      return unless result_sets
+
+      result_sets.find { |rs| rs["name"].eql?(SYNERGY_PLAY_TYPE) }
+    end
+    private_class_method :find_result_set
+
+    # Builds a PlayTypeStat object from raw data
+    #
+    # @api private
+    # @return [PlayTypeStat] the play type stat object
+    def self.build_play_type_stat(headers, row, play_type, type_grouping)
+      data = headers.zip(row).to_h
+      PlayTypeStat.new(**play_type_attributes(data, play_type, type_grouping))
+    end
+    private_class_method :build_play_type_stat
+
+    # Combines all play type attributes
+    #
+    # @api private
+    # @return [Hash] the combined attributes
+    def self.play_type_attributes(data, play_type, type_grouping)
+      identity_attributes(data, play_type, type_grouping)
+        .merge(possession_attributes(data))
+        .merge(efficiency_attributes(data))
+    end
+    private_class_method :play_type_attributes
+
+    # Extracts identity attributes from data
+    #
+    # @api private
+    # @return [Hash] identity attributes
+    def self.identity_attributes(data, play_type, type_grouping)
+      {player_id: data["PLAYER_ID"], player_name: data["PLAYER_NAME"],
+       team_id: data["TEAM_ID"], team_abbreviation: data["TEAM_ABBREVIATION"],
+       play_type: play_type, type_grouping: type_grouping, gp: data["GP"]}
+    end
+    private_class_method :identity_attributes
+
+    # Extracts possession attributes from data
+    #
+    # @api private
+    # @return [Hash] possession attributes
+    def self.possession_attributes(data)
+      {poss: data["POSS"], poss_pct: data["POSS_PCT"],
+       pts: data["PTS"], pts_pct: data["PTS_PCT"]}
+    end
+    private_class_method :possession_attributes
+
+    # Extracts efficiency attributes from data
+    #
+    # @api private
+    # @return [Hash] efficiency attributes
+    def self.efficiency_attributes(data)
+      {fgm: data["FGM"], fga: data["FGA"], fg_pct: data["FG_PCT"],
+       efg_pct: data["EFG_PCT"], ft_poss_pct: data["FT_POSS_PCT"],
+       tov_poss_pct: data["TOV_POSS_PCT"], sf_poss_pct: data["SF_POSS_PCT"],
+       ppp: data["PPP"], percentile: data["PERCENTILE"]}
+    end
+    private_class_method :efficiency_attributes
+  end
+end

data/lib/nba/team.rb

@@ -1,135 +1,211 @@
-require 'faraday'
-require 'json'
+require "equalizer"
+require "shale"
+require_relative "conference"
+require_relative "division"
 
 module NBA
-  class Team
-    attr_reader :name, :founded, :conference, :division, :championships, :players, :head_coach, :team_stats
-
-    alias :coach :head_coach
+  # Represents an NBA team
+  class Team < Shale::Mapper
+    include Equalizer.new(:id)
+
+    # @!group Team ID Constants
+
+    # Atlanta Hawks team ID
+    # @return [Integer] the team ID
+    ATL = 1_610_612_737
+    # Boston Celtics team ID
+    # @return [Integer] the team ID
+    BOS = 1_610_612_738
+    # Brooklyn Nets team ID
+    # @return [Integer] the team ID
+    BKN = 1_610_612_751
+    # Charlotte Hornets team ID
+    # @return [Integer] the team ID
+    CHA = 1_610_612_766
+    # Chicago Bulls team ID
+    # @return [Integer] the team ID
+    CHI = 1_610_612_741
+    # Cleveland Cavaliers team ID
+    # @return [Integer] the team ID
+    CLE = 1_610_612_739
+    # Dallas Mavericks team ID
+    # @return [Integer] the team ID
+    DAL = 1_610_612_742
+    # Denver Nuggets team ID
+    # @return [Integer] the team ID
+    DEN = 1_610_612_743
+    # Detroit Pistons team ID
+    # @return [Integer] the team ID
+    DET = 1_610_612_765
+    # Golden State Warriors team ID
+    # @return [Integer] the team ID
+    GSW = 1_610_612_744
+    # Houston Rockets team ID
+    # @return [Integer] the team ID
+    HOU = 1_610_612_745
+    # Indiana Pacers team ID
+    # @return [Integer] the team ID
+    IND = 1_610_612_754
+    # Los Angeles Clippers team ID
+    # @return [Integer] the team ID
+    LAC = 1_610_612_746
+    # Los Angeles Lakers team ID
+    # @return [Integer] the team ID
+    LAL = 1_610_612_747
+    # Memphis Grizzlies team ID
+    # @return [Integer] the team ID
+    MEM = 1_610_612_763
+    # Miami Heat team ID
+    # @return [Integer] the team ID
+    MIA = 1_610_612_748
+    # Milwaukee Bucks team ID
+    # @return [Integer] the team ID
+    MIL = 1_610_612_749
+    # Minnesota Timberwolves team ID
+    # @return [Integer] the team ID
+    MIN = 1_610_612_750
+    # New Orleans Pelicans team ID
+    # @return [Integer] the team ID
+    NOP = 1_610_612_740
+    # New York Knicks team ID
+    # @return [Integer] the team ID
+    NYK = 1_610_612_752
+    # Oklahoma City Thunder team ID
+    # @return [Integer] the team ID
+    OKC = 1_610_612_760
+    # Orlando Magic team ID
+    # @return [Integer] the team ID
+    ORL = 1_610_612_753
+    # Philadelphia 76ers team ID
+    # @return [Integer] the team ID
+    PHI = 1_610_612_755
+    # Phoenix Suns team ID
+    # @return [Integer] the team ID
+    PHX = 1_610_612_756
+    # Portland Trail Blazers team ID
+    # @return [Integer] the team ID
+    POR = 1_610_612_757
+    # Sacramento Kings team ID
+    # @return [Integer] the team ID
+    SAC = 1_610_612_758
+    # San Antonio Spurs team ID
+    # @return [Integer] the team ID
+    SAS = 1_610_612_759
+    # Toronto Raptors team ID
+    # @return [Integer] the team ID
+    TOR = 1_610_612_761
+    # Utah Jazz team ID
+    # @return [Integer] the team ID
+    UTA = 1_610_612_762
+    # Washington Wizards team ID
+    # @return [Integer] the team ID
+    WAS = 1_610_612_764
+
+    # @!endgroup
+
+    # @!attribute [rw] id
+    #   Returns the unique identifier for the team
+    #   @api public
+    #   @example
+    #     team.id #=> 1610612747
+    #   @return [Integer] the unique identifier for the team
+    attribute :id, Shale::Type::Integer
+
+    # @!attribute [rw] name
+    #   Returns the team name
+    #   @api public
+    #   @example
+    #     team.name #=> "Los Angeles Lakers"
+    #   @return [String] the team name
+    attribute :name, Shale::Type::String
+
+    # @!attribute [rw] full_name
+    #   Returns the team's full name
+    #   @api public
+    #   @example
+    #     team.full_name #=> "Los Angeles Lakers"
+    #   @return [String] the team's full name
+    attribute :full_name, Shale::Type::String
+
+    # @!attribute [rw] abbreviation
+    #   Returns the team abbreviation
+    #   @api public
+    #   @example
+    #     team.abbreviation #=> "LAL"
+    #   @return [String] the team abbreviation
+    attribute :abbreviation, Shale::Type::String
+
+    # @!attribute [rw] nickname
+    #   Returns the team nickname
+    #   @api public
+    #   @example
+    #     team.nickname #=> "Lakers"
+    #   @return [String] the team nickname
+    attribute :nickname, Shale::Type::String
+
+    # @!attribute [rw] city
+    #   Returns the team's city
+    #   @api public
+    #   @example
+    #     team.city #=> "Los Angeles"
+    #   @return [String] the team's city
+    attribute :city, Shale::Type::String
+
+    # @!attribute [rw] state
+    #   Returns the team's state
+    #   @api public
+    #   @example
+    #     team.state #=> "California"
+    #   @return [String] the team's state
+    attribute :state, Shale::Type::String
+
+    # @!attribute [rw] year_founded
+    #   Returns the year the team was founded
+    #   @api public
+    #   @example
+    #     team.year_founded #=> 1947
+    #   @return [Integer] the year the team was founded
+    attribute :year_founded, Shale::Type::Integer
+
+    # @!attribute [rw] conference
+    #   Returns the team's conference
+    #   @api public
+    #   @example
+    #     team.conference #=> #<NBA::Conference>
+    #   @return [Conference] the team's conference
+    attribute :conference, Conference
+
+    # @!attribute [rw] division
+    #   Returns the team's division
+    #   @api public
+    #   @example
+    #     team.division #=> #<NBA::Division>
+    #   @return [Division] the team's division
+    attribute :division, Division
+
+    json do
+      map "id", to: :id
+      map "name", to: :name
+      map "full_name", to: :full_name
+      map "fullName", to: :full_name
+      map "abbreviation", to: :abbreviation
+      map "nickname", to: :nickname
+      map "city", to: :city
+      map "state", to: :state
+      map "year_founded", to: :year_founded
+      map "yearFounded", to: :year_founded
+      map "conference", to: :conference
+      map "division", to: :division
+    end
 
-    # Returns an array of Team objects
+    # Returns the team's home arena
     #
+    # @api public
     # @example
-    #   NBA::Team.all.first.name                    # => "Atlanta Hawks"
-    #   NBA::Team.all.first.division                # => "Southeast Division"
-    #   NBA::Team.all.first.founded                 # => 1946
-    #   NBA::Team.all.first.players.first.name      # => "Al Horford"
-    #   NBA::Team.all.first.players.first.number    # => 15
-    #   NBA::Team.all.first.players.first.position  # => ["Forward-center"]
-    def self.all
-      # Attempt to fetch the result from the Freebase API unless there is a
-      # connection error, in which case read from a fixture file
-      @all ||= begin
-        results_to_team(results_from_freebase)
-      rescue Errno::EHOSTUNREACH, Faraday::Error::ConnectionFailed, Faraday::Error::TimeoutError
-        results_to_team(results_from_cache)
-      end
-    end
-
-    def self.reset
-      @all = nil
+    #   team.arena #=> "Chase Center"
+    # @return [String, nil] the arena name
+    def arena
+      TeamDetails.find(team: id)&.arena
     end
-
-    ADJUST_WIDTH = 16
-    def pretty_print
-      puts "%#{ADJUST_WIDTH}s: #{self.name}" % "Name"
-      puts "%#{ADJUST_WIDTH}s: #{self.founded}" % "Founded"
-      puts "%#{ADJUST_WIDTH}s: #{self.conference}" % "Conference"
-      puts "%#{ADJUST_WIDTH}s: #{self.division}" % "Division"
-      puts "%#{ADJUST_WIDTH}s: #{self.coach}" % "Coach"
-      puts "%#{ADJUST_WIDTH}s: #{pretty_print_championships}" % "Championships"
-      puts "%#{ADJUST_WIDTH}s: #{pretty_print_players}" % "Players"
-    end
-
-    private
-
-      def initialize(attributes = {})
-        attributes.each do |key, value|
-          instance_variable_set("@#{key}", value) if self.respond_to?(key)
-        end
-      end
-
-      def pretty_print_championships
-        idx = 0
-
-        self.championships.sort.reverse.each_slice(2).inject("") do |string, chams|
-          string << "\n" +  (" " * (ADJUST_WIDTH + 2)) if (idx += 1) != 1
-          string << chams.join(", ")
-        end
-      end
-
-      def pretty_print_players
-        idx = 0
-
-        self.players.sort_by{|p| -p.number}.reverse.inject("") do |string, player|
-          string << "\n" +  (" " * (ADJUST_WIDTH + 2)) if (idx += 1) != 1
-          string << player.pretty_print
-        end
-      end
-
-      def self.results_from_freebase
-        options = {:query => mql_query}
-        Request.get_teams('/freebase/v1/mqlread', options)
-      end
-
-      def self.results_from_cache
-        JSON.load(file_from_cache('teams.json').read)
-      end
-
-      def self.file_from_cache(file_name)
-        File.new(File.expand_path('../../../cache', __FILE__) + '/' + file_name)
-      end
-
-      def self.results_to_team(results)
-        results['result'].map do |result|
-          players       = result['/sports/sports_team/roster']
-
-          new(
-            :name          => result['name'],
-            :conference    => result['/basketball/basketball_team/conference'],
-            :division      => result['/basketball/basketball_team/division'],
-            :head_coach    => result['/basketball/basketball_team/head_coach'],
-            :team_stats    => result['/basketball/basketball_team/team_stats'],
-            :founded       => result['/sports/sports_team/founded'].to_i,
-            :championships => result['/sports/sports_team/championships'],
-            :players       => (players ? Player.all_from_roster(players) : [])
-          )
-        end
-      end
-
-      # Returns the MQL query for teams, as a Ruby hash
-      def self.mql_query
-        query = <<-eos
-          [{
-            "name":          null,
-            "mid":           null,
-            "/basketball/basketball_team/head_coach": null,
-            "/basketball/basketball_team/conference": null,
-            "/basketball/basketball_team/division": null,
-            "/sports/sports_team/founded": null,
-            "/sports/sports_team/championships": [],
-            "/sports/sports_team/roster": [{
-              "number":   null,
-              "player":   null,
-              "from":     null,
-              "to":       null,
-              "position": [],
-              "sort": "player"
-            }],
-            "/basketball/basketball_team/team_stats": [{
-              "optional": true,
-              "season": null,
-              "wins": null,
-              "losses": null
-            }],
-            "sort":          "name",
-            "type":          "/basketball/basketball_team",
-            "/sports/sports_team/league": [{
-              "league": "National Basketball Association"
-            }]
-          }]
-          eos
-        query.gsub!("\n", '')
-      end
   end
 end