lacquer 0.5.5 → 0.5.6

data/README.rdoc

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

data/lib/lacquer/cache_control.rb

@@ -1,40 +1,39 @@
 module Lacquer
-  
   def self.cache_control
     @cache_control ||= CacheControl.new
   end
-  
+
   class CacheControl
     include Lacquer::CacheUtils
     attr_accessor :store
-    
+
     def initialize
       self.store = []
     end
-  
+
     def register(group, options = {})
       options[:group]  = group
       options[:args]   = Array(options[:args]).compact
       store            << options
     end
-  
+
     def configure
       yield self
     end
-    
+
     def purge(group, *args)
       clear_cache_for(*urls_for(group, *args))      
     end
-    
+
     def urls_for(group, *args)
       args.map! { |arg| arg.to_param }
       urls_by(group).map { |options| options[:url] % args }
     end
-  
+
     def to_vcl_conditions(urls = store)
       urls.map { |opt| %Q[req.url ~ "#{(opt[:url] % opt[:args])}"] }.join(" || ")
     end
-    
+
     def to_vcl_override_ttl_urls
       urls_grouped_by_expires.map do |expires_in, list|
         <<-CODE.gsub(/^[ \t]{4}*/, '')
@@ -62,15 +61,15 @@ module Lacquer
       }
       CODE
     end
-    
-  protected
-    
+
+    protected
+
     def urls_grouped_by_expires
       store.group_by { |opt| opt[:expires_in] }.select { |expires_in, list| expires_in }
     end
-    
+
     def urls_by(group)
       store.select { |opt| opt[:group] == group }
     end
-  end  
+  end
 end

data/lib/lacquer/cache_utils.rb

@@ -38,7 +38,7 @@ module Lacquer
         Varnish.new.purge(*paths)
       end
     end
-    
+
     # Sends cache control headers with page.
     # These are the headers that varnish responds to
     # to set cache properly.

data/lib/lacquer/configuration.rb

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

data/lib/lacquer/recipes.rb

@@ -18,32 +18,32 @@ Capistrano::Configuration.instance.load do
     def rails_env
       fetch(:rails_env, false) ? "RAILS_ENV=#{fetch(:rails_env)}" : ''
     end
-    
+
     def rake
       fetch(:rake, 'rake')
     end
-    
+
     def roles
       fetch(:varnishd_role, :varnish)
     end
-    
+
     desc "Link varnishd.yml from shared/config to app/config"
     task :link_varnishd_yml, :roles => lambda { roles } do
       run "cd #{release_path} && ln -nfs #{shared_path}/config/varnishd.yml  #{release_path}/config/varnishd.yml"
     end
     after 'deploy:update_code', 'varnishd:link_varnishd_yml'
-    
+
     desc "Link varnish.vcl from shared/config to app/config"
     task :link_varnish_vcl, :roles => lambda { roles } do
       run "cd #{release_path} && ln -nfs #{shared_path}/config/varnish.vcl  #{release_path}/config/varnish.vcl"
     end
     after 'deploy:update_code', 'varnishd:link_varnishd_vcl'
-    
+
     desc "Purge ALL urls from Varnish"
     task :global_purge, :roles => lambda { roles } do
       run "cd #{current_path};#{rails_env} #{rake} varnishd:global_purge"
     end
-    
+
     desc "Stop the varnishd process"
     task :stop, :roles => lambda { roles } do
       run "cd #{current_path};#{rails_env} #{rake} varnishd:stop"
@@ -59,4 +59,4 @@ Capistrano::Configuration.instance.load do
       run "cd #{current_path};#{rails_env} #{rake} varnishd:restart"
     end
   end
-end
+end

data/lib/lacquer/tasks.rb

@@ -4,12 +4,12 @@ namespace :lacquer do
     task :start => :environment do
       Lacquer::Varnishd.new.start
     end
-    
+
     desc "Stop varnishd daemon using Lacquer's settings"
     task :stop => :environment do
       Lacquer::Varnishd.new.stop
     end
-    
+
     desc "Running status of varnishd daemon using Lacquer's settings"
     task :status => :environment do
       if Lacquer::Varnishd.new.running?
@@ -18,7 +18,7 @@ namespace :lacquer do
         puts "Varnishd is not running"
       end
     end
-    
+
     desc "Restart varnishd daemon using Lacquer's settings"
     task :restart => :environment do
       varnishd = Lacquer::Varnishd.new
@@ -28,7 +28,7 @@ namespace :lacquer do
       end
       varnishd.start
     end
-    
+
     desc "Purge ALL urls from Varnish"
     task :global_purge => :environment do
       Lacquer::Varnish.new.purge('.*')

data/lib/lacquer/varnish.rb

@@ -14,12 +14,15 @@ module Lacquer
     # Sends the command 'url.purge *path*'
     def purge(*paths)
       paths.all? do |path|
-        send_command(Lacquer.configuration.purge_command + " " + path.gsub('\\', '\\\\\\')).all? do |result|
-          result =~ /200/
+        ActiveSupport::Notifications.instrument('purge.lacquer', path: path) do |payload|
+          send_command(Lacquer.configuration.purge_command + " " + path.gsub('\\', '\\\\\\')).all? do |result|
+            payload[:result] = result
+            result =~ /200/
+          end
         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|
@@ -31,7 +34,7 @@ module Lacquer
             '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!
@@ -39,7 +42,7 @@ module Lacquer
               if(salt.empty?)
                 raise VarnishError, "Bad authentication request"
               end
