lacquer 0.4.0 → 0.6.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e706da67a272b82cee6c8da31abe6c8d9e78358c
+  data.tar.gz: 60c69ff19d95e669f1f5201b0ae78a6e69480501
+SHA512:
+  metadata.gz: 1ca0ce46286b668c6617e8d1a619c56abc583ad649d4f321927e2247cf16b79c50e8be20fac4526afd5ca56d670ef0361b3832edc2d43d82e5c2b42eee08d4ca
+  data.tar.gz: f40f3deffabd878d515c46538c6012179c386c143b5b034767c873c652abc12e1751b0c15707818af0deec3d6ed1734a6f025af2eacce6d980a993f94de7a208

data/.gitignore

@@ -1,21 +1,5 @@
-## MAC OS
+*.gem
+.bundle
 .DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-doc
-.yardoc
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -1,8 +1,3 @@
-source :gemcutter
+source "http://rubygems.org"
 
-gem "activesupport", "3.0.1"
-gem "i18n", "0.4.1"
-gem "jeweler"
-gem "rake"
-gem "rspec", "2.0.0"
-gem "yard"
+gemspec

data/README.md

@@ -0,0 +1,260 @@
+![http://travis-ci.org/russ/lacquer](https://secure.travis-ci.org/russ/lacquer.png?branch=master)
+
+# Lacquer
+
+Rails drop in for [Varnish](https://www.varnish-cache.org/) support.
+
+## Install
+This gem requires ruby 1.9+
+
+```text
+gem install lacquer  
+rails generate lacquer:install
+```
+
+**config/initializers/lacquer.rb**
+
+```ruby
+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, :sidekiq
+  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.pass_command = "pass"
+end
+```
+
+**app/controllers/application_controller.rb**
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Lacquer::CacheUtils
+end
+```
+
+**config/varnishd.yml**
+```yaml
+development:
+  listen: localhost:3001
+  telnet: localhost:6082
+  sbin_path: /usr/local/sbin # path to varnishd
+  bin_path: /usr/local/bin   # path to varnishadm
+  storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
+
+test:
+  listen: localhost:3002
+  telnet: localhost:6083
+  sbin_path: /usr/local/sbin
+  bin_path: /usr/local/bin
+  storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
+
+production:
+  listen: :80
+  telnet: localhost:6082
+  sbin_path: /usr/local/sbin
+  bin_path: /usr/local/bin
+  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**
+```ruby
+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
+
+```ruby
+  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**
+
+```vcl
+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:
+
+```ruby
+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
+
+```text
+rake lacquer:varnishd:start
+rake lacquer:varnishd:stop
+rake lacquer:varnishd:restart
+rake lacquer:varnishd:reload
+rake lacquer:varnishd:status
+rake lacquer:varnishd:global_purge  
+```
+
+## Deployment
+Lacquer supports Capistrano 2.5+
+
+For Capistrano 2.5 just add `require 'lacquer/capistrano'` to your `config/deploy.rb` file.
+
+For Capistrano 3+ add `require 'lacquer/capistrano'` to your `Capfile`.
+
+```ruby
+# Capfile
+require 'capistrano/setup'
+require 'capistrano/deploy'
+require 'capistrano/rails/assets'
+require 'capistrano/rails/migrations'
+require 'lacquer/capistrano'
+```
+
+Adding this will give you the following cap tasks
+
+```text
+cap lacquer:global_purge           # global_purge varnish
+cap lacquer:restart                # restart varnish
+cap lacquer:start                  # start varnish
+cap lacquer:status                 # status varnish
+cap lacquer:stop                   # stop varnish
+```
+
+## 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) 2015 Russ Smith. See LICENSE for details.

data/Rakefile

@@ -1,37 +1,15 @@
-require "rubygems"
-require "bundler/setup"
-
-require "rake"
-require "yard"
-require "rspec"
-require "rspec/core/rake_task"
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "lacquer"
-    gem.summary = %Q{Rails drop in for Varnish support.}
-    gem.description = %Q{Rails drop in for Varnish support.}
-    gem.email = "russ@bashme.org"
-    gem.homepage = "http://github.com/russ/lacquer"
-    gem.authors = ["Russ Smith (russ@bashme.org)", "Ryan Johns", "Garry Tan (garry@posterous.com), Gabe da Silveira (gabe@websaviour.com)"]
-    gem.add_development_dependency "rspec", "~> 1.3.0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:normal) do |t|
+    t.pattern ='spec/**/*_spec.rb'
+    t.rcov = false
   end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-desc "Run all examples"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_path = "rspec"
-  t.rspec_opts = %w[--color]
-end
-
-YARD::Rake::YardocTask.new do |t|
-  t.files = [ "lib/**/*.rb" ]
-  t.options = [ "--no-private" ]
-end
+desc "RSpec tests"
+task "spec" => "spec:normal"
 
-task :default => [ :spec ]
+task "default" => "spec"

data/init.rb

@@ -1 +1 @@
-require File.join(File.dirname(__FILE__), 'lib', 'lacquer')
+require File.join(File.dirname(__FILE__), 'lib', 'lacquer')

data/lacquer.gemspec

@@ -1,74 +1,24 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "lacquer/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{lacquer}
-  s.version = "0.4.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Russ Smith (russ@bashme.org)", "Ryan Johns", "Garry Tan (garry@posterous.com), Gabe da Silveira (gabe@websaviour.com)"]
-  s.date = %q{2010-11-03}
-  s.description = %q{Rails drop in for Varnish support.}
-  s.email = %q{russ@bashme.org}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".bundle/config",
-     ".document",
-     ".gitignore",
-     "Gemfile",
-     "Gemfile.lock",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "init.rb",
-     "lacquer.gemspec",
-     "lib/generators/lacquer/USAGE",
-     "lib/generators/lacquer/install_generator.rb",
-     "lib/generators/lacquer/templates/initializer.rb",
-     "lib/generators/lacquer/templates/varnish.sample.vcl",
-     "lib/lacquer.rb",
-     "lib/lacquer/cache_utils.rb",
-     "lib/lacquer/configuration.rb",
-     "lib/lacquer/delayed_job_job.rb",
-     "lib/lacquer/resque_job.rb",
-     "lib/lacquer/varnish.rb",
-     "rails/init.rb",
-     "spec/lacquer/cache_utils_spec.rb",
-     "spec/lacquer/delayed_job_job_spec.rb",
-     "spec/lacquer/resque_job_spec.rb",
-     "spec/lacquer/varnish_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/russ/lacquer}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.name = "lacquer"
+  s.version = Lacquer::VERSION
+  s.authors = ["Russ Smith (russ@bashme.org)", "Ryan Johns", "Garry Tan (garry@posterous.com), Gabe da Silveira (gabe@websaviour.com)", "H\u{e5}kon Lerring"]
+  s.email = "russ@bashme.org"
+  s.homepage = "http://github.com/russ/lacquer"
+  s.summary = "Rails drop in for Varnish support."
+  s.description = "Rails drop in for Varnish support."
+  s.rubyforge_project = "lacquer"
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Rails drop in for Varnish support.}
-  s.test_files = [
-    "spec/lacquer/cache_utils_spec.rb",
-     "spec/lacquer/delayed_job_job_spec.rb",
-     "spec/lacquer/resque_job_spec.rb",
-     "spec/lacquer/varnish_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::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
-    else
-      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
-  end
+  s.add_dependency('activesupport', '>= 2.3.10')
+  s.add_dependency('i18n', '~> 0.4')
+  s.add_dependency('erubis')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '~> 2.5')
+  s.add_development_dependency('yard')
 end
