mlb 0.9.0 → 0.11.0

data/lib/mlb/metric.rb

@@ -0,0 +1,48 @@
+require "equalizer"
+require "shale"
+
+module MLB
+  # Represents a statcast metric
+  class Metric < Shale::Mapper
+    include Equalizer.new(:metric_id)
+
+    # @!attribute [rw] name
+    #   Returns the metric name
+    #   @api public
+    #   @example
+    #     metric.name #=> "launchSpeed"
+    #   @return [String] the metric name
+    attribute :name, Shale::Type::String
+
+    # @!attribute [rw] metric_id
+    #   Returns the unique metric identifier
+    #   @api public
+    #   @example
+    #     metric.metric_id #=> 1
+    #   @return [Integer] the unique metric identifier
+    attribute :metric_id, Shale::Type::Integer
+
+    # @!attribute [rw] group
+    #   Returns the metric group
+    #   @api public
+    #   @example
+    #     metric.group #=> "hitting"
+    #   @return [String] the metric group
+    attribute :group, Shale::Type::String
+
+    # @!attribute [rw] unit
+    #   Returns the measurement unit
+    #   @api public
+    #   @example
+    #     metric.unit #=> "MPH"
+    #   @return [String] the measurement unit
+    attribute :unit, Shale::Type::String
+
+    json do
+      map "name", to: :name
+      map "metricId", to: :metric_id
+      map "group", to: :group
+      map "unit", to: :unit
+    end
+  end
+end

data/lib/mlb/metrics.rb

@@ -0,0 +1,12 @@
+require_relative "collection"
+require_relative "metric"
+
+module MLB
+  # Provides methods for fetching metrics from the API
+  #
+  # @example Fetch all metrics
+  #   MLB::Metrics.all #=> [#<MLB::Metric>, ...]
+  class Metrics < Collection
+    collection endpoint: "metrics", item_type: Metric, collection_name: :metrics
+  end
+end

data/lib/mlb/people_changes.rb

@@ -0,0 +1,34 @@
+require "shale"
+require "uri"
+require_relative "player"
+
+module MLB
+  # Provides methods for fetching people changes from the API
+  class PeopleChanges < Shale::Mapper
+    # @!attribute [rw] people
+    #   Returns the changed people
+    #   @api public
+    #   @example
+    #     people_changes.people #=> [#<MLB::Player>, ...]
+    #   @return [Array<Player>] the changed people
+    attribute :people, Player, collection: true
+
+    json do
+      map "people", to: :people
+    end
+
+    # Retrieves people changes since a date
+    #
+    # @api public
+    # @example Get people changes since a date
+    #   MLB::PeopleChanges.since(date: Date.new(2024, 6, 1))
+    # @param date [Date] the date to check changes from
+    # @return [Array<Player>] the changed people
+    def self.since(date:)
+      params = {updatedSince: date.to_s}
+      query_string = URI.encode_www_form(params)
+      response = CLIENT.get("people/changes?#{query_string}")
+      from_json(response).people
+    end
+  end
+end

data/lib/mlb/personnel.rb

@@ -0,0 +1,28 @@
+require "shale"
+require_relative "job"
+
+module MLB
+  # Provides methods for fetching team personnel from the API
+  class Personnel < Shale::Mapper
+    attribute :roster, Job, collection: true
+
+    json do
+      map "roster", to: :roster
+    end
+
+    # Retrieves personnel for a team
+    #
+    # @api public
+    # @example Get personnel for a team
+    #   MLB::Personnel.find(team: 147, season: 2024)
+    # @param team [Team, Integer] the team or team ID
+    # @param season [Integer, nil] the season year (defaults to current year)
+    # @return [Array<Job>] the personnel
+    def self.find(team:, season: nil)
+      season ||= Utils.current_season
+      team_id = Utils.extract_id(team)
+      response = CLIENT.get("teams/#{team_id}/personnel?#{Utils.build_query(season:)}")
+      from_json(response).roster
+    end
+  end
+end

data/lib/mlb/pitch_code.rb

