Add Promise API

* Base logic moved into event-emitter and all APIs wrapped around it * read-all-stream combined into one place - less code duplication * Unzip stream now inherits all properties and function from response and returned instead of response Closes #66
sindresorhus · Jul 15, 2015 · 04dbc4b · 04dbc4b
1 parent 63d95b6
commit 04dbc4b
Show file tree

Hide file tree

Showing 9 changed files with 323 additions and 243 deletions.
diff --git a/index.js b/index.js
diff --git a/package.json b/package.json
@@ -43,12 +43,12 @@
   ],
   "dependencies": {
     "duplexify": "^3.2.0",
-    "infinity-agent": "^2.0.0",
     "is-redirect": "^1.0.0",
     "is-stream": "^1.0.0",
     "lowercase-keys": "^1.0.0",
     "nested-error-stacks": "^1.0.0",
     "object-assign": "^3.0.0",
+    "pinkie-promise": "^1.0.0",
     "prepend-http": "^1.0.0",
     "read-all-stream": "^3.0.0",
     "timed-out": "^2.0.0"

diff --git a/readme.md b/readme.md
@@ -35,12 +35,18 @@ got('todomvc.com', function (err, data, res) {
 	//=> <!doctype html> ...
 });
 
+// Promise mode
+got('todomvc.com')
+	.then(function (res) {
+		console.log(res.body);
+	})
+	.catch(console.error);
 
 // Stream mode
-got('todomvc.com').pipe(fs.createWriteStream('index.html'));
+got.stream('todomvc.com').pipe(fs.createWriteStream('index.html'));
 
-// For POST, PUT and PATCH methods got returns a WritableStream
-fs.createReadStream('index.html').pipe(got.post('todomvc.com'));
+// For POST, PUT and PATCH methods got.stream returns a WritableStream
+fs.createReadStream('index.html').pipe(got.stream('todomvc.com', {method: 'POST'}));
 ```
 
 ### API
@@ -104,6 +110,8 @@ Milliseconds after which the request will be aborted and an error event with `ET
 
 ##### callback(error, data, response)
 
+Function to be called, when error or data recieved. If omitted - Promise will be returned.
+
 ###### error
 
 `Error` object with HTTP status code as `code` property.
@@ -118,6 +126,10 @@ The [response object](http://nodejs.org/api/http.html#http_http_incomingmessage)
 
 When in stream mode, you can listen for events:
 
+##### .on('request', request)
+
+`request` event to get the request object of the request.
+
 ##### .on('response', response)
 
 `response` event to get the response object of the final request.
@@ -130,9 +142,6 @@ When in stream mode, you can listen for events:
 
 `error` event emitted in case of protocol error (like `ENOTFOUND` etc.) or status error (4xx or 5xx). Second argument is body of server response in case of status error. Third argument is response object.
 
-###### response
-
-The [response object](http://nodejs.org/api/http.html#http_http_incomingmessage).
 
 #### got.get(url, [options], [callback])
 #### got.post(url, [options], [callback])

diff --git a/test/test-helpers.js b/test/test-helpers.js
@@ -8,25 +8,37 @@ s.on('/', function (req, res) {
 	res.end('ok');
 });
 
+s.on('/404', function (req, res) {
+	res.statusCode = 404;
+	res.end('not found');
+});
+
 test('setup', function (t) {
 	s.listen(s.port, function () {
 		t.end();
 	});
 });
 
-test('callback mode', {timeout: 1000}, function (t) {
+test('callback mode', function (t) {
 	got.get(s.url, function (err, data) {
 		t.error(err);
 		t.equal(data, 'ok');
 		t.end();
 	});
 });
 
-test('stream mode', {timeout: 1000}, function (t) {
+test('promise mode', function (t) {
+	t.plan(2);
+
 	got.get(s.url)
-		.on('data', function (data) {
-			t.equal(data.toString(), 'ok');
-			t.end();
+		.then(function (res) {
+			t.equal(res.body, 'ok');
+		});
+
+	got.get(s.url + '/404')
+		.catch(function (err) {
+			t.equal(err.message, 'GET http://localhost:6767/404 response code is 404 (Not Found)');
+			t.equal(err.response.body, 'not found');
 		});
 });
 

diff --git a/test/test-http.js b/test/test-http.js
@@ -70,39 +70,11 @@ test('buffer on encoding === null', function (t) {
 	});
 });
 
-test('stream mode', function (t) {
-	got(s.url)
-		.on('data', function (data) {
-			t.equal(data.toString(), 'ok');
-			t.end();
-		});
-});
-
-test('emit response object to stream', function (t) {
-	got(s.url)
-		.on('response', function (res) {
-			t.ok(res);
-			t.ok(res.headers);
-			t.end();
-		});
-});
-
-test('proxy errors to the stream', function (t) {
-	got(s.url + '/404')
-		.on('error', function (err, data, res) {
-			t.equal(err.code, 404);
-			t.equal(data, 'not');
-			t.ok(res);
-			t.end();
-		});
-});
-
 test('timeout option', function (t) {
-	got(s.url + '/404', {timeout: 1})
-		.on('error', function (err) {
-			t.equal(err.code, 'ETIMEDOUT');
-			t.end();
-		});
+	got(s.url + '/404', {timeout: 1}, function (err) {
+		t.equal(err.code, 'ETIMEDOUT');
+		t.end();
+	});
 });
 
 test('query option', function (t) {

diff --git a/test/test-json.js b/test/test-json.js
@@ -33,13 +33,6 @@ test('setup', function (t) {
 	});
 });
 
-test('json option can not be used in stream mode', function (t) {
-	t.throws(function () {
-		got(s.url, {json: true});
-	}, 'got can not be used as stream when options.json is used');
-	t.end();
-});
-
 test('json option should parse response', function (t) {
 	got(s.url, {json: true}, function (err, json) {
 		t.error(err);

diff --git a/test/test-post.js b/test/test-post.js
@@ -67,32 +67,6 @@ test('works with empty post response', function (t) {
 	});
 });
 
-test('return readable stream', function (t) {
-	got.post(s.url, {body: from2Array(['wow'])})
-		.on('data', function (data) {
-			t.equal(data.toString(), 'wow');
-			t.end();
-		});
-});
-
-test('return writeable stream', function (t) {
-	got.post(s.url)
-		.on('data', function (data) {
-			t.equal(data.toString(), 'wow');
-			t.end();
-		})
-		.end('wow');
-});
-
-test('throws on write to stream with body specified', function (t) {
-	t.throws(function () {
-		got(s.url, {body: 'wow'}).write('wow');
-	});
-
-	// wait for request to end
-	setTimeout(t.end.bind(t), 10);
-});
-
 test('post have content-length header to string', function (t) {
 	t.plan(5);
 

diff --git a/test/test-redirects.js b/test/test-redirects.js
@@ -4,6 +4,10 @@ var got = require('../');
 var server = require('./server.js');
 var s = server.createServer();
 
+s.on('/', function (req, res) {
+	res.end('reached');
+});
+
 s.on('/finite', function (req, res) {
 	res.writeHead(302, {
 		location: s.url + '/'
@@ -32,10 +36,6 @@ s.on('/relativeQuery?bang', function (req, res) {
 	res.end();
 });
 
-s.on('/', function (req, res) {
-	res.end('reached');
-});
-
 test('setup', function (t) {
 	s.listen(s.port, function () {
 		t.end();
@@ -90,18 +90,6 @@ test('redirect only GET and HEAD requests', function (t) {
 	});
 });
 
-test('redirect event', function (t) {
-	got(s.url + '/endless')
-		.on('redirect', function (res, opts) {
-			t.equal(res.headers.location, s.url + '/endless');
-			opts.path = '/';
-		})
-		.on('data', function (data) {
-			t.equal(data.toString(), 'reached');
-			t.end();
-		});
-});
-
 test('cleanup', function (t) {
 	s.close();
 	t.end();

diff --git a/test/test-stream.js b/test/test-stream.js
@@ -0,0 +1,90 @@
+'use strict';
+
+var test = require('tap').test;
+var from2Array = require('from2-array');
+var got = require('../');
+var server = require('./server.js');
+var s = server.createServer();
+
+s.on('/', function (req, res) {
+	res.end('ok');
+});
+
+s.on('/post', function (req, res) {
+	req.pipe(res);
+});
+
+s.on('/redirect', function (req, res) {
+	res.writeHead(302, {
+		location: s.url
+	});
+	res.end();
+});
+
+test('setup', function (t) {
+	s.listen(s.port, function () {
+		t.end();
+	});
+});
+
+test('json option can not be used in stream mode', function (t) {
+	t.throws(function () {
+		got.stream(s.url, {json: true});
+	}, 'got can not be used as stream when options.json is used');
+	t.end();
+});
+
+test('return readable stream', function (t) {
+	got.stream(s.url)
+		.on('data', function (data) {
+			t.equal(data.toString(), 'ok');
+			t.end();
+		});
+});
+
+test('return writeable stream', function (t) {
+	t.plan(1);
+	got.stream(s.url + '/post', {method: 'POST'})
+		.on('data', function (data) {
+			t.equal(data.toString(), 'wow');
+		})
+		.end('wow');
+});
+
+test('throws on write to stream with body specified', function (t) {
+	t.throws(function () {
+		got.stream(s.url, {body: 'wow'}).write('wow');
+	}, 'got\'s stream is not writable when options.body is used');
+
+	// wait for request to end
+	setTimeout(t.end.bind(t), 10);
+});
+
+test('request event', function (t) {
+	got.stream(s.url)
+		.on('request', function (req) {
+			t.ok(req);
+			t.end();
+		});
+});
+
+test('redirect event', function (t) {
+	got.stream(s.url + '/redirect')
+		.on('redirect', function (res, opts) {
+			t.equal(res.headers.location, s.url);
+			t.end();
+		});
+});
+
+test('response event', function (t) {
+	got.stream(s.url)
+		.on('response', function (res) {
+			t.equal(res.statusCode, 200);
+			t.end();
+		});
+});
+
+test('cleanup', function (t) {
+	s.close();
+	t.end();
+});