reve 0.1.0 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f791f5b67b627b79b4791339bc3c693b28822e4
+  data.tar.gz: d7f8b73f32992bd46f360df441ed714491b7f112
+SHA512:
+  metadata.gz: 053385d07e36ef01a9b16a467609def1fa136750703f066b36dc20c9b4de83c6cb1b361b9d05fa3234c88f463a3bb049e3b607d07e83f2d7d498f9a182a25794
+  data.tar.gz: d30853a03669ea1f8be250015fccfee75e1722593666a1eb684e1e4e2ede7cc23e2dea2f8ed6613abfb04444079f9f6801cebf974bac7ee5ce7d04c0f4189fd4

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 task :default => :redoc
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.3

data/lib/reve.rb

@@ -11,7 +11,7 @@ rescue LoadError
   require 'rubygems'
   require 'hpricot'
 end
-require 'net/http'
+require 'net/https'
 require 'uri'
 require 'cgi'
 require 'digest'
@@ -23,6 +23,7 @@ $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) ||
 require 'reve/exceptions'
 require 'reve/extensions'
 require 'reve/classes'
+require 'reve/processing_helpers'
 
 
 module Reve
@@ -45,58 +46,67 @@ module Reve
   # All API methods have the functionality to read XML from an arbitrary location. This could be another webserver, or a XML file on disk.
   # To use this pass the hash option :url => +location+ where +location+ is a String or URI class. See format_url_request documentation for more details.
   class API
+    BASE_URL = 'https://api.eveonline.com'
+    
+    @@characters_url                  = BASE_URL + '/account/Characters.xml.aspx'
+    @@account_status_url              = BASE_URL + '/account/AccountStatus.xml.aspx'
+
+    @@research_url                    = BASE_URL + '/char/Research.xml.aspx'
+    @@contracts_url                   = BASE_URL + '/char/Contracts.xml.aspx'
+    @@personal_notification_url       = BASE_URL + '/char/Notifications.xml.aspx'
+    @@personal_mailing_lists_url      = BASE_URL + '/char/mailinglists.xml.aspx'
+    @@personal_mail_messages_url      = BASE_URL + '/char/MailMessages.xml.aspx'
+    @@personal_mail_message_bodies_url= BASE_URL + '/char/MailBodies.xml.aspx'
+    @@personal_contacts_url           = BASE_URL + '/char/ContactList.xml.aspx'
+    @@personal_wallet_balance_url     = BASE_URL + '/char/AccountBalance.xml.aspx' 
+    @@personal_wallet_trans_url       = BASE_URL + '/char/WalletTransactions.xml.aspx'
+    @@personal_wallet_journal_url     = BASE_URL + '/char/WalletJournal.xml.aspx'
+    @@training_skill_url              = BASE_URL + '/char/SkillInTraining.xml.aspx'
+    @@skill_queue_url                 = BASE_URL + '/char/SkillQueue.xml.aspx'
+    @@character_sheet_url             = BASE_URL + '/char/CharacterSheet.xml.aspx'
+    @@personal_market_orders_url      = BASE_URL + '/char/MarketOrders.xml.aspx'
+    @@personal_industry_jobs_url      = BASE_URL + '/char/IndustryJobs.xml.aspx'
+    @@personal_assets_url             = BASE_URL + '/char/AssetList.xml.aspx'
+    @@personal_kills_url              = BASE_URL + '/char/KillLog.xml.aspx'
+    @@personal_faction_war_stats_url  = BASE_URL + '/char/FacWarStats.xml.aspx'
+    @@character_medals_url            = BASE_URL + '/char/Medals.xml.aspx'
+    @@upcoming_calendar_events_url    = BASE_URL + '/char/UpcomingCalendarEvents.xml.aspx'
+
+    @@member_tracking_url             = BASE_URL + '/corp/MemberTracking.xml.aspx'
+    @@corporate_wallet_balance_url    = BASE_URL + '/corp/AccountBalance.xml.aspx'
+    @@corporate_wallet_trans_url      = BASE_URL + '/corp/WalletTransactions.xml.aspx'
+    @@corporate_wallet_journal_url    = BASE_URL + '/corp/WalletJournal.xml.aspx'
+    @@starbases_url                   = BASE_URL + '/corp/StarbaseList.xml.aspx'
+    @@starbasedetail_url              = BASE_URL + '/corp/StarbaseDetail.xml.aspx'
+    @@corporation_sheet_url           = BASE_URL + '/corp/CorporationSheet.xml.aspx'
+    @@corporation_member_security_url = BASE_URL + '/corp/MemberSecurity.xml.aspx'
+    @@corporate_market_orders_url     = BASE_URL + '/corp/MarketOrders.xml.aspx'
+    @@corporate_industry_jobs_url     = BASE_URL + '/corp/IndustryJobs.xml.aspx'
+    @@corporate_assets_url            = BASE_URL + '/corp/AssetList.xml.aspx'
+    @@corporate_kills_url             = BASE_URL + '/corp/KillLog.xml.aspx'
+    @@corporate_faction_war_stats_url = BASE_URL + '/corp/FacWarStats.xml.aspx'
+    @@corporate_medals_url            = BASE_URL + '/corp/Medals.xml.aspx'
+    @@corp_member_medals_url          = BASE_URL + '/corp/MemberMedals.xml.aspx'
+    @@corporate_contacts_url          = BASE_URL + '/corp/ContactList.xml.aspx'
 
