lacquer 0.4.0 → 0.4.1

data/Gemfile

@@ -1,4 +1,4 @@
-source :gemcutter
+source 'http://rubygems.org'
 
 gem "activesupport", "3.0.1"
 gem "i18n", "0.4.1"

data/Gemfile.lock

@@ -3,15 +3,12 @@ GEM
   specs:
     activesupport (3.0.1)
     diff-lcs (1.1.2)
-    gemcutter (0.5.0)
-      json_pure
     git (1.2.5)
     i18n (0.4.1)
-    jeweler (1.4.0)
-      gemcutter (>= 0.1.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
       git (>= 1.2.5)
-      rubyforge (>= 2.0.0)
-    json_pure (1.4.6)
+      rake
     rake (0.8.7)
     rspec (2.0.0)
       rspec-core (= 2.0.0)
@@ -23,9 +20,7 @@ GEM
     rspec-mocks (2.0.0)
       rspec-core (= 2.0.0)
       rspec-expectations (= 2.0.0)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
-    yard (0.6.1)
+    yard (0.6.4)
 
 PLATFORMS
   ruby

data/README.rdoc

@@ -21,7 +21,7 @@ config/initializers/lacquer.rb
 
     # Array of Varnish servers to manage
     config.varnish_servers << {
-      :host => "0.0.0.0", :port => 6082
+      :host => "0.0.0.0", :port => 6082 # if you have authentication enabled, add :secret => "your secret"
     }
 
     # Number of retries
@@ -72,11 +72,11 @@ As a result, all you have to do to set a cacheable action is the before filter a
 
 == 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.
+* 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
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lacquer.gemspec

@@ -1,61 +1,59 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{lacquer}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Russ Smith (russ@bashme.org)", "Ryan Johns", "Garry Tan (garry@posterous.com), Gabe da Silveira (gabe@websaviour.com)"]
-  s.date = %q{2010-11-03}
+  s.date = %q{2010-12-28}
   s.description = %q{Rails drop in for Varnish support.}
   s.email = %q{russ@bashme.org}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
     ".bundle/config",
-     ".document",
-     ".gitignore",
-     "Gemfile",
-     "Gemfile.lock",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "init.rb",
-     "lacquer.gemspec",
-     "lib/generators/lacquer/USAGE",
-     "lib/generators/lacquer/install_generator.rb",
-     "lib/generators/lacquer/templates/initializer.rb",
-     "lib/generators/lacquer/templates/varnish.sample.vcl",
-     "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.rb",
-     "rails/init.rb",
-     "spec/lacquer/cache_utils_spec.rb",
-     "spec/lacquer/delayed_job_job_spec.rb",
-     "spec/lacquer/resque_job_spec.rb",
-     "spec/lacquer/varnish_spec.rb",
-     "spec/spec_helper.rb"
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "lacquer.gemspec",
+    "lib/generators/lacquer/USAGE",
+    "lib/generators/lacquer/install_generator.rb",
+    "lib/generators/lacquer/templates/initializer.rb",
+    "lib/generators/lacquer/templates/varnish.sample.vcl",
+    "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.rb",
+    "rails/init.rb",
+    "spec/lacquer/cache_utils_spec.rb",
+    "spec/lacquer/delayed_job_job_spec.rb",
+    "spec/lacquer/resque_job_spec.rb",
+    "spec/lacquer/varnish_spec.rb",
+    "spec/spec_helper.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.7}
   s.summary = %q{Rails drop in for Varnish support.}
   s.test_files = [
     "spec/lacquer/cache_utils_spec.rb",
-     "spec/lacquer/delayed_job_job_spec.rb",
-     "spec/lacquer/resque_job_spec.rb",
-     "spec/lacquer/varnish_spec.rb",
-     "spec/spec_helper.rb"
+    "spec/lacquer/delayed_job_job_spec.rb",
+    "spec/lacquer/resque_job_spec.rb",
+    "spec/lacquer/varnish_spec.rb",
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -63,11 +61,29 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["= 3.0.1"])
+      s.add_runtime_dependency(%q<i18n>, ["= 0.4.1"])
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<rspec>, ["= 2.0.0"])
+      s.add_runtime_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
     else
