wowr 0.1.1 → 0.1.2

data/lib/wowr.rb

@@ -5,10 +5,10 @@
 # http://benhumphreys.co.uk/
 
 begin
-	require 'lib/hpricot-0.6/hpricot'
+	require 'hpricot' # version 0.6
 rescue LoadError
 	require 'rubygems'
-	require 'hpricot'
+	require 'hpricot' # version 0.6
 end
 require 'net/http'
 require 'cgi'
@@ -26,6 +26,8 @@ module Wowr
 		@@armory_url = 'http://www.wowarmory.com/'
 		@@eu_armory_url = 'http://eu.wowarmory.com/'
 		
+		@@search_url = 'search.xml'
+		
 		@@character_sheet_url = 'character-sheet.xml'
 		@@character_talents_url = 'character-talents.xml'
 		@@character_skills_url = 'character-skills.xml'
@@ -33,18 +35,15 @@ module Wowr
 		
 		@@guild_info_url = 'guild-info.xml'
 		
-		@@search_url = 'search.xml'
-		
 		@@item_info_url = 'item-info.xml'
 		@@item_tooltip_url = 'item-tooltip.xml'
-		
-		@@icon_url = 'http://wowbench.com/images/icons/32x32/'
-		
+
 		@@arena_team_url = 'team-info.xml'
 		
 		@@max_connection_tries = 10
 
 		# Tiny forum-used race/class icons
+		# @@icon_url = 'http://wowbench.com/images/icons/32x32/'		
 		# http://forums.worldofwarcraft.com/images/icon/class/4.gif
 		# http://forums.worldofwarcraft.com/images/icon/race/3-0.gif
 		# http://forums.worldofwarcraft.com/images/icon/pvpranks/rank_default_0.gif
@@ -111,8 +110,6 @@ module Wowr
 		
 		@@arena_team_sizes = [2, 3, 5]
 
-		# TODO: Refactor, rethink and remove locale from all requests by passing unused options on to get_xml
-		
 		attr_accessor :character_name, :guild_name, :realm, :locale
 		
 		# You can set up the API with an optional default guild and realm
@@ -128,6 +125,7 @@ module Wowr
 		
 		
 		# General-purpose search
+		# All specific searches are wrappers around this method.
 		def search(options = {:search => nil, :type => nil})
 			if @@search_types.include? options[:type]
 				raise Wowr::Exceptions::InvalidSearchType.new
@@ -141,7 +139,7 @@ module Wowr
 			
 			results = []
 			
-			if (xml%'armorySearch'%'searchResults')
+			if (xml) && (xml%'armorySearch') && (xml%'armorySearch'%'searchResults')
 				case options[:type]
 				
 					# TODO: Filter stuff
@@ -184,18 +182,10 @@ module Wowr
 			return Wowr::Classes::CharacterSheet.new(xml)
 		end
 		
-		def get_character_list(min_level, klass)
-			
-		end
-		
-		# ??
-		def get_character_skills(options = {:character_name => @character_name, :realm => @realm})
-			compute_hash(options.merge(:url => @@character_skills_url)) || 
-				process_query(Wowr::Classes::Skill, @character_skills_url, false)			
-		end
 		
 		
 		# Guilds
+		# Note searches go across all realms by default
 		def search_guilds(options = {:search => @guild_name, :locale => @locale})
 			options.merge!(:type => @@search_types[:guild])
 			return search(options)
@@ -209,16 +199,17 @@ module Wowr
 		
 		
 		# Items
+		# Items are not realm-specific
 		def search_items(options = {:search => nil})
 			options.merge!(:type => @@search_types[:item])
 			return search(options)
 		end
 		
 		# TODO: Is not finding the item an exception or just return nil?
-		def get_item(options = {:item_id => nil, :locale => @locale})
+		#def get_item(options = {:item_id => nil, :locale => @locale})
 			
 			#return Wowr::Classes::ItemTooltip.new(xml%'itemTooltip')
-		end
+		#end
 		
 		def get_item_info(options = {:item_id => nil, :locale => @locale})
 			xml = get_xml(@@item_info_url, options)
