lsegal-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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: lsegal-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 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  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: 
+- LICENSE
+- README.markdown
+- Rakefile
+has_rdoc: yard
+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: couchio
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Virtual filesystem support for a CouchDB database.
+test_files: []
+