CacheGorilla 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-07-10
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/CacheGorilla.rb
+script/console
+script/destroy
+script/generate
+spec/CacheGorilla_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,3 @@
+
+For more information on CacheGorilla, see http://github.com/timrosenblatt/CacheGorilla/
+

data/README.rdoc

@@ -0,0 +1,57 @@
+= CacheGorilla
+
+http://www.animalpictures1.com/data/media/65/gorilla-7.jpg
+
+* http://github.com/timrosenblatt/CacheGorilla
+
+== DESCRIPTION:
+
+Let's say you've got a MongoDB server, being used as a key-value store for an app being served by three sticky-load-balanced web servers. Running an instance of memcached will speed up repeated reads. 
+
+=== tl;dr
+
+This speeds up MongoDB by using antimatter and solar rays.
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  include CacheGorilla
+  
+  @cg = CacheGorilla.new
+  @cg["key"] = "value"
+
+== REQUIREMENTS:
+
+* You need either the `memcached` or `memcache-client` gem, and the `mongo` gem
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Tim Rosenblatt
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/CacheGorilla'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'CacheGorilla' do
+  self.developer 'Tim', 'Rosenblatt'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/CacheGorilla.rb

@@ -0,0 +1,100 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module CacheGorilla
+  VERSION = '0.0.1'
+  
+  begin
+    require "memcached"
+    MemCache = Memcached
+  rescue LoadError
+    begin
+      require "memcache"
+    rescue LoadError
+      puts "You need either the `memcached` or `memcache-client` gem"
+      exit
+    end
+  rescue
+    puts "You need either the `memcached` or `memcache-client` gem"
+    exit
+  end
+
+  begin
+    require "mongo"
+  rescue LoadError
+    puts "You need the mongo gem"
+    exit
+  end
+
+  # This code is heavily inspired by Yehuda's Moneta (http://github.com/wycats/moneta)
+  class CacheGorilla
+    # :server sets up memcache, :host sets up mongo
+    def initialize(options = {})
+      @options = {
+        :host => ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost',
+        :port => ENV['MONGO_RUBY_DRIVER_PORT'] || 27017,
+        :db => 'cache',
+        :collection => 'cache',
+        :server => 'localhost'
+      }.update(options)
+
+      @mongo_connection = Mongo::Connection.new(@options[:host], @options[:port], :pool_size => 5, :timeout => 5)
+      @mongo_collection = @mongo_connection.db(@options[:db]).collection(@options[:collection])
+      
+      @memcache = MemCache.new(options[:server], @options)
+    end
+
+    def key?(key)
+      !!self[key]
+    end
+    
+    alias has_key? key?
+
+    def [](key)      
+      begin
+        @memcache.get(key)
+      rescue Memcached::NotFound
+        res = @mongo_collection.find({'_id' => key}).first
+        res = nil if res && res['expires'] && Time.now > res['expires']
+        
+        if res
+          args = [res['_id'], res['data'], res['expires']].compact
+          @memcache.set(*args)
+        end
+        
+        res && res['data']
+      end
+    end
+
+    def []=(key, value)
+      store(key, value)
+    end
+
+    def delete(key)
+      # todo What's the best way to run these two calls at once, given that it's very much one-at-a-time
+      value = self[key]
+      @mongo_collection.remove('_id' => key) if value
+      @memcache.delete(key) if value
+      value
+    end
+    
+    # Pass an option of :bypass_memcache if you want. Set the key to any value.
+    def store(key, value, options = {})
+      # todo What's the best way to run these two calls at once, given that it's very much one-at-a-time
+      exp = options[:expires_in] ? (Time.now + options[:expires_in]) : nil
+      @mongo_collection.update({ '_id' => key }, { '_id' => key, 'data' => value, 'expires' => exp }, { :upsert => true }) # upsert is the best technical term ever.
+      
+      unless options.has_key?(:bypass_memcache)
+        args = [key, value, options[:expires_in]].compact
+        @memcache.set(*args)
+      end
+      
+      value
+    end
+
+    def clear
+      @mongo_connection.drop_database(@options[:db])
+      @memcache.flush
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/CacheGorilla.rb'}"
+puts "Loading CacheGorilla gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/CacheGorilla_spec.rb

@@ -0,0 +1,102 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# For sneaking a peek during testing
+module CacheGorilla
+  class CacheGorilla
+    # attr_accessor :memcache, :mongo_collection
+  
+    def mongo_get(key)
+      @mongo_collection.find({'_id' => key}).first['data']
+    end
+  
+    def mongo_set(key, value)
+      @mongo_collection.update({ '_id' => key }, { '_id' => key, 'data' => value, 'expires' => nil }, { :upsert => true })
+    end
+  
+    def memcache_get(key)
+      @memcache.get(key)
+    rescue Memcached::NotFound
+      nil
+    end
+  
+    def memcache_set(key, value)
+      args = [key, value]
+      @memcache.set(*args)
+    end
+  end
+end
+
+describe "CacheGorilla" do
+  include CacheGorilla
+  
+  before(:each) do
+    @cg = CacheGorilla.new(:db => "cache_gorilla_test")
+  end
+  
+  after(:each) do
+    @cg.clear
+  end
+  
+  it "can set and get values" do
+    @cg.key?("Unicorns!").should be_false
+    
+    @cg["Unicorns!"] = "Ponies!"
+    
+    @cg["Unicorns!"].should == "Ponies!"
+  end
+  
+  it "can check for the presence of a key" do
+    @cg.key?("Scrooge").should be_false
+    
+    @cg["Scrooge"] = "Christmas Spirit"
+    
+    @cg.key?("Scrooge").should be_true
+  end
+  
+  it "can delete keys" do
+    @cg["Unicorns!"] = "Ponies!"
+    @cg.delete("Unicorns!")
+    
+    @cg.key?("Unicorns!").should be_false
+  end
+  
+  it "respects expirations" do
+    @cg.store("key", "value", { :expires_in => 5 })
+    sleep(6)
+    @cg["key"].should be_nil
+  end
+  
+  it "fills memcache on cache misses" do
+    @cg.memcache_get("key").should be_nil
+    @cg.mongo_set("key", "value")
+    
+    @cg["key"].should == "value"
+    
+    @cg.memcache_get("key").should == "value"
+  end
+  
+  it "returns nil when a key is not found" do
+    @cg["EasterBunny"].should be_nil
+  end
+  
+  it "sets values in both memcache and mongo" do
+    @cg["key"] = "value"
+    
+    @cg.mongo_get("key").should == "value"
+    @cg.memcache_get("key").should == "value"
+  end
+  
+  it "caches" do
+    @cg["key"] = "value"
+    @cg.mongo_set("key", "not the value")
+    
+    @cg["key"].should == "value"
+  end
+  
+  it "can bypass memcache" do
+    @cg.store("key", "value", :bypass_memcache => true)
+    
+    @cg.memcache_get("key").should be_nil
+    @cg["key"].should == "value"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'CacheGorilla'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: CacheGorilla
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-10 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id002
+description: Let's say you've got a MongoDB server, being used as a key-value store for an app being served by three sticky-load-balanced web servers. Running an instance of memcached will speed up repeated reads.
+email: 
+- Rosenblatt
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/CacheGorilla.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/CacheGorilla_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://www.animalpictures1.com/data/media/65/gorilla-7.jpg
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: CacheGorilla
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Let's say you've got a MongoDB server, being used as a key-value store for an app being served by three sticky-load-balanced web servers
+test_files: []
+