Doing the simple stuff so you don't have to
Find a file
Matt Lyon efae804920 Merge branch 'master' of git://github.com/thewordnerd/couchrest
* 'master' of git://github.com/thewordnerd/couchrest:
  Removed model create/update callbacks and integrated with new bulk save infrastructure.
  Make bulk saving more flexible.
  Add support for database compaction.
2008-12-19 02:15:02 -08:00
bin make couchapp database magically 2008-10-29 12:13:22 -07:00
examples better example params name 2008-11-10 21:34:29 -08:00
gems building my own gems 2008-12-03 11:54:19 -08:00
lib Merge branch 'master' of git://github.com/thewordnerd/couchrest 2008-12-19 02:15:02 -08:00
spec Merge branch 'master' of git://github.com/thewordnerd/couchrest 2008-12-19 02:15:02 -08:00
utils created some utility scripts 2008-08-03 14:17:58 -07:00
.gitignore added gem task for easy local packaging 2008-10-26 10:03:59 -05:00
couchrest.gemspec rev the gem version 2008-11-22 16:30:36 -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 rev the gem version 2008-11-22 16:30:36 -08:00
README.rdoc whitespace readme 2008-10-02 10:57:13 -07:00
THANKS updated gem version 2008-09-11 22:23:47 -07:00

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

== CouchRest - CouchDB, close to the metal

CouchRest is based on [CouchDB's couch.js test
library](http://svn.apache.org/repos/asf/incubator/couchdb/trunk/share/www/script/couch.js),
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

  sudo gem install jchris-couchrest -s http://gems.github.com

=== 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://localhost: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.