dsander-reve 0.0.119 → 0.0.120

data/Rakefile

@@ -58,11 +58,11 @@ elsif File.exists?('.git')
   begin
     require 'jeweler'
     Jeweler::Tasks.new do |s|
-      s.name = "reve"
+      s.name = "dsander-reve"
       s.rubyforge_project = "reve"
       s.author = "Lisa Seelye"
       s.email = "lisa@thedoh.com"
-      s.homepage = "http://revetrac.crudvision.com"
+      s.homepage = "http://github.com/lisa/reve"
       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,8 +72,21 @@ 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 +1,2 @@
+# I make Rails happy.
 require 'reve'

data/lib/reve/classes.rb

@@ -1383,5 +1383,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['toListIDs'] == '' ? nil : elem['toListIDs'].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.rb

@@ -87,7 +87,10 @@ 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'
-
+    @@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'
+    
     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,
                    :personal_wallet_balance_url, :corporate_wallet_balance_url, :member_tracking_url,
@@ -99,7 +102,8 @@ module Reve
                    :personal_faction_war_stats_url, :corporate_faction_war_stats_url,
                    :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
+                   :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
 
 
     attr_accessor :key, :userid, :charid
@@ -855,7 +859,42 @@ module Reve
       
       cs
     end
-
+    
+    # Gets the characters notifications. Returns a list of
+    # Reve::Classes::Notification
+    # Expects:
+    # * characterid ( Integer | String ) - Get the Notifications for this Character
+    # See also: Reve::Classes::Notification
+    def personal_notifications(opts = { :characterid => nil })
+      args = postfields(opts)
+      h = compute_hash(args.merge(:url => @@personal_notification_url))
+      return h if h
+      process_query(Reve::Classes::Notification, opts[:url] || @@personal_notification_url,false,args)
+    end
+    
+    # Gets the characters notifications. Returns a list of
+    # Reve::Classes::MailingList
+    # Expects:
+    # * characterid ( Integer | String ) - Get the MailingLists for this Character
+    # See also: Reve::Classes::MailingList
+    def personal_mailing_lists(opts = { :characterid => nil })
+      args = postfields(opts)
+      h = compute_hash(args.merge(:url => @@personal_mailing_lists_url))
+      return h if h
+      process_query(Reve::Classes::MailingList, opts[:url] || @@personal_mailing_lists_url,false,args)
+    end
+    
+    # Gets the characters notifications. Returns a list of
+    # Reve::Classes::MailMessage
+    # Expects:
+    # * characterid ( Integer | String ) - Get the MailMessages for this Character
+    # See also: Reve::Classes::MailMessage
+    def personal_mail_messages(opts = { :characterid => nil })
+      args = postfields(opts)
+      h = compute_hash(args.merge(:url => @@personal_mail_messages_url))
+      return h if h
+      process_query(Reve::Classes::MailMessage, opts[:url] || @@personal_mail_messages_url,false,args)
+    end
 
     protected
     # Sets up the post fields for Net::HTTP::Get hash for process_query method.

data/test/test_reve.rb

@@ -1,5 +1,6 @@
+# Tests designed to run with autotest.
 require 'test/unit'
-require '../lib/reve'
+require 'reve'
 require 'fileutils' # for saving downloaded XML
 
 XML_BASE = File.join(File.dirname(__FILE__),'xml/')
@@ -1070,6 +1071,63 @@ class TestReve < Test::Unit::TestCase
     
     
     