+      s.add_dependency(%q<activesupport>, ["= 3.0.1"])
+      s.add_dependency(%q<i18n>, ["= 0.4.1"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["= 2.0.0"])
+      s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 1.3.0"])
     end
   else
+    s.add_dependency(%q<activesupport>, ["= 3.0.1"])
+    s.add_dependency(%q<i18n>, ["= 0.4.1"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["= 2.0.0"])
+    s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 1.3.0"])
   end
 end

data/lib/generators/lacquer/templates/initializer.rb

@@ -10,7 +10,7 @@ Lacquer.configure do |config|
 
   # Array of Varnish servers to manage
   config.varnish_servers << {
-    :host => "0.0.0.0", :port => 6082
+    :host => "0.0.0.0", :port => 6082 # if you have authentication enabled, add :secret => "your secret"
   }
 
   # Number of retries

data/lib/lacquer/varnish.rb

@@ -29,6 +29,31 @@ 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!
+              salt = matchdata[1]
+              if(salt.empty?)
+                raise VarnishError, "Bad authentication request"
+              end
+              
+              digest = OpenSSL::Digest::Digest.new('sha256')
+              digest << salt
+              digest << "\n"
+              digest << server[:secret]
+              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"
+                end
+              end
+            end
+          end
+          
           connection.cmd('String' => command, 'Match' => /\n\n/) {|r| response = r.split("\n").first.strip}
           connection.close
         rescue Exception => e

data/lib/lacquer.rb

@@ -1,5 +1,9 @@
 require "rubygems"
 require "net/telnet"
+
+require "openssl"
+require "digest/sha2"
+
 require "active_support/core_ext"
 
 require "lacquer/configuration"
@@ -8,6 +12,7 @@ require "lacquer/varnish"
 
 module Lacquer
   class VarnishError < Exception; end # @private
+  class AuthenticationError < VarnishError; end # @private
 
   class << self
     attr_accessor :configuration

data/spec/lacquer/varnish_spec.rb

@@ -33,6 +33,49 @@ describe "Varnish" do
         Lacquer::Varnish.new.purge('/')
       end
     end
+    
+    describe "when using authentication" do
+      after(:each) do
+        Lacquer.configuration.varnish_servers.first[:secret] = nil
+      end
+      describe "with correct secret" do
+        before(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = "the real secret"
+        end
+
+        it "should return successfully when using correct secret" 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
+        end
+
+        after(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = nil
+        end
+      end
+
+      describe "with wrong secret" do
+        before(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = "the wrong secret"
+        end
+        it "should raise Lacquer::AuthenticationError when using wrong secret" 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 49725ec6723b64774a7ab918a24cba811130e99b7ac4b4c9d21ce9a8144762c8", "Match" => /\d{3}/).and_yield('107')
+          @telnet_mock.stub!(:cmd).with("url.purge /").and_yield('200')
+
+          lambda {
+            Lacquer::Varnish.new.purge('/')
+          }.should raise_error(Lacquer::VarnishError)
+        end
+        after(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = nil
+        end
+      end
+    end
 
     describe "when connection is unsuccessful and an error handler is set" do
       before(:each) do
@@ -46,6 +89,7 @@ describe "Varnish" do
         }.should_not raise_error(Lacquer::VarnishError)
       end
     end
+    
   end
 
   describe "when sending a stats command" do
@@ -125,7 +169,7 @@ Closing CLI connection
 
   describe "when sending a purge command" do 
     it "should return successfully" do
-      @telnet_mock.stub!(:cmd).and_yield('200')
+      @telnet_mock.stub!(:cmd).with("String" => "url.purge /", "Match" => /\n\n/).and_yield('200')
       Lacquer::Varnish.new.purge('/').should be(true)
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lacquer
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Russ Smith (russ@bashme.org)
@@ -17,14 +17,104 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 -07:00
+date: 2010-12-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: activesupport
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 0
+        - 1
+        version: 3.0.1
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: i18n
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 4
+        - 1
+        version: 0.4.1
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: rake
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: rspec
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: yard
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
   name: rspec
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -35,7 +125,7 @@ dependencies:
         - 3
         - 0
         version: 1.3.0
-  requirement: *id001
+  requirement: *id007
 description: Rails drop in for Varnish support.
 email: russ@bashme.org
 executables: []
@@ -48,7 +138,6 @@ extra_rdoc_files:
 files: 
 - .bundle/config
 - .document
-- .gitignore
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -78,8 +167,8 @@ homepage: http://github.com/russ/lacquer
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

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