steamwebapi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18246c0e9973ef30a728216a753ad8ae71344ab1
+  data.tar.gz: 584b05177f2ba66a996620a4f018a6af6705e387
+SHA512:
+  metadata.gz: e5428af36f211c7c3ab89ffec092f5113f868456ec543599e2154d1ce647311544f5cbae78f7015274898b503386e72ecee84e325e4079a19ec70c59f3652974
+  data.tar.gz: c0b362774bba21b102496664538370ab68c358d2cec0d15a326c0c775c9c344320d19968ab5a2d88ead4bcd299ee114b78808507b75d399d0ceda40ab8c86b65

data/.gitignore

@@ -0,0 +1,38 @@
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+## RubyMine thing
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in steamwebapi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 kuzmaa
+
+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,39 @@
+Steamwebapi
+===
+
+Steam Web API library in Ruby. Retrieves and parses JSON data. If you want more information about the API go to:
+
+* http://steamcommunity.com/dev
+* https://developer.valvesoftware.com/wiki/Steam_Web_API
+
+
+## TODO
+
+* add a SteamID64 converter thingamajig so you don't have to use a user's SteamID64 only.
+
+## Installation
+
+Open up your terminal or cmd or whatever and copypasta this code
+
+    $ gem install steamwebapi
+
+To use it in your application, add the following to your Gemfile:
+
+    gem 'steamwebapi'
+
+## Usage
+
+Retrieve a user's friend list:
+
+    # retrieve friend list of user with SteamID64 being 76561197960435530
+    SteamUser.key('XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX').friend_list('76561197960435530') # some functions require an api key(IPlayerService, ISteamUser, and some ISteamUserStats)
+
+Retrieve news for a Steam app:
+
+    # retrieve news for Steam app
+    SteamApp.get_news('440', '1', '1') # this will retrieve 1 article of app 440 with the content's length being 1("A...")
+
+You can also use the SteamAPI module's `get` function
+
+    # return news for a Steam app - this does the same thing as the example above, its just messier(IMO)
+    SteamAPI.get('ISteamNews', 'GetNewsForApp', 'v0002', args = {appid: '440', count: '1', maxlength: '1'})

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/steamwebapi.rb

@@ -0,0 +1,3 @@
+require 'steamwebapi/steamapi'
+require 'steamwebapi/user'
+require 'steamwebapi/app'

data/lib/steamwebapi/app.rb

@@ -0,0 +1,9 @@
+require_relative 'steamapi'
+
+module SteamApp
+  # ISteamNews
+  def self.get_news(appid, count='1', maxlength=nil)
+    args = {appid: appid, count: count, maxlength: maxlength}
+    SteamAPI.get('ISteamNews', 'GetNewsForApp', 'v0002', args)
+  end
+end

data/lib/steamwebapi/steamapi.rb

@@ -0,0 +1,28 @@
+require 'net/http'
+require 'json'
+
+module SteamAPI
+  def self.get(interface, method, version, args = {})
+    json = true
+    if args.empty?
+      raise 'cannot retrieve data without arguments'
+    else
+      i = ''
+      args.each do |key, value|
+        # the first key needs ? in front of it
+        if key == args.keys[0]
+          i += "?#{key}=#{value}"
+        else
+          i += "&#{key}=#{value}"
+        end
+      end
+      domain = "http://api.steampowered.com/#{interface}/#{method}/#{version}/#{i}"
+    end
+    uri = Net::HTTP.get(URI(domain))
+    if json
+      JSON.parse(uri)
+    else
+      raise 'data not in JSON format'
+    end
+  end
+end

data/lib/steamwebapi/user.rb

@@ -0,0 +1,79 @@
+require_relative 'steamapi'
+
+module SteamUser
+  def self.key(key)
+    @key = key
+    self
+  end
+
+  ## ISteamUser
+  def self.summaries(steamids=[])
+    args = {key: @key}
+    unless steamids.empty?
+      ids = ''
+      steamids.each do |id|
+        ids += "#{id},"
+      end
+      args[:steamids] = ids
+    end
+    SteamAPI.get('ISteamUser', 'GetPlayerSummaries', 'v0002', args)
+  end
+
+  def self.friend_list(steamid, relationship='friend')
+    args = {key: @key, steamid: steamid, relationship: relationship}
+    SteamAPI.get('ISteamUser', 'GetFriendList', 'v0001', args)
+  end
+
+  ## ISteamUserStats
+  def self.global_achievements_percent(gameid)
+    args = {gameid: gameid}
+    SteamAPI.get('ISteamUserStats', 'GetGlobalAchievementPercentagesForApp', 'v0002', args)
+  end
+
+  def self.global_stats(appid, count='1', name=[])
+    args = {appid: appid, count: count}
+    name.each do |v|
+      args.merge!("name[#{name.index(v)}]" => v)
+    end
+    SteamAPI.get('ISteamUserStats', 'GetGlobalStatsForGame', 'v0001', args)
+  end
+
+  def self.player_achievements(steamid, appid, language='english')
+    args = {key: @key, steamid: steamid, appid: appid, l: language}
+    SteamAPI.get('ISteamUserStats', 'GetPlayerAchievements', 'v0001', args)
+  end
+
+  def self.user_stats_for_game(steamid, appid, language='english')
+    args = {key: @key, steamid: steamid, appid: appid, l: language}
+    SteamAPI.get('ISteamUserStats', 'GetUserStatsForGame', 'v0002', args)
+  end
+
+  ## IPlayerService
+  def self.owned_games(steamid, appinfo=false, freegames=false)
+    args = {key: @key, steamid: steamid}
+
+    if appinfo
+      args[:include_appinfo] = '1'
+    else
+      args[:include_appinfo] = '0'
+    end
+
+    if freegames
+      args[:include_played_free_games] = '1'
+    else
+      args[:include_played_free_games] = '0'
+    end
+
+    SteamAPI.get('IPlayerService', 'GetOwnedGames', 'v0001', args)
+  end
+
+  def self.recently_played(steamid, count='1')
+    args = {key: @key, steamid: steamid, count: count}
+    SteamAPI.get('IPlayerService', 'GetRecentlyPlayedGames', 'v0001', args)
+  end
+
+  def self.is_playing_shared(steamid, appid)
+    args = {key: @key, steamid: steamid, appid_playing: appid}
+    SteamAPI.get('IPlayerService', 'IsPlayingSharedGame', 'v0001', args)
+  end
+end

data/steamwebapi.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "steamwebapi"
+  spec.version       = "1.0.0"
+  spec.authors       = ["kuzmaa"]
+  spec.email         = [""]
+  spec.summary       = %q{Steam Web API library in Ruby}
+  spec.description   = %q{Retrieves and parses JSON data, which it retrieves from http://api.steampowered.com}
+  spec.homepage      = "https://github.com/kuzmaa/steamwebapi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: steamwebapi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- kuzmaa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Retrieves and parses JSON data, which it retrieves from http://api.steampowered.com
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/steamwebapi.rb
+- lib/steamwebapi/app.rb
+- lib/steamwebapi/steamapi.rb
+- lib/steamwebapi/user.rb
+- steamwebapi.gemspec
+homepage: https://github.com/kuzmaa/steamwebapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Steam Web API library in Ruby
+test_files: []