@@ -0,0 +1,90 @@
+require "equalizer"
+require "shale"
+
+module MLB
+  # Represents a pitch code (result of a pitch)
+  class PitchCode < Shale::Mapper
+    include Equalizer.new(:code)
+
+    # @!attribute [rw] code
+    #   Returns the pitch code
+    #   @api public
+    #   @example
+    #     pitch_code.code #=> "B"
+    #   @return [String] the pitch code
+    attribute :code, Shale::Type::String
+
+    # @!attribute [rw] description
+    #   Returns the description
+    #   @api public
+    #   @example
+    #     pitch_code.description #=> "Ball"
+    #   @return [String] the description
+    attribute :description, Shale::Type::String
+
+    # @!attribute [rw] swing_status
+    #   Returns whether the batter swung
+    #   @api public
+    #   @example
+    #     pitch_code.swing_status #=> false
+    #   @return [Boolean] whether the batter swung
+    attribute :swing_status, Shale::Type::Boolean
+
+    # @!attribute [rw] strike_status
+    #   Returns whether this counts as a strike
+    #   @api public
+    #   @example
+    #     pitch_code.strike_status #=> false
+    #   @return [Boolean] whether this counts as a strike
+    attribute :strike_status, Shale::Type::Boolean
+
+    # @!attribute [rw] ball_status
+    #   Returns whether this counts as a ball
+    #   @api public
+    #   @example
+    #     pitch_code.ball_status #=> true
+    #   @return [Boolean] whether this counts as a ball
+    attribute :ball_status, Shale::Type::Boolean
+
+    # @!attribute [rw] sort_order
+    #   Returns the sort order
+    #   @api public
+    #   @example
+    #     pitch_code.sort_order #=> 1
+    #   @return [Integer] the sort order
+    attribute :sort_order, Shale::Type::Integer
+
+    # Returns whether the batter swung
+    #
+    # @api public
+    # @example
+    #   pitch_code.swing? #=> false
+    # @return [Boolean] whether the batter swung
+    def swing? = swing_status
+
+    # Returns whether this counts as a strike
+    #
+    # @api public
+    # @example
+    #   pitch_code.strike? #=> false
+    # @return [Boolean] whether this counts as a strike
+    def strike? = strike_status
+
+    # Returns whether this counts as a ball
+    #
+    # @api public
+    # @example
+    #   pitch_code.ball? #=> true
+    # @return [Boolean] whether this counts as a ball
+    def ball? = ball_status
+
+    json do
+      map "code", to: :code
+      map "description", to: :description
+      map "swingStatus", to: :swing_status
+      map "strikeStatus", to: :strike_status
+      map "ballStatus", to: :ball_status
+      map "sortOrder", to: :sort_order
+    end
+  end
+end

data/lib/mlb/pitch_codes.rb

@@ -0,0 +1,12 @@
+require_relative "collection"
+require_relative "pitch_code"
+
+module MLB
+  # Provides methods for fetching pitch codes from the API
+  #
+  # @example Fetch all pitch codes
+  #   MLB::PitchCodes.all #=> [#<MLB::PitchCode>, ...]
+  class PitchCodes < Collection
+    collection endpoint: "pitchCodes", item_type: PitchCode, collection_name: :pitch_codes
+  end
+end

data/lib/mlb/pitch_type.rb

@@ -0,0 +1,6 @@
+require_relative "code_description_type"
+
+module MLB
+  # Represents a pitch type (e.g., Fastball, Slider, Curveball)
+  class PitchType < CodeDescriptionType; end
+end

data/lib/mlb/pitch_types.rb

@@ -0,0 +1,12 @@
+require_relative "collection"
+require_relative "pitch_type"
+
+module MLB
+  # Provides methods for fetching pitch types from the API
+  #
+  # @example Fetch all pitch types
+  #   MLB::PitchTypes.all #=> [#<MLB::PitchType>, ...]
+  class PitchTypes < Collection
+    collection endpoint: "pitchTypes", item_type: PitchType, collection_name: :pitch_types
+  end
+end

data/lib/mlb/platform.rb

