rattlecache 0.1 → 0.2

data/Rakefile

@@ -1,5 +1,13 @@
 require 'bundler'
 require 'rspec/core/rake_task'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
 
 Bundler::GemHelper.install_tasks
 RSpec::Core::RakeTask.new(:spec) do |t|

data/lib/backends/filesystem.rb

@@ -40,9 +40,17 @@ module Rattlecache
         #puts "Debug: filesystem posted #{object[:key]}"
       end
 
+      def delete(object_key)
+        begin
+          File.delete(@prefix+object_key)
+        rescue Errno::ENOENT
+
+        end
+      end
+
       def open_file(objectKey,how="r")
         begin
-          Dir.mkdir(@prefix) unless File.directory?(@prefix)
+          make_sure_dir_exists()
           File.open(@prefix+objectKey,how)
         rescue
           # raise this to the caller
@@ -50,6 +58,17 @@ module Rattlecache
         end
       end
 
+      def make_sure_dir_exists()
+        Dir.mkdir(@prefix) unless File.directory?(@prefix)
+      end
+
+      def flush()
+        make_sure_dir_exists()
+        Dir.foreach(@prefix) do |file|
+          File.delete(@prefix+file) unless File.directory?(file)
+        end
+      end
+
     end
   end
 end

data/lib/rattlecache.rb

@@ -25,7 +25,7 @@ module Rattlecache
     # @param header [Hash]
     def get(url, header = nil)
       @header = header
-      @header['User-Agent'] = @header['User-Agent'] << " (with rattlecache)"
+      @header['User-Agent'] = @header['User-Agent'] << " (with rattlecache)" unless header.nil?
       #puts "Cache class gets you: #{objectKey}"
 
       # what to do with this request?
@@ -71,6 +71,14 @@ module Rattlecache
       @backend.post({:key => sanitize(object[:key]), :header => object[:header], :data => object[:data]})
     end
 
+    def delete(url)
+      @backend.delete(sanitize(url))
+    end
+
+    def flush
+      @backend.flush()
+    end
+
     # @param headerline [Hash]
     # @param mtime [Time]
     # @return [TrueClass|FalseClass]
@@ -110,6 +118,9 @@ module Rattlecache
     # @param query [String]
     # @return [String]
     def sort_params(query)
+      if query.nil? or query.empty?
+        return ""
+      end
       q = Hash.new
       query.split("&").each do |parampair|
         q[parampair.split("=")[0]] = parampair.split("=")[1]

data/rattlecache.gemspec

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

data/test/test_Backend_Filesystem.rb

@@ -0,0 +1,87 @@
+require "test/unit"
+require "rattlecache"
+
+class MyTest < Test::Unit::TestCase
+
+  # Called before every test method runs. Can be used
+  # to set up fixture information.
+  def setup
+    @cache = Rattlecache::Cache.new(:filesystem)
+    @prefix = "/tmp/rattlecache/"
+
+  end
+
+  # Called after every test method runs. Can be used to tear
+  # down fixture information.
+
+  def teardown
+    # Do nothing
+  end
+
+  def test_flush()
+    @cache.flush
+    assert(File.directory?(@prefix))
+    assert(Dir.entries(@prefix) == [".",".."])
+  end
+
+
+  def test_get_nonexisting_object()
+    @cache.flush
+    res = @cache.get("http://example.com/some/path/some.file")
+    assert_instance_of(Hash,res)
+    assert_equal(404,res[:status])
+  end
+
+  def test_post()
+    @cache.flush
+    testobject = {
+        :key => "http://example.com/some/path/some.file",
+        :header => {"foo" => "bar-thishastobethere-baz", "date" => Time.now(), "content-type" => "text/plain"},
+        :data => %{Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
+                  sed diam nonumy eirmod tempor invidunt ut labore et dolore
+                  magna aliquyam erat, sed diam voluptua. At vero eos et accusam
+                  et justo duo dolores et ea rebum. Stet clita kasd gubergren,
+                   no sea takimata sanctus est Lorem ipsum dolor sit amet.}
+    }
+    testobject_key = @cache.sanitize(testobject[:key])
+    @cache.post(testobject)
+    assert(Dir.entries(@prefix).include?(testobject_key))
+
+    # posting this a second time. What happens than?
+    @cache.post(testobject)
+    assert(Dir.entries(@prefix).include?(testobject_key))
+
+  end
+
+  def test_get()
+    testobject = {
+        :key => "http://example.com/some/path/some.file",
+        :header => {"foo" => "bar-thishastobethere-baz", "date" => Time.now(), "content-type" => "text/plain"},
+        :data => %{Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
+                  sed diam nonumy eirmod tempor invidunt ut labore et dolore
+                  magna aliquyam erat, sed diam voluptua. At vero eos et accusam
+                  et justo duo dolores et ea rebum. Stet clita kasd gubergren,
+                   no sea takimata sanctus est Lorem ipsum dolor sit amet.}
+    }
+    @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])
+
+    testobject[:header] = {
+        "foo" => ["bar-thishastobethere-baz"],
+        "date" => [Time.now()],
+        "content-type" => ["text/plain"],
+        "cache-control" => ["max-age=2592000"]
+    }
+
+    @cache.post(testobject)
+    res = @cache.get(testobject[:key])
+    assert_instance_of(Hash,res)
+    # assert that this is 200, cause the object has "cache-control" => "max-age=2592000"
+    assert_equal(200,res[:status])
+
+  end
+
+end

