eve-api 0.0.1

data/README

@@ -0,0 +1,8 @@
+Eve API Support
+===============
+
+Some docs will go here. See tests/general.rb for usage examples
+
+Run general.rb using the following command:
+  cd lib && ruby ../tests/general.rb
+  

data/lib/eve-api.rb

@@ -0,0 +1,6 @@
+require 'pp'
+
+require 'eve-api/common'
+require 'eve-api/exceptions'
+require 'eve-api/transport'
+require 'eve-api/eve-api'

data/lib/eve-api/common.rb

@@ -0,0 +1,7 @@
+module EveAPI
+  module Common
+    def extract_options_from_args!(args)
+      args.last.is_a?(Hash) ? args.pop : {}
+    end
+  end
+end

data/lib/eve-api/eve-api.rb

@@ -0,0 +1,138 @@
+module EveAPI
+  
+  class API
+    include Common
+    def initialize(*args)
+      @keystore = KeyStore.new
+      @keystore << User.new(extract_options_from_args!(args)) if args.length > 0
+    end
+    def keystore
+      @keystore
+    end
+    def users
+      @keystore.users
+    end
+    def <<(user)
+      @keystore << user
+    end
+  end
+  
+  class KeyStore
+    def initialize(*args)
+      @users = {}
+      args.each do |user|
+        users[user.id] = user
+      end
+    end
+    def <<(user)
+      @users[user.id] = user
+    end
+    def users
+      @users.values
+    end
+    def [](id)
+      @users[id]
+    end
+  end
+  
+  class Base
+    def initialize(options, api=nil)
+      @api ||= api
+      @api ||= Transport::API.new(options)
+      @options = options
+    end
+    def id
+      return(@options[:id])
+    end
+    def type
+      return(@options[:type])
+    end
+    def method_missing(method, *args)
+      return(@options[method]) if @options.has_key?(method)
+      raise(Exceptions::AttributeException,"unknown attribute #{method}")
+    end
+  end
+
+  class User < Base
+    include Common
+    def initialize(*args)
+      super(extract_options_from_args!(args))
+      raise(Exceptions::InputException, "id required") unless @options[:id]
+      raise(Exceptions::InputException, "api_key required") unless @options[:api_key]
+    end
+    def characters
+      characters = []
+      @api.characters.each do |raw_character_id, raw_character|
+        characters << Character.new(raw_character, @api)
+      end
+      return characters
+    end
+  end
+    
+  class Character < Base
+    def corporation
+      return(Corporation.new({:id => corporation_id, :name => corporation_name}, @api, self))
+    end
+    def accounts
+      accounts = []
+      @api.account_balances(id, :char).each do |raw_account|
+        accounts << Account.new(raw_account, @api, self, :char)
+      end
+      return accounts
+    end
+  end
+
+  class Corporation < Base
+    def initialize(options, api, character)
+      super(options, api)
+      options[:character] = character
+      @character = character
+    end
+    def accounts
+      accounts = []
+      @api.account_balances(@character.id, :corp).each do |raw_account|
+        accounts << Account.new(raw_account, @api, @character, :corp)
+      end
+      return accounts
+    end
+    def members
+      members = []
+      @api.member_tracking(@character.id).each do |raw_member_id, raw_member|
+        members << Member.new(raw_member, @api)
+      end
+      return members
+    end
+  end
+  
+  class Account < Base
+    def initialize(options, api, character, type)
+      super(options, api)
+      options[:character] = character
+      options[:type] = type
+    end
+    def journal
+      journal = []
+      @api.account_journal(character.id, type, key).each do |raw_journal_entry|
+        journal << JournalEntry.new(raw_journal_entry, @api)
+      end
+      return journal
+    end
+    def transactions
+      transactions = []
+      @api.account_transactions(character.id, type, key).each do |raw_transaction|
+        transactions << Transaction.new(raw_transaction, @api)
+      end
+      return transactions
+    end
+  end
+  
+  class JournalEntry < Base
+  end
+  
+  class Transaction < Base
+  end
+  
+  class Member < Base
+  end
+  
+end

data/lib/eve-api/exceptions.rb

@@ -0,0 +1,16 @@
+module EveAPI
+  module Exceptions
+    class BaseException < Exception
+    end
+    class OptionsException < BaseException
+    end
+    class InputException < BaseException
+    end
+    class CredentialsException < BaseException
+    end
+    class APIException < BaseException
+    end
+    class AttributeException < BaseException
+    end
+  end
+end

data/lib/eve-api/transport.rb

