rattlecache 0.2 → 0.3

data/lib/backends/filesystem.rb

@@ -69,6 +69,11 @@ module Rattlecache
         end
       end
 
+      # returns the number of entries in this cache
+      def entries()
+        Dir.entries(@prefix).size - 2
+      end
+
     end
   end
 end

data/lib/caches/Auctionscache.rb

@@ -19,9 +19,9 @@ module Rattlecache
       # If yes, request without fields and look into ['lastModified']
       # if we need to fetch new or answer with our cached result.",
       if cached_data[:status] == 200
-        puts "Debug: Auctionscache: cache HIT for #{url}"
+        #puts "Debug: Auctionscache: cache HIT for #{url}"
         unless is_lmt_and_url_request(url)
-          puts "Debug: Auctionscache: has fields. Timethings: #{cached_data[:lastModified]} < #{get_lmt(url,header)} #{cached_data[:lastModified] < get_lmt(url,header)}"
+          #puts "Debug: Auctionscache: has fields. Timethings: #{cached_data[:lastModified]} < #{get_lmt(url,header)} #{cached_data[:lastModified] < get_lmt(url,header)}"
           if cached_data[:lastModified] < get_lmt(url,header)
             cached_data = {:status => 404}
           end
@@ -33,7 +33,7 @@ module Rattlecache
          end
         end
       else
-        puts "Debug: Auctionscache: cache MISS for #{url}"
+        #puts "Debug: Auctionscache: cache MISS for #{url}"
       end
       cached_data
     end
@@ -49,7 +49,7 @@ module Rattlecache
     # @param header [Hash] the Hash of headers for a api request
     def get_lmt(url,header)
       cached_data = @backend.get(sanitize(generic_auctions_url(url)))
-      puts "Debug: get_lmt() cache result for generic url: #{cached_data[:status]}"
+      #puts "Debug: get_lmt() cache result for generic url: #{cached_data[:status]}"
       # if the object was not in the cache or it is expired
       if cached_data[:status] != 200 or generic_needs_request?(cached_data[:header],cached_data[:lastModified])
         # request it from the api
@@ -58,21 +58,27 @@ module Rattlecache
         cached_data = @backend.get(sanitize(generic_auctions_url(url)))
       end
       # this a JS milliseconds timestamp, we only do seconds!
-      Time.at(JSON.parse(cached_data[:object])["lastModified"]/1000)
+      Time.at(JSON.parse(cached_data[:object])["files"][0]["lastModified"]/1000)
     end
 
     def request_generic(url,header)
       # need to request the generic guild response
       url = generic_auctions_url(url)
       # request it from the API:
-      got = request_raw(url,header)
-      @backend.post({:key => sanitize(url),:header => got.header.to_hash, :data => got.body}) # and put into cache
+      begin
+        got = request_raw(url,header)
+        # FIXME this doesnt count towards the caches post count!
+        @backend.post({:key => sanitize(url),:header => got.header.to_hash, :data => got.body}) # and put into cache
+      rescue
+        # some day this will fail! Not sure yet what to do about...
+        raise
+      end
     end
 
 
     def generic_auctions_url(url)
       u = URI.parse(url)
-      u.path=(u.path.gsub("-data","/data").gsub(/\/auctions.*\.json$/,""))
+      u.path=("/api/wow/"+u.path.gsub("-data","/data").gsub(/\/auctions.*\.json$/,""))
       u.to_s
     end
   end

data/lib/caches/Fieldsrequestcache.rb

@@ -19,9 +19,9 @@ module Rattlecache
       # If yes, request without fields and look into ['lastModified']
       # if we need to fetch new or answer with our cached result.",
       if cached_data[:status] == 200
-        puts "Debug: guildcache: cache HIT for #{url}"
+        #puts "Debug: guildcache: cache HIT for #{url}"
         if has_fields?(url)
-          puts "Debug: guildcache: has fields. Timethings: #{cached_data[:lastModified]} < #{get_lmt(url,header)} #{cached_data[:lastModified] < get_lmt(url,header)}"
+          #puts "Debug: guildcache: has fields. Timethings: #{cached_data[:lastModified]} < #{get_lmt(url,header)} #{cached_data[:lastModified] < get_lmt(url,header)}"
           if cached_data[:lastModified] < get_lmt(url,header)
             cached_data = {:status => 404}
           end