-    @@alliances_url                = 'http://api.eve-online.com/eve/AllianceList.xml.aspx'
-    @@sovereignty_url              = 'http://api.eve-online.com/map/Sovereignty.xml.aspx'
-    @@reftypes_url                 = 'http://api.eve-online.com/eve/RefTypes.xml.aspx'
-    @@skill_tree_url               = 'http://api.eve-online.com/eve/SkillTree.xml.aspx'
-    @@member_tracking_url          = 'http://api.eve-online.com/corp/MemberTracking.xml.aspx'
-    @@corporate_wallet_balance_url = 'http://api.eve-online.com/corp/AccountBalance.xml.aspx'
-    @@personal_wallet_balance_url  = 'http://api.eve-online.com/char/AccountBalance.xml.aspx'
-    @@corporate_wallet_trans_url   = 'http://api.eve-online.com/corp/WalletTransactions.xml.aspx'
-    @@personal_wallet_trans_url    = 'http://api.eve-online.com/char/WalletTransactions.xml.aspx'
-    @@corporate_wallet_journal_url = 'http://api.eve-online.com/corp/WalletJournal.xml.aspx'
-    @@personal_wallet_journal_url  = 'http://api.eve-online.com/char/WalletJournal.xml.aspx'
-    @@characters_url               = 'http://api.eve-online.com/account/Characters.xml.aspx'
-    @@training_skill_url           = 'http://api.eve-online.com/char/SkillInTraining.xml.aspx'
-    @@skill_queue_url              = 'http://api.eve-online.com/char/SkillQueue.xml.aspx'
-    @@character_sheet_url          = 'http://api.eve-online.com/char/CharacterSheet.xml.aspx'
-    @@starbases_url                = 'http://api.eve-online.com/corp/StarbaseList.xml.aspx'
-    @@starbasedetail_url           = 'http://api.eve-online.com/corp/StarbaseDetail.xml.aspx'
-    @@conqurable_outposts_url      = 'http://api.eve-online.com/eve/ConquerableStationList.xml.aspx'
-    @@corporation_sheet_url        = 'http://api.eve-online.com/corp/CorporationSheet.xml.aspx'
-    @@corporation_member_security_url = 'http://api.eve-online.com/corp/MemberSecurity.xml.aspx'
-    @@errors_url                   = 'http://api.eve-online.com/eve/ErrorList.xml.aspx'
-    @@map_jumps_url                = 'http://api.eve-online.com/map/Jumps.xml.aspx'
-    @@map_kills_url                = 'http://api.eve-online.com/map/Kills.xml.aspx'
-    @@personal_market_orders_url   = 'http://api.eve-online.com/char/MarketOrders.xml.aspx'
-    @@corporate_market_orders_url  = 'http://api.eve-online.com/corp/MarketOrders.xml.aspx'
-    @@personal_industry_jobs_url   = 'http://api.eve-online.com/char/IndustryJobs.xml.aspx'
-    @@corporate_industry_jobs_url  = 'http://api.eve-online.com/corp/IndustryJobs.xml.aspx'
-    @@personal_assets_url          = 'http://api.eve-online.com/char/AssetList.xml.aspx'
-    @@corporate_assets_url         = 'http://api.eve-online.com/corp/AssetList.xml.aspx'
-    @@personal_kills_url           = 'http://api.eve-online.com/char/KillLog.xml.aspx'
-    @@corporate_kills_url          = 'http://api.eve-online.com/corp/KillLog.xml.aspx'
-    @@character_id_url             = 'http://api.eve-online.com/eve/CharacterID.xml.aspx'   # ?names=CCP%20Garthagk
-    @@character_name_url           = 'http://api.eve-online.com/eve/CharacterName.xml.aspx' # ?ids=797400947
-    @@personal_faction_war_stats_url= 'http://api.eve-online.com/char/FacWarStats.xml.aspx'
-    @@corporate_faction_war_stats_url= 'http://api.eve-online.com/corp/FacWarStats.xml.aspx'
-    @@general_faction_war_stats_url= 'http://api.eve-online.com/eve/FacWarStats.xml.aspx'
-    @@top_faction_war_stats_url    = 'http://api.eve-online.com/eve/FacWarTopStats.xml.aspx'
-    @@faction_war_occupancy_url    = 'http://api.eve-online.com/map/FacWarSystems.xml.aspx'
-    @@certificate_tree_url         = 'http://api.eve-online.com/eve/CertificateTree.xml.aspx'
-    @@character_medals_url         = 'http://api.eve-online.com/char/Medals.xml.aspx'
-    @@corporate_medals_url         = 'http://api.eve-online.com/corp/Medals.xml.aspx'
-    @@corp_member_medals_url       = 'http://api.eve-online.com/corp/MemberMedals.xml.aspx'
-    @@server_status_url            = 'http://api.eve-online.com/Server/ServerStatus.xml.aspx'
-    @@research_url                 = 'http://api.eve-online.com/char/Research.xml.aspx'
-    @@personal_notification_url    = 'http://api.eve-online.com/char/Notifications.xml.aspx'
-    @@personal_mailing_lists_url   = 'http://api.eve-online.com/char/mailinglists.xml.aspx'
-    @@personal_mail_messages_url   = 'http://api.eve-online.com/char/MailMessages.xml.aspx'
-    @@personal_contacts_url        = 'http://api.eve-online.com/char/ContactList.xml.aspx'
-    @@corporate_contacts_url       = 'http://api.eve-online.com/corp/ContactList.xml.aspx'
-    @@account_status_url           = 'http://api.eve-online.com/account/AccountStatus.xml.aspx'
-    @@character_info_url           = 'http://api.eve-online.com/eve/CharacterInfo.xml.aspx'
+    @@alliances_url                   = BASE_URL + '/eve/AllianceList.xml.aspx'
+    @@reftypes_url                    = BASE_URL + '/eve/RefTypes.xml.aspx'
+    @@skill_tree_url                  = BASE_URL + '/eve/SkillTree.xml.aspx'
+    @@conqurable_outposts_url         = BASE_URL + '/eve/ConquerableStationList.xml.aspx'
+    @@errors_url                      = BASE_URL + '/eve/ErrorList.xml.aspx'
+    @@character_id_url                = BASE_URL + '/eve/CharacterID.xml.aspx'   # ?names=CCP%20Garthagk
+    @@general_faction_war_stats_url   = BASE_URL + '/eve/FacWarStats.xml.aspx'
+    @@top_faction_war_stats_url       = BASE_URL + '/eve/FacWarTopStats.xml.aspx'
+    @@certificate_tree_url            = BASE_URL + '/eve/CertificateTree.xml.aspx'
+    @@character_name_url              = BASE_URL + '/eve/CharacterName.xml.aspx' # ?ids=797400947
+    @@character_info_url              = BASE_URL + '/eve/CharacterInfo.xml.aspx'
+    
+    @@sovereignty_url                 = BASE_URL + '/map/Sovereignty.xml.aspx'
+    @@map_jumps_url                   = BASE_URL + '/map/Jumps.xml.aspx'
+    @@map_kills_url                   = BASE_URL + '/map/Kills.xml.aspx'
+    @@faction_war_occupancy_url       = BASE_URL + '/map/FacWarSystems.xml.aspx'
+    
+    @@server_status_url               = BASE_URL + '/Server/ServerStatus.xml.aspx'    
     
     cattr_accessor :character_sheet_url, :training_skill_url, :characters_url, :personal_wallet_journal_url,
                    :corporate_wallet_journal_url, :personal_wallet_trans_url, :corporate_wallet_trans_url,
