vapor 0.0.1 → 0.0.2

data/.gitignore

@@ -1,21 +1,17 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
 coverage
-rdoc
+doc/
+lib/bundler/man
 pkg
-
-## PROJECT::SPECIFIC
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p327@vapor"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.16.5 (latest)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,6 @@
-Copyright (c) 2009 Guillermo Iguaran
+Copyright (c) 2012 Pedro Nascimento
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Vapor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vapor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vapor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -1,53 +1 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "vapor"
-    gem.summary = %Q{Minimalist Ruby library inspired in vapor.js}
-    gem.description = %Q{All awesomest in one library}
-    gem.email = "guilleiguaran@gmail.com"
-    gem.homepage = "http://github.com/guilleiguaran/vapor"
-    gem.authors = ["Guillermo Iguaran"]
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "vapor #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require "bundler/gem_tasks"

data/lib/vapor.rb

@@ -0,0 +1,12 @@
+require "vapor/version"
+require 'vapor/api'
+require 'vapor/crawler'
+require 'vapor/user'
+require 'vapor/game'
+require 'vapor/games_list'
+
+module Vapor
+  def self.api
+    @@api ||= Vapor::API.new
+  end
+end

data/lib/vapor/api.rb

@@ -0,0 +1,44 @@
+require 'active_support/all'
+require 'json'
+module Vapor
+  class API
+    class << self
+      def key
+        @key ||= ENV['STEAM_API_KEY']
+      end
+    end
+    BASE_URL="http://api.steampowered.com"
+    attr_reader :client
+
+    def player_summaries_for(user)
+      fetch('ISteamUser/GetPlayerSummaries', version: 'v0002', steamids: user.steam_id.to_s)
+    end
+
+    def client
+      @client ||= HTTPClient.new
+    end
+
+    private
+    def fetch(url, options)
+      version = options.delete :version
+      options.merge! key: self.class.key
+      response = client.get("#{BASE_URL}/#{url}/#{version}/?#{normalize_params options}")
+      parse_and_extract_response response
+    end
+
+    def normalize_params(params)
+      query = ""
+      params.each {|k, v| query += "#{k}=#{v}&"}
+      query
+    end
+
+    def parse_and_extract_response(response)
+      JSON.parse(response.body)["response"]["players"].first.symbolize_keys
+    end
+  end
+  class APINotAvailableError < StandardError
+    def initialize
+      super("Steam API is currently unavailable")
+    end
+  end
+end

data/lib/vapor/crawler.rb

@@ -0,0 +1,17 @@
+require 'nokogiri'
+module Vapor
+  class Crawler
+    def games_for(user)
+      doc = fetch("#{user.profile_url}games")
+      doc.gamesList.games.elements
+    end
+    private
+    def fetch(url)
+      doc = client.get("#{url}?xml=1").body
+      Nokogiri::Slop(doc)
+    end
+    def client
+      @client ||= HTTPClient.new
+    end
+  end
+end

data/lib/vapor/game.rb

@@ -0,0 +1,15 @@
+module Vapor
+  class Game
+    attr_reader :id, :name, :url, :time_spent_in_hours
+    def initialize(xml_node)
+      parse_xml(xml_node)
+    end
+    private
+    def parse_xml(xml_node)
+      @id = xml_node.search('appID').text.to_i
+      @name = xml_node.search('name').text
+      @url = xml_node.search('storeLink').text
+      @time_spent_in_hours = xml_node.search('hoursOnRecord').text.to_f
+    end
+  end
+end

data/lib/vapor/games_list.rb

@@ -0,0 +1,20 @@
+module Vapor
+  class GamesList
+    def initialize(user)
+      @user = user
+    end
+
+    def games
+      parse_games(fetch_games)
+    end
+
+    private
+    def fetch_games
+      Crawler.new.games_for(@user)
+    end
+
+    def parse_games(xml_nodes)
+      @games ||= xml_nodes.map{|xml| Game.new(xml)}
+    end
+  end
+end

data/lib/vapor/user.rb

