overhaul broken file download methods - fixes #110

Author: busticated

src/Particle.js

@@ -1,4 +1,3 @@
-import request from 'superagent';
 import binaryParser from './superagent-binary-parser';
 import Defaults from './Defaults';
 import EventStream from './EventStream';
@@ -588,11 +587,14 @@ class Particle {
 	 * @returns {Request} A promise
 	 */
 	downloadFirmwareBinary({ binaryId, auth }){
-		const uri = `/v1/binaries/${binaryId}`;
-		const req = request('get', uri);
-		req.use(this.prefix);
-		this.headers(req, auth);
-		return req;
+		let req = this.request({
+			uri: `/v1/binaries/${binaryId}`,
+			method: 'get',
+			raw: true,
+			auth
+		});
+
+		return this._provideFileData(req);
 	}
 
 	/**
@@ -1131,17 +1133,8 @@ class Particle {
 	 * @returns {Promise} Resolves to a buffer with the file data
 	 */
 	downloadFile({ url }){
-		let req = request.get(url);
-		// Different API in Node and browser
-		if (!request.getXHR){
-			req = req.buffer(true).parse(binaryParser);
-		} else if (req.responseType){
-			req = req.responseType('arraybuffer').then(res => {
-				res.body = res.xhr.response;
-				return res;
-			});
-		}
-		return req.then(res => res.body);
+		let req = this.request({ uri: url, method: 'get', raw: true });
+		return this._provideFileData(req);
 	}
 
 	/**
@@ -1299,11 +1292,26 @@ class Particle {
 	 * @returns {Request} A promise
 	 */
 	downloadProductFirmware({ version, product, auth }){
-		const uri = `/v1/products/${product}/firmware/${version}/binary`;
-		const req = request('get', uri);
-		req.use(this.prefix);
-		this.headers(req, auth);
-		return req;
+		let req = this.request({
+			uri: `/v1/products/${product}/firmware/${version}/binary`,
+			method: 'get',
+			raw: true,
+			auth
+		});
+
+		return this._provideFileData(req);
+	}
+
+	_provideFileData(req){
+		if (this.agent.isForBrowser()){
+			req = req.responseType('arraybuffer').then(res => {
+				res.body = res.xhr.response;
+				return res;
+			});
+		} else {
+			req = req.buffer(true).parse(binaryParser);
+		}
+		return req.then(res => res.body);
 	}
 
 	/**

test/Particle.spec.js

@@ -29,6 +29,7 @@ const props = {
 	files: {
 		'app.ino': new Buffer('void(){}\nsetup(){}\n')
 	},
+	binaryId: '123456',
 	targetVersion: '0.4.7',
 	requestType: 'GET',
 	headers: {
@@ -712,6 +713,21 @@ describe('ParticleAPI', () => {
 				});
 			});
 		});
+		describe('.downloadFirmwareBinary', () => {
+			it('generates request', () => {
+				sinon.stub(api, '_provideFileData').callsFake(x => Promise.resolve(x));
+				const req = api.downloadFirmwareBinary(propsWithProduct);
+				api._provideFileData.callCount.should.equal(1);
+				return req.then((results) => {
+					results.should.match({
+						uri: `/v1/binaries/${props.binaryId}`,
+						method: 'get',
+						auth: props.auth,
+						raw: true
+					});
+				});
+			});
+		});
 		describe('.sendPublicKey', () => {
 			it('generates request', () => {
 				return api.sendPublicKey(props).then(Common.expectDeviceUrlAndToken);
@@ -1574,7 +1590,17 @@ describe('ParticleAPI', () => {
 				});
 			});
 		});
-
+		describe('.downloadFile', () => {
+			it('generates request', () => {
+				sinon.stub(api, '_provideFileData').callsFake(x => Promise.resolve(x));
+				const uri = 'http://example.com/path/to/file.png';
+				const req = api.downloadFile({ url: uri });
+				api._provideFileData.callCount.should.equal(1);
+				return req.then((results) => {
+					results.should.match({ uri, method: 'get', raw: true });
+				});
+			});
+		});
 		describe('.listOAuthClients', () => {
 			describe('user scope', () => {
 				it('generates request', () => {
@@ -1751,6 +1777,22 @@ describe('ParticleAPI', () => {
 			});
 		});
 
+		describe('.downloadProductFirmware', () => {
+			it('generates request', () => {
+				sinon.stub(api, '_provideFileData').callsFake(x => Promise.resolve(x));
+				const req = api.downloadProductFirmware(propsWithProduct);
+				api._provideFileData.callCount.should.equal(1);
+				return req.then((results) => {
+					results.should.match({
+						uri: `/v1/products/${product}/firmware/${props.version}/binary`,
+						method: 'get',
+						auth: props.auth,
+						raw: true
+					});
+				});
+			});
+		});
+
 		describe('.getProductFirmware', () => {
 			it('generates request', () => {
 				return api.getProductFirmware(propsWithProduct).then((results) => {