skyhook 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70bf22445e76c8f7b4d1eb9880c9e6ca649fac51
-  data.tar.gz: 5294489974c5b6821775eaadeca5a3fac8ff6260
+  metadata.gz: e90870667ebbb7926c509e58e2b8c2d55591cdea
+  data.tar.gz: 1cdc29acb20e119fc14f087698fd0dd15d1bbf64
 SHA512:
-  metadata.gz: 7ce9151098905efb126934926d4906d0e8e8fbf88e861ca407d22c0322d8e63e857a8aba2c89331964b4cbb32231eb1ea1cdd08a24f8ba7919a44fc1e8f1c504
-  data.tar.gz: f92d418937707f7961dbe9a3bd183cc2ecd1a4ffbcc50f8031a703ee168a951bface41de7bb9184da22c3c15c3e10d26e8c2a8f8ef35584d40b5e9764880d87a
+  metadata.gz: be6d2af60673d9495f523c8c42e46d753c84c261f0b3560a54ee1b38ae03bdec8df65ab497bf1fc14093d10cd9eaecc04593190fcde9c6a3b61ef845db98b84d
+  data.tar.gz: a0bd60914b25d4ca0ce1f201e28e6c137528fbc1931800ddb4bef11a2e058e36058af9f18f72ac66d03250f6a23ac5724044a0a4c3a51ae6e1764b0ac3aca13b

data/.gitignore

@@ -13,3 +13,4 @@
 *.a
 mkmf.log
 .env
+/data/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format progress

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "skyhook"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/skyhook/core.rb

@@ -1,72 +1,35 @@
 module Skyhook
   class Core < Skyhook::Configuration
 
-    def api_reference
-      url = "/ISteamWebAPIUtil/GetSupportedAPIList/v0001/"
-
-      unless @api_key.blank?
-        url << "?key=#{ self.api_key }"
-      end
-
-      request url
-    end
-
-    def resolve_vanity( vanityurl )
-      response = request "/ISteamUser/ResolveVanityURL/v0001/?key=#{ self.api_key }&vanityurl=#{ vanityurl }"
-      if response["response"]["message"]
-        vanityurl.to_i
-      else
-        response["response"]["steamid"].to_i
-      end
+    def self.api_reference
+      request '/ISteamWebAPIUtil/GetSupportedAPIList/v0001/'
     end
 
-    def user_summaries( steamids = [] )
-      steamids = [ steamids ] unless steamids.is_a? Array
-
-      if steamids.empty?
-        p 'No steamids were defined'
-        return nil
-      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
+    protected
 
-    # 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 self.request( uri, params = {} )
+      # uri << "&key=#{ self.api_key }" if self.api_key
+      conn = Faraday.new(:url => 'http://api.steampowered.com') do |faraday|
+          faraday.request  :url_encoded             # form-encode POST params
+          faraday.response :logger                  # log requests to STDOUT
+          faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        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]
+      response = conn.get do |req|
+        req.url uri
 
-      request "/IPlayerService/GetOwnedGames/v1/?key=#{ self.api_key }&steamid=#{ steamid }&include_appinfo='#{ appinfo }'&include_played_free_games='#{ free_games }'"
-    end
+        req.params['key'] = self.api_key if self.api_key
 
-    def friend_list( steamid, relationship )
-      steamid = resolve_vanity steamid
-      raise( ArgumentError,  'Not a valid relationship' ) unless %w{ all friend }.include? relationship
+        params.each do |param, value|
+          value = (value.is_a? TrueClass) ? "'true'" : value
+          value = (value.is_a? FalseClass) ? "'false'" : value
 
-      request "/ISteamUser/GetFriendList/v1/?key=#{ self.api_key }&steamid=#{ steamid }&relationship=#{ relationship }"
-    end
-
-    protected
+          req.params[param] = value
+        end unless params.empty?
+      end
 
-    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 = {} )

data/lib/skyhook/game.rb

@@ -15,7 +15,7 @@ module Skyhook
           @user = Skyhook::User.new steamid
         end
 
-        set_user_attributes player_stats( appid, @user.steamid )['playerstats']
+        set_user_attributes Skyhook::Core::ISteamUserStats.player_stats( appid, @user.steamid )
       end
     end
 
@@ -24,13 +24,12 @@ module Skyhook
 
       @achievements = response['achievements']
       @stats = response['stats']