+  end
+  
+  def test_personal_notifications
+    Reve::API.personal_notification_url = XML_BASE + 'notifications.xml'
+    notifications = nil
+    assert_nothing_raised do
+      notifications = @api.personal_notifications(:characterid => 1)
+    end
+    assert_equal 2, notifications.length
+    assert_equal Reve::Classes::Notification, notifications.first.class
+    assert_equal 200076684, notifications.first.sender_id
+    assert_equal 16, notifications.first.notification_type_id
+    assert_equal Time.parse('2009-12-02 10:54:00 UTC'), notifications.first.send_date
+  end
+
+  def test_personal_mailing_lists
+    Reve::API.personal_mailing_lists_url = XML_BASE + 'mailing_lists.xml'
+    lists = nil
+    assert_nothing_raised do
+      lists = @api.personal_mailing_lists(:characterid => 1)
+    end
+    assert_equal 3, lists.length
+    assert_equal Reve::Classes::MailingList, lists.first.class
+    assert_equal 128250439, lists.first.id
+    assert_equal 'EVETycoonMail', lists.first.name
+    assert_equal 141157801, lists.last.id
+  end
+
+  def test_personal_mail_messages
+    Reve::API.personal_mail_messages_url = XML_BASE + 'mail_messages.xml'
+    mails = nil
+    assert_nothing_raised do
+      mails = @api.personal_mail_messages(:characterid => 1)
+    end
+    assert_equal 5, mails.length
+    assert_equal Reve::Classes::MailMessage, mails.first.class
+    # Corp Mail
+    assert_equal 1, mails.first.sender_id
+    assert_equal Time.parse('2009-12-01 01:04:00 UTC'), mails.first.send_date
+    assert_equal "Corp mail", mails.first.title
+    assert_equal 4, mails.first.to_corp_or_alliance_id
+    assert_equal nil, mails.first.to_character_ids
+    assert_equal nil, mails.first.to_list_ids
+    assert_equal true, mails.first.read
+    # Personal Mail
+    assert_equal nil, mails[1].to_corp_or_alliance_id
+    assert_equal [5], mails[1].to_character_ids
+    assert_equal nil, mails[1].to_list_ids
+    # list Mail
+    assert_equal nil, mails[2].to_corp_or_alliance_id
+    assert_equal nil, mails[2].to_character_ids
+    assert_equal [128250439], mails[2].to_list_ids
+    assert_equal false, mails[2].read
+    # multi personal
+    assert_equal [5,6,7], mails[3].to_character_ids
+    # multi list
+    assert_equal [128250439,141157801], mails[4].to_list_ids
   end
 
   # Can we reassign a URL?

data/test/xml/mail_messages.xml

@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2009-12-02 00:46:10</currentTime>
+  <result>
+    <rowset name="mailMessages" key="messageID" columns="messageID,senderID,sentDate,title,toCorpOrAllianceID,toCharacterIDs,toListIDs,read">
+      <row messageID="290285276" senderID="1" sentDate="2009-12-01 01:04:00" title="Corp mail" toCorpOrAllianceID="4" toCharacterIDs="" toListIDs="" read="1" />
+      <row messageID="290285275" senderID="2" sentDate="2009-12-01 01:04:00" title="Personal mail" toCorpOrAllianceID="" toCharacterIDs="5" toListIDs="" read="1" />
+      <row messageID="290285274" senderID="2" sentDate="2009-12-01 01:04:00" title="Message to mailing list" toCorpOrAllianceID="" toCharacterIDs="" toListIDs="128250439" read="0" />
+      <row messageID="290285278" senderID="2" sentDate="2009-12-01 01:04:00" title="Multi Personal mail" toCorpOrAllianceID="" toCharacterIDs="5,6,7" toListIDs="" read="1" />
+      <row messageID="290285279" senderID="2" sentDate="2009-12-01 01:04:00" title="Multi Message to mailing list" toCorpOrAllianceID="" toCharacterIDs="" toListIDs="128250439,141157801" read="0" />
+    </rowset>
+  </result>
+  <cachedUntil>2009-12-02 01:16:10</cachedUntil>
+</eveapi>
+ 

data/test/xml/mailing_lists.xml

@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2009-12-02 06:29:32</currentTime>
+  <result>
+    <rowset name="mailingLists" key="listID" columns="listID,displayName">
+      <row listID="128250439" displayName="EVETycoonMail" />
+      <row listID="128783669" displayName="EveMarketScanner" />
+      <row listID="141157801" displayName="Exploration Wormholes" />
+    </rowset>
+  </result>
+  <cachedUntil>2009-12-02 12:29:32</cachedUntil>
+</eveapi>

data/test/xml/notifications.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<eveapi version="2">
+  <currentTime>2009-12-03 20:34:09</currentTime>
+  <result>
+    <rowset name="notifications" key="notificationID" columns="notificationID,typeID,senderID,sentDate,read">
+      <row notificationID="290369614" typeID="16" senderID="200076684" sentDate="2009-12-02 10:54:00" read="1"/>
+      <row notificationID="289645395" typeID="1" senderID="1000064" sentDate="2009-11-26 01:34:00" read="0"/>
+    </rowset>
+  </result>
+  <cachedUntil>2009-12-03 21:04:09</cachedUntil>
+</eveapi>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dsander-reve
 version: !ruby/object:Gem::Version 
-  version: 0.0.119
+  version: 0.0.120
 platform: ruby
 authors: 
 - Lisa Seelye
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-09 00:00:00 -07:00
+date: 2009-12-04 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,8 +41,10 @@ files:
 - reve.rb
 - tester.rb
 - ChangeLog
