steam-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d350bed9837ca990cd5f05a491423b01c0bac68
+  data.tar.gz: f24dcce0a76752b2eeb62fe5f3428226a4756e50
+SHA512:
+  metadata.gz: f3e780148ded110562c84ca841f9b3ebd3cbdd0faf9412290c3916ffef1e819080416290bd2de87cd71b9d960920450fa41281aa1f01ec1413cbddbf9039e257
+  data.tar.gz: fbf62a14354948567b72b39cbcbf2a822a79775f3de79cec7fccfc79f3dd8a73c9838b128195f391a2b740ebb5fe66b4dc7e754ba6a36eaca467a685d4a306b2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/secret.rb
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.0.0
+env:
+  global:
+    secure: P5IpEGYYbF0HcP9Mj9/zZAUXpUjkA2YkGLClvbVGsOD5zI9Jj1RZAlCC/fBKtfPUlfjlADp1hIN++n7qnqqmXPw4X/BC2V8Ios91NoFQeKfjQENSmjYykFTCp1CkBmCjq+lb/yE/JPQnVOoI/eEm5uaNSRc/XLjHwuSdKEFPv8M=

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+ruby '2.0.0'
+
+# Specify your gem's dependencies in simple-steam.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Haberer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# SteamAPI
+
+[![Gem Version](https://badge.fury.io/rb/steam-api.png)](http://badge.fury.io/rb/steam-api)
+[![Dependency Status](https://gemnasium.com/bhaberer/steam-api.png)](https://gemnasium.com/bhaberer/steam-api)
+[![Build Status](https://travis-ci.org/bhaberer/steam-api.png?branch=master)](https://travis-ci.org/bhaberer/steam-api)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/steam-api/badge.png?branch=master)](https://coveralls.io/r/bhaberer/steam-api?branch=master)
+[![Code Climate](https://codeclimate.com/github/bhaberer/steam-api.png)](https://codeclimate.com/github/bhaberer/steam-api)
+
+`steam-api` is a simple gem to expose the Steam WebApi directly.
+
+The Gem is not quite finished, but once it is, I will tag v1, still have a lot of work to do (especially on the docs).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'steam-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install steam-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/steam-api.rb

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require 'weary'
+require 'faraday'
+require 'json'
+
+require 'steam-api/version'
+require 'steam-api/steam'
+require 'steam-api/client'
+require 'steam-api/exceptions'
+require 'steam-api/response'
+require 'steam-api/helpers'
+require 'steam-api/steam/apps'
+require 'steam-api/steam/economy'
+require 'steam-api/steam/news'
+require 'steam-api/steam/player'
+require 'steam-api/steam/remote_storage'
+require 'steam-api/steam/user'
+require 'steam-api/steam/user_stats'
+
+include Steam::Helpers

data/lib/steam-api/client.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+module Steam
+  # Client object used to communicate with the steam webapi
+  class Client
+    def initialize(url)
+      @conn = Faraday.new(url: url)
+    end
+
+    # overriding the get method of Faraday to make things simpler.
+    # @param [String] resource the resource you're targeting
+    # @param [Hash] params Hash of parameters to pass to the resource
+    # @param [String] key Steam API key
+    def get(resource, params: {}, key: Steam.apikey)
+      params[:key] = key
+      response = @conn.get resource, params
+      JSON.parse(response.body)
+    rescue JSON::ParserError
+      { error: '500 Internal Server Error' }
+    end
+  end
+end

data/lib/steam-api/exceptions.rb

@@ -0,0 +1,15 @@
+module Steam
+  # Error returning the requested object from the Steam API
+  class SteamError < StandardError
+    def initialize(error = 'The API request has failed')
+      super(error)
+    end
+  end
+
+  # Error returning the requested object from the Steam API
+  class JSONError < StandardError
+    def initialize(error = 'The API returned an unexpected JSON response')
+      super(error)
+    end
+  end
+end

data/lib/steam-api/helpers.rb

@@ -0,0 +1,12 @@
+module Steam
+  module Helpers
+    # Conveniance method to build clients
+    # @param [String] api The endpoint of the API
+    # @param [String] base_url the root uri for steam's API
+    # @return [Steam::Client] The Client
+    def build_client(api, base_url: 'http://api.steampowered.com')
+      Steam::Client.new([base_url, api].join('/'))
+    end
+  end
+end
+

data/lib/steam-api/response.rb

@@ -0,0 +1,31 @@
+module Steam
+  # Since the steam responses are so randomly inconsistant we're making a new
+  #   class to manage the responses.
+  # FIXME move all hash extensions here once the gem is finished and make
+  class Response < Hash
+  #   def parse_key(key)
+  #     fail Steam::JSONError unless self.key?(key)
+  #     self[key]
+  #   end
+  end
+end
+
+class Hash
+  # Simple method to access a nested field, since Valve seems to like
+  #   nesting their json a few levels on every request.
+  # @param [String] key The key to extract from the hash
+  def parse_key(key)
+    fail Steam::JSONError unless self.key?(key)
+    self[key]
+  end
+
+  # Many responses from the apis (but not all) include a success
+  #   field, so this allows us to check it wiht minimal fuss.
+  # @param [String] success_condition what the success condition should be
+  # @return [Boolean] Returns true or raises an exception.
+  def check_success(success_condition: true)
+    success = self.parse_key('success')
+    fail Steam::SteamError unless success == success_condition
+    true
+  end
+end

data/lib/steam-api/ruby/hash.rb

@@ -0,0 +1,11 @@
+# Takes a hash and converts it into a URL encoded parameter string.
+#   NOTE: this does not do any uri escaping at this point, since all args should be numeric.
+# @param [Hash] params Hash of params you want broken up into a query string,
+#   escaped, and returned to you.
+# @return [String] Escaped parameter string to append to a url.
+class Hash
+  def to_params(params = {})
+    params[:format] = :json
+    return "?#{params.each.map{ |x| x.join('=') }.join('&')}"
+  end
+end

data/lib/steam-api/steam.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+# Base class def
+module Steam
+  @apikey = ENV['STEAM_API_KEY']
+
+  def self.apikey
+    fail ArgumentError, 'Please set your Steam API key.' if @apikey.nil?
+    @apikey
+  end
+
+  def self.apikey=(key)
+    @apikey = key
+  end
+end

data/lib/steam-api/steam/apps.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+module Steam
+  # A Ruby DSL for communicating with the Apps portion of the Steam Web API.
+  # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
+  # @since 1.0.0
+  module Apps
+    # Get Steam Applications
+    # @return [Hash] A list of objects containing the title and app ID of each program
+    #   available in the store.
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetAppList
+    def self.get_all
+      response = client.get('GetApplist/v2')
+        .parse_key('applist')
+        .parse_key('apps')
+      response
+    end
+
+    # Get Servers at Address
+    # @param [String] addr IP or IP:queryport to list
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetServersAtAddress
+    def self.get_servers(addr: nil)
+      response = client.get 'GetServersAtAddress/v1',
+                            params: { addr: URI.escape(addr) }
+      response = response.parse_key('response')
+      response.check_success
+      response.parse_key('servers')
+    end
+
+    # Check if a given version of an App is current
+    # @param [Fixnum] appid AppID of game
+    # @param [Fixnum] version The installed version of the game
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/UpToDateCheck
+    def self.up_to_date(appid: nil, version: nil)
+      response = client.get 'UpToDateCheck/v1',
+                            params: { appid: appid, version: version }
+      response = response.parse_key('response')
+      response.check_success
+      response.delete('success')
+      response
+    end
+
+    private
+
+    def self.client
+      build_client 'ISteamApps'
+    end
+  end
+end

data/lib/steam-api/steam/economy.rb

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+module Steam
+  # A Ruby DSL for communicating with the Steam Web API.
+  # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
+  # @since 1.0.0
+  module Economy
+    # Get Asset Class Info
+    # @param [String] appid The application ID for the Steam Game.
+    # @param [Hash] params Parameters to pass to the API
+    # @option params [Fixnum] :class_count The number of classids passed to the request.
+    # @option params [Fixnum] :classidN Where N can be a series of sequential numbers to form a list of class IDs. [1] [2]
+    # @option params [Fixnum] :instanceidN Instance ID of the nth class. (Optional)
+    # @option params [String] :language The ISO639-1 language code for the language all localized
+    #   strings should be returned in. Not all strings have been translated to every language.
+    #   If a language does not have a string, the English string will be returned instead. If this
+    #   parameter is omitted the string token will be returned for the strings. (Optional)
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/UpToDateCheck
+    def self.asset_info(appid, params: {})
+      params[:appid] = appid
+      response = client.get 'GetAssetClassInfo/v1',
+                 params: params
+      parse_response(response)
+    end
+
+    # Get Asset Prices
+    # @param [String] appid The application ID for the Steam Game.
+    # @param [String] language The ISO639-1 language code for the language all localized
+    #   strings should be returned in. Not all strings have been translated to every language.
+    #   If a language does not have a string, the English string will be returned instead. If this
+    #   parameter is omitted the string token will be returned for the strings. (Optional)
+    # @param [String] currency The ISO 4217 code for currency specific filtering. (Optional)
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetAssetPrices
+    def self.asset_prices(appid, language: nil, currency: nil)
+      params = { appid: appid }
+      params[:language] = language unless language.nil?
+      params[:currency] = currency unless currency.nil?
+      response = client.get 'GetAssetPrices/v1',
+                 params: params
+      parse_response(response)
+    end
+
+    private
+
+    def self.client
+      build_client 'ISteamEconomy'
+    end
+
+    def self.parse_response(response)
+      response = response.parse_key('result')
+      response.check_success
+      response.delete('success')
+      response
+    end
+  end
+end

data/lib/steam-api/steam/news.rb

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+module Steam
+  # A Ruby DSL for communicating with the Steam Web API.
+  # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
+  # @since 1.0.0
+  module News
+    # Get News for App
+    # @param [Hash] params Parameters to pass to the API
+    # @option params [String] :appid The application ID for the Steam Game.
+    # @option params [String] :key Steam Api Key
+    # @option params [Fixnum] :count How many news enties you want to get returned. (Optional)
+    # @option params [Fixnum] :maxlength Maximum length of each news entry. (Optional)
+    # @option params [Fixnum] :enddate Unix timestamp, returns posts before this date. (Optional)
+    # @option params [String] :feeds Commma-seperated list of feed names to return news for. (Optional)
+    # @return [Hash] A hash object of the latest news items for a game specified by its appID.
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetNewsForApp
+    def self.get(appid, params: {})
+      params[:appid] = appid
+      client.get('GetNewsForApp/v2', params: params)
+        .parse_key('appnews')
+        .parse_key('newsitems')
+    end
+
+    private
+
+    def self.client
+      build_client 'ISteamNews'
+    end
+  end
+end

data/lib/steam-api/steam/player.rb

@@ -0,0 +1,73 @@
+# -*- encoding: utf-8 -*-
+module Steam
+  # A Ruby DSL for communicating with the Steam Web API.
+  # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
+  # @since 1.0.0
+  module Player
+    # Get Owned Games
+    # @param [Hash] params Parameters to pass to the API
+    # @option params [Fixnum] :steamid The 64 bit ID of the player. (Optional)
+    # @option params [Boolean] :include_appinfo (false) Whether or not to include additional
+    #   details of apps - name and images.
+    # @option params [Boolean] :include_played_free_games (false) Whether or not to list
+    #   free-to-play games in the results.
+    # @option params [Array] :appids_filter You can optionally filter the list to a set of appids.
+    #   Note that these cannot be passed as a URL parameter, instead you must use the JSON format
+    #   described in Steam_Web_API#Calling_Service_interfaces. The expected input is an array of
+    #   integers (in JSON: "appids_filter: [ 440, 500, 550 ]" )
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetOwnedGames
+    def self.owned_games(steamid, params: {})
+      params[:steamid] = steamid
+      response = client.get 'GetOwnedGames/v1', params: params
+      response.parse_key('response')
+    end
+
+    # Get Recently Played Games
+    # @param [Hash] params Parameters to pass to the API
+    # @option params [String] :steamid The SteamID of the account.
+    # @option params [String] :count Optionally limit to a certain number of games (the number of
+    #   games a person has played in the last 2 weeks is typically very small)
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetRecentlyPlayedGames
+    def self.recently_played_games(steamid, params: {})
+      params[:steamid] = steamid
+      response = client.get 'GetRecentlyPlayedGames/v1',
+                            params: params
+      response.parse_key('response')
+    end
+
+    # Get a player's Steam Level
+    # @param [Fixnum] steamid The SteamID of the account.
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetSteamLevel
+    def self.steam_level(steamid)
+      response = client.get 'GetSteamLevel/v1',
+                            params: { steamid: steamid }
+      response.parse_key('response')
+              .parse_key('player_level')
+    end
+
+    # Get a player's Steam badges
+    # @param [Fixnum] steamid The SteamID of the account.
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetBadges
+    def self.badges(steamid)
+      response = client.get 'GetBadges/v1',
+                            params: { steamid: steamid }
+      response.parse_key('response')
+    end
+
+    # Get a player's Steam Level
+    # @param [Fixnum] steamid The SteamID of the account.
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetCommunityBadgeProgress
+    def self.community_badge_progress(steamid)
+      response = client.get 'GetCommunityBadgeProgress/v1',
+                            params: { steamid: steamid }
+      response.parse_key('response')
+              .parse_key('quests')
+    end
+
+    private
+
+    def self.client
+      build_client 'IPlayerService'
+    end
+  end
+end