josevalim-easy_http_cache 2.0

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

@@ -0,0 +1,174 @@
+Copyright (c) 2008 José Valim (jose.valim at gmail dot com)
+Site: http://www.pagestacker.com/
+Blog: http://josevalim.blogspot.com/
+License: MIT
+Version: 2.0
+
+You can also read this README in pretty html at the GitHub project Wiki page
+
+  http://github.com/josevalim/easy_http_cache/wikis/home
+
+Warning
+-------
+
+Since version 2.0, this plugin/gem has drastically changed to fit Rails 2.2
+http cache goodness. :expires_in, :expires_at and :control options were
+removed, so if you want to use previous versions, see "Previous versions"
+below.
+
+Description
+-----------
+
+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
+  end
+
+It uses :last_modified and :etag keys, that besides Time, String or resources
+accepts Proc, Method and Symbols that are evaluated within the current controller.
+Read more about each option below:
+
+  :last_modified
+    Used to manipulate Last-Modified header. You can pass any object that responds
+    to :to_time. If you pass a Proc or Method or Symbols, they will be evaluated
+    within the current controller and :to_time will be called.
+
+    You can also pass resources and :updated_at or :updated_on will be called on
+    it. If you want to call a different method on your resource, you can pass it as
+    a symbol using the :method option.
+
+    All times will be converted to UTC. Finally, if you pass an array, it will get
+    the most recent time to be used.
+
+  :etag
+    Used to manipulate Etag header. If you pass a Proc or Method or Symbols, they
+    will be evaluated within the current controller.
+
+    You can also pass an array and each element will be also evaluated with needed.
+
+  :if
+    Only perform http cache if it returns true.
+
+  :unless
+    Only perform http cache if it returns false.
+
+
+Install
+-------
+
+Install Easy HTTP Cache is very easy. It is stored in GitHub, so if you
+have never installed a gem via GitHub run the following:
+
+  gem sources -a http://gems.github.com
+
+Then install the gem:
+
+  sudo gem install josevalim-easy_http_cache
+
+In RAILS_ROOT/config/environment.rb:
+
+  config.gem "josevalim-easy_http_cache",  :lib => "easy_http_cache", :source => "http://gems.github.com"
+
+If you want it as plugin, just do:
+
+    cd myapp
+    git clone git://github.com/josevalim/easy_http_cache.git
+    rm -rf vendor/plugins/easy_http_cache/.git
+
+
+Previous versions
+-----------------
+
+If you are running on Rails 2.1.x, you should use v1.2.3:
+
+    cd myapp
+    git clone git://github.com/josevalim/easy_http_cache.git
+    cd vendor/plugins/easy_http_cache
+    git checkout v1.2.3
+    rm -rf ./.git
+
+If you are using a previous version, please updagrade your app. =)
+
+
+Variables
+---------
+
+You can set ENV['RAILS_CACHE_ID'] or ENV['RAILS_APP_VERSION'] to change
+the ETag that will be generated, expiring all previous caches. Those variables
+are also used by other cache stores (memcached, file, ...).
+
+
+Examples
+--------
+
+Just as above:
+
+  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 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:
+
+  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:
+
+  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 and it 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
+
+Finally, you can also pass an array at :last_modified as below:
+
+  class ListsController < ApplicationController
+    http_cache :index, :show,
+               :last_modified => [ :list, Time.utc(2007,12,27) ]
+  end
+
+This will check which one is the most recent to compare with the
+"Last-Modified" field sent by the client.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Generate documentation for Footnotes plugin.'
+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('lib/**/*.rb')
+end

data/init.rb

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

data/lib/easy_http_cache.rb

@@ -0,0 +1,140 @@
+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)
+          # We don't go ahead if we are rendering a component
+          #
+          return if component_request?(controller)
+
+          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.
+          #
+          # Finally, if :etag is not sent but RAILS_CACHE_ID or RAILS_APP_VERSION
+          # are set, we return an empty string allowing etag to be performed
+          # because those variables, when modified, are a valid way to expire
+          # all previous caches.
+          #
+          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)
+            elsif ENV['RAILS_CACHE_ID'] || ENV['RAILS_APP_VERSION']
+              ''
+            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
+
+          # We should not do http cache when we are using components
+          #
+          def component_request?(controller)
+            controller.instance_variable_get('@parent_controller')
+          end
+        end
+
+    end
+  end
+end
+
+ActionController::Base.__send__ :include, ActionController::Caching::HttpCache

data/test/easy_http_cache_test.rb

@@ -0,0 +1,239 @@
+# Those lines are plugin test settings
+ENV["RAILS_ENV"] = "test"
+require 'ostruct'
+require File.dirname(__FILE__) + '/../../../../config/environment'
+require File.dirname(__FILE__) + '/../lib/easy_http_cache.rb'
+require 'test_help'
+
+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 < Test::Unit::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.headers['Status']
+  end
+
+  def test_http_cache_without_input_with_env_variable
+    ENV['RAILS_APP_VERSION'] = '1.2.3'
+
+    get :index
+    assert_headers('200 OK', 'private, max-age=0, must-revalidate', 'Last-Modified', Time.utc(0).httpdate)
+    reset!
+
+    etag_http_cache(:index, '')
+  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
+
+  def test_should_not_cache_when_rendering_components
+    set_parent_controller! 
+    get :show
+    assert_headers('200 OK', 'no-cache')
+
+    set_parent_controller!
+    @request.env['HTTP_IF_MODIFIED_SINCE'] = 1.hour.ago.httpdate
+    get :show
+    assert_headers('200 OK', 'no-cache')
+
+    set_parent_controller!
+    @request.env['HTTP_IF_MODIFIED_SINCE'] = 3.hours.ago.httpdate
+    get :show
+    assert_headers('200 OK', 'no-cache')
+  end
+
+  private
+    def reset!
+      @request = ActionController::TestRequest.new
+      @response = ActionController::TestResponse.new
+      @controller = HttpCacheTestController.new
+    end
+
+    def set_parent_controller!
+      get :index
+      old_controller = @controller.dup
+      reset!
+
+      @controller.instance_variable_set('@parent_controller', old_controller)
+    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.headers['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: josevalim-easy_http_cache
+version: !ruby/object:Gem::Version 
+  version: "2.0"
+platform: ruby
+authors: 
+- "Jos\xC3\xA9 Valim"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-29 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Allows Rails applications to use HTTP cache specifications easily.
+email: jose.valim@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- init.rb
+- lib/easy_http_cache.rb
+- test/easy_http_cache_test.rb
+has_rdoc: true
+homepage: http://github.com/josevalim/easy_http_cache
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Allows Rails applications to use HTTP cache specifications easily.
+test_files: 
+- test/easy_http_cache_test.rb