lacquer 0.5.4 → 0.5.5

data/.gitignore

@@ -1,4 +1,5 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
+*.gem
+.bundle
+.DS_Store
+Gemfile.lock
+pkg/*

data/README.rdoc

@@ -1,202 +1,214 @@
-= lacquer
-
-Rails drop in for Varnish support.
-
-== Install
-This gem requires ruby 1.9
-
-Basic installation
-
-  sudo gem install lacquer  
-  rails generate lacquer:install
-
-config/initializers/lacquer.rb
-
-  Lacquer.configure do |config|
-    # Globally enable/disable cache
-    config.enable_cache = true
-
-    # Unless overridden in a controller or action, the default will be used
-    config.default_ttl = 1.week
-
-    # Can be :none, :delayed_job, :resque
-    config.job_backend = :none
-
-    # Array of Varnish servers to manage
-    config.varnish_servers << {
-      :host => "0.0.0.0", :port => 6082 # if you have authentication enabled, add :secret => "your secret"
-    }
-
-    # Number of retries
-    config.retries = 5
-
-    # config handler (optional, if you use Hoptoad or another error tracking service)
-    config.command_error_handler = lambda { |s| HoptoadNotifier.notify(s) }
-  end
-
-app/controllers/application_controller.rb
-
-  class ApplicationController < ActionController::Base
-    include Lacquer::CacheUtils
-  end
-  
-config/varnishd.yml
-
-  development:
-    listen: localhost:3001
-    telnet: localhost:6082
-    sbin_path: /usr/local/sbin
-    storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
-    
-  test:
-    listen: localhost:3002
-    telnet: localhost:6083
-    sbin_path: /usr/local/sbin
-    storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
-
-  production:
-    listen: :80
-    telnet: localhost:6082
-    sbin_path: /usr/local/sbin
-    storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
-    params:
-      overflow_max: 2000
-      thread_pool_add_delay: 2
-      thread_pools: 4             # <Number of cpu cores>
-      thread_pool_min: 200        # <800/number of cpu cores>
-      thread_pool_max: 4000
-
-If only some urls of the application should be cached by varnish, Lacquer::CacheControl will be helpful.
-
-config/initializers/caches.rb
-
-  require "lacquer/cache_control"
-
-  Lacquer.cache_control.configure do |config|
-    config.register :static,              :url => "^/images",                                           
-                                          :expires_in => "365d"
-                                        
-    config.register :static,              :url => "^/stylesheets",
-                                          :expires_in => "365d"
-                                        
-    config.register :static,              :url => "^/javascripts",                                       
-                                          :expires_in => "365d"
-  
-    config.register :class_section,       :url => "^(/[a-z]{2})?/(info_screens|class_sections)/%s.*$",   
-                                          :args => "[0-9]+", 
-                                          :expires_in => "1m"
-                                        
-    config.register :open_scoring,        :url => "^(/[a-z]{2})?/class_sections/%s/open_scoring.*$",
-                                          :args => "[0-9]+",
-                                          :expires_in => "1m"
-                                        
-  end
-
-In the sweeper we can do something like this
-
-  class_section = ClassSection.find(1)
-  Lacquer.cache_control.purge(:open_scoring, class_section) 
-  
-This will purge "^(/[a-z]{2})?/class_sections/1/open_scoring.*$" (/sv/class_sections/1/open_scoring.js, /sv/class_sections/1/open_scoring.html)
-  
-The varnish.vcl is preprocssed when starting varnishd with the rake tasks
-
-  rake varnishd:start
-  
-config/varnish.vcl.erb
-
-  sub vcl_recv {
-    # Lookup requests that we know should be cached
-    if (<%= Lacquer.cache_control.to_vcl_conditions %>) {    
-      # Clear cookie and authorization headers, set grace time, lookup in the cache
-      unset req.http.Cookie;
-      unset req.http.Authorization;
-      return(lookup);
-    }
-    
-    # Generates
-    #
-    # if(req.url ~ "^/images" || 
-    #    req.url ~ "^/stylesheets" || 
-    #    req.url ~ "^/javascripts" || 
-    #    req.url ~ "^(/[a-z]{2})?/(info_screens|class_sections)/[0-9]+.*$" || 
-    #    req.url ~ "^(/[a-z]{2})?/class_sections/[0-9]+/open_scoring.*$") {
-    #    unset req.http.Cookie;
-    #    unset req.http.Authorization;
-    #    return(lookup);         
-    # }
-  }
-
-  sub vcl_fetch {
-    <%= Lacquer.cache_control.to_vcl_override_ttl_urls %>
-    
-    # Generates
-    #
-    # if(req.url ~ "^/images" || req.url ~ "^/stylesheets" || req.url ~ "^/javascripts") {
-    #   unset beresp.http.Set-Cookie;
-    #   set beresp.ttl = 365d;
-    #   return(deliver);
-    # }
-    #
-    # if(req.url ~ "^(/[a-z]{2})?/(info_screens|class_sections)/[0-9]+.*$" || 
-    #   req.url ~ "^(/[a-z]{2})?/class_sections/[0-9]+/open_scoring.*$") {
-    #   unset beresp.http.Set-Cookie;
-    #   set beresp.ttl = 1m;
-    #   return(deliver);
-    # }
-  }
- 
-This makes it much simpler to perform cacheing, it's only setuped in one place, purge it or just let it expire.
-  
-== Usage
-
-To set a custom ttl for a controller:
-
-  before_filter { |controller| controller.set_cache_ttl(15.minutes) }
-
-Clearing the cache:
-
-  class Posts < ApplicationController
-    after_filter :clear_cache, :only => [ :create, :update, :destroy ]
-
-  private
-
-    def clear_cache
-      clear_cache_for(
-        root_path,
-        posts_path,
-        post_path(@post))
-    end
-  end
-  
-Control varnishd with the following rake tasks
-
-  rake varnishd:start
-  rake varnishd:stop
-  rake varnishd:restart
-  rake varnishd:status
-  rake varnishd:global_purge  
-
-== Gotchas
-
-The default TTL for most actions is set to 0, since for most cases you'll probably want to be fairly explicit about what pages do get cached by varnish. The default cache header is typically:
-
-  Cache-Control: max-age=0, no-cache, private
-
-This is good for normal controller actions, since you won't want to cache them. If TTL for an action is set to 0, it won't mess with the default header.
-
-The key gotcha here is that cached pages strip cookies, so if your application relies on sessions and uses authenticity tokens, the user will need a session cookie set before form actions will work. Setting default TTL to 0 here will make sure these session cookies won't break.
-
-As a result, all you have to do to set a cacheable action is the before filter above.
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Russ Smith. See LICENSE for details.
+= lacquer
+
+Rails drop in for Varnish support.
+
+== Install
+This gem requires ruby 1.9
+
+Basic installation
+
+  sudo gem install lacquer  
+  rails generate lacquer:install
+
+config/initializers/lacquer.rb
+
+  Lacquer.configure do |config|
+    # Globally enable/disable cache
+    config.enable_cache = true
+
+    # Unless overridden in a controller or action, the default will be used
+    config.default_ttl = 1.week
+
+    # Can be :none, :delayed_job, :resque
+    config.job_backend = :none
+
+    # Array of Varnish servers to manage
+    config.varnish_servers << {
+      :host => "0.0.0.0", :port => 6082 # if you have authentication enabled, add :secret => "your secret"
+    }
+
+    # Number of retries
+    config.retries = 5
+
+    # config handler (optional, if you use Hoptoad or another error tracking service)
+    config.command_error_handler = lambda { |s| HoptoadNotifier.notify(s) }
+    
+    
+    ### Varnish - 2.x  /  3.x  .. VCL-Changes
+    ### https://www.varnish-cache.org/docs/trunk/installation/upgrade.html
+    
+    # => Purge Command  ( "url.purge" for Varnish 2.x .. "ban.url" for Varnish 3.x )
+    # => purges are now called bans in Varnish 3.x .. purge() and purge_url() are now respectively ban() and ban_url()
+    config.purge_command = "ban.url"
+    
+    # => VCL_Fetch Pass Command  ( "pass" for Varnish 2.x .. "hit_for_pass" for Varnish 3.x )
+    # => pass in vcl_fetch renamed to hit_for_pass in Varnish 3.x   
+    config.vcl_pass_command = "pass"
+  end
+
+app/controllers/application_controller.rb
+
+  class ApplicationController < ActionController::Base
+    include Lacquer::CacheUtils
+  end
+  
+config/varnishd.yml
+
+  development:
+    listen: localhost:3001
+    telnet: localhost:6082
+    sbin_path: /usr/local/sbin
+    storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
+    
+  test:
+    listen: localhost:3002
+    telnet: localhost:6083
+    sbin_path: /usr/local/sbin
+    storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
+
+  production:
+    listen: :80
+    telnet: localhost:6082
+    sbin_path: /usr/local/sbin
+    storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
+    params:
+      overflow_max: 2000          # for Varnish 2.x ... use "queue_max: 2000" for Varnish 3.x
+      thread_pool_add_delay: 2
+      thread_pools: 4             # <Number of cpu cores>
+      thread_pool_min: 200        # <800/number of cpu cores>
+      thread_pool_max: 4000
+
+If only some urls of the application should be cached by varnish, Lacquer::CacheControl will be helpful.
+
+config/initializers/caches.rb
+
+  require "lacquer/cache_control"
+
+  Lacquer.cache_control.configure do |config|
+    config.register :static,              :url => "^/images",                                           
+                                          :expires_in => "365d"
+                                        
+    config.register :static,              :url => "^/stylesheets",
+                                          :expires_in => "365d"
+                                        
+    config.register :static,              :url => "^/javascripts",                                       
+                                          :expires_in => "365d"
+  
+    config.register :class_section,       :url => "^(/[a-z]{2})?/(info_screens|class_sections)/%s.*$",   
+                                          :args => "[0-9]+", 
+                                          :expires_in => "1m"
+                                        
+    config.register :open_scoring,        :url => "^(/[a-z]{2})?/class_sections/%s/open_scoring.*$",
+                                          :args => "[0-9]+",
+                                          :expires_in => "1m"
+                                        
+  end
+
+In the sweeper we can do something like this
+
+  class_section = ClassSection.find(1)
+  Lacquer.cache_control.purge(:open_scoring, class_section) 
+  
+This will purge "^(/[a-z]{2})?/class_sections/1/open_scoring.*$" (/sv/class_sections/1/open_scoring.js, /sv/class_sections/1/open_scoring.html)
+  
+The varnish.vcl is preprocssed when starting varnishd with the rake tasks
+
+  rake lacquer:varnishd:start
+  
+config/varnish.vcl.erb
+
+  sub vcl_recv {
+    # Lookup requests that we know should be cached
+    if (<%= Lacquer.cache_control.to_vcl_conditions %>) {    
+      # Clear cookie and authorization headers, set grace time, lookup in the cache
+      unset req.http.Cookie;
+      unset req.http.Authorization;
+      return(lookup);
+    }
+    
+    # Generates
+    #
+    # if(req.url ~ "^/images" || 
+    #    req.url ~ "^/stylesheets" || 
+    #    req.url ~ "^/javascripts" || 
+    #    req.url ~ "^(/[a-z]{2})?/(info_screens|class_sections)/[0-9]+.*$" || 
+    #    req.url ~ "^(/[a-z]{2})?/class_sections/[0-9]+/open_scoring.*$") {
+    #    unset req.http.Cookie;
+    #    unset req.http.Authorization;
+    #    return(lookup);         
+    # }
+  }
+
+  sub vcl_fetch {
+    <%= Lacquer.cache_control.to_vcl_override_ttl_urls %>
+    
+    # Generates
+    #
+    # if(req.url ~ "^/images" || req.url ~ "^/stylesheets" || req.url ~ "^/javascripts") {
+    #   unset beresp.http.Set-Cookie;
+    #   set beresp.ttl = 365d;
+    #   return(deliver);
+    # }
+    #
+    # if(req.url ~ "^(/[a-z]{2})?/(info_screens|class_sections)/[0-9]+.*$" || 
+    #   req.url ~ "^(/[a-z]{2})?/class_sections/[0-9]+/open_scoring.*$") {
+    #   unset beresp.http.Set-Cookie;
+    #   set beresp.ttl = 1m;
+    #   return(deliver);
+    # }
+  }
+ 
+This makes it much simpler to perform cacheing, it's only setuped in one place, purge it or just let it expire.
+  
+== Usage
+
+To set a custom ttl for a controller:
+
+  before_filter { |controller| controller.set_cache_ttl(15.minutes) }
+
+Clearing the cache:
+
+  class Posts < ApplicationController
+    after_filter :clear_cache, :only => [ :create, :update, :destroy ]
+
+  private
+
+    def clear_cache
+      clear_cache_for(
+        root_path,
+        posts_path,
+        post_path(@post))
+    end
+  end
+  
+Control varnishd with the following rake tasks
+
+  rake lacquer:varnishd:start
+  rake lacquer:varnishd:stop
+  rake lacquer:varnishd:restart
+  rake lacquer:varnishd:status
+  rake lacquer:varnishd:global_purge  
+
+== Gotchas
+
+The default TTL for most actions is set to 0, since for most cases you'll probably want to be fairly explicit about what pages do get cached by varnish. The default cache header is typically:
+
+  Cache-Control: max-age=0, no-cache, private
+
+This is good for normal controller actions, since you won't want to cache them. If TTL for an action is set to 0, it won't mess with the default header.
+
+The key gotcha here is that cached pages strip cookies, so if your application relies on sessions and uses authenticity tokens, the user will need a session cookie set before form actions will work. Setting default TTL to 0 here will make sure these session cookies won't break.
+
+As a result, all you have to do to set a cacheable action is the before filter above.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Russ Smith. See LICENSE for details.

data/lib/generators/lacquer/templates/initializer.rb

@@ -1,21 +1,33 @@
-Lacquer.configure do |config|
-  # Globally enable/disable cache
-  config.enable_cache = true
-
-  # Unless overridden in a controller or action, the default will be used
-  config.default_ttl = 1.week
-
-  # Can be :none, :delayed_job, :resque
-  config.job_backend = :none
-
-  # Array of Varnish servers to manage
-  config.varnish_servers << {
-    :host => "0.0.0.0", :port => 6082 # if you have authentication enabled, add :secret => "your secret"
-  }
-
-  # Number of retries
-  config.retries = 5
-
-  # Config handler (optional, if you use Hoptoad or another error tracking service)
-  config.command_error_handler = lambda { |s| HoptoadNotifier.notify(s) }
-end
+Lacquer.configure do |config|
+  # Globally enable/disable cache
+  config.enable_cache = true
+
+  # Unless overridden in a controller or action, the default will be used
+  config.default_ttl = 1.week
+
+  # Can be :none, :delayed_job, :resque
+  config.job_backend = :none
+
+  # Array of Varnish servers to manage
+  config.varnish_servers << {
+    :host => "0.0.0.0", :port => 6082 # if you have authentication enabled, add :secret => "your secret"
+  }
+
+  # Number of retries
+  config.retries = 5
+
+  # Config handler (optional, if you use Hoptoad or another error tracking service)
+  # config.command_error_handler = lambda { |s| HoptoadNotifier.notify(s) }
+
+
+  ### Varnish - 2.x  /  3.x  .. VCL-Changes
+  ### https://www.varnish-cache.org/docs/trunk/installation/upgrade.html
+
+  # => Purge Command  ( "url.purge" for Varnish 2.x .. "ban.url" for Varnish 3.x )
+  # => purges are now called bans in Varnish 3.x .. purge() and purge_url() are now respectively ban() and ban_url()
+  config.purge_command = "url.purge"
+
+  # => VCL_Fetch Pass Command  ( "pass" for Varnish 2.x .. "hit_for_pass" for Varnish 3.x )
+  # => pass in vcl_fetch renamed to hit_for_pass in Varnish 3.x   
+  config.pass_command = "pass"
+end

data/lib/generators/lacquer/templates/varnish.vcl.erb

@@ -1,102 +1,102 @@
-backend default {
-  .host = "<%= backend.split(':').first %>";
-  .port = "<%= backend.split(':').last %>";
-}
-
-# Handling of requests that are received from clients.
-# First decide whether or not to lookup data in the cache.
-sub vcl_recv {
-  # Pipe requests that are non-RFC2616 or CONNECT which is weird.
-  if (req.request != "GET" &&
-      req.request != "HEAD" &&
-      req.request != "PUT" &&
-      req.request != "POST" &&
-      req.request != "TRACE" &&
-      req.request != "OPTIONS" &&
-      req.request != "DELETE") {
-    return(pipe);
-  }
-  
-  if (req.backend.healthy) {
-     set req.grace = 30s;
-  } else {
-     set req.grace = 1h;
-  }  
-  
-  # Pass requests that are not GET or HEAD
-  if (req.request != "GET" && req.request != "HEAD") {
-    return(pass);
-  }
-  
-  # Handle compression correctly. Varnish treats headers literally, not
-  # semantically. So it is very well possible that there are cache misses
-  # because the headers sent by different browsers aren't the same.
-  # @see: http://varnish.projects.linpro.no/wiki/FAQ/Compression
-  if (req.http.Accept-Encoding) {
-    if (req.http.Accept-Encoding ~ "gzip") {
-      # if the browser supports it, we'll use gzip
-      set req.http.Accept-Encoding = "gzip";
-    } elsif (req.http.Accept-Encoding ~ "deflate") {
-      # next, try deflate if it is supported
-      set req.http.Accept-Encoding = "deflate";
-    } else {
-      # unknown algorithm. Probably junk, remove it
-      remove req.http.Accept-Encoding;
-    }
-  }
-
-  # Clear cookie and authorization headers, set grace time, lookup in the cache
-  unset req.http.Cookie;
-  unset req.http.Authorization;
-  return(lookup);
-}
-
-# Called when entering pipe mode
-sub vcl_pipe {
-  # If we don't set the Connection: close header, any following
-  # requests from the client will also be piped through and
-  # left untouched by varnish. We don't want that.
-  set req.http.connection = "close";
-  return(pipe);
-}
-
-# Called when the requested object has been retrieved from the
-# backend, or the request to the backend has failed
-sub vcl_fetch {
-  # Set the grace time
-  set beresp.grace = 1h;
-  
-  # Do not cache the object if the status is not in the 200s
-  if (beresp.status >= 300) {
-    # Remove the Set-Cookie header
-    remove beresp.http.Set-Cookie;
-    return(pass);
-  }
-  
-  # Do not cache the object if the backend application does not want us to.
-  if (beresp.http.Cache-Control ~ "(no-cache|no-store|private|must-revalidate)") {
-    return(pass);
-  }
-
-  # Everything below here should be cached
-
-  # Remove the Set-Cookie header
-  remove beresp.http.Set-Cookie;
-
-  # Deliver the object
-  return(deliver);
-}
-
-# Called before the response is sent back to the client
-sub vcl_deliver {
-  # Force browsers and intermediary caches to always check back with us
-  set resp.http.Cache-Control = "private, max-age=0, must-revalidate";
-  set resp.http.Pragma = "no-cache";
-
-  # Add a header to indicate a cache HIT/MISS
-  if (obj.hits > 0) {
-    set resp.http.X-Cache = "HIT";
-  } else {
-    set resp.http.X-Cache = "MISS";
-  }
-}
+backend default {
+  .host = "<%= backend.split(':').first %>";
+  .port = "<%= backend.split(':').last %>";
+}
+
+# Handling of requests that are received from clients.
+# First decide whether or not to lookup data in the cache.
+sub vcl_recv {
+  # Pipe requests that are non-RFC2616 or CONNECT which is weird.
+  if (req.request != "GET" &&
+      req.request != "HEAD" &&
+      req.request != "PUT" &&
+      req.request != "POST" &&
+      req.request != "TRACE" &&
+      req.request != "OPTIONS" &&
+      req.request != "DELETE") {
+    return(pipe);
+  }
+  
+  if (req.backend.healthy) {
+     set req.grace = 30s;
+  } else {
+     set req.grace = 1h;
+  }  
+  
+  # Pass requests that are not GET or HEAD
+  if (req.request != "GET" && req.request != "HEAD") {
+    return(pass);
+  }
+  
+  # Handle compression correctly. Varnish treats headers literally, not
+  # semantically. So it is very well possible that there are cache misses
+  # because the headers sent by different browsers aren't the same.
+  # @see: http://varnish.projects.linpro.no/wiki/FAQ/Compression
+  if (req.http.Accept-Encoding) {
+    if (req.http.Accept-Encoding ~ "gzip") {
+      # if the browser supports it, we'll use gzip
+      set req.http.Accept-Encoding = "gzip";
+    } elsif (req.http.Accept-Encoding ~ "deflate") {
+      # next, try deflate if it is supported
+      set req.http.Accept-Encoding = "deflate";
+    } else {
+      # unknown algorithm. Probably junk, remove it
+      remove req.http.Accept-Encoding;
+    }
+  }
+
+  # Clear cookie and authorization headers, set grace time, lookup in the cache
+  unset req.http.Cookie;
+  unset req.http.Authorization;
+  return(lookup);
+}
+
+# Called when entering pipe mode
+sub vcl_pipe {
+  # If we don't set the Connection: close header, any following
+  # requests from the client will also be piped through and
+  # left untouched by varnish. We don't want that.
+  set req.http.connection = "close";
+  return(pipe);
+}
+
+# Called when the requested object has been retrieved from the
+# backend, or the request to the backend has failed
+sub vcl_fetch {
+  # Set the grace time
+  set beresp.grace = 1h;
+  
+  # Do not cache the object if the status is not in the 200s
+  if (beresp.status >= 300) {
+    # Remove the Set-Cookie header
+    remove beresp.http.Set-Cookie;
+    return(<%= Lacquer.configuration.pass_command %>);
+  }
+  
+  # Do not cache the object if the backend application does not want us to.
+  if (beresp.http.Cache-Control ~ "(no-cache|no-store|private|must-revalidate)") {
+    return(<%= Lacquer.configuration.pass_command %>);
+  }
+
+  # Everything below here should be cached
+
+  # Remove the Set-Cookie header
+  remove beresp.http.Set-Cookie;
+
+  # Deliver the object
+  return(deliver);
+}
+
+# Called before the response is sent back to the client
+sub vcl_deliver {
+  # Force browsers and intermediary caches to always check back with us
+  set resp.http.Cache-Control = "private, max-age=0, must-revalidate";
+  set resp.http.Pragma = "no-cache";
+
+  # Add a header to indicate a cache HIT/MISS
+  if (obj.hits > 0) {
+    set resp.http.X-Cache = "HIT";
+  } else {
+    set resp.http.X-Cache = "MISS";
+  }
+}

data/lib/generators/lacquer/templates/varnishd.yml

@@ -1,26 +1,26 @@
-development:
-  listen: 127.0.0.1:3001
-  telnet: 127.0.0.1:6082
-  backend: 127.0.0.1:3000
-  sbin_path: /usr/local/sbin
-  storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
-    
-test:
-  listen: 127.0.0.1:3002
-  telnet: 127.0.0.1:6083
-  backend: 127.0.0.1:3000
-  sbin_path: /usr/local/sbin
-  storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
-
-production:
-  listen: :80
-  telnet: localhost:6082
-  backend: backend_server:8080
-  sbin_path: /usr/local/sbin
-  storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
-  params:
-    overflow_max: 2000
-    thread_pool_add_delay: 2
-    thread_pools: 4             # <Number of cpu cores>
-    thread_pool_min: 200        # <800/number of cpu cores>
-    thread_pool_max: 4000
+development:
+  listen: 127.0.0.1:3001
+  telnet: 127.0.0.1:6082
+  backend: 127.0.0.1:3000
+  sbin_path: /usr/local/sbin
+  storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
+    
+test:
+  listen: 127.0.0.1:3002
+  telnet: 127.0.0.1:6083
+  backend: 127.0.0.1:3000
+  sbin_path: /usr/local/sbin
+  storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
+
+production:
+  listen: :80
+  telnet: localhost:6082
+  backend: backend_server:8080
+  sbin_path: /usr/local/sbin
+  storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
+  params:
+    overflow_max: 2000          # for Varnish 2.x ... use "queue_max: 2000" for Varnish 3.x
+    thread_pool_add_delay: 2
+    thread_pools: 4             # <Number of cpu cores>
+    thread_pool_min: 200        # <800/number of cpu cores>
+    thread_pool_max: 4000

data/lib/lacquer/capistrano.rb

@@ -11,6 +11,7 @@ Capistrano::Configuration.instance(:must_exit).load do
 
   namespace :lacquer do
     %w( start stop restart global_purge status ).each do |name|
+      desc "#{name} varnish"
       task name.to_sym, :roles => lacquer_roles do
         next if find_servers_for_task(current_task).empty?
         run "cd #{current_path} && #{rake} lacquer:varnishd:#{name}"

data/lib/lacquer/configuration.rb

@@ -1,43 +1,47 @@
-module Lacquer
-  class Configuration
-    OPTIONS = []
-
-    # Enable cache
-    attr_accessor :enable_cache
-
-    # Varnish servers
-    attr_accessor :varnish_servers
-
-    # Application default ttl
-    attr_accessor :default_ttl
-
-    # Number of retries before failing
-    attr_accessor :retries
-
-    # Job backend
-    attr_accessor :job_backend
-
-    # Error handler
-    attr_accessor :command_error_handler
-
-    # Purge Command
-    attr_accessor :purge_command
-
-    def initialize
-      @enable_cache = true
-      @varnish_servers = []
-      @default_ttl = 0
-      @job_backend = :none
-      @retries = 5
-      @command_error_handler = nil
-      @purge_command = "url.purge"
-    end
-
-    # Returns a hash of all configurable options
-    def to_hash
-      OPTIONS.inject({}) do |hash, option|
-        hash.merge(option.to_sym => send(option))
-      end
-    end
-  end
-end
+module Lacquer
+  class Configuration
+    OPTIONS = []
+
+    # Enable cache
+    attr_accessor :enable_cache
+
+    # Varnish servers
+    attr_accessor :varnish_servers
+
+    # Application default ttl
+    attr_accessor :default_ttl
+
+    # Number of retries before failing
+    attr_accessor :retries
+
+    # Job backend
+    attr_accessor :job_backend
+
+    # Error handler
+    attr_accessor :command_error_handler
+
+    # Purge Command
+    attr_accessor :purge_command
+    
+    # Pass Command (in vcl_fetch)
+    attr_accessor :pass_command
+
+    def initialize
+      @enable_cache = true
+      @varnish_servers = []
+      @default_ttl = 0
+      @job_backend = :none
+      @retries = 5
+      @command_error_handler = nil
+      @purge_command = "url.purge"
+      @pass_command = "pass"
+    end
+
+    # Returns a hash of all configurable options
+    def to_hash
+      OPTIONS.inject({}) do |hash, option|
+        hash.merge(option.to_sym => send(option))
+      end
+    end
+  end
+end

data/lib/lacquer/version.rb

@@ -1,3 +1,3 @@
 module Lacquer
-  VERSION = '0.5.4'
+  VERSION = '0.5.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lacquer
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-05 00:00:00.000000000 Z
+date: 2012-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70160322129900 !ruby/object:Gem::Requirement
+  requirement: &70107447903980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 2.3.10
   type: :runtime
   prerelease: false
-  version_requirements: *70160322129900
+  version_requirements: *70107447903980
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70160322128420 !ruby/object:Gem::Requirement
+  requirement: &70107447914580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -35,10 +35,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70160322128420
+  version_requirements: *70107447914580
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &70160322127780 !ruby/object:Gem::Requirement
+  requirement: &70107447924320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +46,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70160322127780
+  version_requirements: *70107447924320
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70160322125760 !ruby/object:Gem::Requirement
+  requirement: &70107447921200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +57,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160322125760
+  version_requirements: *70107447921200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70160322124620 !ruby/object:Gem::Requirement
+  requirement: &70107447934240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +68,10 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *70160322124620
+  version_requirements: *70107447934240
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70160322123360 !ruby/object:Gem::Requirement
+  requirement: &70107447929060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,7 +79,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160322123360
+  version_requirements: *70107447929060
 description: Rails drop in for Varnish support.
 email: russ@bashme.org
 executables: []
@@ -138,18 +138,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1420781862807341168
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1420781862807341168
 requirements: []
 rubyforge_project: lacquer
 rubygems_version: 1.8.10