eaal 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 2008-12-08
+
+* 1 major enhancement:
+  * Initial release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2008 Peter Petermann <PeterPetermann@gmx.net>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+Manifest.txt
+README.rdoc
+LICENSE.txt
+Rakefile
+lib/eaal.rb
+lib/eaal/eaal.rb
+lib/eaal/eaal_cache.rb
+lib/eaal/eaal_exception.rb
+lib/eaal/eaal_result.rb
+lib/eaal/eaal_rowset.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_eaal.rb
+test/fixtures/test/test/account/Characters/Request_.xml
+test/fixtures/test/test/char/Killlog/Request_characterID:12345.xml
+test/fixtures/test/test/char/Killlog/Request_.xml

data/README.rdoc

@@ -0,0 +1,96 @@
+= eaal
+*  http://eaal.rubyforge.org
+
+== DESCRIPTION:
+
+EAAL (Eve API Access Layer) is a ruby library for accessing data of the API of 
+the game Eve Online
+
+== FEATURES/PROBLEMS:
+
+* does not need to change when EVE API gets new pages
+* has a build in file cache which respects eve caching times (usage= EAAL.cache = EAAL::Cache::FileCache.new('path/to/save/files/in'))
+
+== SYNOPSIS:
+
+Usage:
+Initialize the API Object
+
+  api = EAAL::API.new("my Userid", "my API key"[, "scope for requests"])
+
+the scope is the one used for the API requests, 
+ex. account/char/corp/eve/map/server
+see http://wiki.eve-id.net/APIv2_Page_Index
+the scope can be changed during runtime and defaults to account
+
+Request Information
+  result = api.ApiPage
+this will return an Object of type ScopeApiPageResult which then
+can be used to do read the api result
+
+Example 1, getting a list of characters on the account:
+
+  api = EAAL::API.new("my userid", "my API key")
+  result = api.Characters
+  result.characters.each{|character|
+      puts character.name
+  }
+
+Example 2, getting the id for a given character name
+ api = EAAL::API.new("my userid", "my API key")
+ api.scope = "eve"
+ result = api.CharacterID(:names => "Peter Powers")
+ puts result.characters.name
+
+Example 3, Example 2 in short
+ puts EAAL::Api.new("my userid", "my API key", "eve").CharacterID(:names => "Peter Powers").characters.name
+ 
+
+Errors returned by the EVE API are handled a bit unique,
+since i wanted to have them pretty much dynamic (so i dont need to hack EAAL 
+whenever CCP adds a new Error) you have to use dynamic created classes to catch 'em
+(if you dont want to catch EAAL::Exception::EveAPIException in general)
+so what you do is:
+
+Example 4, catching a specific EVE API Exception
+  begin
+    api.Killlog("characterID" => "12345") #this example offcourse 
+                                          # assumes your not having the key for character 12345 loaded ;)
+  rescue EAAL::Exception.EveAPIException(201)
+    #dosomething
+  end
+
+
+== REQUIREMENTS:
+
+* hpricot
+* activesupport
+
+== INSTALL:
+
+* sudo gem install eaal
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Peter Petermann
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,27 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/eaal.rb'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('eaal', EAAL.version) do |p|
+  p.developer('Peter Petermann', 'PeterPetermann@gmx.net')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['activesupport','>= 2.0.2'], ['hpricot', '>= 0.6']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/eaal.rb

@@ -0,0 +1,6 @@
+path = File.dirname(__FILE__) + '/eaal/'
+require path + 'eaal_cache.rb'
+require path + 'eaal_exception.rb'
+require path + 'eaal_result.rb'
+require path + 'eaal_rowset.rb'
+require path + 'eaal.rb'

data/lib/eaal/eaal.rb

