couchio 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008 Loren Segal
+
+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,99 @@
+CouchIO for Ruby
+================
+
+Written by Loren Segal in 2008, licensed under MIT license.
+
+
+SYNOPSYS
+--------
+
+CouchIO is a simple VFS for Ruby, adding support to open, read and write
+CouchDB resource URI's as if they were local files. The API intuitively uses
+the existing `File` and `Dir` API to read and write. The goal is to emulate
+Ruby's `Dir` and `File` implementation for the filesystem completely. Not all of 
+the interface has been implemented, but basic read/write support is currently 
+available. In addition to database support, CouchIO has support for both documents 
+and attachments. 
+
+
+USAGE
+-----
+
+### Accessing Databases & Documents ###
+
+In CouchIO, the `Dir` filesystem equivalent of a directory is a CouchDB database.
+The equivalent of a `File` is a CouchDB document *or* a CouchDB attachment, depending
+on how the data is written.
+
+The only difference between accessing files and directories and accessing documents and
+databases is that you need to specify the full URI including the "couch://" scheme prefix,
+not "http://" (to differentiate from `open-uri` support).
+
+### Writing Documents & Attachments ###
+
+Like with writing to files, you need to use the 'a' append mode flag if you wish to append
+to the file. If you do not use this for a Couch resource, it will overwrite all of your contents.
+
+To write data to a document, your data **must** be a `Hash`. To write data to an _attachment_,
+your data must be a `String`. As you will see in the examples, writing a string will force
+the resource to be saved as an attachment while writing hash contents will save it as a document.
+
+### Note About Saving ###
+
+Saving is done when the file is closed. There is a `save` method that can be manually called, 
+however, to maintain filesystem independence, it should never be called.
+
+
+EXAMPLES
+--------
+
+List databases:
+
+    Dir.entries("couch://localhost:5984/") #=> ['todo', 'test']
+    
+Create a database:
+
+    Dir.mkdir("couch://localhost:5984/xyzzy")
+    
+Delete a database:
+
+    Dir.unlink("couch://localhost:5984/xyzzy")
+  
+List documents in a database:
+
+    Dir.entries("couch://localhost:5984/todo") #=> ['fix_car', 'wash_dishes', ...]
+    # - OR -
+    Dir.open("couch://localhost:5984/todo").each do |p|
+      puts p
+    end
+  
+Open and read a document:
+
+    File.open("couch://localhost:5984/todo/fix_car").read 
+    #=> {'_id' => 'fix_car', 'text' => 'Need to fix car!', 'time' => 'June 20th 2008 10:55AM'}
+    # Same as: File.read("couch://localhost:5984/todo/fix_car")
+  
+Open a document for append-writing:
+
+    File.open("couch://localhost:5984/todo/fix_car", 'wa') do |f|
+      f.write 'text' => 'Need to fix car NOW!!!'
+    end
+    File.read("couch://localhost:5984/todo/fix_car")
+    #=> {'_id' => 'fix_car', 'text' => 'Need to fix car NOW!!!', 'time' => 'June 20th 2008 10:55AM'}
+  
+Write an attachment (document must exist):
+
+    File.open("couch://localhost:5984/test/doc/foo.txt", 'w') do |f|
+      f.write "hello world"
+    end
+  
+Read an attachment:
+
+    File.read("couch://localhost:5984/test/doc/foo.txt") #=> "hello world"
+  
+  
+COPYRIGHT
+---------
+
+CouchIO is free software written by **Loren Segal** under the MIT license. If
+you meet him, give him props.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec'
+require 'spec/rake/spectask'
+require 'yard'
+
+WINDOWS = (PLATFORM =~ /win32|cygwin/ ? true : false) rescue false
+SUDO = WINDOWS ? '' : 'sudo'
+
+task :default => :specs
+
+load 'couchio.gemspec'
+Rake::GemPackageTask.new(SPEC) do |pkg|
+  pkg.gem_spec = SPEC
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+desc "Install the gem locally"
+task :install => :package do 
+  sh "#{SUDO} gem install pkg/#{SPEC.name}-#{SPEC.version}.gem --local"
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new("specs") do |t|
+  $DEBUG = true if ENV['DEBUG']
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir["spec/**/*_spec.rb"].sort
+end
+
+YARD::Rake::YardocTask.new

