steam_api_client 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d18c324c4585ab45385d8edf00615002e7906faa914c90a961a597baee266447
-  data.tar.gz: bfb5cb86136edac94cfb7829e0e14a944909d7d4db525424fc39d5aa3b03f77a
+  metadata.gz: d0c5680dd7c5f04050858684ffdedba92a405af03105ff67d5ab5f83786a9be3
+  data.tar.gz: 18dace5a415dbae06ab33d22af1d8d2f89a692c18b33d0fde7632e9608860476
 SHA512:
-  metadata.gz: 45aa21466727fe4cc07592a9af86a47688ea1953154a09a9a4466f7fd6bea4b220874baeec8c029e1c99885f1865373c920a70a7a3db48b6de5faf1210763880
-  data.tar.gz: 0bb3e7ac41550d22fadf112663de1cc4d569fd5719351b1b34ba78fc046248771dff510e0912887793c887158bca4b6121e4175b86f7165e37f8f30ac0f72fe8
+  metadata.gz: '008e3f030129225f200f25063f45bc1df84a0abc0aba381d1c2a919ef99f9cfebba87a908a14ebfc6652a0d9ea9dfdd76e8a7dc5299762df648b03423879dc07'
+  data.tar.gz: 886f409484facc5b94264c94a488e07d85bcf0514c84b81b9541f395da769d53d9407b8af83b2dc8cfcf45cb8bae81a5044a4d8542074c3940a3cec9ccfa2a71

data/CHANGELOG.md

@@ -1,9 +1,148 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
 ## [Unreleased]
 
