Doing the simple stuff so you don't have to
Go to file
Sam Lown b0d2258bd3 Improving handling of mime types, instanciation of documents from the
database, and more dependencies on active_support.
2010-05-12 23:43:17 +02:00
examples/model Moving to own repo without the base couchrest 2010-05-10 21:19:24 +02:00
lib Improving handling of mime types, instanciation of documents from the 2010-05-12 23:43:17 +02:00
spec Improving handling of mime types, instanciation of documents from the 2010-05-12 23:43:17 +02:00
utils s/localhost/127.0.0.1/ 2008-12-14 12:05:02 +01:00
.gitignore Moving to own repo without the base couchrest 2010-05-10 21:19:24 +02:00
history.txt Improving handling of mime types, instanciation of documents from the 2010-05-12 23:43:17 +02:00
init.rb Moving to own repo without the base couchrest 2010-05-10 21:19:24 +02:00
LICENSE added apache license 2008-09-11 21:31:59 -07:00
Rakefile Moving initial loading parts 2010-05-11 15:37:50 +02:00
README.md Tiny doc update 2010-05-11 00:16:17 +02:00
THANKS.md fix repository url 2010-01-13 21:25:17 -02:00

CouchRest::ExtendedDocument: CouchDB, not too close to the metal

CouchRest::ExtendedDocument adds additional functionality to the standard CouchRest Document class such as setting properties, callbacks, typecasting, and validations.

Note: CouchRest only supports CouchDB 0.9.0 or newer.

Install

$ sudo gem install couchrest_extended_document

Usage

General

require 'couchrest_extended_document'

class Cat < CouchRest::ExtendedDocument

  property :name, :type => String

end

Rails

In your environment.rb file require the gem as follows:

Rails::Initializer.run do |config|
  ....
  config.gem "couchrest_extended_document"
  ....
end

Testing

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_extended_document

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

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