-
+      @user.games= self
     end
 
     def set_global_attributes
       #Will return a games global stats
       raise NotImplementedError
     end
-
   end
 end

data/lib/skyhook/i_player_service.rb

@@ -0,0 +1,46 @@
+module Skyhook
+  module Core::IPlayerService
+
+    # IPlayerService
+    # Methods relating to a Steam user's games.
+
+    def self.owned_games( steamid, options = {} )
+      steamid = Skyhook::Core::ISteamUser.resolve_vanity steamid
+      appinfo = options[:appinfo].nil? ? false : options[:appinfo]
+      free_games = options[:free_games].nil? ? false : options[:free_games]
+      appids_filter = options[:appids_filter].nil? ? [] : options[:appids_filter]
+
+      response = parent.request '/IPlayerService/GetOwnedGames/v1', steamid: steamid, include_appinfo: appinfo, include_played_free_games: free_games, appids_filter: appids_filter
+      response['response']
+    end
+
+    def self.recently_played_games( steamid, count = 10 )
+        steamid = Skyhook::Core::ISteamUser.resolve_vanity steamid
+
+        response = parent.request '/IPlayerService/GetRecentlyPlayedGames/v1', steamid: steamid, count: count
+        response['response']
+    end
+
+    def self.steam_level( steamid )
+      steamid = Skyhook::Core::ISteamUser.resolve_vanity steamid
+
+      response = parent.request '/IPlayerService/GetSteamLevel/v1', steamid: steamid
+      response['response']['player_level']
+    end
+
+    def self.badges( steamid )
+      steamid = Skyhook::Core::ISteamUser.resolve_vanity steamid
+
+      response = parent.request '/IPlayerService/GetBadges/v1', steamid: steamid
+      response['response']
+    end
+
+    def self.community_badge_progress( steamid, badgeid = nil )
+      steamid = Skyhook::Core::ISteamUser.resolve_vanity steamid
+
+      response = parent.request '/IPlayerService/GetCommunityBadgeProgress/v1', steamid: steamid, badgeid: badgeid
+      response['response']['quests']
+    end
+
+  end
+end

data/lib/skyhook/i_steam_apps.rb

@@ -0,0 +1,23 @@
+module Skyhook
+  module Core::ISteamApps
+
+    # ISteamApps
+    # Methods relating to Steam Apps in general.
+
+    def self.server_at_address( ip_address )
+      response = parent.request '/ISteamApps/GetServersAtAddress/v1', addr: ip_address
+      response['response']['servers']
+    end
+
+    def self.up_to_date_check( appid, version )
+      response = parent.request '/ISteamApps/UpToDateCheck/v1', appid: appid, version: version
+      response
+    end
+
+    def self.app_list
+      response = parent.request '/ISteamApps/GetAppList/v2'
+      response['applist']['apps']
+    end
+
+  end
+end

data/lib/skyhook/i_steam_economy.rb

@@ -0,0 +1,13 @@
+module Skyhook
+  module Core::ISteamEconomy
+
+    # ISteamEconomy
+    # Methods relating to games' store's assets.
+
+    # TODO implement these methods
+
+    def self.asset_class_info;end
+    def self.asset_prices;end
+
+  end
+end

data/lib/skyhook/i_steam_news.rb

@@ -0,0 +1,18 @@
+module Skyhook
+  module Core::ISteamNews
+
+    # SteamNews
+    # Methods relating to Steam News.
+
+    def self.news_for_app( appid, options = {} )
+      maxlength = options[:maxlength]
+      enddate = options[:enddate]
+      count = options[:count]
+      feeds = options[:feeds]
+
+      response = parent.request '/ISteamNews/GetNewsForApp/v0002', appid: appid,  maxlength: maxlength, enddate: enddate, count: count, feeds: feeds
+      response['appnews']
+    end
+
+  end
+end

data/lib/skyhook/i_steam_remote_storage.rb

@@ -0,0 +1,24 @@
+module Skyhook
+  module Core::ISteamRemoteStorage
+
+    # ISteamRemoteStorage
+    # Methods relating to stored files.
+
+    # TODO finish implementing this
+
+    def collection_details;end
+    def published_file_details;end
+
+    def ugcf_file_details( ugcid, appid, options = {} )
+      steamid = Skyhook::Core::ISteamUser.resolve_vanity options[:steamid] unless options.empty?
+
+      response = parent.request 'ISteamRemoteStorage/GetUGCFileDetails/v1/', ugcid: ugcid, appid: appid, steamid: steamid
+      if response['status']['code'] == 9
+        raise StandardError
+      else
+        response['data']
+      end
+    end
+
+  end
+end

