open-uri-cached 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Danial Pearce
+
+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,14 @@
+# OpenURI with caching
+
+Carelessly make OpenURI requests without getting hate mail.
+
+## Usage
+
+Require the library
+
+    require 'open-uri/cached'
+    open('http://www.someone-that-hates-being-scraped.com').read
+
+## Configuring
+
+OpenURI::Cache.cache_path = '/tmp/open-uri'

data/lib/open-uri/cached.rb

@@ -0,0 +1,63 @@
+require 'open-uri'
+require 'digest/sha1'
+
+module OpenURI
+  class << self
+    alias original_open_uri open_uri #:nodoc:
+    def open_uri(uri, *rest, &block)
+      response = Cache.get(uri.to_s)
+
+      unless response
+        response = original_open_uri(uri, *rest).read
+        Cache.set(uri.to_s, response)
+      end
+
+      response = StringIO.new(response)
+
+      if block_given?
+        begin
+          yield response
+        ensure
+          response.close
+        end
+      else
+        response
+      end
+    end
+  end
+
+  class Cache
+    @cache_path = '/tmp/open-uri'
+
+    class << self
+      def get(key)
+        filename = filename_from_url(key)
+        # TODO: head request to determine last_modified vs file modtime
+        File.exists?(filename) ? File.read(filename) : nil
+      end
+
+      def set(key, value)
+        filename = filename_from_url(key)
+        mkpath(filename)
+        File.open(filename, 'w'){|f| f.write value }
+      end
+
+      protected
+        def filename_from_url(url)
+          uri = URI.parse(url) # TODO: rescue here?
+          [ @cache_path, uri.host, Digest::SHA1.hexdigest(url) ].join('/')
+        end
+
+        def mkpath(path)
+          full = []
+          dirs = path.split('/'); dirs.pop
+          dirs.each do |dir|
+            full.push(dir)
+            dir = full.join('/')
+            next if dir.to_s == ''
+            Dir.mkdir(dir) unless File.exists?(dir)
+          end
+        end
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: open-uri-cached
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Danial Pearce
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-27 00:00:00 +11:00
+default_executable: 
+dependencies: []
+
+description: OpenURI with transparent disk caching
+email: rubygems@tigris.id.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- LICENSE
+- lib/open-uri/cached.rb
+has_rdoc: true
+homepage: http://github.com/tigris/open-uri-cached
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Do a lot of site scraping but take lots of attempts at parsing the content before reaching your end result? This gem is for you. But wait, there's more... Ok, no there isn't.
+test_files: []
+