lacquer 0.4.1 → 0.5.0.beta1

data/lib/lacquer/varnish.rb

@@ -12,12 +12,14 @@ module Lacquer
     end
 
     # Sends the command 'url.purge *path*'
-    def purge(path)
-      send_command('url.purge ' << path).all? do |result|
-        result =~ /200/
+    def purge(*paths)
+      paths.all? do |path|
+        send_command('url.purge ' << path.gsub('\\', '\\\\\\')).all? do |result|
+          result =~ /200/
+        end
       end
     end
-
+    
     # Sends commands over telnet to varnish servers listed in the config.
     def send_command(command)
       Lacquer.configuration.varnish_servers.collect do |server|
@@ -55,7 +57,7 @@ module Lacquer
           end
           
           connection.cmd('String' => command, 'Match' => /\n\n/) {|r| response = r.split("\n").first.strip}
-          connection.close
+          connection.close if connection.respond_to?(:close)
         rescue Exception => e
           if retries < Lacquer.configuration.retries
             retry

data/lib/lacquer/varnishd.rb

@@ -0,0 +1,131 @@
+module Lacquer
+  class Varnishd
+    attr_accessor :listen, :telnet, :sbin_path, :storage, :working_dir, :user, :backend, :params
+    
+    cattr_accessor :started_check_delay, :vcl_script_filename
+    self.started_check_delay = 1
+    self.vcl_script_filename = 'config/varnish.vcl'
+    
+    def self.root_path
+      Rails.root
+    end
+
+    def self.env
+      Rails.env
+    end
+    
+    def self.config_file
+      root_path.join('config/varnishd.yml')
+    end
+    
+    def self.config
+      YAML.load(File.read(config_file))[env].stringify_keys
+    end
+    
+    def initialize(settings = self.class.config)
+      self.listen, self.telnet, self.backend, self.sbin_path, self.storage, self.working_dir, self.user, self.params =
+        settings.values_at("listen", "telnet", "backend", "sbin_path", "storage", "working_dir", "user", "params")
+    end
+    
+    def render_vcl      
+      require 'erubis'
+      eruby = Erubis::Eruby.new(erb_vcl_script_filename.read)
+      eruby.result(binding)
+    end
+    
+    def generate_vcl
+      if erb_vcl_script_filename.exist?
+        log "#{erb_vcl_script_filename} found rendering to #{vcl_script_filename}"
+        File.open(vcl_script_filename, "w") do |vcl|
+          vcl.write(render_vcl)
+        end
+      end
+    end
+    
+    def start
+      if running?
+        log("Already running")
+        return
+      end
+      generate_vcl
+      execute("#{varnishd_cmd} #{args} #{params_args}")
+      sleep(self.class.started_check_delay)
+      log("Failed to start varnishd daemon") unless running?
+    end
+    
+    def stop
+      if running?
+        execute("kill #{pid}")
+        pid_file.delete
+      else
+        log("pid file not found or varnishd not running")
+      end      
+    end
+    
+    def running?
+      !!pid && !!Process.kill(0, pid.to_i)
+    rescue
+      false
+    end
+    
+    def args
+      options.map { |k, v| "#{k} #{v}" }.join(" ")
+    end
+    
+    def params_args
+      params.map { |k, v| "-p #{k}=#{v}" }.join(" ")
+    end
+
+    def options
+      opt = {}
+      opt["-P"] = pid_file
+      opt["-a"] = listen
+      opt["-T"] = telnet        if telnet.present?
+      opt["-n"] = working_dir   if working_dir.present?
+      opt["-u"] = user          if user.present?
+      opt["-s"] = eval(%Q("#{storage}"))
+      opt["-f"] = vcl_script_filename
+      opt
+    end
+    
+    def params
+      @params || {}
+    end
+    
+    protected
+    
+    def varnishd_cmd
+      Pathname.new(sbin_path).join('varnishd')
+    end
+    
+    def pid_file
+      self.class.root_path.join("log/varnishd.#{self.class.env}.pid")
+    end
+    
+    def vcl_script_filename
+      self.class.root_path.join(self.class.vcl_script_filename)
+    end
+    
+    def erb_vcl_script_filename
+      vcl_script_filename.sub_ext('.vcl.erb')
+    end
+    
+    def log(message)
+      puts "** [#{self.class.name}] #{message}"
+    end
+    
+    def execute(cmd)
+      log(cmd)
+      `#{cmd}`
+    end
+   
+    def pid
+      if pid_file.exist?
+        pid_file.read
+      else
+        nil
+      end
+    end
+    
+  end
+end

