Option based server.request()

lib/server/server.coffee

@@ -1,12 +1,14 @@
+_ = require('lodash')
 request = require('request')
 urlResolve = require('url').resolve
 async = require('async')
 config = require('../config')
 token = require('../token/token')
 
-exports.request = (method = 'GET', url, json, callback) ->
-	method = method.toUpperCase()
-	url = urlResolve(config.remoteUrl, url)
+exports.request = (options = {}, callback) ->
+
+	if not options.url?
+		throw new Error('Missing URL')
 
 	async.waterfall [
 
@@ -14,17 +16,20 @@ exports.request = (method = 'GET', url, json, callback) ->
 			token.getToken(callback)
 
 		(savedToken, callback) ->
-			requestOptions = {
-				url
-				method
-				json
-			}
+			options.url = urlResolve(config.remoteUrl, options.url)
+
+			if options.method?
+				options.method = options.method.toUpperCase()
+
+			_.defaults options,
+				method: 'GET'
+				headers: {}
 
 			if savedToken?
-				requestOptions.headers =
+				options.headers = _.extend options.headers,
 					'Authorization': "Bearer #{savedToken}"
 
-			request(requestOptions, callback)
+			request(options, callback)
 
 		(response, body, callback) ->
 			try
@@ -38,19 +43,40 @@ exports.request = (method = 'GET', url, json, callback) ->
 	], callback
 
 exports.get = (url, callback) ->
-	return exports.request('GET', url, null, callback)
+	return exports.request {
+		method: 'GET'
+		url: url
+	}, callback
 
 exports.head = (url, callback) ->
-	return exports.request('HEAD', url, null, callback)
+	return exports.request {
+		method: 'HEAD'
+		url: url
+	}, callback
 
 exports.delete = (url, callback) ->
-	return exports.request('DELETE', url, null, callback)
+	return exports.request {
+		method: 'DELETE'
+		url: url
+	}, callback
 
 exports.post = (url, json, callback) ->
-	return exports.request('POST', url, json, callback)
+	return exports.request {
+		method: 'POST'
+		url: url
+		json: json
+	}, callback
 
 exports.put = (url, json, callback) ->
-	return exports.request('PUT', url, json, callback)
+	return exports.request {
+		method: 'PUT'
+		url: url
+		json: json
+	}, callback
 
 exports.patch = (url, json, callback) ->
-	return exports.request('PATCH', url, json, callback)
+	return exports.request {
+		method: 'PATCH'
+		url: url
+		json: json
+	}, callback

lib/server/server.spec.coffee

@@ -47,21 +47,29 @@ describe 'Server:', ->
 	describe '#request()', ->
 
 		it 'should make a real HTTP request', (done) ->
-			server.request 'GET', URI.ok, null, (error, response) ->
+			server.request {
+				method: 'GET'
+				url: URI.ok
+			}, (error, response) ->
 				return done(error) if error?
 				expect(response.body.status).to.equal(STATUS.ok)
 				expect(response.statusCode).to.equal(200)
 				done()
 
 		it 'should make a GET request if method is omitted', (done) ->
-			server.request undefined, URI.ok, null, (error, response) ->
+			server.request {
+				url: URI.ok
+			}, (error, response) ->
 				return done(error) if error?
 				expect(response.request.method).to.equal('GET')
 				done()
 
 		checkRequestType = (type) ->
 			return (done) ->
-				server.request type, URI.ok, null, (error, response) ->
+				server.request {
+					method: type
+					url: URI.ok
+				}, (error, response) ->
 					return done(error) if error?
 					expect(response.request.method).to.equal(type)
 					done()
@@ -70,13 +78,19 @@ describe 'Server:', ->
 			it("should make a #{method} request if method is #{method}", checkRequestType(method))
 
 		it 'should get a raw response of response is not JSON', (done) ->
-			server.request 'GET', URI.nojson, null, (error, response) ->
+			server.request {
+				method: 'GET'
+				url: URI.nojson
+			}, (error, response) ->
 				return done(error) if error?
 				expect(response.body).to.equal(RESPONSE.nojson)
 				done()
 
 		it 'should parse the body', (done) ->
-			server.request 'GET', URI.ok, null, (error, response, body) ->
+			server.request {
+				method: 'GET'
+				url: URI.ok
+			}, (error, response, body) ->
 				expect(error).to.not.exist
 				expect(body).to.be.an.object
 				expect(body).not.to.be.a.string
@@ -85,19 +99,29 @@ describe 'Server:', ->
 		it 'should be able to send data in the body', (done) ->
 			body = { hello: 'world' }
 
-			server.request 'POST', URI.ok, body, (error, response) ->
+			server.request {
+				method: 'POST'
+				url: URI.ok
+				json: body
+			}, (error, response) ->
 				return done(error) if error?
 				expect(response.request.body.toString()).to.equal(JSON.stringify(body))
 				done()
 
 		it 'should throw an error if method is unknown', (done) ->
-			server.request 'FOO', URI.ok, null, (error, response) ->
+			server.request {
+				method: 'FOO'
+				url: URI.ok
+			}, (error, response) ->
 				expect(error).to.exist
 				expect(error).to.be.an.instanceof(Error)
 				done()
 
 		it 'should throw an error if the status code is >= 400', (done) ->
-			server.request 'GET', URI.error, null, (error, response) ->
+			server.request {
+				method: 'GET'
+				url: URI.error
+			}, (error, response) ->
 				expect(error).to.exist
 				expect(error).to.be.an.instanceof(Error)
 				done()
@@ -145,7 +169,10 @@ describe 'Server:', ->
 
 			it 'should send the Authorization header', (done) ->
 
-				server.request 'GET', URI.ok, null, (error, response) ->
+				server.request {
+					method: 'GET'
+					url: URI.ok
+				}, (error, response) ->
 					authorizationHeader = response.request.headers.Authorization
 
 					expect(error).to.not.exist
@@ -161,7 +188,10 @@ describe 'Server:', ->
 		describe '#request()', ->
 
 			it 'should not send the Authorization header', (done) ->
-				server.request 'GET', URI.ok, null, (error, response) ->
+				server.request {
+					method: 'GET'
+					url: URI.ok
+				}, (error, response) ->
 					expect(error).to.not.exist
 					authorizationHeader = response.request.headers.Authorization
 					expect(authorizationHeader).to.not.exist