mlb 0.10.0 → 0.11.0

data/lib/mlb/linescore.rb

@@ -0,0 +1,342 @@
+require "shale"
+require_relative "inning_score"
+require_relative "linescore_teams"
+
+module MLB
+  # Represents a game's linescore
+  class Linescore < Shale::Mapper
+    INNING_TOP = "Top".freeze
+    INNING_MIDDLE = "Middle".freeze
+    INNING_BOTTOM = "Bottom".freeze
+
+    # @!attribute [rw] current_inning
+    #   Returns the current inning number
+    #   @api public
+    #   @example
+    #     linescore.current_inning #=> 9
+    #   @return [Integer] the current inning
+    attribute :current_inning, Shale::Type::Integer
+
+    # @!attribute [rw] current_inning_ordinal
+    #   Returns the current inning ordinal
+    #   @api public
+    #   @example
+    #     linescore.current_inning_ordinal #=> "9th"
+    #   @return [String] the current inning ordinal
+    attribute :current_inning_ordinal, Shale::Type::String
+
+    # @!attribute [rw] inning_state
+    #   Returns the inning state (Top/Middle/Bottom/End)
+    #   @api public
+    #   @example
+    #     linescore.inning_state #=> "Bottom"
+    #   @return [String] the inning state
+    attribute :inning_state, Shale::Type::String
+
+    # @!attribute [rw] inning_half
+    #   Returns the inning half
+    #   @api public
+    #   @example
+    #     linescore.inning_half #=> "Bottom"
+    #   @return [String] the inning half
+    attribute :inning_half, Shale::Type::String
+
+    # @!attribute [rw] is_top_inning
+    #   Returns whether it's the top of the inning
+    #   @api public
+    #   @example
+    #     linescore.top_inning? #=> false
+    #   @return [Boolean] whether it's the top of the inning
+    attribute :is_top_inning, Shale::Type::Boolean
+
+    # @!attribute [rw] scheduled_innings
+    #   Returns the number of scheduled innings
+    #   @api public
+    #   @example
+    #     linescore.scheduled_innings #=> 9
+    #   @return [Integer] the scheduled innings
+    attribute :scheduled_innings, Shale::Type::Integer
+
+    # @!attribute [rw] innings
+    #   Returns the inning-by-inning scores
+    #   @api public
+    #   @example
+    #     linescore.innings #=> [#<MLB::InningScore>, ...]
+    #   @return [Array<InningScore>] the innings
+    attribute :innings, InningScore, collection: true
+
+    # @!attribute [rw] teams
+    #   Returns the team totals
+    #   @api public
+    #   @example
+    #     linescore.teams #=> #<MLB::LinescoreTeams>
+    #   @return [LinescoreTeams] the teams
+    attribute :teams, LinescoreTeams
+
+    # Returns whether it's the top of the inning
+    #
+    # @api public
+    # @example
+    #   linescore.top_inning? #=> false
+    # @return [Boolean] whether it's the top of the inning
+    def top_inning?
+      is_top_inning
+    end
+
+    # Returns whether the inning state is top
+    #
+    # @api public
+    # @example
+    #   linescore.top? #=> true
+    # @return [Boolean] whether it's the top of the inning
+    def top? = inning_state.eql?(INNING_TOP)
+
+    # Returns whether the inning state is middle
+    #
+    # @api public
+    # @example
+    #   linescore.middle? #=> false
+    # @return [Boolean] whether it's the middle of the inning
+    def middle? = inning_state.eql?(INNING_MIDDLE)
+
+    # Returns whether the inning state is bottom
+    #
+    # @api public
+    # @example
+    #   linescore.bottom? #=> false
+    # @return [Boolean] whether it's the bottom of the inning
+    def bottom? = inning_state.eql?(INNING_BOTTOM)
+
+    # Returns whether it's the 1st inning
+    #
+    # @api public
+    # @example
+    #   linescore.first? #=> true
+    # @return [Boolean] whether it's the 1st inning
+    def first? = current_inning.eql?(1)
+
+    # Returns whether it's the 2nd inning
+    #
+    # @api public
+    # @example
+    #   linescore.second? #=> false
+    # @return [Boolean] whether it's the 2nd inning
+    def second? = current_inning.eql?(2)
+
+    # Returns whether it's the 3rd inning
+    #
+    # @api public
+    # @example
+    #   linescore.third? #=> false
+    # @return [Boolean] whether it's the 3rd inning
+    def third? = current_inning.eql?(3)
+
+    # Returns whether it's the 4th inning
+    #
+    # @api public
+    # @example
+    #   linescore.fourth? #=> false
+    # @return [Boolean] whether it's the 4th inning
+    def fourth? = current_inning.eql?(4)
+
+    # Returns whether it's the 5th inning
+    #
+    # @api public
+    # @example
+    #   linescore.fifth? #=> false
+    # @return [Boolean] whether it's the 5th inning
+    def fifth? = current_inning.eql?(5)
+
+    # Returns whether it's the 6th inning
+    #
+    # @api public
+    # @example
+    #   linescore.sixth? #=> false
+    # @return [Boolean] whether it's the 6th inning
+    def sixth? = current_inning.eql?(6)
+
+    # Returns whether it's the 7th inning
+    #
+    # @api public
+    # @example
+    #   linescore.seventh? #=> false
+    # @return [Boolean] whether it's the 7th inning
+    def seventh? = current_inning.eql?(7)
+
+    # Returns whether it's the 8th inning
+    #
+    # @api public
+    # @example
+    #   linescore.eighth? #=> false
+    # @return [Boolean] whether it's the 8th inning
+    def eighth? = current_inning.eql?(8)
+
+    # Returns whether it's the 9th inning
+    #
+    # @api public
+    # @example
+    #   linescore.ninth? #=> false
+    # @return [Boolean] whether it's the 9th inning
+    def ninth? = current_inning.eql?(9)
+
+    # Returns whether it's the 10th inning
+    #
+    # @api public
+    # @example
+    #   linescore.tenth? #=> false
+    # @return [Boolean] whether it's the 10th inning
+    def tenth? = current_inning.eql?(10)
+
+    # Returns whether it's the 11th inning
+    #
+    # @api public
+    # @example
+    #   linescore.eleventh? #=> false
+    # @return [Boolean] whether it's the 11th inning
+    def eleventh? = current_inning.eql?(11)
+
+    # Returns whether it's the 12th inning
+    #
+    # @api public
+    # @example
+    #   linescore.twelfth? #=> false
+    # @return [Boolean] whether it's the 12th inning
+    def twelfth? = current_inning.eql?(12)
+
+    # Returns whether it's the 13th inning
+    #
+    # @api public
+    # @example
+    #   linescore.thirteenth? #=> false
+    # @return [Boolean] whether it's the 13th inning
+    def thirteenth? = current_inning.eql?(13)
+
+    # Returns whether it's the 14th inning
+    #
+    # @api public
+    # @example
+    #   linescore.fourteenth? #=> false
+    # @return [Boolean] whether it's the 14th inning
+    def fourteenth? = current_inning.eql?(14)
+
+    # Returns whether it's the 15th inning
+    #
+    # @api public
+    # @example
+    #   linescore.fifteenth? #=> false
+    # @return [Boolean] whether it's the 15th inning
+    def fifteenth? = current_inning.eql?(15)
+
+    # Returns whether it's the 16th inning
+    #
+    # @api public
+    # @example
+    #   linescore.sixteenth? #=> false
+    # @return [Boolean] whether it's the 16th inning
+    def sixteenth? = current_inning.eql?(16)
+
+    # Returns whether it's the 17th inning
+    #
+    # @api public
+    # @example
+    #   linescore.seventeenth? #=> false
+    # @return [Boolean] whether it's the 17th inning
+    def seventeenth? = current_inning.eql?(17)
+
+    # Returns whether it's the 18th inning
+    #
+    # @api public
+    # @example
+    #   linescore.eighteenth? #=> false
+    # @return [Boolean] whether it's the 18th inning
+    def eighteenth? = current_inning.eql?(18)
+
+    # Returns whether it's the 19th inning
+    #
+    # @api public
+    # @example
+    #   linescore.nineteenth? #=> false
+    # @return [Boolean] whether it's the 19th inning
+    def nineteenth? = current_inning.eql?(19)
+
+    # Returns whether it's the 20th inning
+    #
+    # @api public
+    # @example
+    #   linescore.twentieth? #=> false
+    # @return [Boolean] whether it's the 20th inning
+    def twentieth? = current_inning.eql?(20)
+
+    # Returns whether it's the 21st inning
+    #
+    # @api public
+    # @example
+    #   linescore.twenty_first? #=> false
+    # @return [Boolean] whether it's the 21st inning
+    def twenty_first? = current_inning.eql?(21)
+
+    # Returns whether it's the 22nd inning
+    #
+    # @api public
+    # @example
+    #   linescore.twenty_second? #=> false
+    # @return [Boolean] whether it's the 22nd inning
+    def twenty_second? = current_inning.eql?(22)
+
+    # Returns whether it's the 23rd inning
+    #
+    # @api public
+    # @example
+    #   linescore.twenty_third? #=> false
+    # @return [Boolean] whether it's the 23rd inning
+    def twenty_third? = current_inning.eql?(23)
+
+    # Returns whether it's the 24th inning
+    #
+    # @api public
+    # @example
+    #   linescore.twenty_fourth? #=> false
+    # @return [Boolean] whether it's the 24th inning
+    def twenty_fourth? = current_inning.eql?(24)
+
+    # Returns whether it's the 25th inning
+    #
+    # @api public
+    # @example
+    #   linescore.twenty_fifth? #=> false
+    # @return [Boolean] whether it's the 25th inning
+    def twenty_fifth? = current_inning.eql?(25)
+
+    # Returns whether it's the 26th inning
+    #
+    # @api public
+    # @example
+    #   linescore.twenty_sixth? #=> false
+    # @return [Boolean] whether it's the 26th inning
+    def twenty_sixth? = current_inning.eql?(26)
+
+    json do
+      map "currentInning", to: :current_inning
+      map "currentInningOrdinal", to: :current_inning_ordinal
+      map "inningState", to: :inning_state
+      map "inningHalf", to: :inning_half
+      map "isTopInning", to: :is_top_inning
+      map "scheduledInnings", to: :scheduled_innings
+      map "innings", to: :innings
+      map "teams", to: :teams
+    end
+
+    # Retrieves the linescore for a game
+    #
+    # @api public
+    # @example Get linescore for a game
+    #   MLB::Linescore.find(game: 745726)
+    # @param game [ScheduledGame, Integer] the game or game PK
+    # @return [Linescore] the linescore
+    def self.find(game:)
+      game_pk = game.respond_to?(:game_pk) ? game.game_pk : game
+      response = CLIENT.get("game/#{game_pk}/linescore")
+      from_json(response)
+    end
+  end
+end

