steam-api 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9d350bed9837ca990cd5f05a491423b01c0bac68
-  data.tar.gz: f24dcce0a76752b2eeb62fe5f3428226a4756e50
+SHA256:
+  metadata.gz: 96cb46113ba573dc3989af65e06477ca2692d66a511bbcf2071058282a12d6ee
+  data.tar.gz: ac26ffb8ba9b4644ffd8ada6b0ad16f017394356e23467ff422a956cff6189f9
 SHA512:
-  metadata.gz: f3e780148ded110562c84ca841f9b3ebd3cbdd0faf9412290c3916ffef1e819080416290bd2de87cd71b9d960920450fa41281aa1f01ec1413cbddbf9039e257
-  data.tar.gz: fbf62a14354948567b72b39cbcbf2a822a79775f3de79cec7fccfc79f3dd8a73c9838b128195f391a2b740ebb5fe66b4dc7e754ba6a36eaca467a685d4a306b2
+  metadata.gz: 7b7bb32f8b52c0b24c6328f7162f132d6b101e72062c47e2b7bdabb981578306dbbb52fb879076361198ca48a15b29f54ed64eac506a0582eeada4de71ff8d09
+  data.tar.gz: 936ad9ba4bae360237d2f3f3ec1847ad56b38fac1684f8f01d6cd09483b1b9d1d24e99456ea82a9201f5fa2b353034c5dd832436b8601354974d4ff5b6dd478c

data/.rspec

@@ -0,0 +1 @@
+-f d -c --warning

data/.travis.yml

@@ -1,6 +1,28 @@
+addons:
+  code_climate:
+    repo_token: 5eb1ad424f83b5332cdb915736dc46e23cb24f7b335a063243f928be79d7a75b
 language: ruby
-rvm:
-- 2.0.0
+before_install:
+  - gem update --system
+  - gem update bundler
 env:
   global:
     secure: P5IpEGYYbF0HcP9Mj9/zZAUXpUjkA2YkGLClvbVGsOD5zI9Jj1RZAlCC/fBKtfPUlfjlADp1hIN++n7qnqqmXPw4X/BC2V8Ios91NoFQeKfjQENSmjYykFTCp1CkBmCjq+lb/yE/JPQnVOoI/eEm5uaNSRc/XLjHwuSdKEFPv8M=
+after_success:
+  bundle exec codeclimate-test-reporter
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+  - ree
+matrix:
+  allow_failures:
+    - rvm: ree
+    - rvm: jruby-19mode
+    - rvm: jruby-head
+    - rvm: ruby-head
+  fast_finish: true

data/Gemfile

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

data/README.md