@@ -111,15 +121,14 @@ module Reve
                    :certificate_tree_url, :character_medals_url, :corporate_medals_url, 
                    :corp_member_medals_url, :server_status_url, :skill_queue_url, :corporation_member_security_url,
                    :personal_notification_url, :personal_mailing_lists_url, :personal_mail_messages_url,
-                   :research_url, :personal_contacts_url, :corporate_contacts_url,
-                   :account_status_url, :character_info_url
-
+                   :personal_mail_message_bodies_url, :research_url, :personal_contacts_url, :corporate_contacts_url,
+                   :account_status_url, :character_info_url, :upcoming_calendar_events_url
 
     attr_accessor :key, :keyid, :cak, :charid
     alias :userid :keyid
     alias :userid= :keyid=
     attr_accessor :http_user_agent, :save_path, :timeout
-    attr_reader :current_time, :cached_until, :last_hash, :reve_version
+    attr_reader :current_time, :cached_until, :last_hash, :last_xml, :reve_version
     
     # Create a new API instance.
     # current_time and cached_until are meaningful only for the LAST call made.
@@ -145,6 +154,7 @@ module Reve
       @current_time = nil
       @cached_until = nil
       @last_hash = nil
+      @last_xml  = nil
       @reve_version = File.read(File.join(File.dirname(__FILE__),'../','VERSION')).chomp
       @http_user_agent = "Reve v#{@reve_version}; http://github.com/lisa/reve"
     end
