lacquer 0.1.0 → 0.2.0

data/README.rdoc

@@ -2,9 +2,29 @@
 
 Rails drop in for Varnish support.
 
-== TODO
-* Add DelayedJob/Resque support.
-* Add helpful install generators.
+== Install
+Basic installation
+
+  rails generate lacquer
+
+config/initializers/lacquer.rb
+
+  Lacquer.configure do |config|
+    config.enable_cache = true
+    config.default_ttl = 1.week
+    config.varnish_servers << { :host => '0.0.0.0', :port => 6082 }
+  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) }
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lacquer.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{lacquer}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Russ Smith"]
@@ -31,6 +31,8 @@ Gem::Specification.new do |s|
      "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_interface.rb",
      "rails/init.rb",
      "test/helper.rb",

data/lib/generators/templates/initializer.rb

@@ -1,5 +1,6 @@
 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

data/lib/lacquer/cache_utils.rb

@@ -25,7 +25,16 @@ module Lacquer
     # clear_cache_for(root_path, blog_posts_path, '/other/content/*')
     def clear_cache_for(*paths)
       paths.each do |path|
-        VarnishInterface.send_command('url.purge ' << path)
+        case Lacquer.configuration.job_backend
+        when :delayed_job
+          require 'lacquer/delayed_job_job'
+          Delayed::Job.enqueue(DelayedJobJob.new('url.purge ' << path))
+        when :resque
+          require 'lacquer/resque_job'
+          Resque.enqueue(ResqueJob, 'url.purge ' << path)
+        when :none
+          VarnishInterface.send_command('url.purge ' << path)
+        end
       end
     end
     

data/lib/lacquer/configuration.rb

@@ -11,10 +11,14 @@ module Lacquer
     # Application default ttl
     attr_accessor :default_ttl
 
+    # Job Backend
+    attr_accessor :job_backend
+
     def initialize
       @enable_cache = true
       @varnish_servers = []
       @default_ttl = 1.week
+      @job_backend = :none
     end
 
     # Returns a hash of all configurable options

data/lib/lacquer/delayed_job_job.rb

@@ -0,0 +1,5 @@
+class DelayedJobJob < Struct.new(:command)
+  def perform
+    VarnishInterface.send_command(command)
+  end
+end

data/lib/lacquer/resque_job.rb

@@ -0,0 +1,7 @@
+class ResqueJob
+  @queue = :lacquer
+
+  def self.perform(command)
+    VarnishInterface.send_command(command)
+  end
+end

data/lib/lacquer/varnish_interface.rb

@@ -1,5 +1,6 @@
 module Lacquer
   class VarnishInterface
+    # Sends commands over telnet to varnish servers listed in the config.
     def self.send_command(command)
       Lacquer.configuration.varnish_servers.each do |server|
         begin

data/test/helper.rb

@@ -7,5 +7,18 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'lacquer'
 
-class Test::Unit::TestCase
+class ControllerClass
+  def self.before_filter(arg); end
+  def self.after_filter(arg); end
+
+  include Lacquer::CacheUtils
+end
+
+module Delayed;
+  module Job; end
+end
+
+module Resque; end
+
+class ActiveSupport::TestCase
 end

data/test/test_cache_utils.rb

@@ -1,20 +1,32 @@
 require 'helper'
 
-class ControllerClass
-  def self.before_filter(arg); end
-  def self.after_filter(arg); end
-
-  include Lacquer::CacheUtils
-end
-
 class TestLacquer < ActiveSupport::TestCase
   setup do
     @controller = ControllerClass.new
   end
 
-  should "take paths to clear cache for" do
-    Lacquer::VarnishInterface.expects(:send_command).twice
-    @controller.clear_cache_for('/', '/blog/posts')
+  context "when job backend is :none" do
+    should "take paths to clear cache for" do
+      Lacquer.configuration.job_backend = :none
+      Lacquer::VarnishInterface.expects(:send_command).twice
+      @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

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Russ Smith
@@ -42,6 +42,8 @@ files:
 - 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_interface.rb
 - rails/init.rb
 - test/helper.rb