@@ -0,0 +1,288 @@
+require 'date'
+require 'rexml/document'
+require 'net/http'
+require 'uri'
+
+module EveAPI
+  
+  module Transport
+    
+    class API
+
+      include Common
+      
+      def initialize(*args)
+        @options = extract_options_from_args!(args)
+        @transport = HTTP.new(@options)
+      end
+
+      def characters
+        result = {}
+        doc = @transport.call('account/Characters.xml.aspx')
+        doc.each_element('//rowset[@name="characters"]/row') do |row|
+          character = {
+            :id => row.attributes['characterID'].to_i,
+            :name => row.attributes['name'],
+            :corporation_id => row.attributes['corporationID'].to_i,
+            :corporation_name => row.attributes['corporationName']
+          }
+          result[character[:id]] = character
+        end
+        return result
+      end
+
+      def reftypes
+        result = {}
+        doc = @transport.call('eve/RefTypes.xml.aspx')
+        doc.each_element('//rowset[@name="refTypes"]/row') do |row|
+          reftype = {
+            :id => row.attributes['refTypeID'].to_i,
+            :name => row.attributes['refTypeName']
+          }
+          result[reftype[:id]] = reftype
+        end
+        return result
+      end
+
+      def skills(character_id)
+        doc = @transport.call('char/CharacterSheet.xml.aspx', :characterID => character_id)
+        base = doc.elements['//result']
+        result = {
+          :race      => base.elements['race'].text,
+          :bloodline => base.elements['bloodLine'].text,
+          :gender    => base.elements['gender'].text,
+          :balance   => base.elements['balance'].text.to_f
+        }
+        attributes = base.elements['attributes'].elements
+        result[:attributes] = {
+          :intelligence => attributes['intelligence'].text.to_i,
+          :memory => attributes['memory'].text.to_i,
+          :charisma => attributes['charisma'].text.to_i,
+          :perception => attributes['perception'].text.to_i,
+          :willpower => attributes['willpower'].text.to_i
+        }
+        skills = {}
+        base.each_element('rowset[@name="skills"]/row') do |row|
+          skill = {
+            :id => row.attributes['typeID'].to_i,
+            :level => row.attributes['level'].to_i,
+            :skillpoints => row.attributes['skillpoints'].to_i
+          }
+          skills[skill[:id]] = skill
+        end
+        result[:skills] = skills
+        return result
+      end
+
+      def skill_in_training(character_id)
+        skill = {}
+        doc = @transport.call('char/SkillInTraining.xml.aspx', :characterID => character_id)
+        result = doc.elements['//result']
+        skill = {
+          :skill_id => result.elements['trainingTypeID'].text.to_i,
+          :to_level => result.elements['trainingToLevel'].text.to_i,
+          :started_at => DateTime.parse(result.elements['trainingStartTime'].text),
+          :ends_at => DateTime.parse(result.elements['trainingEndTime'].text),
+          :skillpoints => {
+            :from => result.elements['trainingStartSP'].text.to_i,
+            :to => result.elements['trainingDestinationSP'].text.to_i
+          }
+        }
+        return skill
+      end
+      
+      def skilltree
+        result = {
+          :skillgroups => {},
+          :skills => {}
+        }
+        doc = @transport.call('eve/SkillTree.xml.aspx')
+        doc.each_element('//rowset[@name="skillGroups"]/row') do |row|
+          skillgroup = {
+            :id => row.attributes['groupID'].to_i,
+            :name => row.attributes['groupName'],
+          }
+          skills = []
+          row.each_element('rowset[@name="skills"]/row') do |skill_row|
+            skill = {
+              :id => skill_row.attributes['typeID'].to_i,
+              :name => skill_row.attributes['typeName'],
+              :rank => skill_row.elements['rank'].text.to_i,
+              :description => skill_row.elements['description'].text
+            }
+            prerequisites = []
+            skill_row.each_element('rowset[@name="requiredSkills"]/row') do |prerequisite_row|
+              prerequisites << prerequisite_row.attributes["typeID"].to_i
+            end
+            skill[:prerequisites] = prerequisites
+            skills << skill[:id]
+            result[:skills][skill[:id]] = skill
+          end
+          skillgroup[:skills] = skills
+          result[:skillgroups][skillgroup[:id]] = skillgroup
+          break
+        end
+        return result
+      end
+
+      def sovereignty
+        sovereignty = {}
+        doc = @transport.call('map/Sovereignty.xml.aspx')
+        doc.each_element('//rowset[@name="solarSystems"]/row') do |row|
+          solarsystem = {
+            :id => row.attributes['solarSystemID'].to_i,
+            :name => row.attributes['solarSystemName'],
+            :alliance_id => row.attributes['allianceID'].to_i,
+            :faction_id => row.attributes['factionID'].to_i,
+            :constellation_sovereignty => (row.attributes['constellationSovereignty'] != '0'),
+            :sovereignty_level => row.attributes['sovereigntyLevel'].to_i
+          }
+          sovereignty[solarsystem[:id]] = solarsystem
+        end
+        return sovereignty
+      end
+      
+      def account_balances(character_id, type)
+        accounts = []
+        doc = @transport.call("#{type.to_s}/AccountBalance.xml.aspx", :characterID => character_id)
+        doc.each_element('//rowset[@name="accounts"]/row') do |row|
+          account = {
+            :id => row.attributes['accountID'].to_i,
+            :key => row.attributes['accountKey'].to_i,
+            :balance => row.attributes['balance'].to_f
+          }
+          accounts << account
+        end
+        return accounts
+      end
+      
+      def account_journal(character_id, type, account_key)
+        journal = []
+        doc = @transport.call("#{type.to_s}/WalletJournal.xml.aspx", :characterID => character_id, :accountKey => account_key)
+        doc.each_element('//rowset[@name="entries"]/row') do |row|
+          entry = {
+            :id => row.attributes['refID'].to_i,
+            :reftype_id => row.attributes['refTypeID'].to_i,
+            :owner1 => {
+              :id => row.attributes['ownerID1'].to_i,
+              :name => row.attributes['ownerName1'].to_i
+            },
+            :owner2 => {
+              :id => row.attributes['ownerID2'].to_i,
+              :name => row.attributes['ownerName2'].to_i
+            },
+            :arg => {
+              :id => row.attributes['argID1'].to_i,
+              :name => row.attributes['argName1'].to_i              
+            },
+            :amount => row.attributes['amount'].to_f,
+            :balance => row.attributes['balance'].to_f,
+            :date => DateTime.parse(row.attributes['date']),
+            :reason => row.attributes['reason']
+          }
+          journal << entry
+        end
+        return journal
+      end
+      
+      def account_transactions(character_id, type, account_key)
+        transactions = []
+        doc = @transport.call("#{type.to_s}/WalletTransactions.xml.aspx", :characterID => character_id, :accountKey => account_key)
+        doc.each_element('//rowset[@name="transactions"]/row') do |row|
+          transaction = {
+            :id => row.attributes['transactionID'].to_i,
+            :type => row.attributes['transactionType'],
+            :date => DateTime.parse(row.attributes['transactionDateTime']),
+            :quantity => row.attributes['quantity'].to_i,
+            :item => {
+              :id => row.attributes['typeID'].to_i,
+              :name => row.attributes['typeName']
+            },
+            :price => row.attributes['price'].to_f,
+            :client => {
+              :id => row.attributes['clientID'].to_i,
+              :name => row.attributes['clientName']
+            },
+            :seller => {
+              :id => row.attributes['characterID'].to_i,
+              :name => row.attributes['characterName']
+            },
+            :station => {
+              :id => row.attributes['stationID'].to_i,
+              :name => row.attributes['stationName']
+            }
+          }
+          transactions << transaction
+        end
+        return transactions
+      end
+      
+      def member_tracking(character_id)
+        members = {}
+        doc = @transport.call('corp/MemberTracking.xml.aspx', :characterID => character_id)
+        doc.each_element('//rowset[@name="members"]/row') do |row|
+          member = {
+            :id => row.attributes['characterID'].to_i,
+            :name => row.attributes['name'],
+            :title => row.attributes['title'],
+            :base => {
+              :id => row.attributes['baseID'].to_i,
+              :name => row.attributes['base']
+            },
+            :ship => {
+              :id => row.attributes['shipTypeID'].to_i,
+              :name => row.attributes['shipType']
+            },
+            :last => {
+              :logon => DateTime.parse(row.attributes['logonDateTime']),
+              :logoff => DateTime.parse(row.attributes['logoffDateTime'])
+            },
+            :location => {
+              :id => row.attributes['locationID'].to_i,
+              :name => row.attributes['location']
+            },
+            :roles => row.attributes['roles'].to_i,
+            :grantable_roles => row.attributes['grantableRoles'].to_i
+          }
+          members[member[:id]] = member
+        end
+        return members
+      end
+    end
+    
+    class HTTP
+      
+      include Common
+    
+      EVE_API_URI_BASE = "http://api.eve-online.com/"
+    
+      def initialize(*args)
+        options = extract_options_from_args!(args)
+        @base_params = {}
+        @base_params[:userID] = options[:id] or raise Exceptions::OptionsException, "id is missing"
+        @base_params[:apiKey] = options[:api_key] or raise Exceptions::OptionsException, "api_key is missing"
+        @base_params[:betaAccess] = options[:beta_key] if options[:beta_key]
+      end
+    
+      def call(uri, *args)
+        params = extract_options_from_args!(args).merge(@base_params)
+        #pp params
+        res = Net::HTTP.post_form(URI.parse("#{EVE_API_URI_BASE}#{uri}"), params)
+        xml = '<?xml version="1.0"?>' + res.body
+        doc = REXML::Document.new(xml)
+        #puts doc
+        if error = doc.elements['//error']
+          case error.attributes['code'][0,1]
+            when '1': raise Exceptions::InputException, error.text
+            when '2': raise Exceptions::CredentialsException, error.text
+            else raise Exceptions::APIException, error.text
+          end
+        end
+        return doc
+      end
+  
+    end
+
+  end
+  
+end

