vulcan 0.6.1 → 0.7.0

data/server/node_modules/cradle/node_modules/follow/lib/index.js

@@ -0,0 +1,66 @@
+// Copyright 2011 Iris Couch
+//
+//    Licensed under the Apache License, Version 2.0 (the "License");
+//    you may not use this file except in compliance with the License.
+//    You may obtain a copy of the License at
+//
+//        http://www.apache.org/licenses/LICENSE-2.0
+//
+//    Unless required by applicable law or agreed to in writing, software
+//    distributed under the License is distributed on an "AS IS" BASIS,
+//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//    See the License for the specific language governing permissions and
+//    limitations under the License.
+
+exports.scrub_creds = function scrub_creds(url) {
+  return url.replace(/^(https?:\/\/)[^:]+:[^@]+@(.*)$/, '$1$2'); // Scrub username and password
+}
+
+exports.JP = JSON.parse;
+exports.JS = JSON.stringify;
+exports.JDUP = function(obj) { return JSON.parse(JSON.stringify(obj)) };
+
+var timeouts = { 'setTimeout': setTimeout
+               , 'clearTimeout': clearTimeout
+               }
+
+exports.setTimeout   = function() { return timeouts.setTimeout.apply(this, arguments) }
+exports.clearTimeout = function() { return timeouts.clearTimeout.apply(this, arguments) }
+exports.timeouts = function(set, clear) {
+  timeouts.setTimeout = set
+  timeouts.clearTimeout = clear
+}
+
+// Wrap log4js so it will not be a dependency.
+var VERBOSE;
+if(require.isBrowser)
+  VERBOSE = true;
+else
+  VERBOSE = (process.env.verbose === 'true');
+
+var noop = function() {}
+if(process.env.TAP_DIAG)
+  noop = console.error
+
+function noops() {
+  return { "trace": noop
+         , "debug": VERBOSE ? console.log   : noop
+         , "info" : VERBOSE ? console.info  : noop
+         , "warn" : VERBOSE ? console.warn  : noop
+         , "error": VERBOSE ? console.error : noop
+         , "fatal": VERBOSE ? console.error : noop
+
+         , "level": {'level':0, 'levelStr':'noop'}
+         , "setLevel": noop
+         }
+}
+
+
+try {
+  if(! process.env.log_plain)
+    exports.log4js = require('log4js');
+} catch(e) {
+  exports.log4js = null;
+}
+
+exports.log4js = exports.log4js || { 'getLogger': function() { return noops() } }

data/server/node_modules/cradle/node_modules/follow/lib/stream.js