data/test/test_cache.rb

@@ -0,0 +1,66 @@
+require "test/unit"
+require "rattlecache"
+
+class CacheTest < Test::Unit::TestCase
+
+  # Called before every test method runs. Can be used
+  # to set up fixture information.
+  def setup
+    @cache = Rattlecache::Cache.new()
+  end
+
+  # Called after every test method runs. Can be used to tear
+  # down fixture information.
+
+  def teardown
+    # Do nothing
+  end
+
+  def test_sort_params()
+    params = "a=1&z=zzz&car=a,b,or,c&bar=2&1=firstofall"
+    sorted_params = "?1=firstofall&a=1&bar=2&car=a,b,or,c&z=zzz"
+    assert_equal(sorted_params,@cache.sort_params(params))
+  end
+
+  def test_request_type()
+    input = "http://eu.battle.net/api/wow/item/25"
+    type = "item"
+    assert_equal(type,@cache.request_type(input))
+
+    input = "http://eu.battle.net/api/wow/guild/nathrezim/Badeverein%20Orgrimmar?fields=members"
+    type = "guild"
+    assert_equal(type,@cache.request_type(input))
+
+    input = "http://eu.battle.net/api/wow/auction/data/nathrezim"
+    type = /auction.*/
+    assert_match(type,@cache.request_type(input))
+
+    input = "http://eu.battle.net/auction-data/nathrezim/auctions.json"
+    type = /auction.*/
+    assert_match(type,@cache.request_type(input))
+
+    input = "http://eu.battle.net/api/wow/character/nathrezim/schnecke?fields=items"
+    type = "character"
+    assert_equal(type,@cache.request_type(input))
+  end
+
+  def test_needs_request_with_given_time?()
+    # an our ago + 30 minutes should be O.K.
+    assert(@cache.needs_request_with_given_time?(60*30,Time.now-(60*60)))
+  end
+
+  def test_sanitize()
+    input = "http://eu.battle.net/api/wow/character/nathrezim/schnecke?fields=items&locale=en_GB"
+    exp = "0d85213fdb08da5936e1783f5dde60dbb159164a2d084b157773e3067bcdac88"
+    assert_equal(exp,@cache.sanitize(input))
+
+    input_with_unsorted_params = "http://eu.battle.net/api/wow/character/nathrezim/schnecke?locale=en_GB&fields=items"
+    assert_equal(@cache.sanitize(input_with_unsorted_params),@cache.sanitize(input))
+  end
+
+  def test_has_fields?()
+    assert(@cache.has_fields?("http://eu.battle.net/api/wow/character/nathrezim/schnecke?fields=items&locale=en_GB"))
+    assert_instance_of(FalseClass,@cache.has_fields?("http://eu.battle.net/api/wow/character/nathrezim/schnecke?locale=en_GB"))
+  end
+
+end

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  version: "0.1"
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Marv Cool
@@ -38,6 +38,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gemtest
 - .gitignore
 - Gemfile
 - LICENSE
@@ -49,6 +50,8 @@ files:
 - lib/caches/Fieldsrequestcache.rb
 - lib/rattlecache.rb
 - rattlecache.gemspec
+- test/test_Backend_Filesystem.rb
+- test/test_cache.rb
 has_rdoc: true
 homepage: https://github.com/MrMarvin/rattlcache/wiki
 licenses: []
@@ -81,5 +84,6 @@ rubygems_version: 1.3.7
 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