background_cache 0.1.4 → 0.2.0

data/README.md

@@ -3,62 +3,79 @@ BackgroundCache
 
 Bust caches before your users do (in your Rails app).
 
+Works with [memcache-client](https://github.com/mperham/memcache-client), [Dalli](https://github.com/mperham/dalli), or [memcached](https://github.com/fauna/memcached).
+
 Requirements
 ------------
 
-<pre>
-sudo gem install background_cache
-</pre>
-
-### config/environment.rb
-
-<pre>
-config.gem 'background_cache'
-</pre>
+    gem install background_cache
 
 Dynamic Configuration
 ---------------------
 
-Create *lib/background\_cache\_config.rb*:
+Create `lib/background_cache_config.rb` in your Rails app:
 
-<pre>
-BackgroundCache::Config.new do
+    BackgroundCache::Config.new do
 
-  # Configure a background cache in one call
-  
-  Tag::League.find(:all).each do |tag|
-    cache(
-      # Route params
-      :controller => 'sections',
-      :action => 'teams',
-      :tag => tag.permalink,
+      # Configure using block methods
       
-      # Background cache options
-      :group => 'every_hour',
-      :layout => false,
-      :only => "sections_teams_#{tag.permalink}"
-    )
-  end
-  
-  # Configure using block methods
-  
-  group('every_hour').layout(false).only("sections_teams_#{tag.permalink}") do
-    Tag::League.find(:all).each do |tag|
-      cache("/#{tag.permalink}")
-    end
-  end
-end
-</pre>
+      group('every_hour').layout(false).only("sections_teams_#{tag.permalink}") do
+        Tag::League.find(:all).each do |tag|
+          cache(:path => "/#{tag.permalink}")
+        end
+      end
 
-The <code>cache</code> method takes route parameters or a path.
+      # Configure using options
+      
+      Tag::League.find(:all).each do |tag|
+        cache(
+          # Route params
+          :controller => 'sections',
+          :action => 'teams',
+          :tag => tag.permalink,
 
-The <code>only</code> and <code>except</code> methods/options take fragment ids or arrays of fragment ids.
+          # Or specify a path
+          :path => "/#{tag.permalink}",
+          
+          # Background cache options
+          :group => 'every_hour',
+          :layout => false,
+          :only => "sections_teams_#{tag.permalink}"
+        )
+      end
+    end
+
+The `only` and `except` options take cache fragment ids or arrays of cache fragment ids.
 
 If no fragment is specified, all of the action's caches will regenerate.
 
-Rake task
+Rake Task
 ---------
 
-Add <code>rake background_cache</code> to cron. All cache configurations are busted every time it is run.
+Add `rake background_cache` to cron. All cache configurations are busted every time it is run.
+
+To run a specific group of caches, run `rake background_cache[every_hour]` (as per the example above).
+
+Daemon Mode
+-----------
+
+Create `config/background_cache.yml` in your Rails app:
+
+    redis: localhost:6379/0
+
+Start a `background_cache` daemon from your Rails app:
+
+    $ cd path/to/app
+    $ background_cache
+
+Run caches via Ruby:
+
+    require 'background_cache'
+
+    client = BackgroundCache::Client.new('/path/to/app')
+
+    # Cache group
+    client.cache(:group => "every_hour")
 
-To run a specific group of caches, run <code>rake background\_cache[every\_hour]</code> (as per the example above).
+    # Manual cache
+    client.cache(:path => "/")

data/background_cache.gemspec

@@ -6,7 +6,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "background_cache"
-  s.version     = '0.1.4'
+  s.version     = '0.2.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = [ "Winton Welsh" ]
   s.email       = [ "mail@wintoni.us" ]
@@ -22,4 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rack-test", "= 0.5.3"
   s.add_development_dependency "rails", "= 2.3.10"
   s.add_development_dependency "rspec", "~> 1.0"
+
+  s.add_dependency "redis", "~> 2.2.2"
+  s.add_dependency "yajl-ruby", "~> 1.0.0"
 end

data/bin/background_cache

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
 
-require File.expand_path("../../lib/background_cache", __FILE__)
+require File.expand_path("../../lib/background_cache/daemon", __FILE__)
+
+BackgroundCache::Daemon.new(Dir.pwd)

data/lib/background_cache/client.rb

@@ -0,0 +1,46 @@
+module BackgroundCache
+  class Client
+
+    attr_reader :redis_1, :redis_2
+
+    def initialize(root)
+      if File.exists?(yaml = "#{root}/config/background_cache.yml")
+        options = YAML.load(File.read(yaml))
+      else
+        puts "\nFAIL: config/background_cache.yml not found"
+        shutdown
+      end
+
+      @redis_1 = Redis.connect(:url => "redis://#{options['redis']}")
+      @redis_2 = Redis.connect(:url => "redis://#{options['redis']}")
+    end
+
+    def cache(options)
+      wait = options.delete(:wait)
+      subscribe_to = options[:channel] = Digest::SHA1.hexdigest("#{rand}")
+      options = Yajl::Encoder.encode(options)
+      response = nil
+
+      if wait != false
+        Timeout.timeout(60) do
+          @redis_1.subscribe("background_cache:response:#{subscribe_to}") do |on|
+            on.subscribe do |channel, subscriptions|
+              @redis_2.rpush "background_cache:request", options
+            end
+
+            on.message do |channel, message|
+              if message.include?('[SUCCESS]')
+                response = true
+                @redis_1.unsubscribe
+              end
+            end
+          end
+        end
+      else
+        @redis_1.rpush "background_cache:request", options
+      end
+
+      response
+    end
+  end
+end

data/lib/background_cache/daemon.rb

@@ -0,0 +1,89 @@
+require 'rubygems'
+
+require "digest/sha1"
+require "timeout"
+require "yaml"
+
+gem "yajl-ruby", "~> 1.0.0"
+require "yajl"
+
+gem "redis", "~> 2.2.2"
+require "redis"
+
+module BackgroundCache
+  class Daemon
+
+    def initialize(root)
+      if File.exists?(yaml = "#{root}/config/background_cache.yml")
+        options = YAML.load(File.read(yaml))
+      else
+        puts "\nFAIL: config/background_cache.yml not found"
+        shutdown
+      end
+
+      puts "\nStarting background cache server (redis @ #{options['redis']})..."
+
+      require "#{root}/config/environment.rb"
+      require File.expand_path("../../background_cache", __FILE__)
+
+      instance = BackgroundCache.boot
+      redis = Redis.connect(:url => "redis://#{options['redis']}")
+      retries = 0
+      
+      begin
+        while true
+          request = redis.lpop('background_cache:request')
+          if request
+            Timeout.timeout(60) do
+              request = Yajl::Parser.parse(request)
+              channel = request.delete('channel')
+
+              cache_key = request.to_a.sort { |a, b| a.first <=> b.first }.inspect
+
+              request.keys.each do |key|
+                request[(key.to_sym rescue key) || key] = request.delete(key)
+              end
+              
+              unless redis.get(cache_key)
+                redis.set(cache_key, 1)
+
+                # Timeout incase execution fails
+                redis.expire(cache_key, 5 * 60)
+
+                if request[:group]
+                  BackgroundCache.cache!(request[:group], instance)
+                else
+                  BackgroundCache.manual(
+                    BackgroundCache::Config.build_cache(request),
+                    instance
+                  )
+                end
+
+                redis.del(cache_key)
+                redis.publish(
+                  "background_cache:response:#{channel}",
+                  "[SUCCESS]"
+                )
+              end
+            end
+          end
+
+          sleep(1.0 / 1000.0)
+        end
+      rescue Interrupt
+        shut_down
+      rescue Exception => e
+        puts "\nError: #{e.message}"
+        puts "\t#{e.backtrace.join("\n\t")}"
+        retries += 1
+        shut_down if retries >= 10
+        retry
+      end
+    end
+
+    def shut_down
+      puts "\nShutting down background cache server..."
+      exit
+    end
+  end
+end

data/lib/background_cache.rb

@@ -1,10 +1,20 @@
+require 'rubygems'
+
 gem 'rack-test', '=0.5.3'
 
+gem "yajl-ruby", "~> 1.0.0"
+require "yajl"
+
+gem "redis", "~> 2.2.2"
+require "redis"
+
 require 'digest/sha2'
 require 'rack/test'
+require 'yaml'
 
 $:.unshift File.dirname(__FILE__)
 
+require 'background_cache/client'
 require 'background_cache/config'
 require 'background_cache/controller'
 require 'background_cache/helper'
@@ -24,8 +34,10 @@ module BackgroundCache
     BackgroundCache::Config.current_cache
   end
 
-  def self.cache!(group=nil)
-    instance = self.boot
+  def self.cache!(group=nil, instance=nil)
+    unless instance
+      instance = self.boot
+    end
     BackgroundCache::Config.load!(group)
     caches = BackgroundCache::Config.caches
     caches.each do |cache|

data/rails/init.rb

@@ -1,10 +1,8 @@
-begin
-  require 'memcache'
-rescue LoadError
-end
-
 require File.expand_path('../../lib/background_cache.rb', __FILE__)
 
 ActionController::Base.send(:include, BackgroundCache::Controller)
 ActionView::Helpers::CacheHelper.send(:include, BackgroundCache::Helper)
-::MemCache.send(:include, BackgroundCache::Memcache) if defined?(::MemCache)
+
+::Dalli::Client.send(:include, BackgroundCache::Memcache)    if defined?(::Dalli::Client)
+::MemCache.send(:include, BackgroundCache::Memcache)         if defined?(::MemCache)
+::Memcached::Rails.send(:include, BackgroundCache::Memcache) if defined?(::Memcached::Rails)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: background_cache
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Winton Welsh
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-20 00:00:00 Z
+date: 2011-10-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack-test
@@ -64,6 +64,38 @@ dependencies:
         version: "1.0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 2
+        - 2
+        version: 2.2.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id005
 description: Bust caches before your users do.
 email: 
 - mail@wintoni.us
@@ -83,8 +115,10 @@ files:
 - bin/background_cache
 - init.rb
 - lib/background_cache.rb
+- lib/background_cache/client.rb
 - lib/background_cache/config.rb
 - lib/background_cache/controller.rb
+- lib/background_cache/daemon.rb
 - lib/background_cache/helper.rb
 - lib/background_cache/mem_cache.rb
 - rails/init.rb