@@ -196,14 +206,24 @@ module Reve
     # Expects a Hash as a parameter with these keys:
     # * ids ( Array ) - An Array of Character IDs to fetch the names of.
     # See Also: character_name, Reve::Classes::Character, character_sheet
-    def character_name(opts = {})
+
+    def ids_to_names(opts = {})
       ids = opts[:ids] || []
-      return [] if ids.empty?
+      return [] if ids.empty? #No ids where passed
       opts[:ids] = ids.join(',')
-      compute_hash(  opts.merge(:url => @@character_name_url) ) ||
-        process_query(Reve::Classes::Character,opts[:url] || @@character_name_url,false,opts)
-    end
-
+      args = postfields(opts)
+      h = compute_hash(  opts.merge(:url => @@character_name_url) )
+      return h if h
+      xml = process_query(nil,opts[:url] || @@character_name_url, true,opts)
+      ret = []
+        xml.search("//rowset/row").each do |elem|
+          ret << Reve::Classes::Character.new(elem)
+        end
+        ret
+      end      
+    
+    alias_method :character_name, :ids_to_names
+    
     # Return a list of Alliances and member Corporations from
     # http://api.eve-online.com/eve/AllianceList.xml.aspx
     # Use the corporation_sheet method to get information for each member
@@ -394,6 +414,20 @@ module Reve
       process_query(Reve::Classes::Research,opts[:url] || @@research_url,false,args)      
     end
 
