reve 0.0.132 → 0.0.133

data/VERSION

@@ -1 +1 @@
-0.0.132
+0.0.133

data/lib/reve.rb

@@ -17,6 +17,7 @@ require 'uri'
 require 'cgi'
 require 'digest'
 require 'fileutils'
+require 'time'
 
 $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
@@ -90,9 +91,13 @@ module Reve
     @@corp_member_medals_url       = 'http://api.eve-online.com/corp/MemberMedals.xml.aspx'
     @@server_status_url            = 'http://api.eve-online.com/Server/ServerStatus.xml.aspx'
     @@research_url                 = 'http://api.eve-online.com/char/Research.xml.aspx'
-    @@personal_notification_url = 'http://api.eve-online.com/char/Notifications.xml.aspx'
-    @@personal_mailing_lists_url = 'http://api.eve-online.com/char/mailinglists.xml.aspx'
-    @@personal_mail_messages_url = 'http://api.eve-online.com/char/MailMessages.xml.aspx'
+    @@personal_notification_url    = 'http://api.eve-online.com/char/Notifications.xml.aspx'
+    @@personal_mailing_lists_url   = 'http://api.eve-online.com/char/mailinglists.xml.aspx'
+    @@personal_mail_messages_url   = 'http://api.eve-online.com/char/MailMessages.xml.aspx'
+    @@personal_contacts_url        = 'http://api.eve-online.com/char/ContactList.xml.aspx'
+    @@corporate_contacts_url       = 'http://api.eve-online.com/corp/ContactList.xml.aspx'
+    @@account_status_url           = 'http://api.eve-online.com/account/AccountStatus.xml.aspx'
+    @@character_info_url           = 'http://api.eve-online.com/eve/CharacterInfo.xml.aspx'
     
     cattr_accessor :character_sheet_url, :training_skill_url, :characters_url, :personal_wallet_journal_url,
                    :corporate_wallet_journal_url, :personal_wallet_trans_url, :corporate_wallet_trans_url,
@@ -107,7 +112,8 @@ module Reve
                    :certificate_tree_url, :character_medals_url, :corporate_medals_url, 
                    :corp_member_medals_url, :server_status_url, :skill_queue_url, :corporation_member_security_url,
                    :personal_notification_url, :personal_mailing_lists_url, :personal_mail_messages_url,
-                   :research_url
+                   :research_url, :personal_contacts_url, :corporate_contacts_url,
+                   :account_status_url, :character_info_url
 
 
     attr_accessor :key, :userid, :charid
@@ -294,7 +300,23 @@ module Reve
       return h if h
       process_query(Reve::Classes::CorporateIndustryJob, opts[:url] || @@corporate_industry_jobs_url,false,args)
     end
-
+    
+    # Returns a list of Reve::Classes::PersonalContact objects.
+    def personal_contacts(opts = {:characterid => nil})
+      args = postfields(opts)
+      h = compute_hash(args.merge(:url => @@personal_contacts_url))
+      return h if h
+      process_query(Reve::Classes::PersonalContact, opts[:url] || @@personal_contacts_url,false,args)
+    end
+    
+    # Returns a list of Reve::Classes::CorporateContact objects.
+    def corporate_contacts(opts = {:characterid => nil})
+      args = postfields(opts)
+      h = compute_hash(args.merge(:url => @@corporate_contacts_url))
+      return h if h
+      process_query(Reve::Classes::PersonalContact, opts[:url] || @@corporate_contacts_url,false,args)
+    end
+        
     # Returns the SkillTree from
     # http://api.eve-online.com/eve/SkillTree.xml.aspx
     # See also: Reve::Classes::SkillTree
@@ -940,6 +962,26 @@ module Reve
       process_query(Reve::Classes::MailMessage, opts[:url] || @@personal_mail_messages_url,false,args)
     end
 