@@ -0,0 +1,30 @@
+require "equalizer"
+require "shale"
+
+module MLB
+  # Represents a platform
+  class Platform < Shale::Mapper
+    include Equalizer.new(:platform_code)
+
+    # @!attribute [rw] platform_code
+    #   Returns the platform code
+    #   @api public
+    #   @example
+    #     platform.platform_code #=> "web"
+    #   @return [String] the platform code
+    attribute :platform_code, Shale::Type::String
+
+    # @!attribute [rw] platform_description
+    #   Returns the platform description
+    #   @api public
+    #   @example
+    #     platform.platform_description #=> "Web"
+    #   @return [String] the platform description
+    attribute :platform_description, Shale::Type::String
+
+    json do
+      map "platformCode", to: :platform_code
+      map "platformDescription", to: :platform_description
+    end
+  end
+end

data/lib/mlb/platforms.rb

@@ -0,0 +1,12 @@
+require_relative "collection"
+require_relative "platform"
+
+module MLB
+  # Provides methods for fetching platforms from the API
+  #
+  # @example Fetch all platforms
+  #   MLB::Platforms.all #=> [#<MLB::Platform>, ...]
+  class Platforms < Collection
+    collection endpoint: "platforms", item_type: Platform, collection_name: :platforms
+  end
+end

data/lib/mlb/play.rb

