steam_api_client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d69cc1b3c7d853d973708c6ec1c4eacebb60122b0f338dbbec3eb0766ae63464
-  data.tar.gz: 4df0c047832658d3ecbc4505a0308682ab93121c834e44c9515cb63e5e8f17be
+  metadata.gz: fff398c488310a8cd495c37bc213bc6b41645c21aef707a5b83a951c4ee7550e
+  data.tar.gz: '0191bdcd553d89bcf7f15cf247eb5aa2e6a616377e791a544ee8ccfefcdc9e7d'
 SHA512:
-  metadata.gz: 14c25c60ca63dbc6eee90a07060b0a34d87a61c5d2808a9ac5b12aab5aeb1b2ca769e1f58b2dd638cbb32f4b00740dede05f83534105b80d39599fa9b47eec35
-  data.tar.gz: c36ccb50189c59e39be4420bc9419594457fa4383a614506b68770621df445d487a223fa4f7e2450ffd9dc7911a398b29dfb6967f8a8c13e791ff3779d5db9e1
+  metadata.gz: eee77c9968b4a7ba64330c7fde66690509e2f8c6e9ea77bacd16b7e61a097f6e4ac8daa4226d38c6c33fbf6ed2d753dbf4c5527d58951672a2d33d18c91d27d5
+  data.tar.gz: e9fae7d714e744f4131951f3c45f73f4e8e81725b01b61d7ed6a9fc365293fe94808b58a6e96be457904e89c64b4fd3d073d1a1616051c6b5354a76d01c62a1e

data/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 ## [Unreleased]
 
+## [1.1.0] - 2026-11-02
+
+### Added
+
+- `player_wishlist`, `player_wishlist_count` and `player_followed_games`: a player's wishlist and the apps they follow in the store. No API key needed (#104).
+
 ## [1.0.0] - 2026-10-24
 
 ### Added
@@ -198,7 +204,8 @@ The versions below were bumped in `version.rb` during development but **never pu
 
 - Initial gem skeleton.
 
-[Unreleased]: https://github.com/jpechaves/steam_api/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/jpechaves/steam_api/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/jpechaves/steam_api/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/jpechaves/steam_api/compare/v0.10.0...v1.0.0
 [0.11.0]: https://github.com/jpechaves/steam_api/compare/v0.10.0...v0.11.0
 [0.10.0]: https://github.com/jpechaves/steam_api/compare/v0.9.1...v0.10.0

data/docs/USAGE.md

@@ -191,6 +191,33 @@ stats.achievements.first # => #<data SteamApiClient::PlayerGameStats::Achievemen
 
 Stat values are Integers or Floats, as the game defines them. A private profile, or a game without stats, raises `Errors::HttpBadRequest`.
 
+#### `player_wishlist`
+
+The apps on a player's wishlist. No key needed.
+
+```ruby
+client.player_wishlist.retrieve(steamid: 76561198000000001).first
+# => #<data SteamApiClient::WishlistItem app_id=202350, priority=3, date_added=1403384867>
+```
+
+`priority` is the player's ranking of the app, and `date_added` a unix timestamp. A private or empty wishlist is `[]`. An ID that isn't a valid SteamID (e.g. `1`) raises `Errors::HttpBadRequest`, here and in the two endpoints below.
+
+#### `player_wishlist_count`
+
+The number of apps on a player's wishlist, or `nil` when it's private or empty. No key needed.
+
+```ruby
+client.player_wishlist_count.retrieve(steamid: 76561198000000001) # => 19
+```
+
+#### `player_followed_games`
+
+The app IDs a player follows in the store, or `[]` when the profile is private. No key needed.
+
+```ruby
+client.player_followed_games.retrieve(steamid: 76561198000000001) # => [400, 440, 620, ...]
+```
+
 ### Apps
 
 #### `app_details`
@@ -321,6 +348,6 @@ Don't retry other 4xx errors: they won't succeed on their own.
 
 - **Rate limits.** Steam's [Web API terms](https://steamcommunity.com/dev/apiterms) allow 100,000 calls per day per key. The Storefront API (`app_details`) is rate limited per IP address, commonly reported at about 200 requests per 5 minutes. Both answer `429` when you go over. Cache what you can.
 - **The Storefront API is unofficial.** `app_details` uses the API behind Steam's store and Big Picture mode. Valve doesn't document it, and its fields change without notice.
