dsander-reve 0.0.132 → 0.0.133.pre

data/Rakefile

@@ -1,13 +1,7 @@
-STATS_DIRECTORIES = [
-  %w(Libraries          lib/),
-  %w(tests test/)
-]
-
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-
 task :default => :redoc
 
 desc "Generate Docs"
@@ -21,40 +15,7 @@ Rake::RDocTask.new("doc") { |rdoc|
   rdoc.rdoc_files.include('test/**/*')
 }
 
-desc "Code Statistics"
-task :stats do
-  require 'code_statistics'
-  CodeStatistics.new(*STATS_DIRECTORIES).to_s  
-end
-
-if File.exists?('.svn')
-  require 'rubygems'
-  require 'rake/packagetask'
-  require 'rake/gempackagetask'
-  
-  REVE_RELEASE=`svn up &>/dev/null && svn info|grep ^Revision| cut -d ' ' -f 2` 
-  
-  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
-  
-  Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_tar = true
-  end rescue nil
-elsif File.exists?('.git')
+if File.exists?('.git')
   begin
     require 'jeweler'
     Jeweler::Tasks.new do |s|
@@ -62,10 +23,10 @@ elsif File.exists?('.git')
       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
+      s.files = FileList["Rakefile","VERSION","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

data/lib/reve/classes.rb

@@ -453,7 +453,8 @@ module Reve #:nodoc:
         @flag = elem['flag'].to_i
         @singleton = elem['singleton'] == "1"
         @assets = []
-        #@xml_hash = elem.to_s.gsub(/\n|\r|\s/,'')
+        # 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
@@ -473,7 +474,8 @@ module Reve #:nodoc:
         @quantity = elem['quantity'].to_i
         @flag = elem['flag'].to_i
         @singleton = elem['singleton'].to_i
-        #@xml_hash = elem.to_s.gsub(/\n|\r|\s/,'')
+        # 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
@@ -708,7 +710,6 @@ module Reve #:nodoc:
         @id = elem['stationID'].to_i
         @name = elem['stationName']
         @type_id = elem['stationTypeID'].to_i
-        @system_id = elem['solarSystemID'].to_i
         @corporation_id = elem['corporationID'].to_i
         @corporation_name = elem['corporationName']
         @system_id = elem['solarSystemID'].to_i
@@ -1520,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/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.rb

@@ -1,5 +1,6 @@
 #--
-# Code copyright Lisa Seelye, 2007-2008. www.crudvision.com
+# Code copyright Lisa Seelye, 2007-2010. www.crudvision.com
+# Contributors at: http://github.com/lisa/reve/contributors
 # This library is licensed under the terms of the MIT license. For full text
 # see the LICENSE file distributed with this package.
 # (Also, send Raquel Smith some ISK if you would like to show appreciation ;-)
@@ -16,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__)))
 
@@ -93,7 +95,11 @@ module Reve
     @@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'
+    @@corporate_contacts_url       = 'http://api.eve-online.com/corp/ContactList.xml.aspx'
+    # DO NOT USE THE FOLLOWING IN PRODUCTION
+    # These methods will be available with Tyrannis 1.2 (current data is from the test server)
+    @@account_status_url           = 'http://apitest.eve-online.com/account/AccountStatus.xml.aspx'
+    @@character_info_url           = 'http://apitest.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,
@@ -108,12 +114,13 @@ 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, :personal_contacts_url, :corporate_contacts_url
+                   :research_url, :personal_contacts_url, :corporate_contacts_url,
+                   :account_status_url, :character_info_url
 
 
     attr_accessor :key, :userid, :charid
-    attr_accessor :http_user_agent, :save_path
-    attr_reader :current_time, :cached_until, :last_hash
+    attr_accessor :http_user_agent, :save_path, :timeout
+    attr_reader :current_time, :cached_until, :last_hash, :reve_version
     
     # Create a new API instance.
     # current_time and cached_until are meaningful only for the LAST call made.
@@ -128,13 +135,15 @@ module Reve
       @charid = (charid || "").to_s
       
       @save_path = nil
-
-      @http_user_agent = "Reve"
+      
       @max_tries = 3
+      @timeout = 20
 
       @current_time = nil
       @cached_until = nil
       @last_hash = nil
+      @reve_version = File.read(File.join(File.dirname(__FILE__),'../','VERSION')).chomp
+      @http_user_agent = "Reve v#{@reve_version}; http://github.com/lisa/reve"
     end
     # Save XML to this directory with the format:
     # :save_path/:userid/:method/:expires_at_in_unixtime.xml
@@ -955,6 +964,29 @@ module Reve
       process_query(Reve::Classes::MailMessage, opts[:url] || @@personal_mail_messages_url,false,args)
     end
 
+    # DO NOT USE THE FOLLOWING IN PRODUCTION
+    # These methods will be available with Tyrannis 1.2 (current data is from the test server)
+
+    # 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
@@ -1047,7 +1079,7 @@ module Reve
         opts.merge({ :version => 2, :url => nil }) #the uri bit will now ignored in format_url_request
         req_args =  format_url_request(opts)
         req = Net::HTTP::Get.new(source.path + req_args)
-        req['User-Agent'] = @http_referer_agent || "Reve"
+        req['User-Agent'] = @http_referer_agent || "Reve v#{@reve_version}; http://github.com/lisa/reve"
         
         res = nil
         response = nil
@@ -1055,7 +1087,10 @@ module Reve
           begin
             # ||= to prevent making a new Net::HTTP object, the res = nil above should reset this for the next request.
             # the request needs to be here to rescue exceptions from it.
-            res ||= Net::HTTP.new(source.host, source.port).start {|http| http.request(req) }
+            http ||= Net::HTTP.new(source.host, source.port)
+            http.open_timeout = 3
+            http.read_timeout = @timeout
+            res = http.start {|http| http.request(req) }
             case res
             when Net::HTTPSuccess, Net::HTTPRedirection
               response = res.body

data/test/test_reve.rb

@@ -1209,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
@@ -1285,11 +1353,14 @@ class TestReve < Test::Unit::TestCase
     assert_equal real,time
   end
   
-  protected
-  def get_api(userid = nil, apikey = nil, charid = nil)
-    api = Reve::API.new(userid, apikey, charid)
-    api.save_path = nil
-    api
+  # It's useful to know the version and we'll stick it in the user agent
+  # now as well.
+  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')).chomp
+    assert_equal(@api.reve_version, version)
+    assert_equal("Reve v#{version}; http://github.com/lisa/reve", @api.http_user_agent)
   end
   
   # no need to test corporate cos they're the same.
@@ -1341,4 +1412,11 @@ class TestReve < Test::Unit::TestCase
     end
   end
 
+  #### All tests above this method.
+  protected
+  def get_api(userid = nil, apikey = nil, charid = nil)
+    api = Reve::API.new(userid, apikey, charid)
+    api.save_path = nil
+    api
+  end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dsander-reve
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  prerelease: true
   segments: 
   - 0
   - 0
-  - 132
-  version: 0.0.132
+  - 133
+  - pre
+  version: 0.0.133.pre
 platform: ruby
 authors: 
 - Lisa Seelye