lacquer 0.2.3 → 0.3.0

data/README.rdoc

@@ -1,30 +1,36 @@
 = lacquer
 
-Rails drop in for Varnish support.
+Rails drop in for Varnish support. This version is adapted from Russ Smith's gem and is in production use on posterous.com.
 
 == Install
 Basic installation
 
-  rails generate lacquer install
+  sudo gem install posterous-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
     }
+
+    # 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
@@ -32,12 +38,40 @@ app/controllers/application_controller.rb
   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

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.email = "russ@bashme.org"
     gem.homepage = "http://github.com/russ/lacquer"
     gem.authors = ["Russ Smith"]
+    gem.add_development_dependency "rspec", ">= 1.3.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -17,36 +18,28 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
-task :test => :check_dependencies
+task :spec => :check_dependencies
 
-task :default => :test
+task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "lacquer #{version}"
+  rdoc.title = "testing #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.3.0

data/lacquer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{lacquer}
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Russ Smith"]
-  s.date = %q{2010-06-15}
+  s.date = %q{2010-09-14}
   s.description = %q{Rails drop in for Varnish support.}
   s.email = %q{russ@bashme.org}
   s.extra_rdoc_files = [
@@ -36,29 +36,33 @@ Gem::Specification.new do |s|
      "lib/lacquer/resque_job.rb",
      "lib/lacquer/varnish.rb",
      "rails/init.rb",
-     "test/helper.rb",
-     "test/test_cache_utils.rb",
-     "test/test_varnish_interface.rb"
+     "spec/lacquer/cache_utils_spec.rb",
+     "spec/lacquer/varnish_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/russ/lacquer}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Rails drop in for Varnish support.}
   s.test_files = [
-    "test/helper.rb",
-     "test/test_cache_utils.rb",
-     "test/test_varnish_interface.rb"
+    "spec/lacquer/cache_utils_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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    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
 end
 

data/lib/lacquer/cache_utils.rb

@@ -42,8 +42,8 @@ module Lacquer
     # These are the headers that varnish responds to
     # to set cache properly.
     def send_cache_control_headers
-      if Lacquer.configuration.enable_cache
-        expires_in(@cache_ttl, :public => true)
+      if Lacquer.configuration.enable_cache && @cache_ttl && @cache_ttl != 0
+        expires_in(@cache_ttl, :public => true, :private => false)
       end
     end
   end

data/lib/lacquer/configuration.rb

@@ -11,14 +11,22 @@ module Lacquer
     # Application default ttl
     attr_accessor :default_ttl
 
+    # Application default ttl
+    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 = 1.week
+      @default_ttl = 0
       @job_backend = :none
+      @retries = 5
+      @command_error_handler = nil
     end
 
     # Returns a hash of all configurable options

data/lib/lacquer/varnish.rb

@@ -1,35 +1,51 @@
 module Lacquer
   class Varnish
     def stats
-      stats = send_command('stats').split("\n")
-      stats.shift
-      
-      stats = stats.collect do |stat|
-        stat = stat.strip.match(/(\d+)\s+(.+)$/)
-        { :key => stat[2], :value => stat[1] }
+      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
 
     def purge(path)
-      (send_command('url.purge ' << path) == '200 0') ? true : false
+      send_command('url.purge ' << path).all? do |result|
+        result =~ /200/
+      end
     end
 
-  private
-
     # Sends commands over telnet to varnish servers listed in the config.
     def send_command(command)
-      Lacquer.configuration.varnish_servers.each do |server|
+      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)
-          connection.cmd(command) do |c|
-            return c.strip
-          end
+          connection.cmd(command + "\nquit\n") {|r| response = r.strip}
+          connection.close
         rescue Exception => e
-          raise VarnishError.new("Error while trying to connect to #{server[:host]}:#{server[:port]} #{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

data/spec/lacquer/cache_utils_spec.rb

@@ -0,0 +1,64 @@
+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
+      it "sends commands to varnish instantly" do
+        Lacquer.configuration.job_backend = :none
+
+        @varnish_stub.should_receive(:purge).twice
+        @controller.clear_cache_for('/', '/blog/posts')
+      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
+end

data/spec/lacquer/varnish_spec.rb

@@ -0,0 +1,132 @@
+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 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).and_yield('200')
+      Lacquer::Varnish.new.purge('/').should be(true)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/{test/helper.rb → spec/spec_helper.rb}

@@ -1,11 +1,9 @@
-require 'rubygems'
-require 'active_support'
-require 'test/unit'
-require 'shoulda'
-
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
 require 'lacquer'
+require 'spec'
+require 'spec/autorun'
 
 class ControllerClass
   def self.before_filter(arg); end
@@ -20,5 +18,12 @@ end
 
 module Resque; end
 
-class ActiveSupport::TestCase
+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
+
+Spec::Runner.configure do |config|
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lacquer
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Russ Smith
@@ -14,10 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-15 00:00:00 -07:00
+date: 2010-09-14 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
 description: Rails drop in for Varnish support.
 email: russ@bashme.org
 executables: []
@@ -47,9 +63,10 @@ files:
 - lib/lacquer/resque_job.rb
 - lib/lacquer/varnish.rb
 - rails/init.rb
-- test/helper.rb
-- test/test_cache_utils.rb
-- test/test_varnish_interface.rb
+- spec/lacquer/cache_utils_spec.rb
+- spec/lacquer/varnish_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/russ/lacquer
 licenses: []
@@ -60,27 +77,31 @@ 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.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rails drop in for Varnish support.
 test_files: 
-- test/helper.rb
-- test/test_cache_utils.rb
-- test/test_varnish_interface.rb
+- spec/lacquer/cache_utils_spec.rb
+- spec/lacquer/varnish_spec.rb
+- spec/spec_helper.rb

data/test/test_cache_utils.rb

@@ -1,50 +0,0 @@
-require 'helper'
-
-class TestLacquer < ActiveSupport::TestCase
-  setup do
-    @controller = ControllerClass.new
-  end
-
-  context "when job backend is :none" do
-    should "take paths to clear cache for" do
-      varnish_stub = mock('Varnish')
-      Lacquer::Varnish.stubs('new').returns(varnish_stub)
-      varnish_stub.expects(:purge).twice
-      Lacquer.configuration.job_backend = :none
-      @controller.clear_cache_for('/', '/blog/posts')
-    end
-  end
-
-  context "when job backend is :delayed_job" do
-    should "take paths to clear cache for" do
-      Lacquer.configuration.job_backend = :delayed_job
-      Delayed::Job.expects(:enqueue).twice
-      @controller.clear_cache_for('/', '/blog/posts')
-    end
-  end
-
-  context "when job backend is :resque" do
-    should "take paths to clear cache for" do
-      Lacquer.configuration.job_backend = :resque
-      Resque.expects(:enqueue).twice
-      @controller.clear_cache_for('/', '/blog/posts')
-    end
-  end
-
-  context "when cache is enabled" do
-    should "send cache control headers based on ttl" do
-      Lacquer.configuration.enable_cache = true
-      @controller.set_cache_ttl(10.week)
-      @controller.expects(:expires_in).with(10.week, :public => true)
-      @controller.send_cache_control_headers
-    end
-  end
-
-  context "when cache is disabled" do
-    should "do not send cache control headers" do
-      Lacquer.configuration.enable_cache = false
-      @controller.expects(:expires_in).never
-      @controller.send_cache_control_headers
-    end
-  end
-end

data/test/test_varnish_interface.rb

@@ -1,30 +0,0 @@
-require 'helper'
-
-class TestLacquer < ActiveSupport::TestCase
-  setup do
-    Lacquer.configure do |config|
-      config.varnish_servers << { :host => '0.0.0.0', :port => 6082 }
-    end 
-
-    @telnet_mock = mock('Net::Telnet')
-    @telnet_mock.stubs(:cmd)
-
-    @controller = ControllerClass.new
-  end
-
-  context "when connection is succesful" do
-    should "send command to varnish server" do
-      Net::Telnet.stubs(:new).returns(@telnet_mock)
-      Lacquer::Varnish.new.purge('/')
-    end
-  end
-
-  context "when connection is unsuccesful" do
-    should "raise timeout exception" do
-      Net::Telnet.stubs(:new).raises(Timeout::Error)
-      assert_raise Lacquer::VarnishError do
-        Lacquer::Varnish.new.purge('/')
-      end
-    end
-  end
-end