Make cassette API more predictable by splitting it into two calls

This will give users of this library more control over how they want to
mount and unmount multiple cassettes. As well as the added benefit of
being able to control when cassettes can be unmounted. Which in turn
simplifies how one would deal with multiple promises.

Author: nettofarah

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.0.0 (Feb 10, 2017)
+- Split casssette API in two functions so users can mount and unmount cassettes at different parts of their codebase
+
 ## 0.1.0 (Jun 16, 2016)
 ### Added
 - Initial release

README.md

@@ -25,11 +25,29 @@ Using axios-vcr is very simple. All you need to do is to provide a cassette path
 ```javascript
 var axiosVCR = require('axios-vcr');
 
-axiosVCR.mountCassette('./test/fixtures/cats.json', () => {
-  axios.get('https://reddit.com/r/cats.json').then(response => {
-    // axios-vcr will store the remote response from /cats.json
-    // in ./test/fixtures/cats.json
-    // Subsequent requests will then load the response directly from the file system
+axiosVCR.mountCassette('./test/fixtures/cats.json')
+
+axios.get('https://reddit.com/r/cats.json').then(response => {
+  // axios-vcr will store the remote response from /cats.json
+  // in ./test/fixtures/cats.json
+  // Subsequent requests will then load the response directly from the file system
+
+  VCR.ejectCassette('https://reddit.com/r/cats.json')
+})
+```
+
+### Usage in a test case
+```javascript
+it('makes your requests load faster and more reliably', function(done) {
+  // mount a cassette
+  axiosVCR.mountCassette('./fixtures/test_case_name.json')
+
+  myAPI.fetchSomethingFromRemote().then(function(response) {
+    assert.equal(response.something, 'some value')
+    done()
+
+    // Eject the cassette when all your promises have been fulfilled
+    axiosVCR.ejectCassette('./fixture/test_case_name.json')
   })
 })
 ```

index.js

@@ -1,7 +1,9 @@
 var RequestMiddleware = require('./lib/RequestMiddleware');
 var ResponseMiddleware = require('./lib/ResponseMiddleware');
 