@@ -0,0 +1,114 @@
+#--
+# EAAL by Peter Petermann <PeterPetermann@gmx.net>
+# This library is licensed under the terms found in
+# the LICENSE file distributed with it
+#
+# TODO: 
+#  - more documenation
+#  - write tests (i know, i know, i fail badly)
+#  - more error handling (im certain i missed a few possibles)
+#  - cleanup (you can see that this is my first project in ruby, cant you?)
+#
+# THANKS:
+#  thanks go to all people on irc.coldfront.net, channel #eve-dev
+#  special thanks go to lisa (checkout her eve api library, reve,
+#  much more mature then mine) for answering my endless questions 
+#  about ruby stuff (and for one or two snippets i stole from reve)
+#++
+
+require 'rubygems'
+require 'hpricot'
+require 'activesupport'
+
+require 'net/http'
+require 'uri'
+require 'cgi'
+
+module EAAL
+    
+    mattr_reader :version_string, :version
+    
+    @@version = "0.1.0"
+    @@version_string = "EAAL" +  EAAL.version # the version string, used as client name in http requests
+    
+    mattr_accessor :api_base, :additional_request_parameters, :cache
+    @@api_base = "http://api.eve-online.com/"  # the url used as basis for all requests, you might want to use gatecamper url or a personal proxy instead
+    @@additional_request_parameters = {}       # hash, if :key => value pairs are added those will be added to each request    
+    @@cache = EAAL::Cache::NoCache.new         # caching object, see EAAL::Cache::FileCache for an Example
+    
+    # EAAL::API class
+    # Usage Example:
+    #  api = EAAL::API.new("my userid", "my API key")
+    #  result = api.Characters
+    #  result.characters.each{|character|
+    #      puts character.name
+    #  }
+    class API
+        attr_accessor :userid, :key, :scope
+        
+        # constructor
+        # Expects:
+        # * userid (String | Integer) the users id
+        # * key (String) the apikey Full or Restricted
+        # * scope (String) defaults to account
+        def initialize(userid, key, scope="account")
+            self.userid = userid.to_s
+            self.key = key.to_s
+            self.scope = scope.to_s
+        end
+        
+        # create an xml request according to the method called
+        # this is used to dynamicaly create api calls and 
+        # should usually not be called directly
+        # * method (const) 
+        # * args 
+        def method_missing(method, *args)
+            scope = self.scope
+            args_hash = args.first
+            args_hash = {} unless args_hash
+            self.request_xml(scope, method.id2name, args_hash)
+        end
+      
+        # make a request to the api. will use cache if set.
+        # usually not called by the user directly
+        # * scope (String)
+        # * name (String)
+        # * opts (Hash)
+        def request_xml(scope, name, opts)
+            opts = EAAL.additional_request_parameters.merge(opts)
+            xml = EAAL.cache.load(self.userid, self.key, scope, name,opts)
+            if not xml
+              source = URI.parse(EAAL.api_base + scope + '/' + name +'.xml.aspx')
+              req_path = source.path + format_url_request(opts.merge({
+                  :userid => self.userid, 
+                  :apikey => self.key}))
+              req = Net::HTTP::Get.new(req_path)
+              req[EAAL.version_string]
+              res = Net::HTTP.new(source.host, source.port).start {|http| http.request(req) } #one request for now  
+              case res
+              when Net::HTTPOK
+              when Net::HTTPNotFound
+                raise EAAL::Exception::APINotFoundError.new("The requested API (#{scope} / #{name}) could not be found.")
+              else 
+                raise EAAL::Exception::HTTPError.new("An HTTP Error occured, body: " + res.body)
+              end
+              EAAL.cache.save(self.userid, self.key, scope,name,opts, res.body)
+              xml = res.body
+            end
+            doc = Hpricot.XML(xml)
+            result = EAAL::Result.new(scope.capitalize + name, doc)
+        end
+                
+        # Turns a hash into ?var=baz&bam=boo
+        # stolen from Reve (thx lisa)
+        # * opts (Hash)
+        def format_url_request(opts)
+            req = "?"
+            opts.stringify_keys!
+            opts.keys.sort.each do |key|
+                req += "#{CGI.escape(key.to_s)}=#{CGI.escape(opts[key].to_s)}&" if opts[key]
+            end
+            req.chop # We are lazy and append a & to each pair even if it's the last one. FIXME: Don't do this.
+        end
+    end
+end

