deac/couchrest_model
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
Doing the simple stuff so you don't have to
670 commits 4 branches 11 tags 4.5 MiB
Ruby 100%
Find a file
Will Leinweber 13d76d38de update history
2010-03-15 19:19:27 -05:00
examples removed CouchRest::Model, added more specs and fixed a bug with casted CR::ExtendedDocument 2009-02-24 22:51:13 -08:00
lib Provide a description of the timeout error 2010-03-15 19:16:40 -05:00
spec make one spec work on ruby 1.8.6 2010-03-15 19:07:41 -05:00
utils s/localhost/127.0.0.1/ 2008-12-14 12:05:02 +01:00
.gitignore change to use Jeweler and Gemcutter 2010-01-13 21:33:23 -02:00
history.txt update history 2010-03-15 19:19:27 -05:00
init.rb Add init.rb for easy usage as a Rails plugin (Makes for easy submodule-ing) 2009-07-18 01:49:19 +08:00
LICENSE added apache license 2008-09-11 21:31:59 -07:00
Rakefile update history, and add will to authors 2010-03-15 19:12:38 -05:00
README.md add API link 2010-01-13 23:16:16 -02:00
THANKS.md fix repository url 2010-01-13 21:25:17 -02:00

README.md

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.

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. Other adapters can be added to support more http libraries.

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://jchris.lighthouseapp.com/projects/17807-couchrest/overview.

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

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

Ruby on Rails

CouchRest is compatible with rails and can even be used a Rails plugin. However, you might be interested in the CouchRest companion rails project: http://github.com/hpoydar/couchrest-rails