+    # Gets the status of the selected account. Returns
+    # Reve::Classes::AccountStatus
+    def account_status(opts = {})
+      args = postfields(opts)
+      h = compute_hash(args.merge(:url => @@account_status_url))
+      return h if h
+      xml = process_query(nil,opts[:url] || @@account_status_url,true,args)
+      Reve::Classes::AccountStatus.new(xml.search('//result').first)
+    end
+    
+    # Gets the character info sheet for the selected Character
+    # Reve::Classes::CharacterInfo
+    def character_info(opts = { :characterid => nil })
+      args = postfields(opts)
+      h = compute_hash(args.merge(:url => @@character_info_url))
+      return h if h
+      xml = process_query(nil,opts[:url] || @@character_info_url,true,args)
+      Reve::Classes::CharacterInfo.new(xml.search('//result').first)
+    end
+
     protected
     # Sets up the post fields for Net::HTTP::Get hash for process_query method.
     # See also format_url_request

data/lib/reve/classes.rb

@@ -159,6 +159,24 @@ module Reve #:nodoc:
       end      
     end
     
+    # Represents a single Contact
+    # Attributes:
+    # * contact_id ( Fixnum ) - ID of the Contact.
+    # * contact_name ( String ) - Name of the belligerant Contact.
+    # * in_watchlist ( Fixnum ) - Whether or not the Contact is in the watchlist.
+    # * standing ( String ) - The standing of the Contact.
+    class PersonalContact
+      attr_reader :contact_id, :contact_name, :in_watchlist, :standing
+      def initialize(elem) #:nodoc:
+        @contact_id = elem['contactID'].to_i
+        @contact_name = elem['contactName']
+        @in_watchlist = elem['inWatchlist'] == 'True' ?  true : false
+        @standing     = elem['standing'].to_i
+      end      
+    end
+    
+    class CorporateContact < PersonalContact; end
+    
     # The status of a System with regards to a FactionWar. Who controls what 
     # and what System is contested
     # Attributes:
@@ -1503,5 +1521,84 @@ module Reve #:nodoc:
         @read = elem['read'] == '1'
       end      
     end
+    
+    # Represents a AccountStatus for
+    # Reve::API#account_status
+    # Attributes
+    # * user_id ( Fixnum ) - The account's userID
+    # * paid_until ( Time ) - DateTime until when the account is still active.
+    # * created_at ( Time ) - DateTime when the account was created.
+    # * logon_count ( Fixnum ) - The amount of times the User logged in.
+    # * logon_minutes ( Fixnum ) - The amount of minutes the user was logged in.
+    # GTC buy offers not yet inplemented 
+    class AccountStatus
+      attr_reader :user_id, :paid_until, :created_at, :logon_count, :logon_minutes
+      def initialize(elem) #:nodoc:
+        @user_id = (elem/'userID').inner_html.to_i
+        @paid_until = Time.parse((elem/'paidUntil').inner_html)
+        @created_at = Time.parse((elem/'createDate').inner_html)
+        @logon_count = (elem/'logonCount').inner_html.to_i
+        @logon_minutes = (elem/'logonMinutes').inner_html.to_i
+      end
+    end
+    
+    # Represents a CharacterInfo for
+    # Reve::API#character_info
+    # Basic Attributes
+    # * id ( Fixnum ) - ID of the Character
+    # * name ( String ) - Name of the Character
+    # * race ( String ) - Race of the Character
+    # * bloodline ( String ) - Bloodline of the Character
+    # * corporation_id ( Fixnum ) - ID of the Corporation the Character is in
+    # * corporation_name ( String ) - Name of the Corporation the Character is in
+    # * corporation_date ( Time ) - Date the Character joined his Corporation
+    # * alliance_id ( Fixnum | NilClass ) - The ID of the Alliance the Character is in, if any. Will be nil unless the victim was in an Alliance
+    # * alliance_name ( String  | NilClass ) - Name of the Alliance the Character is in, if any.
+    # * alliance_date ( Time | NilClass ) - Date the Character's Corporations joined the Alliance.
+    # * security_status ( Float ) - Security status of the Character
+    # Limited Attributes
+    # * skillpoints ( Fixnum ) - The amount of Skillpoints
+    # * skill_training_ends ( Time )- 
+    # * ship_name ( String ) - 
+    # * ship_type_id ( Fixnum ) -
+    # * ship_type_name ( String ) - 
+    # Full Attributes
+    # * last_known_location ( String ) -
+    # * acount_balance ( Float )
+    class CharacterInfo
+      attr_reader :id, :name, :race, :bloodline, :corporation_id, :corporation_name, :corporation_date, :alliance_id, :alliance_name, :alliance_date
+      attr_reader :security_status, :skillpoints, :skill_training_ends, :ship_name, :ship_type_id, :ship_type_name, :last_known_location, :acount_balance
+
+      def initialize(elem) #:nodoc:
+        @id = (elem/'characterID').inner_html.to_i
+        @name = (elem/'characterName').inner_html
+        @race = (elem/'race').inner_html
+        @bloodline = (elem/'bloodline').inner_html
+        @corporation_id = (elem/'corporationID').inner_html.to_i
+        @corporation_name = (elem/'corporation').inner_html
+        @corporation_date = Time.parse((elem/'corporationDate').inner_html)
+        @alliance_id = (elem/'allianceID').inner_html.to_i
+        @alliance_name = (elem/'alliance').inner_html
+        @alliance_date = Time.parse((elem/'alliancenDate').inner_html)
+        @security_status  = (elem/'securityStatus').inner_html.to_f
+        @skillpoints = (elem/'skillPoints').inner_html == "" ? nil : (elem/'skillPoints').inner_html.to_i
+        @skill_training_ends = (elem/'nextTrainingEnds').inner_html == "" ? nil : Time.parse((elem/'nextTrainingEnds').inner_html)
+        @ship_name = (elem/'shipName').inner_html == "" ? nil : (elem/'shipName').inner_html
+        @ship_type_id = (elem/'shipTypeID').inner_html == "" ? nil : (elem/'shipTypeID').inner_html.to_i
+        @ship_type_name = (elem/'shipTypeName').inner_html == "" ? nil : (elem/'shipTypeName').inner_html
+        @last_known_location = (elem/'lastKnownLocation').inner_html == "" ? nil : (elem/'lastKnownLocation').inner_html
+        @acount_balance = (elem/'accountBalance').inner_html == "" ? nil : (elem/'accountBalance').inner_html.to_f
+      end
+      
+      def type
+        if self.acount_balance
+          return :full
+        elsif self.skillpoints
+          return :limited
+        else
+          return :basic
+        end
+      end
+    end
   end
 end

