shellac 0.0.1

data/.document

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

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "klarlack", "~> 0.0.6"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    klarlack (0.0.6)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  klarlack (~> 0.0.6)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Marian
+
+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 @@
+= shellac
+
+Description goes here.
+
+== Contributing to shellac
+ 
+* 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 Marian. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+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 = "shellac"
+  gem.homepage = "http://github.com/bitflut/shellac"
+  gem.license = "MIT"
+  gem.summary = %Q{Shellac is a gem to easily send purges to varnish servers from rails}
+  gem.description = %Q{Shellac gives you an environment aware helper for purging configured under config/varnish.yml built ontop of Max Schoefmann's klarlack gem}
+  gem.email = "marian@bitflut.com"
+  gem.authors = ["Marian"]
+  # 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 'klarlack', '~> 0.0.6'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shellac #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/generators/shellac/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module Shellac
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+            
+      def generate
+        copy_file "../templates/varnish.yml", "config/varnish.yml"
+        
+        puts "------------------------"
+        puts "Now configure your varnish setup here:"
+        puts "config/varnish.yml"
+        puts "------------------------"
+      end
+      
+    end
+  end
+end

data/lib/generators/templates/varnish.yml

@@ -0,0 +1,25 @@
+# Define varnish for all environments that make use of it.
+# Currently all options must be specified. This will change in a future
+# version to only need definition of non default values of varnish.
+
+# host:       The host which you access your varnish server from. This 
+#             is particularly useful when you cache more than one host
+#             with one varnish instance (default: localhost)
+
+# post:       The port of your varnish telnet server (default: 6082)
+
+# timeout:    Timeout in seconds when connecting to varnish (default: 1)
+
+# keep_alive: Set to true, to keep the connection alive (default: false)
+
+development:
+  host: localhost
+  port: 6082
+  timeout: 1
+  keep_alive: false
+  
+production:
+  host: example.com
+  port: 6082
+  timeout: 1
+  keep_alive: false

data/lib/shellac.rb

@@ -0,0 +1,11 @@
+require 'rails'
+require 'klarlack'
+
+class Shellac < Rails::Railtie
+  
+  config.after_initialize do
+    require 'shellac/cache'
+    require 'shellac/actions'
+  end
+
+end

data/lib/shellac/actions.rb

@@ -0,0 +1,12 @@
+module Shellac
+  module Actions
+  
+    def purge regex
+      return unless perform_caching
+      Shellac::Cache.instance.purge regex
+    end
+  
+  end
+end
+
+ActionController::Base.send :include, Shellac::Actions

data/lib/shellac/cache.rb

@@ -0,0 +1,36 @@
+module Shellac
+  class Cache
+    include Singleton
+    
+    VARNISH_CONFIGURATION = YAML.load_file("#{Rails.root.to_s}/config/varnish.yml")[::Rails.env]    
+    
+    # return client instance
+    def client
+      @client ||= Varnish::Client.new  "#{config("host")}:#{config("port")}",
+                                :timeout => config("timeout"),
+                                :keep_alive => config("keep_alive")
+    end
+    
+    # purge a regular expression of url
+    def purge path, recursive=false
+      
+      if recursive
+        regex = "^#{path}" # purge any page starting with regex
+      else
+        regex = "^#{path}$"
+      end
+      
+      # write to log
+      Rails.logger.info "Purging#{" (recursively)" if recursive}: #{path}"
+      
+      # purge with 
+      client.purge "req.http.host ~ ^#{config("host")} && req.url ~ #{regex}"
+    end
+    
+    protected
+    
+      def config attr
+        VARNISH_CONFIGURATION[attr]
+      end
+  end
+end

data/shellac.gemspec

@@ -0,0 +1,73 @@
+# 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{shellac}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marian"]
+  s.date = %q{2011-04-12}
+  s.description = %q{Shellac gives you an environment aware helper for purging configured under config/varnish.yml built ontop of Max Schoefmann's klarlack gem}
+  s.email = %q{marian@bitflut.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/generators/shellac/install_generator.rb",
+    "lib/generators/templates/varnish.yml",
+    "lib/shellac.rb",
+    "lib/shellac/actions.rb",
+    "lib/shellac/cache.rb",
+    "shellac.gemspec",
+    "test/helper.rb",
+    "test/test_shellac.rb"
+  ]
+  s.homepage = %q{http://github.com/bitflut/shellac}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Shellac is a gem to easily send purges to varnish servers from rails}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_shellac.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<klarlack>, ["~> 0.0.6"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<klarlack>, ["~> 0.0.6"])
+    else
+      s.add_dependency(%q<klarlack>, ["~> 0.0.6"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<klarlack>, ["~> 0.0.6"])
+    end
+  else
+    s.add_dependency(%q<klarlack>, ["~> 0.0.6"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<klarlack>, ["~> 0.0.6"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'shellac'
+
+class Test::Unit::TestCase
+end

data/test/test_shellac.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestShellac < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: shellac
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Marian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-12 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: klarlack
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: klarlack
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+description: Shellac gives you an environment aware helper for purging configured under config/varnish.yml built ontop of Max Schoefmann's klarlack gem
+email: marian@bitflut.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/generators/shellac/install_generator.rb
+- lib/generators/templates/varnish.yml
+- lib/shellac.rb
+- lib/shellac/actions.rb
+- lib/shellac/cache.rb
+- shellac.gemspec
+- test/helper.rb
+- test/test_shellac.rb
+has_rdoc: true
+homepage: http://github.com/bitflut/shellac
+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: 3508154638655709638
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Shellac is a gem to easily send purges to varnish servers from rails
+test_files: 
+- test/helper.rb
+- test/test_shellac.rb