data/tests/general.rb

@@ -0,0 +1,82 @@
+require 'eve-api'
+require 'yaml'
+
+include EveAPI
+
+# create a file called "config.yml" in the tests dir that looks like:
+#
+# user_id: <EVE API User ID>
+# api_key: <EVE API Key>
+
+config = YAML::load_file('../tests/config.yml')
+
+raise "config.yml missing attribute user_id" unless config.has_key?('user_id')
+raise "config.yml missing attribute api_key" unless config.has_key?('api_key')
+
+api = Transport::API.new(:id => config['user_id'], :api_key => config['api_key'])
+api.characters.each do |char_id, character|
+  begin
+    pp api.member_tracking(char_id)
+  rescue Exceptions::CredentialsException => ex
+    puts "CREDENTIALS EXCEPTION: #{ex.message}"
+  end
+end
+
+api = API.new(:id => config['user_id'], :api_key => config['api_key'])
+
+api = API.new
+api << User.new(:id => config['user_id'], :api_key => config['api_key'])
+
+api.users.each do |user|
+  user.characters.each do |character|
+    puts "CHARACTER: #{character.name}"
+    puts "  SELF ACCOUNTS:"
+    character.accounts.each do |account|
+      begin
+        puts "    ACCOUNT: #{account.key} [balance=#{account.balance}]"
+        puts "      TRANSACTIONS: "
+        account.transactions.each do |transaction|
+          puts "        TRANSACTION: #{transaction.id} [date=#{transaction.date.strftime("%Y-%m-%d %H:%m")}]"
+        end
+        puts "      JOURNAL: "
+        account.journal.each do |entry|
+          puts "        ENTRY: #{entry.id} [balance=#{entry.balance}]"
+        end
+      rescue Exceptions::InputException => ex
+        puts "        INPUT ERROR: #{ex.message}"
+      end
+    end
+    begin
+      puts "  CORP MEMBERS:"
+      character.corporation.members.each do |member|
+        puts "    MEMBER: #{member.id} [name=#{member.name}]"
+      end
+    rescue Exceptions::CredentialsException => ex
+      print "    CREDENTIALS EXCEPTION: #{ex.message}"
+    end
+    puts "  CORP ACCOUNTS:"
+    begin
+      character.corporation.accounts.each do |account|
+        begin
+          puts "    ACCOUNT: #{account.key} [balance=#{account.balance}]"
+          puts "      TRANSACTIONS: "
+          account.transactions.each do |transaction|
+            puts "        TRANSACTION: #{transaction.id} [date=#{transaction.date.strftime("%Y-%m-%d %H:%m")}]"
+          end
+          puts "      JOURNAL: "
+          account.journal.each do |entry|
+            puts "        ENTRY: #{entry.id} [balance=#{entry.balance}]"
+          end
+        rescue Exceptions::InputException => ex
+          puts "        INPUT ERROR: #{ex.message}"
+        end
+      end
+    rescue Exceptions::CredentialsException => ex
+      puts "    CREDENTIALS ERROR: #{ex.message}"
+    end
+  end
+end
+                
+
+
+

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: eve-api
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-06-21 00:00:00 -04:00
+summary: Ruby support for EVE Online's API
+require_paths: 
+- lib
+email: ddollar@gmail.com
+homepage: ""
+rubyforge_project: 
+description: 
+autorequire: eve-api
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- David Dollar
+files: 
+- lib/eve-api
+- lib/eve-api.rb
+- lib/eve-api/common.rb
+- lib/eve-api/eve-api.rb
+- lib/eve-api/exceptions.rb
+- lib/eve-api/transport.rb
+- README
+test_files: 
+- tests/general.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+