steam_api_client 0.9.0

data/lib/steam_api_client/structs/app_details/achievement.rb

@@ -0,0 +1,12 @@
+module SteamApiClient
+  module Structs
+    module AppDetails
+      # Struct that holds the App/Game achievement highlighted information
+      # @see https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI#appdetails
+      class Achievement < Base
+        attribute :name, Types::String
+        attribute :path, Types::String
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/app_details/category.rb

@@ -0,0 +1,12 @@
+module SteamApiClient
+  module Structs
+    module AppDetails
+      # Struct that holds the App/Game category information
+      # @see https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI#appdetails
+      class Category < Base
+        attribute :id, Types::Coercible::Integer
+        attribute :description, Types::String
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/app_details/details.rb

@@ -0,0 +1,82 @@
+module SteamApiClient
+  module Structs
+    module AppDetails
+      # Struct that holds the App/Game details information
+      # @see https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI#appdetails
+      class Details < Base
+        attribute :appid, Types::Coercible::Integer
+        attribute :response do
+          attribute :success, Types::Bool
+          # Steam omits data when the app is unavailable (success: false)
+          attribute? :data do
+            attribute? :type, Types::String
+            attribute? :name, Types::String
+            attribute? :required_age, Types::Coercible::Integer
+            attribute? :is_free, Types::Bool
+            attribute? :dlc, Types::Array.of(Types::Coercible::Integer)
+            attribute? :detailed_description, Types::String
+            attribute? :about_the_game, Types::String
+            attribute? :short_description, Types::String
+            attribute? :supported_languages, Types::String
+            attribute? :header_image, Types::String
+            attribute? :website, Types::String
+            attribute? :pc_requirements, SteamApiClient::Structs::AppDetails::Requirements
+            attribute? :mac_requirements, SteamApiClient::Structs::AppDetails::Requirements
+            attribute? :linux_requirements, SteamApiClient::Structs::AppDetails::Requirements
+            attribute? :developers, Types::Array.of(Types::Coercible::String)
+            attribute? :publishers, Types::Array.of(Types::Coercible::String)
+            attribute? :price_overview do
+              attribute :currency, Types::String
+              attribute :initial, Types::Coercible::Integer
+              attribute :final, Types::Coercible::Integer
+              attribute :discount_percent, Types::Coercible::Integer
+              attribute :initial_formatted, Types::String
+              attribute :final_formatted, Types::String
+            end
+            attribute? :packages, Types::Array.of(Types::Coercible::Integer)
+            attribute? :package_groups, Types::Array.of(SteamApiClient::Structs::AppDetails::PackageGroup)
+            attribute? :platforms do
+              attribute :windows, Types::Bool
+              attribute :mac, Types::Bool
+              attribute :linux, Types::Bool
+            end
+            attribute? :metacritic do
+              attribute :score, Types::Coercible::Integer
+              attribute :url, Types::String
+            end
+            attribute? :categories, Types::Array.of(SteamApiClient::Structs::AppDetails::Category)
+            attribute? :genres, Types::Array.of(SteamApiClient::Structs::AppDetails::Genre)
+            attribute? :screenshots, Types::Array.of(SteamApiClient::Structs::AppDetails::Screenshot)
+            attribute? :movies, Types::Array.of(SteamApiClient::Structs::AppDetails::Movie)
+            attribute? :recommendations do
+              attribute :total, Types::Coercible::Integer
+            end
+            attribute? :achievements do
+              attribute :total, Types::Coercible::Integer
+              attribute :highlighted, Types::Array.of(SteamApiClient::Structs::AppDetails::Achievement)
+            end
+            attribute? :release_date do
+              attribute :coming_soon, Types::Bool
+              attribute :date, Types::String
+            end
+            attribute? :support_info do
+              attribute :url, Types::String
+              attribute :email, Types::String
+            end
+            attribute? :background, Types::String
+            attribute? :background_raw, Types::String
+            attribute? :content_descriptors do
+              attribute :ids, Types::Array.of(Types::Coercible::Integer)
+              attribute :notes, Types::String
+            end
+          end
+        end
+
+        def self.build_from_response(json_response)
+          outer_key = json_response.keys.first
+          new(appid: outer_key.to_s, response: json_response[outer_key])
+        end
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/app_details/genre.rb

@@ -0,0 +1,12 @@
+module SteamApiClient
+  module Structs
+    module AppDetails
+      # Struct that holds the App/Game genre information
+      # @see https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI#appdetails
+      class Genre < Base
+        attribute :id, Types::Coercible::Integer
+        attribute :description, Types::String
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/app_details/movie.rb

