dsander-reve 0.0.120 → 0.0.121

data/Rakefile

@@ -58,11 +58,11 @@ elsif File.exists?('.git')
   begin
     require 'jeweler'
     Jeweler::Tasks.new do |s|
-      s.name = "dsander-reve"
+      s.name = "reve"
       s.rubyforge_project = "reve"
       s.author = "Lisa Seelye"
       s.email = "lisa@thedoh.com"
-      s.homepage = "http://github.com/lisa/reve"
+      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
@@ -72,21 +72,8 @@ elsif File.exists?('.git')
       s.extra_rdoc_files = ["ChangeLog"]
       s.add_dependency("hpricot",">= 0.6")
     end
-    Jeweler::GemcutterTasks.new
   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
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end

data/init.rb

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

data/lib/reve.rb

@@ -87,6 +87,7 @@ module Reve
     @@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'
@@ -103,7 +104,8 @@ module Reve
                    :general_faction_war_stats_url, :top_faction_war_stats_url, :faction_war_occupancy_url,
                    :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
+                   :personal_notification_url, :personal_mailing_lists_url, :personal_mail_messages_url,
+                   :research_url
 
 
     attr_accessor :key, :userid, :charid
@@ -339,6 +341,19 @@ module Reve
       return h if h
       process_query(Reve::Classes::MemberTracking,opts[:url] || @@member_tracking_url,false,args)
     end
+    
+    
+    # Gets one's research stats from agents
+    # http://api.eve-online/char/Research.xml.aspx
+    # Expects:
+    # * characterid ( Integer | String ) - Get stats for this Character
+    # See also: Reve::Classes::Research
+    def research(opts = { :characterid => nil })
+      args = postfields(opts)
+      h = compute_hash(args.merge(:url => @@research_url))
+      return h if h
+      process_query(Reve::Classes::Research,opts[:url] || @@research_url,false,args)      
+    end
 
     # Gets one's own personal WalletBalance from
     # http://api.eve-online.com/char/AccountBalance.xml.aspx
@@ -647,21 +662,46 @@ module Reve
       process_query(Reve::Classes::Starbase,opts[:url] || @@starbases_url,false,args)
     end
     
-    # Returns the fuel status for the Starbase whose item id is starbase_id
+    # Returns the starbase details for the Starbase whose item id is starbase_id
     # http://api.eve-online.com/corp/StarbaseDetail.xml.aspx
     # Expects:
     # * characterid ( Integer | String ) - Get the Starbase associated wih this character's Corporation
-    # * starbase_id ( Integer ) - Get the fuel for this Starbase. This is the Starbase's itemid.
-    # See also Reve::Classes::StarbaseFuel
-    def starbase_fuel(opts = { :characterid => nil, :starbaseid => nil })
+    # * starbaseid ( Integer ) - Get the fuel for this Starbase. This is the Starbase's itemid.
+    # See also Reve::Classes::StarbaseDetails
+    def starbase_details(opts = { :characterid => nil, :starbaseid => nil })
+      opts[:itemid] = opts.delete(:starbaseid)
       args = postfields(opts)
       h = compute_hash(args.merge(:url => @@starbasedetail_url))
       return h if h
-      ret = process_query(Reve::Classes::StarbaseFuel,opts[:url] || @@starbasedetail_url, false, args)
-      ret.each { |r| r.starbase_id = opts[:starbaseid] }
-      ret
+      xml = process_query(Reve::Classes::StarbaseDetails,opts[:url] || @@starbasedetail_url, true, args)
+      
+      state = xml.search("/eveapi/result/state").inner_text
+      state_timestamp = xml.search("/eveapi/result/stateTimestamp").inner_text
+      online_timestamp = xml.search("/eveapi/result/onlineTimestamp").inner_text
+      
+      h = {'usageFlags' => 0, 'deployFlags' => 0, 'allowCorporationMembers' => 0, 'allowAllianceMembers' => 0, 'claimSovereignty' => 0}
+      h.keys.each {|k| h[k] = xml.search("/eveapi/result/generalSettings/#{k}").inner_text }
+      general_settings = Reve::Classes::StarbaseGeneralSettings.new(h)
+      
+      h = {'onStandingDrop' => 0, 'onStatusDrop' => 0, 'onAggression' => 0, 'onCorporationWar' => 0}
+      h.keys.each {|k| h[k] = xml.search("/eveapi/result/combatSettings/#{k}") }
+      combat_settings = Reve::Classes::StarbaseCombatSettings.new(h)
+      
+      fuel = []
+      xml.search("/eveapi/result/rowset[@name='fuel']/row").each do |entry|
+        fuel << Reve::Classes::StarbaseFuel.new(entry)
+      end
+      
+      res = Hash.new
+      { :state => :state, :stateTimestamp => :state_timestamp, :onlineTimestamp => :online_timestamp }.each do |k,v|
+        res[v] = xml.search("/eveapi/result/#{k.to_s}/").first.to_s.strip
+      end
+      
+      Reve::Classes::StarbaseDetails.new res, general_settings, combat_settings, fuel
     end
     