@@ -33,7 +33,7 @@ module Rattlecache
          end
         end
       else
-        puts "Debug: guildcache: cache MISS for #{url}"
+        #puts "Debug: guildcache: cache MISS for #{url}"
       end
       cached_data
     end
@@ -43,7 +43,7 @@ module Rattlecache
     # @param header [Hash] the Hash of headers for a api request
     def get_lmt(url,header)
       cached_data = @backend.get(sanitize(url_without_fields(url)))
-      puts "Debug: get_lmt() cache result for generic url: #{cached_data[:status]}"
+      #puts "Debug: get_lmt() cache result for generic url: #{cached_data[:status]}"
       # if the object was not in the cache or it is expired
       if cached_data[:status] != 200 or generic_needs_request?(cached_data[:header],cached_data[:lastModified])
         # request it from the api
@@ -51,8 +51,13 @@ module Rattlecache
         # and load the new object
         cached_data = @backend.get(sanitize(url_without_fields(url)))
       end
-      # this a JS milliseconds timestamp, we only do seconds!
-      Time.at(JSON.parse(cached_data[:object])["lastModified"]/1000)
+      begin
+        # this a JS milliseconds timestamp, we only do seconds!
+        Time.at(JSON.parse(cached_data[:object])["lastModified"]/1000)
+      rescue NoMethodError
+        # if the data could not be retrieved, there will be a noMethod on nil object Error!
+        raise
+      end
     end
 
     def request_without_fields(url,header)
@@ -60,11 +65,12 @@ module Rattlecache
       url = url_without_fields(url)
       # request it from the API:
       got = request_raw(url,header)
+      # FIXME this doesnt count towards the caches post count!
       @backend.post({:key => sanitize(url),:header => got.header.to_hash, :data => got.body}) # and put into cache
     end
 
     def url_without_fields(url)
-      url_obj = URI.parse(url)
+      url_obj = URI.parse(URI.encode(url))
       url_obj.query=(url_obj.query.gsub(/fields=.+&|$/,"")) # strip the fields
       url_obj.to_s
     end

data/lib/rattlecache.rb

@@ -9,9 +9,13 @@ module Rattlecache
     # @param backend [Symbol]
     # @param adapter [Battlenet::Adapter::AbstractAdapter]
     def initialize(backend = :filesystem, adapter = nil)
-      puts "Debug: rattlecache adapter: #{adapter}"
       @adapter = adapter
       @backend = Rattlecache::Backend.fetch(backend)