@@ -0,0 +1,25 @@
+module SteamApiClient
+  module Structs
+    module AppDetails
+      # Struct that holds the App/Game video (movies, trailers etc) information
+      # @see https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI#appdetails
+      class Movie < Base
+        attribute :id, Types::Coercible::Integer
+        attribute :name, Types::String
+        attribute :thumbnail, Types::String
+        # Streaming manifests (MPEG-DASH and HLS) returned by the current Storefront API
+        attribute? :dash_av1, Types::String
+        attribute? :dash_h264, Types::String
+        attribute? :hls_h264, Types::String
+        # Legacy direct video files, no longer returned by Steam
+        attribute? :webm do
+          attribute :max, Types::String
+        end
+        attribute? :mp4 do
+          attribute :max, Types::String
+        end
+        attribute :highlight, Types::Bool
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/app_details/package_group.rb

@@ -0,0 +1,18 @@
+module SteamApiClient
+  module Structs
+    module AppDetails
+      # Struct that holds the App/Game package group information
+      # @see https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI#appdetails
+      class PackageGroup < Base
+        attribute :name, Types::String
+        attribute :title, Types::String
+        attribute :description, Types::String
+        attribute :selection_text, Types::String
+        attribute :save_text, Types::String
+        attribute :display_type, Types::Coercible::Integer
+        attribute :is_recurring_subscription, Types::String
+        attribute :subs, Types::Array.of(SteamApiClient::Structs::AppDetails::Sub)
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/app_details/requirements.rb

@@ -0,0 +1,12 @@
+module SteamApiClient
+  module Structs
+    module AppDetails
+      # Struct that holds the App/Game requirement information
+      # @see https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI#appdetails
+      class Requirements < Base
+        attribute :minimum?, Types::String
+        attribute :recommended?, Types::String
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/app_details/screenshot.rb

@@ -0,0 +1,13 @@
+module SteamApiClient
+  module Structs
+    module AppDetails
+      # Struct that holds the App/Game screenshot information
+      # @see https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI#appdetails
+      class Screenshot < Base
+        attribute :id, Types::Coercible::Integer
+        attribute :path_thumbnail, Types::String
+        attribute :path_full, Types::String
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/app_details/sub.rb

@@ -0,0 +1,18 @@
+module SteamApiClient
+  module Structs
+    module AppDetails
+      # Struct that holds the App/Game package group sub information
+      # @see https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI#appdetails
+      class Sub < Base
+        attribute :packageid, Types::Coercible::Integer
+        attribute :percent_savings_text, Types::String
+        attribute :percent_savings, Types::Coercible::Integer
+        attribute :option_text, Types::String
+        attribute :option_description, Types::String
+        attribute :can_get_free_license, Types::String
+        attribute :is_free_license, Types::Bool
+        attribute :price_in_cents_with_discount, Types::Coercible::Integer
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/app_global_achievements.rb

@@ -0,0 +1,18 @@
+module SteamApiClient
+  module Structs
+    # 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
+        attribute :name, Types::String
+        attribute :percent, Types::Decimal
+      end
+
+      attribute :achievementpercentages do
+        attribute :achievements?, Types::Strict::Array.of(
+          InternalAppAchievementsAttributes
+        )
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/app_new.rb

@@ -0,0 +1,20 @@
+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
+      attribute :gid, Types::String
+      attribute :title, Types::String
+      attribute :url, Types::String
+      attribute :is_external_url, Types::Bool
+      attribute :author, Types::String
+      attribute :contents, Types::String
+      attribute :feedlabel, Types::String
+      attribute :date, Types::Integer
+      attribute :feedname, Types::String
+      attribute :feed_type, Types::Integer
+      attribute :appid, Types::Integer
+      attribute :tags?, Types::Strict::Array.of(Types::String).optional
+    end
+  end
+end

data/lib/steam_api_client/structs/app_news.rb

@@ -0,0 +1,13 @@
+module SteamApiClient
+  module Structs
+    # Struct that holds all App news information
+    # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetNewsForApp_.28v0002.29
+    class AppNews < Base
+      attribute :appnews do
+        attribute :appid?, Types::Integer
+        attribute :count?, Types::Integer
+        attribute :newsitems?, Types::Strict::Array.of(AppNew)
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/base.rb

@@ -0,0 +1,15 @@
+module SteamApiClient
+  module Structs
+    # Base struct used by the others client's structs.
+    class Base < ::Dry::Struct
+      transform_keys(&:to_sym)
+
+      # Build the struct through the response from api.
+      # @param [Hash] json_response - The json response received from api.
+      # @return an instance of the Struct
+      def self.build_from_response(json_response)
+        new(**json_response)
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/game_current_players.rb