data/lib/lacquer.rb

@@ -8,7 +8,11 @@ require "active_support/core_ext"
 
 require "lacquer/configuration"
 require "lacquer/cache_utils"
+require "lacquer/cache_control"
 require "lacquer/varnish"
+require "lacquer/varnishd"
+
+require "lacquer/railtie" if defined?(Rails::Railtie)
 
 module Lacquer
   class VarnishError < Exception; end # @private

data/rails/init.rb

@@ -1 +1 @@
-require 'lacquer'
+require 'lacquer'

data/recipes/lacquer.rb

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

data/spec/config/generate.vcl.erb

@@ -0,0 +1,16 @@
+backend default {
+  .host = "<%= backend.split(':').first %>";
+  .port = "<%= backend.split(':').last %>";
+}
+
+sub vcl_recv {
+  set req.backend = default;
+  unset req.http.Cookie;
+  set req.grace = 30m;
+}
+
+sub vcl_fetch {
+  unset beresp.http.Set-Cookie;
+  set beresp.grace = 30m;
+}
+

data/spec/config/varnish.vcl

@@ -0,0 +1,16 @@
+backend default {
+  .host = "127.0.0.1";
+  .port = "3000";
+}
+
+sub vcl_recv {
+  set req.backend = default;
+  unset req.http.Cookie;
+  set req.grace = 30m;
+}
+
+sub vcl_fetch {
+  unset beresp.http.Set-Cookie;
+  set beresp.grace = 30m;
+}
+

data/spec/config/varnishd.yml

@@ -0,0 +1,10 @@
+test:
+  listen: :80
+  telnet: localhost:6082
+  sbin_path: /usr/local/sbin
+  backend: 0.0.0.0:3000
+  storage: "file,#{Rails.root}/log/varnish,1GB"
+  working_dir: ""
+  user: "deploy"
+  params:
+    overflow_max: 2000

data/spec/lacquer/cache_control_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+require 'lacquer/cache_control'
+
+describe Lacquer::CacheControl do
+  
+  describe "#register" do
+    
+    it "persists cache settings for url" do
+      cache_control = described_class.new
+      cache_control.register :class_section, :url => "^/sv/class_sections/%s.*$", :args => "[0-9]+"
+      cache_control.store.first[:group].should  == :class_section
+      cache_control.store.first[:url].should    == "^/sv/class_sections/%s.*$"
+      cache_control.store.first[:args].should   == ["[0-9]+"]
+    end
+    
+  end
+  
+  describe "#urls_for" do
+    
+    it "returns urls to expire for object" do      
+      cache_control = described_class.new
+      cache_control.register :class_section, :url => "^/sv/class_sections/%s.*$", :args => "[0-9]+"
+      cache_control.urls_for(:class_section, mock("ClassSection", :to_param => 1)).should == ["^/sv/class_sections/1.*$"]
+    end
+    
+  end
+
+  context "vcl" do
+    
+    it "returns all urls as vcl conditions" do
+      cache_control = described_class.new
+      cache_control.register :class_section, :url => "^/sv/class_sections/%s.*$", :args => "[0-9]+"
+      cache_control.register :class_section, :url => "^/sv/info_screens/%s.*$", :args => "[0-9]+"
+      
+      conditions = cache_control.to_vcl_conditions
+      conditions.should include("req.url ~ \"^/sv/class_sections/[0-9]+.*$\"")
+      conditions.should include("||")
+      conditions.should include("req.url ~ \"^/sv/info_screens/[0-9]+.*$\"")
+    end
+    
+    # if (req.url ~ "^/images" || req.url ~ "^/stylesheets" || req.url ~ "^/javascripts") {
+    #  unset beresp.http.Set-Cookie;
+    #  set beresp.ttl = 7d;
+    #  return(deliver);
+    # }  
+    
+    it "returns vcl for override ttl on beresp" do
+      cache_control = described_class.new
+      cache_control.register :class_section, :url => "^/sv/competitions$", :expires_in => "7d"
+      override_ttl = cache_control.to_vcl_override_ttl_urls
+      override_ttl.should include('if(req.url ~ "^/sv/competitions$")')
+      override_ttl.should include('unset beresp.http.Set-Cookie')
+      override_ttl.should include('return(deliver)')
+    end
+    
+    it "group by expires in" do
+      cache_control = described_class.new
+      cache_control.register :class_section, :url => "^/sv/competitions$", :expires_in => "1d"
+      cache_control.register :class_section, :url => "^/sv/competitions/%s$", :args => "[0-9]+", :expires_in => "2d"
+      cache_control.register :class_section, :url => "^/sv/competitions/%s/info_screen$", :args => "[0-9]+"
+      
+      override_ttl = cache_control.to_vcl_override_ttl_urls
+      override_ttl.should include('if(req.url ~ "^/sv/competitions$")')
+      override_ttl.should include('set beresp.ttl = 1d')
+      override_ttl.should include('if(req.url ~ "^/sv/competitions/[0-9]+$")')
+      override_ttl.should include('set beresp.ttl = 2d')
+      override_ttl.should_not include('info_screen')
+    end
+    
+  end
+  
+end

