https://github.com/couchrest/couchrest
A minimalist CouchDB client in ruby
https://github.com/couchrest/couchrest
Last synced: 22 days ago
JSON representation
A minimalist CouchDB client in ruby
- Host: GitHub
- URL: https://github.com/couchrest/couchrest
- Owner: couchrest
- License: apache-2.0
- Created: 2009-07-27T22:04:22.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2021-11-13T22:11:11.000Z (over 3 years ago)
- Last Synced: 2025-03-09T12:33:28.747Z (about 1 month ago)
- Language: Ruby
- Homepage: http://groups.google.com/group/couchrest
- Size: 3.11 MB
- Stars: 475
- Watchers: 6
- Forks: 133
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: history.txt
- License: LICENSE
Awesome Lists containing this project
- awesome-ruby-toolbox - Couchrest - 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. (Data Persistence / CouchDB Clients)
- awesome-starred - couchrest/couchrest - A minimalist CouchDB client in ruby (others)
- awesome-couchdb - CouchRest - A minimalist Ruby client for CouchDB. (Libraries and Clients)
README
# CouchRest: CouchDB, close to the metal
[](https://travis-ci.org/couchrest/couchrest)
CouchRest wraps CouchDB's HTTP API using persistent connections with the [HTTPClient gem](https://github.com/nahi/httpclient) managing servers, databases, and JSON document serialization using CouchDB's API endpoints so you don't have to.
CouchRest is designed to provide a simple base for application and framework-specific object oriented APIs. CouchRest is Object-Mapper agnostic, the JSON objects provided by CouchDB are parsed and returned as Document objects providing a simple Hash-like interface.
For more complete modelling support based on ActiveModel, please checkout CouchRest's sister project: [CouchRest Model](https://github.com/couchrest/couchrest_model).
## CouchDB Version
Tested on latest stable release (1.6.X), but should work on older versions above 1.0. Also known to work on [Cloudant](http://cloudant.com).
### Performance with Persistent Connections
When connecting to a CouchDB 1.X server from a Linux system, you may see a big drop in performance due to the change in library to HTTPClient using persistent connections. The issue is caused by the NOWAIT TCP configuration option causing sockets to hang as they wait for more information. The fix is a [simple configuration change](http://docs.couchdb.org/en/1.6.1/maintenance/performance.html#network):
```bash
curl -X PUT "http://localhost:5984/_config/httpd/socket_options" -d '"[{nodelay, true}]"'
```
## Install
$ sudo gem install couchrest
## Basic Usage
Getting started with CouchRest is easy. You can send requests directly to a URL using a [RestClient](https://github.com/rest-client/rest-client)-like interface:
```ruby
CouchRest.put("http://localhost:5984/testdb/doc", 'name' => 'test', 'date' => Date.current)
```
Or use the lean server and database orientated API to take advantage of persistent and reusable connections:
```ruby
server = CouchRest.new # assumes localhost by default!
db = server.database!('testdb') # create db if it doesn't already exist
# Save a document, with ID
db.save_doc('_id' => 'doc', 'name' => 'test', 'date' => Date.current)
# Fetch doc
doc = db.get('doc')
doc.inspect # #
# Delete
db.delete_doc(doc)
```
## 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 1.7.19
* Rubinius 2.5.7
See the [Travis Build status](https://travis-ci.org/couchrest/couchrest) for more details.
## Docs
Changes history: [history.txt](./history.txt)
API: [http://rdoc.info/projects/couchrest/couchrest](http://rdoc.info/projects/couchrest/couchrest)
Check the wiki for documentation and examples [http://wiki.github.com/couchrest/couchrest](http://wiki.github.com/couchrest/couchrest)
## Contact
Please post bugs, suggestions and patches to the bug tracker at [http://github.com/couchrest/couchrest/issues](http://github.com/couchrest/couchrest/issues).
Follow us on Twitter: [http://twitter.com/couchrest](http://twitter.com/couchrest)
Also, check [https://twitter.com/search?q=couchrest](https://twitter.com/search?q=couchrest)