technoweenie-openuri_memcached 0.2

data/History.txt

@@ -0,0 +1,18 @@
+== 0.2.0 2009-01-23
+* Include support for Rails.cache
+
+== 0.1.0 2008-04-17
+* Included Evan Weaver's Memcached C wrapper for a healthy speed improvement
+
+== 0.0.3 2008-01-18
+* Caches are now stored by the uri as the key like they originally were
+
+== 0.0.2 2008-01-15
+* Some moron forgot to write the dependency list correctly for 0.0.1
+
+
+== 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-2009 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/README.markdown

@@ -0,0 +1,40 @@
+# OpenURI with Memcached caching
+
+Carelessly make heavy OpenURI calls as many times as you like with local
+memcached picking up the slack and stopping people from sending you hate mail.
+
+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 = ['10.1.1.10:11211', '10.1.1.11: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!
+    # Slow as a wet week
+    open("http://germanforblack.com").read 
+  
+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
+
+### Requirements
+
+* Ruby 1.8.6
+* MemCached 
+* memcache (gem)
+  * You will need to ensure that you have [corresponding version](http://blog.evanweaver.com/files/doc/fauna/memcached/files/COMPATIBILITY.html) of libmemcached to the memcached gem installed for installation to go by breezy

data/lib/openuri/common.rb

@@ -0,0 +1,90 @@
+require 'open-uri'
+
+module Kernel
+  private 
+  alias openuri_original_open open
+  def open(name, *rest, &block)
+    if name.respond_to?(:open)
+      name.open(*rest, &block)
+    elsif name.respond_to?(:to_str) &&
+          %r{\A[A-Za-z][A-Za-z0-9+\-\.]*://} =~ name &&
+          (uri = URI.parse(name)).respond_to?(:open)
+      OpenURI::open(name, *rest, &block)
+    else
+      open_uri_original_open(name, *rest, &block)
+    end
+  end
+  module_function :open, :openuri_original_open
+end
+
+module OpenURI
+  alias original_open open #:nodoc:
+  def self.open(uri, *rest, &block)
+    if Cache.enabled?
+      response = Cache::get(uri.to_s)
+    end
+    
+    unless response
+      response = openuri_original_open(uri, *rest).read
+      Cache::set(uri.to_s, response) if Cache.enabled?
+    end
+
+    response = StringIO.new(response)
+
+    if block_given?
+      begin
+        yield response
+      ensure
+        response.close
+      end
+    else
+      response
+    end
+  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!
+        raise NotImplementedError
+      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)
+        raise NotImplementedError
+      end
+      
+      def set(key, value)
+        raise NotImplementedError
+      end
+            
+      # How long your caches will be kept for (in seconds)
+      def expiry
+        @expiry ||= 60 * 10
+      end
+      
+      def host
+        @host ||= "127.0.0.1:11211"
+      end
+    end
+  end
+end

data/lib/openuri/memcached.rb

@@ -0,0 +1,36 @@
+require 'openuri/common'
+
+begin
+  require 'minigems'
+rescue LoadError
+  require 'rubygems'
+end
+
+gem "memcached", ">= 0.10"
+require 'memcached'
+
+module OpenURI
+  class Cache
+    class << self
+      # Enable caching
+      def enable!
+        @cache ||= Memcached.new(host, {
+          :namespace => 'openuri', 
+          :no_block => true,
+          :buffer_requests => true
+        })
+        @cache_enabled = true
+      end
+      
+      def get(key)
+        @cache.get(key)
+      rescue Memcached::NotFound
+        false
+      end
+      
+      def set(key, value)
+        @cache.set(key, value, expiry)
+      end
+    end
+  end
+end

data/lib/openuri/rails-cache.rb

@@ -0,0 +1,21 @@
+require 'openuri/common'
+
+module OpenURI
+  class Cache
+    class << self
+      # Enable caching
+      def enable!
+        @cache ||= Rails.cache
+        @cache_enabled = true
+      end
+      
+      def get(key)
+        @cache.fetch(key) { false }
+      end
+      
+      def set(key, value)
+        @cache.write(key, value, expiry)
+      end
+    end
+  end
+end

data/lib/openuri_memcached.rb

@@ -0,0 +1 @@
+require 'openuri/memcached'

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: technoweenie-openuri_memcached
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Ben Schwarz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-11 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: OpenURI with transparent caching
+email: ben@germanforblack.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- History.txt
+- License.txt
+- lib/openuri_memcached.rb
+- lib/openuri/memcached.rb
+- lib/openuri/common.rb
+- lib/openuri/rails-cache.rb
+has_rdoc: false
+homepage: http://github.com/benschwarz/open-uri-memcached
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: The same OpenURI that you know and love with the power of Memcached
+test_files: []
+