hakon-lacquer 0.4.1

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem "activesupport", "~> 3.0"
+gem "i18n", "~> 0.4"
+gem "jeweler"
+gem "rake"
+gem "yard"
+
+group :development do
+    gem "rspec", "~> 2.0"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.0)
+  i18n (~> 0.4)
+  jeweler
+  rake
+  rspec (~> 2.0)
+  yard

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Russ Smith
+
+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,83 @@
+= lacquer
+
+Rails drop in for Varnish support.
+
+== Install
+Basic installation
+
+  sudo gem install lacquer
+
+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
+
+== 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
+
+== 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/Rakefile

@@ -0,0 +1,36 @@
+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 = "hakon-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)", "Håkon Lerring"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  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
+
+task :default => [ :spec ]

data/VERSION

@@ -0,0 +1 @@
+0.4.1

data/init.rb

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

data/lacquer.gemspec

@@ -0,0 +1,87 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{lacquer}
+  s.version = "0.4.1"
+
+  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)", "H\303\245kon Lerring"]
+  s.date = %q{2010-12-28}
+  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",
+    "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.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_runtime_dependency(%q<activesupport>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<i18n>, ["~> 0.4"])
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 3.0"])
+      s.add_dependency(%q<i18n>, ["~> 0.4"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 3.0"])
+    s.add_dependency(%q<i18n>, ["~> 0.4"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.0"])
+  end
+end
+

data/lib/generators/lacquer/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Installs Lacquer into your Rails application.
+
+  Provides a sample varnish vcl and a Lacquer 
+  initializer to get you started.
+
+Example:
+  rails generate lacquer:install

data/lib/generators/lacquer/install_generator.rb

@@ -0,0 +1,15 @@
+module Lacquer
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), "templates"))
+
+      def copy_initializer
+        copy_file("initializer.rb", "config/initializers/lacquer.rb")
+      end
+
+      def copy_vcl
+        copy_file("varnish.sample.vcl", "config/varnish.sample.vcl")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+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

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

@@ -0,0 +1,102 @@
+backend default {
+  .host = "0.0.0.0";
+  .port = "10000";
+}
+
+# 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") {
+    pipe;
+  }
+
+  # 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;
+  }
+
+  # 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;
+  set req.grace = 30s;
+  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";
+  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;
+  }
+
+  # Do not cache the object if the status is not in the 200s
+  if (obj.status >= 300) {
+    # Remove the Set-Cookie header
+    remove obj.http.Set-Cookie;
+    pass;
+  }
+
+  # Everything below here should be cached
+
+  # Remove the Set-Cookie header
+  remove obj.http.Set-Cookie;
+
+  # Set the grace time
+  set obj.grace = 30s;
+
+  # Deliver the object
+  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/lacquer.rb

@@ -0,0 +1,30 @@
+require "rubygems"
+require "net/telnet"
+
+require "openssl"
+require "digest/sha2"
+
+require "active_support/core_ext"
+
+require "lacquer/configuration"
+require "lacquer/cache_utils"
+require "lacquer/varnish"
+
+module Lacquer
+  class VarnishError < Exception; end # @private
+  class AuthenticationError < VarnishError; end # @private
+
+  class << self
+    attr_accessor :configuration
+
+    # Call this method to modify defaults in your initailizers.
+    #
+    #   Lacquer.configure do |config|
+    #     config.varnish_servers << { :host => '0.0.0.0', :port => 6082, :timeout => 5 }
+    #   end
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end

data/lib/lacquer/cache_utils.rb

