sports-odds-api 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdfcac63dcdf37a24e24996746997cfabab7b955decbee450576fd0fdc6f62c3
-  data.tar.gz: c34370dccf8a5ca2f6b539eccc830b74876017a9637e704ba455395e9ff44292
+  metadata.gz: ce905e962b28a44ec834ba7ff8a966df7e8d021dc8394a71bf3386663abc6e60
+  data.tar.gz: 6348dd6bac833a96fbfa69ffa87ead1266430e4de7b725589c7cf84dec764e0a
 SHA512:
-  metadata.gz: fbb548a78f81ea7bcf0f72dbb284bc95f25dcc35d85e12c9da784ef69c53e131013362b39b5eddcc083c99315aa12452740b4d0def24649f211c5fbeab4cb25d
-  data.tar.gz: e3b6187cfeb6ba6d40b5257e90f6c55de22b8b08adb843dc7031939ded3dac59282cc6fb447d37c444ef39655863ebdaf6d49a0f078eaacb975a951de41d2f0d
+  metadata.gz: 87f0ef7c34d0ff1266e9fd949f0d76661ce131bc901f6bfd136ccc10d65ee0fcf83a18455be5aac0c428a5a97b472a5a053e41982bb70995b24e4c8732c62f35
+  data.tar.gz: 7999f18438c8422fe9d09bbac7e0001e3b5fe7eb7e9ac83be2d1188ca646caed4b3ead17a41934603123deacb1dcd986eb1912a0ebb870e198cba23b996a98e3

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [1.3.0](https://github.com/SportsGameOdds/sports-odds-api-ruby/compare/v1.2.3...v1.3.0) (2026-07-18)
+
+
+### Features
+
+* add support for the /markets endpoint ([ce01d75](https://github.com/SportsGameOdds/sports-odds-api-ruby/commit/ce01d759933fc8c79d15ae84720da6d0b94eccf3))
+* initial stlc build ([51bb9f0](https://github.com/SportsGameOdds/sports-odds-api-ruby/commit/51bb9f0ae4bb9e49d056c0cedebaddb6db207f98))
+
+
+### Bug Fixes
+
+* declare base64 dependency for Ruby 3.4+ compatibility ([b238e6a](https://github.com/SportsGameOdds/sports-odds-api-ruby/commit/b238e6a09ddbbbb7f06e5317a296ad2b8bca5779))
+
 ## 1.2.3 (2026-07-08)
 
 Full Changelog: [v1.2.2...v1.2.3](https://github.com/SportsGameOdds/sports-odds-api-ruby/compare/v1.2.2...v1.2.3)

data/lib/sports_odds_api/client.rb

@@ -23,27 +23,39 @@ module SportsOddsAPI
     # @return [String, nil]
     attr_reader :api_key_param
 
+    # Get info about Events (includes odds, results, teams, and other metadata)
     # @return [SportsOddsAPI::Resources::Events]
     attr_reader :events
 
+    # Get metadata on supported Markets
+    # @return [SportsOddsAPI::Resources::Markets]
+    attr_reader :markets
+
+    # Get Team-related data
     # @return [SportsOddsAPI::Resources::Teams]
     attr_reader :teams
 
+    # Get Player-related data
     # @return [SportsOddsAPI::Resources::Players]
     attr_reader :players
 
+    # Get League-related data
     # @return [SportsOddsAPI::Resources::Leagues]
     attr_reader :leagues
 
+    # Get Sport-related data
     # @return [SportsOddsAPI::Resources::Sports]
     attr_reader :sports
 
+    # Get data on specific Stats
     # @return [SportsOddsAPI::Resources::Stats]
     attr_reader :stats
 
+    # Get data related to your Account & API key
     # @return [SportsOddsAPI::Resources::Account]
     attr_reader :account
 
+    # Get info about Events (includes odds, results, teams, and other metadata)
     # @return [SportsOddsAPI::Resources::Stream]
     attr_reader :stream
 
@@ -88,6 +100,19 @@ module SportsOddsAPI
     )
       base_url ||= "https://api.sportsgameodds.com/v2"
 
+      headers = {}
+      custom_headers_env = ENV["SPORTS_GAME_ODDS_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       @api_key_header = api_key_header&.to_s
       @api_key_param = api_key_param&.to_s
 
@@ -96,10 +121,12 @@ module SportsOddsAPI
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        headers: headers
       )
 
       @events = SportsOddsAPI::Resources::Events.new(client: self)
+      @markets = SportsOddsAPI::Resources::Markets.new(client: self)
       @teams = SportsOddsAPI::Resources::Teams.new(client: self)
       @players = SportsOddsAPI::Resources::Players.new(client: self)
       @leagues = SportsOddsAPI::Resources::Leagues.new(client: self)

data/lib/sports_odds_api/internal/transport/base_client.rb

@@ -315,6 +315,11 @@ module SportsOddsAPI
               SportsOddsAPI::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          # Generated methods always pass `req[:body]` for operations that define a
+          # request body, so only elide the content-type header when the operation
+          # has no body at all, not when an optional body param was omitted.
+          headers.delete("content-type") if body.nil? && !req.key?(:body)
+
           url = SportsOddsAPI::Internal::Util.join_parsed_uri(
             @base_url_components,
             {**req, path: path, query: query}

data/lib/sports_odds_api/internal/util.rb

@@ -157,7 +157,7 @@ module SportsOddsAPI
           in Hash | nil => coerced
             coerced
           else
-            message = "Expected a #{Hash} or #{SportsOddsAPI::Internal::Type::BaseModel}, got #{data.inspect}"
+            message = "Expected a #{Hash} or #{SportsOddsAPI::Internal::Type::BaseModel}, got #{input.inspect}"
             raise ArgumentError.new(message)
           end
         end
@@ -237,6 +237,11 @@ module SportsOddsAPI
         end
       end
 
+      # @type [Regexp]
+      #
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = /[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/
+
       class << self
         # @api private
         #
@@ -247,6 +252,15 @@ module SportsOddsAPI
           "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
+        # @api private
+        #
+        # @param path [String, Integer]
+        #
+        # @return [String]
+        def encode_path(path)
+          path.to_s.gsub(SportsOddsAPI::Internal::Util::RFC_3986_NOT_PCHARS) { ERB::Util.url_encode(_1) }
+        end
+
         # @api private
         #
         # @param path [String, Array<String>]
@@ -259,7 +273,7 @@ module SportsOddsAPI
           in []
             ""
           in [String => p, *interpolations]
-            encoded = interpolations.map { ERB::Util.url_encode(_1) }
+            encoded = interpolations.map { encode_path(_1) }
             format(p, *encoded)
           end
         end
@@ -490,6 +504,37 @@ module SportsOddsAPI
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
+        # @api private
+        #
+        # @param query [Hash{Symbol=>Object}]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def encode_query_params(query)
+          out = {}
+          query.each { write_query_param_element!(out, _1, _2) }
+          out
+        end
+
+        # @api private
+        #
+        # @param collection [Hash{Symbol=>Object}]
+        # @param key [String]
+        # @param element [Object]
+        #
+        # @return [nil]
+        private def write_query_param_element!(collection, key, element)
+          case element
+          in Hash
+            element.each do |name, value|
+              write_query_param_element!(collection, "#{key}[#{name}]", value)
+            end
+          in Array
+            collection[key] = element.map(&:to_s).join(",")
+          else
+            collection[key] = element.to_s
+          end
+        end
+
         # @api private
         #
         # @param y [Enumerator::Yielder]
@@ -540,16 +585,15 @@ module SportsOddsAPI
           y << "Content-Disposition: form-data"
 
           unless key.nil?
-            name = ERB::Util.url_encode(key.to_s)
-            y << "; name=\"#{name}\""
+            y << "; name=\"#{key}\""
           end
 
           case val
           in SportsOddsAPI::FilePart unless val.filename.nil?
-            filename = ERB::Util.url_encode(val.filename)
+            filename = encode_path(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(::File.basename(val.to_path))
+            filename = encode_path(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -566,6 +610,7 @@ module SportsOddsAPI
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
@@ -575,7 +620,7 @@ module SportsOddsAPI
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || SportsOddsAPI::Internal::Type::FileInput === _1 }
                   val.each do |v|
                     write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
@@ -591,6 +636,7 @@ module SportsOddsAPI
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private

data/lib/sports_odds_api/models/event.rb

@@ -40,6 +40,7 @@ module SportsOddsAPI
       optional :players, -> { SportsOddsAPI::Internal::Type::HashOf[SportsOddsAPI::Event::Player] }
 
       # @!attribute results
+      #   Nested results in the format `{periodID}.{statEntityID}.{statID} → number`.
       #
       #   @return [Hash{Symbol=>Hash{Symbol=>Hash{Symbol=>Float}}}, nil]
       optional :results,
@@ -67,16 +68,27 @@ module SportsOddsAPI
 
       # @!method initialize(activity: nil, event_id: nil, info: nil, league_id: nil, manual: nil, odds: nil, players: nil, results: nil, sport_id: nil, status: nil, teams: nil, type: nil)
       #   @param activity [SportsOddsAPI::Models::Event::Activity]
+      #
       #   @param event_id [String]
+      #
       #   @param info [SportsOddsAPI::Models::Event::Info]
+      #
       #   @param league_id [String]
+      #
       #   @param manual [Boolean]
+      #
       #   @param odds [Hash{Symbol=>SportsOddsAPI::Models::Event::Odd}]
+      #
       #   @param players [Hash{Symbol=>SportsOddsAPI::Models::Event::Player}]
-      #   @param results [Hash{Symbol=>Hash{Symbol=>Hash{Symbol=>Float}}}]
+      #
+      #   @param results [Hash{Symbol=>Hash{Symbol=>Hash{Symbol=>Float}}}] Nested results in the format `{periodID}.{statEntityID}.{statID} → number`.
+      #
       #   @param sport_id [String]
+      #
       #   @param status [SportsOddsAPI::Models::Event::Status]
+      #
       #   @param teams [SportsOddsAPI::Models::Event::Teams]
+      #
       #   @param type [String]
 
       # @see SportsOddsAPI::Models::Event#activity
@@ -98,13 +110,130 @@ module SportsOddsAPI
 
       # @see SportsOddsAPI::Models::Event#info
       class Info < SportsOddsAPI::Internal::Type::BaseModel
+        # @!attribute broadcasts
+        #
+        #   @return [Array<SportsOddsAPI::Models::Event::Info::Broadcast>, nil]
+        optional :broadcasts, -> { SportsOddsAPI::Internal::Type::ArrayOf[SportsOddsAPI::Event::Info::Broadcast] }
+
+        # @!attribute referee
+        #
+        #   @return [SportsOddsAPI::Models::Event::Info::Referee, nil]
+        optional :referee, -> { SportsOddsAPI::Event::Info::Referee }
+
         # @!attribute season_week
         #
         #   @return [String, nil]
         optional :season_week, String, api_name: :seasonWeek
 
-        # @!method initialize(season_week: nil)
+        # @!attribute venue
+        #
+        #   @return [SportsOddsAPI::Models::Event::Info::Venue, nil]
+        optional :venue, -> { SportsOddsAPI::Event::Info::Venue }
+
+        # @!method initialize(broadcasts: nil, referee: nil, season_week: nil, venue: nil)
+        #   @param broadcasts [Array<SportsOddsAPI::Models::Event::Info::Broadcast>]
+        #   @param referee [SportsOddsAPI::Models::Event::Info::Referee]
         #   @param season_week [String]
+        #   @param venue [SportsOddsAPI::Models::Event::Info::Venue]
+
+        class Broadcast < SportsOddsAPI::Internal::Type::BaseModel
+          # @!attribute broadcaster_id
+          #
+          #   @return [String, nil]
+          optional :broadcaster_id, String, api_name: :broadcasterID
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, SportsOddsAPI::Models::Event::Info::Broadcast::Type, nil]
+          optional :type, enum: -> { SportsOddsAPI::Event::Info::Broadcast::Type }
+
+          # @!method initialize(broadcaster_id: nil, name: nil, type: nil)
+          #   @param broadcaster_id [String]
+          #   @param name [String]
+          #   @param type [Symbol, SportsOddsAPI::Models::Event::Info::Broadcast::Type]
+
+          # @see SportsOddsAPI::Models::Event::Info::Broadcast#type
+          module Type
+            extend SportsOddsAPI::Internal::Type::Enum
+
+            TV = :tv
+            WEBSTREAM = :webstream
+            SUBSCRIPTION = :subscription
+            SPORTSBOOK = :sportsbook
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see SportsOddsAPI::Models::Event::Info#referee
+        class Referee < SportsOddsAPI::Internal::Type::BaseModel
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(name: nil)
+          #   @param name [String]
+        end
+
+        # @see SportsOddsAPI::Models::Event::Info#venue
+        class Venue < SportsOddsAPI::Internal::Type::BaseModel
+          # @!attribute address
+          #
+          #   @return [String, nil]
+          optional :address, String
+
+          # @!attribute capacity
+          #
+          #   @return [Float, nil]
+          optional :capacity, Float
+
+          # @!attribute city
+          #
+          #   @return [String, nil]
+          optional :city, String
+
+          # @!attribute country_code
+          #
+          #   @return [String, nil]
+          optional :country_code, String, api_name: :countryCode
+
+          # @!attribute country_name
+          #
+          #   @return [String, nil]
+          optional :country_name, String, api_name: :countryName
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute region_code
+          #
+          #   @return [String, nil]
+          optional :region_code, String, api_name: :regionCode
+
+          # @!attribute region_name
+          #
+          #   @return [String, nil]
+          optional :region_name, String, api_name: :regionName
+
+          # @!method initialize(address: nil, capacity: nil, city: nil, country_code: nil, country_name: nil, name: nil, region_code: nil, region_name: nil)
+          #   @param address [String]
+          #   @param capacity [Float]
+          #   @param city [String]
+          #   @param country_code [String]
+          #   @param country_name [String]
+          #   @param name [String]
+          #   @param region_code [String]
+          #   @param region_name [String]
+        end
       end
 
       class Odd < SportsOddsAPI::Internal::Type::BaseModel
@@ -261,6 +390,21 @@ module SportsOddsAPI
           #   @return [String, nil]
           optional :bookmaker_id, String, api_name: :bookmakerID
 
+          # @!attribute close_odds
+          #
+          #   @return [String, nil]
+          optional :close_odds, String, api_name: :closeOdds
+
+          # @!attribute close_over_under
+          #
+          #   @return [String, nil]
+          optional :close_over_under, String, api_name: :closeOverUnder
+
+          # @!attribute close_spread
+          #
+          #   @return [String, nil]
+          optional :close_spread, String, api_name: :closeSpread
+
           # @!attribute is_main_line
           #
           #   @return [Boolean, nil]
@@ -276,6 +420,21 @@ module SportsOddsAPI
           #   @return [String, nil]
           optional :odds, String
 
+          # @!attribute open_odds
+          #
+          #   @return [String, nil]
+          optional :open_odds, String, api_name: :openOdds
+
+          # @!attribute open_over_under
+          #
+          #   @return [String, nil]
+          optional :open_over_under, String, api_name: :openOverUnder
+
+          # @!attribute open_spread
+          #
+          #   @return [String, nil]
+          optional :open_spread, String, api_name: :openSpread
+
           # @!attribute over_under
           #
           #   @return [String, nil]
@@ -286,12 +445,18 @@ module SportsOddsAPI
           #   @return [String, nil]
           optional :spread, String
 
-          # @!method initialize(available: nil, bookmaker_id: nil, is_main_line: nil, last_updated_at: nil, odds: nil, over_under: nil, spread: nil)
+          # @!method initialize(available: nil, bookmaker_id: nil, close_odds: nil, close_over_under: nil, close_spread: nil, is_main_line: nil, last_updated_at: nil, odds: nil, open_odds: nil, open_over_under: nil, open_spread: nil, over_under: nil, spread: nil)
           #   @param available [Boolean]
           #   @param bookmaker_id [String]
+          #   @param close_odds [String]
+          #   @param close_over_under [String]
+          #   @param close_spread [String]
           #   @param is_main_line [Boolean]
           #   @param last_updated_at [Time]
           #   @param odds [String]
+          #   @param open_odds [String]
+          #   @param open_over_under [String]
+          #   @param open_spread [String]
           #   @param over_under [String]
           #   @param spread [String]
         end
@@ -328,19 +493,47 @@ module SportsOddsAPI
         #   @return [String, nil]
         optional :player_id, String, api_name: :playerID
 
+        # @!attribute status
+        #
+        #   @return [Symbol, SportsOddsAPI::Models::Event::Player::Status, nil]
+        optional :status, enum: -> { SportsOddsAPI::Event::Player::Status }
+
+        # @!attribute status_details
+        #
+        #   @return [String, nil]
+        optional :status_details, String, api_name: :statusDetails
+
         # @!attribute team_id
         #
         #   @return [String, nil]
         optional :team_id, String, api_name: :teamID
 
-        # @!method initialize(alias_: nil, first_name: nil, last_name: nil, name: nil, photo: nil, player_id: nil, team_id: nil)
+        # @!method initialize(alias_: nil, first_name: nil, last_name: nil, name: nil, photo: nil, player_id: nil, status: nil, status_details: nil, team_id: nil)
         #   @param alias_ [String]
         #   @param first_name [String]
         #   @param last_name [String]
         #   @param name [String]
         #   @param photo [String]
         #   @param player_id [String]
+        #   @param status [Symbol, SportsOddsAPI::Models::Event::Player::Status]
+        #   @param status_details [String]
         #   @param team_id [String]
+
+        # @see SportsOddsAPI::Models::Event::Player#status
+        module Status
+          extend SportsOddsAPI::Internal::Type::Enum
+
+          IR = :ir
+          ACTIVE = :active
+          OUT = :out
+          SUSPENDED = :suspended
+          QUESTIONABLE = :questionable
+          DOUBTFUL = :doubtful
+          PROBABLE = :probable
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       # @see SportsOddsAPI::Models::Event#status

data/lib/sports_odds_api/models/event_get_params.rb

@@ -21,8 +21,8 @@ module SportsOddsAPI
       optional :cancelled, SportsOddsAPI::Internal::Type::Boolean
 
       # @!attribute cursor
-      #   The cursor for the request. Used to get the next group of Events. This should be
-      #   the nextCursor from the prior response.
+      #   The cursor for the request. Used to get the next group of Events. This is an
+      #   opaque token — pass the nextCursor value from the prior response unchanged.
       #
       #   @return [String, nil]
       optional :cursor, String
@@ -46,6 +46,13 @@ module SportsOddsAPI
       #   @return [String, nil]
       optional :event_ids, String
 
+      # @!attribute expand_results
+      #   Whether to expand the results object to include all stat values rather than just
+      #   the base set
+      #
+      #   @return [Boolean, nil]
+      optional :expand_results, SportsOddsAPI::Internal::Type::Boolean
+
       # @!attribute finalized
       #   Only include finalized Events (true), exclude unfinalized Events (false) or all
       #   Events (omit)
@@ -59,6 +66,13 @@ module SportsOddsAPI
       #   @return [Boolean, nil]
       optional :include_alt_lines, SportsOddsAPI::Internal::Type::Boolean
 
+      # @!attribute include_open_close_odds
+      #   Whether to include open and close odds values (openOdds, closeOdds, openSpread,
+      #   closeSpread, openOverUnder, closeOverUnder) in the odds byBookmaker data
+      #
+      #   @return [Boolean, nil]
+      optional :include_open_close_odds, SportsOddsAPI::Internal::Type::Boolean
+
       # @!attribute include_opposing_odds
       #   Whether to include opposing odds for each included oddID
       #
@@ -149,7 +163,7 @@ module SportsOddsAPI
       #   @return [String, nil]
       optional :type, String
 
-      # @!method initialize(bookmaker_id: nil, cancelled: nil, cursor: nil, ended: nil, event_id: nil, event_ids: nil, finalized: nil, include_alt_lines: nil, include_opposing_odds: nil, league_id: nil, limit: nil, live: nil, odd_id: nil, odds_available: nil, odds_present: nil, player_id: nil, sport_id: nil, started: nil, starts_after: nil, starts_before: nil, team_id: nil, type: nil, request_options: {})
+      # @!method initialize(bookmaker_id: nil, cancelled: nil, cursor: nil, ended: nil, event_id: nil, event_ids: nil, expand_results: nil, finalized: nil, include_alt_lines: nil, include_open_close_odds: nil, include_opposing_odds: nil, league_id: nil, limit: nil, live: nil, odd_id: nil, odds_available: nil, odds_present: nil, player_id: nil, sport_id: nil, started: nil, starts_after: nil, starts_before: nil, team_id: nil, type: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SportsOddsAPI::Models::EventGetParams} for more details.
       #
@@ -157,7 +171,7 @@ module SportsOddsAPI
       #
       #   @param cancelled [Boolean] Only include cancelled Events (true), only non-cancelled Events (false) or all E
       #
-      #   @param cursor [String] The cursor for the request. Used to get the next group of Events. This should be
+      #   @param cursor [String] The cursor for the request. Used to get the next group of Events. This is an opa
       #
       #   @param ended [Boolean] Only include Events which have have ended (true), only Events which have not end
       #
@@ -165,10 +179,14 @@ module SportsOddsAPI
       #
       #   @param event_ids [String] A comma separated list of eventIDs to get Event data for
       #
+      #   @param expand_results [Boolean] Whether to expand the results object to include all stat values rather than just
+      #
       #   @param finalized [Boolean] Only include finalized Events (true), exclude unfinalized Events (false) or all
       #
       #   @param include_alt_lines [Boolean] Whether to include alternate lines in the odds byBookmaker data
       #
+      #   @param include_open_close_odds [Boolean] Whether to include open and close odds values (openOdds, closeOdds, openSpread,
+      #
       #   @param include_opposing_odds [Boolean] Whether to include opposing odds for each included oddID
       #
       #   @param league_id [String] A leagueID or comma-separated list of leagueIDs to get Events for