+## [0.10.0] - 2026-10-23
+
+### Added
+
+- `player_game_stats` exposes the game's stats: `playerstats.stats`, a list of `name`/`value` pairs. Values keep the Integer or Float Steam sends (#71).
+- `PlayerSummary` exposes `realname`, `timecreated`, `loccountrycode`, `avatarhash`, `primaryclanid` (an Integer, like other SteamIDs) and `personastateflags`. They're `nil` when the profile doesn't make them public (#71).
+- `SteamApiClient::Errors::HttpTooManyRequests` (429), `HttpBadGateway` (502) and `HttpServiceUnavailable` (503), so rate limits and outages can be retried selectively. 429 and 503 errors expose `#retry_after`, the seconds from the `Retry-After` header (`nil` when absent). All three are `ApiError`s, like before (#27).
+- `SteamApiClient::Errors::MissingApiToken`, raised before any request when an endpoint needs an API token and the client has none (nil or empty). Previously the request was sent and Steam's HTML "key is missing" page came back as `HttpBadRequest` (#25).
+
+### Changed
+
+- Every response struct, including the nested element structs (`PlayerSummary`, `AppNew`, friends, games and achievements), inherits from `SteamApiClient::Structs::Base`, so they all accept string keys and respond to `build_from_response` (#28).
+- GET requests (every endpoint) no longer send an empty JSON body (`"{}"`) and `Content-Type: application/json` (#26).
+- Missing or invalid request parameters raise `ArgumentError` instead of a bare `StandardError` (#25). `ArgumentError` is a `StandardError`, so existing `rescue StandardError` code keeps working.
+- **Breaking:** every `retrieve` method takes keyword arguments (#24), so IDs can't be swapped by position. Defaults are unchanged.
+
+  | Before | After |
+  |---|---|
+  | `player_summaries.retrieve([id])` | `player_summaries.retrieve(steamids: [id])` |
+  | `player_steamid.retrieve("name")` | `player_steamid.retrieve(vanityurl: "name")` |
+  | `player_friends.retrieve(id, "friend")` | `player_friends.retrieve(steamid: id, relationship: "friend")` |
+  | `player_level.retrieve(id)` | `player_level.retrieve(steamid: id)` |
+  | `player_owned_games.retrieve(id, include_appinfo: true)` | `player_owned_games.retrieve(steamid: id, include_appinfo: true)` |
+  | `player_recent_games.retrieve(id, 10)` | `player_recent_games.retrieve(steamid: id, count: 10)` |
+  | `player_achievements.retrieve(appid, id)` | `player_achievements.retrieve(appid: appid, steamid: id)` |
+  | `player_game_stats.retrieve(appid, id)` | `player_game_stats.retrieve(appid: appid, steamid: id)` |
+  | `app_news.retrieve(appid, 5, 500)` | `app_news.retrieve(appid: appid, count: 5, maxlength: 500)` |
+  | `app_global_achievements.retrieve(appid)` | `app_global_achievements.retrieve(appid: appid)` |
+  | `game_current_players.retrieve(appid)` | `game_current_players.retrieve(appid: appid)` |
+
+### Fixed
+
+- `player_owned_games` failed on real public libraries: it required `playtime_windows_forever`, `playtime_mac_forever`, `playtime_linux_forever` and `rtime_last_played`, which Steam doesn't send. They're optional now, and `playtime_2weeks`, `has_community_visible_stats`, `has_leaderboards` and `content_descriptorids` are exposed (#70).
+- Responses with duplicate JSON keys parse the same on every `json` gem version, with the last value winning. json 3 rejects duplicate keys by default, which would have raised `ResponseParseError` (#19).
+
+### Changed
+
+- Allows `dry-configurable` 1.2 and newer (`~> 1.1` instead of `~> 1.1.0`, which only allowed 1.1.x) (#19).
+- **Breaking:** requires Ruby 3.3 or newer (#17). Ruby 3.0, 3.1 and 3.2 have reached end of life. CI now tests 3.3, 3.4 and 4.0.
+- **Breaking:** response structs now validate their declared types (#15). Integer, Float and String fields convert Steam's values (Steam often sends numbers as strings), and a value that can't be converted raises `SteamApiClient::Errors::ResponseParseError` instead of passing through unchanged. `null` values still come through as `nil`.
+  - `PlayerSummary#steamid` is now an Integer, like every other SteamID in the gem (it was a String).
+  - `PlayerSummary#profilestate` is now an Integer (it was declared String; Steam sends `1`).
+  - Global achievement `percent` is now a Float (it held Steam's raw value, e.g. `"49.6"`).
+- The gem homepage and README links point to `github.com/jpechaves/steam_api` instead of the old `sosolidkk` account (#22).
+
+## [0.9.1] - 2026-10-23
+
+### Fixed
+
+- The gem no longer packages development files (`CLAUDE.md`, `CODE_OF_CONDUCT.md`, `Gemfile`, `Gemfile.lock` and tooling dotfiles). It ships only `lib/`, `LICENSE`, `README.md` and `CHANGELOG.md` (#37).
+
+## [0.9.0] - 2026-10-23
+
+First release published to RubyGems, as [`steam_api_client`](https://rubygems.org/gems/steam_api_client).
+
 ### Changed
 
 - **Breaking:** renamed the gem from `steam_api` to `steam_api_client`, since `steam_api` is taken on RubyGems by an unrelated gem (#21). Update your Gemfile to `gem "steam_api_client"`, use `require "steam_api_client"`, and replace the `SteamApi` namespace with `SteamApiClient` (e.g. `SteamApiClient::Client`, `SteamApiClient::Errors::HttpTimeout`).
+- **Breaking:** `Response#result` raises `SteamApiClient::Errors::ResponseParseError` instead of letting `Dry::Struct::Error` escape when a response can't be built into its struct, and for bodies that aren't a JSON object (#11). The original error is available as `#cause`.
+- `gem push` requires MFA (`rubygems_mfa_required`).
+- Removed the `activesupport`, `vcr` and `webmock` dependencies.
+
+### Added
+
+- Configurable HTTP timeouts: 10s per request and 5s to connect by default. Set them with `Client.configure` (`timeout`, `connect_timeout`) or `Client.new(timeout:, connect_timeout:)`. Timed-out requests raise `HttpTimeout` (#12).
+- `AppDetails::Movie` exposes Steam's streaming trailer manifests: `dash_av1`, `dash_h264`, `hls_h264` (#9).
+- CI: Standard Ruby lint, a RubyCritic score gate, and bundler-audit on push, PRs and weekly (#31).
+
+### Fixed
+
+- `app_details` raised `Dry::Struct::Error` for every app with trailers, because Steam no longer returns `webm`/`mp4` (#9).
+- `app_details` raised `Dry::Struct::Error` for unavailable apps. It now returns `response.success == false` with `response.data == nil` (#10).
+- The token set through `Client.configure` was never sent. `Client#api_token` now falls back to it.
+- `require "steam_api"` didn't load `json`, so requests failed outside the test suite.
+- The default request `body` used ActiveSupport methods (`as_json`, `deep_symbolize_keys`) after ActiveSupport was removed.
+- The README examples used a positional `Client.new` argument instead of `api_token:`.
+
+### Security
+
+- Bumped `concurrent-ruby` to 1.3.8 and `json` to 2.21.2 in `Gemfile.lock` to resolve bundler-audit advisories (#31). This affects development and CI only. Apps using the gem resolve their own versions.
+
+## Earlier versions
+
+The versions below were bumped in `version.rb` during development but **never published or tagged**. They are reconstructed from the git history (the gem was named `steam` until 0.1.5 and `steam_api` until 0.9.0).
+
+## [0.8.0] - 2025-04-13
+
+- Fixed YARD comments, added `bin/setup`, completed the struct specs and added the first request spec.
+- Updated dependencies.
+
+## [0.7.0] - 2024-07-27
+
+- Removed unused development tooling and ran Standard Ruby on the whole project. There was no 0.6.0.
+
+## [0.5.0] - 2024-06-03
+
+- Raised the required Ruby version (needed by `dry-core`) and updated the CI Ruby versions.
+- More specs.
+
+## [0.4.0] - 2024-04-14
+
+- Updated gem metadata. More struct specs.
+
+## [0.3.0] - 2024-01-20
+
+- Added a GitHub Actions workflow and dropped Ruby 2.6.
+- Added specs for errors, responses and base structs. Removed unused code.
+
+## [0.2.2] - 2023-06-28
+
+- Added `EndpointKindNotSupported` for unknown endpoint kinds.
+- Fixed query params not being sent with requests.
+- Clearer parameter names. Updated gems and the Ruby version. First specs for the client and the failure handler.
+
+## [0.2.1] - 2023-02-26
+
+- Added support for the Storefront API and the app details endpoint.
+
+## [0.1.5] - 2023-01-15
+
+- Renamed the gem from `steam` to `steam_api`. There were no 0.1.3 or 0.1.4.
+
+## [0.1.2] - 2022-11-25
+
+- Client, structs, and request/response/error handling, with `HttpForbidden` (403) and `HttpInternalServerError` (500).
+- Endpoints: player summaries, app news, global achievement percentages, player achievements, user game stats, recently played games, resolve vanity URL, current player count, player level, owned games and friend list.
+- Development tooling configuration.
+
+## [0.1.1] - 2022-09-29
+
+- Basic client configuration.
 
 ## [0.1.0] - 2022-09-28
 
-- Initial release
+- Initial gem skeleton.
+
+[Unreleased]: https://github.com/jpechaves/steam_api/compare/v0.10.0...HEAD
+[0.10.0]: https://github.com/jpechaves/steam_api/compare/v0.9.1...v0.10.0
+[0.9.1]: https://github.com/jpechaves/steam_api/compare/v0.9.0...v0.9.1
+[0.9.0]: https://github.com/jpechaves/steam_api/releases/tag/v0.9.0

data/README.md

@@ -14,6 +14,7 @@
     - [Running the Interactive Console](#running-the-interactive-console)
     - [Running Tests](#running-tests)
     - [Code Quality](#code-quality)
+    - [Releasing](#releasing)
   - [Contributing](#contributing)
     - [How to Contribute](#how-to-contribute)
   - [License](#license)
@@ -21,6 +22,9 @@
 
 # steam_api_client
 
+[![Gem Version](https://img.shields.io/gem/v/steam_api_client)](https://rubygems.org/gems/steam_api_client)
+[![CI](https://github.com/jpechaves/steam_api/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/jpechaves/steam_api/actions/workflows/ci.yml)
+
 > Previously developed as `steam_api`. It is not related to the [`steam_api`](https://rubygems.org/gems/steam_api) gem on RubyGems.
 
 A Ruby gem for interacting with the [Steam Web API](https://developer.valvesoftware.com/wiki/Steam_Web_API). This gem provides a structured and user-friendly way to fetch various types of data from Steam's API endpoints, such as game details, player information, and achievements.
@@ -35,22 +39,28 @@ A Ruby gem for interacting with the [Steam Web API](https://developer.valvesoftw
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the gem to your application's Gemfile:
 
 ```ruby
+gem "steam_api_client"
+```
+
+and run `bundle install`. Or let Bundler do both:
+
+```bash
 $ bundle add steam_api_client
 ```
 
-Or install it manually:
+Without Bundler, install it with:
 
 ```bash
 $ gem install steam_api_client
 ```
 
-Then execute:
+and load it with:
 
-```bash
-$ bundle install
+```ruby
+require "steam_api_client"
 ```
 
 ## Usage
@@ -86,7 +96,7 @@ client = SteamApiClient::Client.new(api_token: "your-API-token-value", timeout:
 
 ```ruby
 client = SteamApiClient::Client.new(api_token: "your-API-token-value")
-client.player_summaries.retrieve([76561198160009756])
+client.player_summaries.retrieve(steamids: [76561198160009756])
 ```
 
 #### Get App Details
@@ -102,8 +112,7 @@ For more examples, see the [Usage](#usage) section above.
 
 ### Requirements
 
-- Ruby >= 3.0
-- Docker (optional, for consistent development environments)
+- Ruby >= 3.3
 
 ### Initial Setup
 
@@ -137,9 +146,29 @@ We use [standardrb](https://github.com/standardrb/standard) for linting and code
 $ bin/lint
 ```
 
+### Releasing
+
+Each pull request with a user-visible change adds a line under `## [Unreleased]` in `CHANGELOG.md`. Pull requests don't change the version.
+
+To release the merged changes, open a release pull request:
+
+```bash
+$ git checkout -b release/0.10.0
+$ bin/bump minor         # or patch / major: bumps version.rb and Gemfile.lock, moves [Unreleased] under "## [0.10.0] - <today>"
+```
+
+Commit, open the pull request, and merge it. Then publish from `main`:
+
+```bash
+$ bin/release            # build and push the gem (asks for your RubyGems MFA code), then tag v<version> and push the tag
+$ bin/release --dry-run  # show what would happen without building, pushing or tagging
+```
+
+`bin/release` checks out and pulls `main` first, and refuses to run with uncommitted changes or without a CHANGELOG entry. Steps that are already done are skipped, so running it again for a released version does nothing.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [GitHub Repository](https://github.com/sosolidkk/steam_api). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Code of Conduct](https://github.com/sosolidkk/steam_api/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at [GitHub Repository](https://github.com/jpechaves/steam_api). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Code of Conduct](https://github.com/jpechaves/steam_api/blob/main/CODE_OF_CONDUCT.md).
 
 ### How to Contribute
 
@@ -155,4 +184,4 @@ This gem is available as open source under the terms of the [MIT License](https:
 
 ## Code of Conduct
 
-Everyone interacting in the Steam project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [Code of Conduct](https://github.com/sosolidkk/steam_api/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Steam project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [Code of Conduct](https://github.com/jpechaves/steam_api/blob/main/CODE_OF_CONDUCT.md).

data/lib/steam_api_client/errors/api_error.rb

@@ -44,5 +44,34 @@ module SteamApiClient
 
     # status_code: 500
     class HttpInternalServerError < ApiError; end
+
+    # Reads the Retry-After header of rate limited / unavailable responses
+    module RetryAfter
+      # Seconds to wait before retrying. Retry-After is either a number of
+      # seconds or an HTTP date.
+      # @return [Integer, nil] nil when the header is missing or invalid
+      def retry_after
+        value = response.headers&.[]("Retry-After").to_s.strip
+        return Integer(value, 10) if value.match?(/\A\d+\z/)
+        return if value.empty?
+
+        [(Time.httpdate(value) - Time.now).ceil, 0].max
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    # status_code: 429. Steam rate limits frequent requests.
+    class HttpTooManyRequests < ApiError
+      include RetryAfter
+    end
+
+    # status_code: 502
+    class HttpBadGateway < ApiError; end
+
+    # status_code: 503
+    class HttpServiceUnavailable < ApiError
+      include RetryAfter
+    end
   end
 end

data/lib/steam_api_client/errors/missing_api_token.rb

@@ -0,0 +1,11 @@
+module SteamApiClient
+  module Errors
+    # Raised before a request is sent when the endpoint needs an API token
+    # and the client has none
+    class MissingApiToken < ::StandardError
+      def initialize(message = "This endpoint needs a Steam Web API token. Pass Client.new(api_token: ...) or set it with Client.configure { |config| config.api_token = ... }.")
+        super
+      end
+    end
+  end
+end

data/lib/steam_api_client/failure_handler.rb

@@ -30,12 +30,15 @@ module SteamApiClient
       when 401 then raise SteamApiClient::Errors::HttpUnauthorized, response
       when 403 then raise SteamApiClient::Errors::HttpForbidden, response
       when 404 then raise SteamApiClient::Errors::HttpNotFound, response
+      when 429 then raise SteamApiClient::Errors::HttpTooManyRequests, response
       end
     end
 
     def raise_response_5xx(response)
       case response.status_code
       when 500 then raise SteamApiClient::Errors::HttpInternalServerError, response
+      when 502 then raise SteamApiClient::Errors::HttpBadGateway, response
+      when 503 then raise SteamApiClient::Errors::HttpServiceUnavailable, response
       end
     end
 

data/lib/steam_api_client/request.rb

@@ -6,6 +6,7 @@ module SteamApiClient
       @response_struct = response_struct
       @client = client
 
+      ensure_api_token!
       build_request
     end
 
@@ -23,6 +24,13 @@ module SteamApiClient
 
     attr_accessor :request_struct, :response_struct, :client, :raw_request, :failure_handler
 
+    def ensure_api_token!
+      return unless request_struct.needs_authorization?
+      return unless client.api_token.to_s.empty?
+
+      raise SteamApiClient::Errors::MissingApiToken
+    end
+
     def build_request
       url = nil
 
@@ -67,20 +75,19 @@ module SteamApiClient
     end
 
     def build_options
-      {
+      options = {
         method: request_struct.method,
-        headers: default_headers,
-        body: request_struct.body.to_json,
+        headers: {},
         followlocation: true,
         timeout_ms: (client.timeout * 1000).to_i,
         connecttimeout_ms: (client.connect_timeout * 1000).to_i,
         # Required for sub-second timeouts and safe use of timeouts across threads
         nosignal: true
       }
-    end
+      # GET requests (every Steam endpoint so far) carry their params in the query string
+      return options if request_struct.method == :get
 
-    def default_headers
-      {"Content-Type" => "application/json"}
+      options.merge(headers: {"Content-Type" => "application/json"}, body: request_struct.body.to_json)
     end
   end
 end

data/lib/steam_api_client/requestors/app_global_achievements.rb

@@ -4,14 +4,14 @@ module SteamApiClient
     # of an app in the Steam Web Api.
     class AppGlobalAchievements < Base
       # Get on the Api all global achievements info of an App in the Steam.
-      # @param [Integer] gameid The Steam app id
+      # @param [Integer] appid The Steam app id (sent to Steam as `gameid`)
       # @return [SteamApiClient::Structs::AppGlobalAchievements] instance with the
       #   player summary details.
-      def retrieve(gameid)
+      def retrieve(appid:)
         build_request_and_run(
           SteamApiClient::Structs::Requests::GetAppGlobalAchievements,
           SteamApiClient::Structs::AppGlobalAchievements,
-          gameid: gameid
+          gameid: appid
         )
       end
     end

data/lib/steam_api_client/requestors/app_news.rb

@@ -9,7 +9,7 @@ module SteamApiClient
       # @param [Integer] maxlength The max length of the news content
       # @return [SteamApiClient::Structs::AppNews] instance with the
       #   player summary details.
-      def retrieve(appid, count, maxlength = 300)
+      def retrieve(appid:, count:, maxlength: 300)
         build_request_and_run(
           SteamApiClient::Structs::Requests::GetAppNews,
           SteamApiClient::Structs::AppNews,

data/lib/steam_api_client/requestors/game_current_players.rb

@@ -7,7 +7,7 @@ module SteamApiClient
       # @param [Integer] appid The Steam app id
       # @return [SteamApiClient::Structs::GameCurrentPlayers] instance with the
       #   game current players count.
-      def retrieve(appid)
+      def retrieve(appid:)
         build_request_and_run(
           SteamApiClient::Structs::Requests::GetGameCurrentPlayers,
           SteamApiClient::Structs::GameCurrentPlayers,

data/lib/steam_api_client/requestors/player_achievements.rb

@@ -8,7 +8,7 @@ module SteamApiClient
       # @param [Integer] steamid The Steam user id
       # @return [SteamApiClient::Structs::PlayerAchievements] instance with the
       #   player summary details.
-      def retrieve(appid, steamid)
+      def retrieve(appid:, steamid:)
         build_request_and_run(
           SteamApiClient::Structs::Requests::GetPlayerAchievements,
           SteamApiClient::Structs::PlayerAchievements,

data/lib/steam_api_client/requestors/player_friends.rb

@@ -8,7 +8,7 @@ module SteamApiClient
       # @param [String] relationship Relationship filter. Possibles values: 'all', 'friend'.
       # @return [SteamApiClient::Structs::PlayerFriends] instance with the
       #   player friends list.
-      def retrieve(steamid, relationship = "all")
+      def retrieve(steamid:, relationship: "all")
         build_request_and_run(
           SteamApiClient::Structs::Requests::GetPlayerFriends,
           SteamApiClient::Structs::PlayerFriends,

data/lib/steam_api_client/requestors/player_game_stats.rb

@@ -8,7 +8,7 @@ module SteamApiClient
       # @param [Integer] steamid The Steam user id
       # @return [SteamApiClient::Structs::PlayerGameStats] instance with the
       #   player summary details.
-      def retrieve(appid, steamid)
+      def retrieve(appid:, steamid:)
         build_request_and_run(
           SteamApiClient::Structs::Requests::GetPlayerGameStats,
           SteamApiClient::Structs::PlayerGameStats,

data/lib/steam_api_client/requestors/player_level.rb

@@ -6,7 +6,7 @@ module SteamApiClient
       # @param [Integer] steamid The Steam user id
       # @return [SteamApiClient::Structs::PlayerLevel] instance with the
       #   player level.
-      def retrieve(steamid)
+      def retrieve(steamid:)
         build_request_and_run(
           SteamApiClient::Structs::Requests::GetPlayerLevel,
           SteamApiClient::Structs::PlayerLevel,

data/lib/steam_api_client/requestors/player_owned_games.rb

@@ -9,7 +9,7 @@ module SteamApiClient
       # @param [Boolean] include_played_free_games Flag to include free games
       # @return [SteamApiClient::Structs::PlayerOwnedGames] instance with the
       #   player owned games details.
-      def retrieve(steamid, include_appinfo: false, include_played_free_games: false)
+      def retrieve(steamid:, include_appinfo: false, include_played_free_games: false)
         build_request_and_run(
           SteamApiClient::Structs::Requests::GetPlayerOwnedGames,
           SteamApiClient::Structs::PlayerOwnedGames,

data/lib/steam_api_client/requestors/player_recent_games.rb

@@ -8,7 +8,7 @@ module SteamApiClient
       # @param [Integer] count - The number of games that should return
       # @return [SteamApiClient::Structs::PlayerRecentGames] instance with the
       #   player summary details.
-      def retrieve(steamid, count = 5)
+      def retrieve(steamid:, count: 5)
         build_request_and_run(
           SteamApiClient::Structs::Requests::GetPlayerRecentGames,
           SteamApiClient::Structs::PlayerRecentGames,

data/lib/steam_api_client/requestors/player_steamid.rb

@@ -7,7 +7,7 @@ module SteamApiClient
       # @param [String] vanityurl - The Steam user short url
       # @return [SteamApiClient::Structs::PlayerSteamId] instance with the
       #   player SteamId.
-      def retrieve(vanityurl)
+      def retrieve(vanityurl:)
         build_request_and_run(
           SteamApiClient::Structs::Requests::GetPlayerSteamId,
           SteamApiClient::Structs::PlayerSteamId,

data/lib/steam_api_client/requestors/player_summaries.rb

@@ -7,7 +7,7 @@ module SteamApiClient
       # @param [Array<Integer>] steamids - The Steam order's id
       # @return [SteamApiClient::Structs::PlayerSummaries] instance with the
       #   player summary details.
-      def retrieve(steamids)
+      def retrieve(steamids:)
         build_request_and_run(
           SteamApiClient::Structs::Requests::GetPlayerSummaries,
           SteamApiClient::Structs::PlayerSummaries,

data/lib/steam_api_client/response.rb

@@ -25,6 +25,12 @@ module SteamApiClient
       !success?
     end
 
+    # Returns the HTTP response headers (case-insensitive)
+    # @return [Typhoeus::Response::Header, nil]
+    def headers
+      raw_response.headers
+    end
+
     # Returns the HTTP status code
     # @return [Integer]
     def status_code
@@ -57,8 +63,10 @@ module SteamApiClient
 
     attr_accessor :raw_response, :response_struct
 
+    # json 3 rejects duplicate keys by default; keep json 2's behavior (last one wins)
+    # so a response parses the same whichever json version the app uses
     def parse_body
-      ::JSON.parse(raw_response.body.to_s, symbolize_names: true)
+      ::JSON.parse(raw_response.body.to_s, symbolize_names: true, allow_duplicate_key: true)
     end
   end
 end

data/lib/steam_api_client/structs/app_global_achievements.rb

@@ -3,9 +3,9 @@ module SteamApiClient
     # Struct that holds all App Global Achievements information
     # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetGlobalAchievementPercentagesForApp_.28v0002.29
     class AppGlobalAchievements < Base
-      class InternalAppAchievementsAttributes < Dry::Struct
+      class InternalAppAchievementsAttributes < Base
         attribute :name, Types::String
-        attribute :percent, Types::Decimal
+        attribute :percent, Types::Float
       end
 
       attribute :achievementpercentages do

data/lib/steam_api_client/structs/app_new.rb

@@ -2,7 +2,7 @@ module SteamApiClient
   module Structs
     # Struct that holds an App news information
     # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetNewsForApp_.28v0002.29
-    class AppNew < Dry::Struct
+    class AppNew < Base
       attribute :gid, Types::String
       attribute :title, Types::String
       attribute :url, Types::String

data/lib/steam_api_client/structs/player_achievements.rb

@@ -3,7 +3,7 @@ module SteamApiClient
     # Struct that holds all Player Achievements of an app information
     # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetPlayerAchievements_.28v0001.29
     class PlayerAchievements < Base
-      class InternalPlayerAchievementsAttributes < Dry::Struct
+      class InternalPlayerAchievementsAttributes < Base
         attribute :apiname?, Types::String
         attribute :achieved?, Types::Integer
         attribute :unlocktime?, Types::Integer

data/lib/steam_api_client/structs/player_friends.rb

@@ -2,7 +2,7 @@ module SteamApiClient
   module Structs
     # Struct that holds information of all friends the player has
     # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetFriendList_.28v0001.29
-    class InternalPlayerFriends < Dry::Struct
+    class InternalPlayerFriends < Base
       attribute :steamid?, Types::Integer
       attribute :relationship?, Types::String
       attribute :friend_since, Types::Integer

data/lib/steam_api_client/structs/player_game_stats.rb

@@ -3,14 +3,22 @@ module SteamApiClient
     # Struct that holds all Player Stats for a given game/appid
     # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetUserStatsForGame_.28v0002.29
     class PlayerGameStats < Base
-      class InternalPlayerGameStatsAttributes < Dry::Struct
+      class InternalPlayerGameStatsAttributes < Base
         attribute :name?, Types::String
         attribute :achieved?, Types::Integer
       end
 
+      # A game-defined stat, e.g. "Scout.accum.iDamageDealt" => 26580
+      class Stat < Base
+        attribute :name, Types::String
+        # Integer or Float exactly as Steam sends it (coercing would truncate float stats)
+        attribute :value, (Types::Strict::Integer | Types::Strict::Float).optional
+      end
+
       attribute :playerstats do
         attribute :steamID?, Types::Coercible::Integer.optional.default(nil)
         attribute :gameName?, Types::String
+        attribute :stats?, Types::Strict::Array.of(Stat)
         attribute :achievements?, Types::Strict::Array.of(
           InternalPlayerGameStatsAttributes
         )

data/lib/steam_api_client/structs/player_owned_games.rb

@@ -3,15 +3,21 @@ module SteamApiClient
     # Struct that holds all user owned games
     # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetOwnedGames_.28v0001.29
     class PlayerOwnedGames < Base
-      class InternalPlayerOwnedGames < Dry::Struct
+      class InternalPlayerOwnedGames < Base
         attribute :appid, Types::Integer
         attribute :name?, Types::String
+        # Minutes played, in total and in the last two weeks (only sent when played recently)
         attribute :playtime_forever, Types::Integer
+        attribute? :playtime_2weeks, Types::Integer
         attribute :img_icon_url?, Types::String
-        attribute :playtime_windows_forever, Types::Integer
-        attribute :playtime_mac_forever, Types::Integer
-        attribute :playtime_linux_forever, Types::Integer
-        attribute :rtime_last_played, Types::Integer
+        attribute? :has_community_visible_stats, Types::Bool
+        attribute? :has_leaderboards, Types::Bool
+        attribute? :content_descriptorids, Types::Array.of(Types::Integer)
+        # Steam doesn't send these for most libraries anymore
+        attribute? :playtime_windows_forever, Types::Integer
+        attribute? :playtime_mac_forever, Types::Integer
+        attribute? :playtime_linux_forever, Types::Integer
+        attribute? :rtime_last_played, Types::Integer
       end
 
       attribute :response do

data/lib/steam_api_client/structs/player_recent_games.rb

@@ -3,7 +3,7 @@ module SteamApiClient
     # Struct that holds all user recent played games
     # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetRecentlyPlayedGames_.28v0001.29
     class PlayerRecentGames < Base
-      class InternalPlayerRecentGames < Dry::Struct
+      class InternalPlayerRecentGames < Base
         attribute :appid, Types::Integer
         attribute :name, Types::String
         attribute :playtime_2weeks, Types::Integer