Project

dpla-couchrest

0.0
Bugfix fork ofcouchrest
Repository is archived
No commit activity in last 3 years
No release in over 3 years
dpla-couchrestdpla/couchrestHomepageDocumentationSource CodeWiki
CouchRest provides a simple interface on top of CouchDB's RESTful HTTP API, as well as including some utility scripts for managing views and attachments.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,205
Stars
0
Forks
0
Watchers
10
 Releases
Current version
1.2.1.pre.dpla
Total releases
1
First release
2015-01-16
Latest release
2015-01-16
 Development
Primary Language
Ruby
Licenses
Apache License 2.0
Average date of last 50 commits
2012-04-29
Reverse Dependencies
0

 Dependencies

Development

json
>= 1.7.0
rake
>= 0
rspec
~> 2.6.0

Runtime

mime-types
~> 2.1
multi_json
~> 1.8
rest-client
~> 1.6
 Project Readme

CouchRest: CouchDB, close to the metal Build Status

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.

Important Upgrade Notice

2011-04-04: Time#to_json no longer overwritten!

Now sticking to JSON standard format. Ensure you views using Time will be ordered correctly after upgrade!

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.

Modelling

For more complete modelling support based on Rails 3's ActiveModel, please checkout CouchRest's sister project: CouchRest Model.

Extended Document

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

If you're starting a new project however, we recommend you use the more actively maintained CouchRest Model project, supported by the same team of developers.

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 show to run on:

  • Ruby 1.8.7
  • Ruby 1.9.2
  • Ruby 1.9.3
  • JRuby 1.5.6

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