data/lib/mlb/linescore_teams.rb

@@ -0,0 +1,89 @@
+require "shale"
+require_relative "inning_score"
+
+module MLB
+  # Represents one team's linescore totals
+  class LinescoreTeam < Shale::Mapper
+    # @!attribute [rw] runs
+    #   Returns total runs
+    #   @api public
+    #   @example
+    #     linescore_team.runs #=> 8
+    #   @return [Integer] the runs
+    attribute :runs, Shale::Type::Integer
+
+    # @!attribute [rw] hits
+    #   Returns total hits
+    #   @api public
+    #   @example
+    #     linescore_team.hits #=> 9
+    #   @return [Integer] the hits
+    attribute :hits, Shale::Type::Integer
+
+    # @!attribute [rw] errors
+    #   Returns total errors
+    #   @api public
+    #   @example
+    #     linescore_team.errors #=> 0
+    #   @return [Integer] the errors
+    attribute :errors, Shale::Type::Integer
+
+    # @!attribute [rw] left_on_base
+    #   Returns total left on base
+    #   @api public
+    #   @example
+    #     linescore_team.left_on_base #=> 5
+    #   @return [Integer] the left on base
+    attribute :left_on_base, Shale::Type::Integer
+
+    # @!attribute [rw] is_winner
+    #   Returns whether this team won
+    #   @api public
+    #   @example
+    #     linescore_team.winner? #=> true
+    #   @return [Boolean] whether this team won
+    attribute :is_winner, Shale::Type::Boolean
+
+    # Returns whether this team won
+    #
+    # @api public
+    # @example
+    #   linescore_team.winner? #=> true
+    # @return [Boolean] whether this team won
+    def winner?
+      is_winner
+    end
+
+    json do
+      map "runs", to: :runs
+      map "hits", to: :hits
+      map "errors", to: :errors
+      map "leftOnBase", to: :left_on_base
+      map "isWinner", to: :is_winner
+    end
+  end
+
+  # Represents both teams' linescore totals
+  class LinescoreTeams < Shale::Mapper
+    # @!attribute [rw] home
+    #   Returns the home team's totals
+    #   @api public
+    #   @example
+    #     linescore_teams.home #=> #<MLB::LinescoreTeam>
+    #   @return [LinescoreTeam] the home team
+    attribute :home, LinescoreTeam
+
+    # @!attribute [rw] away
+    #   Returns the away team's totals
+    #   @api public
+    #   @example
+    #     linescore_teams.away #=> #<MLB::LinescoreTeam>
+    #   @return [LinescoreTeam] the away team
+    attribute :away, LinescoreTeam
+
+    json do
+      map "home", to: :home
+      map "away", to: :away
+    end
+  end
+end

