nock 9.2.2 → 9.2.6

package/README.md

@@ -187,64 +187,51 @@ var scope = nock('http://www.example.com')
 
 ## Specifying request body
 
-You can specify the request body to be matched as the second argument to the `get`, `post`, `put` or `delete` specifications like this:
+You can specify the request body to be matched as the second argument to the `get`, `post`, `put` or `delete` specifications. There are four types of second argument allowed:
+
+**String**: nock will exact match the stringified request body with the provided string
 
 ```js
-var scope = nock('http://myapp.iriscouch.com')
-                .post('/users', {
-                  username: 'pgte',
-                  email: 'pedro.teixeira@gmail.com'
-                })
-                .reply(201, {
-                  ok: true,
-                  id: '123ABC',
-                  rev: '946B7D1C'
-                });
+nock('http://www.example.com')
+  .post('/login', 'username=pgte&password=123456')
+  .reply(200, { id: '123ABC' });
 ```
 
-The request body can be a string, a RegExp, a JSON object or a function.
+**RegExp**: nock will test the stringified request body against the provided RegExp
 
 ```js
-var scope = nock('http://myapp.iriscouch.com')
-                .post('/users', /email=.?@gmail.com/gi)
-                .reply(201, {
-                  ok: true,
-                  id: '123ABC',
-                  rev: '946B7D1C'
-                });
+nock('http://www.example.com')
+  .post('/login', /username=\w+/gi)
+  .reply(200, { id: '123ABC' });
 ```
 
-If the request body is a JSON object, a RegExp can be used to match an attribute value.
+**JSON object**: nock will exact match the request body with the provided object. In order to increase flexibility, nock also supports RegExp as an attribute value for the keys:
 
 ```js
-var scope = nock('http://myapp.iriscouch.com')
-                .post('/users', {
-                  username: 'pgte',
-                  password: /a.+/,
-                  email: 'pedro.teixeira@gmail.com'
-                })
-                .reply(201, {
-                  ok: true,
-                  id: '123ABC',
-                  rev: '946B7D1C'
-                });
+nock('http://www.example.com')
+  .post('/login', { username: 'pgte', password: /.+/i })
+  .reply(200, { id: '123ABC' });
 ```
 
-If the request body is a function, return true if it should be considered a match:
+**Function**: nock will evaluate the function providing the request body object as first argument. Return true if it should be considered a match:
 
 ```js
-var scope = nock('http://myapp.iriscouch.com')
-                .post('/users', function(body) {
-                  return body.id === '123ABC';
-                })
-                .reply(201, {
-                  ok: true,
-                  id: '123ABC',
-                  rev: '946B7D1C'
-                });
+nock('http://www.example.com')
+  .post('/login', function(body) { 
+    return body.username && body.password;
+  })
+  .reply(200, { id: '123ABC' });
+```
+
+In case you need to perform a partial matching on a complex, nested request body you should have a look at libraries like [lodash.matches](https://lodash.com/docs/#matches). Indeed, partial matching can be achieved as:
 
+```js
+nock('http://www.example.com')
+  .post('/user', _.matches({ address: { country: 'US' } }))
+  .reply(200, { id: '123ABC' });
 ```
 
+
 ## Specifying request query string
 
 Nock understands query strings. Instead of placing the entire URL, you can specify the query part as an object:

package/lib/common.js

@@ -266,7 +266,7 @@ var headersArrayToObject = function (rawHeaders) {
   var headers = {};
 
   for (var i=0, len=rawHeaders.length; i<len; i=i+2) {
-    var key = rawHeaders[i];
+    var key = rawHeaders[i].toLowerCase();
     var value = rawHeaders[i+1];
 
     if (headers[key]) {

package/lib/match_body.js

@@ -2,6 +2,7 @@
 
 var deepEqual = require('deep-equal');
 var qs = require('qs');
+var _ = require('lodash')
 
 module.exports =
 function matchBody(spec, body) {
@@ -14,10 +15,14 @@ function matchBody(spec, body) {
     body = body.toString();
   }
 
-  var contentType = options.headers && (options.headers['Content-Type'] ||
-                                        options.headers['content-type']);
+  var contentType = (
+    options.headers &&
+    (options.headers['Content-Type'] || options.headers['content-type']) ||
+    ''
+  ).toString();
 
-  var isMultipart = contentType && contentType.toString().match(/multipart/);
+  var isMultipart = contentType.indexOf('multipart') >= 0;
+  var isUrlencoded = contentType.indexOf('application/x-www-form-urlencoded') >= 0;
 
   // try to transform body to json
   var json;
@@ -25,10 +30,8 @@ function matchBody(spec, body) {
     try { json = JSON.parse(body);} catch(err) {}
     if (json !== undefined) {
       body = json;
-    } else {
-      if (contentType && contentType.toString().match(/application\/x-www-form-urlencoded/)) {
-        body = qs.parse(body, { allowDots: true });
-      }
+    } else if (isUrlencoded) {
+      body = qs.parse(body, { allowDots: true });
     }
   }
 
@@ -54,9 +57,37 @@ function matchBody(spec, body) {
     spec = spec.replace(/\r?\n|\r/g, '');
   }
 
+  if (isUrlencoded) {
+    spec = mapValuesDeep(spec, function(val) {
+      if (_.isRegExp(val)) {
+        return val
+      }
+      return val + ''
+    })
+  }
+
   return deepEqualExtended(spec, body);
 };
 
+
+/**
+ * Based on lodash issue discussion
+ * https://github.com/lodash/lodash/issues/1244
+ */
+function mapValuesDeep(obj, cb) {
+  if (_.isArray(obj)) {
+    return obj.map(function(v) {
+      return mapValuesDeep(v, cb)
+    })
+  }
+  if (_.isPlainObject(obj)) {
+    return _.mapValues(obj, function(v) {
+      return mapValuesDeep(v, cb)
+    })
+  }
+  return cb(obj)
+}
+
 function deepEqualExtended(spec, body) {
   if (spec && spec.constructor === RegExp) {
     return spec.test(body);

package/lib/recorder.js

@@ -74,11 +74,11 @@ var getBodyFromChunks = function(chunks, headers) {
   //    2.  A string buffer which represents a JSON object.
   //    3.  A string buffer which doesn't represent a JSON object.
 
-  var isBinary = common.isBinaryBuffer(mergedBuffer)
+  var isBinary = common.isBinaryBuffer(mergedBuffer);
   if(isBinary) {
     return {
       body: mergedBuffer.toString('hex'),
-      isBinary
+      isBinary: true
     }
   } else {
     var maybeStringifiedJson = mergedBuffer.toString('utf8');

package/package.json

@@ -7,7 +7,7 @@
     "testing",
     "isolation"
   ],
-  "version": "9.2.2",
+  "version": "9.2.6",
   "author": "Pedro Teixeira <pedro.teixeira@gmail.com>",
   "contributors": [
     {