reve 0.0.74 → 0.0.76

data/Rakefile

@@ -18,7 +18,7 @@ Rake::RDocTask.new("doc") { |rdoc|
   rdoc.options << '--line-numbers' << '--inline-source' << '--all'
   rdoc.rdoc_files.include('./ChangeLog')
   rdoc.rdoc_files.include('*.rb')
-  rdoc.rdoc_files.include('lib/*.rb')
+  rdoc.rdoc_files.include('lib/**/*.rb')
   rdoc.rdoc_files.include('test/**/*')
 }
 
@@ -30,7 +30,7 @@ spec = Gem::Specification.new do |s|
   s.homepage = "http://revetrac.crudvision.com"
   s.platform = Gem::Platform::RUBY
   s.summary = "Reve is a Ruby library to interface with the Eve Online API"
-  s.files = FileList["Rakefile","lib/*.rb","reve.rb","tester.rb","init.rb"].to_a
+  s.files = FileList["Rakefile","lib/**/*.rb","reve.rb","tester.rb","init.rb"].to_a
   s.require_path = "lib"
   s.test_files = FileList["test/test_reve.rb","test/xml/**/*.xml"].to_a
   s.has_rdoc = true

data/lib/reve/classes.rb

@@ -0,0 +1,839 @@
+#--
+# Code copyright Lisa Seelye, 2007-2008. www.crudvision.com
+# Reve is not licensed for commercial use. For other uses there are no
+# restrictions.
+#
+# The author is not adverse to tokens of appreciation in the form of Eve ISK,
+# ships, and feedback. Please use
+# http://www.crudvision.com/reve-ruby-eve-online-api-library/ to provide
+# feedback or send ISK to Raquel Smith in Eve. :-)
+#++
+module Reve #:nodoc:
+  module Classes #:nodoc:
+    
+    # Represents an Alliance as it appears in the Reve::API#alliances call.
+    # Attributes
+    # * name ( String ) - Full Name of the Alliance
+    # * short_name ( String ) - Short name (ticker) of the Alliance
+    # * id ( Fixnum ) - The Alliance's Eve-Online ID
+    # * executor_corp_id ( Fixnum ) - ID of the Corporation that's in charge of the Alliance
+    # * member_count ( Fixnum ) - The number of members that are in the Alliance
+    # * start_date ( Time ) - When the Alliance was formed.
+    # * member_corporations ( [Corporation] ) - Array of the Corporation objects that belong to the Alliance.
+    class Alliance
+      attr_reader :name, :short_name, :id, :executor_corp_id, :member_count, :start_date
+      attr_accessor :member_corporations
+      def initialize(elem) #:nodoc:
+        @name             = elem['name']
+        @short_name       = elem['shortname']
+        @id               = elem['allianceid'].to_i
+        @executor_corp_id = elem['executorcorpid'].to_i
+        @member_count     = elem['membercount'].to_i
+        @start_date       = elem['startdate'].to_time
+        @member_corporations = []
+      end
+    end
+
+    # Only for use in Alliance class (member_corporations array) from the Reve::API#alliances call
+    # Attributes
+    # * id ( Fixnum ) - ID of the Corporation (use this in the Reve::API#corporation_sheet call)
+    # * start_date ( Time ) - When the Corporation was started?
+    class Corporation
+      attr_reader :id, :start_date
+      def initialize(elem) #:nodoc:
+        @id = elem['corporationid'].to_i
+        @start_date = elem['startdate'].to_time
+      end      
+    end
+    
+    # A Skill has a RequiredAttribute, either a PrimaryAttribute or SecondaryAttribute, which both derrive from this.
+    # Attributes
+    # * name ( String ) - Name of the required Attribute
+    # See Also: PrimaryAttribute, SecondaryAttribute, Skill, Reve::API#skill_tree
+    class RequiredAttribute
+      attr_reader :name
+      def initialize(attrib) #:nodoc:
+        @name = attrib
+      end
+    end
+    # Denotes the PrimaryAttribute of the RequiredAttribute pair for a Skill. See also
+    # SecondaryAttribute and RequiredAttribute
+    class PrimaryAttribute < RequiredAttribute
+    end
+    # Denotes the SecondaryAttribute of the RequiredAttribute pair for a Skill. See also
+    # PrimaryAttribute and RequiredAttribute
+    class SecondaryAttribute < RequiredAttribute
+    end
+    
+    # Represents the victim of a Kill.
+    # Attributes:
+    # * id ( Fixnum ) - ID of the Character that was killed.
+    # * name ( String ) - The name of the Character that was killed.
+    # * corporation_id ( Fixnum ) - The ID of the Corporation that the victim belongs to.
+    # * alliance_id ( Fixnum | NilClass ) - The ID of the Alliance that the victim belongs to, if applicable. Will be nil unless the victim was in an Alliance
+    # * damage_taken ( Fixnum ) - The amount of damage the victim took before being killed.
+    # * ship_type_id ( Fixnum ) - ID of the ship type (references CCP data dump) that the victim was flying.
+    # See Also: KillAttacker, Kill, KillLoss, Reve::API#personal_kills, Reve::API#corporate_kills
+    class KillVictim
+      attr_reader :id, :name, :corporation_id, :corporation_name, :alliance_id, :damage_taken, :ship_type_id
+      def initialize(elem) #:nodoc:
+        @id = elem['characterid'].to_i
+        @name = elem['charactername']
+        @corporation_id = elem['corporationname']
+        @alliance_id = elem['allianceid'] == "0" ? nil : elem['allianceid'].to_i
+        @damage_taken = elem['damagetaken'].to_i
+        @ship_type_id = elem['shiptypeid'].to_i
+      end
+    end
+    
+    # It's possible to be killed/attacked by an NPC. In this case character_id, character_name, 
+    # alliance_id, alliance_name and weapon_type_id will be nil
+    # Represents an attacker (attacking a KillVictim) in a Kill
+    # Attributes
+    # * id ( Fixnum | NilClass ) - ID of the attacker; nil if the attacker was an NPC or not a Character
+    # * name ( String | NilClass ) - Name of the attacker; nil if the attacker was an NPC or not a Character
+    # * corporation_id ( Fixnum ) - ID of the Corporation that the Character belongs to (could be NPC Corporation!)
+    # * corporation_name ( String ) - Name of the Corporation that the Character belongs to (could be NPC Corporation!)
+    # * alliance_id ( Fixnum | NilClass ) - ID of the Alliance that the Character belongs to (nil if the KillAttacker doesn't belong to an Alliance)
+    # * security_status ( Float ) - Security status of the KillAttacker
+    # * damage_done ( Fixnum ) - How much damage the KillAttacker did.
+    # * final_blow ( Boolean ) - True if this KillAttacker got the final blow to kill the KillVictim
+    # * weapon_type_id ( Fixnum | NilClass ) - Type ID of the (a?) weapon the KillAttacker was firing. (Refer to CCP database dump invtypes)
+    # * ship_type_id ( Fixnum ) - Type ID of the ship the KillAttacker was flying. (Refer to CCP database dump invtypes)
+    # See Also: Kill, KillLoss, KillVictim, Reve::API#personal_kills, Reve::API#corporate_kills
+    class KillAttacker
+      attr_reader :id, :name, :corporation_id, :corporation_name, :alliance_id, :alliance_name,
+                  :security_status, :damage_done, :final_blow, :weapon_type_id, :ship_type_id
+      def initialize(elem) #:nodoc:
+        @id = elem['characterid'] == "0" ? nil : elem['characterid'].to_i
+        @name = elem['charactername'].empty? ? nil : elem['charactername']
+        @corporation_id = elem['corporationid'].to_i
+        @corporation_name = elem['corporationname']
+        @alliance_id = elem['allianceid'] == "0" ? nil : elem['allianceid'].to_i
+        @alliance_name = elem['alliancename'].empty? ? nil : elem['alliancename']
+        @security_status = elem['securitystatus'].to_f
+        @damage_done = elem['damagedone'].to_i
+        @final_blow = elem['finalblow'] == "1"
+        @weapon_type_id = elem['weapontypeid'] == "0" ? nil : elem['weapontypeid'].to_i
+        @ship_type_id = elem['shiptypeid'].to_i
+      end
+    end
+    
+    # A model to represent losses from being killed.
+    # Attributes
+    # * type_id ( Fixnum ) - Type ID of the KillLoss. (Refer to CCP database dump invtypes)
+    # * flag ( Fixnum ) - A flag to denoe some special qualities of the KillLoss such as where it was mounted or if it was in a container. Refer to http://wiki.eve-dev.net/API_Inventory_Flags
+    # * quantity_dropped ( Fixnum ) - The number of +type_id+ that were dropped for looting - e.g., not destroyed.
+    # * quantity_destroyed ( Fixnum ) - The number of +type_id+ that were destroyed in the Kill.
+    # * contained_losses ( [KillLoss] ) - If the KillLoss was a container (refer to +type_id+) then this array will be populated with a list of KillLoss objects that were inside the container.
+    # See Also: Kill, KillAttacker, KillVictim, Reve::API#personal_kills, Reve::API#corporate_kills
+    class KillLoss
+      attr_reader :type_id, :flag, :quantity_dropped, :quantity_destroyed
+      attr_accessor :contained_losses
+      def initialize(elem)
+        @type_id = elem['typeid'].to_i
+        @flag = elem['flag'].to_i
+        @quantity_dropped = elem['qtydropped'].to_i
+        @quantity_destroyed = elem['qtydestroyed'].to_i
+        @contained_losses = []        
+      end
+    end
+    
+    
+    # Simple class to contain the information relevant to a single Kill.
+    # Comprised of an array of KillLoss, an array of KillAttacker and one KillVictim
+    # Attributes
+    # * victim ( KillVictim ) - Instance of the KillVictim class to represent the victim of the Kill.
+    # * attackers ( [KillAttacker] ) - Array of KillAttacker objects that represent the people who killed the +victim+.
+    # * losses ( [KillLoss] ) - Array of KillLoss objects that represents the +victim+'s items destroyed in the Kill.
+    # * system_id ( Fixnum ) - The ID of the System that the Kill took place in.
+    # * id ( Fixnum ) - The ID of this specific Kill
+    # * moon_id ( Fixnum | NilClass ) - The ID of the Moon that this kill happened at (due to a POS?), if any; nil otherwise.
+    # See Also: KillAttacker, KillVictim, KillLoss, Reve::API#personal_kills, Reve::API#corporate_kills
+    class Kill
+      attr_reader :victim, :attackers, :losses
+      attr_reader :system_id, :created_at, :id, :moon_id
+      def initialize(elem, victim, attackers, losses) #:nodoc:
+        @victim, @attackers, @losses = victim, attackers, losses
+        @system_id = elem['solarsystemid'].to_i
+        @created_at = elem['killtime'].to_time
+        @id = elem['killid'].to_i
+        @moon_id = elem['moonid'] == "0" ? nil : elem['moonid'].to_i
+      end
+    end
+    
+    
+    # A container or singleton (unpackaged thing).
+    # Attributes
+    # * item_id ( Fixnum ) - A CCP-specific ID for the Asset/AssetContainer
+    # * location_id ( Fixnum ) - The ID of the Station (or POS?) that the Asset/AssetContainer is at.
+    # * type_id ( Fixnum ) - Type ID of the Asset/AssetContainer. (Refer to CCP database dump invtypes)
+    # * quantity ( Fixnum ) - The number of Asset/AssetContainer at this +location_id+
+    # * flag ( Fixnum ) - Inventory flag, refer to http://wiki.eve-dev.net/API_Inventory_Flags (See also KillLoss's flag)
+    # * singleton ( Boolean ) - True if the Asset/AssetContainer is not packaged up.
+    # * assets ( [Asset] ) - A list of Asset objects that are contained in this AssetContainer.
+    # See Also: Asset, Reve::API#corporate_assets_list, Reve::API#personal_assets_list
+    class AssetContainer
+      attr_reader :item_id, :location_id, :type_id, :quantity, :flag, :singleton
+      attr_accessor :assets
+      def initialize(elem)
+        @item_id = elem['itemid'].to_i
+        @location_id = elem['locationid'].to_i
+        @type_id = elem['typeid'].to_i
+        @quantity = elem['quantity'].to_i
+        @flag = elem['flag'].to_i
+        @singleton = elem['singleton'] == "1"
+        @assets = []
+      end
+    end
+    
+    # An item contained within an AssetContainer (ship, or container)
+    # Attributes
+    # * item_id ( Fixnum ) - A CCP-specific ID for the Asset/AssetContainer
+    # * type_id ( Fixnum ) - Type ID of the Asset/AssetContainer. (Refer to CCP database dump invtypes)
+    # * quantity ( Fixnum ) - The number of Asset/AssetContainer at this +location_id+
+    # * flag ( Fixnum ) - Inventory flag, refer to http://wiki.eve-dev.net/API_Inventory_Flags (See also KillLoss's flag)
+    # See Also: AssetContainer, Reve::API#corporate_assets_list, Reve::API#personal_assets_list
+    class Asset
+      attr_reader :item_id, :type_id, :quantity, :flag, :singleton
+      def initialize(elem) #:nodoc:
+        @item_id = elem['itemid'].to_i
+        @type_id = elem['typeid'].to_i
+        @quantity = elem['quantity'].to_i
+        @flag = elem['flag'].to_i
+        @singleton = elem['singleton'].to_i
+      end
+    end
+
+    # Used for attribute enhancers (in-game Implants)
+    # IntelligenceEnhancer, MemoryEnhancer, PerceptionEnhancer, CharismaEnhancer
+    # and WillpowerEnhancer all subclass this class as this AttributeEnhancer 
+    # class is never used (except in a fault-case). Use the kind_of? method 
+    # to determine what kind of AttributeEnhancer one is dealing with.
+    # Attributes
+    # * name ( String ) - The name of the AttributeEnhancer (implant)
+    # * value ( Fixnum ) - How much the +name+ implant boosts.
+    # See Also: CharacterSheet, Reve::API#character_sheet
+    class AttributeEnhancer
+      attr_accessor :name, :value
+      def initialize(name = "", value = 0) #:nodoc:
+        @name = name
+        @value = value.to_i
+      end
+    end
+    class IntelligenceEnhancer < AttributeEnhancer; end
+    class MemoryEnhancer < AttributeEnhancer; end
+    class PerceptionEnhancer < AttributeEnhancer; end
+    class CharismaEnhancer < AttributeEnhancer; end
+    class WillpowerEnhancer < AttributeEnhancer; end
+
+    # Represents a Character for the Reve::API#characters, Reve::API#character_name and Reve::API#character_id calls.
+    # Attributes
+    # * name ( String ) - Name of the Character
+    # * id ( Fixnum ) - ID of the Character (use this for Reve::API method calls)
+    # * corporation_name ( String | NilClass ) - Name of the Corporation the Character belongs to. Nil if being used for Reve::API#character_name or Reve::API#character_id
+    # * corporation_id ( Fixnum | NilClass ) - ID of the Corporation the Character belongs to. Nil if being used for Reve::API#character_name or Reve::API#character_id
+    # See Also: Reve::API
+    class Character
+      attr_reader :name, :id, :corporation_name, :corporation_id
+      def initialize(elem) #:nodoc:
+        @id               = elem['characterid'].to_i
+        @name             = elem['name']
+        @corporation_name = elem['corporationname']
+        @corporation_id   = elem['corporationid'].to_i
+      end
+    end
+
+    # Holds the result of the Reve::API#character_sheet call.
+    # This has all of the stuff that appears in the in-game 'character sheet'
+    # screen.
+    # The skills array is a Skill list (no name is stored in it)
+    # The enhancers array is an AttributeEnhancer derrived list
+    # Attributes
+    # * name ( String ) - Name of the Character
+    # * race ( String ) - Race of the Character
+    # * gender ( String ) - Gender of the Character
+    # * id ( Fixnum ) - ID of the Character
+    # * corporation_name ( String ) - Name of the Corporation the Character is in
+    # * corporation_id ( Fixnum ) - ID of the Corporation the Character is in
+    # * balance ( Float ) - How much ISK the Character has
+    # * intelligence ( Fixnum ) - Character's Intelligence level
+    # * memory ( Fixnum ) - 
+    # * charisma ( Fixnum ) - 
+    # * perception ( Fixnum ) - 
+    # * willpower ( Fixnum ) - 
+    # * skills ( [Skill] ) - An Array of Skill objects that the Character has trained.
+    # * enhancers ( [AttributeEnhancer] ) - An Array of any implants (AttributeEnhancer) the Character has in its head.
+    # See Also: Reve::API#character_sheet, AttributeEnhancer (and subclasses), Skill
+    class CharacterSheet
+      attr_accessor :name, :race, :bloodline, :gender, :id, :corporation_name, :corporation_id, :balance
+      attr_accessor :intelligence, :memory, :charisma, :perception, :willpower
+      attr_accessor :skills, :enhancers
+      def initialize #:nodoc:
+        @skills = []
+        @enhancers = []
+      end
+      def characterid=(i) #:nodoc:
+        @id = i.to_i
+      end
+      def corporationname=(i) #:nodoc:
+        @corporation_name = i
+      end
+      def corporationid=(i) #:nodoc:
+        @corporation_id = i.to_i
+      end
+    end
+    
+    # Holds the result of the Reve::API#conqurable_stations call.
+    # Attributes
+    # * id ( Fixnum ) - ID of the ConqurableStation
+    # * name ( String ) - Name of the ConqurableStation
+    # * type_id ( Fixnum ) - What kind of ConqurableStation Station it is (Refer to CCP database dump invtypes).
+    # * type_name ( String ) - Name of the kind of Station this ConqurableStation is. (May not be present??)
+    # * corporation_id ( Fixnum ) - ID of the Corporation that owns the ConqurableStation
+    # * corporation_name ( String ) - Name of the Corporation that owns the ConqurableStation.
+    # See Also: Sovereignty, Reve::API#conqurable_stations, Reve::API#sovereignty, Reve::API#corporation_sheet, CorporationSheet
+    class ConqurableStation
+      attr_reader :id, :name, :type_id, :type_name, :system_id, :system_name, :corporation_id, :corporation_name
+      def initialize(elem) #:nodoc:
+        @id = elem['stationid'].to_i
+        @name = elem['stationname']
+        @type_id = elem['stationtypeid'].to_i
+        @type_name = elem['stationtypename']
+        @corporation_id = elem['corporationid'].to_i
+        @corporation_name = elem['corporationname']
+      end
+    end
+    
+    # Part of the CorporationSheet; represnets a Corporation's in-game logo
+    # All of these values are internal to CCP; +shape_1+ matches with +color_1+ and so on.
+    # Attributes
+    # * graphic_id ( Fixnum ) 
+    # * shape_1 ( Fixnum ) 
+    # * shape_2 ( Fixnum )
+    # * shape_3 ( Fixnum )
+    # * color_1 ( Fixnum )
+    # * color_2 ( Fixnum )
+    # * color_3 ( Fixnum )
+    class CorporateLogo
+      attr_reader :graphic_id, :shape_1, :shape_2, :shape_3, :color_1, :color_2, :color_3
+      def initialize(elem) #:nodoc:
+        @graphic_id = elem['graphicid'].to_i
+        @shape_1    = elem['shape1'].to_i
+        @shape_2    = elem['shape2'].to_i
+        @shape_3    = elem['shape3'].to_i
+        @color_1    = elem['color1'].to_i
+        @color_2    = elem['color2'].to_i
+        @color_3    = elem['color3'].to_i                
+      end      
+    end
+    
+    # Part of the CorporationSheet. Describes a division in the wallet
+    # Attributes
+    # * key ( Fixnum ) - Account key. Used for things like WalletBalance and such.
+    # * description ( String ) - Description of the WalletDivision
+    # See Also CorporationSheet
+    class WalletDivision
+      attr_reader :key, :description
+      def initialize(elem) #:nodoc:
+        @key = elem['accountkey'].to_i
+        @description = elem['description'].split(/\n/).collect { |s| s.strip }.join(' ') # newlines to spaces
+      end
+    end
+    
+    # Part of the CorporationSheet. Describes a division of the Corporation
+    # Attributes
+    # * key ( Fixnum ) - Account key.
+    # * description ( String ) - Description of the CorporateDivision
+    # See Also CorporationSheet
+    class CorporateDivision
+      attr_reader :key, :description
+      def initialize(elem) #:nodoc:
+        @key = elem['accountkey'].to_i
+        @description = elem['description'].split(/\n/).collect { |s| s.strip }.join(' ') # newlines to spaces
+      end
+    end
+    
+    # Describes a Corporation. The public listing when a Corporation is in an Alliance is limited. When the requestor is in the Corporation for which the CorporationSheet is for then the details are full.
+    # Attributes
+    # * id ( Fixnum ) - ID of the Corporation
+    # * name ( String ) - Name of the Corporation
+    # * ticker ( String ) - Ticker (short name) of the Corporation
+    # * ceo_id ( Fixnum ) - The ID of the Character who is the CEO of the Corporation
+    # * ceo_name ( String ) - The name of the Character whois he CEO of the Corporation
+    # * station_id ( Fixnum ) - The ID of the Corporation's home Station
+    # * station_name ( Station ) - The name of the Corporation's home Station
+    # * description ( String ) - Corporation's description
+    # * url ( String ) - URL of the Corporation's website. If none is set the value is an empty String
+    # * alliance_id ( Fixnum | NilClass ) - ID of the Alliance that this Corporation belongs to; nil if no membership
+    # * alliance_name ( String | NilClass ) - Name of the Alliance that this Corporation belongs to; nil if no membership
+    # * tax_rate ( Float ) - Tax rate for the Corporation
+    # * member_count ( Fixnum ) - How many Characters are in the Corporation
+    # * member_limit ( Fixnum ) - Member limit (Max number of Characters allowed in?)
+    # * shares ( Fixnum ) - Number of shares available for the Corporation
+    # * divisions ( [CorporateDivision] ) - Array of CorporateDivision objects representing the differet divisions in the Corporation
+    # * wallet_divisions ( [WalletDivision] ) - Array of WalletDivision objects representing the different divisions in the wallet for the Corporation
+    # * logo ( CorporateLogo ) - An object to represent the Corporation's logo.
+    # See Also: CorporateLogo, WalletDivision, CorporateDivision, Corporation, Reve::API#corporation_sheet
+    class CorporationSheet
+      attr_reader   :id, :name, :ticker, :ceo_id, :ceo_name, :station_id, :station_name, :description, :url,
+                    :alliance_id, :alliance_name, :tax_rate, :member_count, :member_limit, :shares
+      attr_accessor :divisions, :wallet_divisions, :logo
+      
+      # Call it +h+ here cos it's a Hash and not any Hpricot object like in other constructors
+      def initialize(h, divisions = [],wallet_divisions = [], logo =Reve::Classes::CorporateLogo.new(Hash.new(0)) ) #:nodoc:
+        @divisions = divisions
+        @wallet_divisions = wallet_divisions
+        @logo = logo
+        @id = h[:id].to_i
+        @name = h[:name]
+        @ticker = h[:ticker]
+        @ceo_id = h[:ceo_id].to_i
+        @ceo_name = h[:ceo_name]
+        @station_id = h[:station_id].to_i
+        @station_name = h[:station_name]
+        @description = h[:description].split(/\n/).collect { |s| s.strip }.join(' ') # newlines to spaces
+        @url = h[:url] || ""
+        @alliance_id = h[:alliance_id].to_i rescue nil
+        @alliance_name = h[:alliance_name] rescue nil
+        @tax_rate = h[:tax_rate].to_f
+        @member_count = h[:member_count].to_i
+        @member_limit = h[:member_limit].to_i
+        @shares = h[:shares].to_i
+      end                              
+    end
+    
+    # This is just for getting the list and writing to test/xml/errors
+    class APIError #:nodoc:
+      attr_reader :code, :text
+      def initialize(elem)
+        @code = elem['errorcode'].to_i
+        @text = elem['errortext']
+      end
+    end
+    
+    # Used for the Reve::API#map_jumps method. If there are no jumps it is not listed.
+    # Attributes
+    # * system_id ( Fixnum ) - ID of the System
+    # * jumps ( Fixnum ) - Number of jumps through the System
+    # See Also: MapKill, Reve::API#map_jumps
+    class MapJump
+      attr_reader :system_id, :jumps
+      def initialize(elem) #:nodoc:
+        @system_id = elem['solarsystemid'].to_i
+        @jumps     = elem['shipjumps'].to_i
+      end
+    end
+    
+    # Used for the Reve::API#personal_market_orders and Reve::API#corporate_market_orders
+    # Each of those derrive from this parent class.
+    # Attributes
+    # * id ( Fixnum ) - ID of the MarketOrder. This is a CCP internal ID and is not guaranteed to always be unique! You may want to generate your own globally unique ID for this.
+    # * character_id ( Fixnum ) - ID of the Character who set this MarketOrder up
+    # * station_id ( Fixnum ) - ID of the Station where the MarketOrder is
+    # * volume_entered ( Fixnum ) - How many of +type_id+ was initially entered in the MarketOrder
+    # * volume_remaining ( Fixnum ) - How many of +type_id+ is left in the MarketOrder
+    # * minimum_volume ( Fixnum ) - How much of +type_id+ can be transacted (as a minimum) at once
+    # * order_state ( String ) - String representation of the MarketOrder's current state. Options are: Active, Closed, Expired, Cancelled, Pending, Character Deleted
+    # * type_id ( Fixnum ) - Type ID of item for which the MarketOrder was created. (Refer to CCP database dump invtypes)
+    # * range ( Fixnum ) - Range of the MarketOrder. For sell orders it is always 32767 (Entire Region), for sell orders the values are -1 (Station only), 0 (Solar system), 1..40 (Number of jumps away from the Station), 32767 (Region wide)
+    # * account_key ( Fixnum ) - For a CorporateMarketOrder the account key (see WalletDivision and CorporationSheet) that was used as the source/destination.
+    # * duration ( Fixnum ) - Duration of the MarketOrder in days from when it was +created_at+
+    # * escrow ( Float ) - How much ISK is held in escrow for the MarketOrder
+    # * price ( Float ) - Unit price of the item in the MarketOrder
+    # * bid ( Boolean ) - True if this MarketOrder is a sell order, false otherwise
+    # * created_at ( Time ) - When the MarketOrder was created
+    # See Also: CorporationSheet, WalletDivision, CorporateDivision, Reve::API#personal_market_orders, Reve::API#corporate_market_orders
+    class MarketOrder
+      attr_reader :id, :character_id, :station_id, :volume_entered, :volume_remaining, :minimum_volume,
+                  :order_state, :type_id, :range, :account_key, :duration, :escrow, :price, :bid, :created_at
+      def initialize(elem) #:nodoc:
+        @id = elem['orderid'].to_i
+        @character_id = elem['characterid'].to_i
+        @station_id = elem['station_id'].to_i
+        @volume_entered = elem['volentered'].to_i
+        @volume_remaining = elem['volremaining'].to_i
+        @minimum_volume = elem['minvolume'].to_i
+        @order_state = case elem['orderstate'].to_i
+                       when 0
+                         'Active'
+                       when 1
+                         'Closed'
+                       when 2
+                         'Expired'
+                       when 3
+                         'Cancelled'
+                       when 4
+                         'Pending'
+                       when 5
+                         'Character Deleted'
+                       end
+        @type_id = elem['typeid'].to_i
+        @range = elem['range'].to_i
+        @account_key = elem['accountkey'].to_i
+        @escrow = elem['escrow'].to_f
+        @price = elem['price'].to_f
+        @bid = elem['bid'] == '1'
+        @duration = elem['duration'].to_i
+        @created_at = elem['issued'].to_time
+      end
+    end
+    class PersonalMarketOrder < MarketOrder; end
+    class CorporateMarketOrder < MarketOrder; end
+    
+    
+    # Used in Reve::API#personal_industry_jobs and Reve::API#corporate_industry_jobs. PersonalIndustryJob and CorporateIndustryJob
+    # subclass this for more logical containment.
+    # These attributes should be largely self-explanatory. There are so many of them that it's soulcrushing to document each one! (Sorry ;)
+    # For further information please see: http://wiki.eve-dev.net/APIv2_Char_IndustryJobs_XML especially about +completed_status+ and +completed+
+    class IndustryJob
+      attr_reader :id, :assembly_line_id, :container_id, :installed_item_id, :installed_item_location_id,
+                  :installed_item_quantity, :installed_item_productivity_level, :installed_item_material_level,
+                  :installed_item_licensed_production_runs_remaining, :output_location_id, :installer_id, :runs,
+                  :licensed_production_runs, :installed_system_id, :container_location_id, :material_multiplier,
+                  :char_material_multiplier, :time_multiplier, :char_time_multiplier, :installed_item_type_id,
+                  :output_type_id, :container_type_id, :installed_item_copy, :completed, :completed_successfully, 
+                  :installed_item_flag, :output_flag, :activity_id, :completed_status, :installed_at, 
+                  :begin_production_at, :end_production_at, :pause_production_time
+      def initialize(elem) #:nodoc:
+        @id = elem['jobid'].to_i; @assembly_line_id = elem['assemblylineid'].to_i ; @container_id = elem['containerid'].to_i
+        @installed_item_id = elem['installeditemid'].to_i ; @installed_item_location_id = elem['installeditemlocationid'].to_i
+        @installed_item_quantity = elem['installeditemquantity'].to_i
+        @installed_item_productivity_level = elem['installeditemproductivitylevel'].to_i
+        @installed_item_material_level = elem['installeditemmateriallevel'].to_i
+        @installed_item_licensed_production_runs_remaining = elem['installeditemlicensedproductionrunsremaining'].to_i
+        @output_location_id = elem['outputlocationid'].to_i ; @installer_id = elem['installerid'].to_i; @runs = elem['runs'].to_i
+        @licensed_production_runs = elem['licensedproductionruns'].to_i ; @installed_system_id = elem['installedsolarsystemid'].to_i
+        @container_location_id = elem['containerlocationid'].to_i ; @material_multiplier = elem['materialmultiplier'].to_f
+        @char_material_multiplier = elem['charmaterialmultiplier'].to_f; @time_multiplier = elem['timemultiplier'].to_f
+        @char_time_multiplier = elem['chartimemultiplier'].to_f ; @installed_item_type_id = elem['installeditemtypeid'].to_i
+        @output_type_id = elem['outputtypeid'].to_i ; @container_type_id = elem['containertypeid'].to_i
+        @installed_item_copy = (elem['installeditemcopy'] == "1") ; @completed = (elem['completed'] == "1")
+        @completed_successfully = (elem['completedsuccessfully'] == "1")
+        @installed_item_flag = elem['installeditemflag'].to_i ; @output_flag = elem['outputflag'].to_i
+        @activity_id = elem['activityid'].to_i ; @completed_status = elem['completedstatus'].to_i
+        @installed_at = elem['installtime'].to_time ; @begin_production_at = elem['beginproductiontime'].to_time
+        @end_production_at = elem['endproductiontime'].to_time
+        @pause_production_time = elem['pauseproductiontime'].to_time
+      end
+    end
+    class PersonalIndustryJob < IndustryJob; end
+    class CorporateIndustryJob < IndustryJob; end
+      
+    # Used for the Reve::API#map_kills method. If there are no kills it's not listed.
+    # Attributes
+    # * system_id ( Fixnum ) - ID of the System
+    # * ship_kills ( Fixnum ) - Number of ships killed
+    # * faction_kills ( Fixnum ) - Number of faction ships killed (NPC Pirates)
+    # * pod_kills ( Fixnum ) - Number of podkills
+    # See also Reve::API#map_kills, MapJump
+    class MapKill
+      attr_reader :system_id, :ship_kills, :faction_kills, :pod_kills
+      def initialize(elem) #:nodoc:        
+        @system_id     = elem['solarsystemid'].to_i
+        @ship_kills    = elem['shipkills'].to_i
+        @faction_kills = elem['factionkills'].to_i
+        @pod_kills     = elem['podkills'].to_i
+      end            
+    end
+
+    # Holds the result of the Reve::API#member_tracking call for big brother.
+    # * character_id ( Fixnum ) - ID of the Character
+    # * character_name ( Fixnum ) - Name of the Character
+    # * start_time ( Time ) - When the Character joined the Corporation
+    # * base_id ( Fixnum ) - ID of the Station (Starbase too?) where the Character calls home
+    # * base ( String ) - Name of the Station (Starbase?) where the Character calls home
+    # * title ( String ) - Title of the Character
+    # * logon_time ( Time | NilClass ) - When the Character last logged on (or nil for non-CEOs)
+    # * logoff_time ( Time | NilClass ) - When the Character last logged off (or nil for non-CEOs)
+    # * location_id ( Fixnum ) - ID of the Station (Starbase too?) where the Character last/currently is
+    # * location ( String ) - Name of the Station (Starbase?) where the Character last/currently is
+    # * ship_type_id ( Fixnum ) - Type ID of the ship the Character is flying. (Refer to CCP database dump invtypes)
+    # * ship_type ( String ) - Name of the type of ship the Character is flying
+    # * roles ( String ) - List of roles for the Character
+    # * grantable_roles ( String ) - List of grantable roles for the Character
+    # See Also: Reve::API#member_tracking
+    class MemberTracking
+      attr_reader :character_id, :character_name, :start_time, :base_id, :base, :title, :logon_time, :logoff_time, 
+                  :location_id, :location, :ship_type_id, :ship_type, :roles, :grantable_roles
+      def initialize(elem) #:nodoc:
+        @character_id    = elem['characterid'].to_i
+        @character_name  = elem['name']
+        @start_time      = elem['startdatetime'].to_time
+        @base_id         = elem['baseid'].to_i
+        @base            = elem['base']
+        @title           = elem['title']
+        @logon_time      = elem['logondatetime'].to_time rescue nil # can be nil for non CEOs
+        @logoff_time     = elem['logoffdatetime'].to_time rescue nil # Can be nil for non CEOs
+        @location_id     = elem['locationid']
+        @location        = elem['location']
+        @ship_type_id    = elem['shiptypeid'].to_i
+        @ship_type       = elem['shiptype']
+        @roles           = elem['roles']
+        @grantable_roles = elem['grantableroles']
+      end
+    end
+
+    # Represents Reve::API#ref_types return. Used in WalletTransaction and WalletJournal, among others to qualify the "type" of the entry
+    # Attributes
+    # * id ( Fixnum ) - CCP's ID for the RefType
+    # * name ( String ) - CCP's name for the RefType
+    # See Also: Reve::API#ref_types, WalletJournal, WalletTransaction
+    class RefType
+      attr_reader :id, :name
+      def initialize(elem) #:nodoc:
+        @id   = elem['reftypeid'].to_i
+        @name = elem['reftypename']
+      end
+    end
+
+    # A Skill is used in the CharacterSheet for Reve::API#character_sheet call.
+    # Attributes
+    # * id ( Fixnum ) - Type ID of the Skill. (Refer to CCP database dump invtypes)
+    # * skillpoints ( Fixnum ) - Number of skill points invested in this skill
+    # * level ( Fixnum ) - Level of the Skill
+    # See Also: CharacterSheet, Reve::API#character_sheet
+    class Skill
+      attr_accessor :id, :unpublished, :skillpoints, :level
+      def initialize(elem) #:nodoc:
+        @id          = elem['typeid'].to_i
+        @skillpoints = elem['skillpoints'].to_i
+        @level       = elem['level'].to_i
+      end
+    end
+
+    # A SkillBonus, for SkillTree and Reve::API#skill_tree.
+    # Bear in mind that "SkillBonus" doesn't always mean anything useful or beneficial
+    # * type ( String ) - Name of the bonus
+    # * value ( String ) - Value of the bonus. This is may be Fixnum or Float or Boolean but is left as a String
+    # See Also: SkillTree, Reve::API#skill_tree
+    class SkillBonus
+      attr_reader :type, :value
+      def initialize(elem) #:nodoc:
+        @type = elem['bonustype']
+        @value = elem['bonusvalue']
+      end
+    end
+    
+    # A SkillRequirement, for SkillTree and Reve::API#skill_tree
+    # Attributes
+    # * type_id ( Fixnum ) - ID of the Skill that is the SkillRequirement (Refer to CCP database dump invtypes)
+    # * level ( Fixnum ) - What level of the Skill is required
+    # See Also: SkillTree, Reve::API#skill_tree
+    class SkillRequirement
+      attr_reader :type_id, :level
+      alias_method :id, :type_id
+      def initialize(elem)
+        @type_id = elem['typeid'].to_i
+        @level = elem['skilllevel'].to_i
+      end
+    end
+
+    # Holds the result of the Reve::API#skill_tree call. Currently this is not
+    # nested based on group_id in each individual skill.
+    # Attributes
+    # * name ( String ) - Name of a Skill
+    # * type_id ( Fixnum ) - ID of the Skill (Refer to CCP database dump invtypes)
+    # * group_id ( Fixnum ) - Group ID of the Skill (Refer to CCP database dump invgroups)
+    # * description ( Skill ) - Description of the Skill
+    # * rank ( Fixnum ) - Rank of the skill
+    # * attribs ( [RequiredAttribute] ) - Two-element array with the PrimaryAttribute and SecondaryAttribute for the Skill
+    # * skills ( [SkillTree] ) - Nested Skills under this group. NOT USED
+    # * bonuses ( [SkillBonus] ) - Bonuses given by this Skill
+    # See Also: SkillBonus, RequiredAttribute, Reve::API#skill_tree
+    class SkillTree
+      attr_reader :name, :type_id, :group_id, :description, :rank, :attribs, :required_skills, :bonuses
+      def initialize(name, typeid, groupid, desc, rank, attribs = [], skills = [], bonuses = []) #:nodoc:
+        @name = name
+        @type_id = typeid.to_i
+        @group_id = groupid.to_i
+        @rank = rank.to_i
+        @attribs = attribs
+        @required_skills = skills
+        @bonuses = bonuses
+        # turn multiline literals (embedded \n and lot of white space) into one
+        # line!
+        @description = desc.split(/\n/).collect { |s| s.strip }.join(' ')
+      end
+    end
+
+    # Holds the result of the Reve::API#skill_in_training call.
+    # Note: When a Character finishes training the API will not be updated until the Character next logs into the game.
+    # Attributes
+    # * tranquility_time ( Time ) - The current time on Tranquility
+    # * end_time ( Time ) - When the Skill is due to end
+    # * start_time ( Time ) - When the Skill training was started
+    # * type_id ( Fixnum ) - ID of the Skill (Refer to CCP database dump invtypes)
+    # * start_sp ( Fixnum ) - How many SP did the Character have before training was started
+    # * end_sp ( Fixnum ) - How many SP will the Character have after training finishes
+    # * to_level ( Fixnum ) - This is the level the Skill will be at when training is completed
+    # * skill_in_training ( Boolean ) - Is there actually a skill in training? (Check this first before doing anything)
+    # See Also: CharacterSheet, Reve::API#skill_in_training
+    class SkillInTraining
+      attr_reader :tranquility_time, :end_time, :start_time, :type_id, :start_sp, :end_sp, :to_level, :skill_in_training
+      def initialize(elem) #:nodoc:
+        @tranquility_time = elem['currenttqtime'].to_time
+        @end_time         = elem['trainingendtime'].to_time
+        @start_time       = elem['trainingstarttime'].to_time
+        @type_id          = elem['trainingtypeid'].to_i
+        @start_sp         = elem['trainingstartsp'].to_i
+        @end_sp           = elem['trainingdestinationsp'].to_i
+        @to_level         = elem['trainingtolevel'].to_i
+        @skill_in_training= elem['skillintraining'] == '1'
+      end
+    end
+
+    # Used for the Reve::API#sovereignty call.
+    # Attributes
+    # * system_id ( Fixnum ) - ID of the System
+    # * alliance_id ( Fixnum ) - ID of the Alliance that controls the System
+    # * constellation_sovereignty ( String ) - Not sure? Maybe this is if the System falls under a Constellation Sovereignty setup?
+    # * level ( Fixnum ) - Not sure? Level of Constellation Sovereignty
+    # * faction_id ( Fixnum ) - ID of the Faction that controls the System
+    # * system_name ( String ) - Name of the System
+    # See Also: Alliance, Reve::API#alliances
+    class Sovereignty
+      attr_reader :system_id, :alliance_id, :constellation_sovereignty, :level, :faction_id, :system_name
+      def initialize(elem) #:nodoc:
+        @system_id                 = elem['solarsystemid'].to_i
+        @alliance_id               = elem['allianceid'] == '0' ? nil : elem['allianceid'].to_i
+        @constellation_sovereignty = elem['constellationsovereignty']
+        @level                     = elem['sovereigntylevel'].to_i if elem['sovereigntylevel']
+        @faction_id                = elem['factionid'] == '0' ? nil : elem['factionid'].to_i
+        @system_name               = elem['solarsystemname']
+      end
+    end
+    
+    # Used for a list of Starbases, Reve::API#starbases
+    # Attributes
+    # * type_id ( Fixnum ) - Type of Starbase (Refer to CCP database dump invtypes)
+    # * type_name ( String ) - Name of the type of Starbase
+    # * id ( Fixnum ) - ID of the Starbase
+    # * system_id ( Fixnum ) - ID of the System where the Starbase is
+    # * system_name ( Starbase ) - Name of the System where the Starbase is
+    # See Also: StarbaseFuel, Reve::API#starbases, Reve::API#starbase_fuel
+    class Starbase
+      attr_reader :type_id, :type_name, :id, :system_id, :system_name
+      alias_method :item_id, :id
+      alias_method :location_id,:system_id
+      alias_method :location_name, :system_name
+      def initialize(elem) #:nodoc:
+        @type_id = elem['typeid'].to_i
+        @type_name = elem['typename']
+        @id = elem['itemid'].to_i
+        @system_id = elem['locationid'].to_i
+        @system_name = elem['locationname']
+      end
+    end
+    
+    # Used for the fuel status of a Starbase. See Reve::API#starbase_fuel
+    # starbase_id is set in the Reve::API#starbase_fuel method and not here
+    # Attributes
+    # * type_id ( Fixnum ) - Type of fuel in the Starbase (Refer to CCP database dump invtypes)
+    # * quantity ( Fixnum ) - How much of the fuel is in the Starbase
+    # * starbase_id ( Fixnum ) - ID of the Starbase
+    # See Also: Starbase, Reve::API#starbase_fuel, Reve::API#starbases
+    class StarbaseFuel
+      attr_reader :type_id, :quantity
+      attr_accessor :starbase_id
+      def initialize(elem) #:nodoc:
+        @type_id = elem['typeid'].to_i
+        @quantity = elem['quantity'].to_i
+      end
+    end
+
+    # Corporation or Character WalletBalance for
+    # Reve::API#personal_wallet_transactions and
+    # Reve::API#corporate_wallet_balance
+    # Attributes
+    # * account_id ( Fixnum ) - ID of the account
+    # * account_key ( String ) - Account key
+    # * balance ( Float ) - Balance of the wallet
+    class WalletBalance
+      attr_reader :account_id, :account_key, :balance
+      def initialize(elem)
+        @account_id  = elem['accountid'].to_i
+        @account_key = elem['accountkey']
+        @balance     = elem['balance'].to_f
+      end
+    end
+    # Corporation or Character WalletJournal for
+    # Reve::API#personal_wallet_journal and 
+    # Reve::API#corporate_wallet_journal
+    # Attributes:
+    # * date ( Time ) - Time the action occured
+    # * ref_id ( Integer ) - Reference ID for this action (used with stepping through Journal Entries)
+    # * reftype_id ( Integer ) - RefType id
+    # * owner_name1 ( String ) - Name of the Player/Corporation/whatever that did something to owner_name2
+    # * owner_name2 ( String ) - Recipient of this action (from owner_name1)
+    # * owner_id1 ( Integer ) - ID of the Owner's whatever (Player/Corporation/Faction/Whatever)
+    # * owner_id2 ( Integer ) - ID of the recpient (Player/Corporation/Faction/Whatever)
+    # * arg_name1 ( String ) - For bounty, what caused this. (May be blank)
+    # * arg_id1 ( Integer ) - ID of arg_name1
+    # * amount ( Float ) - Wallet delta
+    # * balance ( Float ) - New wallet balance after this action
+    # * reason ( String ) - Any reason for the action. May be blank (useful in giving ISK)
+    class WalletJournal
+      attr_reader :date, :ref_id, :reftype_id, :owner_name1, :owner_id1, :owner_name2, :owner_id2, :arg_name1, :arg_id1, :amount, :balance, :reason
+      alias_method :id, :ref_id
+      def initialize(elem) #:nodoc:
+        @date        = elem['date'].to_time
+        @ref_id      = elem['refid'].to_i
+        @reftype_id  = elem['reftypeid'].to_i
+        @owner_name1 = elem['ownername1']
+        @owner_name2 = elem['ownername2']
+        @owner_id1   = elem['ownerid1'].to_i if elem['ownerid1']
+        @owner_id2   = elem['ownerid2'].to_i if elem['ownerid2']
+        @arg_name1   = elem['argname1']
+        @arg_id1     = elem['argid1'].to_i if elem['argid1']
+        @amount      = elem['amount'].to_f
+        @balance     = elem['balance'].to_f
+        @reason      = elem['reason']
+      end
+    end
+    # Corporation or Character WalletTransaction for
+    # Reve::API#personal_wallet_transactions and
+    # Reve::API#corporate_wallet_transactions
+    # Attributes
+    # * created_at ( Time ) - When was the WalletTransaction created?
+    # * id ( Fixnum ) - CCP's ID of the WalletTransaction. Note: This is not guaranteed to be unique. It may be best to create your own unique ID
+    # * quantity ( Fixnum ) - Number of +type_id+ transacted
+    # * type_name ( String ) - Name of the transacted thing
+    # * price ( Float) - Price of the transacted thing
+    # * client_id ( Fixnum ) - ID of the client 
+    # * client_name ( String ) - Name of the client
+    # * character_id ( Fixnum ) - ID of the Character
+    # * station_id ( Fixnum ) - ID of the Station where the WalletTransaction took place
+    # * station_name ( String ) - Name of the Station where the WalletTransaction took place
+    # * type ( String ) - Not sure?
+    # * transaction_for ( String ) - This is corporate or personal, mirrors the subclasses.
+    class WalletTransaction
+      attr_reader :created_at, :id, :quantity, :type_name, :type_id, :price, 
+                  :client_id, :client_name, :character_id, :station_id, :station_name, :type,
+                  :transaction_for
+      def initialize(elem) #:nodoc:
+        @created_at       = elem['transactiondatetime'].to_time rescue nil
+        @id               = elem['transactionid'].to_i
+        @quantity         = elem['quantity'].to_i
+        @type_name        = elem['typename']
+        @type_id          = elem['typeid'].to_i
+        @price            = elem['price'].to_f
+        @client_id        = elem['clientid'].to_i if elem['clientid']
+        @client_name      = elem['clientname']
+        @station_id       = elem['stationid'].to_i
+        @station_name     = elem['stationname']
+        @character_id     = elem['characterid'].to_i if elem['characterid'] && elem['characterid'] != '0'
+        @type             = elem['transactiontype']
+        @transaction_for  = elem['transactionfor'] # This is corporate or personal, mirrors the subclasses.
+      end
+    end
+    # For Corporate WalletTransaction (WalletTransaction#transaction_for == 'corporation')
+    # See WalletTransaction
+    class CorporateWalletTransaction < WalletTransaction
+    end
+    # For Personal WalletTransaction (WalletTransaction#transaction_for == 'personal')
+    # See WalletTransaction
+    class PersonalWalletTransaction < WalletTransaction
+    end
+  end
+end

