Merge pull request #34 from dadi/feature/add-debug-module

feat: use debug instead of logger

Author: jimlambie

README.md

@@ -3,7 +3,7 @@
 > A high-level library for interacting with DADI API
 
 [![npm (scoped)](https://img.shields.io/npm/v/@dadi/api-wrapper.svg?maxAge=10800&style=flat-square)](https://www.npmjs.com/package/@dadi/api-wrapper)
-![coverage](https://img.shields.io/badge/coverage-93%25-brightgreen.svg?style=flat-square)
+![coverage](https://img.shields.io/badge/coverage-91%25-brightgreen.svg?style=flat-square)
 [![Build Status](https://travis-ci.org/dadi/api-wrapper.svg?branch=master)](https://travis-ci.org/dadi/api-wrapper)
 [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)

index.js

@@ -21,14 +21,6 @@ const APIWrapper = function (options) {
       path: __dirname + '/.wallet/token.' + this._slugify(options.uri + options.port) + '.' + this._slugify(options.credentials.clientId) + '.json'
     }
   }
-
-  // Initialise logger
-  this.logger = require('@dadi/logger')
-  this.logger.init({
-    enabled: true,
-    filename: 'api-wrapper',
-    level: this.options.debug ? 'info' : 'warn'
-  })
 }
 
 APIWrapper.prototype = new APIWrapperCore()

lib/helpers.js

@@ -1,18 +1,19 @@
 'use strict'
 
+const debug = require('debug')('api-wrapper')
 const passport = require('@dadi/passport')
 const request = require('request-promise')
 
 module.exports = function (APIWrapper) {
   /**
-   * Logs a message. Overrides the basic log mechanism with DADI Logger
+   * Logs a debug message to the console when running with `DEBUG=*`.
    *
    * @param {String} message
    * @return undefined
    * @api private
    */
   APIWrapper.prototype._log = function (message) {
-    this.logger.info(message)
+    debug(message)
   }
 
   /**

package.json

@@ -12,8 +12,8 @@
   "license": "GPL",
   "dependencies": {
     "@dadi/api-wrapper-core": "1.x.0",
-    "@dadi/logger": "^1.1.3",
     "@dadi/passport": "^1.2.0",
+    "debug": "^2.6.1",
     "query-string": "^4.1.0",
     "request-promise": "^2.0.1",
     "standard": "*"

scripts/coverage.svg

@@ -355,4 +355,26 @@ describe('Terminators', function (done) {
         })
     })
   })
+
+  describe('getCollections', function () {
+    afterEach(function () {
+      apiWrapper.prototype._buildURL.restore()
+    })
+
+    it('should call buildUrl with {collections:true}', function() {
+      var host = options.uri + ':' + options.port
+      var urlPath = '/api/collections'
+      var scope = nock(host).get(urlPath).reply(200)
+
+      sinon.stub(apiWrapper.prototype, '_buildURL', function() {
+        var args = arguments[0]
+        args.should.eql({collections:true})
+        return this.options.uri + ':' + this.options.port + '/api/collections'
+      })
+
+      return wrapper.getCollections().then().catch((err) => {
+        throw err
+      })
+    })
+  })
 })