rest_cache 0.0.1 → 0.0.2

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+.gitignore
+*~

data/README

@@ -0,0 +1,57 @@
+RestCache by Dave Barbalato
+---------------------------
+
+When To Use This Gem:
+
+	You have built a RESTful service in a Rack-based frameword, such as Rails, and you want to cache requests intelligently behind the scenes. This gem does just that - Using your parameters or some sane defaults, you can eliminate the retrieval of the same data across GET requests in your application. This caching can be performed globally, where processing power allocated to one individual can be used to the benefit of the group, or alternatively, on a per-session basis.
+
+
+The Cool Part:
+		
+	RestCache is powerful in that, through reliance on the conventions of RESTful verbs, any cached request will be ignored if a PUT/POST/DELETE has been seen before the expiration time. This ensures that cached data is thrown out when it has become stale.
+
+	
+Instructions (Rails 3.1+):
+
+	1.) Get the RestCache gem
+	
+		Install from the public repository using the following line:
+	
+			gem install rest_cache
+
+
+	2.) Install the Rack middleware
+		
+		In your application.rb file, add the following line*:
+	
+			config.middleware.use 'RestCache::Middleware'#, {:global => true, :expiration_seconds => 300}
+		
+		This tells your Rails application to insert RestCache into the Rack middleware stack. 
+		
+		*Note: supplying the hash is optional (hence why it is commented out above), and is set to "{:expiration_seconds => 300, :global => true}" by default in the gem.
+
+	
+	3.) Configure RestCache
+	
+		If you want your app to cache requests on a per-session basis, modify the option hash like so:
+		
+			{ :global => false, :expiration_seconds => 300 }
+			
+		Doing so will result in more personalized requests, but will yield higher memory usage, and thus fewer performance benefits, which is why it is not the default :)
+		
+		If you want your app to cache requests for longer than 300 seconds (5 minutes), modify the option hash like so:
+		
+			{ :global => true, :expiration_seconds => 86400 }
+			
+		Using this configuration, requests will be cached for a day, UNLESS the service endpoint is accessed with a PUT/POST/DELETE request.
+		
+		
+License:
+
+	Free to use for any entity without any warranty or guarantee - have at it! Give me credit if you wish, or better yet, a job with an awesome salary. Please forward constructive criticism to dbarbalato@gmail.com, and all complaints to /dev/null. 
+
+
+Comments:
+		
+Thanks for using the gem, I hope you find it useful! 
+

data/lib/rest_cache/version.rb

@@ -1,3 +1,3 @@
 module RestCache
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/rest_cache.rb

@@ -1,12 +1,20 @@
 require "rest_cache/version"
 
 module RestCache
-
+	
 	class Middleware
 
+		EXPIRATION_SECONDS_DEFAULT = 300
+		GLOBAL_CACHING_DEFAULT = true
+
 	  @@cache = {}
 	
-	  def initialize(app, options = { :expiration_seconds => 300, :global => true })
+	  def initialize(app, options)
+	  
+	  	# assign defaults to potentially missing options
+	    options[:expiration_seconds] ||= EXPIRATION_SECONDS_DEFAULT
+	    options[:global] &&= GLOBAL_CACHING_DEFAULT
+	  
 	    @app = app
 	    @options = options
 	  end
@@ -50,8 +58,7 @@ module RestCache
     	purge_expired
 
 	    # build a request
-    	key = @request.fullpath
-	    key << @request.session[:session_id] unless @options[:global]
+    	key = '' << (@request.session[:session_id] unless @options[:global]) << @request.fullpath
     
 	    # return the cached result, if present
 	    if @@cache.has_key? key
@@ -66,7 +73,7 @@ module RestCache
 
 	  def purge_path(path)
 	    @@cache.each do |key, value|
-	      @@cache.delete(key) if key.gsub(/\.(.*)$/, '') == path
+	      @@cache.delete(key) if key.gsub(/\.(.*)$/, '').end_with? path
     	end
 	  end
 

data/rest_cache.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["dbarbalato@gmail.com"]
   s.homepage    = ""
   s.summary     = %q{Request caching for Rack-based web applications.}
-  s.description = %q{RestCache is Rack middleware that relies on HTTP verbs to cache requests to your server application. Every GET request will be cached according to your initialization parameters (see example for more information), and conversely, every PUT/POST/DELETE request will clear your cache to ensure that updates are always reflected. RestCache is designed to be a lightweight, simple, yet effective tool to enhance the performance of your application. }
+  s.description = %q{RestCache is Rack middleware that relies on HTTP verbs to cache requests to your server application. Every GET request will be cached according to your initialization parameters (see README for more information), and conversely, every PUT/POST/DELETE request will clear your cache to ensure that updates are always reflected. RestCache is designed to be a lightweight, simple, yet effective tool to enhance the performance of your application. }
 
   s.rubyforge_project = "RestCache"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-05 00:00:00.000000000Z
+date: 2012-05-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &69360080 !ruby/object:Gem::Requirement
+  requirement: &82828900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *69360080
+  version_requirements: *82828900
 description: ! 'RestCache is Rack middleware that relies on HTTP verbs to cache requests
   to your server application. Every GET request will be cached according to your initialization
-  parameters (see example for more information), and conversely, every PUT/POST/DELETE
+  parameters (see README for more information), and conversely, every PUT/POST/DELETE
   request will clear your cache to ensure that updates are always reflected. RestCache
   is designed to be a lightweight, simple, yet effective tool to enhance the performance
   of your application. '
@@ -36,7 +36,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- Rakefile
+- README
 - lib/rest_cache.rb
 - lib/rest_cache/version.rb
 - rest_cache.gemspec

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"