varnish_sweeper 0.0.4

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem "resque"
+gem "resque-loner"
+gem "curb"
+#
+group :development do
+  gem "rspec", "~> 2.0.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.0.pre6"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    curb (0.7.9)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    rack (1.2.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    redis (2.1.1)
+    redis-namespace (0.8.0)
+      redis (< 3.0.0)
+    resque (1.10.0)
+      json (~> 1.4.6)
+      redis-namespace (~> 0.8.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    resque-loner (0.1.3)
+      resque (~> 1.0)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    sinatra (1.1.2)
+      rack (~> 1.1)
+      tilt (~> 1.2)
+    tilt (1.2.1)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  curb
+  jeweler (~> 1.5.0.pre6)
+  rcov
+  resque
+  resque-loner
+  rspec (~> 2.0.0)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Daniel Bornkessel
+
+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,19 @@
+= varnish_sweeper
+
+Description goes here.
+
+== Contributing to varnish_sweeper
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Daniel Bornkessel. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "varnish_sweeper"
+  gem.homepage = "http://github.com/kesselborn/varnish_sweeper"
+  gem.license = "MIT"
+  gem.summary = %Q{A few helper functions that help caching web pages}
+  gem.description = %Q{hihih}
+  gem.email = "daniel@moviepilot.com"
+  gem.authors = ["Daniel Bornkessel"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/sweeper_job.rb

@@ -0,0 +1,16 @@
+require 'resque-loner'
+
+class SweeperJob < Resque::Plugins::Loner::UniqueJob
+  @queue = :sweeper
+
+  def self.perform( urls, options = {} )
+    if urls
+      urls.each do |url|
+        Curl::Easy.perform(url) do |curl| 
+          curl.headers["X-Varnish-Control"] = "sweep"
+        end
+        Rails.logger.debug "sweeped #{url}"
+      end
+    end
+  end
+end

data/lib/varnish.rb

@@ -0,0 +1,65 @@
+module Varnish
+  def make_cacheable(options = {})
+    if should_be_cached?(options)
+      headers['Cache-Control'] = cache_control_text(options)
+    end
+
+    if options[:depends_on] && request.headers['X_VARNISH']
+      remember_url_for_obj(request.url, options)
+    end
+  end
+
+  def sweep_cache_for(obj)
+    return unless obj
+    if cache_data = Rails.cache.read( varnish_cache_key(obj) )
+      Rails.cache.delete( varnish_cache_key(obj) )
+      Resque.enqueue(SweeperJob, cache_data[:urls])
+    end
+  end
+
+protected
+  def cache_control_text(options)
+    return unless should_be_cached?(options)
+
+    string_array = []
+    string_array << options[:private] ? "private" : "public"
+
+    string_array << "max-age=%d"  % options[:max_age].to_i   if options[:max_age]
+    string_array << "s-maxage=%d" % options[:s_max_age].to_i if options[:s_max_age]
+
+    string_array.join(", ")
+  end
+
+
+  def remember_url_for_obj(url, options = {})
+    obj = options[:depends_on]
+    cache_key = varnish_cache_key(obj)
+    current_time = Time.now
+
+    expire_times = [current_time]
+    expire_times << current_time + options[:max_age]   if options[:max_age]
+    expire_times << current_time + options[:s_max_age] if options[:s_max_age]
+
+    cached_urls_for_obj = [url]
+    cached_data = Rails.cache.read(cache_key)
+    if cached_data
+      expire_times << cached_data[:expires_at]
+      cached_urls_for_obj = cached_urls_for_obj + cached_data[:urls]
+    end
+
+    # EXPIRE THIS BEAST AT SOME POINT OF TIME
+    Rails.cache.write( cache_key,
+                      {:expires_at => expire_times.max, :urls => cached_urls_for_obj.uniq},
+                      :expires_in => (expire_times.max - Time.now).to_i )
+  end
+
+  def should_be_cached?(options)
+    request.headers['X_VARNISH'] && ( options[:max_age] || options[:s_max_age] )
+  end
+
+  def varnish_cache_key(obj)
+    "varnish_cw_#{obj.class_name}_#{obj.hash}"
+  end
+    
+end
+

data/lib/varnish_sweeper.rb

@@ -0,0 +1,4 @@
+require 'varnish'
+ApplicationController.send(:include, Varnish)
+ActionController::Caching::Sweeper.send(:include, Varnish)
+require 'sweeper_job'

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+class ApplicationController
+end
+
+module ActionController
+  module Caching
+    class Sweeper
+    end
+  end
+end
+
+
+require 'varnish_sweeper'
+require 'rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/varnish_sweeper_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "VarnishSweeper" do
+  it "should provide our functions to the ApplicationController" do
+    ApplicationController.new.should respond_to(:make_cacheable)
+    ApplicationController.new.should respond_to(:sweep_cache_for)
+  end
+
+  it "should provide our functions to the ActionController::Caching::Sweeper" do
+    ActionController::Caching::Sweeper.new.should respond_to(:make_cacheable)
+    ActionController::Caching::Sweeper.new.should respond_to(:sweep_cache_for)
+  end
+
+  it "should make the sweeper job available" do
+    defined?(SweeperJob).should_not be_nil
+  end
+end

data/varnish_sweeper.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{varnish_sweeper}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Bornkessel"]
+  s.date = %q{2011-01-10}
+  s.description = %q{hihih}
+  s.email = %q{daniel@moviepilot.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/sweeper_job.rb",
+    "lib/varnish.rb",
+    "lib/varnish_sweeper.rb",
+    "spec/spec_helper.rb",
+    "spec/varnish_sweeper_spec.rb",
+    "varnish_sweeper.gemspec"
+  ]
+  s.homepage = %q{http://github.com/kesselborn/varnish_sweeper}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A few helper functions that help caching web pages}
+  s.test_files = [
+    "spec/spec_helper.rb",
+    "spec/varnish_sweeper_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<resque>, [">= 0"])
+      s.add_runtime_dependency(%q<resque-loner>, [">= 0"])
+      s.add_runtime_dependency(%q<curb>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.0.pre6"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<resque>, [">= 0"])
+      s.add_dependency(%q<resque-loner>, [">= 0"])
+      s.add_dependency(%q<curb>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.0.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre6"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<resque>, [">= 0"])
+    s.add_dependency(%q<resque-loner>, [">= 0"])
+    s.add_dependency(%q<curb>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.0.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre6"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification 
+name: varnish_sweeper
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- Daniel Bornkessel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-10 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resque-loner
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: curb
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 0
+        - pre6
+        version: 1.5.0.pre6
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+description: hihih
+email: daniel@moviepilot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sweeper_job.rb
+- lib/varnish.rb
+- lib/varnish_sweeper.rb
+- spec/spec_helper.rb
+- spec/varnish_sweeper_spec.rb
+- varnish_sweeper.gemspec
+has_rdoc: true
+homepage: http://github.com/kesselborn/varnish_sweeper
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1409484695132746894
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A few helper functions that help caching web pages
+test_files: 
+- spec/spec_helper.rb
+- spec/varnish_sweeper_spec.rb