file_proxy 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in file_proxy.gemspec
+gemspec

data/LICENCE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Craig R Webster <craig@barkingiguana.com>
+
+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.md

@@ -0,0 +1,86 @@
+# File Proxy
+
+A toy project to see if I can make a library with no knowledge of an external
+storage service read files from and write files to that service.
+
+Why would you want to do this? Well, here's an example of reading a CSV:
+
+    require 'csv'
+    CSV.foreach("./employees.csv",
+      :headers => :first_row) do |row|
+      puts row.to_hash.inspect
+    end
+
+This causes the CSV library to read the file `employees.csv` from the local
+filesystem. What if I have access to that file from a central resource, maybe
+an HR database, and it's exposed over something like HTTP? Do I really want to
+deal with downloading that file before I read it? Why can't I just tell `CSV`
+where the file lives?
+
+    CSV.foreach("http://hr.local/data/employees.csv",
+      :headers => :first_row) do |row|
+      puts row.to_hash.inspect
+    end
+
+I could pass an `IO` to the `CSV` library which correctly wrapped the HTTP
+resource, and that would be perfectly valid and in this case arguable better,
+but there are plenty of other libraries that don't provide the same degree of
+flexibility and I want to see if I can support those too. I'd also like to not
+worry about providing IO wrappers around common things like reading from or
+writing to objects stored in s3 or on some FTP server.
+
+
+## A word of warning
+
+This is a toy project and I'm not sure I'd use it for anything serious unless
+there was absolutely no better way. "Better" is, of course, rather subjective,
+so I'll leave that up to you do decide.
+
+Here are some alternatives that were suggested to me as more sane solutions
+when talking about this project:
+
+  * Use `open-uri` to read files
+  * Mount the remote service via FUSE
+
+I'm sure there are others - feel free to add your suggestions here.
+
+
+## How is it used and how does it work?
+
+Include the shim into the `File` class:
+
+    require 'file_proxy'
+    File.class_eval { include FileProxy::Shim }
+
+That little piece of code totally screws with the `File` class as provided by
+stdlib. I'd encourage you to read the code to find out exactly the sort of
+crazy things I'm doing.
+
+From now on, any file access (via `File` at least) will try to parse the path
+as an `URI`. If there's no scheme part to the URI, as will be the case with
+normal filesystem paths, then proxy back to the original `File` class ie
+behaviour should not be changed.
+
+If there *is* a scheme in the URI then attempt to load the appropriate Proxy
+behaviour from `FileProxy::Proxies::<Scheme>Proxy` and call the method which
+was origianlly called on `File` from that, passing the same arguments
+(including blocks, if any) to that method.
+
+
+## Who made this crazy thing?
+
+[Craig R Webster][0] wrote most of the madness.
+
+Jon Wood helped work out how to delegate back to the original File class.
+
+Tom Stuart and James Adam tried to talk me into doing something sane (sorry
+guys) and talked about how to capture the original File class before futzing
+with it.
+
+[0]: mailto:craig@barkingiguana.com
+
+
+## Licence
+
+Since nothing is complete without a licence, this is released under the terms
+of the MIT licence, a copy of which is included in the LICENCE file.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/file_proxy.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "file_proxy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "file_proxy"
+  s.version     = FileProxy::VERSION
+  s.authors     = ["Craig R Webster"]
+  s.email       = ["craig@barkingiguana.com"]
+  s.homepage    = ""
+  s.summary     = %q{Proxy the File class to places that aren't on the local filesystem}
+  s.description = %q{A toy project to see if I can make a library with no knowledge of an external storage service read files from and write files to that service.}
+
+  s.rubyforge_project = "file_proxy"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/file_proxy.rb

@@ -0,0 +1,10 @@
+require 'net/http'
+require 'uri'
+require 'delegate'
+
+require 'file_proxy/version'
+require 'file_proxy/original_file'
+require 'file_proxy/proxies/file_proxy'
+require 'file_proxy/proxies/http_proxy'
+require 'file_proxy/proxy'
+require 'file_proxy/shim'

data/lib/file_proxy/original_file.rb

@@ -0,0 +1,3 @@
+module FileProxy
+  OriginalFile = File.dup
+end

data/lib/file_proxy/proxies/file_proxy.rb

@@ -0,0 +1,13 @@
+module FileProxy
+  module Proxies
+    module FileProxy
+      def remote
+        @remote ||= SimpleDelegator.new(OriginalFile)
+      end
+
+      def method_missing *args, &blk
+        remote.send *args, &blk
+      end
+    end
+  end
+end

data/lib/file_proxy/proxies/http_proxy.rb

@@ -0,0 +1,15 @@
+module FileProxy
+  module Proxies
+    module HttpProxy
+      def open url, *args, &blk
+        uri = URI.parse url
+        data = Net::HTTP.get uri
+        buffer = '/tmp/' + Time.now.to_s + rand(1_000_000_000_000).to_s
+        ::FileProxy::OriginalFile.open buffer, 'w+' do |f|
+          f.print data
+        end
+        ::FileProxy::OriginalFile.open buffer, *args, &blk
+      end
+    end
+  end
+end

data/lib/file_proxy/proxy.rb

@@ -0,0 +1,16 @@
+module FileProxy
+  class Proxy
+    def initialize scheme
+      self.class.instance_eval do
+        include proxy_for scheme
+      end
+    end
+
+    def self.proxy_for scheme
+      return Proxies::FileProxy if scheme.nil?
+      proxy = scheme.dup
+      proxy[0] = proxy[0].upcase
+      Proxies.const_get "#{proxy}Proxy"
+    end
+  end
+end

data/lib/file_proxy/shim.rb

@@ -0,0 +1,14 @@
+module FileProxy
+  module Shim
+    def self.included into
+      class << into
+	def open file_name, *args, &blk
+          uri = URI.parse file_name
+          puts uri.scheme.inspect
+          proxy = Proxy.new uri.scheme
+          proxy.open file_name, *args, &blk
+        end
+      end
+    end
+  end
+end

data/lib/file_proxy/version.rb

@@ -0,0 +1,3 @@
+module FileProxy
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: file_proxy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Craig R Webster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-22 00:00:00.000000000Z
+dependencies: []
+description: A toy project to see if I can make a library with no knowledge of an
+  external storage service read files from and write files to that service.
+email:
+- craig@barkingiguana.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- file_proxy.gemspec
+- lib/file_proxy.rb
+- lib/file_proxy/original_file.rb
+- lib/file_proxy/proxies/file_proxy.rb
+- lib/file_proxy/proxies/http_proxy.rb
+- lib/file_proxy/proxy.rb
+- lib/file_proxy/shim.rb
+- lib/file_proxy/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: file_proxy
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Proxy the File class to places that aren't on the local filesystem
+test_files: []