+    #
+    #gets contracts
+    # http://api.eve-online/char/Contracts.xml.aspx
+    # * characterid ( Integer | String ) - Get stats for this Character
+    # See also: Reve::Classes::Contract
+
+    def contracts(opts = { :characterid => nil })
+      args = postfields(opts)
+      h = compute_hash(args.merge(:url => @@contracts_url))
+      return h if h
+      process_query(Reve::Classes::Contracts,opts[:url] || @@contracts_url,false,args)      
+    end
+
+
     # Gets one's own personal WalletBalance from
     # http://api.eve-online.com/char/AccountBalance.xml.aspx
     # Expects:
@@ -953,12 +987,63 @@ module Reve
     # * characterid ( Integer | String ) - Get the MailMessages for this Character
     # See also: Reve::Classes::MailMessage
     def personal_mail_messages(opts = { :characterid => nil })
+      with_bodies = opts.include?(:with_bodies) ? opts.delete(:with_bodies) : false
       args = postfields(opts)
       h = compute_hash(args.merge(:url => @@personal_mail_messages_url))
       return h if h
-      process_query(Reve::Classes::MailMessage, opts[:url] || @@personal_mail_messages_url,false,args)
+      messages = process_query(Reve::Classes::MailMessage, opts[:url] || @@personal_mail_messages_url,false,args)
+      if with_bodies
+        ids = messages.collect{|m| m.id }
+        bodies = personal_mail_message_bodies(:ids => ids)
+        messages.each do |msg|
+          # For now we are ignoring messages that come back saying
+          # body is missing. So use fetch to assign body to message
+          msg.body = bodies.fetch(msg.id.to_s, nil)
+        end
+      end
+      messages
+    end
+
+    # Gets the bodies for mail messages. NB this API call does not
+    # return objects.  It returns a hash with messageID strings as the keys -
+    # suitable for merging into a Reve::Classes::MailMessage object
+    # 
+    # Note from the Eve API docs: 
+    #   Bodies cannot be accessed if you have not called for their headers recently.
+    # 
+    # Expects:
+    # * ids ( List of Integers ) - List of message ids for which we want bodies
+    # See also: Reve::Classes::MailMessage
+    def personal_mail_message_bodies(opts = { :ids => [] })
+      args = postfields(opts)
+      h = compute_hash(args.merge(:url => @@personal_mail_message_bodies_url))
+      return h if h
+      just_xml = true
+      xml = process_query(Reve::Classes::MailMessage, opts[:url] || @@personal_mail_message_bodies_url,just_xml,args)
+      results = {}
+      xml.search("//rowset/row").each do |el| 
+        results[el.attributes['messageID']] = el.inner_text
+      end
+      results
+    end
+
+
+
+
+    #Gets upcoming calendar events
+    #Reve::Classes::UpcomingCalendarEvents
+    def upcoming_calendar_events(opts = { :characterid => nil })
+      args = postfields(opts)
+      h = compute_hash(args.merge(:url => @@upcoming_calendar_events_url))
+      return h if h
+      process_query(Reve::Classes::UpcomingCalendarEvents, opts[:url] || @@upcoming_calendar_events_url,false,args)
     end
 
+
+
+
+
+
     # Gets the status of the selected account. Returns
     # Reve::Classes::AccountStatus
     def account_status(opts = {})
@@ -979,196 +1064,7 @@ module Reve
       Reve::Classes::CharacterInfo.new(xml.search('//result').first)
     end
 
