renchap-wowr 0.5.1 → 0.5.3

data/README

@@ -36,6 +36,11 @@ Author
 ------
 Originally written by Ben Humphreys benhumphreys[at]gmail.com
 Maintained by Peter Wood peter+wowr[at]alastria.net
-Patches from Renaud Chaput and Michael Chen
+
+Patches:
+Renaud Chaput
+Michael Chen
+Ken Preudhomme
+Scott (thestorcks.de)
 
 Apologies to anyone missed, please let Peter Wood know if this is the case.

data/lib/wowr.rb

@@ -3,7 +3,7 @@
 # http://wowr.rubyforge.org/
 # Written by Ben Humphreys
 # http://benhumphreys.co.uk/
-# Matained By Peter Wood
+# Maintained By Peter Wood
 # http://narwar.net/
 # 
 # Author:: Ben Humphreys
@@ -299,7 +299,7 @@ module Wowr
 			
 			xml = get_xml(@@guild_info_url, options)
 			
-			if (xml%'guildKey') && !(xml%'guildInfo').children.empty?
+			if !(xml%'guildInfo').children.empty?
 				return Wowr::Classes::FullGuild.new(xml)
 			else
 				raise Wowr::Exceptions::GuildNotFound.new(options[:guild_name])
@@ -310,9 +310,11 @@ module Wowr
 		# Search for items with the specified name.
 		# Returns an array of Wowr::Classes::SearchItem.
 		# Searches across all realms.
+		# Can search for items based upon the following options => :source, :dungeon, :item_type ("armor, weapon, etc"), :item_slot (head, shoulders, etc), and :item_sub_type (leather, mail, etc)
+		# The dungeon param is the dungeon ID
 		# Caching is disabled for searching.
 		# * name (String) Name of the item
-		# * options (Hash) Optional hash of arguments identical to those used in the API constructor (realm, debug, cache etc.)
+		# * options (Hash) Optional hash of arguments identical to those used in the API constructor (realm, debug, cache etc.).
 		def search_items(name, options = {})
 			if (name.is_a?(Hash))
 				options = name
@@ -321,6 +323,8 @@ module Wowr
 			end
 			
 			options.merge!(:type => @@search_types[:item])
+			
+			puts options.inspect if options[:debug]
 			return search(options)
 		end
 		
@@ -463,16 +467,18 @@ module Wowr
 		# * 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 = {})
+		def get_guild_bank_contents(cookie, name = @guild_name, options = {})
+			full_cookie = ' JSESSIONID='+cookie
+		
 			if (cookie.is_a?(Hash))
-				options = cookie
+				options = full_cookie
 			elsif (guild_name.is_a?(Hash))
 				options = guild_name
-				options.merge!(:cookie => cookie)
-				options.merge!(:guild_name => @guild_name)
+				options.merge!(:cookie => full_cookie)
+				options.merge!(:guild_name => name)
 			else
-				options.merge!(:cookie => cookie)
-				options.merge!(:guild_name => guild_name)
+				options.merge!(:cookie => full_cookie)
+				options.merge!(:guild_name => name)
 			end			
 			options = merge_defaults(options)
 			
@@ -504,14 +510,16 @@ module Wowr
 		# * 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 = {})
+			full_cookie = ' JSESSIONID='+cookie
+			
 			if (cookie.is_a?(Hash))
-				options = cookie
+				options = full_cookie
 			elsif (name.is_a?(Hash))
 				options = name
-				options.merge!(:cookie => cookie)
-				options.merge!(:guild_name => @guild_name)
+				options.merge!(:cookie => full_cookie)
+				options.merge!(:guild_name => name)
 			else
-				options.merge!(:cookie => cookie)
+				options.merge!(:cookie => full_cookie)
 				options.merge!(:guild_name => name)
 			end
 			
@@ -538,20 +546,22 @@ module Wowr
 
 
 		def get_complete_world_calendar(cookie, name = @character_name, realm = @realm, options = {})
+			full_cookie = ' JSESSIONID='+cookie
+			
 			if (cookie.is_a?(Hash))
-			  options = cookie
+			  options = full_cookie
 			elsif (name.is_a?(Hash))
 			  options = name
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => @character_name)
 			  options.merge!(:realm => @realm)
 			elsif (realm.is_a?(Hash))
 			  options = realm
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => name)
 			  options.merge!(:realm => @realm)
 			else
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => name)
 			  options.merge!(:realm => realm)
 			end