@@ -0,0 +1,52 @@
+module Lacquer
+  module CacheUtils
+    def self.included(base)
+      base.class_eval do
+        attr_reader :cache_ttl
+
+        if respond_to? :before_filter
+          before_filter :set_default_cache_ttl
+          after_filter :send_cache_control_headers
+        end
+      end
+    end
+
+    # Instance variable for the action ttl.
+    def set_cache_ttl(ttl)
+      @cache_ttl = ttl
+    end
+
+    # Called as a before filter to set default ttl
+    # for the entire application.
+    def set_default_cache_ttl
+      set_cache_ttl(Lacquer.configuration.default_ttl)
+    end
+
+    # Sends url.purge command to varnish to clear cache.
+    #
+    # clear_cache_for(root_path, blog_posts_path, '/other/content/*')
+    def clear_cache_for(*paths)
+      paths.each do |path|
+        case Lacquer.configuration.job_backend
+        when :delayed_job
+          require 'lacquer/delayed_job_job'
+          Delayed::Job.enqueue(Lacquer::DelayedJobJob.new(path))
+        when :resque
+          require 'lacquer/resque_job'
+          Resque.enqueue(Lacquer::ResqueJob, path)
+        when :none
+          Varnish.new.purge(path)
+        end
+      end
+    end
+    
+    # Sends cache control headers with page.
+    # These are the headers that varnish responds to
+    # to set cache properly.
+    def send_cache_control_headers
+      if Lacquer.configuration.enable_cache && @cache_ttl && @cache_ttl != 0
+        expires_in(@cache_ttl, :public => true)
+      end
+    end
+  end
+end

data/lib/lacquer/configuration.rb

@@ -0,0 +1,39 @@
+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
+
+    def initialize
+      @enable_cache = true
+      @varnish_servers = []
+      @default_ttl = 0
+      @job_backend = :none
+      @retries = 5
+      @command_error_handler = nil
+    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/delayed_job_job.rb

@@ -0,0 +1,7 @@
+module Lacquer
+  class DelayedJobJob < Struct.new(:url)
+    def perform
+      Varnish.new.purge(url)
+    end
+  end
+end

data/lib/lacquer/resque_job.rb

@@ -0,0 +1,9 @@
+module Lacquer
+  class ResqueJob
+    @queue = :lacquer
+
+    def self.perform(url)
+      Varnish.new.purge(url)
+    end
+  end
+end

data/lib/lacquer/varnish.rb

@@ -0,0 +1,78 @@
+module Lacquer
+  class Varnish
+    def stats
+      send_command('stats').collect do |stats|
+        stats = stats.split("\n")
+        stats.shift
+        stats = stats.collect do |stat|
+          stat = stat.strip.match(/(\d+)\s+(.+)$/)
+          { :key => stat[2], :value => stat[1] } if stat
+        end
+      end
+    end
+
+    # Sends the command 'url.purge *path*'
+    def purge(path)
+      send_command('url.purge ' << path).all? do |result|
+        result =~ /200/
+      end
+    end
+
+    # Sends commands over telnet to varnish servers listed in the config.
+    def send_command(command)
+      Lacquer.configuration.varnish_servers.collect do |server|
+        retries = 0
+        response = nil
+        begin
+          retries += 1
+          connection = Net::Telnet.new(
+            'Host' => server[:host],
+            'Port' => server[:port],
+            'Timeout' => server[:timeout] || 5)
+          
+          if(server[:secret])
+            connection.waitfor("Match" => /^107/) do |authentication_request|
+              matchdata = /^107 \d{2}\s*(.{32}).*$/m.match(authentication_request) # Might be a bit ugly regex, but it works great!
+              salt = matchdata[1]
+              if(salt.empty?)
+                raise VarnishError, "Bad authentication request"
+              end
+              
+              digest = OpenSSL::Digest::Digest.new('sha256')
+              digest << salt
+              digest << "\n"
+              digest << server[:secret]
+              digest << "\n"
+              digest << salt
+              digest << "\n"
+              
+              connection.cmd("String" => "auth #{digest.to_s}", "Match" => /\d{3}/) do |auth_response|
+                if(!(/^200/ =~ auth_response))
+                  raise AuthenticationError, "Could not authenticate"
+                end
+              end
+            end
+          end
+          
+          connection.cmd('String' => command, 'Match' => /\n\n/) {|r| response = r.split("\n").first.strip}
+          connection.close
+        rescue Exception => e
+          if retries < Lacquer.configuration.retries
+            retry
+          else
+            if Lacquer.configuration.command_error_handler
+              Lacquer.configuration.command_error_handler.call({
+               :error_class   => "Varnish Error, retried #{Lacquer.configuration.retries} times",
+               :error_message => "Error while trying to connect to #{server[:host]}:#{server[:port]}: #{e}",
+               :parameters    => server,
+               :response      => response })
+            else
+              raise VarnishError.new("Error while trying to connect to #{server[:host]}:#{server[:port]} #{e}")
+            end
+          end
+        end
+        response
+      end
+    end
+  end
+end