data/test/test_reve.rb

@@ -295,6 +295,26 @@ class TestReve < Test::Unit::TestCase
     end
   end
   
+  def test_personal_contacts_clean
+    Reve::API.personal_contacts_url = XML_BASE + 'char_contacts.xml'
+    contacts = @api.personal_contacts
+    assert_equal(2, contacts.length)
+    assert_equal("Hirento Raikkanen", contacts.first.contact_name )
+    assert_equal(3010913, contacts.first.contact_id )
+    assert_equal(false, contacts.first.in_watchlist )
+    assert_equal(0, contacts.first.standing )
+  end
+  
+  def test_corporate_contacts_clean
+    Reve::API.corporate_contacts_url = XML_BASE + 'char_contacts.xml'
+    contacts = @api.corporate_contacts
+    assert_equal(2, contacts.length)
+    assert_equal("Hirento Raikkanen", contacts.first.contact_name )
+    assert_equal(3010913, contacts.first.contact_id )
+    assert_equal(false, contacts.first.in_watchlist )
+    assert_equal(0, contacts.first.standing )
+  end
+  
   def test_faction_war_system_stats_clean(skip_preamble = false,stats = nil)
     Reve::API.faction_war_occupancy_url = XML_BASE + 'map_facwarsystems.xml'
     unless skip_preamble # not best practice but will get the job done!
@@ -1189,6 +1209,74 @@ class TestReve < Test::Unit::TestCase
     assert_equal [128250439,141157801], mails[4].to_list_ids
   end
 