data/lib/skyhook/i_steam_user.rb

@@ -0,0 +1,52 @@
+module Skyhook
+  module Core::ISteamUser
+
+    # ISteamUser
+    # Methods relating to Steam users.
+
+    def self.friend_list( steamid, relationship )
+      steamid = resolve_vanity steamid
+      raise( ArgumentError,  'Not a valid relationship' ) unless %w{ all friend }.include? relationship
+
+      response = parent.request '/ISteamUser/GetFriendList/v1', steamid: steamid, relationship: relationship
+      response['friendslist']['friends']
+    end
+
+    def self.resolve_vanity( vanityurl )
+      response = parent.request '/ISteamUser/ResolveVanityURL/v0001', vanityurl: vanityurl
+
+      if response["response"]["message"]
+        vanityurl.to_i
+      else
+        response["response"]["steamid"].to_i
+      end
+    end
+
+    def self.resolve_vanities( *vanityurls )
+      vanityurls.map! do |vanityurl|
+        resolve_vanity vanityurl
+      end
+    end
+
+    def self.user_summaries( *steamids )
+      steamids = resolve_vanities steamids
+
+      response = parent.request '/ISteamUser/GetPlayerSummaries/v0002', steamids: steamids
+      response["response"]["players"]
+    end
+
+    def self.player_bans( *steamids )
+      steamids = resolve_vanities steamids
+
+      response = parent.request '/ISteamUser/GetPlayerBans/v1', steamids: steamids
+      response["players"]
+    end
+
+    def self.user_group_list( steamid )
+      steamid = resolve_vanity steamid
+      response = parent.request '/ISteamUser/GetUserGroupList/v1', steamid: steamid
+      response["response"]["groups"]
+    end
+
+  end
+end

data/lib/skyhook/i_steam_user_stats.rb

@@ -0,0 +1,48 @@
+module Skyhook
+  module Core::ISteamUserStats
+
+    # ISteamUserStats
+    # Methods relating to User stats.
+
+    def self.player_stats( appid, steamid )
+      steamid = Skyhook::Core::ISteamUser.resolve_vanity steamid
+
+      response = parent.request '/ISteamUserStats/GetUserStatsForGame/v2', steamid: steamid, appid: appid
+      response['playerstats']
+    end
+
+    def self.player_achievements( appid, steamid, options = {} )
+      steamid = Skyhook::Core::ISteamUser.resolve_vanity steamid
+      l = options[:l] || options[:language]
+
+      response = parent.request '/ISteamUserStats/GetPlayerAchievements/v1', appid: appid, steamid: steamid, l: l
+      response['playerstats']
+    end
+
+    def self.number_of_current_players( appid )
+      response = parent.request '/ISteamUserStats/GetNumberOfCurrentPlayers/v1', appid: appid
+      response['response']['player_count']
+    end
+
+    # FIXME(ClikeX) this won't work without names. But names do use the [] url parameter encoding. This won't work with faraday
+    def self.global_stats( appid, count = 1, options = {} )
+      startdate = options[:startdate]
+      enddate = options[:enddate]
+
+      parent.request '/ISteamUserStats/GetGlobalStatsForGame/v0001', appidid: appid, count: count, startdate: startdate, enddate: enddate
+    end
+
+    def self.global_achievenement_percentages( appid )
+
+      response = parent.request '/ISteamUserStats/GetGlobalAchievementPercentagesForApp/v0002', gameid: appid
+      response['achievementpercentages']['achievements']
+    end
+
+    def self.schema_for_game(appid, options = {})
+      l = options[:l] || options[:language]
+
+      result = parent.request '/ISteamUserStats/GetSchemaForGame/v2', appid: appid, l: l
+      result['game']
+    end
+  end
+end

data/lib/skyhook/user.rb

@@ -8,15 +8,15 @@ module Skyhook
     attr_reader :loccityid, :locstatecode, :loccountrycode
 
     def initialize( steamid )
