wowr 0.3.0 → 0.4.0

data/changelog.txt

@@ -1,31 +1,17 @@
-0.3.0
-* It is now possible to use shorter method calls
-  api.get_item_tooltip(29242)
-  api.get_item_tooltip(29242, :caching => false, :lang => 'fr_fr')
+0.4.0
+* Added Guild Bank functionality
+  Guild bank contents and transaction logs are now available.
+  Accessing them requires that you login, which returns a cookie string which must be used for all subsequent requests.
+
+  api = Wowr::API.new(:guild_name => 'my_guild', :realm => 'my_realm')
+  cookie = api.login('myuser', 'mypass')
+  api.get_guild_bank_contents(cookie)
+  api.get_guild_bank_log(cookie)
   
-  Old method calls using hashes are still supported
-  api.get_item_tooltip(:item_id => 29242)
+  It's possible to specify the guild and usual extra parameters
+  api.get_guild_bank_contents(cookie, "my_other_guild", :realm => 'other_realm)
   
-  api.get_character_sheet("Smith")
-  
-  The same applies for searches, instead of
-  api.search_characters(:search => "cake")
-  it is now possible to write
-  api.search_characters("cake")
-
-* A new request get_character has been created which gets the full character details provided by the character_sheet.xml, character_skills.xml and character_reputation.xml.  It is still possible to use get_character_sheet, but this is deprecated
-
-* A new method Wowr::API.get_item has been created, which provides the details from get_item_info and get_item_tooltip returned in one object.
-
-* The API is now more strict and will throw exceptions if the correct parameters are not provided.
-
-* For consistency, the get requests now throws exceptions whenever the item or character is not found.  Search requests still return empty arrays if nothing is found, but will return an exception if empty search parameters are provided.
-
-* Skill information is now in a hash my_char.skill_categories['weaponskills'].skills['maces']
-
-* Reputation information is accessible by hash: my_char.rep['alliance'].factions['darnassus']
-
-* More informative exception messages.
-
-* Caching is now on by default.
+  At no point are your user details stored and SSH is used for connections to the server.
+  Thanks to Hesperus and SheepCow of Rawr for help with this.
 
+* Buy and sell prices, as well as transactions in the guild bank now use Wowr::Classes::Money

data/lib/wowr.rb

@@ -15,6 +15,7 @@ rescue LoadError
 	require 'hpricot'
 end
 require 'net/http'
+require 'net/https'
 require 'cgi'
 require 'fileutils'
 
@@ -28,10 +29,11 @@ require 'wowr/character.rb'
 require 'wowr/guild.rb'
 require 'wowr/item.rb'
 require 'wowr/arena_team.rb'
+require 'wowr/guild_bank.rb'
 
 module Wowr
 	class API
-		VERSION = '0.3.0'
+		VERSION = '0.4.0'
 		
 		@@armory_url_base = 'wowarmory.com/'
 		
@@ -49,6 +51,11 @@ module Wowr
 		
 		@@arena_team_url = 'team-info.xml'
 		
+		@@guild_bank_contents_url = 'guild-bank-contents.xml'
+		@@guild_bank_log_url = 'guild-bank-log.xml'
+		
+		@@login_url = 'login.xml'
+		
 		@@max_connection_tries = 10
 		
 		@@cache_directory_path = 'cache/'
@@ -192,6 +199,7 @@ module Wowr
 			character_skills = get_xml(@@character_skills_url, options)
 			character_reputation = get_xml(@@character_reputation_url, options)
 			
+			# FIXME
 			if true
 				return Wowr::Classes::FullCharacter.new(character_sheet,
 																								character_skills,
@@ -417,6 +425,143 @@ module Wowr
 		end
 		
 		
+		# Get the current items within the guild bank.
+		# Note that the bags and items the user can see is dependent on their privileges.
+		# Requires realm.
+		# * cookie (String) Cookie data returned by the login function.
+		# * guild_name (String) Guild name
+		# * options (Hash) Optional hash of arguments identical to those used in the API constructor (realm, debug, cache etc.)
+		def get_guild_bank_contents(cookie, guild_name = @guild_name, options = {})
+			if (cookie.is_a?(Hash))
+				options = cookie
+			elsif (guild_name.is_a?(Hash))
+				options = guild_name
+				options.merge!(:cookie => cookie)
+				options.merge!(:guild_name => @guild_name)
+			else
+				options.merge!(:cookie => cookie)
+				options.merge!(:guild_name => guild_name)
+			end			
+			options = merge_defaults(options)
+			
+			if options[:cookie].nil? || options[:cookie] == ""
+				raise Wowr::Exceptions::CookieNotSet.new
+			elsif options[:guild_name].nil? || options[:guild_name] == ""
+				raise Wowr::Exceptions::GuildNameNotSet.new
+			elsif options[:realm].nil? || options[:realm] == ""
+				raise Wowr::Exceptions::RealmNotSet.new
+			end
+			
+			options.merge!(:secure => true)
+			
+			xml = get_xml(@@guild_bank_contents_url, options)
+			
+			if !(xml%'guildBank').children.empty?
+				return Wowr::Classes::GuildBankContents.new(xml, self)
+			else
+				raise Wowr::Exceptions::GuildBankNotFound.new(options[:guild_name])
+			end
+		end
+		
+		
+		# Get a particular page of the guild bank transaction log.
+		# Each page contains up to 1000 transactions, other pages can be specified using :group in the options hash.
+		# Note that data returned is specific to the logged in user's privileges.
+		# Requires realm.
+		# * cookie (String) Cookie data returned by the login function
+		# * guild_name (String) Guild name
+		# * options (Hash) Optional hash of arguments identical to those used in the API constructor (realm, debug, cache etc.)
+		def get_guild_bank_log(cookie, name = @guild_name, options = {})
+			if (cookie.is_a?(Hash))
+				options = cookie
+			elsif (name.is_a?(Hash))
+				options = name
+				options.merge!(:cookie => cookie)
+				options.merge!(:guild_name => @guild_name)
+			else
+				options.merge!(:cookie => cookie)
+				options.merge!(:guild_name => name)
+			end
+			
+			options = merge_defaults(options)
+			
+			if options[:cookie].nil? || options[:cookie] == ""
+				raise Wowr::Exceptions::CookieNotSet.new
+			elsif options[:guild_name].nil? || options[:guild_name] == ""
+				raise Wowr::Exceptions::GuildNameNotSet.new
+			elsif options[:realm].nil? || options[:realm] == ""
+				raise Wowr::Exceptions::RealmNotSet.new
+			end
+			
+			options.merge!(:secure => true)
+			
+			xml = get_xml(@@guild_bank_log_url, options)
+			
+			if !(xml%'guildBank').children.empty?
+				return Wowr::Classes::GuildBankLog.new(xml, self)
+			else
+				raise Wowr::Exceptions::GuildBankNotFound.new(options[:guild_name])
+			end
+		end
+		
+		
+		# Logs the user into the armory using their main world of warcraft username and password.
+		# Returns a cookie string used for secure requests like get_guild_bank_contents and get_guild_bank_log.
+		# Uses SSH to send details to the login page.
+		def login(username, password)
+			# url = 'https://eu.wowarmory.com/guild-bank-contents.xml?n=Rawr&r=Trollbane'
+			url = base_url(@locale, {:secure => true}) + @@login_url
+			
+			req = Net::HTTP::Post.new(url)
+			req["user-agent"] = "Mozilla/5.0 Gecko/20070219 Firefox/2.0.0.2" # ensure returns XML
+			req["cookie"] = "cookieMenu=all; cookies=true;"
+			
+			uri = URI.parse(url)
+			
+			http = Net::HTTP.new(uri.host, uri.port)
+			
+			# Suppress "warning: peer certificate won't be verified in this SSL session"
+			http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+			http.use_ssl = true
+			
+			req.set_form_data({'accountName' => username, 'password' => password}, '&')
+			
+			
+			http.start do
+				res = http.request(req)
+				
+				tries = 0
+				response = case res
+					when Net::HTTPSuccess, Net::HTTPRedirection
+						res.body
+					else
+						tries += 1
+						if tries > @@max_connection_tries
+							raise Wowr::Exceptions::NetworkTimeout.new('Timed out')
+						else
+							retry
+						end
+					end
+				
+				doc = Hpricot.XML(response)
+				
+				# error = 0 nothing provided
+				# error = 1 invalid credentials
+				# TODO: Detect different kinds of errors
+				if (doc%'login')
+					raise Wowr::Exceptions::InvalidLoginDetails
+				else
+					cookie = nil
+					res.header['set-cookie'].scan(/JSESSIONID=(.*?);/) {
+						cookie = 'JSESSIONID=' + $1 + ';'
+					}
+					return cookie
+				end
+			end
+		end
+		
+		
+		
 		# Clear the cache, optional directory name.
 		# * cache_path (String) Relative path of the cache directory to be deleted
 		def clear_cache(cache_path = @@cache_directory_path)
@@ -430,12 +575,22 @@ module Wowr
 		
 		# Return the base url for the armory, e.g. http://eu.wowarmory.com/
 		# * locale (String) The locale, defaults to that specified in the API constructor
-		def base_url(locale = @locale)
-			if locale == 'us'
-				'http://www.' + @@armory_url_base
+		def base_url(locale = @locale, options = {})
+			str = ""
+			
+			if (options[:secure] == true)
+				str += 'https://'
 			else
-				'http://' + locale + '.' + @@armory_url_base
+				str += 'http://'
 			end
+			
+			if (locale == 'us')
+				str += 'www.' + @@armory_url_base
+			else
+				str += locale + '.' + @@armory_url_base
+			end
+			
+			return str
 		end
 		
 		
@@ -471,9 +626,11 @@ module Wowr
 				:guild_name => 'n',
 				:item_id => 'i',
 				:team_size => 'ts',
-				:team_name => 't'
+				:team_name => 't',
+				:group => 'group'
 			}
 			
+			
 			params = []
 			options.each do |key, value|
 				params << "#{reqs[key]}=#{u(value)}" if reqs[key]
@@ -481,7 +638,7 @@ module Wowr
 			
 			query = '?' + params.join('&') if params.size > 0
 			
-			base = self.base_url(options[:locale])
+			base = self.base_url(options[:locale], options)
 			full_query = base + url + query
 			
 			puts full_query if options[:debug]
@@ -505,15 +662,26 @@ module Wowr
 			end
 		end
 		
+		
 		# Perform an HTTP request and return the contents of the document
 		def http_request(url, options = {})
 			req = Net::HTTP::Get.new(url)
 			req["user-agent"] = "Mozilla/5.0 Gecko/20070219 Firefox/2.0.0.2" # ensure returns XML
 			req["cookie"] = "cookieMenu=all; cookieLangId=" + options[:lang] + "; cookies=true;"
 			
+			req["cookie"] += options[:cookie] if options[:cookie]
+			
 			uri = URI.parse(url)
 			
-		  http = Net::HTTP.new(uri.host, uri.port)
+			http = Net::HTTP.new(uri.host, uri.port)
+			
+			if (options[:secure])
+				puts "Secure authentication" if options[:debug]
+
+				http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+				http.use_ssl = true
+			end
+		  
 			
 			begin
 			  http.start do

data/lib/wowr/exceptions.rb

@@ -39,6 +39,24 @@ module Wowr
 			end
 		end
 		
+		class CookieNotSet < StandardError
+			def initialize
+				super "Cookie required for secure requests not set. Use login(username, password) to retrieve cookie."
+			end
+		end
+		
+		class GuildBankNotFound < StandardError
+			def initialize(guild)
+				super "Guild bank for '#{guild}' not found, this could be due to lack of access privileges or failed login attempt."
+			end
+		end
+		
+		class InvalidLoginDetails < StandardError
+			def initialize
+				super "It was not possible to login using the username and password provided."
+			end
+		end
+		
 		class InvalidArenaTeamSize < StandardError
 		end
 		

data/lib/wowr/general.rb

@@ -0,0 +1,31 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module Wowr
+	module Classes
+		
+		# TODO: Fix default to_s option
+		class Money
+			attr_reader :total
+			alias_method :to_i, :total
+			alias_method :to_s, :total
+			
+			def initialize(total)
+				@total = total
+			end
+			
+			def gold
+				return (@total / 10000)
+			end
+			
+			def silver
+				return (@total % 10000) / 100
+			end
+
+			def bronze
+				return @total % 100
+			end
+		end
+		
+	end
+end

data/lib/wowr/guild_bank.rb

@@ -0,0 +1,181 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'item.rb'
+require 'general.rb'
+
+module Wowr
+	module Classes
+		
+		# def get_login_status
+		# 	name = xml%'loginStatus'[:username]
+		# 	return name == "" ? nil : name
+		# end
+		
+		class GuildBank < Guild
+			attr_reader :motd, :info, :money, :ranks, :bags
+			
+			def initialize(elem)
+				super(elem%'guildKey')
+				
+				@motd = (elem%'guildMessages')[:motd]
+				@info = (elem%'guildMessages')[:info]
+				@info.gsub("&#10;", "\n")
+				
+				@bags = []
+				(elem%'bags'/:bag).each do |bag|
+					@bags[bag[:id].to_i] = GuildBankBag.new(bag)
+				end
+				
+				@ranks = []
+				(elem%'guildRanks'/:rank).each do |rank|
+					@ranks[rank[:id].to_i] = rank[:name]
+				end
+			end
+		end
+		
+		# bags now contain references to the items
+		# Items can be accessed from items (within Wowr::Classes::GuildBankContents)
+		# Or by their individual bags using bag.items
+		class GuildBankContents < GuildBank
+			attr_reader :items
+			
+			def initialize(elem, api = nil)
+				super(elem)
+				@money = Money.new((elem%'guildBank')[:money].to_i)
+				
+				@items = []
+				(elem%'items'/:item).each do |item|
+					@items << GuildBankItem.new(item, bags, api)
+				end
+			end
+		end
+		
+		
+		# Consists of multiple groups, each with 1000 entries
+		class GuildBankLog < GuildBank
+			attr_reader :entries
+			
+			def initialize(elem, api = nil)
+				super(elem)
+				
+				@entries = []
+				(elem%'banklogs'/:banklog).each do |entry|
+					@entries << GuildBankLogEntry.new(entry, self, api)
+				end
+			end
+			
+		end
+		
+		
+		class GuildBankBag < Item
+			attr_reader		:viewable
+			attr_accessor :items
+			
+			def initialize(elem, api = nil)
+				super(elem, api)
+				@viewable = (@viewable == "true")
+				
+				@items = []
+			end
+		end
+		
+
+		# Zero to 1 items
+		# <banklog dtab="" money="1200000" otab="" player="Quixsilver" rank="0" ts="1212595269000" type="4"/>
+		# <banklog dtab="" money="0" otab="0" player="Quixsilver" rank="0" ts="1212527470000" type="2">
+		# 	<item count="1" icon="inv_potion_92" id="12820" name="Winterfall Firewater" qi="1" subtype="" type="consumables"/>
+		# </banklog>
+		class GuildBankLogEntry
+			attr_reader :dtab, :money, :otab, :player, :rank_id, :ts, :type_id, :item
+			
+			@@types = {
+				1 => 'Deposit Item',
+				2 => 'Withdraw Item',
+				3 => 'Move Item',
+				4 => 'Deposit Money',
+				5 => 'Withdraw Money',
+				6 => 'Repair'
+			}
+			
+			def initialize(elem, bank = nil, api = nil)
+				@bank = bank
+				
+				@dtab			= elem[:dtab] == "" ? nil : elem[:dtab].to_i
+				@otab			= elem[:otab] == "" ? nil : elem[:otab].to_i 
+				@money		= Money.new(elem[:money].to_i)
+				@player 	= elem[:player]
+				@rank_id	= elem[:rank].to_i
+				@ts 			= elem[:ts].to_i # TODO: Check TS isn't overloading
+				@type_id	= elem[:type].to_i
+				
+				if (elem%'item')
+					@item = GuildBankLogItem.new(elem%'item', api)
+				end
+			end
+			
+			def type
+				return @@types[@type_id]
+			end
+			
+			def rank
+				@rank_id.nil? ? nil : @bank.ranks[@rank_id]
+			end
+			
+			def origin
+				@otab.nil? ? nil : @bank.bags[@otab]
+			end
+			
+			def destination
+				@dtab.nil? ? nil : @bank.bags[@dtab]
+			end
+			
+			def time
+				return Time.at(@ts / 1000)
+			end
+		end
+		
+		
+		# Simple item that appears in Wowr::Classes::GuildBankLog entries
+		# <item count="1" icon="inv_potion_92" id="12820" name="Winterfall Firewater" qi="1" subtype="" type="consumables"/>
+		class GuildBankLogItem < Item
+			attr_reader :count, :qi, :subtype, :type
+			
+			def initialize(elem, api = nil)
+				super(elem, api)
+				@count		= elem[:count].to_i
+				@qi				= elem[:qi].to_i
+				@subtype	= elem[:subtype] == "" ? nil : elem[:subtype]
+				@type			= elem[:type]
+			end
+		end
+		
+		
+		# More detailed item used in full Wowr::Classes::GuildBank
+		# Very close to Wowr::Classes::EquippedItem
+		# <item bag="0" durability="0" icon="racial_dwarf_findtreasure" id="12219" maxDurability="0" name="Unadorned Seal of Ascension" qi="1" quantity="1" randomPropertiesId="0" seed="1827537860" slot="90" subtype="" subtypeLoc="Quest" type="consumables"/>
+		class GuildBankItem < Item
+			attr_reader :bag_id, :durability, :max_durability, :qi, :quantity,
+									:random_properties_id, :seed, :slot, :subtype, :subtype_loc, :type
+			
+			def initialize(elem, bags = nil, api = nil)
+				super(elem, api)
+				
+				@bag_id		= elem[:bag].to_i
+				@qi				= elem[:qi].to_i
+				@quantity = elem[:quantity].to_i
+				
+				@durability						= elem[:durability].to_i
+				@max_durability				= elem[:maxDurability].to_i
+				@random_properties_id = elem[:randomPropertiesId] == 0 ? nil : elem[:randomPropertiesId].to_i
+				@seed					= elem[:seed].to_i
+				@slot					= elem[:slot].to_i
+				@subtype			= elem[:subtype]		== "" ? nil : elem[:subtype]
+				@subtype_loc	= elem[:subtypeLoc] == "" ? nil : elem[:subtypeLoc]
+				@type					= elem[:type].to_i
+				
+				bags[@bag_id].items << self
+			end
+		end
+	end
+end

data/lib/wowr/item.rb

@@ -6,6 +6,8 @@
 $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
+require 'general.rb'
+
 module Wowr
 	module Classes
 
@@ -463,8 +465,8 @@ module Wowr
 			attr_reader :buy_price, :sell_price, :tokens
 	
 			def initialize(elem)
-				@buy_price 	= elem[:buyPrice].to_i	if elem[:buyPrice]
-				@sell_price	= elem[:sellPrice].to_i	if elem[:sellPrice]
+				@buy_price 	= Money.new(elem[:buyPrice].to_i)	if elem[:buyPrice]
+				@sell_price	= Money.new(elem[:sellPrice].to_i)	if elem[:sellPrice]
 		
 				if (elem%'token')
 					@tokens = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wowr
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Ben Humphreys
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-05 00:00:00 +01:00
+date: 2008-06-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,10 +32,12 @@ extra_rdoc_files:
 - changelog.txt
 files: 
 - lib/wowr.rb
+- lib/wowr/general.rb
 - lib/wowr/arena_team.rb
 - lib/wowr/character.rb
 - lib/wowr/guild.rb
 - lib/wowr/item.rb
+- lib/wowr/guild_bank.rb
 - lib/wowr/exceptions.rb
 - lib/wowr/extensions.rb
 - README