caolan / couchr

Lightweight CouchDB request library for Node and the browser

couchr

Simple request library for CouchDB. Provides both a Node.js module and a browser module (based on jQuery.ajax), with better CouchDB error reporting and a simpler API than making XHR requests directly in the browser.

Examples

// browser
require(['couchr'], function (couchr) {
    couchr.get('/dbname/docid', function (err, doc) {
        ...
    });
});

// Node
var couchr = require('couchr');
couchr.get('http://hostname:port/dbname/docid', function (err, doc) {
    ...
});

Methods

couchr.get (url, /*optional*/params, function (err, res, req) { ... })
couchr.post(url, /*optional*/data,   function (err, res, req) { ... })
couchr.put (url, /*optional*/data,   function (err, res, req) { ... })
couchr.del (url, /*optional*/data,   function (err, res, req) { ... })
couchr.head(url, function (err, res, req) { ... })

couchr.copy(from, to, function (err, res, req) { ... }) 

var feed = couchr.changes(db_url);
feed.on('change', function (change_object) { ...  });
feed.on('error', function (err) { ...  });
feed.pause();
feed.resume();

Installation

Browser (using jam):

jam install couchr

Node (using npm):

npm install couchr

couchr's Issues

how can i handle with _attachments?

Hi @caolan,

how can i handle with _attachments using couchr (hoodie.request)?

thanks

follow redirects?

Right now if you get a 301 or 302 from a request, couchr handles it like an error. Would it be useful to follow the redirect before returning an error (as well as handling auth headers and such)?

put this in bower pls

very usefull to create hoodie plugins

Possible mis-handling UTF-8 strings in HEAD requests

I use HEAD requests to get eTag values for caching purposes for given queries.

If my cache under that eTag is a miss, then I make a GET request.

Since the couchr.head() call does not accept arguments as GET does, I pass the arguments along as a query string to the HEAD request.

In doing so, I discovered that when "key=" strings containing UTF-8 values (emoji), the HEAD would return a different eTag value than the GET would using the same strings. Non-emoji-containing strings would work as expected.

I was able to work around this seeming limitation by performing - for HEAD requests - the encoding dance that couchr uses for GET strings.

Unless I am abusing the spec, it would seem that couchr should natively handle this string encoding.

Here is a snippet I used to take a json object containing values and returning a string properly encoded for use as the arguments to the HEAD call.

function getHeadArgs(lookup) {
  var dup = JSON.parse(JSON.stringify(lookup));
  ['key', 'keys', 'startkey', 'endkey'].forEach(function(key) {
    if (dup[key] != null) {
      dup[key] = JSON.stringify(dup[key]);
    }
  });
  return querystring.stringify(dup);
}

var encoded = getHeadArgs({ key: '💟💜💛💚💙💙!!' });

couchr.head(URL + '?' + encoded);

ios 4.0 safari browser does not like 'delete' as a property

Testing an app using couchr on an older ios and it does not like the reserved word 'delete'. maybe we can rename the method to 'del' or something else?