lacquer 0.2.1 → 0.2.2

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lacquer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{lacquer}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Russ Smith"]
-  s.date = %q{2010-06-12}
+  s.date = %q{2010-06-14}
   s.description = %q{Rails drop in for Varnish support.}
   s.email = %q{russ@bashme.org}
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "init.rb",
      "lacquer.gemspec",
+     "lib/generators/USAGE",
      "lib/generators/lacquer_generator.rb",
      "lib/generators/templates/initializer.rb",
      "lib/generators/templates/varnish.sample.vcl",
@@ -33,7 +34,7 @@ Gem::Specification.new do |s|
      "lib/lacquer/configuration.rb",
      "lib/lacquer/delayed_job_job.rb",
      "lib/lacquer/resque_job.rb",
-     "lib/lacquer/varnish_interface.rb",
+     "lib/lacquer/varnish.rb",
      "rails/init.rb",
      "test/helper.rb",
      "test/test_cache_utils.rb",

data/lib/generators/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Installs Lacquer into your Rails application.
+
+Example: 
+  rails generate lacquer

data/lib/generators/lacquer_generator.rb

@@ -1,11 +1,9 @@
 require 'rails/generators'
 
-class LacquerGenerator < Rails::Generators::Base
-  def self.source_root
-    File.join(File.dirname(__FILE__), 'templates')
-  end
+class LacquerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
 
-  def install_lacquer
+  def install
     copy_file('varnish.sample.vcl', 'config/varnish.sample.vcl')
     copy_file('initializer.rb', 'config/initializers/lacquer.rb')
   end

data/lib/generators/templates/initializer.rb

@@ -1,6 +1,15 @@
 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
-  config.varnish_servers << { :host => '0.0.0.0', :port => 6082 }
+
+  # Array of Varnish servers to manage
+  config.varnish_servers << { 
+    :host => '0.0.0.0', :port => 6082
+  }
 end

data/lib/lacquer.rb

@@ -4,7 +4,7 @@ require 'active_support/core_ext'
 
 require 'lacquer/configuration'
 require 'lacquer/cache_utils'
-require 'lacquer/varnish_interface'
+require 'lacquer/varnish'
 
 module Lacquer
   class VarnishError < Exception; end

data/lib/lacquer/cache_utils.rb

@@ -28,12 +28,12 @@ module Lacquer
         case Lacquer.configuration.job_backend
         when :delayed_job
           require 'lacquer/delayed_job_job'
-          Delayed::Job.enqueue(DelayedJobJob.new('url.purge ' << path))
+          Delayed::Job.enqueue(Lacquer::DelayedJobJob.new('url.purge ' << path))
         when :resque
           require 'lacquer/resque_job'
-          Resque.enqueue(ResqueJob, 'url.purge ' << path)
+          Resque.enqueue(Lacquer::ResqueJob, 'url.purge ' << path)
         when :none
-          VarnishInterface.send_command('url.purge ' << path)
+          Varnish.new.purge('url.purge ' << path)
         end
       end
     end

data/lib/lacquer/delayed_job_job.rb

@@ -1,5 +1,7 @@
-class DelayedJobJob < Struct.new(:command)
-  def perform
-    VarnishInterface.send_command(command)
+module Lacquer
+  class DelayedJobJob < Struct.new(:command)
+    def perform
+      Varnish.new.purge(command)
+    end
   end
 end

data/lib/lacquer/resque_job.rb

@@ -1,7 +1,9 @@
-class ResqueJob
-  @queue = :lacquer
-
-  def self.perform(command)
-    VarnishInterface.send_command(command)
+module Lacquer
+  class ResqueJob
+    @queue = :lacquer
+  
+    def self.perform(command)
+      VarnishInterface.new.purge(command)
+    end
   end
 end

data/lib/lacquer/{varnish_interface.rb → varnish.rb}

@@ -1,14 +1,32 @@
 module Lacquer
-  class VarnishInterface
+  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] }
+      end
+    end
+
+    def purge(path)
+      (send_command('url.purge ' << path) == '200 0') ? true : false
+    end
+
+  private
+
     # Sends commands over telnet to varnish servers listed in the config.
-    def self.send_command(command)
+    def send_command(command)
       Lacquer.configuration.varnish_servers.each do |server|
         begin
           connection = Net::Telnet.new(
             'Host' => server[:host],
             'Port' => server[:port],
             'Timeout' => server[:timeout] || 5)
-          connection.puts(command)
+          connection.cmd(command) do |c|
+            return c.strip
+          end
         rescue Exception => e
           raise VarnishError.new("Error while trying to connect to #{server[:host]}:#{server[:port]} #{e}")
         end

data/test/test_cache_utils.rb

@@ -7,8 +7,10 @@ class TestLacquer < ActiveSupport::TestCase
 
   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
-      Lacquer::VarnishInterface.expects(:send_command).twice
       @controller.clear_cache_for('/', '/blog/posts')
     end
   end

data/test/test_varnish_interface.rb

@@ -15,7 +15,7 @@ class TestLacquer < ActiveSupport::TestCase
   context "when connection is succesful" do
     should "send command to varnish server" do
       Net::Telnet.stubs(:new).returns(@telnet_mock)
-      Lacquer::VarnishInterface.send_command('url.purge /')
+      Lacquer::Varnish.new.purge('/')
     end
   end
 
@@ -23,7 +23,7 @@ class TestLacquer < ActiveSupport::TestCase
     should "raise timeout exception" do
       Net::Telnet.stubs(:new).raises(Timeout::Error)
       assert_raise Lacquer::VarnishError do
-        Lacquer::VarnishInterface.send_command('url.purge /')
+        Lacquer::Varnish.new.purge('/')
       end
     end
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Russ Smith
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-12 00:00:00 -07:00
+date: 2010-06-14 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,7 @@ files:
 - VERSION
 - init.rb
 - lacquer.gemspec
+- lib/generators/USAGE
 - lib/generators/lacquer_generator.rb
 - lib/generators/templates/initializer.rb
 - lib/generators/templates/varnish.sample.vcl
@@ -44,7 +45,7 @@ files:
 - lib/lacquer/configuration.rb
 - lib/lacquer/delayed_job_job.rb
 - lib/lacquer/resque_job.rb
-- lib/lacquer/varnish_interface.rb
+- lib/lacquer/varnish.rb
 - rails/init.rb
 - test/helper.rb
 - test/test_cache_utils.rb