@@ -0,0 +1,300 @@
+require "shale"
+require_relative "player"
+require_relative "handedness"
+
+module MLB
+  # Represents the result of a play
+  class PlayResult < Shale::Mapper
+    # @!attribute [rw] type
+    #   Returns the result type
+    #   @api public
+    #   @example
+    #     result.type #=> "atBat"
+    #   @return [String] the result type
+    attribute :type, Shale::Type::String
+
+    # @!attribute [rw] event
+    #   Returns the event name
+    #   @api public
+    #   @example
+    #     result.event #=> "Groundout"
+    #   @return [String] the event name
+    attribute :event, Shale::Type::String
+
+    # @!attribute [rw] event_type
+    #   Returns the event type code
+    #   @api public
+    #   @example
+    #     result.event_type #=> "field_out"
+    #   @return [String] the event type code
+    attribute :event_type, Shale::Type::String
+
+    # @!attribute [rw] description
+    #   Returns the description
+    #   @api public
+    #   @example
+    #     result.description #=> "Francisco Lindor grounds out..."
+    #   @return [String] the description
+    attribute :description, Shale::Type::String
+
+    # @!attribute [rw] rbi
+    #   Returns the RBIs on this play
+    #   @api public
+    #   @example
+    #     result.rbi #=> 0
+    #   @return [Integer] the RBIs
+    attribute :rbi, Shale::Type::Integer
+
+    # @!attribute [rw] away_score
+    #   Returns the away score after this play
+    #   @api public
+    #   @example
+    #     result.away_score #=> 0
+    #   @return [Integer] the away score
+    attribute :away_score, Shale::Type::Integer
+
+    # @!attribute [rw] home_score
+    #   Returns the home score after this play
+    #   @api public
+    #   @example
+    #     result.home_score #=> 0
+    #   @return [Integer] the home score
+    attribute :home_score, Shale::Type::Integer
+
+    # @!attribute [rw] is_out
+    #   Returns whether this play resulted in an out
+    #   @api public
+    #   @example
+    #     result.out? #=> true
+    #   @return [Boolean] whether an out occurred
+    attribute :is_out, Shale::Type::Boolean
+
+    # Returns whether this play resulted in an out
+    #
+    # @api public
+    # @example
+    #   result.out? #=> true
+    # @return [Boolean] whether an out occurred
+    def out?
+      is_out
+    end
+
+    json do
+      map "type", to: :type
+      map "event", to: :event
+      map "eventType", to: :event_type
+      map "description", to: :description
+      map "rbi", to: :rbi
+      map "awayScore", to: :away_score
+      map "homeScore", to: :home_score
+      map "isOut", to: :is_out
+    end
+  end
+
+  # Represents information about a play
+  class PlayAbout < Shale::Mapper
+    # @!attribute [rw] at_bat_index
+    #   Returns the at bat index
+    #   @api public
+    #   @example
+    #     about.at_bat_index #=> 0
+    #   @return [Integer] the at bat index
+    attribute :at_bat_index, Shale::Type::Integer
+
+    # @!attribute [rw] half_inning
+    #   Returns the half inning
+    #   @api public
+    #   @example
+    #     about.half_inning #=> "top"
+    #   @return [String] the half inning
+    attribute :half_inning, Shale::Type::String
+
+    # @!attribute [rw] is_top_inning
+    #   Returns whether it's the top of the inning
+    #   @api public
+    #   @example
+    #     about.top_inning? #=> true
+    #   @return [Boolean] whether top of inning
+    attribute :is_top_inning, Shale::Type::Boolean
+
+    # @!attribute [rw] inning
+    #   Returns the inning number
+    #   @api public
+    #   @example
+    #     about.inning #=> 1
+    #   @return [Integer] the inning
+    attribute :inning, Shale::Type::Integer
+
+    # @!attribute [rw] is_complete
+    #   Returns whether the play is complete
+    #   @api public
+    #   @example
+    #     about.complete? #=> true
+    #   @return [Boolean] whether complete
+    attribute :is_complete, Shale::Type::Boolean
+
+    # @!attribute [rw] is_scoring_play
+    #   Returns whether this is a scoring play
+    #   @api public
+    #   @example
+    #     about.scoring_play? #=> false
+    #   @return [Boolean] whether a scoring play
+    attribute :is_scoring_play, Shale::Type::Boolean
+
+    # Returns whether it's the top of the inning
+    #
+    # @api public
+    # @example
+    #   about.top_inning? #=> true
+    # @return [Boolean] whether top of inning
+    def top_inning?
+      is_top_inning
+    end
+
+    # Returns whether the play is complete
+    #
+    # @api public
+    # @example
+    #   about.complete? #=> true
+    # @return [Boolean] whether complete
+    def complete?
+      is_complete
+    end
+
+    # Returns whether this is a scoring play
+    #
+    # @api public
+    # @example
+    #   about.scoring_play? #=> false
+    # @return [Boolean] whether a scoring play
+    def scoring_play?
+      is_scoring_play
+    end
+
+    json do
+      map "atBatIndex", to: :at_bat_index
+      map "halfInning", to: :half_inning
+      map "isTopInning", to: :is_top_inning
+      map "inning", to: :inning
+      map "isComplete", to: :is_complete
+      map "isScoringPlay", to: :is_scoring_play
+    end
+  end
+
+  # Represents the count during a play
+  class PlayCount < Shale::Mapper
+    # @!attribute [rw] balls
+    #   Returns the ball count
+    #   @api public
+    #   @example
+    #     count.balls #=> 1
+    #   @return [Integer] the balls
+    attribute :balls, Shale::Type::Integer
+
+    # @!attribute [rw] strikes
+    #   Returns the strike count
+    #   @api public
+    #   @example
+    #     count.strikes #=> 1
+    #   @return [Integer] the strikes
+    attribute :strikes, Shale::Type::Integer
+
+    # @!attribute [rw] outs
+    #   Returns the out count
+    #   @api public
+    #   @example
+    #     count.outs #=> 1
+    #   @return [Integer] the outs
+    attribute :outs, Shale::Type::Integer
+
+    json do
+      map "balls", to: :balls
+      map "strikes", to: :strikes
+      map "outs", to: :outs
+    end
+  end
+
+  # Represents the matchup during a play
+  class PlayMatchup < Shale::Mapper
+    # @!attribute [rw] batter
+    #   Returns the batter
+    #   @api public
+    #   @example
+    #     matchup.batter #=> #<MLB::Player>
+    #   @return [Player] the batter
+    attribute :batter, Player
+
+    # @!attribute [rw] bat_side
+    #   Returns the bat side
+    #   @api public
+    #   @example
+    #     matchup.bat_side #=> #<MLB::Handedness>
+    #   @return [Handedness] the bat side
+    attribute :bat_side, Handedness
+
+    # @!attribute [rw] pitcher
+    #   Returns the pitcher
+    #   @api public
+    #   @example
+    #     matchup.pitcher #=> #<MLB::Player>
+    #   @return [Player] the pitcher
+    attribute :pitcher, Player
+
+    # @!attribute [rw] pitch_hand
+    #   Returns the pitch hand
+    #   @api public
+    #   @example
+    #     matchup.pitch_hand #=> #<MLB::Handedness>
+    #   @return [Handedness] the pitch hand
+    attribute :pitch_hand, Handedness
+
+    json do
+      map "batter", to: :batter
+      map "batSide", to: :bat_side
+      map "pitcher", to: :pitcher
+      map "pitchHand", to: :pitch_hand
+    end
+  end
+
+  # Represents a play in a game
+  class Play < Shale::Mapper
+    # @!attribute [rw] result
+    #   Returns the play result
+    #   @api public
+    #   @example
+    #     play.result #=> #<MLB::PlayResult>
+    #   @return [PlayResult] the result
+    attribute :result, PlayResult
+
+    # @!attribute [rw] about
+    #   Returns the play info
+    #   @api public
+    #   @example
+    #     play.about #=> #<MLB::PlayAbout>
+    #   @return [PlayAbout] the info
+    attribute :about, PlayAbout
+
+    # @!attribute [rw] count
+    #   Returns the count
+    #   @api public
+    #   @example
+    #     play.count #=> #<MLB::PlayCount>
+    #   @return [PlayCount] the count
+    attribute :count, PlayCount
+
+    # @!attribute [rw] matchup
+    #   Returns the matchup
+    #   @api public
+    #   @example
+    #     play.matchup #=> #<MLB::PlayMatchup>
+    #   @return [PlayMatchup] the matchup
+    attribute :matchup, PlayMatchup
+
+    json do
+      map "result", to: :result
+      map "about", to: :about
+      map "count", to: :count
+      map "matchup", to: :matchup
+    end
+  end
+end

