benschwarz-openuri_memcached 0.1.3 → 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,48 @@
+# OpenURI with caching
+
+Carelessly make OpenURI requests without getting hate mail.
+
+## Running with MemCached
+
+Require the library
+
+    require 'openuri/memcached'
+  
+Start memcached server
+  
+    ben@Spinners ~/ Ϟ memcached -d
+
+Set your memcached host/s (defaults to 127.0.0.1:11211)
+  
+    OpenURI::Cache.host = ['10.1.1.10:11211', '10.1.1.11:11211']
+
+The default expiry is 15 minutes, this can be changed using the `expiry` method
+    
+    # Ten long minutes
+    OpenURI::Cache.expiry = 600
+    
+## Running using Rails cache
+
+You can also cache your OpenURI calls using Rails cache. 
+require the library using `require openuri/rails-cache`
+  
+### Execution
+Use exactly the same as you would OpenURI, only.. enable it.
+
+    OpenURI::Cache.enable!
+    # As slow a wet week
+    open("http://ab-c.com.au").read 
+  
+Quit your app (leave memcached running) and re-run the same request, It will come from cache.
+
+### Requirements
+
+* Ruby
+* 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
+
+### Contributors
+
+* [Ben Askins](http://github.com/benaskins)
+* [Rick Olson](http://github.com/technoweenie)

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

@@ -1,107 +1 @@
-require 'open-uri'
-
-begin
-  require 'minigems'
-rescue LoadError
-  require 'rubygems'
-end
-
-require 'memcached'
-
-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?
-      begin
-        response = Cache::get(uri.to_s)
-      rescue Memcached::NotFound
-        response = false
-      end
-    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!
-        @cache ||= Memcached.new(host, {
-          :namespace => 'openuri', 
-          :no_block => true,
-          :buffer_requests => true
-        })
-        @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 host
-        @host ||= "127.0.0.1:11211"
-      end
-    end
-  end
-end
+require 'openuri/memcached'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: benschwarz-openuri_memcached
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: "0.2"
 platform: ruby
 authors: 
 - Ben Schwarz
@@ -11,16 +11,8 @@ cert_chain: []
 
 date: 2009-01-11 00:00:00 -08:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: memcached
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.10"
-    version: 
+dependencies: []
+
 description: OpenURI with transparent caching
 email: ben@germanforblack.com
 executables: []
@@ -30,8 +22,13 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
+- 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: 

data/README

@@ -1,35 +0,0 @@
-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!
-  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
-
-Requirements: 
-	» Ruby 1.8.6
-	» Memcached 
-	» memcache - Refer to blog.evanweaver.com/files/doc/fauna/memcached/files/README.html for installation notes
-	 For the gem, do this `sudo env ARCHFLAGS="-arch i386" gem install memcached --no-rdoc --no-ri -- --with-opt-dir=/opt/local`
-