-      set_attributes user_summaries( steamid )["response"]["players"][0]
+      set_attributes Skyhook::Core::ISteamUser.user_summaries( steamid ).first
     end
 
     def game( appid )
-      Skyhook::Game.new appid, self
+      Skyhook::Game.new( appid, self )
     end
 
-    def friends( relationship = 'friend' )
-      @friends ||= friend_list @steamid, relationship
+    def friends( relationship = :all )
+      @friends ||= Skyhook::Core::ISteamUser.friend_list @steamid, relationship.to_s
     end
 
     private
@@ -41,6 +41,5 @@ module Skyhook
       @locstatecode = response["locstatecode"]
       @loccityid = response["loccityid"]
     end
-
   end
 end

data/lib/skyhook/version.rb

@@ -1,3 +1,3 @@
 module Skyhook
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/lib/skyhook.rb

@@ -1,12 +1,23 @@
 require 'active_support/all'
-require 'net/http'
+require 'faraday'
 
 require 'skyhook/configuration'
 require 'skyhook/core'
 require 'skyhook/game'
 require 'skyhook/user'
+require 'skyhook/i_player_service'
+require 'skyhook/i_steam_apps'
+require 'skyhook/i_steam_economy'
+require 'skyhook/i_steam_news'
+require 'skyhook/i_steam_user'
+require 'skyhook/i_steam_user_stats'
+
+
 
 module Skyhook
+
+  Faraday::Utils.default_params_encoder = Faraday::FlatParamsEncoder
+
   def self.configure( options = {} )
     self::Configuration.configure options
   end

data/skyhook.gemspec

@@ -24,11 +24,14 @@ Gem::Specification.new do |s|
   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 "bundler", "~> 1.9"
+  s.add_development_dependency 'dotenv', '~> 2.0'
   s.add_development_dependency 'rake', '~> 10.0' ,'>= 10.0.0'
+  s.add_development_dependency 'rspec', '~> 3.2'
+  s.add_development_dependency 'vcr', '~> 2.9.3'
+  s.add_development_dependency 'pry', '~> 0.10.0'
 
+  s.add_runtime_dependency 'faraday', '~> 0.9.1'
   s.add_runtime_dependency 'activesupport', '~> 4.0 '
 
 end

data/spec/features/core_spec.rb

@@ -0,0 +1,9 @@
+describe "Core" do
+
+  it 'should be able to configure format'
+
+  it 'should be able to request the api reference'
+
+  it 'should be able to resolve vanity urls'
+
+end

data/spec/features/game_spec.rb

@@ -0,0 +1,7 @@
+describe "Game" do
+
+  it 'should be able to collect global stats'
+
+  it 'should be able to collect user stats'
+
+end

data/spec/features/user_spec.rb

@@ -0,0 +1,7 @@
+describe "User" do
+
+  it 'should be able to collect user stats'
+
+  it 'should be able to collect stats for a game'
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'skyhook'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skyhook
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - ClikeX
@@ -16,74 +16,104 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: 1.0.0
+        version: 10.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '10.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 10.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
+        version: '3.2'
   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
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-    - - ">="
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.0
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-    - - ">="
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.0
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -100,24 +130,40 @@ dependencies:
         version: '4.0'
 description: A wrapper/library for the Steam web API
 email: w.s.van.der.meulen@gmail.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/skyhook.rb
 - lib/skyhook/configuration.rb
 - lib/skyhook/core.rb
 - lib/skyhook/game.rb
+- lib/skyhook/i_player_service.rb
+- lib/skyhook/i_steam_apps.rb
+- lib/skyhook/i_steam_economy.rb
+- lib/skyhook/i_steam_news.rb
+- lib/skyhook/i_steam_remote_storage.rb
+- lib/skyhook/i_steam_user.rb
+- lib/skyhook/i_steam_user_stats.rb
 - lib/skyhook/user.rb
 - lib/skyhook/version.rb
 - skyhook.gemspec
+- spec/features/core_spec.rb
+- spec/features/game_spec.rb
+- spec/features/user_spec.rb
+- spec/spec_helper.rb
 - tasks/test.rake
 homepage: http://rubygems.org/gems/skyhook
 licenses:
@@ -144,4 +190,8 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Steam API wrapper/library
-test_files: []
+test_files:
+- spec/features/core_spec.rb
+- spec/features/game_spec.rb
+- spec/features/user_spec.rb
+- spec/spec_helper.rb