+  def test_account_status_cleanly
+    Reve::API.account_status_url = XML_BASE + 'account_status.xml'
+    status = nil
+    assert_nothing_raised do
+      status = @api.account_status
+    end
+    assert_equal 3000000, status.user_id
+    assert_equal Time.parse("2004-01-01 00:00:00"), status.created_at
+    assert_equal Time.parse("2011-01-01 00:00:00"), status.paid_until
+    assert_equal 9998, status.logon_count
+    assert_equal 9999, status.logon_minutes
+    
+  end
+  
+  def test_character_info_cleanly
+    Reve::API.character_info_url = XML_BASE + 'char_info.xml'
+    info = nil
+    assert_nothing_raised do
+      info = @api.character_info
+    end
+    assert_equal :basic, info.type
+    assert_equal 1643072492, info.id
+    assert_equal 'Catari Taga', info.name
+    assert_equal 'Caldari', info.race
+    assert_equal 'Achura', info.bloodline
+    assert_equal 553239300, info.corporation_id
+    assert_equal 'Centre Of Attention', info.corporation_name
+    assert_equal Time.parse('2009-02-03 13:06:00'), info.corporation_date
+    assert_equal 1923227030, info.alliance_id
+    assert_equal 'Middle of Nowhere', info.alliance_name
+    assert_equal Time.parse('2009-02-03 13:06:00'), info.alliance_date
+    assert_equal 0.0, info.security_status
+    # limited
+    assert_equal nil, info.skillpoints
+    assert_equal nil, info.skill_training_ends
+    assert_equal nil, info.ship_name
+    assert_equal nil, info.ship_type_id
+    assert_equal nil, info.ship_type_name
+
+  end
+  
+  def test_character_info_limited_cleanly
+    Reve::API.character_info_url = XML_BASE + 'char_info_limited.xml'
+    info = nil
+    assert_nothing_raised do
+      info = @api.character_info
+    end
+    assert_equal :limited, info.type
+    assert_equal 9999, info.skillpoints
+    assert_equal Time.parse('2010-10-10 08:10:48'), info.skill_training_ends
+    assert_equal '.', info.ship_name
+    assert_equal 24694, info.ship_type_id
+    assert_equal 'Maelstrom', info.ship_type_name
+    # full
+    assert_equal nil, info.last_known_location
+    assert_equal nil, info.acount_balance
+  end
+  
+  def test_character_info_full_cleanly
+    Reve::API.character_info_url = XML_BASE + 'char_info_full.xml'
+    info = nil
+    assert_nothing_raised do
+      info = @api.character_info
+    end
+    assert_equal :full, info.type
+    assert_equal 'FD-MLJ VII - Moon 2 - Intaki Bank Investment Bank', info.last_known_location
+    assert_equal 9999.29, info.acount_balance
+  end
   # Can we reassign a URL?
   def test_assignment
     assert_nothing_raised do
@@ -1270,7 +1358,7 @@ class TestReve < Test::Unit::TestCase
   def test_reve_version
     # Path to Reve version is ../VERSION. We rely on File.read here and in the
     # class so it's kind of crummy.
-    version = File.read(File.join(File.dirname(__FILE__),'../','VERSION'))
+    version = File.read(File.join(File.dirname(__FILE__),'../','VERSION')).chomp
     assert_equal(@api.reve_version, version)
     assert_equal("Reve v#{version}; http://github.com/lisa/reve", @api.http_user_agent)
   end

data/test/xml/account_status.xml

@@ -0,0 +1,13 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2010-10-05 20:28:55</currentTime>
+  <result>
+    <userID>3000000</userID>
+    <paidUntil>2011-01-01 00:00:00</paidUntil>
+    <createDate>2004-01-01 00:00:00</createDate>
+    <logonCount>9998</logonCount>
+    <logonMinutes>9999</logonMinutes>
+    <rowset name="Offers" key="offerID" columns="offerID,offeredDate,from,to,ISK" />
+  </result>
+  <cachedUntil>2010-10-05 20:33:55</cachedUntil>
+</eveapi>

data/test/xml/char_contacts.xml

@@ -0,0 +1,11 @@
+<eveapi version="2">
+  <currentTime>2010-05-29 22:35:46</currentTime>
+  <result>
+    <rowset name="contactList" key="contactID" columns="contactID,contactName,inWatchlist,standing">
+      <row contactID="3010913" contactName="Hirento Raikkanen" inWatchlist="False" standing="0" />
+      <row contactID="797400947" contactName="CCP Garthagk" inWatchlist="True" standing="10" />
+    </rowset>
+  </result>
+  <cachedUntil>2010-05-29 22:50:46</cachedUntil>
+</eveapi>
+ 

