chore(test): mock all request responses (#376)

* chore(test): mock all request responses

* chore(ci): run tests on circleci

* fix(ci): put lint and test in seperate run lines

* chore: make mock data json more human readable

* feat: add a way to re-record mock data

* fix(ci): disable weather test

The upstream data source is currently broken so we're disablign the test
for now.

* chore(test): re-record the mock test data

* Add a note about `nock` in the README docs

Author: Kristján Oddsson

.circleci/config.yml

@@ -8,7 +8,7 @@ jobs:
     docker:
       # specify the version you desire here
       - image: circleci/node:7.10
-      
+
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
       # documented at https://circleci.com/docs/2.0/circleci-images/
@@ -32,6 +32,6 @@ jobs:
           paths:
             - node_modules
           key: v1-dependencies-{{ checksum "package.json" }}
-        
-      # run tests!
+
       - run: yarn run lint
+      - run: yarn run test

README.md

@@ -39,6 +39,22 @@ To run the tests:
 $ npm test
 ```
 
+The tests utilize a man-in-the-middle library called [nock](https://github.com/node-nock/nock) that
+intercepts requests that the tests made and respond with data from disk. The data was generated using
+the [record feature](https://github.com/node-nock/nock#recording) and saved in [`mock-data.json`](mock-data.json).
+
+If a endpoints data source has changed and the we need to re-record this data we can simply set the
+env variable `RECORD_MOCK_DATA` to a truthy value and run the tests. This will disable nock in the tests
+and make requests to each endpoints data source and save that to disk.
+
+```sh
+RECORD_MOCK_DATA=true npm test
+```
+
+Newly added endpoints should mock the endpoints data source using the `nock` API since this initial
+data mocking was only made to help migrate to a mocking library. See the [original PR](https://github.com/apis-is/apis/pull/376)
+for more info.
+
 ## Adding a new Endpoint
 
 ### Step by Step

endpoints/weather/tests/integration_test.js

@@ -10,7 +10,7 @@ describe('weather', () => {
     request.get(params, resultHandler)
   })
 
-  describe('getAvailableStations', () => {
+  describe.skip('getAvailableStations', () => {
     it('should return an array of objects containing correct fields', (done) => {
       const fieldsToCheckFor = ['name', 'id']
       const params = helpers.testRequestParams('/weather/getAvailableStations')