-

data/lib/generators/lacquer/install_generator.rb

@@ -8,7 +8,11 @@ module Lacquer
       end
 
       def copy_vcl
-        copy_file("varnish.sample.vcl", "config/varnish.sample.vcl")
+        copy_file("varnish.vcl.erb", "config/varnish.vcl.erb")
+      end
+      
+      def copy_varnishd_config
+        copy_file("varnishd.yml", "config/varnishd.yml")
       end
     end
   end

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

@@ -5,17 +5,29 @@ Lacquer.configure do |config|
   # Unless overridden in a controller or action, the default will be used
   config.default_ttl = 1.week
 
-  # Can be :none, :delayed_job, :resque
+  # Can be :none, :delayed_job, :resque, :sidekiq
   config.job_backend = :none
 
   # Array of Varnish servers to manage
   config.varnish_servers << {
-    :host => "0.0.0.0", :port => 6082
+    :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) }
+  # 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.sample.vcl → varnish.vcl.erb}

@@ -1,6 +1,6 @@
 backend default {
-  .host = "0.0.0.0";
-  .port = "10000";
+  .host = "<%= backend.split(':').first %>";
+  .port = "<%= backend.split(':').last %>";
 }
 
 # Handling of requests that are received from clients.
@@ -14,19 +14,20 @@ sub vcl_recv {
       req.request != "TRACE" &&
       req.request != "OPTIONS" &&
       req.request != "DELETE") {
-    pipe;
+    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") {
-    pass;
-  }
-
-  # Pass requests that we know we aren't caching
-  if (req.url ~ "^/admin") {
-    pass;
+    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.
@@ -47,8 +48,7 @@ sub vcl_recv {
   # Clear cookie and authorization headers, set grace time, lookup in the cache
   unset req.http.Cookie;
   unset req.http.Authorization;
-  set req.grace = 30s;
-  lookup;
+  return(lookup);
 }
 
 # Called when entering pipe mode
@@ -57,34 +57,34 @@ sub vcl_pipe {
   # requests from the client will also be piped through and
   # left untouched by varnish. We don't want that.
   set req.http.connection = "close";
-  pipe;
+  return(pipe);
 }
 
 # Called when the requested object has been retrieved from the
 # backend, or the request to the backend has failed
 sub vcl_fetch {
-  # Do not cache the object if the backend application does not want us to.
-  if (obj.http.Cache-Control ~ "(no-cache|no-store|private|must-revalidate)") {
-    pass;
-  }
-
+  # Set the grace time
+  set beresp.grace = 1h;
+  
   # Do not cache the object if the status is not in the 200s
-  if (obj.status >= 300) {
+  if (beresp.status >= 300) {
     # Remove the Set-Cookie header
-    remove obj.http.Set-Cookie;
-    pass;
+    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 obj.http.Set-Cookie;
-
-  # Set the grace time
-  set obj.grace = 30s;
+  remove beresp.http.Set-Cookie;
 
   # Deliver the object
-  deliver;
+  return(deliver);
 }
 
 # Called before the response is sent back to the client

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

@@ -0,0 +1,31 @@
+development:
+  listen: 127.0.0.1:3001
+  telnet: 127.0.0.1:6082
+  backend: 127.0.0.1:3000
+  sbin_path: /usr/local/sbin
+  bin_path: /usr/local/bin
+  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
+  bin_path: /usr/local/bin
+  storage: "file,#{Rails.root}/log/varnishd.#{Rails.env}.cache,100MB"
+
+production:
+  listen: :80
+  telnet: localhost:6082
+  backend: backend_server:8080
+  use_sudo: false
+  sbin_path: /usr/local/sbin
+  bin_path: /usr/local/bin
+  pid_path: <%= Rails.root.join('log') %>
+  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