data/rails/init.rb

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

data/spec/lacquer/cache_utils_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+describe "Lacquer" do
+  before(:each) do
+    @controller = ControllerClass.new
+  end
+
+  describe "talking to varnish" do
+    before(:each) do
+      @varnish_stub = mock('varnish')
+      Lacquer::Varnish.stub!(:new).and_return(@varnish_stub)
+    end
+
+    describe "when backend is :none" do
+      before(:each) do
+        Lacquer.configuration.job_backend = :none
+      end
+
+      it "sends commands to varnish instantly" do
+        @varnish_stub.should_receive(:purge).twice
+        @controller.clear_cache_for('/', '/blog/posts')
+      end
+
+      it "calls purge with the correct parameter" do
+        @varnish_stub.should_receive(:purge).with('/')
+        @controller.clear_cache_for('/')
+      end
+    end
+
+    describe "when backend is :delayed_job" do
+      it "sends commands to a delayed_job queue" do
+        Lacquer.configuration.job_backend = :delayed_job
+
+        Delayed::Job.should_receive(:enqueue).twice
+        @controller.clear_cache_for('/', '/blog/posts')
+      end
+    end
+
+    describe "when backend is :resque" do
+      it "sends commands to a resque queue" do
+        Lacquer.configuration.job_backend = :resque
+
+        Resque.should_receive(:enqueue).twice
+        @controller.clear_cache_for('/', '/blog/posts')
+      end
+    end
+  end
+
+  describe "when cache is enabled" do
+    describe "when no custom ttl is set" do
+      it "should send cache control headers based on default ttl" do
+        Lacquer.configuration.enable_cache = true
+        Lacquer.configuration.default_ttl = 1.week
+
+        @controller.set_default_cache_ttl
+        @controller.should_receive(:expires_in).with(1.week, :public => true)
+        @controller.send_cache_control_headers
+      end
+    end
+
+    describe "when custom ttl is set" do
+      it "should send cache control headers based on custom set ttl" do
+        Lacquer.configuration.enable_cache = true
+
+        @controller.set_cache_ttl(10.week)
+        @controller.should_receive(:expires_in).with(10.week, :public => true)
+        @controller.send_cache_control_headers
+      end
+    end
+  end
+
+  it "should allow purge by non-controller sweepers" do
+    @varnish_stub = mock('varnish')
+    Lacquer::Varnish.stub!(:new).and_return(@varnish_stub)
+
+    @sweeper = SweeperClass.new
+
+    @varnish_stub.should_receive(:purge)
+    @sweeper.clear_cache_for('/')
+  end
+end

data/spec/lacquer/delayed_job_job_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+describe "DelayedJobJob" do
+  describe "perform" do
+    it "should purge the parameter" do
+      @varnish_mock = mock('varnish')
+      Lacquer::Varnish.stub!(:new).and_return(@varnish_mock)
+
+      @varnish_mock.should_receive(:purge).with('/').exactly(1).times
+      Lacquer::DelayedJobJob.new('/').perform
+    end
+  end
+end