data/lib/couchio.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'json'
+require 'uri'
+require 'net/http'
+require 'base64'
+
+root = File.join(File.dirname(__FILE__), 'couchio')
+
+['couch_io', 'couch_open', 'couch_database', 'couch_document'].each do |f|
+  require File.join(root, f)
+end
+
+Dir[root + '/core_ext/*.rb'].each {|f| require f }

data/lib/couchio/core_ext/dir.rb

@@ -0,0 +1,44 @@
+class << Dir
+  alias couch_orig_open open
+  alias couch_orig_new new
+  remove_method :open
+  include CouchOpen
+  
+  alias couch_orig_entries entries
+  def entries(dirname)
+    if dirname.index("couch://") == 0
+      CouchDatabase.new(dirname).map
+    else
+      couch_orig_entries(dirname)
+    end
+  end
+
+  alias couch_orig_foreach foreach
+  def foreach(dirname, &block)
+    if dirname.index("couch://") == 0
+      CouchDatabase.new(dirname).each {|f| yield f }
+    else
+      couch_orig_foreach(dirname, &block)
+    end
+  end
+
+  alias couch_orig_rmdir rmdir
+  def rmdir(dirname)
+    if dirname.index("couch://") == 0
+      CouchDatabase.new(dirname).delete
+    else
+      couch_orig_rmdir(dirname)
+    end
+  end
+  alias unlink rmdir
+  alias delete rmdir
+
+  alias couch_orig_mkdir mkdir
+  def mkdir(dirname, *args)
+    if dirname.index("couch://") == 0
+      CouchDatabase.new(dirname).create
+    else
+      couch_orig_mkdir(dirname, *args)
+    end
+  end
+end

data/lib/couchio/core_ext/file.rb

@@ -0,0 +1,14 @@
+class << File
+  alias couch_orig_open open
+  alias couch_orig_new new
+  include CouchOpen
+  
+  alias couch_orig_read read
+  def read(filename)
+    if filename.index("couch://") == 0
+      CouchDocument.new(filename).read
+    else
+      couch_orig_read
+    end
+  end
+end

data/lib/couchio/core_ext/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def stringify_keys
+    Hash[*map {|k,v| [k.to_s, v] }.flatten]
+  end
+end

data/lib/couchio/core_ext/kernel.rb

@@ -0,0 +1,4 @@
+module Kernel
+  alias couch_orig_open open
+  include CouchOpen
+end

data/lib/couchio/core_ext/uri.rb

@@ -0,0 +1,5 @@
+Net::HTTP.version_1_2
+
+module URI
+  @@schemes['COUCH'] = URI::HTTP
+end

data/lib/couchio/couch_database.rb