+    alias_method  :starbase_fuel, :starbase_details
+    
     
     # Get the last kills for the characterid passed.
     # Expects:

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
@@ -1255,35 +1274,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

data/test/test_reve.rb

@@ -82,6 +82,7 @@ class TestReve < Test::Unit::TestCase
       File.open(File.join(SAVE_PATH,'alliances',@api.cached_until.to_i.to_s + '.xml')).read)
   end
   
+
   def test_saving_xml_when_save_path_is_nil
     assert_nil @api.save_path
     alliances = @api.alliances :url => File.join(XML_BASE,'alliances.xml')
@@ -134,6 +135,25 @@ class TestReve < Test::Unit::TestCase
     end
   end
   
+  def test_research_api_call
+    Reve::API.research_url = XML_BASE + 'research.xml'
+    research = nil
+    assert_nothing_raised do
+      research = @api.research :characterid => 123
+    end
+    assert_not_nil(research)
+    assert_not_nil(@api.last_hash)
+    assert_equal(4, research.size)
+    research.each do |ri|
+      assert_kind_of(Fixnum, ri.agent_id)
+      assert_kind_of(Fixnum, ri.skill_type_id)
+      assert_kind_of(Time, ri.research_started_at)
+      assert_kind_of(Float, ri.points_per_day)
+      assert_kind_of(Float, ri.remainder_points)
+    end
+  end
+  
+  
   def test_corporation_sheet_clean
     Reve::API.corporation_sheet_url = XML_BASE + 'corporation_sheet.xml'
     corporation = nil
@@ -488,24 +508,42 @@ class TestReve < Test::Unit::TestCase
     bases.each do |starbase|
       assert_instance_of Reve::Classes::Starbase, starbase
       assert_not_nil starbase.type_id
-      assert_not_nil starbase.type_name
       assert_not_nil starbase.id
       assert_not_nil starbase.system_id
-      assert_not_nil starbase.system_name
+      assert_not_nil starbase.moon_id
+      assert_not_nil starbase.state
+      assert_not_nil starbase.state_timestamp
+      assert_not_nil starbase.online_timestamp
     end
   end
   
-  def test_starbase_fuel_clean
+  def test_starbase_details_clean
     Reve::API.starbasedetail_url = XML_BASE + 'starbase_fuel.xml'
-    fuels = nil
+    detail = nil
     assert_nothing_raised do
-      fuels = @api.starbase_fuel(:starbaseid => 1,:characterid => 2)
+      detail = @api.starbase_details(:starbaseid => 1,:characterid => 2)
     end
     assert_not_nil @api.last_hash
     assert_kind_of Time, @api.cached_until
-    assert_equal 14, fuels.size
-    fuels.each do |fuel|
-      assert_equal 1, fuel.starbase_id
+    
+    assert_not_nil detail.state
+    assert_kind_of Time, detail.state_timestamp
+    assert_kind_of Time, detail.online_timestamp
+    assert_instance_of Reve::Classes::StarbaseGeneralSettings, detail.general_settings
+    assert_instance_of Reve::Classes::StarbaseCombatSettings, detail.combat_settings
+    assert_equal 9, detail.fuel.size
+    
+    assert_not_nil detail.general_settings.usage_flags
+    assert [TrueClass, FalseClass].include?(detail.general_settings.allow_corporation_members.class)
+    assert [TrueClass, FalseClass].include?(detail.general_settings.allow_alliance_members.class)
+    assert [TrueClass, FalseClass].include?(detail.general_settings.claim_sovereignty.class)
+    
+    assert_not_nil detail.combat_settings.on_standings_drop
+    assert_not_nil detail.combat_settings.on_status_drop
+    assert_not_nil detail.combat_settings.on_aggression
+    assert_not_nil detail.combat_settings.on_corporation_war
+    
+    detail.fuel.each do |fuel|
       assert_not_nil fuel.type_id
       assert_not_nil fuel.quantity
     end

data/test/xml/starbase_fuel.xml

@@ -1,23 +1,33 @@
-<eveapi version="1">
-  <currentTime>2007-08-16 19:52:38</currentTime>
+<eveapi version="2">
+  <currentTime>2009-11-03 18:52:44</currentTime>
   <result>
