wowr 0.2.1 → 0.2.2

data/README

@@ -19,12 +19,14 @@ When initialising the library, it is possible to set a number of parameters to b
 
 # all parameters optional
 api = Wowr::API.new(:character_name => 'Foo',
-                  :guild_name => 'Bar',
-                  :realm => 'Baz',
-                  :locale => :eu) # defaults to US
+                    :guild_name => 'Bar',
+                    :realm => 'Baz',
+                    :locale => 'eu', # defaults to US www
+                    :lang => 'fr_fr', # remove for locale default language
+                    :caching => true # defaults to false)
 
 # Character requests
-my_char = api.get_character_sheet
+my_char = api.get_character_sheet # gets character with API default values
 char_boo = api.get_character_sheet(:character_name => 'Boo')
 chars = api.search_characters(:search => 'Cake')
 

data/lib/wowr.rb

@@ -15,17 +15,22 @@ require 'cgi'
 require 'fileutils' # for making directories :S
 
 # TODO: what does this do?
-#$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+# require 'lib/wowr/exceptions.rb'
+# require 'lib/wowr/extensions.rb'
+# require 'lib/wowr/classes.rb'
+
+require 'wowr/exceptions.rb'
+require 'wowr/extensions.rb'
+require 'wowr/classes.rb'
 
-require 'lib/wowr/exceptions.rb'
-require 'lib/wowr/extensions.rb'
-require 'lib/wowr/classes.rb'
 
 module Wowr
 	class API
 
-		@@armory_url = 'http://www.wowarmory.com/'
-		@@eu_armory_url = 'http://eu.wowarmory.com/'
+		@@armory_url_base = 'wowarmory.com/'
+		# @@eu_armory_url = 'http://eu.wowarmory.com/'
 		
 		@@search_url = 'search.xml'
 		
@@ -112,30 +117,49 @@ module Wowr
 		
 		@@arena_team_sizes = [2, 3, 5]
 
-		attr_accessor :character_name, :guild_name, :realm, :locale, :caching
+		attr_accessor :character_name, :guild_name, :realm, :locale, :lang, :caching, :debug
 		
 		# You can set up the API with an optional default guild and realm
 		# These will be used in all your API requests unless you specify otherwise
 		# For item requests, the locale will not matter in results, but may affect the speed of replies
 		# Caching is off by default
 		# TODO: are these nil declarations pointless?
-		def initialize(options = {:character_name => nil,
-															:guild_name => nil,
-															:realm => nil,
-															:locale => :us,
-															:caching => false})
+		# :character_name => nil,
+		# 													:guild_name => nil,
+		# 													:realm => nil,
+		# 													:locale => 'us',
+		# 													:caching => false,
+		# 													:debug => false
+		def initialize(options = {})
 			@character_name = options[:character_name]
 			@guild_name			= options[:guild_name]
 			@realm					= options[:realm]
-			@locale					= options[:locale] #|| :us
+			@locale					= options[:locale] || :us
 			@caching				= options[:caching]
+			
+			if (options[:lang].nil?)
+				@lang = 'default'
+			else
+				@lang					= options[:lang]
+			end
+						
+			@debug					= options[:debug]
 		end
 		
 		
+		# def self.test
+		# 	puts @debug
+		# 	puts @caching
+		# 	puts @locale
+		# end
+		
+				
 		# General-purpose search
 		# All specific searches are wrappers around this method.
 		# Caching is disabled for searching
 		def search(options = {:search => nil, :type => nil})
+			options = merge_defaults(options)
+			
 			if @@search_types.include? options[:type]
 				raise Wowr::Exceptions::InvalidSearchType.new
 			end
@@ -184,12 +208,17 @@ module Wowr
 		# Characters
 		# Note searches go across all realms by default
 		# Caching is disabled for searching
-		def search_characters(options = {:name => @character_name})
+		def search_characters(options = {:name => nil})
 			options.merge!(:type => @@search_types[:character])
 			return search(options)
 		end
 		
-		def get_character_sheet(options = {:character_name => @character_name, :realm => @realm, :caching => @caching})			
+		def get_character_sheet(options = {})
+			
+			options = {:character_name => @character_name}.merge(options) if (!@character_name.nil?)
+			
+			options = merge_defaults(options)
+					
 			xml = get_xml(@@character_sheet_url, options)
 			
 			# resist_types = ['arcane', 'fire', 'frost', 'holy', 'nature', 'shadow']
@@ -198,7 +227,6 @@ module Wowr
 			# 	@resistances[res] = Wowr::Classes::Resistance.new(xml%'resistances'%res)
 			# end
 			# puts @resistances.to_yaml
-			puts xml
 			return Wowr::Classes::CharacterSheet.new(xml)
 		end
 		
@@ -207,18 +235,24 @@ module Wowr
 		# Guilds
 		# Note searches go across all realms by default
 		# Caching is disabled for searching
