deac/couchrest_model
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
Doing the simple stuff so you don't have to
620 commits 4 branches 11 tags 4.5 MiB
Ruby 100%
Go to file
Marcos Tapajós 6702574b32 moving all examples to wiki
2010-01-13 21:07:59 -02: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 Fixing incorrectly generated document URIs with testing 2010-01-03 21:42:22 -02:00
spec Move the provides_collection declaration into the Article test fixture, and out of the test, fixing a test case that was failing in ruby 1.9. 2010-01-07 12:25:31 -06:00
utils s/localhost/127.0.0.1/ 2008-12-14 12:05:02 +01:00
.gitignore Adds attribute protection to properties 2009-10-31 09:56:58 -02:00
couchrest.gemspec changed the gemspec to avoid building a new gh version 2009-09-28 21:00:14 -07:00
github_gemtest.rb a file to check the gem build 2008-11-26 13:42:27 -08:00
history.txt bumped the version number to 0.33 2009-08-03 12:23:13 -07: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
make-gemspec.sh make gemspec cleans build products before gemspecing 2009-01-12 21:19:02 -08:00
Rakefile color specs 2009-08-06 12:57:47 -07:00
README.md moving all examples to wiki 2010-01-13 21:07:59 -02:00
THANKS.md Updating the version number 2009-09-03 00:09:16 -03: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

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

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