@@ -572,20 +582,22 @@ module Wowr
 	
 
 		def get_world_calendar(cookie, name = @character_name, realm = @realm, options = {})
+			full_cookie = ' JSESSIONID='+cookie
+			
 			if (cookie.is_a?(Hash))
-			  options = cookie
+			  options = full_cookie
 			elsif (name.is_a?(Hash))
 			  options = name
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => @character_name)
 			  options.merge!(:realm => @realm)
 			elsif (realm.is_a?(Hash))
 			  options = realm
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => name)
 			  options.merge!(:realm => @realm)
 			else
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => name)
 			  options.merge!(:realm => realm)
 			end
@@ -618,21 +630,23 @@ module Wowr
 		end
 
 
-                def get_full_user_calendar(cookie, name = @character_name, realm = @realm, options = {})
+        def get_full_user_calendar(cookie, name = @character_name, realm = @realm, options = {})
+			full_cookie = ' JSESSIONID='+cookie
+			
 			if (cookie.is_a?(Hash))
-			  options = cookie
+			  options = full_cookie
 			elsif (name.is_a?(Hash))
 			  options = name
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => @character_name)
 			  options.merge!(:realm => @realm)
 			elsif (realm.is_a?(Hash))
 			  options = realm
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => name)
 			  options.merge!(:realm => @realm)
 			else
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => name)
 			  options.merge!(:realm => realm)
 			end
@@ -654,20 +668,22 @@ module Wowr
 
 
 		def get_user_calendar(cookie, name = @character_name, realm = @realm, options = {})
+			full_cookie = ' JSESSIONID='+cookie
+			
 			if (cookie.is_a?(Hash))
-			  options = cookie
+			  options = full_cookie
 			elsif (name.is_a?(Hash))
 			  options = name
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => @character_name)
 			  options.merge!(:realm => @realm)
 			elsif (realm.is_a?(Hash))
 			  options = realm
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => name)
 			  options.merge!(:realm => @realm)
 			else
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:character_name => name)
 			  options.merge!(:realm => realm)
 			end
@@ -701,28 +717,30 @@ module Wowr
 
 
 		def get_calendar_event (cookie, event = nil, name = @character_name, realm = @realm, options = {})
+			full_cookie = ' JSESSIONID='+cookie
+			
 			if (cookie.is_a?(Hash))
-			  options = cookie
+			  options = full_cookie
 			elsif (event.is_a?(Hash))
 			  options = event
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:event => nil)
 			  options.merge!(:character_name => @character_name)
 			  options.merge!(:realm => @realm)
 			elsif (name.is_a?(Hash))
 			  options = name
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:event => event)
 			  options.merge!(:character_name => @character_name)
 			  options.merge!(:realm => @realm)
 			elsif (realm.is_a?(Hash))
 			  options = realm
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:event => event)
 			  options.merge!(:character_name => name)
 			  options.merge!(:realm => @realm)
 			else
-			  options.merge!(:cookie => cookie)
+			  options.merge!(:cookie => full_cookie)
 			  options.merge!(:event => event)
 			  options.merge!(:character_name => name)
 			  options.merge!(:realm => realm)
@@ -906,7 +924,7 @@ module Wowr
 			
 			# All we need to do is goto the armory login page passing our long life cookie, we should get 302 instantly.
 			stage1 = login_http(authentication_url, true, { @@persistant_cookie => long_life_cookie })
-			
+
 			# Let's see
 			if (stage1.code == "200")
 				# It's no good, our cookie doesn't work anymore.
@@ -1035,12 +1053,19 @@ module Wowr
 			
 			# better way of doing this?
 			# Map custom keys to the HTTP request values
+			# TODO add handles for searching based upon stats
 			reqs = {
 				:character_name => 'n',
+				:source => "fl[source]", # dungeon, badges, arena, etc
+				:dungeon => "fl[dungeon]", # seems it needs the dungeons id rather than name
+				:difficulty => "fl[difficulty]", # normal, heroic, etc
+				:item_type => "fl[type]", # weapon, armor, trinket, etc
+				:item_slot => "fl[slot]", # head, shoulders, etc
+				:item_sub_type => "fl[subTp]", # leather, mail, etc
 				:realm => 'r',
 				:search => 'searchQuery',
 				:type => 'searchType',
-				:guild_name => 'n',
+				:guild_name => 'gn',
 				:item_id => 'i',
 				:team_size => 'ts',
 				:team_name => 't',
@@ -1052,7 +1077,7 @@ module Wowr
 				:event => 'e',
         :now => 'now',
 				:achievement_category => 'c'
-                        }    
+			}    
 			
 			params = []
 			options.each do |key, value|