@@ -331,6 +322,10 @@ module Wowr
 					errors.each do |error|
 						raise Wowr::Exceptions::raise_me(error[:errCode])
 					end
+				# elsif (doc%'page').nil?
+				# 	puts full_query
+				# 	puts response
+				# 	raise Wowr::Exceptions::EmptyPage
 				else
 					return (doc%'page')
 				end
@@ -342,14 +337,13 @@ module Wowr
 			
 		end
 		
-		# TODO: URL encoding of query strings
+		# :nodoc:
 		def u(str)
 			if str.instance_of?(String)
 				return CGI.escape(str)
 			else
 				return str
 			end
-			#stripslashes(str)
 		end
 	end
 end

data/lib/wowr/classes.rb

@@ -3,8 +3,7 @@
 # sourceType.questReward
 # sourceType.createdBySpell
 
-# TODO: Split up classes depending on subject?
-# Character, Item, Guild, ArenaTeam
+# TODO: Split up classes depending on subject?　　Character, Item, Guild, ArenaTeam
 
 
 # Wowr was written by Ben Humphreys!
@@ -12,6 +11,7 @@
 module Wowr
 	module Classes
 		
+		# Most basic 
 		# Composed of an ItemInfo and
 		# Needs to be consolidated with ItemInfo and other stuff
 		# to be a parent class that they extend?
@@ -28,6 +28,10 @@ module Wowr
 		
 		
 		# Short character info, used in guild lists etc.
+		# Note that the way that searches and character listings within guilds works,
+		# there can be a variable amount of information filled in within the class.
+		# Guild listings and search results contain a smaller amount of information than
+		# single queries
 		class Character
 			attr_reader :name, :level, :url, :rank,
 									:klass, :klass_id,
@@ -63,6 +67,8 @@ module Wowr
 				@relevance 		= elem[:relevance].to_i
 				@search_rank 	= elem[:searchRank].to_i
 				
+				# 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]
 				
 				# From ArenaTeam info, can be blank on normal requests
@@ -207,7 +213,7 @@ module Wowr
 		
 		
 		
-		# Note differences in values depending on class
+		# Second stat bar, depends on character class
 		class SecondBar
 			attr_reader :effective, :casting, :not_casting, :type
 			
@@ -500,7 +506,7 @@ module Wowr
 			end
 		end
 		
-		class Resilience			
+		class Resilience
 			attr_reader :damage_percent, :hit_percent, :value
 			
 			def initialize(elem)
@@ -522,7 +528,7 @@ module Wowr
 		end
 		
 		
-		# TODO: Array starting at 1?  Not sure if this is such a hot idea
+		# 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
 
@@ -594,25 +600,9 @@ module Wowr
 			end
 		end
 
-
-
-		# class Damage
-		#		:type, :min, :max, :speed, :dps
-		# end
-		# 
-		# class ItemSource
-		#		:area_id
-		#		:area_name
-		#		:creature_id
-		#		:creature_name
-		#		:difficulty
-		#		:drop_rate
-		#		:value
-		# end
 		
 		# A player guild containing members
-		# note not all of these will be filled out, depending on how the data is found
-		
+		# note not all of these will be filled out, depending on how the data is found		
 		class Guild
 			attr_reader :name, :url, :realm, :realm_url, :battle_group,
 									:roster_url, :stats_url, :stats_url_escape,
@@ -626,14 +616,14 @@ module Wowr
 					guild = elem
 				end
 				
-				@name = guild[:name]
-				@name_url = guild[:nameUrl]
-				@url = guild[:url]
-				@realm = guild[:realm]
-				@realm_url = guild[:realmUrl]
+				@name					= guild[:name]
+				@name_url			= guild[:nameUrl]
+				@url					= guild[:url]
+				@realm				= guild[:realm]
+				@realm_url		= guild[:realmUrl]
 				@battle_group = guild[:battleGroup]
-				@faction = guild[:faction]
-				@faction_id = guild[:factionId]
+				@faction			= guild[:faction]
+				@faction_id		= guild[:factionId].to_i
 				
 				# some shortened versions
 				if (elem%'guildInfo')