@@ -0,0 +1,12 @@
+module SteamApiClient
+  module Structs
+    # Struct that holds the number of current players for a game/appid
+    # @see https://wiki.teamfortress.com/wiki/WebAPI/GetNumberOfCurrentPlayers
+    class GameCurrentPlayers < Base
+      attribute :response do
+        attribute :player_count?, Types::Coercible::Integer
+        attribute :result, Types::Coercible::Integer
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/player_achievements.rb

@@ -0,0 +1,23 @@
+module SteamApiClient
+  module Structs
+    # 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
+        attribute :apiname?, Types::String
+        attribute :achieved?, Types::Integer
+        attribute :unlocktime?, Types::Integer
+      end
+
+      attribute :playerstats do
+        attribute :steamID?, Types::Coercible::Integer.optional.default(nil)
+        attribute :error?, Types::String
+        attribute :gameName?, Types::String
+        attribute :achievements?, Types::Strict::Array.of(
+          InternalPlayerAchievementsAttributes
+        )
+        attribute :success, Types::Bool
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/player_friends.rb

@@ -0,0 +1,17 @@
+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
+      attribute :steamid?, Types::Integer
+      attribute :relationship?, Types::String
+      attribute :friend_since, Types::Integer
+    end
+
+    class PlayerFriends < Base
+      attribute :friendslist do
+        attribute :friends?, Types::Strict::Array.of(InternalPlayerFriends)
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/player_game_stats.rb

@@ -0,0 +1,20 @@
+module SteamApiClient
+  module Structs
+    # 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
+        attribute :name?, Types::String
+        attribute :achieved?, Types::Integer
+      end
+
+      attribute :playerstats do
+        attribute :steamID?, Types::Coercible::Integer.optional.default(nil)
+        attribute :gameName?, Types::String
+        attribute :achievements?, Types::Strict::Array.of(
+          InternalPlayerGameStatsAttributes
+        )
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/player_level.rb

@@ -0,0 +1,11 @@
+module SteamApiClient
+  module Structs
+    # Struct that holds the user level on Steam
+    # @see https://wiki.teamfortress.com/wiki/WebAPI/GetSteamLevel
+    class PlayerLevel < Base
+      attribute :response do
+        attribute :player_level?, Types::Integer
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/player_owned_games.rb

@@ -0,0 +1,25 @@
+module SteamApiClient
+  module Structs
+    # 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
+        attribute :appid, Types::Integer
+        attribute :name?, Types::String
+        attribute :playtime_forever, 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
+      end
+
+      attribute :response do
+        attribute :game_count?, Types::Integer
+        attribute :games?, Types::Strict::Array.of(
+          InternalPlayerOwnedGames
+        )
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/player_recent_games.rb

@@ -0,0 +1,22 @@
+module SteamApiClient
+  module Structs
+    # 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
+        attribute :appid, Types::Integer
+        attribute :name, Types::String
+        attribute :playtime_2weeks, Types::Integer
+        attribute :playtime_forever, Types::Integer
+        attribute :img_icon_url, Types::String
+      end
+
+      attribute :response do
+        attribute :total_count?, Types::Integer
+        attribute :games?, Types::Strict::Array.of(
+          InternalPlayerRecentGames
+        ).optional
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/player_steamid.rb

@@ -0,0 +1,16 @@
+module SteamApiClient
+  module Structs
+    # Struct that holds the player SteamId
+    # @see https://wiki.teamfortress.com/wiki/WebAPI/ResolveVanityURL
+    class PlayerSteamId < Base
+      attribute :response do
+        # The 64 bit Steam ID the vanity URL resolves to. Not returned on resolution failures.
+        attribute :steamid?, Types::Coercible::Integer.optional.default(nil)
+        # The message associated with the request status. Currently only used on resolution failures.
+        attribute :message?, Types::String
+        # The status of the request. 1 if successful, 42 if there was no match.
+        attribute :success, Types::Integer
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/player_summaries.rb

@@ -0,0 +1,11 @@
+module SteamApiClient
+  module Structs
+    # Struct that holds the Player Summaries information
+    # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetPlayerSummaries_.28v0002.29
+    class PlayerSummaries < Base
+      attribute :response do
+        attribute :players, Types::Strict::Array.of(PlayerSummary)
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/player_summary.rb

