reve 0.0.115 → 0.0.130

data/Rakefile

@@ -1,27 +1,9 @@
-STATS_DIRECTORIES = [
-  %w(Libraries          lib/),
-  %w(tests test/)
-]
-require 'rubygems'
-
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-
 task :default => :redoc
 
-desc "Code Statistics"
-task :stats do
-  require 'code_statistics'
-  CodeStatistics.new(*STATS_DIRECTORIES).to_s  
-end
-
-
-REVE_RELEASE=`svn up &>/dev/null && svn info|grep ^Revision| cut -d ' ' -f 2`
-
 desc "Generate Docs"
 Rake::RDocTask.new("doc") { |rdoc|
   rdoc.rdoc_dir = 'doc'
@@ -33,23 +15,26 @@ Rake::RDocTask.new("doc") { |rdoc|
   rdoc.rdoc_files.include('test/**/*')
 }
 
-spec = Gem::Specification.new do |s|
-  s.name = "reve"
-  s.rubyforge_project = "reve"
-  s.version = "0.0.#{REVE_RELEASE.chomp || '1'}"
-  s.author = "Lisa Seelye"
-  s.email = "lisa@thedoh.com"
-  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","LICENSE", "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
-  s.extra_rdoc_files = ["ChangeLog"]
-  s.add_dependency("hpricot",">= 0.6")
-end rescue nil
+if File.exists?('.git')
+  begin
+    require 'jeweler'
+    Jeweler::Tasks.new do |s|
+      s.name = "reve"
+      s.rubyforge_project = "reve"
+      s.author = "Lisa Seelye"
+      s.email = "lisa@thedoh.com"
+      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","LICENSE", "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
+      s.extra_rdoc_files = ["ChangeLog"]
+      s.add_dependency("hpricot",">= 0.6")
+    end
+  rescue LoadError
+    puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  end
+end
 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_tar = true
-end rescue nil

data/init.rb

@@ -1 +1,3 @@
+# I exist to make Reve work as a Rails plugin.
+# (It's such a glamorous job!)
 require 'reve'

data/lib/reve/classes.rb

@@ -269,6 +269,25 @@ module Reve #:nodoc:
       
     end
     
+    # A Research object holds information about Agents the Character is doing research with.
+    # Attributes
+    # * agent_id ( Fixnum ) - ID of the Agent
+    # * skill_type_id ( Fixnum ) - Skill used for research (not the ID of the core received)
+    # * research_started_at ( Time ) - Date the Character began research with the Agent
+    # * points_per_day ( Float ) - Number of points generated per day
+    # * remainder_points ( Float ) - Number of points remaining since last datacore purchase andor points_per_day update.
+    # See Also: Character, Skill, Reve::API#research_stats
+    class Research
+      attr_reader :agent_id, :skill_type_id, :research_started_at, :points_per_day, :remainder_points
+      def initialize(elem) #:nodoc:
+        @agent_id            = elem['agentID'].to_i
+        @skill_type_id       = elem['skillTypeID'].to_i
+        @research_started_at = elem['researchStartDate'].to_time
+        @points_per_day      = elem['pointsPerDay'].to_f
+        @remainder_points    = elem['remainderPoints'].to_f
+      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
@@ -300,14 +319,17 @@ module Reve #:nodoc:
     # * 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
+      attr_reader :id, :name, :corporation_id, :corporation_name, :alliance_id, :damage_taken, :ship_type_id, :faction_id, :faction_name
       def initialize(elem) #:nodoc:
         @id = elem['characterID'].to_i
         @name = elem['characterName']
         @corporation_id = elem['corporationID']
         @corporation_name = elem['corporationName']
         @alliance_id = elem['allianceID'] == "0" ? nil : elem['allianceID'].to_i
-        @alliance_name = elem['allianceName']
+        @faction_id = elem['factionID'] == "0" ? nil : elem['factionID'].to_i
+        @faction_id = elem['factionID'] == "0" ? nil : elem['factionID'].to_i
+        @faction_name = elem['factionName'].empty? ? nil : elem['factionName']
+        @alliance_name = elem['allianceName'].empty? ? nil : elem['allianceName']
         @damage_taken = elem['damageTaken'].to_i
         @ship_type_id = elem['shipTypeID'].to_i
       end
@@ -330,7 +352,7 @@ module Reve #:nodoc:
     # 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
+                  :security_status, :damage_done, :final_blow, :weapon_type_id, :ship_type_id, :faction_id, :faction_name
       def initialize(elem) #:nodoc:
         @id = elem['characterID'] == "0" ? nil : elem['characterID'].to_i
         @name = elem['characterName'].empty? ? nil : elem['characterName']
@@ -338,6 +360,8 @@ module Reve #:nodoc:
         @corporation_name = elem['corporationName']
         @alliance_id = elem['allianceID'] == "0" ? nil : elem['allianceID'].to_i
         @alliance_name = elem['allianceName'].empty? ? nil : elem['allianceName']
+        @faction_id = elem['factionID'] == "0" ? nil : elem['factionID'].to_i
+        @faction_name = elem['factionName'].empty? ? nil : elem['factionName']
         @security_status = elem['securityStatus'].to_f
         @damage_done = elem['damageDone'].to_i
         @final_blow = elem['finalBlow'] == "1"
@@ -401,7 +425,7 @@ module Reve #:nodoc:
     # * 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_reader :item_id, :location_id, :type_id, :quantity, :flag, :singleton, :xml_hash
       attr_accessor :assets
       def initialize(elem)
         @item_id = elem['itemID'].to_i
@@ -411,6 +435,9 @@ module Reve #:nodoc:
         @flag = elem['flag'].to_i
         @singleton = elem['singleton'] == "1"
         @assets = []
+        # This ::Digest::SHA1 is a bit of custom code for Eve Metrics that will
+        # probably find its way to all classes since it could prove handy.
+        @xml_hash = ::Digest::SHA1.hexdigest elem.to_s.gsub(/\n|\r|\s/,'')
       end
     end
     
@@ -422,13 +449,16 @@ module Reve #:nodoc:
     # * 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
+      attr_reader :item_id, :type_id, :quantity, :flag, :singleton, :xml_hash
       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
+        # This ::Digest::SHA1 is a bit of custom code for Eve Metrics that will
+        # probably find its way to all classes since it could prove handy.
+        @xml_hash = ::Digest::SHA1.hexdigest elem.to_s.gsub(/\n|\r|\s/,'')
       end
     end
 
@@ -524,7 +554,7 @@ module Reve #:nodoc:
         @grade = elem["grade"].to_i
       end
     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
@@ -601,6 +631,52 @@ module Reve #:nodoc:
       end
     end
     
+    # Holds the result of the Reve::API#corporate_member_security call.
+    # Attributes
+    # * members ( [CorporationMember] ) - Array of CorporationMember
+    # See Also: CorporationMember, CorporateRole, CorporateTitle
+    class CorporationMemberSecurity
+      attr_accessor :members
+      
+      def initialize
+        @members = []
+      end
+    end
+    
+    # Part of the CorporationMemberSecurity; represnets a Corporation's member
+    # All of these values are internal to CCP; +shape_1+ matches with +color_1+ and so on.
+    # Attributes
+    # * name ( String ) - Name of the Character
+    # * id ( Fixnum ) - ID of the Character
+    # * roles ( [CorporateRole] ) - Array of Roles
+    class CorporationMember
+      attr_accessor :roles, :grantableRoles, :rolesAtHQ, :grantableRolesAtHQ, :rolesAtBase
+      attr_accessor :grantableRolesAtBase, :rolesAtOther, :grantableRolesAtOther, :titles
+      attr_accessor :id, :name
+      
+      alias_method :roles_at_hq,    :rolesAtHQ
+      alias_method :grantable_roles_at_hq,    :grantableRolesAtHQ
+      alias_method :roles_at_base,  :rolesAtBase
+      alias_method :grantable_roles_at_base,  :grantableRolesAtBase
+      alias_method :roles_at_other, :rolesAtOther
+      alias_method :grantable_roles_at_other, :grantableRolesAtOther
+    
+      def initialize(elem) #:nodoc:
+        @id = elem['characterID'].to_i
+        @name = elem['name']
+        
+        @roles = []
+        @grantableRoles = []
+        @rolesAtHQ = []
+        @grantableRolesAtHQ = []
+        @rolesAtBase = []
+        @grantableRolesAtBase = []
+        @rolesAtOther = []
+        @grantableRolesAtOther = []
+        @titles = []
+      end
+    end
+    
     # Holds the result of the Reve::API#conqurable_stations call.
     # Attributes
     # * id ( Fixnum ) - ID of the ConqurableStation
@@ -619,6 +695,7 @@ module Reve #:nodoc:
         @system_id = elem['solarSystemID'].to_i
         @corporation_id = elem['corporationID'].to_i
         @corporation_name = elem['corporationName']
+        @system_id = elem['solarSystemID'].to_i
       end
     end
     class ConquerableStation < ConqurableStation; end
@@ -1155,6 +1232,29 @@ module Reve #:nodoc:
       end
     end
 
+    # Holds the result of the Reve::API#skill_queue call.
+    # Attributes
+    # * queue_position ( Integer ) - The queue position of this QueuedSkill
+    # * 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
+    # See Also: Reve::API#skill_queue
+    class QueuedSkill
+      attr_reader :queue_position, :end_time, :start_time, :type_id, :start_sp, :end_sp, :to_level
+      def initialize(elem) #:nodoc:
+        @queue_position = elem['queuePosition'].to_i
+        @end_time         = elem['endTime'] == "" ? nil : elem['endTime'].to_time
+        @start_time       = elem['startTime'] == "" ? nil : elem['startTime'].to_time
+        @type_id          = elem['typeID'].to_i
+        @start_sp         = elem['startSP'].to_i
+        @end_sp           = elem['endSP'].to_i
+        @to_level         = elem['level'].to_i
+      end
+    end
+    
     # Used for the Reve::API#sovereignty call.
     # Attributes
     # * system_id ( Fixnum ) - ID of the System
@@ -1180,35 +1280,75 @@ module Reve #:nodoc:
     # 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
+    # * moon_id ( Fixnum ) - ID of the Moon where the Starbase is
+    # * state ( Fixnum ) - Mode of the POS. See Known POS States, below, see: http://wiki.eve-id.net/APIv2_Corp_StarbaseList_XML
+    # * state_timestamp ( Time ) - Depends on the state, for example cycle time or Reinforced until
+    # * online_timestamp ( Time ) - Since when the starbase is online
     # See Also: StarbaseFuel, Reve::API#starbases, Reve::API#starbase_fuel
     class Starbase
-      attr_reader :type_id, :type_name, :id, :system_id, :system_name
+      attr_reader :type_id, :type_name, :id, :system_id, :moon_id, :state, :state_timestamp, :online_timestamp
       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']
+        @moon_id = elem['moonID'].to_i
+        @state = elem['state'].to_i
+        @state_timestamp = elem['stateTimestamp'].to_time
+        @online_timestamp = elem['onlineTimestamp'].to_time
       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
+    # Returns the starbase details for the Starbase whose item id is starbase_id
     # 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
+    # * state ( Fixnum ) - State of the starbase (Refer to CCP database dump invtypes)
+    # * state_timestamp ( Time ) - Depents on state
+    # * online_timestamp ( Time ) - Since when this starbase is online
+    # * general_settings ( StarbaseGeneralSettings ) - See StarbaseGeneralSettings
+    # * combat_settings ( StarbaseCombatSettings ) - See StarbaseCombatSettings
+    # * fuel ( [StarbaseFuel ] ) - See StarbaseFuel
+    # See Also: Starbase, StarbaseGeneralSettings, StarbaseCombatSettings, StarbaseFuel, Reve::API#starbase_details, Reve::API#starbases
+    class StarbaseDetails
+      attr_reader :state, :state_timestamp, :online_timestamp
+      attr_accessor :general_settings, :combat_settings, :fuel
+      
+      def initialize(elem, general_settings, combat_settings, fuel) #:nodoc:
+        @state = elem[:state].to_i
+        @state_timestamp = elem[:state_timestamp].to_time
+        @online_timestamp = elem[:online_timestamp].to_time
+        @general_settings = general_settings
+        @combat_settings = combat_settings
+        @fuel = fuel
+      end
+    end
+    
+    class StarbaseGeneralSettings
+      attr_reader :usage_flags, :deploy_flags, :allow_corporation_members,
+                  :allow_alliance_members, :claim_sovereignty
+      def initialize(elem) #:nodoc:
+        @usage_flags                = elem['usageFlags'].to_i
+        @deploy_flags               = elem['deployFlags'].to_i
+        @allow_corporation_members  = elem['allowCorporationMembers'] == '1'
+        @allow_alliance_members     = elem['allowAllianceMembers'] == '1'
+        @claim_sovereignty          = elem['claimSovereignty'] == '1'
+      end
+    end
+    
+    class StarbaseCombatSettings
+      attr_reader :on_standings_drop, :on_status_drop, :on_aggression, :on_corporation_war
+      def initialize(elem) #:nodoc:
+        @on_standings_drop  = elem['onStandingDrop'].attr('standing').to_i
+        @on_status_drop     = (elem['onStatusDrop'].attr('enabled') == '1' ? elem['onStatusDrop'].attr('standing').to_i : false)
+        @on_aggression      = elem['onAggression'].attr('enabled') == '1'
+        @on_corporation_war = elem['onCorporationWar'].attr('enabled') == '1'
+      end
+    end
+    
     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
@@ -1308,5 +1448,62 @@ module Reve #:nodoc:
     # See WalletTransaction
     class PersonalWalletTransaction < WalletTransaction
     end
+    
+    # Represents a MailingList for
+    # Reve::API#personal_mailing_lists
+    # Attributes
+    # * id ( Fixnum ) - ID of the MailingList (use this in the Reve::API#mail_messages call)
+    # * name ( String ) - Name of the MailingList
+    class MailingList
+      attr_reader :id, :name
+      def initialize(elem) #:nodoc:
+        @id = elem['listID'].to_i
+        @name = elem['displayName']
+      end      
+    end
+    
+    # Represents a MailMessage for
+    # Reve::API#personal_mail_messages
+    # Attributes
+    # * id ( Fixnum ) - The unique message ID number. 
+    # * sender_id ( Fixnum ) - The character ID of the message originator. (use Reve::API#character_name to get their names)
+    # * send_date ( Time ) - The date the message was sent. 
+    # * title ( String ) - The title of the message 
+    # * to_corp_or_alliance_id ( Fixnum ) - The ID of a corporation/alliance that the message was sent to. 
+    # * to_character_ids ( [Fixnum] ) - Array of character IDs of the characters that received the message. 
+    # * to_list_ids ( [Fixnum] ) - Array of mailing lists that the mail was sent to. (use Reve::API#personal_mailing_lists to get their names)
+    # * read ( Boolean ) - Whether the mail/notification has been read in the EVE client. This does not change when you get it through the API. 
+    class MailMessage
+      attr_reader :id, :name, :sender_id, :send_date, :title, :to_corp_or_alliance_id, :to_character_ids, :to_list_ids, :read
+      def initialize(elem) #:nodoc:
+        @id = elem['messageID'].to_i
+        @sender_id = elem['senderID'].to_i
+        @send_date = elem['sentDate'].to_time
+        @title = elem['title']
+        @to_corp_or_alliance_id = elem['toCorpOrAllianceID'] == '' ? nil : elem['toCorpOrAllianceID'].to_i
+        @to_character_ids = elem['toCharacterIDs'] == '' ? nil : elem['toCharacterIDs'].split(',').collect {|id| id.to_i }
+        @to_list_ids = elem['toListID'] == '' ? nil : elem['toListID'].split(',').collect {|id| id.to_i }
+        @read = elem['read'] == '1'
+      end      
+    end
+    
+    # Represents a Notification for
+    # Reve::API#personal_notifications
+    # Attributes
+    # * id ( Fixnum ) - The unique notification ID number.
+    # * notification_type_id ( Fixnum ) - The notification type indicates what has happened but not who performed the action in question nor upon whom the action was performed. See http://wiki.eve-id.net/APIv2_Char_Notifications_XML for a list of ids
+    # * sender_id ( Fixnum ) - TThe ID of the entity that sent the notification. 
+    # * send_date ( Time ) - The ID of the entity that sent the notification. 
+    # * read ( Boolean ) - Whether the notification has been read in the EVE client. This does not change when you get it through the API. 
+    class Notification
+      attr_reader :id, :name, :notification_type_id, :sender_id, :send_date, :read
+      def initialize(elem) #:nodoc:
+        @id = elem['notificationID'].to_i
+        @notification_type_id = elem['typeID'].to_i
+        @sender_id = elem['senderID'].to_i
+        @send_date = elem['sentDate'].to_time
+        @read = elem['read'] == '1'
+      end      
+    end
   end
 end

data/lib/reve/exceptions.rb

@@ -57,6 +57,8 @@ module Reve
         raise UnexpectedBeforeKillID.new(msg)
       when 121
         raise BadBeforeKillID.new(msg)
+      when 122
+        raise InvalidOrMissingListOfNames.new(msg)
       when 200
         raise SecurityLevelNotHighEnough.new(msg + ' (Should you be using the full API Key?)')
       when 201
@@ -214,6 +216,9 @@ module Reve
     # 121
     class BadBeforeKillID < ReveError #:nodoc:
     end
+    # 122
+    class InvalidOrMissingListOfNames < ReveError #:nodoc:
+    end
     # 200
     class SecurityLevelNotHighEnough < ReveError #:nodoc:
     end

data/lib/reve/extensions.rb

@@ -1,4 +1,4 @@
-require 'parsedate'
+require 'time'
 
 module Reve #:nodoc:
   # All of these are shamelessly nicked from Ruby on Rails. 
@@ -78,16 +78,16 @@ module Reve #:nodoc:
         cattr_writer(*syms)
       end
     end
-
     module String
       def to_time(form = :utc)
         begin
-          ::Time.send(form, *ParseDate.parsedate(self))
-        rescue Exception
+          return Time.parse(self + ' +00:00')
+        rescue Exception => e
           self
         end
       end
     end
+
   end
 end
 
@@ -105,4 +105,16 @@ end
 
 class NilClass #:nodoc:
   include Reve::Extensions::NilClass
-end
+end
+
+class Object
+  def rsend(*args, &block)
+    obj = self
+    args.each do |a|
+      b = (a.is_a?(Array) && a.last.is_a?(Proc) ? a.pop : block)
+      obj = obj.__send__(*a, &b)
+    end
+    obj
+  end
+  alias_method :__rsend__, :rsend
+end