skyhook 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23fb31890016fd720993dd6ac882d1339490c3b8
+  data.tar.gz: 3bef965d3c308229b4d86b5450d05a809e366d5d
+SHA512:
+  metadata.gz: c1f685e986c9c0ec316b2bc4da8876ebf5c9d0db77c9361af1114880f683773a52ed463c814a721287b84058083f904650a5166c58ad70b81904e8b91232dbbd
+  data.tar.gz: 5d0619a0fe2e079b179357aa4d233087280dc194d844cae051cd9deffd1b0e9f518b2f0913f137ba9855ac94ae98820b0e0d8dedd75f54df56d0c238935873fb

data/.env.example

@@ -0,0 +1 @@
+API_KEY='Fill me in'

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+ruby '2.2.0'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Wouter van der Meulen
+
+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,32 @@
+The Steampowered Skyhook
+========================
+
+A wrapper for the Steam web API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'skyhook'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install skyhook
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/ClikeX/skyhook/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require './lib/skyhook'
+require 'dotenv'
+
+Dotenv.load
+Skyhook::Configuration.configure api_key: ENV['API_KEY']
+
+Dir.glob('tasks/*.rake').each { |r| import r }

data/lib/skyhook/configuration.rb

@@ -0,0 +1,20 @@
+module Skyhook
+  class Configuration
+    cattr_accessor :format
+    cattr_accessor :api_key
+    cattr_accessor :debug
+
+    FORMATS = %W(json xml vdf).map { |x| x.to_sym.freeze }
+    BASE = 'api.steampowered.com'
+
+    def self.configure( options = {} )
+      if options[ :format ]
+        FORMATS.include?( options[ :format ] ) ? self.format = options[ :format ] : raise(ArgumentError,  "#{ options[ :format ] } is not a valid format" )
+      else
+        @@format = :json
+      end
+      @@api_key = options[:api_key] if options[:api_key]
+      @@debug = options[:debug] if options[:debug]
+    end
+  end
+end

data/lib/skyhook/core.rb

@@ -0,0 +1,80 @@
+module Skyhook
+  class Core < Skyhook::Configuration
+
+    # These are default urls to use with #Service_request
+    RESTAPI = {
+      owned_games: "",
+      shared_games: ""
+    }.freeze
+
+    def api_reference
+      url = "/ISteamWebAPIUtil/GetSupportedAPIList/v0001/"
+
+      unless @api_key.blank?
+        url << "?key=#{ self.api_key }"
+      end
+
+      request url
+    end
+
+    def resolve_vanity( vanityurl )
+      return vanityurl if vanityurl.is_a? Integer
+      response = request "/ISteamUser/ResolveVanityURL/v0001/?key=#{ self.api_key }&vanityurl=#{ vanityurl }"
+      response["response"]["steamid"].to_i
+    end
+
+    def user_summaries( steamids = [] )
+      steamids = [ steamids ] unless steamids.is_a? Array
+
+      if steamids.empty?
+        p 'No steamids were defined'
+        return false
+      end
+
+      steamids.map! do |steamid|
+        steamid = resolve_vanity steamid
+      end
+
+      request "/ISteamUser/GetPlayerSummaries/v0002/?key=#{ self.api_key }&steamids=#{ steamids }"
+    end
+
+    def player_stats( appid, steamid )
+      steamid = resolve_vanity steamid
+
+      request "/ISteamUserStats/GetUserStatsForGame/v2/?key=#{self.api_key }&steamid=#{ steamid }&appid=#{ appid }"
+    end
+
+    # TODO (ClikeX) Test this with multiple names.
+    def global_stats( appid, count = 1, names = [], options = {} )
+      request "/ISteamUserStats/GetGlobalStatsForGame/v0001/?appidid=#{ appid }&count=#{}&name[0]=global.map.emp_isle"
+    end
+
+    def owned_games( steamid, options = {} )
+      steamid = resolve_vanity steamid
+      appinfo = options[:appinfo] == nil ? false : options[:appinfo]
+      free_games = options[:free_games] == nil ? false : options[:free_games]
+
+      request "/IPlayerService/GetOwnedGames/v1/?key=#{ self.api_key }&steamid=#{ steamid }&include_appinfo='#{ appinfo }'&include_played_free_games='#{ free_games }'"
+    end
+
+    def friend_list( steamid, relationship )
+      steamid = resolve_vanity steamid
+      raise( ArgumentError,  'Not a valid relationship' ) unless %w{ all friend }.include? relationship
+
+      request "/ISteamUser/GetFriendList/v1/?key=#{ self.api_key }&steamid=#{ steamid }&relationship=#{ relationship }"
+    end
+
+    protected
+
+    def request( uri )
+      puts "#{BASE}#{uri}" if self.debug
+      response = Net::HTTP.get_response BASE, uri
+      JSON.parse response.body
+    end
+
+    def service_request( uri, options = {} )
+      raise( ArgumentError,  'No JSON options were supplied' ) if options.empty?
+      request "#{ uri }?key=#{ self.api_key }}&format=#{ self.format }&input_json=#{ options[:json]} "
+    end
+  end
+end

data/lib/skyhook/game.rb

