purgeable 0.0.1 → 0.1.0

data/GEM_VERSION

@@ -0,0 +1 @@
+v0.1.0

data/README.md

@@ -0,0 +1,91 @@
+# Purgeable
+
+Purge contents from shared caches easily by sending a HTTP method "PURGE".
+
+## Configuration
+
+Configuration file structure:
+
+```yaml
+# ./purgeable.yml
+sample: &sample
+  http_cache:
+    - resource_hosts:
+        - "www.example.com"
+        - "www2.example.com"
+      cache_locations:
+        - "varnish1.example.com"
+        - "varnish2.example.com"
+    - resource_hosts:
+        - "www3.example.com"
+        - "www4.example.com"
+      cache_locations:
+        - "varnish3.example.com"
+        - "varnish4.example.com"
+
+production:
+  <<: *sample
+```
+
+Configuration load example:
+
+```ruby
+Purgeable.load_settings("./purgeable.yml", "production")
+```
+
+## Rails generators
+
+Rails 2 generator:
+
+```bash
+$ script/generate purgeable_install
+      create  config/purgeable.yml
+```
+
+Rails 3 generator:
+
+```bash
+$ script/rails generate purgeable:install
+      create  config/purgeable.yml
+```
+
+## Usage
+
+Simple usage:
+
+```ruby
+client = Purgeable::Client.new
+urls = %w[
+  http://www.example.com/article/my-example
+  http://www3.example.com/article/id/1234
+]
+client.purge(urls)  # => {
+                    #      "http://www.example.com/article/my-example" => {
+                    #          "varnish1.example.com" => #<Net::HTTPOK 200 Purged readbody=true>,
+                    #          "varnish2.example.com" => #<Net::HTTPOK 200 Purged readbody=true>
+                    #        },
+                    #      "http://www3.example.com/article/id/1234" => {
+                    #          "varnish3.example.com" => #<Net::HTTPOK 200 Purged readbody=true>,
+                    #          "varnish4.example.com" => #<Net::HTTPOK 200 Purged readbody=true>
+                    #        },
+                    #    }
+```
+
+Model helpers usage:
+
+```ruby
+class Article < ActiveRecord::Base
+  include Purgeable::HttpResource
+
+  def resource_url
+    "http://www3.example.com/article/id/#{id}"
+  end
+
+  http_purge { "http://www.example.com/article/#{friendly_title}" }
+  http_purge :resource_url
+
+  after_save :perform_purge  # send the HTTP PURGE to configured caches on save
+end
+```
+
+Enjoy it.

data/generators/purgeable/purgeable_install_generator.rb

@@ -0,0 +1,27 @@
+require 'rbconfig'
+
+class PurgeableInstallGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file "purgeable.yml", "config/purgeable.yml"
+    end
+  end
+
+  def self.gem_root
+    File.expand_path('../../../', __FILE__)
+  end
+
+  def self.source_root
+    File.join(gem_root, 'templates', 'install')
+  end
+
+  def source_root
+    self.class.source_root
+  end
+
+  private
+
+  def banner
+    "Usage: #{$0} purgeable_install"
+  end
+end

data/lib/generators/purgeable/install_generator.rb

@@ -0,0 +1,19 @@
+require 'rbconfig'
+
+module Purgeable
+  class InstallGenerator < ::Rails::Generators::Base
+
+    def generate
+      copy_file "purgeable.yml", "config/purgeable.yml"
+    end
+
+    def self.gem_root
+      File.expand_path("../../../../", __FILE__)
+    end
+
+    def self.source_root
+      File.join(gem_root, 'templates/install')
+    end
+
+  end
+end

data/lib/purgeable.rb

@@ -2,7 +2,9 @@
 module Purgeable
   autoload :HttpResource, "purgeable/http_resource"
   autoload :Client, "purgeable/client"
+  autoload :VERSION, "purgeable/version"
 end
 
 require "purgeable/http/purge"
 require "purgeable/settings"
+require "purgeable/railtie" if defined?(::Rails) && defined?(::Rails::Railtie)

data/lib/purgeable/client.rb

@@ -2,15 +2,22 @@
 module Purgeable
   class Client
     def purge(urls)
+      purge_all(urls)
+    end
+
+  private
+    def purge_all(urls, responses = {})
       if urls.is_a?(String)
-        cache_locations_for(urls).map{ |location| perform_purge(location, urls) }
+        cache_locations_for(urls).each do |location|
+          next if (responses[urls] ||= {}).has_key?(location)
+          responses[urls][location] = perform_purge(location, urls)
+        end
       elsif urls.is_a?(Array)
-        urls.map{ |url| purge(url) }
+        urls.each{ |url| purge_all(url, responses) }
       end
+      responses
     end
 
-  private
-
     def perform_purge(location, url)
       ip, port = location.split(/:/)
       port = 80 if port.nil? || port.empty?

