Skip to content

A RESTful CouchDB client based on Curb(libcurl) and Couch.js; ~2x faster then RestClient based couchrest

License

Notifications You must be signed in to change notification settings

CodeMonkeyKevin/couchrest

This branch is 7 commits ahead of, 157 commits behind couchrest/couchrest:master.

Folders and files

NameName
Last commit message
Last commit date
Aug 18, 2010
May 10, 2010
Aug 18, 2010
Aug 18, 2010
Dec 14, 2008
Jul 1, 2010
Sep 12, 2008
Jun 15, 2010
Aug 18, 2010
Jul 28, 2010
Aug 12, 2010
Aug 9, 2010
Jul 17, 2009

Repository files navigation

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 is designed to make a simple base for application and framework-specific object oriented APIs. CouchRest is Object-Mapper agnostic, the parsed JSON it returns from CouchDB shows up as subclasses of Ruby's Hash. Naked JSON, just as it was mean to be.

Note: CouchRest only support CouchDB 0.9.0 or newer. Some features requires CouchDB 0.10.0 or newer.

Easy Install

$ sudo gem install couchrest

Relax, it's RESTful

CouchRest rests on top of a HTTP abstraction layer using by default Heroku’s excellent REST Client Ruby HTTP wrapper.

Extended Document

As of May 2010 support for the popular CouchRest::ExtendedDocument mixin has been moved to its own gem: couchrest_extended_document.

Most people will probably want to use this library (or one of the alternatives) to make it slightly easier to access your documents.

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).

Docs

API: http://rdoc.info/projects/couchrest/couchrest

Check the wiki for documentation and examples http://wiki.github.com/couchrest/couchrest

Contact

Please post bugs, suggestions and patches to the bug tracker at http://github.com/couchrest/couchrest/issues.

Follow us on Twitter: http://twitter.com/couchrest

Also, check http://twitter.com/#search?q=%23couchrest

About

A RESTful CouchDB client based on Curb(libcurl) and Couch.js; ~2x faster then RestClient based couchrest

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 99.2%
  • JavaScript 0.8%