data/lib/reve/exceptions.rb

@@ -0,0 +1,343 @@
+#--
+# Code copyright Lisa Seelye, 2007-2008. www.crudvision.com
+# Reve is not licensed for commercial use. For other uses there are no
+# restrictions.
+#
+# The author is not adverse to tokens of appreciation in the form of Eve ISK,
+# ships, and feedback. Please use
+# http://www.crudvision.com/reve-ruby-eve-online-api-library/ to provide
+# feedback or send ISK to Raquel Smith in Eve. :-)
+#++
+module Reve
+  # Exceptions live here.
+  module Exceptions
+    # Raise the flag!
+    def self.raise_it(code,msg = "No Error Message From CCP Server (But one DID occur!)")
+      msg = "(#{code.to_s}) #{msg}"
+      case code
+      when 100
+        raise WalletNotPreviouslyLoaded.new(msg)
+      when 101, 103
+        raise WalletExhausted.new(msg)
+      when 102
+        raise WalletPreviouslyLoaded.new(msg)
+      when 104
+        raise KeyNotFound.new(msg)
+      when 105
+        raise InvalidCharacterID.new(msg)
+      when 106
+        raise MustProvideUserIDParameterForAuthentication.new(msg)
+      when 107
+        raise InvalidBeforeRefID.new(msg)
+      when 108
+        raise InvalidAccountKey.new(msg)
+      when 109
+        raise AccountKeyOutOfRange.new(msg)
+      when 110
+        raise InvalidBeforeTransID.new(msg)
+      when 111
+        raise InvalidInteger.new(msg)
+      when 112
+        raise VersionMismatchException.new(msg)
+      when 113
+        raise VersionEscalationException.new(msg)
+      when 114
+        raise InvalidItemIDProvided.new(msg)
+      when 115
+        raise AssetsAlreadyFetched.new(msg)
+      when 116
+        raise IndustryJobsAlreadyFetched.new(msg)
+      when 117
+        raise MarketOrdersAlreadyFetched.new(msg)
+      when 118
+        raise ExpectedBeforeKillID.new(msg)
+      when 119
+        raise KillsExhausted.new(msg)
+      when 120
+        raise UnexpectedBeforeKillID.new(msg)
+      when 121
+        raise BadBeforeKillID.new(msg)
+      when 200
+        raise SecurityLevelNotHighEnough.new(msg + ' (Should you be using the full API Key?)')
+      when 201
+        raise CharacterDoesNotBelongToAccount.new(msg)
+      when 202
+        raise CachedAPIKeyAuthenticationFailure.new(msg)
+      when 203..205
+        raise AuthenticationFailure.new(msg)
+      when 206
+        raise MustHaveAccountantRole.new(msg)
+      when 207
+        raise NotAvailableForNPCCorps.new(msg)
+      when 208
+        raise MustHaveAccountantOrTraderRole.new(msg)
+      when 209
+        raise MustBeDirectorOrCEO.new(msg)
+      when 210,212
+        raise AuthenticationFailure.new(msg)
+      when 211
+        raise LoginDeniedByAccountStatus.new(msg)
+      when 213
+        raise CharacterNeedsFactoryManagerRole.new(msg)
+      when 214
+        raise CorporationNotInAlliance.new(msg)
+      when 500
+        raise GetNameInvalid.new(msg)
+      when 501
+        raise GetIDInvalid.new(msg)
+      when 502
+        raise CachedUntilException.new(msg)
+      when 503
+        raise InvalidInput.new(msg)
+      when 504
+        raise InvalidRace.new(msg)
+      when 505
+        raise InvalidGender.new(msg)
+      when 506
+        raise InvalidBloodline.new(msg)
+      when 507
+        raise InvalidAttribute.new(msg)
+      when 508
+        raise InvalidRefType.new(msg)
+      when 509
+        raise NullDataComponent.new(msg)
+      when 510
+        raise NoCorporationException.new(msg)
+      when 511
+        raise InvalidAccountKey.new(msg)
+      when 512
+        raise InvalidCharID.new(msg)
+      when 513
+        raise CorporateRoleFetchException.new(msg)
+      when 514
+        raise InvalidCorpID.new(msg)
+      when 515
+        raise InvalidUserIDOrAPIKey.new(msg)
+      when 516 
+        raise UserInformationFetchException.new(msg)
+      when 517
+        raise CSVHeaderRowMismatch.new(msg)
+      when 518
+        raise TranquilityTimeException.new(msg)
+      when 519
+        raise StarbaseDetailFetchFailure.new(msg)
+      when 520
+        raise EveDatabaseConnectionFailure.new(msg)
+      when 521
+        raise InvalidUsernameOrPassword.new(msg)
+      when 522
+        raise CharacterRetrevialFailure.new(msg)
+      when 523
+        raise CorporationRetrevialFailure.new(msg)
+      when 900
+        raise BetaAccessDenied.new(msg)
+      when 901
+        raise WebsiteOffline.new(msg)
+      when 902
+        raise EveDatabaseOffline.new(msg)
+      when 903
+        raise ObeyCacheTimers.new(msg)
+      when 999
+        raise UserForcedException.new(msg)
+      end
+    end
+    
+    # All API-specific exceptions derrive from this. Useful for rescuing one
+    # parent exception to handle all API exceptions.
+    class ReveError < StandardError
+    end
+    
+    # 100
+    class WalletNotPreviouslyLoaded < ReveError #:nodoc:
+    end
+    # 101, 103
+    class WalletExhausted < ReveError #:nodoc:
+    end
+    # 102
+    class WalletPreviouslyLoaded < ReveError #:nodoc:
+    end
+    # 104
+    class KeyNotFound < ReveError #:nodoc:
+    end
+    # 105
+    class InvalidCharacterID  < ReveError #:nodoc:
+    end
+    # 106
+    class MustProvideUserIDParameterForAuthentication < ReveError #:nodoc:
+    end
+    # 107
+    class InvalidBeforeRefID < ReveError #:nodoc:
+    end
+    # 108
+    class InvalidAccountKey < ReveError #:nodoc:
+    end
+    # 109
+    class AccountKeyOutOfRange < ReveError #:nodoc:
+    end
+    # 110
+    class InvalidBeforeTransID < ReveError #:nodoc:
+    end
+    # 111
+    class InvalidInteger < ReveError #:nodoc:
+    end
+    # 112
+    class VersionMismatchException < ReveError #:nodoc:
+    end
+    # 113
+    class VersionEscalationException < ReveError #:nodoc:
+    end
+    # 114
+    class InvalidItemIDProvided < ReveError #:nodoc:
+    end
+    # 115
+    class AssetsAlreadyFetched < ReveError #:nodoc:
+    end
+    # 116
+    class IndustryJobsAlreadyFetched < ReveError #:nodoc:
+    end
+    # 117
+    class MarketOrdersAlreadyFetched < ReveError #:nodoc:
+    end
+    # 118
+    class ExpectedBeforeKillID < ReveError #:nodoc:
+    end
+    # 119
+    class KillsExhausted < ReveError #:nodoc:
+    end
+    # 120
+    class UnexpectedBeforeKillID < ReveError #:nodoc:
+    end
+    # 121
+    class BadBeforeKillID < ReveError #:nodoc:
+    end
+    # 200
+    class SecurityLevelNotHighEnough < ReveError #:nodoc:
+    end
+    # 201
+    class CharacterDoesNotBelongToAccount < ReveError #:nodoc:
+    end
+    # 202
+    class CachedAPIKeyAuthenticationFailure < ReveError #:nodoc:
+    end
+    # 203, 204, 205
+    class AuthenticationFailure < ReveError #:nodoc:
+    end
+    # 206
+    class MustHaveAccountantRole < ReveError #:nodoc:
+    end
+    # 207
+    class NotAvailableForNPCCorps < ReveError #:nodoc:
+    end
+    # 208
+    class MustHaveAccountantOrTraderRole < ReveError #:nodoc:
+    end
+    # 209
+    class MustBeDirectorOrCEO < ReveError #:nodoc:
+    end
+    # 210, 212
+    class AuthenticationFailure < ReveError #:nodoc:
+    end
+    # 211
+    class LoginDeniedByAccountStatus < ReveError #:nodoc:
+    end
+    # 213
+    class CharacterNeedsFactoryManagerRole < ReveError #:nodoc:
+    end
+    # 214
+    class CorporationNotInAlliance < ReveError #:nodoc:
+    end
+
+    # 500
+    class GetNameInvalid < ReveError #:nodoc:
+    end
+    # 501
+    class GetIDInvalid < ReveError #:nodoc:
+    end
+    # 502
+    class CachedUntilException < ReveError #:nodoc:
+    end
+    # 503
+    class InvalidInput < ReveError #:nodoc:
+    end
+    # 504
+    class InvalidRace < ReveError #:nodoc:
+    end
+    # 505
+    class InvalidGender < ReveError #:nodoc:
+    end
+    # 506
+    class InvalidBloodline < ReveError #:nodoc:
+    end
+    # 507
+    class InvalidAttribute < ReveError #:nodoc:
+    end
+    # 508
+    class InvalidRefType < ReveError #:nodoc:
+    end
+    # 509
+    class NullDataComponent < ReveError #:nodoc:
+    end
+    # 510
+    class NoCorporationException < ReveError #:nodoc:
+    end
+    # 511
+    class InvalidAccountKey < ReveError #:nodoc:
+    end
+    # 512
+    class InvalidCharID < ReveError #:nodoc:
+    end
+    # 513
+    class CorporateRoleFetchException < ReveError #:nodoc:
+    end
+    # 514
+    class InvalidCorpID < ReveError #:nodoc:
+    end
+    # 515
+    class InvalidUserIDOrAPIKey < ReveError #:nodoc:
+    end
+    # 516
+    class UserInformationFetchException < ReveError #:nodoc:
+    end
+    # 517
+    class CSVHeaderRowMismatch < ReveError #:nodoc:
+    end
+    # 518
+    class TranquilityTimeException < ReveError #:nodoc:
+    end
+    # 519
+    class StarbaseDetailFetchFailure < ReveError #:nodoc:
+    end
+    # 520 
+    class EveDatabaseConnectionFailure < ReveError #:nodoc:
+    end
+    # 521
+    class InvalidUsernameOrPassword < ReveError #:nodoc:
+    end
+    # 522
+    class CharacterRetrevialFailure < ReveError #:nodoc:
+    end
+    # 523
+    class CorporationRetrevialFailure < ReveError #:nodoc:
+    end
+
+    # 900
+    class BetaAccessDenied < ReveError #:nodoc:
+    end
+    class WebsiteOffline  < ReveError #:nodoc:
+    end
+    # 902
+    class EveDatabaseOffline < ReveError #:nodoc:
+    end
+    # 903 - Obey the %*(&!*@ timers!!!
+    class ObeyCacheTimers < ReveError #:nodoc:
+    end
+    
+    # 999
+    class UserForcedException < ReveError #:nodoc:
+    end
+
+    # this is an Exception to do with the connection to the Eve server failing
+    class ReveNetworkStatusException < StandardError
+    end
+  end
+end

