lacquer 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Russ Smith
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,21 @@
+= lacquer
+
+Rails drop in for Varnish support.
+
+== TODO
+* Add DelayedJob/Resque support.
+* Add helpful install generators.
+
+== 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/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "lacquer"
+    gem.summary = %Q{Rails drop in for Varnish support.}
+    gem.description = %Q{Rails drop in for Varnish support.}
+    gem.email = "russ@bashme.org"
+    gem.homepage = "http://github.com/russ/lacquer"
+    gem.authors = ["Russ Smith"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+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
+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
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lacquer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

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

data/lacquer.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{lacquer}
+  s.version = "0.1.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-11}
+  s.description = %q{Rails drop in for Varnish support.}
+  s.email = %q{russ@bashme.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lacquer.gemspec",
+     "lib/generators/lacquer_generator.rb",
+     "lib/generators/templates/initializer.rb",
+     "lib/generators/templates/varnish.sample.vcl",
+     "lib/lacquer.rb",
+     "lib/lacquer/cache_utils.rb",
+     "lib/lacquer/configuration.rb",
+     "lib/lacquer/varnish_interface.rb",
+     "rails/init.rb",
+     "test/helper.rb",
+     "test/test_cache_utils.rb",
+     "test/test_varnish_interface.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.summary = %q{Rails drop in for Varnish support.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_cache_utils.rb",
+     "test/test_varnish_interface.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
+    else
+    end
+  else
+  end
+end
+

data/lib/generators/lacquer_generator.rb

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

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,5 @@
+Lacquer.configure do |config|
+  config.enable_cache = true
+  config.default_ttl = 1.week
+  config.varnish_servers << { :host => '0.0.0.0', :port => 6082 }
+end

data/lib/generators/templates/varnish.sample.vcl

@@ -0,0 +1,117 @@
+backend default {
+  .host = "0.0.0.0";
+  .port = "10000";
+}
+
+
+#
+# Handling of requests that are received from clients.
+# First decide whether or not to lookup data in the cache.
+#
+sub vcl_recv {
+  # Pipe requests that are non-RFC2616 or CONNECT which is weird.
+  if (req.request != "GET" &&
+      req.request != "HEAD" &&
+      req.request != "PUT" &&
+      req.request != "POST" &&
+      req.request != "TRACE" &&
+      req.request != "OPTIONS" &&
+      req.request != "DELETE") {
+    pipe;
+  }
+
+  # Pass requests that are not GET or HEAD
+  if (req.request != "GET" && req.request != "HEAD") {
+    pass;
+  }
+
+  # Pass requests that we know we aren't caching
+  if (req.url ~ "^/admin") {
+    pass;
+  }
+
+  #
+  # Everything below here should be cached
+  #
+
+  # Handle compression correctly. Varnish treats headers literally, not
+  # semantically. So it is very well possible that there are cache misses
+  # because the headers sent by different browsers aren't the same.
+  # @see: http://varnish.projects.linpro.no/wiki/FAQ/Compression
+  if (req.http.Accept-Encoding) {
+    if (req.http.Accept-Encoding ~ "gzip") {
+      # if the browser supports it, we'll use gzip
+      set req.http.Accept-Encoding = "gzip";
+    } elsif (req.http.Accept-Encoding ~ "deflate") {
+      # next, try deflate if it is supported
+      set req.http.Accept-Encoding = "deflate";
+    } else {
+      # unknown algorithm. Probably junk, remove it
+      remove req.http.Accept-Encoding;
+    }
+  }
+
+  # Clear cookie and authorization headers, set grace time, lookup in the cache
+  unset req.http.Cookie;
+  unset req.http.Authorization;
+  set req.grace = 30s;
+  lookup;
+}
+
+#
+# Called when entering pipe mode
+#
+sub vcl_pipe {
+  # If we don't set the Connection: close header, any following
+  # requests from the client will also be piped through and
+  # left untouched by varnish. We don't want that.
+  set req.http.connection = "close";
+  pipe;
+}
+
+#
+# Called when the requested object has been retrieved from the
+# backend, or the request to the backend has failed
+#
+sub vcl_fetch {
+  # Do not cache the object if the backend application does not want us to.
+  if (obj.http.Cache-Control ~ "(no-cache|no-store|private|must-revalidate)") {
+    pass;
+  }
+
+  # Do not cache the object if the status is not in the 200s
+  if (obj.status >= 300) {
+    # Remove the Set-Cookie header
+    remove obj.http.Set-Cookie;
+    pass;
+  }
+
+  #
+  # Everything below here should be cached
+  #
+
+  # Remove the Set-Cookie header
+  remove obj.http.Set-Cookie;
+
+  # Set the grace time
+  set obj.grace = 30s;
+
+  # Deliver the object
+  deliver;
+}
+
+#
+# Called before the response is sent back to the client
+#
+sub vcl_deliver {
+  # Force browsers and intermediary caches to always check back with us
+  set resp.http.Cache-Control = "private, max-age=0, must-revalidate";
+  set resp.http.Pragma = "no-cache";
+
+  # Add a header to indicate a cache HIT/MISS
+  if (obj.hits > 0) {
+    set resp.http.X-Cache = "HIT";
+  } else {
+    set resp.http.X-Cache = "MISS";
+  }
+}

data/lib/lacquer/cache_utils.rb

@@ -0,0 +1,41 @@
+module Lacquer
+  module CacheUtils
+    def self.included(base)
+      base.class_eval do
+        attr_reader :cache_ttl
+
+        before_filter :set_default_cache_ttl
+        after_filter :send_cache_control_headers
+      end
+    end
+
+    # Instance variable for the action ttl.
+    def set_cache_ttl(ttl)
+      @cache_ttl = ttl
+    end
+
+    # Called as a before filter to set default ttl
+    # for the entire application.
+    def set_default_cache_ttl
+      set_cache_ttl(Lacquer.configuration.default_ttl)
+    end
+
+    # Sends url.purge command to varnish to clear cache.
+    #
+    # 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)
+      end
+    end
+    
+    # Sends cache control headers with page.
+    # 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)
+      end
+    end
+  end
+end

data/lib/lacquer/configuration.rb

@@ -0,0 +1,27 @@
+module Lacquer
+  class Configuration
+    OPTIONS = [ :varnish_servers ]
+
+    # Enable cache
+    attr_accessor :enable_cache
+
+    # Varnish servers
+    attr_accessor :varnish_servers
+
+    # Application default ttl
+    attr_accessor :default_ttl
+
+    def initialize
+      @enable_cache = true
+      @varnish_servers = []
+      @default_ttl = 1.week
+    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/varnish_interface.rb

@@ -0,0 +1,17 @@
+module Lacquer
+  class VarnishInterface
+    def self.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)
+        rescue Exception => e
+          raise VarnishError.new("Error while trying to connect to #{server[:host]}:#{server[:port]} #{e}")
+        end
+      end
+    end
+  end
+end

data/lib/lacquer.rb

@@ -0,0 +1,24 @@
+require 'net/telnet'
+require 'active_support/time'
+
+require 'lacquer/configuration'
+require 'lacquer/cache_utils'
+require 'lacquer/varnish_interface'
+
+module Lacquer
+  class VarnishError < Exception; end
+
+  class << self
+    attr_accessor :configuration
+
+    # Call this method to modify defaults in your initailizers.
+    #
+    # Lacquer.configure do |config|
+    #   config.varnish_servers << { :host => '0.0.0.0', :port => 6082, :timeout => 5 }
+    # end
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+puts "testing this here..."
+
+require 'lacquer'

data/test/helper.rb

@@ -0,0 +1,11 @@
+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'
+
+class Test::Unit::TestCase
+end

data/test/test_cache_utils.rb

@@ -0,0 +1,36 @@
+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')
+  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

@@ -0,0 +1,30 @@
+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(:puts)
+
+    @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::VarnishInterface.send_command('url.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::VarnishInterface.send_command('url.purge /')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: lacquer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Russ Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Rails drop in for Varnish support.
+email: russ@bashme.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lacquer.gemspec
+- lib/generators/lacquer_generator.rb
+- lib/generators/templates/initializer.rb
+- lib/generators/templates/varnish.sample.vcl
+- lib/lacquer.rb
+- lib/lacquer/cache_utils.rb
+- lib/lacquer/configuration.rb
+- lib/lacquer/varnish_interface.rb
+- rails/init.rb
+- test/helper.rb
+- test/test_cache_utils.rb
+- test/test_varnish_interface.rb
+has_rdoc: true
+homepage: http://github.com/russ/lacquer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+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