@@ -0,0 +1,34 @@
+module SteamApiClient
+  module Structs
+    # Struct that holds the Player Summary information
+    # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetPlayerSummaries_.28v0002.29
+    class PlayerSummary < Dry::Struct
+      # 64bit SteamID of the user
+      attribute :steamid, Types::String
+      # The player's persona name (display name)
+      attribute :personaname, Types::String
+      # The full URL of the player's Steam Community profile.
+      attribute :profileurl, Types::String
+      # The full URL of the player's 32x32px avatar. If the user hasn't configured an avatar
+      # this will be the default ? avatar.
+      attribute :avatar, Types::String
+      # The full URL of the player's 64x64px avatar. If the user hasn't configured an avatar
+      # this will be the default ? avatar.
+      attribute :avatarmedium, Types::String
+      # The full URL of the player's 184x184px avatar. If the user hasn't configured an avatar
+      # this will be the default ? avatar.
+      attribute :avatarfull, Types::String
+      # The user's current status. 0 - Offline, 1 - Online, 2 - Busy, 3 - Away, 4 - Snooze, 5 - looking to trade
+      # 6 - looking to play. If the player's profile is private, this will always be "0".
+      attribute :personastate, Types::Integer
+      # This represents whether the profile is visible or not, and if it is visible, why you are allowed to see it.
+      attribute :communityvisibilitystate, Types::Integer
+      # If set, indicates the user has a community profile configured (will be set to '1')
+      attribute :profilestate, Types::String
+      # The last time the user was online, in unix time.
+      attribute :lastlogoff, Types::Optional::Integer
+      # If set, indicates the profile allows public comments.
+      attribute :commentpermission, Types::Optional::Integer
+    end
+  end
+end

data/lib/steam_api_client/structs/requests/abstract.rb

@@ -0,0 +1,59 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      # @abstract class for a base API endpoint Request's struct
+      class Abstract < SteamApiClient::Structs::Base
+        # Returns the version value to create the request path
+        # @abstract
+        # @return [String] the version of the request path
+        def version
+          raise NoMethodError, "Override this method"
+        end
+
+        # Returns the interface value to create the request path
+        # @abstract
+        # @return [String] the interface of the request path
+        def interface
+          raise NoMethodError, "Override this method"
+        end
+
+        # Returns the API path value to create the request path
+        # @abstract
+        # @return [String] the API path of the request path
+        def path
+          raise NoMethodError, "Override this method"
+        end
+
+        # Returns the HTTP method used by the request.
+        # @return [Symbol]
+        def method
+          :get
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          {}
+        end
+
+        # Return the class attributes as a Hash
+        # @return [Hash]
+        def body
+          to_h
+        end
+
+        # Tells if the request require the api_token in the query params
+        # @return [Boolean]
+        def needs_authorization?
+          true
+        end
+
+        # Tells the URL builder which format to choose from
+        # @return [Symbol]
+        def endpoint_kind
+          :base_endpoint
+        end
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/requests/get_app_details.rb

@@ -0,0 +1,54 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetAppDetails < StorefrontAbstract
+        attribute :appid, Types::Integer
+        attribute :filters, Types::Array.of(Types::String)
+        attribute :cc, Types::String
+        attribute :l, Types::String
+
+        # Build the struct through the received params.
+        # @params [Hash] params The hash params.
+        # @return an instance of the Struct
+        def self.build_from_params(params)
+          %i[appid].each do |attrib|
+            raise StandardError, "#{attrib} is missing" unless params.key?(attrib)
+          end
+
+          new(params)
+        end
+
+        # Returns the API path value to create the request path
+        # @return [String] the API path of the request path
+        def path
+          "appdetails/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          super.merge(
+            {
+              appids: appid,
+              filters: filters.join(","),
+              cc: cc,
+              l: l
+            }
+          )
+        end
+
+        # Return the class attributes as a Hash
+        # @return [Hash]
+        def body
+          {}
+        end
+
+        # Tells if the request require the api_token in the query params
+        # @return [Boolean]
+        def needs_authorization?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/requests/get_app_global_achievements.rb

@@ -0,0 +1,54 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetAppGlobalAchievements < Abstract
+        attribute :gameid, Types::Integer
+
+        # Build the struct through the received params.
+        # @params [Hash] params The hash params.
+        # @return an instance of the Struct
+        def self.build_from_params(params)
+          raise StandardError, ":gameid is missing" unless params.key?(:gameid)
+
+          new(params)
+        end
+
+        # Returns the version value to create the request path
+        # @return [String] the version of the request path
+        def version
+          "v0002/"
+        end
+
+        # Returns the interface value to create the request path
+        # @return [String] the interface of the request path
+        def interface
+          "ISteamUserStats/"
+        end
+
+        # Returns the API path value to create the request path
+        # @return [String] the API path of the request path
+        def path
+          "GetGlobalAchievementPercentagesForApp/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          {gameid: gameid}
+        end
+
+        # Return the class attributes as a Hash
+        # @return [Hash]
+        def body
+          {}
+        end
+
+        # Tells if the request require the api_token in the query params
+        # @return [Boolean]
+        def needs_authorization?
+          false
+        end
+      end
+    end
+  end
+end