pwood-wowr 0.5.1

data/lib/wowr/dungeon.rb

@@ -0,0 +1,85 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+# TODO: This class requires some thought as its source is different to others
+# 			The data source for other classes are single XML files that contain
+# 			information relevant to the request.
+# 			Dungeon data is stored in two large (7kb each) files.
+# 			Even with caching this is going to be slow as the entire XML file has
+# 			to be read in and built even for a single look-up.
+
+module Wowr
+	module Classes
+		class Dungeon
+			attr_reader :id, :key, :name,
+			 						:level_minimum, :level_maximum,
+									:party_size, :raid,
+									:release, :heroic, :bosses
+			
+			alias_method :to_s, :name
+			alias_method :to_i, :id
+			alias_method :max_level, :level_maximum
+			alias_method :min_level, :level_minimum
+			
+			def initialize(elem)				
+				@id							= elem[:id].to_i
+				@key						= elem[:key]
+				@level_minimum	= elem[:levelMin].to_i
+				@level_maximum	= elem[:levelMax].to_i
+				@party_size			= elem[:partySize].to_i
+				@raid						= (elem[:raid].to_i == 1) ? true : false
+				@release				= elem[:release].to_i
+				@heroic					= (elem[:hasHeroic].to_i == 1) ? true : false
+				
+				# Ideally want to be able to get the boss by both ID and key
+				#	but by using normal hash.
+				# After a test it seems the method below creates 2 references to an object.
+				@bosses = {}
+				
+				(elem/:boss).each do |elem|
+					# TODO: Is this insane?
+					#				After object test, appears this will be references to the same object
+					boss = Boss.new(elem)
+					@bosses[boss.id]	= boss	if boss.id
+					@bosses[boss.key]	= boss	if boss.key
+				end
+			end
+			
+			# Add the name data from dungeonStrings.xml
+			def add_name_data(elem)
+				# puts elem.raw_string.to_yaml
+				@name = elem.attributes["name"]
+				
+				(elem/:boss).each do |boss_elem|
+					id = boss_elem[:id].to_i
+					key = boss_elem[:key]
+					
+					@bosses[id].add_name_data(boss_elem)	if id
+					@bosses[key].add_name_data(boss_elem)	if key
+				end
+			end
+		end
+
+
+		# Note Key or id can be nil
+		# Not both
+		class Boss
+			attr_reader :id, :key, :name, :type
+			
+			alias_method :to_s, :name
+			alias_method :to_i, :id
+			
+			def initialize(elem)				
+				@id			= elem[:id].to_i if elem[:id].to_i
+				@key		= elem[:key] if elem[:key]
+				@id			= @key if !elem[:id].to_i
+				
+				@type			= elem[:type]
+			end
+			
+			def add_name_data(elem)
+				@name = elem['name']
+			end
+		end
+	end
+end

data/lib/wowr/exceptions.rb