@@ -0,0 +1,305 @@
+// Changes stream
+//
+// Copyright 2011 Iris Couch
+//
+//    Licensed under the Apache License, Version 2.0 (the "License");
+//    you may not use this file except in compliance with the License.
+//    You may obtain a copy of the License at
+//
+//        http://www.apache.org/licenses/LICENSE-2.0
+//
+//    Unless required by applicable law or agreed to in writing, software
+//    distributed under the License is distributed on an "AS IS" BASIS,
+//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//    See the License for the specific language governing permissions and
+//    limitations under the License.
+
+var lib = require('../lib')
+  , util = require('util')
+  , stream = require('stream')
+  , request = require('request')
+
+// Use the library timeout functions, primarily so the test suite can catch errors.
+var setTimeout = lib.setTimeout
+  , clearTimeout = lib.clearTimeout
+
+
+var DEFS =
+  { 'longpoll_header': '{"results":['
+  , 'log_level'      : process.env.follow_log_level || 'info'
+  }
+
+module.exports = { 'Changes': Changes
+                 }
+
+
+util.inherits(Changes, stream)
+function Changes (opts) {
+  var self = this
+  stream.call(self)
+
+  self.readable = true
+  self.writable = true
+
+  self.headers = {}
+  self.statusCode = null
+
+  opts = opts || {}
+  self.feed = opts.feed || null // "continuous" or "longpoll"
+  self.encoding = opts.encoding || 'utf8'
+
+  self.log = opts.log
+  if(!self.log) {
+    self.log = lib.log4js.getLogger('change_stream')
+    self.log.setLevel(DEFS.log_level)
+  }
+
+  self.is_sending = true
+  self.is_ending = false
+  self.is_dead = false
+
+  self.source = null
+  self.expect = null
+  self.buf = null
+  self.changes = []
+
+  self.on('pipe', function(src) {
+    if(!self.source)
+      self.source = src
+    else {
+      var er = new Error('Already have a pipe source')
+      er.source = self.source
+      self.error(er)
+    }
+  })
+}
+
+
+Changes.prototype.setHeader = function(key, val) {
+  var self = this
+  self.headers[key] = val
+}
+
+//
+// Readable stream API
+//
+
+Changes.prototype.setEncoding = function(encoding) {
+  var self = this
+  self.encoding = encoding // TODO
+}
+
+
+Changes.prototype.pause = function() {
+  var self = this
+  self.is_sending = false
+
+  if(self.source && self.source.pause)
+    self.source.pause()
+}
+
+
+Changes.prototype.resume = function() {
+  var self = this
+  self.is_sending = true
+  if(self.source && self.source.resume)
+    self.source.resume()
+  self.emit_changes()
+}
+
+//
+// Writable stream API
+//
+
+Changes.prototype.write = function(data, encoding) {
+  var self = this
+
+  data = self.normalize_data(data, encoding)
+  if(typeof data != 'string')
+    return // Looks like normalize_data emitted an error.
+
+  if(self.feed === 'longpoll')
+    return self.write_longpoll(data)
+  else if(self.feed === 'continuous')
+    return self.write_continuous(data)
+}
+
+
+Changes.prototype.write_longpoll = function(data) {
+  var self = this
+
+  if(self.buf === null)
+    self.buf = []
+
+  self.buf.push(data)
+  return true
+}
+
+
+Changes.prototype.write_continuous = function(data) {
+  var self = this
+
+  var offset, json, change
+    , buf = (self.buf || "") + data
+
+  self.log.debug('write: ' + util.inspect({'data':data, 'buf':buf}))
+
+  // Buf could have 0, 1, or many JSON objects in it.
+  while((offset = buf.indexOf("\n")) >= 0) {
+    json = buf.substr(0, offset);
+    buf = buf.substr(offset + 1);
+    self.log.debug('JSON: ' + util.inspect(json))
+
+    // Heartbeats (empty strings) are fine, but otherwise confirm valid JSON.
+    if(json === "")
+      ;
+
+    else if(json[0] !== '{')
+      return self.error(new Error('Non-object JSON data: ' + json))
+
+    else {
+      try { change = JSON.parse(json) }
+      catch (er) { return self.error(er) }
+
+      self.log.debug('Object: ' + util.inspect(change))
+      json = JSON.stringify(change)
+    }
+
+    // Change (or heartbeat) looks good.
+    self.changes.push(json)
+  }
+
+  // Remember the unused data and send all known good changes (or heartbeats).
+  self.buf = buf
+  self.emit_changes()
+
+  return self.is_sending
+}
+
+
+Changes.prototype.end = function(data, encoding) {
+  var self = this
+
+  self.is_ending = true
+  self.writable = false
+
+  // Always call write, even with no data, so it can fire the "end" event.
+  self.write(data, encoding)
+
+  if(self.feed === 'longpoll') {
+    var changes = [ DEFS.longpoll_header ].concat(self.buf).join('')
+    try { changes = JSON.parse(changes) || {} }
+    catch (er) { return self.error(er) }
+
+    if(!Array.isArray(changes.results))
+      return self.error(new Error('No "results" field in feed'))
+    if(self.changes.length !== 0)
+      return self.error(new Error('Changes are already queued: ' + JSON.stringify(self.changes)))
+
+    self.changes = changes.results.map(function(change) { return JSON.stringify(change) })
+    return self.emit_changes()
+  }
+
+  else if(self.feed === 'continuous') {
+    if(self.buf !== "")
+      self.log.debug('Unprocessed data after "end" called: ' + util.inspect(self.buf))
+  }
+}
+
+
+Changes.prototype.emit_changes = function() {
+  var self = this
+
+  while(self.is_sending && self.changes.length > 0) {
+    var change = self.changes.shift()
+    if(change === "") {
+      self.log.debug('emit: heartbeat')
+      self.emit('heartbeat')
+    }
+
+    else {
+      self.log.debug('emit: data')
+      self.emit('data', change)
+    }
+  }
+
+  if(self.is_sending && self.is_ending && self.changes.length === 0) {
+    self.is_ending = false
+    self.readable = false
+    self.log.debug('emit: end')
+    self.emit('end')
+  }
+}
+
+//
+// Readable/writable stream API
+//
+
+Changes.prototype.destroy = function() {
+  var self = this
+  self.log.debug('destroy')
+
+  self.is_dead = true
+  self.is_ending = false
+  self.is_sending = false
+
+  if(self.source && typeof self.source.destroy === 'function')
+    self.source.destroy()
+
+  // Often the source is from the request package, so destroy its response object.
+  if(self.source && self.source.__isRequestRequest && self.source.response
+  && typeof self.source.response.destroy === 'function')
+    self.source.response.destroy()
+}
+
+
+Changes.prototype.destroySoon = function() {
+  var self = this
+  throw new Error('not implemented')
+  //return self.request.destroySoon()
+}
+
+//
+// Internal implementation
+//
+
+Changes.prototype.normalize_data = function(data, encoding) {
+  var self = this
+
+  if(data instanceof Buffer)
+    data = data.toString(encoding)
+  else if(typeof data === 'undefined' && typeof encoding === 'undefined')
+    data = ""
+
+  if(typeof data != 'string')
+    return self.error(new Error('Not a string or Buffer: ' + util.inspect(data)))
+
+  if(self.feed !== 'continuous' && self.feed !== 'longpoll')
+    return self.error(new Error('Must set .feed to "continuous" or "longpoll" before writing data'))
+
+  if(self.expect === null)
+    self.expect = (self.feed == 'longpoll')
+                    ? DEFS.longpoll_header
+                    : ""
+
+  var prefix = data.substr(0, self.expect.length)
+  data = data.substr(prefix.length)
+
+  var expected_part = self.expect.substr(0, prefix.length)
+    , expected_remainder = self.expect.substr(expected_part.length)
+
+  if(prefix !== expected_part)
+    return self.error(new Error('Prefix not expected '+util.inspect(expected_part)+': ' + util.inspect(prefix)))
+
+  self.expect = expected_remainder
+  return data
+}
+
+
+Changes.prototype.error = function(er) {
+  var self = this
+
+  self.readable = false
+  self.writable = false
+  self.emit('error', er)
+}

