steam-api 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: e0baaf180a77930f5d4f6c330611a73ce8fe980e
-  data.tar.gz: 2de31d7ddbcbf8cc5656648515b015b14bb2753e
+  metadata.gz: a420d8645cd116e9df469e837dfd32cab3385a09
+  data.tar.gz: 40a66089d1cd4f233877a7eac8dd1dfa0874cbeb
 SHA512:
-  metadata.gz: dcffe8cc1ee1b03737d4b3fa59f8a224004a2d5cde6cb65cc181eaf86f338618b21ffba2e3ac1e92237dc1e84c44a8939dd9144d7f682a9cf819a4cd212ea3dc
-  data.tar.gz: 1b25675f516359a5df9f346a12c486ec4106a3114911a7e175822114c84fda0683643121013f06f86788eab67c56b05412ac8c65986000dfdd4972fac030b81e
+  metadata.gz: 32d8f5be1ffe6d3918d4b3042d18992db77d2a978a59dee0be538418ece9ec533f41a3ac746778e03682eea2f9709011d424ed8c5752acfca1bc678cbac24c5e
+  data.tar.gz: b5459282ca4b3e5828101123e6671071d146c6894efb9d99099495391cc38bce6956d31ad1c7c33926c9c0debb391d1a4718693cfe9c0571a49ac8ad981bf26c

data/README.md

@@ -8,7 +8,7 @@
 
 `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/lib/steam-api/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 # Versioning Info
 module Steam
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/steam-api.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake', '~> 10'
   gem.add_development_dependency 'rspec', '~> 3'
   gem.add_development_dependency 'coveralls', '~> 0.7'
-  gem.add_dependency 'faraday', '0.9.0'
+  gem.add_dependency 'faraday', '~> 0.9'
   gem.add_dependency 'multi_json', '~> 1.7', '>= 1.7.7'
   gem.add_dependency 'json', '~> 1.7', '>= 1.7.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steam-api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Brian Haberer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -56,16 +56,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Simple Gem to interact witht the Steam Web API