-    protected
-    # Helper method to handle nested assets
-    def recur_through_assets(rows)
-      assets = []
-      rows.each do |container|
-        unless container.empty?  
-          asset_container = Reve::Classes::AssetContainer.new(container)
-          asset_container.assets = self.recur_through_assets(container.search("/rowset/row"))
-          assets << asset_container 
-        else
-          assets << Reve::Classes::Asset.new(container)
-        end
-      end 
-      assets
-    end
-    
-    # Sets up the post fields for Net::HTTP::Get hash for process_query method.
-    # See also format_url_request
-    # TODO: Consider moving this whole thing into process_query to avoid 
-    # calling this in every method!
-    def postfields(opts = {})
-      baseargs = { :characterid => @charid }
-      if @cak
-        baseargs[:keyid] = @keyid
-        baseargs[:vcode] = @key
-      else
-        baseargs[:userid] = @keyid
-        baseargs[:apikey] = @key
-      end
-      ret = opts.clone
-      baseargs.each do |k,v|
-        if ret[k].nil?
-          ret[k] = v
-        end
-      end
-      ret.inject({}) do |n, (k,v)|
-        n[k.downcase] = v.to_s if v
-        n
-      end
-    end
-    
-    # Creates a hash for some hash of postfields. For each API method pass 
-    # :just_hash => to something to return a hash that can be matched to 
-    # the last_hash instance method created in process_query.
-    # This method is called in each API method before process_query and if 
-    # :just_hash was passed in args then a String will be returned, otherwise
-    # nil will be returned
-    # TODO: Consider moving this whole thing into process_query before the URI parsing
-    def compute_hash(args = {})
-      args.stringify_keys!
-      return nil unless args.include?('just_hash')
-      args.delete('just_hash')
-      url = args['url'].kind_of?(URI) ? args['url'].path : args['url']
-      args.delete('url')
-      spl = url.split '/'
-      ret = (spl[-2] + '/' + spl[-1]) + ':'
-      args.delete_if { |k,v| (v || "").to_s.length == 0 } # Delete keys if the value is nil
-      h = args.stringify_keys
-      ret += h.sort.flatten.collect{ |e| e.to_s }.join(':')
-      ret.gsub(/:$/,'')
-    end
-
-    # Processes a URL and for simple <rowset><row /><row /></rowset> results
-    # create an array of objects of type klass. Or just return the XML if
-    # just_xml is set true. args is from postfields
-    # This method will call check_exception to see if an Exception came from
-    # CCP.
-    # Expects:
-    # * klass ( Class ) - The class container for parsing. An array of these is returned in default behaviour.
-    # * url ( String ) - API URL
-    # * just_xml ( Boolean ) - Return only the XML and not attempt to parse //rowset/row. Useful if the XML is not in that form.
-    # * args ( Hash ) - Hash of arguments for the request. See postfields method.
-    def process_query(klass, url, just_xml = false, opts = {})
-
-      #args = postfields(opts)
-      #h = compute_hash(args.merge(:url => url))
-      #return h if h
-
-      @last_hash = compute_hash(opts.merge({:url => url, :just_hash => true })) # compute hash
-
-
-      xml = check_exception(get_xml(url,opts))
-      save_xml(xml) if @save_path
-
-      return xml if just_xml
-      return [] if xml.nil? # No XML document returned. We should panic.
-      
-      # Create the array of klass objects to return, assume we start with an empty set from the XML search for rows
-      # and build from there.
-      xml.search("//rowset/row").inject([]) { |ret,elem| ret << klass.new(elem) }
-    end
-    
-    # Turns a hash into ?var=baz&bam=boo
-    def format_url_request(opts)
-      req = "?"
-
-      opts.stringify_keys!
-      opts.keys.sort.each do |key|
-        req += "#{CGI.escape(key.to_s)}=#{CGI.escape(opts[key].to_s)}&" if opts[key]
-      end
-      req.chop # We are lazy and append a & to each pair even if it's the last one. FIXME: Don't do this.
-    end
-    
-    
-    # Gets the XML from a source.
-    # Expects:
-    # * source ( String | URI ) - If the +source+ is a String Reve will attempt to load the XML file from the local filesystem by the path specified as +source+. If the +source+ is a URI or is a String starting with http (lowercase) Reve will fetch it from that URI on the web.
-    # * opts ( Hash ) - Hash of parameters for the request, such as keyid, vcode and such.
-    # NOTE: To override the lowercase http -> URI rule make the HTTP part uppercase.
-    def get_xml(source,opts)
-      xml = ""
-      
-      # Let people still pass Strings starting with http.
-      if source =~ /^http/
-        source = URI.parse(source)
-      end
-      
-      if source.kind_of?(URI)
-        opts.merge({ :version => 2, :url => nil }) #the uri bit will now ignored in format_url_request
-        req_args =  format_url_request(opts)
-        req = Net::HTTP::Get.new(source.path + req_args)
-        req['User-Agent'] = @http_referer_agent || "Reve v#{@reve_version}; http://github.com/lisa/reve"
-        
-        res = nil
-        response = nil
-        1.upto(@max_tries) do |try|
-          begin
-            # ||= to prevent making a new Net::HTTP object, the res = nil above should reset this for the next request.
-            # the request needs to be here to rescue exceptions from it.
-            http ||= Net::HTTP.new(source.host, source.port)
-            http.open_timeout = 3
-            http.read_timeout = @timeout
-            res = http.start {|http| http.request(req) }
-            case res
-            when Net::HTTPSuccess, Net::HTTPRedirection
-              response = res.body
-            end
-          rescue Exception
-            sleep 5
-            next
-          end
-          break if response
-        end
-        raise Reve::Exceptions::ReveNetworkStatusException.new( (res.body rescue "No Response Body!") ) unless response
-        
-        xml = response
-      
-      # here ends test for URI
-      elsif source.kind_of?(String)
-        xml = File.open(source).read
-      else
-        raise Reve::Exceptions::ReveNetworkStatusException.new("Don't know how to deal with a #{source.class} XML source. I expect a URI or String")
-      end
-      xml
-    end
-
-    # Raises the proper exception (if there is one), otherwise it returns the
-    # XML response.
-    def check_exception(xml)
-      x = Hpricot::XML(xml)
-      begin
-        out = x.search("//error") # If this fails then there are some big problems with Hpricot#search ?
-      rescue Exception => e 
-        $stderr.puts "Fatal error ((#{e.to_s})): Couldn't search the XML document ((#{xml})) for any potential error messages! Is your Hpricot broken?"
-        exit 1
-      end
-      @current_time = (x/:currentTime).inner_html.to_time rescue Time.now.utc # Shouldn't need to rescue this but one never knows
-      @cached_until = (x/:cachedUntil).inner_html.to_time rescue nil # Errors aren't always cached
-      return x if out.size < 1
-      code = out.first['code'].to_i
-      str  = out.first.inner_html
-      Reve::Exceptions.raise_it(code,str)
-    end
-    
-    def save_xml(xml)
-      path = build_save_filename
-      FileUtils.mkdir_p(File.dirname(path))
-      File.open(path,'w') { |f| f.print xml.to_original_html }
-    end
-    def build_save_filename
-      method = caller(3).first.match(/\`(.+)'/)[1] # Get the API method that's being called. This is called from save_xml -> process_query -> :real_method
-      File.join(@save_path,@keyid.to_s,method,( @cached_until || Time.now.utc).to_i.to_s + '.xml')
-    end
-
-    # Returns an array of +klass+
-    def pull_out_top_10_data(xml,klass,kind,field)
-      xml.search("/eveapi/result/#{kind}/rowset[@name='#{field}']/row").inject([]) do |all,row|
-        all << klass.new(row)
-        all
-      end
-    end
+    #protected
+    include ProcessingHelpers
   end
 end