-		def search_guilds(options = {:search => @guild_name, :locale => @locale})
-			options.merge!(:type => @@search_types[:guild])
+		def search_guilds(options = {:search => nil})
+			options.merge!(:type => @@search_types[:guild],
+										 :caching => false)
+			
 			return search(options)
 		end
 		
-		def get_guild(options = {:guild_name => @guild_name, :realm => @realm, :caching => @caching})
+		def get_guild(options = {})
+			# overwrite default with parameters, but only if the defaults aren't blank
+			options = {:guild_name => @guild_name}.merge(options) if (!@guild_name.nil?)
+			
+			options = merge_defaults(options)
+			
 			xml = get_xml(@@guild_info_url, options)
 			return Wowr::Classes::Guild.new(xml)
 		end
 		
 		
-		
 		# Items
 		# Items are not realm-specific
 		# Caching is disabled for searching
@@ -233,7 +267,9 @@ module Wowr
 			#return Wowr::Classes::ItemTooltip.new(xml%'itemTooltip')
 		#end
 		
-		def get_item_info(options = {:item_id => nil, :locale => @locale, :caching => @caching})
+		def get_item_info(options = {:item_id => nil})
+			options = merge_defaults(options)
+			
 			xml = get_xml(@@item_info_url, options)
 			if (xml%'itemInfo'%'item')
 				return Wowr::Classes::ItemInfo.new(xml%'itemInfo'%'item')
@@ -242,7 +278,9 @@ module Wowr
 			end
 		end
 		
-		def get_item_tooltip(options = {:item_id => nil, :caching => @caching})
+		def get_item_tooltip(options = {:item_id => nil})
+			options = merge_defaults(options)
+			
 			xml = get_xml(@@item_tooltip_url, options)
 			
 			# tooltip returns empty document when not found
@@ -262,7 +300,9 @@ module Wowr
 			return search(options)
 		end
 		
-		def get_arena_team(options = {:team_name => :nil, :team_size => nil, :realm => @realm, :caching => @caching})
+		def get_arena_team(options = {})
+			options = merge_defaults(options)
+			
 			if !@@arena_team_sizes.include?(options[:team_size])
 				raise Wowr::Exceptions::InvalidArenaTeamSize.new("Arena teams size must be: #{@@arena_team_sizes.inspect}")
 			end
@@ -287,10 +327,34 @@ module Wowr
 		end
 		
 		
+		
+		def merge_defaults(options = {})
+			# defaults[:name] = @charater_name if @charater_name
+			# defaults[:name] = @charater_name if @charater_name
+			defaults = {}
+			defaults[:realm] 		= @realm 		if @realm
+			defaults[:locale] 	= @locale 	if @locale
+			defaults[:lang] 		= @lang 		if @lang
+			defaults[:caching] 	= @caching 	if @caching
+			defaults[:debug] 		= @debug 		if @debug
+
+			# defaults = {:realm			=> @realm,
+			# 						:locale			=> @locale,
+			# 						:lang 			=> @lang,
+			# 						:caching		=> @caching,
+			# 						:debug			=> @debug}
+			
+			# overwrite defaults with any given options
+			defaults.merge!(options)
+		end
+		
+		
 		protected
 		
 		# TODO: pretty damn hacky