@@ -1082,7 +1107,7 @@ module Wowr
 			
 			req["cookie"] += options[:cookie] if options[:cookie]
 
-			uri = URI.parse(url)
+			uri = URI.parse(URI.escape(url))
 			
 			http = Net::HTTP.new(uri.host, uri.port)
 			
@@ -1097,7 +1122,7 @@ module Wowr
 			begin
 				tries = 0
 			  http.start do
-				  puts "Get URL "+url if options[:debug]
+				  puts "Get URL "+ url if options[:debug]
 			    res = http.request req
 					# response = res.body
 					
@@ -1109,13 +1134,13 @@ module Wowr
 							if tries > @@max_connection_tries
 								raise Wowr::Exceptions::NetworkTimeout.new('Timed out')
 							else
-								retry
+								redo
 							end
 						end
 			  end
 			rescue Timeout::Error => e
         raise Wowr::Exceptions::NetworkTimeout.new('Timed out - Timeout::Error Exception')
-			rescue Net::HTTPExceptions => e
+			rescue SocketError, Net::HTTPExceptions => e
 				raise Wowr::Exceptions::ServerDoesNotExist.new('Specified server at ' + url + ' does not exist.')
 			end
 		end
@@ -1195,7 +1220,7 @@ module Wowr
 		def login_final_bounce(url)
 			# Let's bounce to our page that will give us our short term cookie, URL has Kerbrose style ticket.
 			finalstage = login_http(url)
-			
+
 			# Did we get a 200?
 			if (finalstage.code == "200")
 				# Get the short term cookie at last
@@ -1231,7 +1256,7 @@ module Wowr
 			end
 			
 			req.set_form_data(data, '&') if data
-			
+
 			http.start do
 				res = http.request(req)
 				
@@ -1244,7 +1269,7 @@ module Wowr
 						if tries > @@max_connection_tries
 							raise Wowr::Exceptions::NetworkTimeout.new('Timed out')
 						else
-							retry
+							redo
 						end
 					end
 			end				

data/lib/wowr/character.rb

@@ -24,6 +24,7 @@ module Wowr
 									:realm,
 									:battle_group, :last_login,
 									:relevance, :search_rank,
+									:achievement_points,
 									
 									:season_games_played, :season_games_won, :team_rank, :contribution # From ArenaTeam info
 			
@@ -64,6 +65,9 @@ module Wowr
 				@relevance 		= elem[:relevance].to_i
 				@search_rank 	= elem[:searchRank].to_i
 				
+				@achievement_points = elem[:points].to_i if elem[:points]
+				@achievement_points = elem[:achPoints].to_i if elem[:achPoints]
+				
 				# Incoming string is 2007-02-24 20:33:04.0, parse to datetime
 				#@last_login 	= elem[:lastLoginDate] == "" ? nil : DateTime.parse(elem[:lastLoginDate])
 				@last_login 	= elem[:lastLoginDate] == "" ? nil : elem[:lastLoginDate]
@@ -130,7 +134,8 @@ module Wowr
 		class InfoCharacter < Character
 			
 			# character_info
-			attr_reader :char_url, :title, :known_titles,
+			attr_reader :char_url, 
+			             :title, :known_titles,
 									:faction, :faction_id,
 			 						:arena_teams,
 									:last_modified,
@@ -147,7 +152,7 @@ module Wowr
 			
 			attr_reader :melee, :ranged, :spell,
 									:defenses, :resistances,
-									:talent_spec, :pvp,
+									:talent_spec, :all_talent_specs, :pvp,
 									:professions,
 									:items,
 									:buffs, :debuffs
@@ -156,6 +161,8 @@ module Wowr
 			# Don't care about battlegroups yet
 			# I don't think I can call stuff from the constructor?
 			def initialize(sheet, api = nil)
+				super(sheet%'character', api)
+				
 				@api = api
 				
 				character_info(sheet%'character')
@@ -237,14 +244,20 @@ module Wowr
 			
 			def character_tab(elem)
 				# <title value=""/>
-				@title				= (elem%'title')[:value] == "" ? nil : (elem%'title')[:value]
-			
+				#@title				= (elem%'title')[:value] == "" ? nil : (elem%'title')[:value]
+				if (@prefix || @suffix)
+				  @title = (@prefix ? @prefix : "") + "%s" + (@suffix ? @suffix : "") 
+				end
+
+
 				@known_titles = []
 
 				@known_titles << @title if (@title)