data/lib/eaal/eaal_cache.rb

@@ -0,0 +1,86 @@
+#--
+# EAAL by Peter Petermann <PeterPetermann@gmx.net>
+# This library is licensed under the terms found in
+# the LICENSE file distributed with it
+#++
+require 'fileutils'
+
+module EAAL
+  # The Classes in this module are objects that may be used as value
+  # of EAAL.cache.
+  # By default EAAL uses the NoCache class, where no caching is done.
+  # If a working cache class is used it will store the xml data
+  # and return it, so no requests to the API are done (as long as valid xml is available)
+  module Cache
+    
+    # EAAL::Cache::FileCache
+    # File based xml cache which respects the cachedUntil of the Eve API
+    # Usage:
+    #  EAAL.cache = EAAL::Cache::FileCache.new
+    # Or
+    #  EAAL.cache = EAAL::Cache::FileCache.new("/path/to/place/to/store/xml/data")
+    class FileCache
+      attr_accessor :basepath
+      
+      # constructor, takes one argument which is the path
+      # where files should be written
+      # * basepath (String) path which should be used to store cached data. defaults to $HOME/.eaal/cache/
+      def initialize(basepath = "#{ENV['HOME']}/.eaal/cache")
+        if basepath[(basepath.length) -1, basepath.length] != "/"
+          basepath += "/" 
+        end
+        @basepath = basepath
+      end
+      
+      # create the path/filename for the cache file
+      def filename(userid, apikey, scope, name, args)
+        ret =""
+        args.delete_if { |k,v| (v || "").to_s.length == 0 }
+        h = args.stringify_keys
+        ret += h.sort.flatten.collect{ |e| e.to_s }.join(':')
+        hash = ret.gsub(/:$/,'')
+        "#{@basepath}#{userid}/#{apikey}/#{scope}/#{name}/Request_#{hash}.xml"
+      end
+      
+      # load xml if available, return false if not available, or cachedUntil ran out
+      def load(userid, apikey, scope, name, args)
+        filename = self.filename(userid, apikey,scope,name,args)
+        if not File.exist?(filename)
+          ret = false
+        else
+          xml = File.open(filename).read
+          if self.validate_cache(xml)
+            ret = xml
+          else
+            ret = false
+          end
+        end
+        ret
+      end
+      
+      # validate cached datas cachedUntil
+      def validate_cache(xml)
+        doc = Hpricot.XML(xml)
+        (doc/"/eveapi/cachedUntil").inner_html.to_time > Time.now
+      end
+      
+      # save xml data to file
+      def save(userid, apikey, scope, name, args, xml)
+        filename = self.filename(userid, apikey,scope,name,args)
+        FileUtils.mkdir_p(File.dirname(filename))
+        File.open(filename,'w') { |f| f.print xml }        
+      end
+    end
+    
+    # NoCache class
+    # dummy class which is used for non-caching behaviour (default)
+    class NoCache
+      def load(userid, apikey, scope, name, args)
+        false
+      end
+      def save(userid, apikey, scope, name, args, xml)
+      end
+    end
+    
+  end
+end

data/lib/eaal/eaal_exception.rb