data/lib/mlb/live_feed.rb

@@ -0,0 +1,130 @@
+require "shale"
+require_relative "game_data"
+require_relative "play"
+require_relative "linescore"
+require_relative "boxscore"
+
+module MLB
+  # Represents the plays section of the live feed
+  class LivePlays < Shale::Mapper
+    # @!attribute [rw] all_plays
+    #   Returns all plays in the game
+    #   @api public
+    #   @example
+    #     plays.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
+    #     plays.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
+    #     plays.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
+  end
+
+  # Represents the live data section of the feed
+  class LiveData < Shale::Mapper
+    # @!attribute [rw] plays
+    #   Returns the plays data
+    #   @api public
+    #   @example
+    #     live_data.plays #=> #<MLB::LivePlays>
+    #   @return [LivePlays] the plays
+    attribute :plays, LivePlays
+
+    # @!attribute [rw] linescore
+    #   Returns the linescore
+    #   @api public
+    #   @example
+    #     live_data.linescore #=> #<MLB::Linescore>
+    #   @return [Linescore] the linescore
+    attribute :linescore, Linescore
+
+    # @!attribute [rw] boxscore
+    #   Returns the boxscore
+    #   @api public
+    #   @example
+    #     live_data.boxscore #=> #<MLB::Boxscore>
+    #   @return [Boxscore] the boxscore
+    attribute :boxscore, Boxscore
+
+    json do
+      map "plays", to: :plays
+      map "linescore", to: :linescore
+      map "boxscore", to: :boxscore
+    end
+  end
+
+  # Represents the live game feed data
+  class LiveFeed < Shale::Mapper
+    # @!attribute [rw] game_pk
+    #   Returns the game primary key
+    #   @api public
+    #   @example
+    #     feed.game_pk #=> 745571
+    #   @return [Integer] the game PK
+    attribute :game_pk, Shale::Type::Integer
+
+    # @!attribute [rw] link
+    #   Returns the API link
+    #   @api public
+    #   @example
+    #     feed.link #=> "/api/v1.1/game/745571/feed/live"
+    #   @return [String] the link
+    attribute :link, Shale::Type::String
+
+    # @!attribute [rw] game_data
+    #   Returns the game metadata
+    #   @api public
+    #   @example
+    #     feed.game_data #=> #<MLB::GameData>
+    #   @return [GameData] the game data
+    attribute :game_data, GameData
+
+    # @!attribute [rw] live_data
+    #   Returns the live game data
+    #   @api public
+    #   @example
+    #     feed.live_data #=> #<MLB::LiveData>
+    #   @return [LiveData] the live data
+    attribute :live_data, LiveData
+
+    json do
+      map "gamePk", to: :game_pk
+      map "link", to: :link
+      map "gameData", to: :game_data
+      map "liveData", to: :live_data
+    end
+
+    # Retrieves the live feed for a game
+    #
+    # @api public
+    # @example Get live feed for a game
+    #   MLB::LiveFeed.find(game: 745571)
+    # @example Get live feed using a ScheduledGame object
+    #   MLB::LiveFeed.find(game: scheduled_game)
+    # @param game [Integer, ScheduledGame] the game ID or game object
+    # @return [LiveFeed] the live feed
+    def self.find(game:)
+      game_pk = game.respond_to?(:game_pk) ? game.game_pk : game
+      response = CLIENT.get("game/#{game_pk}/feed/live")
+      from_json(response)
+    end
+  end
+end

data/lib/mlb/logical_event.rb

@@ -0,0 +1,17 @@
+require "equalizer"
+require "shale"
+
+module MLB
+  # Represents a logical event code
+  class LogicalEvent < Shale::Mapper
+    include Equalizer.new(:code)
+
+    # @!attribute [rw] code
+    #   Returns the logical event code
+    #   @api public
+    #   @example
+    #     logical_event.code #=> "countChange"
+    #   @return [String] the logical event code
+    attribute :code, Shale::Type::String
+  end
+end

data/lib/mlb/logical_events.rb

@@ -0,0 +1,12 @@
+require_relative "collection"
+require_relative "logical_event"
+
+module MLB
+  # Provides methods for fetching logical events from the API
+  #
+  # @example Fetch all logical events
+  #   MLB::LogicalEvents.all #=> [#<MLB::LogicalEvent>, ...]
+  class LogicalEvents < Collection
+    collection endpoint: "logicalEvents", item_type: LogicalEvent, collection_name: :logical_events
+  end
+end

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