-				(elem%'knownTitles'/:title).each do |entry|
-				  @known_titles << entry[:value] if (!@known_titles.include?(entry[:value]))
-				end
+
+				#@known_titles << @title if (@title)
+				#(elem%'knownTitles'/:title).each do |entry|
+				#  @known_titles << entry[:value] if (!@known_titles.include?(entry[:value]))
+				#end
 
 				@health 		= (elem%'characterBars'%'health')[:effective].to_i
 				@second_bar = SecondBar.new(elem%'characterBars'%'secondBar')
@@ -269,7 +282,14 @@ module Wowr
 					@resistances[res] = Resistance.new(elem%'resistances'%res)
 				end
 				
-				@talent_spec = TalentSpec.new(elem%'talentSpec')
+				@all_talent_specs = []
+				
+				(elem%'talentSpecs'/:talentSpec).each do |spec|
+				   new_spec = TalentSpec.new(spec)
+				   @all_talent_specs << new_spec
+				   
+				   @talent_spec = new_spec if (new_spec.active)
+				end
 				
 				@pvp = Pvp.new(elem%'pvp')
 								
@@ -677,13 +697,16 @@ module Wowr
 		
 		# Note the list of talent trees starts at 1. This is quirky, but that's what's used in the XML
 		class TalentSpec
-			attr_reader :trees
+			attr_reader :trees, :active, :group, :primary
 
 			def initialize(elem)
 				@trees = []
 				@trees[1] = elem[:treeOne].to_i
 				@trees[2] = elem[:treeTwo].to_i
 				@trees[3] = elem[:treeThree].to_i
+				@active = (elem[:active].to_i == 1 ? true : false)
+				@group = elem[:group].to_i
+				@primary = elem[:prim]
 			end
 		end
 		

data/lib/wowr/guild.rb

@@ -14,8 +14,8 @@ module Wowr #:nodoc:
 			alias_method :to_s, :name
 
 			def initialize(elem)
-				if (elem%'guildKey')
-					guild = (elem%'guildKey')
+				if (elem%'guildHeader')
+					guild = (elem%'guildHeader')
 				else
 					guild = elem
 				end
@@ -82,4 +82,4 @@ module Wowr #:nodoc:
 		
 		end
 	end
-end
+end

data/lib/wowr/guild_bank.rb

@@ -16,7 +16,7 @@ module Wowr
 			attr_reader :motd, :info, :money, :ranks, :bags
 			
 			def initialize(elem)
-				super(elem%'guildKey')
+				super(elem%'guildHeader')
 				
 				@motd = (elem%'guildMessages')[:motd]
 				@info = (elem%'guildMessages')[:info]
@@ -58,15 +58,18 @@ module Wowr
 			
 			def initialize(elem, api = nil)
 				super(elem)
-				
+			
 				@entries = []
-				(elem%'banklogs'/:banklog).each do |entry|
+
+				if (elem%'banklogs')
+				    (elem%'banklogs'/:banklog).each do |entry|
 					@entries << GuildBankLogEntry.new(entry, self, api)
-				end
+				    end
 
-        @group_now = (elem%'banklogs')[:now].to_i
-        @group_next = (elem%'banklogs')[:next].to_i
-        @group_prev = (elem%'banklogs')[:prev].to_i
+			            @group_now = (elem%'banklogs')[:now].to_i
+			            @group_next = (elem%'banklogs')[:next].to_i
+			            @group_prev = (elem%'banklogs')[:prev].to_i
+				end
 			end
 		end
 		
@@ -98,7 +101,10 @@ module Wowr
 				3 => 'Move Item',
 				4 => 'Deposit Money',
 				5 => 'Withdraw Money',
-				6 => 'Repair'
+				6 => 'Repair',
+				7 => 'Move Item',
+				8 => 'Withdraw Money',
+				9 => 'Guild Bank Tab Purchase'
 			}
 			
 			def initialize(elem, bank = nil, api = nil)

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: renchap-wowr
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors: 
 - Ben Humphreys
 - Peter Wood
 - Renaud Chaput
+- Ken Preudhomme
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -67,6 +68,7 @@ files:
 - README
 has_rdoc: true
 homepage: http://wowr.rubyforge.org/
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --inline-source
@@ -88,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: wowr
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: A Ruby library for the World of Warcraft Armory