data/lib/reve/extensions.rb

@@ -0,0 +1,165 @@
+require 'parsedate'
+
+module Reve #:nodoc:
+  # All of these are shamelessly nicked from Ruby on Rails. 
+  # The String Extensions have a bit more fault tolerance.
+  module Extensions
+    
+    module NilClass
+      def to_s
+        self
+      end
+      def to_i
+        self
+      end
+      def to_f
+        self
+      end
+      def to_date
+        self
+      end
+      def to_time
+        self
+      end
+    end
+    
+    module Hash
+      def stringify_keys
+        inject({}) do |h, (key,value)|
+          h[key.to_s] = value
+          h
+        end
+      end
+      def stringify_keys!
+        keys.each do |key|
+          unless key.class.to_s == "String" # See ActiveSupport for why this is needed!
+            self[key.to_s] = self[key]
+            delete(key)
+          end
+        end
+        self
+      end
+    end
+
+    # Rails's cattr_ things. activesupport/lib/active_support/core_ext/class
+    # Really quite handy.
+    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
+    end
+
+    module String
+      def to_time(form = :utc)
+        begin
+          ::Time.send(form, *ParseDate.parsedate(self))
+        rescue TypeError
+          self
+        end
+      end
+
+      # Try to make an Integer from a string. Will make sure that there's
+      # actually an integer there. "ponies".to_i will return "ponies" since it
+      # isn't an Integer. Yeah, probably not the best way but I do this with
+      # to_time and to_date. Deal with it - at least it doesn't raise an
+      # Exception.
+      def to_i
+        begin
+          Integer(self).to_s == self ? Integer(self) : self
+        rescue ArgumentError
+          self
+        end
+      end
+      def to_date
+        begin
+          ::Date.new(*ParseDate.parsedate(self)[0..2])
+        rescue TypeError,ArgumentError
+          self
+        end
+      end
+    end
+    module Time
+      def to_date
+        ::Date.new(year,month,day)
+      end
+      def to_time
+        self
+      end
+    end
+    module Date
+      def to_date
+        self
+      end
+      def to_time(form = :utc)
+        if respond_to?(:hour)
+          ::Time.send(form,year,month,day,hour,min,sec)
+        else
+          ::Time.send(form, year, month, day)
+        end
+      end
+    end
+  end
+end
+
+class String #:nodoc:
+  include Reve::Extensions::String
+end
+
+class Time #:nodoc:
+  include Reve::Extensions::Time
+end
+
+class Date #:nodoc:
+  include Reve::Extensions::Date
+end
+
+class Class #:nodoc:
+  include Reve::Extensions::Class
+end
+
+class Hash #:nodoc:
+  include Reve::Extensions::Hash
+end
+
+class NilClass #:nodoc:
+  include Reve::Extensions::NilClass
+end

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: reve
 version: !ruby/object:Gem::Version 
-  version: 0.0.74
+  version: 0.0.76
 date: 2008-02-02 00:00:00 +00:00
 summary: Reve is a Ruby library to interface with the Eve Online API
 require_paths: 
@@ -30,6 +30,9 @@ authors:
 - Lisa Seelye
 files: 
 - Rakefile
+- lib/reve/classes.rb
+- lib/reve/exceptions.rb
+- lib/reve/extensions.rb
 - lib/reve.rb
 - reve.rb
 - tester.rb