@@ -3,12 +3,12 @@
 [![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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e3100c4ed420e839a6cc/maintainability)](https://codeclimate.com/github/bhaberer/steam-api/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/e3100c4ed420e839a6cc/test_coverage)](https://codeclimate.com/github/bhaberer/steam-api/test_coverage)
 
 `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).
+The Gem is not quite finished, but once it is, I will note that here, I still have a lot of work to do (especially on the docs).
 
 ## Installation
 
@@ -26,7 +26,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First you will need to set your Steam API Key you can get this at http://steamcommunity.com/dev/apikey
+
+Once you get it, go ahead and set it. (You can also pass it as the `STEAM_API_KEY` env variable)
+
+```2.1.1 :001 > Steam.apikey = 'YOURAPIKEY'```
+
+Once you've done that you can use any of the API functions in the various modules, for a list of all available commands please  see the docs here: http://rubydoc.info/gems/steam-api/ Of note, all the commands use the numerical Steam ID, if you need to convert from the vanity name you can use the following method:
+
+```
+2.1.1 :012 > Steam::User.vanity_to_steamid("asmeroth")
+
+ => "76561197993276293"
+```
+
+### Examples
+
+Get the Steam level for a user:
+
+```
+2.1.1 :014 > Steam::Player.steam_level(76561197993276293)
+
+ => 34
+```
+
+Get the Borderlands Achievements for a given player:
+
+```
+2.1.1 :005 >   Steam::UserStats.player_achievements(8980, 76561197969622382)
+
+ => {"steamID"=>"76561197969622382", "gameName"=>"Borderlands", "achievements"=>[{"apiname"=>"Achievement_1", "achieved"=>0}, {"apiname"=>"Achievement_2", "achieved"=>0}, {"apiname"=>"Achievement_3", "achieved"=>0}, {"apiname"=>"Achievement_4", "achieved"=>0}, {"apiname"=>"Achievement_5", "achieved"=>0}, {"apiname"=>"Achievement_6", "achieved"=>0}, {"apiname"=>"Achievement_7", "achieved"=>0}, {"apiname"=>"Achievement_8", "achieved"=>0}, {"apiname"=>"Achievement_9", "achieved"=>0}, {"apiname"=>"Achievement_10", ... ]}
+```
+ 
 
 ## Contributing
 

data/Rakefile

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

data/lib/steam-api.rb

@@ -1,20 +1,19 @@
-# -*- 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'
+require_relative 'steam-api/version'
+require_relative 'steam-api/steam'
+require_relative 'steam-api/client'
+require_relative 'steam-api/exceptions'
+require_relative 'steam-api/response'
+require_relative 'steam-api/helpers'
+require_relative 'steam-api/steam/apps'
+require_relative 'steam-api/steam/economy'
+require_relative 'steam-api/steam/news'
+require_relative 'steam-api/steam/player'
+require_relative 'steam-api/steam/remote_storage'
+require_relative 'steam-api/steam/store'
+require_relative 'steam-api/steam/user'
+require_relative 'steam-api/steam/user_stats'
 
 include Steam::Helpers

data/lib/steam-api/client.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Steam
   # Client object used to communicate with the steam webapi
   class Client
@@ -14,7 +13,14 @@ module Steam
       params[:key] = key
       response = @conn.get resource, params
       JSON.parse(response.body)
+      # response
     rescue JSON::ParserError
+      puts response.body
+      # If the steam web api returns an error it's virtually never in json, so
+      #   lets pretend that we're getting some sort of consistant response
+      #   for errors.
+      raise Steam::UnavailableError if response.status == '503'
+
       { error: '500 Internal Server Error' }
     end
   end

data/lib/steam-api/exceptions.rb

@@ -6,6 +6,14 @@ module Steam
     end
   end
 
+  # Error returning the requested object from the Steam API
+  class UnavailableError < StandardError
+    def initialize(error = 'The server is temporarily unable to service \
+                            your request. Please try again later.')
+      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')

data/lib/steam-api/helpers.rb

@@ -1,12 +1,15 @@
 module Steam
+  # Helper Module
   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')
+    def build_client(api, base_url: 'https://api.steampowered.com')
       Steam::Client.new([base_url, api].join('/'))
     end
+
+
+    STORE_API_BASE_URL = 'https://store.steampowered.com/api'
   end
 end
-

data/lib/steam-api/response.rb

@@ -1,12 +1,12 @@
 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
+  # 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
+    # def parse_key(key)
+    #   fail Steam::JSONError unless self.key?(key)
+    #   self[key]
+    # end
   end
 end
 
@@ -15,7 +15,8 @@ class Hash
   #   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)
+    raise Steam::JSONError unless key?(key)
+
     self[key]
   end
 
@@ -24,8 +25,9 @@ class Hash
   # @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
+    success = parse_key('success')
+    raise Steam::SteamError unless success == success_condition
+
     true
   end
 end

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

@@ -1,11 +1,12 @@
 # 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.
+#   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('&')}"
+    "?#{params.each.map { |x| x.join('=') }.join('&')}"
   end
 end

data/lib/steam-api/steam.rb

@@ -1,10 +1,15 @@
-# -*- 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?
+    if @apikey.nil?
+      unless ENV.key?('STEAM_API_KEY')
+        raise ArgumentError, 'Please set your Steam API key.'
+      end
+
+      @apikey = ENV['STEAM_API_KEY']
+    end
     @apikey
   end
 

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

@@ -1,17 +1,16 @@
-# -*- 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.
+    # @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')
+                       .parse_key('applist')
+                       .parse_key('apps')
       response
     end
 
@@ -19,9 +18,9 @@ module Steam
     # @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) }
+    def self.get_servers(addr: nil, api_version: 'v1')
+      response = client.get "GetServersAtAddress/#{api_version}",
+                            params: { addr: ERB::Util.url_encode(addr) }
       response = response.parse_key('response')
       response.check_success
       response.parse_key('servers')
@@ -32,8 +31,8 @@ module Steam
     # @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',
+    def self.up_to_date(appid: nil, version: 'v1', api_version: 'v1')
+      response = client.get "UpToDateCheck/#{api_version}",
                             params: { appid: appid, version: version }
       response = response.parse_key('response')
       response.check_success
@@ -41,8 +40,6 @@ module Steam
       response
     end
 
-    private
-
     def self.client
       build_client 'ISteamApps'
     end

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

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Steam
   # A Ruby DSL for communicating with the Steam Web API.
   # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
@@ -7,29 +6,35 @@ module Steam
     # 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)
+    # @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.
+    # @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.
     # @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
+      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)
+    # @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)
@@ -37,12 +42,10 @@ module Steam
       params[:language] = language unless language.nil?
       params[:currency] = currency unless currency.nil?
       response = client.get 'GetAssetPrices/v1',
-                 params: params
+                            params: params
       parse_response(response)
     end
 
-    private
-
     def self.client
       build_client 'ISteamEconomy'
     end

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

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Steam
   # A Ruby DSL for communicating with the Steam Web API.
   # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
@@ -8,21 +7,24 @@ module Steam
     # @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.
+    # @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')
+            .parse_key('appnews')
+            .parse_key('newsitems')
     end
 
-    private
-
     def self.client
       build_client 'ISteamNews'
     end