data/spec/lacquer/resque_job_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+describe "ResqueJob" do
+  describe "perform" do
+    it "should purge the parameter" do
+      @varnish_mock = mock('varnish')
+      Lacquer::Varnish.stub!(:new).and_return(@varnish_mock)
+
+      @varnish_mock.should_receive(:purge).with('/').exactly(1).times
+      Lacquer::ResqueJob.perform('/')
+    end
+  end
+end

data/spec/lacquer/varnish_spec.rb

@@ -0,0 +1,176 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+describe "Varnish" do
+  before(:each) do
+    @telnet_mock = mock('Net::Telnet')
+    Net::Telnet.stub!(:new).and_return(@telnet_mock)
+    @telnet_mock.stub!(:close)
+    @telnet_mock.stub!(:cmd)    
+    @telnet_mock.stub!(:puts)
+    @telnet_mock.stub!(:waitfor)
+    Lacquer.configuration.retries.should == 5
+  end
+
+  describe "with any command" do
+    describe "when connection is unsuccessful" do
+      it "should raise a Lacquer::VarnishError" do
+        @telnet_mock.stub!(:cmd).and_raise(Timeout::Error)
+        lambda {
+          Lacquer::Varnish.new.purge('/')
+        }.should raise_error(Lacquer::VarnishError)
+      end
+
+      it "should retry on failure before erroring" do
+        @telnet_mock.stub!(:cmd).and_raise(Timeout::Error)
+        Net::Telnet.should_receive(:new).exactly(5).times
+        lambda {
+          Lacquer::Varnish.new.purge('/')
+        }.should raise_error(Lacquer::VarnishError)
+      end
+
+      it "should close the connection afterwards" do
+        @telnet_mock.should_receive(:close).exactly(1).times
+        Lacquer::Varnish.new.purge('/')
+      end
+    end
+    
+    describe "when using authentication" do
+      after(:each) do
+        Lacquer.configuration.varnish_servers.first[:secret] = nil
+      end
+      describe "with correct secret" do
+        before(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = "the real secret"
+        end
+
+        it "should return successfully when using correct secret" do
+          @telnet_mock.stub!(:waitfor).with("Match" => /^107/).and_yield('107 59      \nhaalpffwlcvblmdrinpnjwigwsbiiigq\n\nAuthentication required.\n\n')
+          @telnet_mock.stub!(:cmd).with("String" => "auth d218942acc92753db0c9fedddb32cde6158de28e903356caed1808cf0e23a15a", "Match" => /\d{3}/).and_yield('200')
+          @telnet_mock.stub!(:cmd).with("String" => "url.purge /", "Match" => /\n\n/).and_yield('200')
+        
+          lambda {
+            Lacquer::Varnish.new.purge('/')
+          }.should_not raise_error
+        end
+
+        after(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = nil
+        end
+      end
+
+      describe "with wrong secret" do
+        before(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = "the wrong secret"
+        end
+        it "should raise Lacquer::AuthenticationError when using wrong secret" do
+          @telnet_mock.stub!(:waitfor).with("Match" => /^107/).and_yield('107 59      \nhaalpffwlcvblmdrinpnjwigwsbiiigq\n\nAuthentication required.\n\n')
+          @telnet_mock.stub!(:cmd).with("String" => "auth 49725ec6723b64774a7ab918a24cba811130e99b7ac4b4c9d21ce9a8144762c8", "Match" => /\d{3}/).and_yield('107')
+          @telnet_mock.stub!(:cmd).with("url.purge /").and_yield('200')
+
+          lambda {
+            Lacquer::Varnish.new.purge('/')
+          }.should raise_error(Lacquer::VarnishError)
+        end
+        after(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = nil
+        end
+      end
+    end
+
+    describe "when connection is unsuccessful and an error handler is set" do
+      before(:each) do
+        Lacquer.configuration.command_error_handler = mock("command_error_handler")
+      end
+      it "should call handler on error" do
+        @telnet_mock.stub!(:cmd).and_raise(Timeout::Error)
+        Lacquer.configuration.command_error_handler.should_receive(:call).exactly(1).times
+        lambda {
+          Lacquer::Varnish.new.purge('/')
+        }.should_not raise_error(Lacquer::VarnishError)
+      end
+    end
+    
+  end
+
+  describe "when sending a stats command" do
+    it "should return an array of stats" do
+      @telnet_mock.stub!(:cmd).and_yield(%Q[
+200 2023
+     6263596  Client connections accepted
+     6260911  Client requests received
+      919605  Cache hits for pass
+     2123848  Cache misses
+     6723161  Backend conn. success
+     6641493  Fetch with Length
+       81512  Fetch wanted close
+          11  Fetch failed
+        1648  N struct sess_mem
+          81  N struct sess
+       22781  N struct object
+       23040  N struct objectcore
+       36047  N struct objecthead
+       56108  N struct smf
+        1646  N small free smf
+         263  N large free smf
+          55  N struct vbe_conn
+         804  N worker threads
+        1583  N worker threads created
+        2114  N worker threads limited
+        1609  N overflowed work requests
+           1  N backends
+     1693663  N expired objects
+      400637  N LRU nuked objects
+          10  N LRU moved objects
+         254  HTTP header overflows
+     2506470  Objects sent with write
+     6263541  Total Sessions
+     6260911  Total Requests
+          40  Total pipe
+     4599215  Total pass
+     6722994  Total fetch
+  2607029095  Total header bytes
+ 55280196533  Total body bytes
+     6263536  Session Closed
+           5  Session herd
+   511352337  SHM records
+    33376035  SHM writes
+       33177  SHM flushes due to overflow
+      208858  SHM MTX contention
+         246  SHM cycles through buffer
+     6361382  allocator requests
+       54199  outstanding allocations
+   953389056  bytes allocated
+   120352768  bytes free
+         323  SMS allocator requests
+      151528  SMS bytes allocated
+      151528  SMS bytes freed
+     6723053  Backend requests made
+           1  N vcl total
+           1  N vcl available
+          49  N total active purges
+         197  N new purges added
+         148  N old purges deleted
+        6117  N objects tested
+       60375  N regexps tested against
+         140  N duplicate purges removed
+      944407  HCB Lookups without lock
+           3  HCB Lookups with lock
+     2099076  HCB Inserts
+      515351  Objects ESI parsed (unlock)
+       35371  Client uptime
+
+500 22
+Closing CLI connection
+].strip)
+      stats = Lacquer::Varnish.new.stats
+      stats.size.should be(1)
+    end
+  end
+
+  describe "when sending a purge command" do 
+    it "should return successfully" do
+      @telnet_mock.stub!(:cmd).with("String" => "url.purge /", "Match" => /\n\n/).and_yield('200')
+      Lacquer::Varnish.new.purge('/').should be(true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "lacquer"
+require "rspec"
+
+class ControllerClass
+  def self.before_filter(arg); end
+  def self.after_filter(arg); end
+
+  include Lacquer::CacheUtils
+end
+
+class SweeperClass
+  include Lacquer::CacheUtils
+end
+
+module Delayed;
+  module Job; end
+end
+
+module Resque; end
+
+Lacquer.configure do |config|
+  config.enable_cache = true
+  config.default_ttl = 1.week
+  config.job_backend = :none
+  config.varnish_servers << { :host => "0.0.0.0", :port => 6082 }
+end
+
+Rspec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification 
+name: hakon-lacquer
+version: !ruby/object:Gem::Version 
+  hash: 13
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 1
+  version: 0.4.1
+platform: ruby
+authors: 
+- Russ Smith (russ@bashme.org)
+- Ryan Johns
+- Garry Tan (garry@posterous.com), Gabe da Silveira (gabe@websaviour.com)
+- "H\xC3\xA5kon Lerring"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-28 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id006
+description: Rails drop in for Varnish support.
+email: russ@bashme.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .bundle/config
+- .document
+- 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
+has_rdoc: true
+homepage: http://github.com/russ/lacquer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails drop in for Varnish support.
+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