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.
CouchDB Version¶ ↑
Tested on latest stable release (1.6.X), but little has changed in the last few year and should work on older versions. Also known to work fine on Cloudant.
Install¶ ↑
$ sudo gem install couchrest
Modelling¶ ↑
For more complete modelling support based on ActiveModel, please checkout CouchRest's sister project: CouchRest Model.
Running the Specs¶ ↑
The most complete documentation is the spec/ directory. To validate your CouchRest install, from the project root directory use bundler to install the dependencies and then run the tests:
$ bundle install $ bundle exec rake
To date, the couchrest specs have been shown to run on:
-
MRI Ruby 1.9.3 and later
-
JRuby
Docs¶ ↑
API: rdoc.info/projects/couchrest/couchrest
Check the wiki for documentation and examples wiki.github.com/couchrest/couchrest
Contact¶ ↑
Please post bugs, suggestions and patches to the bug tracker at github.com/couchrest/couchrest/issues.
Follow us on Twitter: twitter.com/couchrest
Also, check twitter.com/search?q=couchrest