@@ -0,0 +1,42 @@
+#--
+# EAAL by Peter Petermann <PeterPetermann@gmx.net>
+# This library is licensed under the terms found in
+# the LICENSE file distributed with it
+#++
+module EAAL
+  module Exception
+    # creates the class for an EveAPIException
+    def self.EveAPIException(nr)
+      classname = "EveAPIException#{nr}" 
+      if not Object.const_defined? classname
+          klass = Object.const_set(classname, Class.new(EAAL::Exception::EveAPIException))
+      else
+          klass = Object.const_get(classname)
+      end
+      klass
+    end
+    
+    # raise the eve API exceptions, class will be dynamicaly created by classname
+    # EveAPIException followed by the APIs exception Number
+    def self.raiseEveAPIException(nr, msg)
+        raise EAAL::Exception.EveAPIException(nr).new(msg)
+    end
+    
+    # all EAAL exceptions should extend this.
+    class EAALError < StandardError
+    end
+    
+    # Used when an http error is encountered
+    class HTTPError < EAALError
+    end
+    
+    # Used when the Eve API returns a 404
+    class APINotFoundError < HTTPError
+    end
+    
+    # All API Errors should be derived from this
+    class EveAPIException < EAALError
+    end
+      
+  end
+end

data/lib/eaal/eaal_result.rb

@@ -0,0 +1,120 @@
+#--
+# EAAL by Peter Petermann <PeterPetermann@gmx.net>
+# This library is licensed under the terms found in
+# the LICENSE file distributed with it
+#++
+module EAAL
+
+    module Result
+      
+        # base class for automated result class creation
+        class ResultBase
+            attr_accessor :request_time, :cached_until
+        end
+        
+        # Result Container class, ...  
+        class ResultContainer
+            attr_accessor :container
+
+            def initialize
+                self.container = {}
+            end
+            
+            def add_element(key, val)
+                self.container.merge!({key => val})
+            end
+
+            def method_missing(method, *args)
+                self.container[method.id2name]
+            end
+        end
+
+        # result element
+        class ResultElement
+            attr_accessor :name, :value, :attribs
+            def initialize(name, value)
+                self.name = name
+                self.value = value     
+                self.attribs = {}
+            end
+
+            def add_attrib(key, val)
+                self.attribs.merge!({key => val})
+            end
+
+            def method_missing(method, *args)
+                if self.attribs.has_key?(method.id2name)
+                    self.attribs[method.id2name]
+                else
+                    self.value.send(method, *args)                    
+                end
+                
+            end
+                    
+            # parses an xml element to create either the ResultElement, ResultContainer or Rowset 
+            # necessary
+            def self.parse_element(prefix, element)
+                if element.name == "rowset"
+                    value = EAAL::Rowset.new(prefix, element)
+                    key = value.name
+                else
+                    key = element.name
+                    if element.containers.length > 0
+                        container = ResultContainer.new
+                        element.containers.each { |celement|
+                            cel = EAAL::Result::ResultElement.parse_element(prefix, celement)
+                            if element.attributes.length > 0
+                                container.add_element(cel.name, cel)
+                            else 
+                                container.add_element(cel.name, cel.value)
+                            end
+                        }
+                        value = container
+                    else
+                        value = element.inner_html
+                    end
+                end
+                re = ResultElement.new(key, value)
+                if element.attributes.length > 0
+                    re.attribs.merge!(element.attributes)
+                end
+                re
+            end
+        end
+
+
+        def self.new(prefix, xml)
+            classname = prefix + 'Result'
+            members = []
+            values = {}
+            if (xml/"eveapi/error").length > 0
+              error = (xml/"eveapi/error").first
+              raise EAAL::Exception.raiseEveAPIException(error["code"], error.inner_html)
+            end
+            if (xml/"eveapi/result").length < 1
+              raise EAAL::Exception::EAALError.new("Unknown API error, no result element was found")
+            end
+            elements = (xml/"eveapi/result").first.containers
+            elements.each {|element|
+                el = EAAL::Result::ResultElement.parse_element(prefix, element)
+                members << el.name
+                values.merge!({el.name => el.value})
+            }
+            if not Object.const_defined? classname
+                klass = Object.const_set(classname, Class.new(EAAL::Result::ResultBase))    
+                klass.class_eval do
+                    attr_accessor *members
+                end
+            else
+                klass = Object.const_get(classname)
+            end
+            result = klass.new
+            result.request_time = (xml/"eveapi/currentTime").first.inner_html
+            result.cached_until = (xml/"eveapi/cachedUntil").first.inner_html
+            values.each { |key,value|
+                result.send(key + "=", value)
+            }
+            result
+        end
+    end
+end