@@ -0,0 +1,57 @@
+class CouchDatabase < CouchIO
+  include Enumerable
+  
+  attr_accessor :pos
+  alias tell pos
+  
+  def initialize(*args, &block)
+    super
+    @pos = 0
+  end
+  
+  def rewind; @pos = 0; self end
+  def seek(n) @pos = n; self end
+  
+  def each 
+    rows.each {|row| yield row }
+  end
+  
+  def read
+    @rows ||= rows
+    result = @rows[@pos]
+    @pos += 1
+    result
+  end
+  
+  def create
+    uri = URI.parse(path)
+    Net::HTTP.start(uri.host, uri.port) do |http|
+      result = http.send_request('PUT', uri.path)
+      json = JSON.parse(result.body)
+      verify_ok(json)
+    end
+    0
+  end
+  
+  def delete
+    uri = URI.parse(path)
+    Net::HTTP.start(uri.host, uri.port) do |http|
+      result = http.delete(uri.path)
+      json = JSON.parse(result.body)
+      verify_ok(json)
+    end
+    0
+  end
+  alias unlink delete
+  alias rmdir delete
+  
+  private
+  
+  def rows
+    if URI.parse(path).path =~ /^\/*$/
+      read_json('_all_dbs')
+    else
+      read_json('_all_docs')["rows"].map {|r| r['id'] }
+    end
+  end
+end

data/lib/couchio/couch_document.rb

@@ -0,0 +1,76 @@
+class CouchDocument < CouchIO
+  def close
+    save
+  end
+  
+  def read
+    return @local_copy if @dirty
+      
+    json = read_json
+    verify_ok(json)
+    @local_copy = json
+  rescue Errno::ENOENT
+    @local_copy = {'_id' => File.basename(path)}
+  end
+  
+  def write(data)
+    read if !@local_copy
+    if @local_copy.is_a?(Hash)
+      @local_copy.delete_if {|k,v| !append && k[0,1] != '_' }
+    end
+      
+    if data.is_a?(String) 
+      write_string(data)
+    elsif data.is_a?(Hash)
+      write_hash(data)
+    else
+      raise ArgumentError, "expecting String or Hash, got #{data.class}"
+    end
+    @dirty = true
+  end
+  alias print write
+  
+  def printf(data, *args)
+    write_string sprintf(data, *args)
+  end
+  
+  def write_string(data)
+    CouchDocument.new(File.dirname(path), 'a') do |f|
+      item = f.read
+      item['_attachments'] ||= {}
+      
+      if append && item['_attachments'][File.basename(path)]
+        item['_attachments'][File.basename(path)].update({
+          'data' => Base64.b64encode(read.to_s + data.to_s).chomp
+        })
+      else
+        item['_attachments'].update(File.basename(path) => {
+          'content_type' => 'text/plain',
+          'data' => Base64.b64encode(data).chomp
+        })
+      end
+      f.write(item)
+    end
+  end
+  alias puts write_string
+  
+  def write_hash(data)
+    data = data.stringify_keys
+    @local_copy.update(data)
+  end
+  
+  private
+  
+  def save
+    return unless @local_copy && @local_copy.is_a?(Hash)
+    
+    uri = URI.parse(path)
+    Net::HTTP.start(uri.host, uri.port) do |http|
+      @local_copy.update('_id' => File.basename(path))
+      result = http.send_request('PUT', uri.path, @local_copy.to_json)
+      json = JSON.parse(result.body)
+      verify_ok(json)
+    end
+    @dirty = false
+  end
+end

data/lib/couchio/couch_io.rb

@@ -0,0 +1,49 @@
+class AccessError < Exception
+end
+
+class CouchIO 
+  attr_accessor :path, :readable, :writeable, :append
+  
+  def initialize(name, mode = 'r', &block)
+    @path      = name
+    @readable  = mode.include?('r')
+    @writeable = mode.include?('w')
+    @append    = mode.include?('a')
+    
+    if block_given?
+      yield(self) 
+      close
+    end
+  end
+  
+  def close; end
+  
+  def read
+    read_json
+  end
+  
+  private
+  
+  def read_json(extra = nil)
+    uri  = extra ? File.join(path, extra) : path
+    data = Net::HTTP.get(URI.parse(uri))
+    
+    if data[0,1] =~ /[\[\{]/
+      JSON.parse(data)
+    else
+      data
+    end
+  rescue JSON::ParserError
+    data
+  end
+  
+  def verify_ok(json)
+    return unless json.is_a?(Hash)
+    return unless json.has_key?('error')
+    
+    case json['error']
+    when 'not_found'
+      raise Errno::ENOENT, path
+    end
+  end
+end

data/lib/couchio/couch_open.rb

@@ -0,0 +1,21 @@
+module CouchOpen
+  def open(name, mode = 'r', *perm, &block)
+    if name.index("couch://") == 0
+      couch_io_class.new(name, mode, &block)
+    else
+      couch_orig_open(name, mode, *perm, &block)
+    end
+  end
+  alias new open
+  
+  private
+  
+  def couch_io_class
+    case self.to_s
+    when 'File'
+      CouchDocument
+    when 'Dir'
+      CouchDatabase
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: couchio
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Loren Segal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-20 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: lsegal@soen.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/couchio
+- lib/couchio/core_ext
+- lib/couchio/core_ext/dir.rb
+- lib/couchio/core_ext/file.rb
+- lib/couchio/core_ext/hash.rb
+- lib/couchio/core_ext/kernel.rb
+- lib/couchio/core_ext/uri.rb
+- lib/couchio/couch_database.rb
+- lib/couchio/couch_document.rb
+- lib/couchio/couch_io.rb
+- lib/couchio/couch_open.rb
+- lib/couchio.rb
+- LICENSE
+- README.markdown
+- Rakefile
+has_rdoc: false
+homepage: http://couchio.soen.ca
+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.1.1
+signing_key: 
+specification_version: 2
+summary: Virtual filesystem support for a CouchDB database.
+test_files: []
+