steam-vapor 0.0.1 → 0.0.2

data/README.md

@@ -1,29 +1,29 @@
 # Vapor
 
-TODO: Write a gem description
+Vapor is a command-line utility that allows you to view and connect to Source game servers (Team Fortress 2, Counter-Strike: Source, etc.) as well as keep tabs on your Steam friends. Instead of launching Steam, followed by TF2, to see if it's worth joining your favorite server, you can just run `vapor server list` to see how many players are online and what the current map is. Then you can connect with `vapor server connect [server alias]`.
 
-## Installation
-
-Add this line to your application's Gemfile:
+![Screenshot](http://i.imgur.com/3nvdU8k.png)
 
-    gem 'vapor'
+## Installation
 
-And then execute:
+First, ensure that you have Ruby 1.9.x installed. (Vapor was written on Ruby 1.9.3.) You also need to have RubyGems. With those prerequisites aside, installation should be a simple matter of:
 
-    $ bundle
+    gem install steam-vapor
 
-Or install it yourself as:
+## Usage
 
-    $ gem install vapor
+**Servers**
 
-## Usage
+* `vapor server add nickname 127.0.0.1` — Save a server to Vapor's server list. The default port used is 27015, though you can specify another by inputting it after the IP/domain (with a space as a separator). The custom nickname is how Vapor keeps track of the server.
+* `vapor server rm nickname` — Remove the server corresponding to "nickname."
+* `vapor server connect nickname` — Launch Steam and connect to the server corresponding to "nickname."
+* `vapor server list` — View a listing of every server you have saved, complete with player counts and the current map.
+* `vapor server info nickname` — Display the same information as `vapor server list`, but with a listing of players and their scores.
 
-TODO: Write usage instructions here
+**Users**
 
-## Contributing
+* `vapor user mynameis you` — (Replace "you" with your Steam username or numeric ID.) This tells Vapor who you are so the friends list will work.
+* `vapor user friends` — Displays a listing of your Steam friends, with their current status.
+* `vapor user profile username` — Displays a brief overview of the profile matching "username."
 
-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
+Note: For the most accurate command listing, use the `vapor` command's built-in help function.

data/bin/vapor

@@ -1,129 +1,10 @@
 #!/usr/bin/env ruby
 
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
 require 'thor'
 require 'user_config'
 require 'steam-condenser'
 require 'vapor/steam'
 require 'vapor/config'
-
-
-module Vapor
-
-
-	class Server < Thor
-
-
-		def initialize(*args)
-			super
-			@config = STConfig.new
-		end
-
-
-		desc "info <handle> [--ip <ip:port>]", "Display server info"
-		option :ip
-		def info(handle=nil)
-			if (options[:ip])
-				parts = options[:ip].strip.split(':')
-				ip = parts[0]
-				port = parts[1]
-			else
-				s = @config.lookup_server_by_handle(handle)
-				ip = s['ip']
-				port = s['port']
-			end
-			Steam.server_info(ip, port)
-		end
-
-
-		desc "list", "List servers"
-		def list
-			Steam.server_listing(@config.data['servers'])
-		end
-
-
-		desc "add <handle> <ip> [port]", "Save a server to the list"
-		def add(handle, ip, port=27015)
-			@config.add_server(handle, ip, port)
-		end
-
-
-		desc "rm <handle>", "Delete a server from the list"
-		def rm(handle)
-			@config.rm_server(handle)
-		end
-
-
-		desc "connect <handle>", "Connect to a server"
-		def connect(handle)
-			s = @config.lookup_server_by_handle(handle)
-			uri = "steam://connect/#{s['ip']}:#{s['port']}"
-			if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
-				system "start #{uri}"
-			elsif RbConfig::CONFIG['host_os'] =~ /darwin/
-				system "open #{uri}"
-			elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/
-				system "xdg-open #{uri}"
-			end
-		end
-
-
-	end
-
-
-
-	class User < Thor
-
-
-		def initialize(*args)
-			super
-			@config = STConfig.new
-		end
-
-
-		desc "profile <username>", "Display information about a Steam user"
-		def profile(username)
-			Steam.user_profile(username)
-		end
-
-
-		desc "friends", "Display friends list"
-		def friends
-			Steam.friends_list(@config.data['me'])
-		end
-
-
-		desc "mynameis <me>", "Tell Vapor your Steam username or numeric Steam ID"
-		def mynameis(me)
-			@config.set_user(me)
-		end
-
-
-	end
-
-
-
-	class CLI < Thor
-
-
-		def initialize(*args)
-			super
-			@config = STConfig.new
-		end
-
-
-		desc "server [SUBCOMMAND]", "Query servers"
-		subcommand "server", Server
-
-
-		desc "user [SUBCOMMAND]", "Lookup Steam user details"
-		subcommand "user", User
-
-
-	end
-
-
-
-	CLI.start
-
-
-end
+require 'vapor'

data/lib/vapor.rb

@@ -1 +1,123 @@
-require "vapor/version"
+require "vapor/version"
+
+
+module Vapor
+
+
+	class Server < Thor
+
+
+		def initialize(*args)
+			super
+			@config = STConfig.new
+		end
+
+
+		desc "info <handle> [--ip <ip:port>]", "Display server info"
+		option :ip
+		def info(handle=nil)
+			if (options[:ip])
+				parts = options[:ip].strip.split(':')
+				ip = parts[0]
+				port = parts[1]
+			else
+				s = @config.lookup_server_by_handle(handle)
+				ip = s['ip']
+				port = s['port']
+			end
+			Steam.server_info(ip, port)
+		end
+
+
+		desc "list", "List servers"
+		def list
+			Steam.server_listing(@config.data['servers'])
+		end
+
+
+		desc "add <handle> <ip> [port]", "Save a server to the list"
+		def add(handle, ip, port=27015)
+			@config.add_server(handle, ip, port)
+		end
+
+
+		desc "rm <handle>", "Delete a server from the list"
+		def rm(handle)
+			@config.rm_server(handle)
+		end
+
+
+		desc "connect <handle>", "Connect to a server"
+		def connect(handle)
+			s = @config.lookup_server_by_handle(handle)
+			uri = "steam://connect/#{s['ip']}:#{s['port']}"
+			if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+				system "start #{uri}"
+			elsif RbConfig::CONFIG['host_os'] =~ /darwin/
+				system "open #{uri}"
+			elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/
+				system "xdg-open #{uri}"
+			end
+		end
+
+
+	end
+
+
+
+	class User < Thor
+
+
+		def initialize(*args)
+			super
+			@config = STConfig.new
+		end
+
+
+		desc "profile <username>", "Display information about a Steam user"
+		def profile(username)
+			Steam.user_profile(username)
+		end
+
+
+		desc "friends", "Display friends list"
+		def friends
+			Steam.friends_list(@config.data['me'])
+		end
+
+
+		desc "mynameis <me>", "Tell Vapor your Steam username or numeric Steam ID"
+		def mynameis(me)
+			@config.set_user(me)
+		end
+
+
+	end
+
+
+
+	class CLI < Thor
+
+
+		def initialize(*args)
+			super
+			@config = STConfig.new
+		end
+
+
+		desc "server [SUBCOMMAND]", "Query servers"
+		subcommand "server", Server
+
+
+		desc "user [SUBCOMMAND]", "Lookup Steam user details"
+		subcommand "user", User
+
+
+	end
+
+
+
+	CLI.start
+
+
+end

data/lib/vapor/steam.rb

@@ -9,9 +9,10 @@ class Steam
 		if server
 
 			server_info = server.server_info
+			game = self.game_name_string(server_info[:game_id])
 
 			puts "----------------------------------------------------"
-			puts "\033[36m" + server_info[:server_name] + "\033[0m"
+			puts "\033[36m" + server_info[:server_name] + "\033[0m  [#{game}] "
 			puts "\033[32mPlayers:\033[0m #{server_info[:number_of_players]}/#{server_info[:max_players]} \t \033[32mMap:\033[0m #{server_info[:map_name]}"
 			puts "----------------------------------------------------"
 
@@ -66,6 +67,24 @@ class Steam
 
 
 
+	def self.game_name_string(gameid)
+		games = {
+			440 => "TF2",
+			240 => "CS:S",
+			730 => "CS:GO",
+			320 => "HL2",
+			500 => "L4D",
+			550 => "L4D2"
+		}
+		if games.has_key?(gameid)
+			return games[gameid]
+		else
+			return "SRC"
+		end
+	end
+
+
+
 	def self.user_profile(user)
 		uid = Integer(user) rescue user
 		id = SteamId.new(uid)

data/lib/vapor/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steam-vapor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4386472134216201780
+      hash: -2124532433296563554
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4386472134216201780
+      hash: -2124532433296563554
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25