-		def get_xml(url, options = {:caching => @caching})
+		def get_xml(url, options = {})
+			# puts options.to_yaml
+			
 			# better way of doing this?
 			# Map custom keys to the HTTP request values 
 			reqs = {
@@ -315,20 +379,24 @@ module Wowr
 				query = '?' + params.join('&')
 			end
 			
-			locale = options[:locale] || @locale
+			# locale = options[:locale] || @locale
 			
-			base = self.base_url(locale)
+			base = self.base_url(options[:locale])
 			full_query = base + url + query
 			
-			#puts full_query
+			if options[:debug]
+				puts full_query
+			end
 			
 			if options[:caching]
-				response = get_cache(full_query)
+				response = get_cache(full_query, options)
 			else
 				response = http_request(full_query)
 			end
 			
-			# puts response
+			if options[:debug]
+				# puts response
+			end
 			
 			doc = Hpricot.XML(response)
 			begin
@@ -354,17 +422,25 @@ module Wowr
 		end
 		
 		# TODO Rename
-		def http_request(url)
-			req = Net::HTTP::Get.new(url)
+		def http_request(url, options = {})
+			
+			req = Net::HTTP::Get.new(url)#, headers)
 			req["user-agent"] = "Mozilla/5.0 Gecko/20070219 Firefox/2.0.0.2"
+			req["cookie"] = "cookieMenu=all; cookieLangId=" + options[:lang] + "; cookies=true;"
 			
 			uri = URI.parse(url)
 			
-		  http = Net::HTTP.new uri.host, uri.port
-		  http.start do
-		    res = http.request req
-				response = res.body
-		  end
+		  http = Net::HTTP.new(uri.host, uri.port)
+		
+			begin
+		
+			  http.start do
+			    res = http.request req
+					response = res.body
+			  end
+			rescue 
+				raise Wowr::Exceptions::ServerDoesNotExist.new('Specified server at ' + url + ' does not exist.');
+			end
 			
 			# tries = 0
 			# 			response = case res
@@ -408,17 +484,23 @@ module Wowr
 		end
 		
 		
-		def get_cache(url)
-			path = @@cache_directory_path + url_to_filename(url);
+		def get_cache(url, options = {})
+			
+			path = @@cache_directory_path + options[:lang] + '/' + url_to_filename(url)
 			
 			# file doesn't exist, make it
 			if !File.exists?(path)
+				if options[:debug]
+					puts 'Cache doesn\'t exist, making: ' + path
+				end
+				
+				FileUtils.mkdir_p(localised_cache_path(options[:lang])) unless File.directory?(localised_cache_path(options[:lang]))
 				
 				# TODO: Hacky
-				FileUtils.mkdir_p(@@cache_directory_path + 'us/') unless File.directory?(@@cache_directory_path + 'us/')
-				FileUtils.mkdir_p(@@cache_directory_path + 'eu/') unless File.directory?(@@cache_directory_path + 'eu/')
+				# FileUtils.mkdir_p(@@cache_directory_path + 'us/') unless File.directory?(@@cache_directory_path + 'us/')
+				# FileUtils.mkdir_p(@@cache_directory_path + 'eu/') unless File.directory?(@@cache_directory_path + 'eu/')
 				
-				xml_content = http_request(url)
+				xml_content = http_request(url, options)
 				
 				# write the cache
 				file = File.open(path, File::WRONLY|File::TRUNC|File::CREAT)
@@ -428,6 +510,10 @@ module Wowr
 			
 			# file exists, return the contents
 			else
+				if options[:debug]
+					puts 'Cache already exists, read: ' + path
+				end
+				
 				file = File.open(path, 'r')
 				xml_content = file.read
 				file.close
@@ -439,23 +525,33 @@ module Wowr
 		
 		# :nodoc:
 		# remove http://
+		# Kind of assuming incoming URL is the same as the current locale
 		def url_to_filename(url)
-			if (url.include?(@@armory_url))
-				path = 'us/' + url.gsub(@@eu_armory_url, '')
-			elsif (url.include?(@@eu_armory_url))
-				path = 'eu/' + url.gsub(@@eu_armory_url, '')
-			end
+			path = url[7..-1]
 			
+			
+			path = url.gsub(base_url, '')
+			# if (url.include?(@@armory_url))
+			# 	path = 'us/' + url.gsub(@@eu_armory_url, '')
+			# elsif (url.include?(@@eu_armory_url))
+			# 	path = 'eu/' + url.gsub(@@eu_armory_url, '')
+			# end
+			# 
 			return path
 		end
 		
 		
+		def localised_cache_path(lang = @lang)
+			@@cache_directory_path + lang
+		end
+		
+		
 		# :nodoc:
 		def base_url(locale = @locale)
-			if locale == :eu
-				@@eu_armory_url
+			if locale == :us
+				'http://www.' + @@armory_url_base
 			else
-				@@armory_url
+				'http://' + locale + '.' + @@armory_url_base
 			end
 		end
 		

data/lib/wowr/classes.rb

@@ -176,7 +176,15 @@ module Wowr
 				@battle_group = elem[:battleGroup]
 				
 				# format is February 11, 2008
-				@last_modified 	= elem[:lastModified] == "" ? nil : DateTime.parse(elem[:lastModified])
+				# except when it's korean, and then it's 2008년 5월 11일 (일)
+				# tw is 2008年5月11日 (2008年5月11日)
+				# TODO: Datetime doesn't parse other languages nicely
+				# 			Until then, just save it as a string
+				begin
+					@last_modified 	= elem[:lastModified] == "" ? nil : DateTime.parse(elem[:lastModified])
+				rescue
+					@last_modified 	= elem[:lastModified] == "" ? nil : elem[:lastModified]
+				end
 				#@last_modified = elem[:lastModified]#.to_time
 				
 				@arena_teams = []

data/lib/wowr/exceptions.rb

@@ -14,6 +14,9 @@ module Wowr
 		class EmptyPage < StandardError
 		end
 		
+		class ServerDoesNotExist < StandardError
+		end
+		
 		# errCode="noCharacter"
 		class CharacterNotFound < StandardError
 		end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wowr
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Ben Humphreys
@@ -57,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: wowr
-rubygems_version: 1.0.1
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: An API wrapper for the World of Warcraft Armory.