+
+      @status = Hash.new
+      @status[:hits] = 0
+      @status[:misses] = 0
+      @status[:posts] = 0
     end
 
     @request_pragmas = {
@@ -31,25 +35,27 @@ module Rattlecache
       # what to do with this request?
       case request_type(url)
         when "guild"
-          puts "Debug: its a guild related request!"
           require 'caches/Fieldsrequestcache'
-          Rattlecache::Fieldsrequestcache.new(@backend,@adapter).get(url,header)
+          res = Rattlecache::Fieldsrequestcache.new(@backend,@adapter).get(url,header)
         when "character"
-          puts "Debug: its a character related request!"
           require 'caches/Fieldsrequestcache'
-          Rattlecache::Fieldsrequestcache.new(@backend,@adapter).get(url,header)
+          res = Rattlecache::Fieldsrequestcache.new(@backend,@adapter).get(url,header)
         when /auction.*/
-          puts "Debug: its a auchtion related request!"
           require 'caches/Auctionscache'
-          Rattlecache::Auctionscache.new(@backend,@adapter).get(url,header)
+          res = Rattlecache::Auctionscache.new(@backend,@adapter).get(url,header)
         when "item"
           # for items it seems reasonable to cache them at least for a week
           # a week in seconds: 60*60*24*7 = 604800
-          check_and_return(@backend.get(sanitize(url)),604800)
+          res = check_and_return(@backend.get(sanitize(url)),604800)
         else
-          puts "Debug: its a boring request!"
-          check_and_return(@backend.get(sanitize(url)))
+          res =  check_and_return(@backend.get(sanitize(url)))
+      end
+      if res[:status] == 200
+        @status[:hits] +=1
+      else
+        @status[:misses] +=1
       end
+      res
     end
 
     def check_and_return(backend_result,given_time = nil)
@@ -67,6 +73,7 @@ module Rattlecache
 
     # @param object [Hash]
     def post(object)
+      @status[:posts] += 1
       #puts "Cache class puts: #{object[:key]}"
       @backend.post({:key => sanitize(object[:key]), :header => object[:header], :data => object[:data]})
     end
@@ -82,7 +89,7 @@ module Rattlecache
     # @param headerline [Hash]
     # @param mtime [Time]
     # @return [TrueClass|FalseClass]
-    def generic_needs_request?(headerline,mtime)
+    def generic_needs_request?(headerline,mtime,alternative_living_time = 3600)
       header = JSON.parse(headerline)
       #header["date"][0] is a String with CGI.rfc1123_date() encoded time,
       # as there is no easy method to inverse this coding, I will keep using the files mtime
@@ -95,7 +102,7 @@ module Rattlecache
         else
           # if we dont find any hint, pull it again!
           puts "Warning: Cache couldn't find any hint if this object is still valid!"
-          true
+          mtime+alternative_living_time < Time.now()
         end
       end
     end
@@ -108,7 +115,7 @@ module Rattlecache
     # @return [String]
     def sanitize(objectKey)
       # strip scheme, sort paramters and encode for safty
-      urlObj = URI.parse(objectKey)
+      urlObj = URI.parse(URI.encode(objectKey))
       key = urlObj.host
       key << urlObj.path
       key << sort_params(urlObj.query)
@@ -134,7 +141,7 @@ module Rattlecache
     # @return [String]
     def request_type(objectKey)
       #[0] = "". [1]= "api". [2]="wow", [3]= what we want
-      URI.parse(objectKey).path.split("/")[3]
+      URI.parse(URI.encode(objectKey)).path.split("/")[3]
     end
 
     # @param query [String]
@@ -151,5 +158,32 @@ module Rattlecache
       req.get(url,header)
     end
 
+    def status(options = {})
+      puts "Rattlecache: STATUS:"
+      puts "\tentries in cache: #{entries()}"
+      begin
+      puts "\trequests served: #{(hits+misses)}, hits: #{hits()} (#{(100*(hits()/(hits()+misses()))).to_i}%), misses: #{misses()} (#{(100*(misses()/(hits()+misses()))).to_i}%)"
+      rescue ZeroDivisionError
+        puts "\t requests served: nothing yet"
+      end
+      puts "\tposts to cache: #{posts}"
+    end
+
+    def entries()
+      @backend.entries()
+    end
+
+    def hits()
+      @status[:hits]
+    end
+
+    def misses()
+      @status[:misses]
+    end
+
+    def posts()
+      @status[:posts]
+    end
+
   end
 end

data/rattlecache.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "rattlecache"
-  s.version     = "0.2"
+  s.version     = "0.3"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Marv Cool"]
   s.email       = "marv@hostin.is"

data/test/test_Backend_Filesystem.rb

@@ -66,8 +66,8 @@ class MyTest < Test::Unit::TestCase
     @cache.post(testobject)
     res = @cache.get(testobject[:key])
     assert_instance_of(Hash,res)
-    # assert that this is 404, cause the object has no validation information
-    assert_equal(404,res[:status])
+    # assert that this is 200, cause the object has no validation information
+    assert_equal(200,res[:status])
 
     testobject[:header] = {
         "foo" => ["bar-thishastobethere-baz"],

metadata

@@ -1,43 +1,33 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rattlecache
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  version: "0.2"
+version: !ruby/object:Gem::Version
+  version: '0.3'
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Marv Cool
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-23 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70146636750420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *70146636750420
 description: 
 email: marv@hostin.is
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gemtest
 - .gitignore
 - Gemfile
@@ -52,38 +42,30 @@ files:
 - rattlecache.gemspec
 - test/test_Backend_Filesystem.rb
 - test/test_cache.rb
-has_rdoc: true
 homepage: https://github.com/MrMarvin/rattlcache/wiki
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: A smart caching system for battlenet API Requests.
-test_files: 
+test_files:
 - test/test_Backend_Filesystem.rb
 - test/test_cache.rb