@@ -0,0 +1,163 @@
+module Wowr
+	module Exceptions
+		def self.raise_me(code, options = {})
+			case code
+				when "noCharacter"
+					raise CharacterNotFound.new("Character '#{options[:character_name]}' not found.")
+				when "belowMinLevel"
+				  raise CharacterBelowMinLevel.new("Character '#{options[:character_name]}' is below min level (10).")
+				else
+					raise StandardError.new("The XML returned an error: #{code.to_s}")
+			end
+		end
+		
+		class InvalidXML < StandardError
+		end
+		
+		class EmptyPage < StandardError
+		end
+		
+		class ServerDoesNotExist < StandardError
+			def initialize(string)
+				super "Server at '#{string}' did not respond."
+			end
+		end
+		
+		class CharacterNameNotSet < StandardError
+			def initialize
+				super "Character name not set in options or API constructor."
+			end
+		end
+		
+		class GuildNameNotSet < StandardError
+			def initialize
+				super "Guild name not set in options or API constructor."
+			end
+		end
+		
+		class ArenaTeamNameNotSet < StandardError
+			def initialize
+				super "Arena team name not set."
+			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 LoginRequiresAuthenticator < StandardError
+			def initialize
+				super "It was not possible to login using the username and password provided, because an authenticator code is required."
+			end
+		end		
+		
+		class LoginBroken < StandardError
+			def initialize
+				super "It was not possible to login due to a failure of login logic."
+			end
+		end		
+		
+		class InvalidArenaTeamSize < StandardError
+		end
+		
+		class RealmNotSet < StandardError
+			def initialize
+				super "Realm not set in options or API constructor."
+			end
+		end
+
+		class EventNotSet < StandardError
+			def initialize
+				super "Event not set in options or API constructor."
+			end
+		end
+		
+		# Search (fold)
+		class SearchError < StandardError
+		end
+		
+		class InvalidSearchType < SearchError
+			def initialize(string)
+				super "'#{string}' is not a valid search type."
+			end
+		end
+		
+		class NoSearchString < SearchError
+			def initialize
+				super "No search string specified or string was empty."
+			end
+		end
+		
+		class ElementNotFoundError < StandardError
+		end
+		
+		class CharacterNotFound < ElementNotFoundError
+			def initialize(string)
+				super "Character not found with name '#{string}'."
+			end
+		end
+		
+		class CharacterBelowMinLevel < ElementNotFoundError
+			def initialize(string)
+				super "Character with name '#{string}' is below min level (10)."
+			end
+		end
+		
+		class CharacterNoInfo < StandardError
+		  def initialize(string)
+		    super "Character with name '#{string}' have no informations in the armory (not logged on WoW since last armory reset)"
+                  end
+                end
+		
+		class ItemNotFound < ElementNotFoundError
+			def initialize(string)
+				super "Item not found with name '#{string}'."
+			end
+		end
+		
+		class GuildNotFound < ElementNotFoundError
+			def initialize(string)
+				super "Guild not found with name '#{string}'."
+			end
+		end
+				
+		class ArenaTeamNotFound < ElementNotFoundError
+			def initialize(string)
+				super "Arena team not found with name '#{string}'."
+			end
+		end
+		# (end)
+
+		class InvalidIconSize < StandardError
+			def initialize(array)
+				super "Icon size must be: #{array.keys.inspect}"
+			end
+		end
+		
+		class InvalidIconType < StandardError
+			def initialize(array)
+				super "Icon type must be: #{array.keys.inspect}"
+			end
+		end
+
+		class NetworkTimeout < StandardError
+			def initialize(string)
+				super "Network timeout '#{string}'."
+			end
+		end
+	end
+end

data/lib/wowr/extensions.rb

@@ -0,0 +1,67 @@
+module Wowr
+	module Extensions
+
+		# Rails's cattr_ things. activesupport/lib/active_support/core_ext/class
+		# Really quite handy.
+		# Thanks Reve's Lisa Seelye
+		module Class #:nodoc:
+			def cattr_reader(*syms) #:nodoc:
+				syms.flatten.each do |sym|
+					next if sym.is_a?(Hash)
+					class_eval(<<-EOS, __FILE__, __LINE__)
+						unless defined? @@#{sym}
+							@@#{sym} = nil
+						end
+
+						def self.#{sym}
+							@@#{sym}
+						end
+
+						def #{sym}
+							@@#{sym}
+						end
+					EOS
+				end
+			end
+
+			def cattr_writer(*syms) #:nodoc:
+				options = syms.last.is_a?(Hash) ? syms.pop : {}
+				syms.flatten.each do |sym|
+					class_eval(<<-EOS, __FILE__, __LINE__)
+						unless defined? @@#{sym}
+							@@#{sym} = nil
+						end
+
+						def self.#{sym}=(obj)
+							@@#{sym} = obj
+						end
+						#{"
+						def #{sym}=(obj)
+							@@#{sym} = obj
+						end
+						" unless options[:instance_writer] == false }
+					EOS
+				end
+			end
+			def cattr_accessor(*syms) #:nodoc:
+				cattr_reader(*syms)
+				cattr_writer(*syms)
+			end
+			
+			
+			def stringy(sym) #:nodoc:
+				class_eval(<<-EOS, __FILE__, __LINE__)
+					def to_s
+						@#{sym}
+					end
+				EOS
+			end
+		end
+
+	end
+end
+
+
+class Class #:nodoc:
+	include Wowr::Extensions::Class
+end