-function mountCassette(cassettePath, cb) {
+var cassettes = {}
+
+function mountCassette(cassettePath) {
   var axios = require('axios');
 
   var responseInterceptor = axios.interceptors.response.use(
@@ -12,16 +14,26 @@ function mountCassette(cassettePath, cb) {
   var requestInterceptor = axios.interceptors.request.use(
     RequestMiddleware.success(cassettePath),
     RequestMiddleware.failure
-  )
+  );
+
+  cassettes[cassettePath] = {
+    responseInterceptor: responseInterceptor,
+    requestInterceptor: requestInterceptor,
+    axios: axios
+  };
+}
 
-  cb();
+function ejectCassette(cassettePath) {
+  var interceptors = cassettes[cassettePath];
+  var axios = interceptors.axios;
 
-  axios.interceptors.response.eject(responseInterceptor);
-  axios.interceptors.request.eject(requestInterceptor);
+  axios.interceptors.response.eject(interceptors.responseInterceptor);
+  axios.interceptors.request.eject(interceptors.requestInterceptor);
 }
 
 module.exports = {
   mountCassette: mountCassette,
+  ejectCassette: ejectCassette,
   RequestMiddleware: RequestMiddleware,
   ResponseMiddleware: ResponseMiddleware
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "axios-vcr",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "axios-vcr is a set of middlewares for axios that allow you to record and replay requests.",
   "main": "index.js",
   "homepage": "http://github.com/nettofarah/axios-vcr",

test/axios_vcr_test.js

@@ -35,38 +35,43 @@ describe('Axios VCR', function() {
 
     it('generates stubs for requests', function(done) {
       var path = './test/fixtures/posts.json'
-      VCR.mountCassette(path, function () {
-        axios.get(posts).then(function(response) {
-          getFixture(path, response.config).then(function(fixture) {
-            assert.deepEqual(fixture.originalResponseData.data, response.data)
-            done()
-          })
+      VCR.mountCassette(path)
+
+      axios.get(posts).then(function(response) {
+        getFixture(path, response.config).then(function(fixture) {
+          assert.deepEqual(fixture.originalResponseData.data, response.data)
+          done()
+          VCR.ejectCassette(path)
         })
       })
     })
 
     it('works with nested folders', function(done) {
       var cassettePath = './test/fixtures/nested/posts.json'
-      VCR.mountCassette(cassettePath, function () {
-        axios.get(posts).then(function(response) {
-          getFixture(cassettePath, response.config).then(function(fixture) {
-            assert.deepEqual(fixture.originalResponseData.data, response.data)
-            done()
-          })
-        }).catch(function(err) { console.log(err) })
-      })
+      VCR.mountCassette(cassettePath)
+
+      axios.get(posts).then(function(response) {
+        getFixture(cassettePath, response.config).then(function(fixture) {
+          assert.deepEqual(fixture.originalResponseData.data, response.data)
+          done()
+
+          VCR.ejectCassette(cassettePath)
+        })
+      }).catch(function(err) { console.log(err) })
     })
 
     it('stores headers and status', function(done) {
       var cassettePath = './test/fixtures/posts.json'
-      VCR.mountCassette(cassettePath, function () {
-        axios.get(posts).then(function(response) {
-          getFixture(cassettePath, response.config).then(function(fixture) {
-            assert.deepEqual(fixture.originalResponseData.headers, response.headers)
-            assert.equal(fixture.originalResponseData.status, response.status)
-            assert.equal(fixture.originalResponseData.statusText, response.statusText)
-            done()
-          })
+      VCR.mountCassette(cassettePath)
+
+      axios.get(posts).then(function(response) {
+        getFixture(cassettePath, response.config).then(function(fixture) {
+          assert.deepEqual(fixture.originalResponseData.headers, response.headers)
+          assert.equal(fixture.originalResponseData.status, response.status)
+          assert.equal(fixture.originalResponseData.statusText, response.statusText)
+          done()
+
+          VCR.ejectCassette(cassettePath)
         })
       })
     })
@@ -84,14 +89,15 @@ describe('Axios VCR', function() {
       assert(fileExists(path))
 
       var url = 'http://something.com/unexisting'
+      VCR.mountCassette(path)
 
-      VCR.mountCassette(path, function () {
-        axios.get(url).then(function(res) {
-          getFixture(path, res.config).then(function(fixture) {
-            assert.deepEqual(fixture.originalResponseData, _.omit(res, 'fixture'))
-            done()
-          }).catch(err => { console.log(err); done() })
-        })
+      axios.get(url).then(function(res) {
+        getFixture(path, res.config).then(function(fixture) {
+          assert.deepEqual(fixture.originalResponseData, _.omit(res, 'fixture'))
+          done()
+
+          VCR.ejectCassette(path)
+        }).catch(err => { console.log(err); done() })
       })
     })
 
@@ -103,13 +109,14 @@ describe('Axios VCR', function() {
       } catch(e) {}
 
       assert(!fileExists(path))
+      VCR.mountCassette(path)
 
-      VCR.mountCassette(path, function () {
-        axios.get(posts).then(function(response) {
-          assert.equal(200, response.status)
-          fs.unlinkSync(path)
-          done()
-        })
+      axios.get(posts).then(function(response) {
+        assert.equal(200, response.status)
+        fs.unlinkSync(path)
+        done()
+
+        VCR.ejectCassette(path)
       })
     })
   })
@@ -126,22 +133,24 @@ describe('Axios VCR', function() {
     it('stores multiple requests in the same cassette', function(done) {
       var path = './test/fixtures/multiple.json'
 
-      VCR.mountCassette(path, function() {
-        var usersPromise = axios.get(usersUrl)
-        var todosPromise = axios.get(todosUrl)
+      VCR.mountCassette(path)
+
+      var usersPromise = axios.get(usersUrl)
+      var todosPromise = axios.get(todosUrl)
 
-        Promise.all([usersPromise, todosPromise]).then(function(responses) {
-          var usersResponse = responses[0]
-          var todosResponse = responses[1]
+      Promise.all([usersPromise, todosPromise]).then(function(responses) {
+        var usersResponse = responses[0]
+        var todosResponse = responses[1]
 
-          var usersResponsePromise = getFixture(path, usersResponse.config)
-          var todosResponsePromise = getFixture(path, todosResponse.config)
+        var usersResponsePromise = getFixture(path, usersResponse.config)
+        var todosResponsePromise = getFixture(path, todosResponse.config)
+
+        Promise.all([usersResponsePromise, todosResponsePromise]).then(function(fixtures) {
+          assert.deepEqual(fixtures[0].originalResponseData.data, usersResponse.data)
+          assert.deepEqual(fixtures[1].originalResponseData.data, todosResponse.data)
+          done()
 
-          Promise.all([usersResponsePromise, todosResponsePromise]).then(function(fixtures) {
-            assert.deepEqual(fixtures[0].originalResponseData.data, usersResponse.data)
-            assert.deepEqual(fixtures[1].originalResponseData.data, todosResponse.data)
-            done()
-          })
+          VCR.ejectCassette(path)
         })
       })
     })