data/lib/eaal/eaal_rowset.rb

@@ -0,0 +1,63 @@
+#--
+# EAAL by Peter Petermann <PeterPetermann@gmx.net>
+# This library is licensed under the terms found in
+# the LICENSE file distributed with it
+#++
+module EAAL
+
+    module Rowset
+
+        class RowsetBase < Array
+            attr_accessor :name, :columns, :rowclass
+            
+            def create_row(xml)
+                row = self.rowclass.new
+                self.columns.each { |colname|
+                    row.send(colname +"=", xml[colname]) # row content ignored so far (needs to be added!!!)
+                }
+                if xml.containers.length > 0
+                    xml.containers.each { |child|
+                        el = EAAL::Result::ResultElement.parse_element(self.rowclass.name, child)
+                        row.add_element(el.name, el)
+                    }
+                end
+               row
+            end
+        end
+        
+        class RowBase < EAAL::Result::ResultContainer
+        end
+        
+        def self.new(prefix, xml)
+            name = xml['name']
+            columns = xml['columns'].split(',')
+            
+            classname = prefix + 'Rowset' + name.capitalize
+            rowname = classname + 'Row'
+            
+            if not Object.const_defined? classname
+                klass = Object.const_set(classname, Class.new(EAAL::Rowset::RowsetBase))    
+            else
+                klass = Object.const_get(classname)
+            end
+            rowset = klass.new
+            
+            if not Object.const_defined? rowname
+                klass = Object.const_set(rowname, Class.new(EAAL::Rowset::RowBase))
+                klass.class_eval do
+                    attr_accessor *columns
+                end
+            else
+                klass = Object.const_get(rowname)
+            end
+            
+            rowset.name = name
+            rowset.columns = columns
+            rowset.rowclass = klass
+            xml.containers.each{ |row|
+                rowset << rowset.create_row(row)
+            }
+            rowset
+        end
+    end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/eaal.rb'}"
+puts "Loading eaal gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/fixtures/test/test/account/Characters/Request_.xml

@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2008-12-08 15:02:25</currentTime>
+  <result>
+    <rowset name="characters" key="characterID" columns="name,characterID,corporationName,corporationID">
+      <row name="Test Tester" characterID="12345" corporationName="Test Corp" corporationID="54321" />
+      <row name="Tester2" characterID="0987" corporationName="Test2 Corp" corporationID="7890" />
+    </rowset>
+  </result>
+  <cachedUntil>2020-12-08 16:02:25</cachedUntil>
+</eveapi>

data/test/fixtures/test/test/char/Killlog/Request_.xml

@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2008-12-08 15:19:28</currentTime>
+  <error code="105">Invalid characterID.</error>
+  <cachedUntil>2020-12-08 16:02:25</cachedUntil>
+</eveapi>

data/test/fixtures/test/test/char/Killlog/Request_characterID:12345.xml

