cryx-cacheability 0.1.2 → 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.sw?
+.DS_Store
+coverage

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Cyril Rohr
+
+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/README

@@ -0,0 +1,41 @@
+Cacheability
+============
+A gem that makes client-side caching of HTTP requests a no-brainer. It is built upon the Rack:Cache gem from Ryan Tomayko.
+
+Cached data can be stored in heap, file or memcached. See the Rack::Cache documentation (http://tomayko.com/src/rack-cache/) for more information.
+
+Installation
+============
+  gem install cryx-cacheability
+  
+Usage
+=====
+  require 'cacheability/restclient'
+  resource = RestClient::CacheableResource.new(  'http://some/cacheable/resource', 
+                                                  :cache => { :metastore => 'file:/tmp/cache/meta', 
+                                                              :entitystore => 'file:/tmp/cache/body' } 
+                                              )
+  resource.get # get from remote server, and cache if possible
+  # ...
+  resource.get # get from cache, if still fresh.
+  # ...
+  resource.get(:cache_control => 'no-cache') # explicitly tells to bypass the cache, requires rack-cache >= 0.4
+  # ...
+
+Do yourself a favor and read: 
+* the HTTP specification related to HTTP caching - http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html
+* Things Caches Do - http://tomayko.com/writings/things-caches-do
+
+
+Supported libraries
+===================
+* rest-client > 0.9
+
+Dependencies
+============
+* rack-cache
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 Cyril Rohr. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "cacheability"
+    s.summary = %Q{TODO}
+    s.email = "cyril.rohr@irisa.fr"
+    s.homepage = "http://github.com/cryx/cacheability"
+    s.description = "A gem that makes client-side caching of HTTP requests a no-brainer. It is built upon the Rack:Cache gem from Ryan Tomayko."
+    s.authors = ["Cyril Rohr"]
+    s.add_dependency "rack-cache"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'cacheability'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+end
+
+task :default => :spec

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 1
-:patch: 2
-:major: 0
+:major: 1
+:minor: 0
+:patch: 0

data/cacheability.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cacheability}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cyril Rohr"]
+  s.date = %q{2009-08-07}
+  s.description = %q{A gem that makes client-side caching of HTTP requests a no-brainer. It is built upon the Rack:Cache gem from Ryan Tomayko.}
+  s.email = %q{cyril.rohr@irisa.fr}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION.yml",
+     "cacheability.gemspec",
+     "lib/cacheability.rb",
+     "lib/cacheability/restclient.rb",
+     "spec/cacheability_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/cryx/cacheability}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{TODO}
+  s.test_files = [
+    "spec/cacheability_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack-cache>, [">= 0"])
+    else
+      s.add_dependency(%q<rack-cache>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rack-cache>, [">= 0"])
+  end
+end

data/lib/cacheability/restclient.rb

@@ -14,13 +14,17 @@ module RestClient
     end
     
     def to_hash
-      @headers
+      @headers.inject({}) {|out, (key, value)|
+        # In Net::HTTP, headers values are arrays
+        out[key] = value.split(", ")
+        out
+      }
     end    
   end
   
   class CacheableResource < Resource
     attr_reader :cache
-    CACHE_DEFAULT_OPTIONS = {}.freeze
+    CACHE_DEFAULT_OPTIONS = {:verbose => true}.freeze
     
     def initialize(*args)
       super(*args)
@@ -80,7 +84,9 @@ module RestClient
       response.headers.delete(:x_content_digest) # don't know why, but it seems to make the validation fail if kept...
       [response.code, debeautify_headers( response.headers ), [response.to_s]]
     rescue RestClient::NotModified => e
-      [304, e.response.to_hash, [""]]
+      # e is a Net::HTTPResponse
+      response = RestClient::Response.new("", e.response)
+      [304, debeautify_headers( response.headers ), [response.to_s]]
     end
   end
 end

data/spec/cacheability_spec.rb

@@ -21,7 +21,7 @@ describe RestClient::CacheableResource do
     before do
       @mock_cache = mock('rack-cache singleton')
       @mock_rack_errors = mock('string io')
-      @mock_304_net_http_response = mock('http response', :code => 304, :body => "", :to_hash => {'header1' => 'value1'})
+      @mock_304_net_http_response = mock('http response', :code => 304, :body => "", :to_hash => {'header1' => ['value1', 'value2']})
       Rack::Cache.stub!(:new).and_return(@mock_cache)
       @env = {
         'REQUEST_METHOD' => 'GET',
@@ -48,13 +48,13 @@ describe RestClient::CacheableResource do
     it "should call the backend (bypassing the cache) if the requested resource is not in the cache" do
       @resource.should_receive(:get).with({'ADDITIONAL-HEADER' => 'whatever'}, false).and_return(mock('rest-client response', :headers => {}, :code => 200, :to_s => 'body'))
       response = @resource.call(@env.merge({'HTTP_ADDITIONAL_HEADER' => 'whatever'}))
-      response.should == [200, {}, "body"]
+      response.should == [200, {}, ["body"]]
     end
     
     it "should return a 304 not modified response if the call to the backend returned a 304 not modified response" do
       @resource.should_receive(:get).with({'ADDITIONAL-HEADER' => 'whatever'}, false).and_raise(RestClient::NotModified.new(@mock_304_net_http_response))
       response = @resource.call(@env.merge({'HTTP_ADDITIONAL_HEADER' => 'whatever'}))
-      response.should == [304, {"header1"=>"value1"}, ""]
+      response.should == [304, {"header1"=>"value1"}, [""]]
     end
     
     it "should render a RestClient::Response even when the data is coming from the cache" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cryx-cacheability
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-31 00:00:00 -07:00
+date: 2009-08-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,20 +28,25 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README
 files: 
+- .gitignore
+- LICENSE
+- README
+- Rakefile
 - VERSION.yml
-- lib/cacheability
-- lib/cacheability/restclient.rb
+- cacheability.gemspec
 - lib/cacheability.rb
+- lib/cacheability/restclient.rb
 - spec/cacheability_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/cryx/cacheability
+licenses: 
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -60,9 +65,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: TODO
-test_files: []
-
+test_files: 
+- spec/cacheability_spec.rb
+- spec/spec_helper.rb