@@ -0,0 +1,34 @@
+module Skyhook
+  class Game < Skyhook::Core
+
+    attr_reader :appid, :user, :game_name, :achievements, :stats
+
+    def initialize( appid, steamid = nil )
+      @appid = appid
+      if steamid == nil
+        # If steamid is not set a game should contain global data
+        set_global_attributes
+      else
+        if steamid.is_a? Skyhook::User
+          @user = steamid
+        else
+          @user = Skyhook::User.new steamid
+        end
+
+        set_user_attributes player_stats( appid, user.steamid )['playerstats']
+      end
+    end
+
+    def set_user_attributes( response )
+      @game_name = response['gameName']
+      @achievements = ( Hash[ response['achievements'].each_slice(2).to_a ] ).deep_symbolize_keys if response['achievements']
+      @stats = ( Hash[ response['stats'].each_slice(2).to_a ] ).deep_symbolize_keys if response['stats']
+    end
+
+    def set_global_attributes
+      #Will return a games global stats
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/skyhook/user.rb

@@ -0,0 +1,46 @@
+module Skyhook
+  class User < Skyhook::Core
+
+    attr_reader :steamid, :personaname, :realname, :profileurl
+    attr_reader :avatar, :avatarmedium, :avatarfull
+    attr_reader :communityvisibilitystate, :profilestate, :lastlogoff, :commentpermission
+    attr_reader :primaryclanid, :timecreated, :personastateflags, :personastate
+    attr_reader :loccityid, :locstatecode, :loccountrycode
+
+    def initialize( steamid )
+      set_attributes user_summaries( steamid )["response"]["players"][0]
+    end
+
+    def game( appid )
+      Skyhook::Game.new appid, self
+    end
+
+    def friends( relationship = 'friend' )
+      @friends ||= friend_list @steamid, relationship
+    end
+
+    private
+
+    def set_attributes( response )
+      @steamid = response["steamid"].to_i
+      @personaname = response["personaname"]
+      @communityvisibilitystate = response["communityvisibilitystate"]
+      @profilestate = response["profilestate"]
+      @lastlogoff = response["lastlogoff"]
+      @commentpermission = response["commentpermission"]
+      @profileurl = response["profileurl"]
+      @avatar = response["avatar"]
+      @avatarmedium = response["avatarmedium"]
+      @avatarfull = response["avatarfull"]
+      @personastate = response["personastate"]
+      @realname = response["realname"]
+      @primaryclanid = response["primaryclanid"]
+      @timecreated = response["timecreated"]
+      @personastateflags = response["personastateflags"]
+      @loccountrycode = response["loccountrycode"]
+      @locstatecode = response["locstatecode"]
+      @loccityid = response["loccityid"]
+    end
+
+  end
+end

data/lib/skyhook/version.rb

@@ -0,0 +1,3 @@
+module Skyhook
+  VERSION = '0.5.0'
+end

data/lib/skyhook.rb

@@ -0,0 +1,13 @@
+require 'active_support/all'
+require 'net/http'
+
+require 'skyhook/configuration'
+require 'skyhook/core'
+require 'skyhook/game'
+require 'skyhook/user'
+
+module Skyhook
+  def self.configure( options = {} )
+    self::Configuration.configure options
+  end
+end

data/skyhook.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'skyhook/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'skyhook'
+  s.version     = Skyhook::VERSION
+  s.date        = '2014-04-28'
+  s.summary     = 'Steam API wrapper/library'
+  s.description = 'A wrapper/library for the Steam web API'
+
+  s.authors     = ['ClikeX']
+  s.email       = 'w.s.van.der.meulen@gmail.com'
+
+  s.homepage    = 'http://rubygems.org/gems/skyhook'
+  s.license       = 'MIT'
+
+
+  s.post_install_message = 'Thank you for installing the Steampowered Skyhook for Ruby. Have fun!'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.7"
+  s.add_development_dependency 'dotenv', '~> 1.0', '>= 1.0.0'
+  s.add_development_dependency 'rspec', '~> 2.0', '>= 2.0.0'
+  s.add_development_dependency 'rake', '~> 10.0' ,'>= 10.0.0'
+
+  s.add_runtime_dependency 'activesupport', '~> 4.0 '
+
+end

data/tasks/test.rake

@@ -0,0 +1,23 @@
+namespace :test do
+
+  # These are to test data return. They do not replace rspec.
+
+  task :key do
+    puts key
+  end
+
+  task :user do
+    puts "\nuser"
+    user = Skyhook::User.new 'ClikeX'
+    puts user.steamid, user.personaname
+  end
+
+  task :game do
+    puts "\ngame"
+    game = Skyhook::Game.new(218620, 'ClikeX')
+    puts game.game_name
+  end
+
+  task :all => ["test:user", "test:game"]
+
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: skyhook
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- ClikeX
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: A wrapper/library for the Steam web API
+email: w.s.van.der.meulen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/skyhook.rb
+- lib/skyhook/configuration.rb
+- lib/skyhook/core.rb
+- lib/skyhook/game.rb
+- lib/skyhook/user.rb
+- lib/skyhook/version.rb
+- skyhook.gemspec
+- tasks/test.rake
+homepage: http://rubygems.org/gems/skyhook
+licenses:
+- MIT
+metadata: {}
+post_install_message: Thank you for installing the Steampowered Skyhook for Ruby.
+  Have fun!
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Steam API wrapper/library
+test_files: []