data/lib/purgeable/http_resource.rb

@@ -16,7 +16,7 @@ module Purgeable
     end
 
     def perform_purge
-      perform_purge! rescue []
+      perform_purge! rescue {}
     end
 
   private

data/lib/purgeable/railtie.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+module Purgeable
+  class Railtie < ::Rails::Railtie
+    initializer "setup http cache" do
+      config_file = ::Rails.root.join("config/purgeable.yml")
+      if File.exists? config_file
+        Purgeable.load_settings config_file, ::Rails.env
+      else
+        puts "Purgeable config not found. Create a config file at: config/purgeable.yml"
+        puts "to generate one run: rails generate purgeable:install"
+      end
+    end
+  end
+end

data/lib/purgeable/settings.rb

@@ -6,19 +6,32 @@ require "methodize"
 module Purgeable
   SETTINGS = {}.extend ::Methodize
 
-  def self.load_settings file_path, env
+  def self.load_settings(file_path, env)
     raise "Invalid config location: #{file_path.inspect}" unless File.exists? file_path
     config = YAML.load(ERB.new(File.read(file_path)).result)[env]
     SETTINGS.merge! config if config.is_a?(Hash)
-    if defined? ::MethodizedHash
-      SETTINGS.http_cache.each do |cfg|
-        cfg.extend ::Methodize unless cfg.kind_of?(MethodizedHash)
-      end
-    end
+    normalize_settings
   end
 
-  if defined? ::Rails
-    config_file = ::Rails.root.join("config/purgeable.yml")
-    load_settings config_file, ::Rails.env if File.exists? config_file
+  private
+
+  def self.normalize_settings
+    SETTINGS["http_cache"] = [] unless SETTINGS.http_cache.is_a?(Array)
+    SETTINGS.http_cache.each do |cfg|
+      next unless cfg.is_a?(Hash)
+      cfg.extend ::Methodize if defined?(::MethodizedHash) && !cfg.kind_of?(MethodizedHash)
+      cfg["cache_locations"] =
+        case cfg["cache_locations"]
+        when String then [cfg["cache_locations"]]
+        when Array then cfg["cache_locations"]
+        else []
+        end
+      cfg["resource_hosts"] =
+        case cfg["resource_hosts"]
+        when String then [cfg["resource_hosts"]]
+        when Array then cfg["resource_hosts"]
+        else []
+        end
+    end
   end
 end

data/lib/purgeable/version.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+module Purgeable
+  version = nil
+  version_file = ::File.expand_path('../../../GEM_VERSION', __FILE__)
+  version = File.read(version_file) if version.nil? && ::File.exists?(version_file)
+  version = $1 if version.nil? && ::File.expand_path('../..', __FILE__) =~ /\/purgeable-(\d+(?:\.\d+)+)/
+  if version.nil? && ::File.exists?(::File.expand_path('../../../.git', __FILE__))
+    begin
+      require 'step-up'
+      version = ::StepUp::Driver::Git.new.last_version_tag("HEAD", true)
+    rescue
+      version = "v0.0.0"
+    end
+    ::File.open(version_file, "w"){ |f| f.write version }
+  end
+  VERSION = version.gsub(/^v?([^\+]+)\+?\d*$/, '\1')
+end

data/rails/init.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+config_file = ::Rails.root.join("config/purgeable.yml")
+if File.exists? config_file
+  Purgeable.load_settings config_file, ::Rails.env
+else
+  puts "Purgeable config not found. Create a config file at: config/purgeable.yml"
+  puts "to generate one run: script/generate purgeable_install"
+end
+

data/templates/install/purgeable.yml

@@ -0,0 +1,23 @@
+sample: &sample
+  http_cache:
+    - resource_hosts:
+        - "www1.example.com"
+        - "www2.example.com"
+      cache_locations:
+        - "varnish1.example.com"
+        - "varnish2.example.com"
+    - resource_hosts:
+        - "www3.example.com"
+        - "www4.example.com"
+      cache_locations:
+        - "varnish3.example.com"
+        - "varnish4.example.com"
+
+development:
+  <<: *sample
+
+test:
+  http_cache: []
+
+production:
+  http_cache: []

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: purgeable
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Marcelo Manzan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-14 00:00:00 Z
+date: 2012-03-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: methodize
@@ -90,11 +90,19 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.md
+- generators/purgeable/purgeable_install_generator.rb
+- lib/generators/purgeable/install_generator.rb
 - lib/purgeable.rb
 - lib/purgeable/client.rb
 - lib/purgeable/http/purge.rb
 - lib/purgeable/http_resource.rb
+- lib/purgeable/railtie.rb
 - lib/purgeable/settings.rb
+- lib/purgeable/version.rb
+- rails/init.rb
+- templates/install/purgeable.yml
+- GEM_VERSION
 homepage: http://github.com/abril/
 licenses: []