eaal 0.1.4 → 0.1.5

data/test/test_eaal.rb

@@ -1,42 +1,53 @@
-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
-
-  # test to check if bug 23177 is fixed. that bug lead to RowSets beeing encapsulated in ResultElements.
-  def test_bug_23177
-   @api.scope = "eve"
-   assert_kind_of EAAL::Rowset::RowsetBase, @api.AllianceList.alliances.first.memberCorporations
-  end
-end
+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
+
+  # test to check if bug 23177 is fixed. that bug lead to RowSets beeing encapsulated in ResultElements.
+  def test_bug_23177
+   @api.scope = "eve"
+   assert_kind_of EAAL::Rowset::RowsetBase, @api.AllianceList.alliances.first.memberCorporations
+  end
+  # Test to ensure Memcached works
+  def test_memcached
+    # TODO: API needs mocking properly instead of depending on file cache for test loading.
+    EAAL.cache = EAAL::Cache::MemcachedCache.new
+    @api.scope = "account"
+    # Should store to cache
+    assert_equal @api.Characters.characters.first.name, "Test Tester"
+    # Should get from cache
+    assert_equal @api.Characters.characters.first.name, "Test Tester"
+    # TODO: Needs some better tests here.
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eaal
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Peter Petermann
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-02 00:00:00 +02:00
+date: 2009-04-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0.6"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.1
+    version: 
 - !ruby/object:Gem::Dependency 
   name: newgem
   type: :development
@@ -61,29 +71,32 @@ extensions: []
 
 extra_rdoc_files: 
 - History.txt
+- LICENSE.txt
 - Manifest.txt
 - README.rdoc
-- LICENSE.txt
 files: 
 - History.txt
+- LICENSE.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
+- lib/eaal/api.rb
+- lib/eaal/cache/base.rb
+- lib/eaal/cache/file.rb
+- lib/eaal/cache/memcached.rb
+- lib/eaal/exception.rb
+- lib/eaal/result.rb
+- lib/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
+- test/fixtures/test/test/char/Killlog/Request_characterID:12345.xml
+- test/fixtures/test/test/eve/AllianceList/Request_.xml
+- test/test_eaal.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: " http://eaal.rubyforge.org"
 post_install_message: 

data/lib/eaal/eaal.rb

@@ -1,114 +0,0 @@
-#--
-# 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.4"
-    @@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

@@ -1,90 +0,0 @@
-#--
-# 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, name)
-            ret = xml
-          else
-            ret = false
-          end
-        end
-        ret
-      end
-      
-      # validate cached datas cachedUntil
-      def validate_cache(xml, name)
-        doc = Hpricot.XML(xml)
-	if name == "WalletJournal"
-          Time.at((doc/"/eveapi/cachedUntil").inner_html.to_time.to_i + 3600) > Time.now
-        else 
-	  (doc/"/eveapi/cachedUntil").inner_html.to_time > Time.now
-	end
-      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

@@ -1,42 +0,0 @@
-#--
-# 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