openuri_memcached 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-01-14
+
+* Inital release:
+  * Proof of concept come used library for a personal project

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ben Schwarz
+
+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/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/openuri_memcached.rb
+lib/openuri_memcached/openuri_memcached.rb
+lib/openuri_memcached/version.rb
+spec/openuri_cache_spec.rb

data/README.txt

@@ -0,0 +1,24 @@
+OpenURI and MemCached sitting in a tree
+Require the library using 
+  require 'openuri_memcached'
+  
+To get started run your memcached server
+  $ memcached -d 
+The default address that this gem will terminate against is localhost:11211, you can change this using
+  OpenURI::Cache.host = ['serverone.com:11211', 'servertwo:11211']
+
+The cache defaults to 15 minutes, however this can be changed using:
+  OpenURI::Cache.expiry = 60 * 10 # Ten long minutes
+  
+Execution
+Use exactly the same as you would openuri, only.. enable it.
+
+  require 'openuri_memcached'
+  OpenURI::Cache.enable!
+  open("http://germanforblack.com").read # Slow as a wet week
+  
+Quit your app (leave memcached running) and run the same example, it 
+should now happen in less then ... some time that is really fast.
+
+Questions and comments can be directed to ben at germanforblack.com
+All code is provided with no warranty and should be considered experimental until otherwise stated

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'openuri_memcached/version'
+
+AUTHOR = 'Ben Schwarz'  # can also be an array of Authors
+EMAIL = "ben.schwarz@gmail.com"
+DESCRIPTION = "The same OpenURI that you know and love with the power of Memcached"
+GEM_NAME = 'openuri_memcached' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'schwarz' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = OpenURI::Cache::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'openuri_memcached documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [["memcached", ">= 1.2.1"]]     # An array of rubygem dependencies [name, ], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'openuri_memcached'

data/lib/openuri_memcached/openuri_memcached.rb

@@ -0,0 +1,82 @@
+require 'open-uri'
+require 'rubygems'
+require 'memcache'
+
+module Kernel
+  private 
+  alias openuri_original_open open
+  def open(uri, *rest, &block)
+    OpenURI::open(uri, *rest, &block)
+  end
+  module_function :open, :openuri_original_open
+end
+
+module OpenURI
+  alias original_open open #:nodoc:
+  def self.open(uri, *rest, &block)
+    if Cache.enabled? and Cache::alive?
+      begin
+        response = Cache::get(uri.hash)
+      rescue
+        response = false
+      end
+    end
+    
+    unless response
+      response = openuri_original_open(uri, *rest, &block).read 
+      Cache::set(uri.hash, response) if Cache.alive?
+    end
+    StringIO.new(response)
+  end
+  
+  class Cache
+    # Cache is not enabled by default
+    @cache_enabled = false
+    
+    class << self
+      attr_writer :expiry, :host
+      
+      # Is the cache enabled?
+      def enabled?
+        @cache_enabled
+      end
+      
+      # Enable caching
+      def enable!
+        @cache ||= MemCache.new(host, :namespace => "openuri")
+        @cache_enabled = true
+      end
+      
+      # Disable caching - all queries will be run directly 
+      # using the standard OpenURI `open` method.
+      def disable!
+        @cache_enabled = false
+      end
+
+      def disabled?
+        !@cache_enabled
+      end
+      
+      def get(key)
+        @cache.get(key)
+      end
+      
+      def set(key, value)
+        @cache.set(key, value, expiry)
+      end
+            
+      # How long your caches will be kept for (in seconds)
+      def expiry
+        @expiry ||= 60 * 10
+      end
+      
+      def alive?
+        servers = @cache.instance_variable_get(:@servers) and servers.collect{|s| s.alive?}.include?(true)
+      end
+      
+      def host
+        @host ||= "localhost:11211"
+      end
+    end
+  end
+end

data/lib/openuri_memcached/version.rb

@@ -0,0 +1,11 @@
+module OpenURI #:nodoc:
+  class Cache
+    module VERSION #:nodoc:
+      MAJOR = 0
+      MINOR = 0
+      TINY  = 1
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

data/lib/openuri_memcached.rb

@@ -0,0 +1,3 @@
+$:.unshift File.dirname(__FILE__)
+
+%w(openuri_memcached version).each{|r| require File.join(File.dirname(__FILE__), 'openuri_memcached', r)}

data/spec/openuri_cache_spec.rb

@@ -0,0 +1,51 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'openuri_memcached')
+
+describe OpenURI::Cache, "init" do
+  it "should be disabled" do
+    OpenURI::Cache.should be_disabled
+  end
+end
+
+describe OpenURI, "module" do
+  it "should query a resource without cache" do
+    open('http://google.com').read.should =~ /html/
+  end
+  
+  it "should query a resource with cache" do
+    OpenURI::Cache.enable!
+    OpenURI::Cache.should be_enabled
+    open('http://google.com').read.should =~ /html/
+  end
+end
+
+describe OpenURI::Cache, "class" do  
+  it "should be able to be enabled" do
+    OpenURI::Cache.enable!
+    OpenURI::Cache.should be_enabled
+  end
+  
+  it "should be able to be disabled" do
+    OpenURI::Cache.enable!
+    OpenURI::Cache.disable!
+    OpenURI::Cache.should be_disabled
+  end
+  
+  it "should cache for a default of 10 minutes" do
+    OpenURI::Cache.expiry.should eql 60 * 10
+  end
+  
+  it "should allow a userset cache expiry timeframe" do
+    OpenURI::Cache.expiry = 60 * 15
+    OpenURI::Cache.expiry.should eql 60 * 15
+  end
+  
+  it "should allow a userset host" do
+    server = "10.1.1.1:11211"
+    OpenURI::Cache.host.should eql "localhost:11211"
+    OpenURI::Cache.host = server
+    OpenURI::Cache.host.should eql server
+  end
+  
+  # Not actually sure how I could implement this spec!
+  it "should allow instant cache expiry"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: openuri_memcached
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Schwarz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-15 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: memcached
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: 
+description: The same OpenURI that you know and love with the power of Memcached
+email: ben.schwarz@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- config/hoe.rb
+- config/requirements.rb
+- lib/openuri_memcached.rb
+- lib/openuri_memcached/openuri_memcached.rb
+- lib/openuri_memcached/version.rb
+- spec/openuri_cache_spec.rb
+has_rdoc: true
+homepage: http://schwarz.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: schwarz
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: The same OpenURI that you know and love with the power of Memcached
+test_files: []
+