-              
+
               digest = OpenSSL::Digest::Digest.new('sha256')
               digest << salt
               digest << "\n"
@@ -47,7 +50,7 @@ module Lacquer
               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"
@@ -55,7 +58,7 @@ module Lacquer
               end
             end
           end
-          
+
           connection.cmd('String' => command, 'Match' => /\n\n/) {|r| response = r.split("\n").first.strip}
           connection.close if connection.respond_to?(:close)
         rescue Exception => e

data/lib/lacquer/varnishd.rb

@@ -1,11 +1,11 @@
 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
@@ -13,26 +13,26 @@ module Lacquer
     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      
+
+    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}"
@@ -41,7 +41,7 @@ module Lacquer
         end
       end
     end
-    
+
     def start
       if running?
         log("Already running")
@@ -52,26 +52,26 @@ module Lacquer
       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
     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
@@ -87,38 +87,38 @@ module Lacquer
       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
@@ -126,6 +126,5 @@ module Lacquer
         nil
       end
     end
-    
   end
-end
+end

data/lib/lacquer/version.rb

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

data/spec/config/generate.vcl.erb

@@ -13,4 +13,3 @@ sub vcl_fetch {
   unset beresp.http.Set-Cookie;
   set beresp.grace = 30m;
 }
-

data/spec/config/varnish.vcl

@@ -13,4 +13,3 @@ sub vcl_fetch {
   unset beresp.http.Set-Cookie;
   set beresp.grace = 30m;
 }
-

data/spec/lacquer/cache_control_spec.rb

@@ -11,9 +11,9 @@ describe Lacquer::CacheControl do
       cache_control.store.first[:args].should   == ["[0-9]+"]
     end
   end
-  
+
   describe "#urls_for" do
-    it "returns urls to expire for object" 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.*$"]
@@ -25,7 +25,7 @@ describe Lacquer::CacheControl 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("||")
@@ -47,7 +47,7 @@ describe Lacquer::CacheControl do
       pass_urls.should include('if(req.url ~ "*.mp4$")')
       pass_urls.should include('return(pipe)')
     end
-    
+
     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"
@@ -56,13 +56,13 @@ describe Lacquer::CacheControl do
       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')

data/spec/lacquer/delayed_job_job_spec.rb

@@ -3,6 +3,8 @@ require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
 describe "DelayedJobJob" do
   describe "perform" do
     it "should purge the parameter" do
+      require File.expand_path('lib/lacquer/delayed_job_job')
+
       @varnish_mock = mock('varnish')
       Lacquer::Varnish.stub!(:new).and_return(@varnish_mock)
 

data/spec/lacquer/resque_job_spec.rb

@@ -3,6 +3,8 @@ require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
 describe "ResqueJob" do
   describe "perform" do
     it "should purge the parameter" do
+      require File.expand_path('lib/lacquer/resque_job')
+
       @varnish_mock = mock('varnish')
       Lacquer::Varnish.stub!(:new).and_return(@varnish_mock)
 

data/spec/lacquer/varnish_spec.rb

@@ -5,7 +5,7 @@ describe "Varnish" 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!(:cmd)
     @telnet_mock.stub!(:puts)
     @telnet_mock.stub!(:waitfor)
     Lacquer.configuration.retries.should == 5
@@ -33,7 +33,7 @@ describe "Varnish" do
         Lacquer::Varnish.new.purge('/')
       end
     end
-    
+
     describe "when using authentication" do
       after(:each) do
         Lacquer.configuration.varnish_servers.first[:secret] = nil
@@ -47,7 +47,7 @@ describe "Varnish" 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
@@ -89,7 +89,7 @@ describe "Varnish" do
         }.should_not raise_error(Lacquer::VarnishError)
       end
     end
-    
+
   end
 
   describe "when sending a stats command" do

data/spec/lacquer/varnishd_spec.rb

@@ -1,14 +1,13 @@
 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|
@@ -18,11 +17,11 @@ describe "Varnishd" do
       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")
@@ -30,42 +29,41 @@ describe "Varnishd" do
     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
+end

data/spec/spec_helper.rb

@@ -28,6 +28,6 @@ Lacquer.configure do |config|
   config.varnish_servers << { :host => "0.0.0.0", :port => 6082 }
 end
 
-Rspec.configure do |c|
+RSpec.configure do |c|
   c.mock_with :rspec
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lacquer
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-11 00:00:00.000000000 Z
+date: 2012-05-02 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70107447903980 !ruby/object:Gem::Requirement
+  requirement: &70253394615980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 2.3.10
   type: :runtime
   prerelease: false
-  version_requirements: *70107447903980
+  version_requirements: *70253394615980
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70107447914580 !ruby/object:Gem::Requirement
+  requirement: &70253394614860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -35,10 +35,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70107447914580
+  version_requirements: *70253394614860
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &70107447924320 !ruby/object:Gem::Requirement
+  requirement: &70253394613740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +46,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70107447924320
+  version_requirements: *70253394613740
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70107447921200 !ruby/object:Gem::Requirement
+  requirement: &70253394612340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +57,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70107447921200
+  version_requirements: *70253394612340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70107447934240 !ruby/object:Gem::Requirement
+  requirement: &70253394610860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +68,10 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *70107447934240
+  version_requirements: *70253394610860
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70107447929060 !ruby/object:Gem::Requirement
+  requirement: &70253394610320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,7 +79,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70107447929060
+  version_requirements: *70253394610320
 description: Rails drop in for Varnish support.
 email: russ@bashme.org
 executables: []