data/lib/wowr/general.rb

@@ -0,0 +1,39 @@
+$:.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
+			
+			def +(add)
+				return Money.new(self.total + add.total)
+			end
+			
+			def -(add)
+				return Money.new(self.total - add.total)
+			end
+		end
+		
+	end
+end

data/lib/wowr/guild.rb

@@ -0,0 +1,85 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'character.rb'
+
+module Wowr #:nodoc:
+	module Classes #:nodoc:
+		
+		# A player guild containing members
+		# Abstract
+		class Guild
+			attr_reader :name, :url, :realm
+									# :roster_url, :stats_url, :stats_url_escape,
+			alias_method :to_s, :name
+
+			def initialize(elem)
+				if (elem%'guildKey')
+					guild = (elem%'guildKey')
+				else
+					guild = elem
+				end
+				
+				@name					= guild[:name]
+				@url					= guild[:url]
+				@realm				= guild[:realm]
+			end
+		end
+		
+		# Basic search information returned by the search.xml
+		# <guilds>
+		#   <guild
+		# battleGroup="Ruin"
+		# faction="Alliance"
+		# factionId="0"
+		# name="HAND"
+		# realm="Stormrage"
+		# relevance="100"
+		# url="r=Stormrage&amp;n=HAND&amp;p=1"/>
+		# </guilds>
+		class SearchGuild < Guild
+			attr_reader :faction, :faction_id, :battle_group
+			
+			def initialize(elem)
+				super(elem)
+				
+				@battle_group = elem[:battleGroup]
+				@faction			= elem[:faction]
+				@faction_id		= elem[:factionId].to_i
+				
+				@relevance		= elem[:relevance].to_i
+			end
+		end
+		
+		# Full guild data
+		# <guildKey factionId="0" name="HAND" nameUrl="HAND" realm="Stormrage" realmUrl="Stormrage" url="r=Stormrage&amp;n=HAND"/>
+	  # <guildInfo>
+	  #   <guild>
+	  #     <members filterField="" filterValue="" maxPage="1" memberCount="1" page="1" sortDir="a" sortField="">
+	  #       <character class="Paladin" classId="2" gender="Male" genderId="0" level="14" name="Sturky" race="Dwarf" raceId="3" rank="0" url="r=Stormrage&amp;n=Sturky"/>
+	  #     </members>
+	  #   </guild>
+	  # </guildInfo>
+		class FullGuild < Guild
+			attr_reader :members, :name_url, :realm_url, :member_count
+		
+			def initialize(elem)
+				super(elem)
+				
+				@name_url			= elem[:nameUrl]
+				@realm_url		= elem[:realmUrl]
+				
+				# Guild/guild_id/guild_url not set for characters
+				if (elem%'guildInfo')
+					@member_count = (elem%'guildInfo'%'guild'%'members')[:memberCount].to_i || nil
+					@members = {}
+					(elem%'guildInfo'%'guild'%'members'/:character).each do |char|
+						# TODO: Change to search character?
+						members[char[:name]] = Character.new(char)
+					end
+				end
+			end
+		
+		end
+	end
+end

data/lib/wowr/guild_bank.rb

@@ -0,0 +1,188 @@
+$:.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, :group_now, :group_next, :group_prev
+			
+			def initialize(elem, api = nil)
+				super(elem)
+				
+				@entries = []
+				(elem%'banklogs'/:banklog).each do |entry|
+					@entries << GuildBankLogEntry.new(entry, self, api)
+				end
+
+        @group_now = (elem%'banklogs')[:now].to_i
+        @group_next = (elem%'banklogs')[:next].to_i
+        @group_prev = (elem%'banklogs')[:prev].to_i
+			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, :unknown
+			
+			@@types = {
+				1 => 'Deposit Item',
+				2 => 'Withdraw Item',
+				3 => 'Move Item',
+				4 => 'Deposit Money',
+				5 => 'Withdraw Money',
+				6 => 'Repair',
+				7 => 'Move Item',
+				8 => 'Withdraw Money',
+				9 => 'Guild Bank Tab Purchase'
+			}
+			
+			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]
+        @unknown  = elem[:unknown] == "1" ? true : false
+				@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