-has_rdoc: false
-homepage: http://revetrac.crudvision.com
+has_rdoc: true
+homepage: http://github.com/lisa/reve
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -63,125 +65,128 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: reve
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Reve is a Ruby library to interface with the Eve Online API
 test_files: 
 - test/test_reve.rb
-- test/xml/corp_membersecurity.xml
-- test/xml/corporate_wallet_transactions.xml
-- test/xml/starbase_fuel.xml
-- test/xml/corporate_assets_list.xml
-- test/xml/characters.xml
-- test/xml/mapjumps.xml
-- test/xml/wallet_balance.xml
-- test/xml/mapkills.xml
-- test/xml/server_status.xml
-- test/xml/skill_in_training-none.xml
-- test/xml/character_sheet.xml
-- test/xml/characterid.xml
-- test/xml/sovereignty.xml
-- test/xml/charactername.xml
-- test/xml/corporate_wallet_journal.xml
-- test/xml/assets.xml
-- test/xml/corp_member_medals.xml
-- test/xml/market_transactions.xml
-- test/xml/eve_facwartopstats.xml
-- test/xml/corporate_market_orders.xml
+- test/xml/map_facwarsystems.xml
+- test/xml/skill_queue.xml
+- test/xml/errors/error_213.xml
+- test/xml/errors/error_521.xml
+- test/xml/errors/error_203.xml
+- test/xml/errors/error_507.xml
+- test/xml/errors/error_112.xml
+- test/xml/errors/error_202.xml
+- test/xml/errors/error_210.xml
 - test/xml/errors/error_100.xml
-- test/xml/errors/error_101.xml
-- test/xml/errors/error_102.xml
-- test/xml/errors/error_103.xml
-- test/xml/errors/error_104.xml
-- test/xml/errors/error_105.xml
-- test/xml/errors/error_106.xml
-- test/xml/errors/error_107.xml
-- test/xml/errors/error_108.xml
-- test/xml/errors/error_109.xml
-- test/xml/errors/error_110.xml
+- test/xml/errors/error_209.xml
+- test/xml/errors/error_518.xml
 - test/xml/errors/error_111.xml
-- test/xml/errors/error_112.xml
-- test/xml/errors/error_113.xml
-- test/xml/errors/error_114.xml
-- test/xml/errors/error_115.xml
-- test/xml/errors/error_116.xml
-- test/xml/errors/error_117.xml
-- test/xml/errors/error_118.xml
-- test/xml/errors/error_119.xml
+- test/xml/errors/error_520.xml
+- test/xml/errors/error_104.xml
 - test/xml/errors/error_120.xml
+- test/xml/errors/error_514.xml
+- test/xml/errors/error_517.xml
+- test/xml/errors/error_117.xml
+- test/xml/errors/error_516.xml
+- test/xml/errors/error_204.xml
+- test/xml/errors/error_509.xml
+- test/xml/errors/error_523.xml
 - test/xml/errors/error_121.xml
-- test/xml/errors/error_122.xml
-- test/xml/errors/error_123.xml
+- test/xml/errors/error_515.xml
+- test/xml/errors/error_510.xml
+- test/xml/errors/error_999.xml
+- test/xml/errors/error_103.xml
+- test/xml/errors/error_525.xml
+- test/xml/errors/error_106.xml
+- test/xml/errors/error_205.xml
+- test/xml/errors/error_212.xml
 - test/xml/errors/error_124.xml
+- test/xml/errors/error_512.xml
+- test/xml/errors/error_122.xml
+- test/xml/errors/error_119.xml
 - test/xml/errors/error_125.xml
+- test/xml/errors/error_500.xml
+- test/xml/errors/error_902.xml
 - test/xml/errors/error_200.xml
-- test/xml/errors/error_201.xml
-- test/xml/errors/error_202.xml
-- test/xml/errors/error_203.xml
-- test/xml/errors/error_204.xml
-- test/xml/errors/error_205.xml
-- test/xml/errors/error_206.xml
 - test/xml/errors/error_207.xml
-- test/xml/errors/error_208.xml
-- test/xml/errors/error_209.xml
-- test/xml/errors/error_210.xml
-- test/xml/errors/error_211.xml
-- test/xml/errors/error_212.xml
-- test/xml/errors/error_900.xml
-- test/xml/errors/error_213.xml
-- test/xml/errors/error_901.xml
+- test/xml/errors/error_118.xml
+- test/xml/errors/error_101.xml
 - test/xml/errors/error_214.xml
-- test/xml/errors/error_902.xml
+- test/xml/errors/error_102.xml
 - test/xml/errors/error_903.xml