data/lib/mlb/play_by_play.rb

@@ -0,0 +1,52 @@
+require "shale"
+require_relative "play"
+
+module MLB
+  # Provides methods for fetching play-by-play data from the API
+  class PlayByPlay < Shale::Mapper
+    # @!attribute [rw] all_plays
+    #   Returns all plays in the game
+    #   @api public
+    #   @example
+    #     pbp.all_plays #=> [#<MLB::Play>, ...]
+    #   @return [Array<Play>] all plays
+    attribute :all_plays, Play, collection: true
+
+    # @!attribute [rw] current_play
+    #   Returns the current play
+    #   @api public
+    #   @example
+    #     pbp.current_play #=> #<MLB::Play>
+    #   @return [Play] the current play
+    attribute :current_play, Play
+
+    # @!attribute [rw] scoring_plays
+    #   Returns indices of scoring plays
+    #   @api public
+    #   @example
+    #     pbp.scoring_plays #=> [5, 12, 23]
+    #   @return [Array<Integer>] scoring play indices
+    attribute :scoring_plays, Shale::Type::Integer, collection: true
+
+    json do
+      map "allPlays", to: :all_plays
+      map "currentPlay", to: :current_play
+      map "scoringPlays", to: :scoring_plays
+    end
+
+    # Retrieves play-by-play data for a game
+    #
+    # @api public
+    # @example Get play-by-play for a game
+    #   MLB::PlayByPlay.find(game: 745571)
+    # @example Get play-by-play for a scheduled game
+    #   MLB::PlayByPlay.find(game: ScheduledGame.new(game_pk: 745571))
+    # @param game [Integer, ScheduledGame] the game ID or game object
+    # @return [PlayByPlay] the play-by-play data
+    def self.find(game:)
+      game_pk = game.respond_to?(:game_pk) ? game.game_pk : game
+      response = CLIENT.get("game/#{game_pk}/playByPlay")
+      from_json(response)
+    end
+  end
+end