data/spec/lacquer/cache_utils_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+require 'lacquer/delayed_job_job'
 
 describe "Lacquer" do
   before(:each) do
@@ -17,7 +18,7 @@ describe "Lacquer" do
       end
 
       it "sends commands to varnish instantly" do
-        @varnish_stub.should_receive(:purge).twice
+        @varnish_stub.should_receive(:purge).with('/', '/blog/posts').once
         @controller.clear_cache_for('/', '/blog/posts')
       end
 
@@ -30,8 +31,8 @@ describe "Lacquer" do
     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
+        Lacquer::DelayedJobJob.should_receive(:new).with(['/', '/blog/posts'])
+        Delayed::Job.should_receive(:enqueue).once
         @controller.clear_cache_for('/', '/blog/posts')
       end
     end
@@ -40,7 +41,7 @@ describe "Lacquer" do
       it "sends commands to a resque queue" do
         Lacquer.configuration.job_backend = :resque
 
-        Resque.should_receive(:enqueue).twice
+        Resque.should_receive(:enqueue).once
         @controller.clear_cache_for('/', '/blog/posts')
       end
     end

data/spec/lacquer/varnishd_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+describe "Varnishd" do
+  
+  before do
+    spec_root = Pathname.new(__FILE__).dirname.join('..').expand_path    
+    Lacquer::Varnishd.stub!(:started_check_delay).and_return(0)
+    Lacquer::Varnishd.stub!(:env).and_return('test')
+    Lacquer::Varnishd.stub!(:root_path).and_return(spec_root)
+  end
+  
+  def executes_with(regexp)
+    new_method = Lacquer::Varnishd.method(:new)
+    Lacquer::Varnishd.stub!(:new).and_return do |*args|
+      varnishd = new_method.call(*args)
+      varnishd.should_receive(:execute).with(regexp)
+      varnishd.stub!(:log)
+      varnishd
+    end
+  end
+  
+  it "passes settings in the initailizer" do
+    Lacquer::Varnishd.new("listen" => ":80").listen.should == ":80"
+  end
+  
+  it "loads settings from varnish_config" do
+    Lacquer::Varnishd.config.should have_key("listen")
+    Lacquer::Varnishd.config.should have_key("telnet")
+    Lacquer::Varnishd.config.should have_key("sbin_path")
+    Lacquer::Varnishd.config.should have_key("storage")
+    Lacquer::Varnishd.config["params"].should have_key('overflow_max')
+  end
+  
+  it "returns full path to varnishd" do
+    executes_with(%r[/opt/varnishd/sbin/varnishd])
+    Lacquer::Varnishd.new("sbin_path" => "/opt/varnishd/sbin").start
+  end
+  
+  it "returns pid file" do
+    executes_with(/log\/varnishd.test.pid/)
+    Lacquer::Varnishd.new("sbin_path" => "/opt/varnishd/sbin").start
+  end
+  
+  it "returns params as string" do
+    Lacquer::Varnishd.new("params" => { "max" => 2000, "add" => 2 }).params_args.should == "-p max=2000 -p add=2"    
+  end
+  
+  it "returns listen arg as string" do
+    Lacquer::Varnishd.new("listen" => ":80").args.should include("-a :80")
+  end
+  
+  it "starts varnishd with args and params" do
+    executes_with(%r[/opt/varnishd/sbin.*-P.*log/varnishd.test.pid])
+    Lacquer::Varnishd.new("sbin_path" => "/opt/varnishd/sbin", "params" => { "overflow_max" => 2000 }).start
+  end
+  
+  it "raises error if vcl_script_file is not present" do
+    Lacquer::Varnishd.stub!(:vcl_script_filename).and_return("config/file_not_found.vcl")
+    expect {
+      Lacquer::Varnishd.new.vcl_script_path
+    }.to raise_error
+  end
+  
+  it "renders vcl file when erb is present" do
+    Lacquer::Varnishd.stub!(:vcl_script_filename).and_return("config/generate.vcl")
+    result = Lacquer::Varnishd.new.render_vcl
+    result.should include('.host = "0.0.0.0"')
+    result.should include('.port = "3000"')
+  end
+  
+end