-- test/xml/errors/error_999.xml
-- test/xml/errors/error_500.xml
-- test/xml/errors/error_501.xml
-- test/xml/errors/error_502.xml
-- test/xml/errors/error_503.xml
-- test/xml/errors/error_504.xml
+- test/xml/errors/error_511.xml
+- test/xml/errors/error_105.xml
 - test/xml/errors/error_505.xml
-- test/xml/errors/error_506.xml
-- test/xml/errors/error_507.xml
 - test/xml/errors/error_508.xml
-- test/xml/errors/error_509.xml
-- test/xml/errors/error_510.xml
-- test/xml/errors/error_511.xml
-- test/xml/errors/error_512.xml
+- test/xml/errors/error_506.xml
+- test/xml/errors/error_114.xml
+- test/xml/errors/error_108.xml
+- test/xml/errors/error_208.xml
 - test/xml/errors/error_513.xml
-- test/xml/errors/error_514.xml
-- test/xml/errors/error_515.xml
-- test/xml/errors/error_516.xml
-- test/xml/errors/error_517.xml
-- test/xml/errors/error_518.xml
-- test/xml/errors/error_519.xml
-- test/xml/errors/error_520.xml
-- test/xml/errors/error_521.xml
-- test/xml/errors/error_522.xml
-- test/xml/errors/error_523.xml
+- test/xml/errors/error_123.xml
+- test/xml/errors/error_501.xml
 - test/xml/errors/error_524.xml
-- test/xml/errors/error_525.xml
-- test/xml/corporate_wallet_balance.xml
-- test/xml/industryjobs.xml
-- test/xml/member_tracking.xml
+- test/xml/errors/error_502.xml
+- test/xml/errors/error_503.xml
+- test/xml/errors/error_900.xml
+- test/xml/errors/error_110.xml
+- test/xml/errors/error_109.xml
+- test/xml/errors/error_113.xml
+- test/xml/errors/error_211.xml
+- test/xml/errors/error_522.xml
+- test/xml/errors/error_201.xml
+- test/xml/errors/error_206.xml
+- test/xml/errors/error_115.xml
+- test/xml/errors/error_519.xml
+- test/xml/errors/error_107.xml
+- test/xml/errors/error_116.xml
+- test/xml/errors/error_504.xml
+- test/xml/errors/error_901.xml
+- test/xml/corporate_wallet_transactions.xml
+- test/xml/wallet_journal.xml
 - test/xml/certificate_tree.xml
+- test/xml/corp_medals.xml
+- test/xml/industryjobs.xml
+- test/xml/characterid.xml
+- test/xml/alliances.xml
+- test/xml/corporate_wallet_balance.xml
+- test/xml/mailing_lists.xml
+- test/xml/mapjumps.xml
+- test/xml/skill_in_training-none.xml
+- test/xml/corp_facwarstats.xml
+- test/xml/starbases.xml
+- test/xml/errors.xml
 - test/xml/marketorders.xml
-- test/xml/eve_facwarstats.xml
+- test/xml/wallet_balance.xml
+- test/xml/characters.xml
 - test/xml/nonmember_corpsheet.xml
-- test/xml/errors.xml
-- test/xml/skilltree.xml
-- test/xml/map_facwarsystems.xml
-- test/xml/corporation_sheet.xml
-- test/xml/alliances.xml
-- test/xml/char_facwarstats.xml
+- test/xml/member_tracking.xml
 - test/xml/char_medals.xml
-- test/xml/starbases.xml
-- test/xml/corp_facwarstats.xml
+- test/xml/sovereignty.xml
 - test/xml/skill_in_training-amarr-titan.xml
+- test/xml/mapkills.xml
+- test/xml/corp_member_medals.xml
+- test/xml/skilltree.xml
+- test/xml/eve_facwartopstats.xml
+- test/xml/server_status.xml
+- test/xml/char_facwarstats.xml
+- test/xml/charactername.xml
+- test/xml/notifications.xml
+- test/xml/kills.xml
+- test/xml/market_transactions.xml
+- test/xml/eve_facwarstats.xml
+- test/xml/corporate_wallet_journal.xml
+- test/xml/assets.xml
+- test/xml/corporation_sheet.xml
+- test/xml/mail_messages.xml
 - test/xml/reftypes.xml
-- test/xml/corp_medals.xml
+- test/xml/corporate_assets_list.xml
+- test/xml/character_sheet.xml
 - test/xml/badxml.xml
-- test/xml/skill_queue.xml
-- test/xml/wallet_journal.xml
-- test/xml/kills.xml
+- test/xml/starbase_fuel.xml
+- test/xml/corp_membersecurity.xml
 - test/xml/conqurable_stations.xml
+- test/xml/corporate_market_orders.xml