Doing the simple stuff so you don't have to
Go to file
2009-01-12 21:07:56 -08:00
bin move some couchapp components to couchapp project 2009-01-08 16:48:11 -08:00
examples s/localhost/127.0.0.1/ 2008-12-14 12:05:02 +01:00
gems building my own gems 2008-12-03 11:54:19 -08:00
lib strip old create and update 2009-01-12 21:07:56 -08:00
spec added CouchRest::Model#attachment_url for someone to fetch the attachment using other means 2009-01-12 21:06:48 -08:00
utils s/localhost/127.0.0.1/ 2008-12-14 12:05:02 +01:00
.gitignore added gem task for easy local packaging 2008-10-26 10:03:59 -05:00
couchrest.gemspec merge mime types in model 2009-01-12 21:06:48 -08:00
github_gemtest.rb a file to check the gem build 2008-11-26 13:42:27 -08:00
LICENSE added apache license 2008-09-11 21:31:59 -07:00
Rakefile thanks file 2009-01-12 20:40:06 -08:00
README.md readme markdown 2009-01-11 02:27:22 -08:00
THANKS.md thanks file 2009-01-12 20:40:06 -08:00

CouchRest: CouchDB, close to the metal

CouchRest is based on CouchDB's couch.js test library, which I find to be concise, clear, and well designed. CouchRest lightly wraps CouchDB's HTTP API, managing JSON serialization, and remembering the URI-paths to CouchDB's API endpoints so you don't have to.

CouchRest's lighweight is designed to make a simple base for application and framework-specific object oriented APIs.

Easy Install

Easy Install is moving to RubyForge, heads up for the gem.

Relax, it's RESTful

The core of Couchrest is Herokus excellent REST Client Ruby HTTP wrapper. REST Client takes all the nastyness of Net::HTTP and gives is a pretty face, while still giving you more control than Open-URI. I recommend it anytime youre interfacing with a well-defined web service.

Running the Specs

The most complete documentation is the spec/ directory. To validate your CouchRest install, from the project root directory run rake, or autotest (requires RSpec and optionally ZenTest for autotest support).

Examples

Quick Start:

# with !, it creates the database if it doesn't already exist
@db = CouchRest.database!("http://127.0.0.1:5984/couchrest-test")
response = @db.save({:key => 'value', 'another key' => 'another value'})
doc = @db.get(response['id'])
puts doc.inspect

Bulk Save:

@db.bulk_save([
    {"wild" => "and random"},
    {"mild" => "yet local"},
    {"another" => ["set","of","keys"]}
  ])
# returns ids and revs of the current docs
puts @db.documents.inspect 

Creating and Querying Views:

@db.save({
  "_id" => "_design/first", 
  :views => {
    :test => {
      :map => "function(doc){for(var w in doc){ if(!w.match(/^_/))emit(w,doc[w])}}"
      }
    }
  })
puts @db.view('first/test')['rows'].inspect 

CouchRest::Model

CouchRest::Model is a module designed along the lines of DataMapper::Resource. By subclassing, suddenly you get all sorts of powerful sugar, so that working with CouchDB in your Rails or Merb app is no harder than working with the standard SQL alternatives. See the CouchRest::Model documentation for an example article class that illustrates usage.

CouchRest::Model will be removed from this package.