data/test/xml/char_info.xml

@@ -0,0 +1,18 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2010-10-05 19:45:21</currentTime>
+  <result>
+    <characterID>1643072492</characterID>
+    <characterName>Catari Taga</characterName>
+    <race>Caldari</race>
+    <bloodline>Achura</bloodline>
+    <corporationID>553239300</corporationID>
+    <corporation>Centre Of Attention</corporation>
+    <corporationDate>2009-02-03 13:06:00</corporationDate>
+    <allianceID>1923227030</allianceID>
+    <alliance>Middle of Nowhere</alliance>
+    <alliancenDate>2009-02-03 13:06:00</alliancenDate>
+    <securityStatus>0.0</securityStatus>
+  </result>
+  <cachedUntil>2010-10-05 20:41:58</cachedUntil>
+</eveapi>

data/test/xml/char_info_full.xml

@@ -0,0 +1,25 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2010-10-05 19:41:58</currentTime>
+  <result>
+    <characterID>1643072492</characterID>
+    <characterName>Catari Taga</characterName>
+    <race>Caldari</race>
+    <bloodline>Achura</bloodline>
+    <accountBalance>9999.29</accountBalance>
+    <skillPoints>9999</skillPoints>
+    <nextTrainingEnds>2010-10-10 08:10:48</nextTrainingEnds>
+    <shipName>.</shipName>
+    <shipTypeID>24694</shipTypeID>
+    <shipTypeName>Maelstrom</shipTypeName>
+    <corporationID>553239300</corporationID>
+    <corporation>Centre Of Attention</corporation>
+    <corporationDate>2009-02-03 13:06:00</corporationDate>
+    <allianceID>1923227030</allianceID>
+    <alliance>Middle of Nowhere</alliance>
+    <alliancenDate>2009-02-03 13:06:00</alliancenDate>
+    <lastKnownLocation>FD-MLJ VII - Moon 2 - Intaki Bank Investment Bank</lastKnownLocation>
+    <securityStatus>0.0</securityStatus>
+  </result>
+  <cachedUntil>2010-10-05 20:41:58</cachedUntil>
+</eveapi>

data/test/xml/char_info_limited.xml

@@ -0,0 +1,23 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2010-10-05 19:41:58</currentTime>
+  <result>
+    <characterID>1643072492</characterID>
+    <characterName>Catari Taga</characterName>
+    <race>Caldari</race>
+    <bloodline>Achura</bloodline>
+    <skillPoints>9999</skillPoints>
+    <nextTrainingEnds>2010-10-10 08:10:48</nextTrainingEnds>
+    <shipName>.</shipName>
+    <shipTypeID>24694</shipTypeID>
+    <shipTypeName>Maelstrom</shipTypeName>
+    <corporationID>553239300</corporationID>
+    <corporation>Centre Of Attention</corporation>
+    <corporationDate>2009-02-03 13:06:00</corporationDate>
+    <allianceID>1923227030</allianceID>
+    <alliance>Middle of Nowhere</alliance>
+    <alliancenDate>2009-02-03 13:06:00</alliancenDate>
+    <securityStatus>0.0</securityStatus>
+  </result>
+  <cachedUntil>2010-10-05 20:41:58</cachedUntil>
+</eveapi>

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 132
-  version: 0.0.132
+  - 133
+  version: 0.0.133
 platform: ruby
 authors: 
 - Lisa Seelye
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-03 00:00:00 -04:00
+date: 2010-11-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,11 +82,16 @@ specification_version: 3
 summary: Reve is a Ruby library to interface with the Eve Online API
 test_files: 
 - test/test_reve.rb
+- test/xml/account_status.xml
 - test/xml/alliances.xml
 - test/xml/assets.xml
 - test/xml/badxml.xml
 - test/xml/certificate_tree.xml
+- test/xml/char_contacts.xml
 - test/xml/char_facwarstats.xml
+- test/xml/char_info.xml
+- test/xml/char_info_full.xml
+- test/xml/char_info_limited.xml
 - test/xml/char_medals.xml
 - test/xml/character_sheet.xml
 - test/xml/characterid.xml