easy_http_cache 2.2

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2006 Coda Hale
+Copyright (c) 2008 José Valim (jose.valim at gmail dot com)
+
+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.rdoc

@@ -0,0 +1,155 @@
+== Easy HTTP Cache
+
+Allows Rails applications to do conditional cache easily and in a DRY way
+(without messing up your actions):
+
+  class ListsController < ApplicationController
+    http_cache :index, :show, :last_modified => :list
+    
+    protected
+      def list
+        @list ||= List.find(params[:id])
+      end
+  end
+
+It uses :last_modified and :etag keys, that besides Time, String or resources
+accepts Proc, Method and Symbol that are evaluated within the current controller.
+
+Read more about each option (more examples at the end of this page):
+
+  :last_modified
+    Used to manipulate Last-Modified header. You can pass any object that responds
+    to :updated_at, :updated_on or :to_time. If you pass a Proc or Method or Symbol,
+    they will be evaluated within the current controller first.
+
+    Finally, if you pass an array, it will get the most recent time to be used.
+
+  :etag
+    Used to manipulate Etag header. The Etag is generated as memcached keys are
+    generated, i.e. calling to_param in the object and then MD5 is applied.
+    
+    If you pass a Proc or Method or Symbols, they will be also evaluated within the
+    current controller first.
+
+  :if
+    Only perform http cache if it returns true.
+
+  :unless
+    Only perform http cache if it returns false.
+  
+  :method
+    If in :last_modified you want to pass a object that doesn't respond to updated_at,
+    updated_on or to_time, you can specify the method that will be called in this object.
+
+== Install
+
+Install Easy HTTP Cache is available on gemcutter, so just execute:
+
+  sudo gem install easy_http_cache
+
+And add it to your environment.
+
+== Environment Variables
+
+As in memcached, you can set ENV['RAILS_CACHE_ID'] or ENV['RAILS_APP_VERSION'] variables
+to change the Etag that will be generated. This means you can control the cache by setting
+a timestamp or a version number in ENV['RAILS_APP_VERSION'] everytime you deploy.
+
+== Examples
+
+The example below will cache your actions and it will never expire:
+
+  class ListsController < ApplicationController
+    http_cache :index, :show
+  end
+
+If you do not want to cache when you are showing a flash message (and you
+usually want that), you can simply do:
+
+  class ListsController < ApplicationController
+    http_cache :index, :show, :if => Proc.new { |c| c.send(:flash).empty? }
+  end
+
+And if you do not want to cache JSON requests:
+
+  class ListsController < ApplicationController
+    http_cache :index, :show, :unless => Proc.new { |c| c.request.format.json? }
+  end
+
+Or if you want to expire all http cache before 2008, just do:
+
+  class ListsController < ApplicationController
+    http_cache :index, :show, :last_modified => Time.utc(2008)
+  end
+
+If you want to cache a list and automatically expire the cache when it changes,
+just do (it will check updated_at and updated_on on the @list object):
+
+  class ListsController < ApplicationController
+    http_cache :index, :show, :last_modified => :list
+
+    protected
+      def list
+        @list ||= List.find(params[:id])
+      end
+  end
+
+You can also set :etag header (it will generate an etag calling to_param
+in the object and applying MD5):
+
+  class ListsController < ApplicationController
+    http_cache :index, :show, :etag => :list
+
+    protected
+      def list
+        @list ||= List.find(params[:id])
+      end
+  end
+
+If you are using a resource that doesn't respond to updated_at or updated_on,
+you can pass a method as parameter that will be called in your resources:
+
+  class ListsController < ApplicationController
+    http_cache :index, :show, :last_modified => :list, :method => :cached_at
+
+    protected
+      def list
+        @list ||= List.find(params[:id])
+      end
+  end
+
+The sample below will call @list.cached_at to generate Last-Modified header.
+Finally, you can also pass an array at :last_modified as below:
+
+  class ItemsController < ApplicationController
+    http_cache :index, :show,
+               :last_modified => [ :list, :item ]
+
+    protected
+      def list
+        @list ||= List.find(params[:list_id])
+      end
+      
+      def item
+        @item ||= list.items.find(params[:id])
+      end
+  end
+
+This will check which one is the most recent to compare with the
+"Last-Modified" field sent by the client.
+
+== What if?
+
+At this point (or at some point), you will ask what happens if you use :etag
+and :last_modified at the same time.
+
+Well, the specification says that if both are sent by the client, both have
+to be valid for the cache not be considered stale. This subject was already brought
+to Rails Core group and this is also how Rails' current implementation behaves.
+
+== Bugs and Feedback
+
+If you find any issues, please use Github issues tracker.
+
+Copyright (c) 2009 José Valim
+http://blog.plataformatec.com.br/

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Run tests for Easy HTTP Cache.'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for Easy HTTP Cache.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Easy HTTP Cache'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('MIT-LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "easy_http_cache"
+    s.version = "2.2"
+    s.summary = "Allows Rails applications to use HTTP cache specifications easily."
+    s.email = "contact@plataformatec.com.br"
+    s.homepage = "http://github.com/josevalim/easy_http_cache"
+    s.description = "Allows Rails applications to use HTTP cache specifications easily."
+    s.authors = ['José Valim']
+    s.files =  FileList["[A-Z]*", "lib/**/*", "init.rb"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/init.rb

@@ -0,0 +1 @@
+require 'easy_http_cache'

data/lib/easy_http_cache.rb

@@ -0,0 +1,126 @@
+module ActionController #:nodoc:
+  module Caching
+    module HttpCache
+      def self.included(base) #:nodoc:
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # Declares that +actions+ should be cached.
+        #
+        def http_cache(*actions)
+          return unless perform_caching
+          options = actions.extract_options!
+
+          options.assert_valid_keys(
+            :last_modified, :method, :etag, :if, :unless
+          )
+
+          http_cache_filter = HttpCacheFilter.new(
+            :method => options.delete(:method),
+            :last_modified => [options.delete(:last_modified)].flatten.compact,
+            :etag => options.delete(:etag)
+          )
+          filter_options = {:only => actions}.merge(options)
+
+          before_filter(http_cache_filter, filter_options)
+        end
+      end
+
+      class HttpCacheFilter #:nodoc:
+        def initialize(options = {})
+          @options = options
+        end
+
+        def filter(controller)
+          return unless flash.empty? && controller.request.get?
+
+          last_modified = get_last_modified(controller)
+          controller.response.last_modified = last_modified if last_modified
+
+          processed_etags = get_processed_etags(controller)
+          controller.response.etag = processed_etags if processed_etags
+
+          if controller.request.fresh?(controller.response)
+            controller.send(:head, :not_modified)
+            return false
+          end
+        end
+
+        protected
+          # If :etag is an array, it processes all Methods, Procs and Symbols
+          # and return them as array. If it's an object, we only evaluate it.
+          #
+          def get_processed_etags(controller)
+            if @options[:etag].is_a?(Array)
+              @options[:etag].collect do |item|
+                evaluate_method(item, controller)
+              end
+            elsif @options[:etag]
+              evaluate_method(@options[:etag], controller)
+            else
+              nil
+            end
+          end
+
+          # We perform Last-Modified HTTP Cache when the option :last_modified is sent
+          # or no other cache mechanism is set (then we set a very old timestamp).
+          #
+          def get_last_modified(controller)
+            # Then, if @options[:last_modified] is not empty, we run through the array
+            # processing all objects (if needed) and return the latest one to be used.
+            #
+            if !@options[:last_modified].empty?
+              @options[:last_modified].collect do |item|
+                evaluate_time(item, controller)
+              end.compact.sort.last
+            elsif @options[:etag].blank?
+              Time.utc(0)
+            else
+              nil
+            end
+          end
+
+          def evaluate_method(method, controller)
+            case method
+              when Symbol
+                controller.__send__(method)
+              when Proc, Method
+                method.call(controller)
+              else
+                method
+              end
+          end
+
+          # Evaluate the objects sent and return time objects
+          #
+          # It process Symbols, String, Proc and Methods, get its results and then
+          # call :to_time, :updated_at, :updated_on on it.
+          #
+          # If the parameter :method is sent, it will try to call it on the object before
+          # calling :to_time, :updated_at, :updated_on.
+          #
+          def evaluate_time(method, controller)
+            return nil unless method
+            time = evaluate_method(method, controller)
+
+            time = time.__send__(@options[:method]) if @options[:method].is_a?(Symbol) && time.respond_to?(@options[:method])
+
+            if time.respond_to?(:to_time)
+              time.to_time.utc
+            elsif time.respond_to?(:updated_at)
+              time.updated_at.utc
+            elsif time.respond_to?(:updated_on)
+              time.updated_on.utc
+            else
+              nil
+            end
+          end
+
+        end
+
+    end
+  end
+end
+
+ActionController::Base.send :include, ActionController::Caching::HttpCache

data/test/easy_http_cache_test.rb

@@ -0,0 +1,212 @@
+# Those lines are plugin test settings
+require 'test/unit'
+require 'rubygems'
+require 'ostruct'
+
+ENV["RAILS_ENV"] = "test"
+
+require 'active_support'
+require 'action_controller'
+require 'action_controller/test_case'
+require 'action_controller/test_process'
+
+require File.dirname(__FILE__) + '/../lib/easy_http_cache.rb'
+
+ActionController::Base.perform_caching = true
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action/:id'
+end
+
+class HttpCacheTestController < ActionController::Base
+  http_cache :index
+  http_cache :show, :last_modified => 2.hours.ago, :if => Proc.new { |c| !c.request.format.json? }
+  http_cache :edit, :last_modified => Proc.new{ 30.minutes.ago }
+  http_cache :destroy, :last_modified => [2.hours.ago, Proc.new{|c| 30.minutes.ago }]
+  http_cache :invalid, :last_modified => [1.hours.ago, false]
+
+  http_cache :etag, :etag => 'ETAG_CACHE'
+  http_cache :etag_array, :etag => [ 'ETAG_CACHE', :resource ]
+  http_cache :resources, :last_modified => [:resource, :list, :object]
+  http_cache :resources_with_method, :last_modified => [:resource, :list, :object], :method => :cached_at
+
+  def index
+    render :text => '200 OK', :status => 200
+  end
+
+  alias_method :show, :index
+  alias_method :edit, :index
+  alias_method :destroy, :index
+  alias_method :invalid, :index
+  alias_method :etag, :index
+  alias_method :etag_array, :index
+  alias_method :resources, :index
+  alias_method :resources_with_method, :index
+
+  protected
+
+    def resource
+      resource = OpenStruct.new
+      resource.instance_eval do
+        def to_param
+          12345
+        end
+      end
+
+      resource.updated_at = 2.hours.ago
+      resource
+    end
+
+    def list
+      list = OpenStruct.new
+      list.updated_on = 30.minutes.ago
+      list
+    end
+
+    def object
+      object = OpenStruct.new
+      object.cached_at = 15.minutes.ago
+      object
+    end
+end
+
+class HttpCacheTest < ActionController::TestCase
+  def setup
+    reset!
+  end
+
+  def test_last_modified_http_cache
+    last_modified_http_cache(:show, 1.hour.ago, 3.hours.ago)
+  end
+
+  def test_last_modified_http_cache_with_proc
+    last_modified_http_cache(:edit, 15.minutes.ago, 45.minutes.ago)
+  end
+
+  def test_last_modified_http_cache_with_array
+    last_modified_http_cache(:destroy, 15.minutes.ago, 45.minutes.ago)
+  end
+  
+  def test_last_modified_http_cache_with_resources
+    last_modified_http_cache(:resources, 15.minutes.ago, 45.minutes.ago)
+  end
+
+  def test_last_modified_http_cache_with_resources_with_method
+    last_modified_http_cache(:resources_with_method, 10.minutes.ago, 20.minutes.ago)
+  end
+
+  def test_last_modified_http_cache_discards_invalid_input
+    last_modified_http_cache(:invalid, 30.minutes.ago, 90.minutes.ago)
+  end
+
+  def test_http_cache_without_input
+    get :index
+    assert_headers('200 OK', 'private, max-age=0, must-revalidate', 'Last-Modified', Time.utc(0).httpdate)
+    reset!
+
+    @request.env['HTTP_IF_MODIFIED_SINCE'] = 1.hour.ago.httpdate
+    get :index
+    assert_headers('304 Not Modified', 'private, max-age=0, must-revalidate', 'Last-Modified', Time.utc(0).httpdate)
+    reset!
+
+    @request.env['HTTP_IF_MODIFIED_SINCE'] = 3.hours.ago.httpdate
+    get :index
+    assert_headers('304 Not Modified', 'private, max-age=0, must-revalidate', 'Last-Modified', Time.utc(0).httpdate)
+  end
+
+  def test_http_cache_with_conditional_options
+    @request.env['HTTP_ACCEPT'] = 'application/json'
+    get :show
+    assert_nil @response.headers['Last-Modified']
+    reset!
+
+    @request.env['HTTP_ACCEPT'] = 'application/json'
+    @request.env['HTTP_IF_MODIFIED_SINCE'] = 1.hour.ago.httpdate
+    get :show
+    assert_equal '200 OK', @response.status
+  end
+
+  def test_etag_http_cache
+    etag_http_cache(:etag, 'ETAG_CACHE')
+  end
+
+  def test_etag_http_cache_with_array
+    etag_http_cache(:etag_array, ['ETAG_CACHE', 12345])
+  end
+
+  def test_etag_http_cache_with_env_variable
+    ENV['RAILS_APP_VERSION'] = '1.2.3'
+    etag_http_cache(:etag, 'ETAG_CACHE')
+  end
+
+  private
+    def reset!
+      @request = ActionController::TestRequest.new
+      @response = ActionController::TestResponse.new
+      @controller = HttpCacheTestController.new
+    end
+
+    def etag_for(etag)
+      %("#{Digest::MD5.hexdigest(ActiveSupport::Cache.expand_cache_key(etag))}")
+    end
+
+    def assert_headers(status, control, cache_header=nil, value=nil)
+      assert_equal status, @response.status
+      assert_equal control, @response.headers['Cache-Control']
+
+      if cache_header
+        if value
+          assert_equal value, @response.headers[cache_header]
+        else
+          assert @response.headers[cache_header]
+        end
+      end
+    end
+
+    # Goes through a http cache process:
+    #
+    #   1. Request an action
+    #   2. Get a '200 OK' status
+    #   3. Request the same action with a not expired HTTP_IF_MODIFIED_SINCE
+    #   4. Get a '304 Not Modified' status
+    #   5. Request the same action with an expired HTTP_IF_MODIFIED_SINCE
+    #   6. Get a '200 OK' status
+    #   
+    def last_modified_http_cache(action, not_expired_time, expired_time)
+      get action
+      assert_headers('200 OK', 'private, max-age=0, must-revalidate', 'Last-Modified')
+      reset!
+
+      @request.env['HTTP_IF_MODIFIED_SINCE'] = not_expired_time.httpdate
+      get action
+      assert_headers('304 Not Modified', 'private, max-age=0, must-revalidate', 'Last-Modified')
+      reset!
+
+      @request.env['HTTP_IF_MODIFIED_SINCE'] = expired_time.httpdate
+      get action
+      assert_headers('200 OK', 'private, max-age=0, must-revalidate', 'Last-Modified')
+    end
+
+    # Goes through a http cache process:
+    #
+    #   1. Request an action
+    #   2. Get a '200 OK' status
+    #   3. Request the same action with a valid ETAG
+    #   4. Get a '304 Not Modified' status
+    #   5. Request the same action with an invalid IF_NONE_MATCH
+    #   6. Get a '200 OK' status
+    #   
+    def etag_http_cache(action, variable)
+      get action
+      assert_headers('200 OK', 'private, max-age=0, must-revalidate', 'ETag', etag_for(variable))
+      reset!
+
+      @request.env['HTTP_IF_NONE_MATCH'] = etag_for(variable)
+      get action
+      assert_headers('304 Not Modified', 'private, max-age=0, must-revalidate', 'ETag', etag_for(variable))
+      reset!
+
+      @request.env['HTTP_IF_NONE_MATCH'] = 'INVALID'
+      get action
+      assert_headers('200 OK', 'private, max-age=0, must-revalidate', 'ETag', etag_for(variable))
+    end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: easy_http_cache
+version: !ruby/object:Gem::Version 
+  version: "2.2"
+platform: ruby
+authors: 
+- "Jos\xC3\xA9 Valim"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-23 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Allows Rails applications to use HTTP cache specifications easily.
+email: contact@plataformatec.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/easy_http_cache.rb
+has_rdoc: true
+homepage: http://github.com/josevalim/easy_http_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Allows Rails applications to use HTTP cache specifications easily.
+test_files: 
+- test/easy_http_cache_test.rb