nock - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

package.json

 { "name" : "nock"
 , "description" : "HTTP Server mocking for Node.js"
 , "tags" : ["Mock", "HTTP", "testing", "isolation"]
-, "version" : "0.0.1"
+, "version" : "0.1.0"
 , "author" : "Pedro Teixeira <[e-mail]>"
@@ -6,0 +6,0 @@ , "repository" :

README.md

@@ -9,14 +9,81 @@ # Nock
 
-## Install
+# Install
 
     $ npm install nock
 
-## Use
+# Use
 
-On your test, you can do this:
+On your test, you can setup your mocking object like this:
 
     var nock = require('nock');
 
-    couchdb = mokk('http://myapp.iriscouch.com')
-                .get('/users/1')
-                .reply
+    var couchdb = nock('http://myapp.iriscouch.com')
+                    .get('/users/1')
+                    .reply(200, {_id: "123ABC", _rev: "946B7D1C", username: 'pgte', email: '[e-mail]'});
+
+This setup says that we will intercept every HTTP call to `http://myapp.iriscouch.com`.
+
+It will intercept an HTTP GET request to '/users/1' and reply with a status 404.
+
+Then the test can call the module, and the module will do the HTTP requests.
+
+## Specifying replies
+
+You can specify the return status code for a path on the first argument of reply like this:
+
+  var couchdb = nock('http://myapp.iriscouch.com')
+                  .get('/users/1')
+                  .reply(404);
+
+You can also specify the reply body as a string:
+
+var couchdb = nock('http://www.google.com')
+                .get('/')
+                .reply(200, "Hello from Google!");
+
+as a JSON-encoded object:
+
+var couchdb = nock('http://myapp.iriscouch.com')
+                .get('/')
+                .reply(200, {username: 'pgte', email: '[e-mail]', _id: "4324243fsd"});
+
+or even as a file:
+
+var couchdb = nock('http://myapp.iriscouch.com')
+                .get('/')
+                .replyWithFile(200, __dirname + '/replies/user.json');
+
+## Chaining
+
+You can chain behaviour like this:
+
+    var couchdb = nock('http://myapp.iriscouch.com')
+                    .get('/users/1')
+                    .reply(404)
+                    .post('/users', {username: 'pgte', email: '[e-mail]'})
+                    .reply(201, {ok: true, id: "123ABC", rev: "946B7D1C"})
+                    .get('/users/123ABC')
+                    .reply(200, {_id: "123ABC", _rev: "946B7D1C", username: 'pgte', email: '[e-mail]'});
+
+
+# Expectations
+
+Every time an HTTP request is performed for a scope that is mocked, Nock expects to find a handler for it. If it doesn't, it will throw an error.
+
+Calls to nock() return a scope which you can assert by calling `scope.done()`. This will assert that all specified calls on that scope were performed.
+
+Example:
+
+    var google = nock('http://google.com')
+                    .get('/')
+                    .reply(200, 'Hello from Google!');
+
+    // do some stuff
+
+    setTimeout(function() {
+      google.done(); // will throw an assertion error if meanwhile a "GET http://google.com" was not performed.
+    });
+
+# How does it work?
+
+Nock works by overriding Node's http.request function.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13892

increased by1279.54%

Number of package files

9

increased by125%

Lines of code

368

increased byInfinity%

Number of lines in readme file

88

increased by319.05%

Worsened metrics

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

3

increased by200%

No dependency changes