data/tasks/lacquer.rake

@@ -0,0 +1 @@
+load File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'lacquer', 'tasks.rb'))

metadata

@@ -1,131 +1,87 @@
 --- !ruby/object:Gem::Specification 
 name: lacquer
 version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
+  prerelease: 6
+  version: 0.5.0.beta1
 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 -08:00
+date: 2011-04-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
   name: activesupport
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        - 0
-        - 1
-        version: 3.0.1
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+        version: "3.0"
   type: :runtime
   prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: i18n
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 4
-        - 1
-        version: 0.4.1
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+        version: "0.4"
   type: :runtime
   prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rake
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
-  name: rspec
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 0
-        - 0
-        version: 2.0.0
-  requirement: *id005
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
   name: yard
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  requirement: *id006
-- !ruby/object:Gem::Dependency 
-  type: :development
+  type: :runtime
   prerelease: false
-  name: rspec
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: erubis
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
-  requirement: *id007
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
 description: Rails drop in for Varnish support.
 email: russ@bashme.org
 executables: []
@@ -139,7 +95,6 @@ files:
 - .bundle/config
 - .document
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -149,19 +104,33 @@ files:
 - lib/generators/lacquer/USAGE
 - lib/generators/lacquer/install_generator.rb
 - lib/generators/lacquer/templates/initializer.rb
-- lib/generators/lacquer/templates/varnish.sample.vcl
+- lib/generators/lacquer/templates/varnish.vcl.erb
+- lib/generators/lacquer/templates/varnishd.yml
 - lib/lacquer.rb
+- lib/lacquer/cache_control.rb
 - lib/lacquer/cache_utils.rb
+- lib/lacquer/capistrano.rb
 - lib/lacquer/configuration.rb
 - lib/lacquer/delayed_job_job.rb
+- lib/lacquer/railtie.rb
+- lib/lacquer/recipes.rb
 - lib/lacquer/resque_job.rb
+- lib/lacquer/tasks.rb
 - lib/lacquer/varnish.rb
+- lib/lacquer/varnishd.rb
 - rails/init.rb
+- recipes/lacquer.rb
+- spec/config/generate.vcl.erb
+- spec/config/varnish.vcl
+- spec/config/varnishd.yml
+- spec/lacquer/cache_control_spec.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/lacquer/varnishd_spec.rb
 - spec/spec_helper.rb
+- tasks/lacquer.rake
 has_rdoc: true
 homepage: http://github.com/russ/lacquer
 licenses: []
@@ -176,29 +145,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 1714554342870495979
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Rails drop in for Varnish support.
 test_files: 
+- spec/lacquer/cache_control_spec.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/lacquer/varnishd_spec.rb
 - spec/spec_helper.rb

data/Gemfile.lock

@@ -1,34 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activesupport (3.0.1)
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    i18n (0.4.1)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    rake (0.8.7)
-    rspec (2.0.0)
-      rspec-core (= 2.0.0)
-      rspec-expectations (= 2.0.0)
-      rspec-mocks (= 2.0.0)
-    rspec-core (2.0.0)
-    rspec-expectations (2.0.0)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.0)
-      rspec-core (= 2.0.0)
-      rspec-expectations (= 2.0.0)
-    yard (0.6.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (= 3.0.1)
-  i18n (= 0.4.1)
-  jeweler
-  rake
-  rspec (= 2.0.0)
-  yard