-    <stateTimestamp>2007-08-14 13:47:02</stateTimestamp>
+    <state>4</state>
+    <stateTimestamp>2009-11-03 19:27:23</stateTimestamp>
+    <onlineTimestamp>2009-08-03 14:22:44</onlineTimestamp>
+    <generalSettings>
+      <usageFlags>3</usageFlags>
+      <deployFlags>0</deployFlags>
+      <allowCorporationMembers>1</allowCorporationMembers>
+      <allowAllianceMembers>0</allowAllianceMembers>
+      <claimSovereignty>0</claimSovereignty>
+    </generalSettings>
+    <combatSettings>
+      <onStandingDrop standing="200" />
+      <onStatusDrop enabled="0" standing="0" />
+      <onAggression enabled="1" />
+      <onCorporationWar enabled="1" />
+    </combatSettings>
     <rowset name="fuel" key="typeID" columns="typeID,quantity">
-      <row typeID="16272" quantity="60000"/>
-      <row typeID="16273" quantity="60000"/>
-      <row typeID="24597" quantity="400"/>
-      <row typeID="24596" quantity="400"/>
-      <row typeID="24595" quantity="400"/>
-      <row typeID="24594" quantity="400"/>
-      <row typeID="24593" quantity="400"/>
-      <row typeID="24592" quantity="400"/>
-      <row typeID="16274" quantity="148500"/>
-      <row typeID="9848" quantity="330"/>
-      <row typeID="9832" quantity="2640"/>
-      <row typeID="3689" quantity="1650"/>
-      <row typeID="3683" quantity="8250"/>
-      <row typeID="44" quantity="1320"/>
+      <row typeID="16273" quantity="10171" />
+      <row typeID="16272" quantity="9316" />
+      <row typeID="9848" quantity="123" />
+      <row typeID="9832" quantity="492" />
+      <row typeID="3689" quantity="369" />
+      <row typeID="3683" quantity="1599" />
+      <row typeID="44" quantity="246" />
+      <row typeID="16275" quantity="6000" />
+      <row typeID="17887" quantity="27675" />
     </rowset>
   </result>
-  <cachedUntil>2007-08-16 19:52:48</cachedUntil>
+  <cachedUntil>2009-11-03 19:52:44</cachedUntil>
 </eveapi>

data/test/xml/starbases.xml

@@ -1,12 +1,12 @@
 <eveapi version="1">
-  <currentTime>2007-08-16 19:51:38</currentTime>
+  <currentTime>2009-11-02 19:51:38</currentTime>
   <result>
-    <rowset name="starbases" key="itemID" columns="typeID,typeName,itemID,locationID,locationName">
-      <row typeID="12235" typeName="Amarr Control Tower" itemID="150354725" locationID="30000380" locationName="Polaris"/>
-      <row typeID="20059" typeName="Amarr Control Tower Medium" itemID="150354773" locationID="30001984" locationName="EC-P8R"/>
-      <row typeID="12235" typeName="Amarr Control Tower" itemID="150357658" locationID="30001984" locationName="EC-P8R"/>
-      <row typeID="16286" typeName="Ultra Fast Control Tower" itemID="150318232" locationID="30003109" locationName="C9N-CC"/>
+    <rowset name="starbases" key="itemID" columns="itemID,typeID,locationID,moonID,state,stateTimestamp,onlineTimestamp">
+      <row typeID="12235" itemID="150354725" locationID="30000380" moonID="12513141" state="4" stateTimestamp="2009-11-03 17:57:32" onlineTimestamp="2009-11-01 10:57:24" />
+      <row typeID="20059" itemID="150354773" locationID="30001984" moonID="12513142" state="4" stateTimestamp="2009-11-03 15:25:12" onlineTimestamp="2009-10-01 11:24:35" />
+      <row typeID="12235" itemID="150357658" locationID="30001984" moonID="12513143" state="4" stateTimestamp="2009-11-03 17:57:32" onlineTimestamp="2008-07-01 16:10:44"/>
+      <row typeID="16286" itemID="150318232" locationID="30003109" moonID="12513144" state="1" stateTimestamp="2009-11-16 17:57:32" onlineTimestamp="2009-09-01 01:35:02"/>
     </rowset>
   </result>
-  <cachedUntil>2007-08-16 19:51:50</cachedUntil>
+  <cachedUntil>2009-08-16 19:51:50</cachedUntil>
 </eveapi>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dsander-reve
 version: !ruby/object:Gem::Version 
-  version: 0.0.120
+  version: 0.0.121
 platform: ruby
 authors: 
 - Lisa Seelye