data/server/node_modules/cradle/node_modules/follow/node_modules/request/LICENSE

@@ -0,0 +1,55 @@
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/server/node_modules/cradle/node_modules/follow/node_modules/request/README.md

@@ -0,0 +1,285 @@
+# Request -- Simplified HTTP request method
+
+## Install
+
+<pre>
+  npm install request
+</pre>
+
+Or from source:
+
+<pre>
+  git clone git://github.com/mikeal/request.git 
+  cd request
+  npm link
+</pre>
+
+## Super simple to use
+
+Request is designed to be the simplest way possible to make http calls. It support HTTPS and follows redirects by default.
+
+```javascript
+var request = require('request');
+request('http://www.google.com', function (error, response, body) {
+  if (!error && response.statusCode == 200) {
+    console.log(body) // Print the google web page.
+  }
+})
+```
+
+## Streaming
+
+You can stream any response to a file stream.
+
+```javascript
+request('http://google.com/doodle.png').pipe(fs.createWriteStream('doodle.png'))
+```
+
+You can also stream a file to a PUT or POST request. This method will also check the file extension against a mapping of file extensions to content-types, in this case `application/json`, and use the proper content-type in the PUT request if one is not already provided in the headers.
+
+```javascript
+fs.readStream('file.json').pipe(request.put('http://mysite.com/obj.json'))
+```
+
+Request can also pipe to itself. When doing so the content-type and content-length will be preserved in the PUT headers.
+
+```javascript
+request.get('http://google.com/img.png').pipe(request.put('http://mysite.com/img.png'))
+```
+
+Now let's get fancy.
+
+```javascript
+http.createServer(function (req, resp) {
+  if (req.url === '/doodle.png') {
+    if (req.method === 'PUT') {
+      req.pipe(request.put('http://mysite.com/doodle.png'))
+    } else if (req.method === 'GET' || req.method === 'HEAD') {
+      request.get('http://mysite.com/doodle.png').pipe(resp)
+    } 
+  }
+})
+```
+
+You can also pipe() from a http.ServerRequest instance and to a http.ServerResponse instance. The HTTP method and headers will be sent as well as the entity-body data. Which means that, if you don't really care about security, you can do:
+
+```javascript
+http.createServer(function (req, resp) {
+  if (req.url === '/doodle.png') {
+    var x = request('http://mysite.com/doodle.png')
+    req.pipe(x)
+    x.pipe(resp)
+  }
+})
+```
+
+And since pipe() returns the destination stream in node 0.5.x you can do one line proxying :)
+
+```javascript
+req.pipe(request('http://mysite.com/doodle.png')).pipe(resp)
+```
+
+Also, none of this new functionality conflicts with requests previous features, it just expands them.
+
+```javascript
+var r = request.defaults({'proxy':'http://localproxy.com'})
+
+http.createServer(function (req, resp) {
+  if (req.url === '/doodle.png') {
+    r.get('http://google.com/doodle.png').pipe(resp)
+  }
+})
+```
+
+You can still use intermediate proxies, the requests will still follow HTTP forwards, etc.
+
+## OAuth Signing
+
+```javascript
+// Twitter OAuth
+var qs = require('querystring')
+  , oauth =
+    { callback: 'http://mysite.com/callback/'
+    , consumer_key: CONSUMER_KEY
+    , consumer_secret: CONSUMER_SECRET
+    }
+  , url = 'https://api.twitter.com/oauth/request_token'
+  ;
+request.post({url:url, oauth:oauth}, function (e, r, body) {
+  // Assume by some stretch of magic you aquired the verifier
+  var access_token = qs.parse(body)
+    , oauth = 
+      { consumer_key: CONSUMER_KEY
+      , consumer_secret: CONSUMER_SECRET
+      , token: access_token.oauth_token
+      , verifier: VERIFIER
+      , token_secret: access_token.oauth_token_secret
+      }
+    , url = 'https://api.twitter.com/oauth/access_token'
+    ;
+  request.post({url:url, oauth:oauth}, function (e, r, body) {
+    var perm_token = qs.parse(body)
+      , oauth = 
+        { consumer_key: CONSUMER_KEY
+        , consumer_secret: CONSUMER_SECRET
+        , token: perm_token.oauth_token
+        , token_secret: perm_token.oauth_token_secret
+        }
+      , url = 'https://api.twitter.com/1/users/show.json?'
+      , params = 
+        { screen_name: perm_token.screen_name
+        , user_id: perm_token.user_id
+        }
+      ;
+    url += qs.stringify(params)
+    request.get({url:url, oauth:oauth, json:true}, function (e, r, user) {
+      console.log(user)
+    })
+  })
+})
+```
+
+
+
+### request(options, callback)
+
+The first argument can be either a url or an options object. The only required option is uri, all others are optional.
+
+* `uri` || `url` - fully qualified uri or a parsed url object from url.parse()
+* `method` - http method, defaults to GET
+* `headers` - http headers, defaults to {}
+* `body` - entity body for POST and PUT requests. Must be buffer or string.
+* `json` - sets `body` but to JSON representation of value and adds `Content-type: application/json` header.
+* `multipart` - (experimental) array of objects which contains their own headers and `body` attribute. Sends `multipart/related` request. See example below.
+* `followRedirect` - follow HTTP 3xx responses as redirects. defaults to true.
+* `maxRedirects` - the maximum number of redirects to follow, defaults to 10.
+* `onResponse` - If true the callback will be fired on the "response" event instead of "end". If a function it will be called on "response" and not effect the regular semantics of the main callback on "end".
+* `encoding` - Encoding to be used on response.setEncoding when buffering the response data.
+* `pool` - A hash object containing the agents for these requests. If omitted this request will use the global pool which is set to node's default maxSockets.
+* `pool.maxSockets` - Integer containing the maximum amount of sockets in the pool.
+* `timeout` - Integer containing the number of milliseconds to wait for a request to respond before aborting the request	
+* `proxy` - An HTTP proxy to be used. Support proxy Auth with Basic Auth the same way it's supported with the `url` parameter by embedding the auth info in the uri.
+* `oauth` - Options for OAuth HMAC-SHA1 signing, see documentation above.
+* `strictSSL` - Set to `true` to require that SSL certificates be valid. Note: to use your own certificate authority, you need to specify an agent that was created with that ca as an option.
+* `jar` - Set to `false` if you don't want cookies to be remembered for future use or define your custom cookie jar (see examples section)
+
+
+The callback argument gets 3 arguments. The first is an error when applicable (usually from the http.Client option not the http.ClientRequest object). The second in an http.ClientResponse object. The third is the response body buffer.
+
+## Convenience methods
+
+There are also shorthand methods for different HTTP METHODs and some other conveniences.
+
+### request.defaults(options)  
+  
+This method returns a wrapper around the normal request API that defaults to whatever options you pass in to it.
+
+### request.put
+
+Same as request() but defaults to `method: "PUT"`.
+
+```javascript
+request.put(url)
+```
+
+### request.post
+
+Same as request() but defaults to `method: "POST"`.
+
+```javascript
+request.post(url)
+```
+
+### request.head
+
+Same as request() but defaults to `method: "HEAD"`.
+
+```javascript
+request.head(url)
+```
+
+### request.del
+
+Same as request() but defaults to `method: "DELETE"`.
+
+```javascript
+request.del(url)
+```
+
+### request.get
+
+Alias to normal request method for uniformity.
+
+```javascript
+request.get(url)
+```
+### request.cookie
+
+Function that creates a new cookie.
+
+```javascript
+request.cookie('cookie_string_here')
+```
+### request.jar
+
+Function that creates a new cookie jar.
+
+```javascript
+request.jar()
+```
+
+
+## Examples:
+
+```javascript
+  var request = require('request')
+    , rand = Math.floor(Math.random()*100000000).toString()
+    ;
+  request(
+    { method: 'PUT'
+    , uri: 'http://mikeal.iriscouch.com/testjs/' + rand
+    , multipart: 
+      [ { 'content-type': 'application/json'
+        ,  body: JSON.stringify({foo: 'bar', _attachments: {'message.txt': {follows: true, length: 18, 'content_type': 'text/plain' }}})
+        }
+      , { body: 'I am an attachment' }
+      ] 
+    }
+  , function (error, response, body) {
+      if(response.statusCode == 201){
+        console.log('document saved as: http://mikeal.iriscouch.com/testjs/'+ rand)
+      } else {
+        console.log('error: '+ response.statusCode)
+        console.log(body)
+      }
+    }
+  )
+```
+Cookies are enabled by default (so they can be used in subsequent requests). To disable cookies set jar to false (either in defaults or in the options sent).
+
+```javascript
+var request = request.defaults({jar: false})
+request('http://www.google.com', function () {
+  request('http://images.google.com')
+})
+```
+
+If you to use a custom cookie jar (instead of letting request use its own global cookie jar) you do so by setting the jar default or by specifying it as an option:
+
+```javascript
+var j = request.jar()
+var request = request.defaults({jar:j})
+request('http://www.google.com', function () {
+  request('http://images.google.com')
+})
+```
+OR
+
+```javascript
+var j = request.jar()
+var cookie = request.cookie('your_cookie_here')
+j.add(cookie)
+request({url: 'http://www.google.com', jar: j}, function () {
+  request('http://images.google.com')
+})
+```