@@ -0,0 +1,19 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2008-12-08 15:22:26</currentTime>
+  <result>
+    <rowset name="kills" key="killID" columns="killID,solarSystemID,killTime,moonID">
+      <row killID="1" solarSystemID="1" killTime="2008-12-07 14:11:00" moonID="0">
+        <victim characterID="179004085" characterName="Peter Powers" corporationID="402487260" corporationName="FinFleet" allianceID="632866070" allianceName="Band of Brothers" factionID="0" factionName="" damageTaken="15909" shipTypeID="22448" />
+        <rowset name="attackers" columns="characterID,characterName,corporationID,corporationName,allianceID,allianceName,factionID,factionName,securityStatus,damageDone,finalBlow,weaponTypeID,shipTypeID">
+          <row characterID="12345" characterName="Test Tester" corporationID="54321" corporationName="Test Corp" allianceID="1" allianceName="Test Alliance" factionID="0" factionName="" securityStatus="4" damageDone="15909" finalBlow="1" weaponTypeID="14286" shipTypeID="24688" />
+        </rowset>
+        <rowset name="items" columns="typeID,flag,qtyDropped,qtyDestroyed">
+          <row typeID="2048" flag="0" qtyDropped="1" qtyDestroyed="0" />
+          <row typeID="12814" flag="5" qtyDropped="0" qtyDestroyed="6" />
+        </rowset>
+      </row>
+    </rowset>
+  </result>
+  <cachedUntil>2020-12-08 16:22:26</cachedUntil>
+</eveapi>

data/test/test_eaal.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestEaal < Test::Unit::TestCase
+ 
+  # prepare the api object. sets EAAL to use FileCache to load fixtures 
+  def setup
+      EAAL.cache = EAAL::Cache::FileCache.new(File.dirname(__FILE__) + '/fixtures/')
+      @api = EAAL::API.new('test','test')
+  end
+  # test if we realy got an API Object
+  def test_api_class
+    assert_instance_of EAAL::API, @api
+  end
+
+  # some random tests if parsing the xml builds the right class
+  def test_api_classes
+    @api.scope = "char"  
+    assert_raise (EAAL::Exception.EveAPIException(105)) { @api.Killlog }
+    assert_equal @api.Killlog(:characterID => 12345).class.name, "CharKilllogResult"
+    assert_equal @api.Killlog(:characterID => 12345).kills.class.name, "CharKilllogRowsetKills"
+    assert_equal @api.Killlog(:characterID => 12345).kills.first.class.name, "CharKilllogRowsetKillsRow"
+    assert_equal @api.Killlog(:characterID => 12345).kills.first.victim.class.name, "EAAL::Result::ResultElement"
+    assert_equal @api.Killlog(:characterID => 12345).kills.first.attackers.first.class.name, "CharKilllogRowsetKillsRowRowsetAttackersRow"
+  end
+  
+  # some random data checks to ensure stuff can be read
+  def test_api_parse_data
+    @api.scope = "account"
+    assert_equal @api.Characters.characters.first.name, "Test Tester"
+    assert_equal @api.Characters.characters.second.corporationID, "7890"
+    @api.scope = "char"  
+    assert_equal @api.Killlog(:characterID => 12345).kills.length, 1
+    assert_equal @api.Killlog(:characterID => 12345).kills.first.victim.characterName, "Peter Powers"
+    assert_equal @api.Killlog(:characterID => 12345).kills.first.attackers.first.characterID, "12345"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/eaal'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: eaal
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Peter Petermann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: EAAL (Eve API Access Layer) is a ruby library for accessing data of the API of  the game Eve Online
+email: 
+- PeterPetermann@gmx.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- LICENSE.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- LICENSE.txt
+- Rakefile
+- lib/eaal.rb
+- lib/eaal/eaal.rb
+- lib/eaal/eaal_cache.rb
+- lib/eaal/eaal_exception.rb
+- lib/eaal/eaal_result.rb
+- lib/eaal/eaal_rowset.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_eaal.rb
+- test/fixtures/test/test/account/Characters/Request_.xml
+- test/fixtures/test/test/char/Killlog/Request_characterID:12345.xml
+- test/fixtures/test/test/char/Killlog/Request_.xml
+has_rdoc: true
+homepage: " http://eaal.rubyforge.org"
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: eaal
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: EAAL (Eve API Access Layer) is a ruby library for accessing data of the API of  the game Eve Online
+test_files: 
+- test/test_helper.rb
+- test/test_eaal.rb