steam_api_client 0.9.0

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

@@ -0,0 +1,62 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetAppNews < Abstract
+        attribute :appid, Types::Integer
+        attribute :count, Types::Integer
+        attribute :maxlength, 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)
+          %i[appid count maxlength].each do |attrib|
+            raise StandardError, "#{attrib} is missing" unless params.key?(attrib)
+          end
+
+          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
+          "ISteamNews/"
+        end
+
+        # Returns the API path value to create the request path
+        # @return [String] the API path of the request path
+        def path
+          "GetNewsForApp/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          {
+            appid: appid,
+            count: count,
+            maxlength: maxlength
+          }
+        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_game_current_players.rb

@@ -0,0 +1,54 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetGameCurrentPlayers < Abstract
+        attribute :appid, 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, ":appid is missing" unless params.key?(:appid)
+
+          new(params)
+        end
+
+        # Returns the version value to create the request path
+        # @return [String] the version of the request path
+        def version
+          "v0001/"
+        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
+          "GetNumberOfCurrentPlayers/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          {appid: appid}
+        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_player_achievements.rb

@@ -0,0 +1,54 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetPlayerAchievements < Abstract
+        attribute :appid, Types::Integer
+        attribute :steamid, 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)
+          %i[appid steamid].each do |attrib|
+            raise StandardError, "#{attrib} is missing" unless params.key?(attrib)
+          end
+
+          new(params)
+        end
+
+        # Returns the version value to create the request path
+        # @return [String] the version of the request path
+        def version
+          "v0001/"
+        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
+          "GetPlayerAchievements/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          {
+            appid: appid,
+            steamid: steamid
+          }
+        end
+
+        # Return the class attributes as a Hash
+        # @return [Hash]
+        def body
+          {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetPlayerFriends < Abstract
+        attribute :steamid, Types::Integer
+        attribute :relationship, 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[steamid relationship].each do |attrib|
+            raise StandardError, "#{attrib} is missing" unless params.key?(attrib)
+          end
+
+          # The only possible values are: all, friend.
+          raise StandardError, ":relationship value not allowed" unless %w[all friend].include? params[:relationship]
+
+          new(params)
+        end
+
+        # Returns the version value to create the request path
+        # @return [String] the version of the request path
+        def version
+          "v0001/"
+        end
+
+        # Returns the interface value to create the request path
+        # @return [String] the interface of the request path
+        def interface
+          "ISteamUser/"
+        end
+
+        # Returns the API path value to create the request path
+        # @return [String] the API path of the request path
+        def path
+          "GetFriendList/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          {
+            steamid: steamid,
+            relationship: relationship
+          }
+        end
+
+        # Return the class attributes as a Hash
+        # @return [Hash]
+        def body
+          {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetPlayerGameStats < Abstract
+        attribute :appid, Types::Integer
+        attribute :steamid, 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)
+          %i[appid steamid].each do |attrib|
+            raise StandardError, "#{attrib} is missing" unless params.key?(attrib)
+          end
+
+          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
+          "GetUserStatsForGame/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          {
+            appid: appid,
+            steamid: steamid
+          }
+        end
+
+        # Return the class attributes as a Hash
+        # @return [Hash]
+        def body
+          {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetPlayerLevel < Abstract
+        attribute :steamid, 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, ":steamid is missing" unless params.key?(:steamid)
+
+          new(params)
+        end
+
+        # Returns the version value to create the request path
+        # @return [String] the version of the request path
+        def version
+          "v0001/"
+        end
+
+        # Returns the interface value to create the request path
+        # @return [String] the interface of the request path
+        def interface
+          "IPlayerService/"
+        end
+
+        # Returns the API path value to create the request path
+        # @return [String] the API path of the request path
+        def path
+          "GetSteamLevel/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          {steamid: steamid}
+        end
+
+        # Return the class attributes as a Hash
+        # @return [Hash]
+        def body
+          {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetPlayerOwnedGames < Abstract
+        attribute :steamid, Types::Integer
+        attribute :include_appinfo, Types::Bool
+        attribute :include_played_free_games, Types::Bool
+
+        # 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[steamid include_appinfo include_played_free_games].each do |attrib|
+            raise StandardError, "#{attrib} is missing" unless params.key?(attrib)
+          end
+
+          new(params)
+        end
+
+        # Returns the version value to create the request path
+        # @return [String] the version of the request path
+        def version
+          "v0001/"
+        end
+
+        # Returns the interface value to create the request path
+        # @return [String] the interface of the request path
+        def interface
+          "IPlayerService/"
+        end
+
+        # Returns the API path value to create the request path
+        # @return [String] the API path of the request path
+        def path
+          "GetOwnedGames/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          {
+            steamid: steamid,
+            include_appinfo: include_appinfo,
+            include_played_free_games: include_played_free_games
+          }
+        end
+
+        # Return the class attributes as a Hash
+        # @return [Hash]
+        def body
+          {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetPlayerRecentGames < Abstract
+        attribute :steamid, Types::Integer
+        attribute :count, 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)
+          %i[steamid count].each do |attrib|
+            raise StandardError, "#{attrib} is missing" unless params.key?(attrib)
+          end
+
+          new(params)
+        end
+
+        # Returns the version value to create the request path
+        # @return [String] the version of the request path
+        def version
+          "v0001/"
+        end
+
+        # Returns the interface value to create the request path
+        # @return [String] the interface of the request path
+        def interface
+          "IPlayerService/"
+        end
+
+        # Returns the API path value to create the request path
+        # @return [String] the API path of the request path
+        def path
+          "GetRecentlyPlayedGames/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          {
+            steamid: steamid,
+            count: count
+          }
+        end
+
+        # Return the class attributes as a Hash
+        # @return [Hash]
+        def body
+          {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetPlayerSteamId < Abstract
+        attribute :vanityurl, 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)
+          raise StandardError, ":vanityurl is missing" unless params.key?(:vanityurl)
+
+          new(params)
+        end
+
+        # Returns the version value to create the request path
+        # @return [String] the version of the request path
+        def version
+          "v0001/"
+        end
+
+        # Returns the interface value to create the request path
+        # @return [String] the interface of the request path
+        def interface
+          "ISteamUser/"
+        end
+
+        # Returns the API path value to create the request path
+        # @return [String] the API path of the request path
+        def path
+          "ResolveVanityURL/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          {vanityurl: vanityurl}
+        end
+
+        # Return the class attributes as a Hash
+        # @return [Hash]
+        def body
+          {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      class GetPlayerSummaries < Abstract
+        attribute :steamids, Types::Array.of(Types::Coercible::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, ":steamids are missing" unless params.key?(:steamids)
+
+          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
+          "ISteamUser/"
+        end
+
+        # Returns the API path value to create the request path
+        # @return [String] the API path of the request path
+        def path
+          "GetPlayerSummaries/"
+        end
+
+        # Returns the query params needed for the HTTP request
+        # @return [Hash]
+        def query_params
+          # I need to join the steamids because they wont accept
+          # multiple equal keys with different values on query params
+          {
+            steamids: steamids.join(",")
+          }
+        end
+
+        # Return the class attributes as a Hash
+        # @return [Hash]
+        def body
+          {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+module SteamApiClient
+  module Structs
+    module Requests
+      # @abstract class for a Storefront Request's struct
+      class StorefrontAbstract < SteamApiClient::Structs::Base
+        # 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.
+        # Here's a list taken from the steam website:
+        # cc (Optional)
+        #   Country code for method to return appropriate currency values.
+        # l (Optional)
+        #   For localized strings; takes English name of language (none of those fancy ISO distractions).
+        # v (Optional)
+        #   Unknown.
+        # Given that information, I'm going to default the currency to 'USD' and locale to 'en'.
+        #
+        # @see https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI#Global_parameters
+        # @return [Hash]
+        def query_params
+          {
+            cc: "US",
+            l: "en"
+          }
+        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
+          :storefront_endpoint
+        end
+      end
+    end
+  end
+end

data/lib/steam_api_client/structs/types.rb

@@ -0,0 +1,14 @@
+module SteamApiClient
+  module Structs
+    # Wrapper module to help use the dry types and easily extend them
+    # when necessary
+    module Types
+      include ::Dry.Types(default: :nominal)
+
+      module Optional
+        String = ::Dry.Types::String.optional.default(nil)
+        Integer = ::Dry.Types::Integer.optional.default(nil)
+      end
+    end
+  end
+end

data/lib/steam_api_client/version.rb

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