@@ -0,0 +1,40 @@
+require 'httpclient'
+require 'rexml/document'
+module Vapor
+  class User
+    attr_reader :steam_id
+
+    def initialize(steam_id)
+      if steam_id.is_a? Integer || steam_id =~ /\A\d+\Z/
+        @steam_id = steam_id
+      else
+        @steam_id = fetch_real_id steam_id
+      end
+      @steam_id = @steam_id.to_i
+    end
+
+    def profile_url
+      @profile_url ||= player_info[:profileurl]
+    end
+
+    def games
+      @games ||= GamesList.new(self).games
+    end
+
+    private
+
+    def player_info
+      @player_info ||= Vapor.api.player_summaries_for(self)
+    end
+
+    def fetch_real_id(username)
+      user_page = client.get("http://steamcommunity.com/id/#{username}?xml=1")
+      raise APINotAvailableError if user_page.status == 503
+      REXML::Document.new(user_page.body).elements['profile/steamID64'].text
+    end
+
+    def client
+      Vapor.api.client
+    end
+  end
+end

data/lib/vapor/version.rb

@@ -0,0 +1,3 @@
+module Vapor
+  VERSION = "0.0.2"
+end

data/spec/cassettes/Vapor_API/fetches_player_summaries_for_an_user.yml

@@ -0,0 +1,87 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.steampowered.com/ISteamUser/GetPlayerSummaries/v0002/?key=8BDCBAAA1E46E207931AA2950110AEB2&steamids=76561198021477729
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        VHVlLCAyNyBOb3YgMjAxMiAwNjoxNjozMyBHTVQ=
+      !binary "RXhwaXJlcw==":
+      - !binary |-
+        VHVlLCAyNyBOb3YgMjAxMiAwNjoxNjozMyBHTVQ=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD1VVEYtOA==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        ODE0
+    body:
+      encoding: US-ASCII
+      string: ! "{\n\t\"response\": {\n\t\t\"players\": [\n\t\t\t{\n\t\t\t\t\"steamid\":
+        \"76561198021477729\",\n\t\t\t\t\"communityvisibilitystate\": 3,\n\t\t\t\t\"profilestate\":
+        1,\n\t\t\t\t\"personaname\": \"Lunks\",\n\t\t\t\t\"lastlogoff\": 1353928831,\n\t\t\t\t\"profileurl\":
+        \"http://steamcommunity.com/id/pedronascimento/\",\n\t\t\t\t\"avatar\": \"http://media.steampowered.com/steamcommunity/public/images/avatars/4c/4c76064be169987500e4c7e228aabe3e33e1df47.jpg\",\n\t\t\t\t\"avatarmedium\":
+        \"http://media.steampowered.com/steamcommunity/public/images/avatars/4c/4c76064be169987500e4c7e228aabe3e33e1df47_medium.jpg\",\n\t\t\t\t\"avatarfull\":
+        \"http://media.steampowered.com/steamcommunity/public/images/avatars/4c/4c76064be169987500e4c7e228aabe3e33e1df47_full.jpg\",\n\t\t\t\t\"personastate\":
+        1,\n\t\t\t\t\"primaryclanid\": \"103582791429521408\",\n\t\t\t\t\"timecreated\":
+        1266769126,\n\t\t\t\t\"loccountrycode\": \"BR\"\n\t\t\t}\n\t\t]\n\t\t\n\t}\n}"
+    http_version: 
+  recorded_at: Tue, 27 Nov 2012 06:16:25 GMT
+- request:
+    method: get
+    uri: http://api.steampowered.com/ISteamUser/GetPlayerSummaries/v0002/?key=&steamids=76561198021477729
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 401
+      message: !binary |-
+        VW5hdXRob3JpemVk
+    headers:
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        OTg=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9odG1sOyBjaGFyc2V0PVVURjg=
+      !binary "RGF0ZQ==":
+      - !binary |-
+        TW9uLCAwMyBEZWMgMjAxMiAxNjo1NzoxMyBHTVQ=
+      !binary "RXhwaXJlcw==":
+      - !binary |-
+        TW9uLCAyNiBKdWwgMTk5NyAwNTowMDowMCBHTVQ=
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bm8tY2FjaGUsbXVzdC1yZXZhbGlkYXRl
+    body:
+      encoding: US-ASCII
+      string: ! '<html>
+
+        <head>
+
+        <title>401 Unauthorized</title>
+
+        </head>
+
+        <body>
+
+        <h1>Unauthorized</h1>
+
+        </body>
+
+        </html>'
+    http_version: 
+  recorded_at: Mon, 03 Dec 2012 16:57:11 GMT
+recorded_with: VCR 2.3.0