@@ -648,31 +638,6 @@ module Wowr
 		end
 		
 		
-		# class Guild
-		# 	attr_reader :name, :realm, :battle_group,
-		# 							:roster_url, :stats_url, :stats_url_escape,
-		# 							:members, :member_count
-		# 	
-		# 	def initialize(elem)
-		# 		@name = elem[:name]
-		# 		@realm = elem[:realm]
-		# 		@battle_group = elem[:battleGroup]
-		# 		@roster_url = elem[:rosterUrl]
-		# 		@stats_url = elem[:statsUrl]
-		# 		@stats_url_escape = elem[:statsUrlEscape]
-		# 		@member_count = (elem%'members')[:memberCount].to_i
-		# 		
-		# 		@members = []
-		# 		(elem%'members'/:character).each do |char|
-		# 			members << Character.new(char)
-		# 		end
-		# 	end
-		# end
-		
-		
-		
-		
-		
 		# General skill category
 		# eg Weapon Skills, Languages
 		class SkillCategory
@@ -738,7 +703,8 @@ module Wowr
 		
 		
 		# Provides detailed item information
-		# Reflects information found within item-tooltip.xml
+		# Note that the itemtooltip just returns an empty document when the item
+		# can't be found.
 		class ItemTooltip < Item
 			attr_reader :desc, :overall_quality_id, :bonding, :max_count, #:id, :name, :icon, 
 									:class_id, :bonuses, :item_source,
@@ -905,7 +871,6 @@ module Wowr
 			end
 		end
 
-
 		class ItemDamageData
 			attr_reader :type, :min, :max, :speed, :dps
 
@@ -1079,7 +1044,8 @@ module Wowr
 			end	
 		end
 		 
-		
+		# Cost can be gold or a set of required tokens
+		# See ItemCostToken
 		# <cost sellPrice="280" buyPrice="5600"></cost>
 		# <cost>
 		# 	<token icon="spell_holy_championsbond" id="29434" count="60"></token>
@@ -1293,7 +1259,6 @@ module Wowr
 				@icon_style		= elem[:iconStyle].to_i
 			end
 		end
-		
 				
 	end
 end

data/lib/wowr/exceptions.rb

@@ -11,6 +11,9 @@ module Wowr
 		class InvalidXML < StandardError
 		end
 		
+		class EmptyPage < StandardError
+		end
+		
 		# errCode="noCharacter"
 		class CharacterNotFound < StandardError
 		end
@@ -21,6 +24,9 @@ module Wowr
 		class GuildNotFound < StandardError
 		end
 		
+		class SearchError < StandardError
+		end
+		
 		class InvalidSearchType < StandardError
 		end
 		

data/lib/wowr/extensions.rb

@@ -1,15 +1,5 @@
 module Wowr
-	# All of these are shamelessly nicked from Ruby on Rails. 
-	# The String Extensions have a bit more fault tolerance.
 	module Extensions
-		module String
-			def to_time(form = :utc)
-				begin
-					::Time.send(form, *ParseDate.parsedate(self))
-				rescue TypeError
-					self
-				end
-			end
-		end
+
 	end
 end

metadata

@@ -1,49 +1,58 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: wowr
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2008-01-23 00:00:00 +00:00
-summary: An API wrapper for the World of Warcraft Armory.
-require_paths: 
-- lib
-email: benhumphreys @nospam@ gmail.com
-homepage: http://wowr.rubyforge.org/
-rubyforge_project: 
-description: Provides Ruby interface for retrieving item, character, guild and arena team info from the armory.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.1.2
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Ben Humphreys
+autorequire: 
+- wowr
+- hpricot
+bindir: bin
+cert_chain: []
+
+date: 2008-02-07 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Provides Ruby interface for retrieving item, character, guild and arena team info from the armory.
+email: benhumphreys @nospam@ gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - lib/wowr.rb
 - lib/wowr/classes.rb
 - lib/wowr/exceptions.rb
 - lib/wowr/extensions.rb
-test_files: []
-
+has_rdoc: true
+homepage: http://wowr.rubyforge.org/
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: An API wrapper for the World of Warcraft Armory.
+test_files: []