-- **Private profiles.** What a player hides depends on their privacy settings. Depending on the endpoint, Steam answers with an error (`player_achievements`: 403, `player_game_stats`: 400, `player_friends`: 401) or with empty data, which the gem returns as `nil` (`player_owned_games`, `player_recent_games`, `player_level`). `player_summaries` still returns the public part of the profile.
+- **Private profiles.** What a player hides depends on their privacy settings. Depending on the endpoint, Steam answers with an error (`player_achievements`: 403, `player_game_stats`: 400, `player_friends`: 401) or with empty data, which the gem returns as `nil` or `[]` (`player_owned_games`, `player_recent_games`, `player_level`, `player_wishlist`, `player_wishlist_count`, `player_followed_games`). Steam answers the same way for an empty wishlist, so the wishlist endpoints can't tell the two apart. `player_summaries` still returns the public part of the profile.
 - **The key is in the URL.** Steam requires `?key=...` in the query string. Treat logs of request URLs as secrets (see [Configuration](#configuration)), and [rotate your key](https://steamcommunity.com/dev/apikey) if it leaks.
 - **SteamIDs are 64 bit Integers** (e.g. `76561197960435530`). Use `player_steamid` to get one from a vanity URL.

data/lib/steam_api_client/endpoints.rb

@@ -62,6 +62,13 @@ module SteamApiClient
         params: {appid: param.integer, steamid: param.integer}
       ),
 
+      # The apps a player follows in the store => [Integer] app IDs ([] when not public)
+      # @see https://steamapi.xpaw.me/#IStoreService/GetGamesFollowed
+      Endpoint.new(
+        :player_followed_games, "IStoreService/GetGamesFollowed/v1/", key: false, returns: [:integer], at: %i[response appids],
+        params: {steamid: param.integer}
+      ),
+
       # A player's friend list, if public => [Friend]
       # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetFriendList_.28v0001.29
       Endpoint.new(
@@ -116,6 +123,20 @@ module SteamApiClient
       Endpoint.new(
         :player_summaries, "ISteamUser/GetPlayerSummaries/v0002/", returns: [PlayerSummary], at: %i[response players],
         params: {steamids: param.integer_list}
+      ),
+
+      # A player's wishlist => [WishlistItem] ([] when empty or not public)
+      # @see https://steamapi.xpaw.me/#IWishlistService/GetWishlist
+      Endpoint.new(
+        :player_wishlist, "IWishlistService/GetWishlist/v1/", key: false, returns: [WishlistItem], at: %i[response items],
+        params: {steamid: param.integer}
+      ),
+
+      # The number of apps on a player's wishlist => Integer, or nil when empty or not public
+      # @see https://steamapi.xpaw.me/#IWishlistService/GetWishlistItemCount
+      Endpoint.new(
+        :player_wishlist_count, "IWishlistService/GetWishlistItemCount/v1/", key: false, returns: :integer, at: %i[response count],
+        params: {steamid: param.integer}
       )
     ].to_h { |endpoint| [endpoint.name, endpoint] }.freeze
   end

data/lib/steam_api_client/models/wishlist_item.rb

@@ -0,0 +1,11 @@
+module SteamApiClient
+  # An app on a player's wishlist, from `player_wishlist`
+  # @see https://steamapi.xpaw.me/#IWishlistService/GetWishlist
+  WishlistItem = Model.define(
+    app_id: [:integer, from: :appid],
+    # The player's ranking of the app in their wishlist
+    priority: :integer,
+    # In unix time
+    date_added: :integer
+  )
+end

data/lib/steam_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SteamApiClient
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/steam_api_client.rb

@@ -30,6 +30,7 @@ require_relative "steam_api_client/models/player_game_stats"
 require_relative "steam_api_client/models/news_item"
 require_relative "steam_api_client/models/global_achievement"
 require_relative "steam_api_client/models/app_details"
+require_relative "steam_api_client/models/wishlist_item"
 
 require_relative "steam_api_client/endpoints"
 require_relative "steam_api_client/client"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steam_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - João Pedro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-24 00:00:00.000000000 Z
+date: 2026-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -61,6 +61,7 @@ files:
 - lib/steam_api_client/models/player_achievements.rb
 - lib/steam_api_client/models/player_game_stats.rb
 - lib/steam_api_client/models/player_summary.rb
+- lib/steam_api_client/models/wishlist_item.rb
 - lib/steam_api_client/request.rb
 - lib/steam_api_client/requestor.rb
 - lib/steam_api_client/response.rb