particle-api-js 11.1.7 → 12.0.1

package/test/Defaults.spec.js

@@ -1,30 +0,0 @@
-'use strict';
-const { expect } = require('./test-setup');
-const Defaults = require('../src/Defaults');
-
-describe('Default Particle constructor options', () => {
-	it('includes baseUrl', () => {
-		expect(Defaults).to.have.property('baseUrl');
-		expect(Defaults.baseUrl).to.eql('https://api.particle.io');
-	});
-
-	it('includes clientSecret', () => {
-		expect(Defaults).to.have.property('clientSecret');
-		expect(Defaults.clientSecret).to.eql('particle-api');
-	});
-
-	it('includes clientId', () => {
-		expect(Defaults).to.have.property('clientId');
-		expect(Defaults.clientId).to.eql('particle-api');
-	});
-
-	it('includes tokenDuration', () => {
-		expect(Defaults).to.have.property('tokenDuration');
-		expect(Defaults.tokenDuration).to.eql(7776000);
-	});
-
-	it('includes defaultAuth', () => {
-		expect(Defaults).to.have.property('auth');
-		expect(Defaults.auth).to.eql(undefined);
-	});
-});

package/test/EventStream.feature

@@ -1,65 +0,0 @@
-# End-to-end tests for the EventStream feature
-# These tests are hard to automate, especially in the browser since they involve error handling with the API
-# so the tests are documented in Gerkin format and are meant to be executed manually
-Feature: EventStream
-
-  Scenario: Connect to event stream
-    Given the API is running
-    And the API access token is valid
-    When I run the end-to-end test program
-    Then the output should contain "event stream connected"
-
-  Scenario: Receive event
-    Given the event stream is connected
-    When I publish a Particle event through the CLI with `particle publish test`
-    Then the event "event" with data "{ name: 'test', ... }" should be output
-
-  Scenario: Initial connection failure
-    Given the API is not running
-    When I run the end-to-end test program
-    Then the output should contain "Error: connect ECONNREFUSED"
-    And the end-to-end test program should exit
-
-  Scenario: Invalid credentials
-    Given the API is running
-    And the API access token is not valid
-    When I run the end-to-end test program
-    Then the output should contain "The access token provided is invalid"
-    And the end-to-end test program should exit
-
-  Scenario: Initial connection timeout
-    Given the API is paused (press Ctrl-Z in the API terminal)
-    When I run the end-to-end test program
-    Then the output should contain "Timeout"
-    And the end-to-end test program should exit
-
-  Scenario: Disconnect due to connection failure
-    Given the event stream is connected
-    When I stop the API (press Ctrl-C in the API terminal)
-    Then the event "disconnect" should be output immediately
-    And after 2 seconds, the event "reconnect" should be output
-    And the event "reconnect-error" should be output immediately
-    And the "reconnect" and "reconnect-error" should repeat indefinitely
-
-  Scenario: Reconnect after connection failure
-    Given the event stream is trying to reconnect after connection failure
-    When I start the API
-    Then the event "reconnect" followed by "reconnect-success" should be output
-
-  Scenario: Disconnect due to idle timeout
-    Given the event stream is connected
-    When I pause the API (press Ctrl-Z in the API terminal)
-    Then after up to 13 seconds, the event "disconnect" should be output
-    And after 2 seconds, the event "reconnect" should be output
-    And after 13 seconds, the event "reconnect-error" should be output
-    And the "reconnect" and "reconnect-error" should repeat indefinitely
-
-  Scenario: Reconnect after idle timeout
-    Given the event stream is trying to reconnect after idle timeout
-    When I unpause the API (type % in bash to resume the process)
-    Then the event "reconnect-success" should be output
-
-  Scenario: Receive event after reconnect
-    Given the event stream reconnected after a connection failure
-    When I publish a Particle event through the CLI with `particle publish test`
-    Then the event "event" should be published once

package/test/EventStream.spec.js

@@ -1,263 +0,0 @@
-'use strict';
-const { sinon, expect } = require('./test-setup');
-const http = require('http');
-const { EventEmitter } = require('events');
-
-const EventStream = require('../src/EventStream');
-
-describe('EventStream', () => {
-	afterEach(() => {
-		sinon.restore();
-	});
-
-	function makeRequest() {
-		const fakeRequest = new EventEmitter();
-		fakeRequest.end = sinon.spy();
-		fakeRequest.setTimeout = sinon.spy();
-		return fakeRequest;
-	}
-
-	function makeResponse(statusCode) {
-		const fakeResponse = new EventEmitter();
-		fakeResponse.statusCode = statusCode;
-		return fakeResponse;
-	}
-
-	describe('constructor', () => {
-		it('creates an EventStream objects', () => {
-			const eventStream = new EventStream('uri', 'token');
-
-			expect(eventStream).to.own.include({ uri: 'uri', token: 'token' });
-		});
-	});
-
-	describe('connect', () => {
-		it('successfully connects to http', () => {
-			sinon.useFakeTimers({ shouldAdvanceTime: true });
-			const fakeRequest = makeRequest();
-			sinon.stub(http, 'request').callsFake(() => {
-				setImmediate(() => {
-					const fakeResponse = makeResponse(200);
-					fakeRequest.emit('response', fakeResponse);
-				});
-
-				return fakeRequest;
-			});
-
-			const eventStream = new EventStream('http://hostname:8080/path', 'token');
-
-			return eventStream.connect().then(() => {
-				expect(http.request).to.have.been.calledWith({
-					hostname: 'hostname',
-					protocol: 'http:',
-					path: '/path?nonce=0',
-					headers: {
-						'Authorization': 'Bearer token'
-					},
-					method: 'get',
-					port: 8080,
-					mode: 'prefer-streaming'
-				});
-			});
-		});
-
-		it('returns http errors on connect', () => {
-			sinon.useFakeTimers({ shouldAdvanceTime: true });
-			const fakeRequest = makeRequest();
-			sinon.stub(http, 'request').callsFake(() => {
-				setImmediate(() => {
-					const fakeResponse = makeResponse(500);
-					fakeRequest.emit('response', fakeResponse);
-					setImmediate(() => {
-						fakeResponse.emit('data', '{"error":"unknown"}');
-						fakeResponse.emit('end');
-					});
-				});
-
-				return fakeRequest;
-			});
-
-			const eventStream = new EventStream('http://hostname:8080/path', 'token');
-
-			return eventStream.connect().then(() => {
-				throw new Error('expected to throw error');
-			}, (reason) => {
-				expect(reason).to.eql({
-					statusCode: 500,
-					errorDescription: 'HTTP error 500 from http://hostname:8080/path',
-					body: {
-						error: 'unknown'
-					}
-				});
-			});
-		});
-	});
-
-	describe('parse', () => {
-		let eventStream;
-		beforeEach(() => {
-			eventStream = new EventStream();
-			sinon.stub(eventStream, 'parseEventStreamLine');
-		});
-
-		it('accumulates date into the buffer before parsing line', () => {
-			eventStream.parse('wo');
-			eventStream.parse('rd');
-
-			expect(eventStream.buf).to.eql('word');
-			expect(eventStream.parseEventStreamLine).not.to.have.been.called;
-		});
-
-		it('parses a line ending with \\n', () => {
-			const line = 'field: value\n';
-
-			eventStream.parse(line);
-
-			expect(eventStream.parseEventStreamLine).to.have.been.calledWith(0, line.indexOf(':'), line.indexOf('\n'));
-		});
-
-		it('parses 2 lines ending with \\n', () => {
-			const line1 = 'field: value\n';
-			const line2 = 'field2: value2\n';
-
-			eventStream.parse(line1 + line2);
-
-			expect(eventStream.parseEventStreamLine).to.have.been.calledWith(0, line1.indexOf(':'), line1.indexOf('\n'));
-			expect(eventStream.parseEventStreamLine).to.have.been.calledWith(line1.length, line2.indexOf(':'), line2.indexOf('\n'));
-		});
-
-
-		it('parses a line ending with \\r\\n', () => {
-			const line = 'field: value\r\n';
-
-			eventStream.parse(line);
-
-			expect(eventStream.parseEventStreamLine).to.have.been.calledWith(0, line.indexOf(':'), line.indexOf('\r'));
-		});
-
-		it('parses 2 lines ending with \\r\\n', () => {
-			const line1 = 'field: value\r\n';
-			const line2 = 'field2: value2\r\n';
-
-			eventStream.parse(line1 + line2);
-
-			expect(eventStream.parseEventStreamLine).to.have.been.calledWith(0, line1.indexOf(':'), line1.indexOf('\r'));
-			expect(eventStream.parseEventStreamLine).to.have.been.calledWith(line1.length, line2.indexOf(':'), line2.indexOf('\r'));
-		});
-
-		it('clears buffer after parsing full lines', () => {
-			eventStream.parse('field: value\n');
-
-			expect(eventStream.buf).to.eql('');
-		});
-
-		it('keeps partial lines in buffer after parsing full lines', () => {
-			eventStream.parse('field: value\nfield2');
-
-			expect(eventStream.buf).to.eql('field2');
-		});
-	});
-
-	describe('parseEventStreamLine', () => {
-		let eventStream;
-		beforeEach(() => {
-			eventStream = new EventStream();
-		});
-
-		it('ignores comments', () => {
-			// comments starts with : at column 0
-			const line = ':ok\n';
-			eventStream.buf = line;
-
-			eventStream.parseEventStreamLine(0, line.indexOf(':'), line.indexOf('\n'));
-
-			expect(eventStream.event).not.to.be.ok;
-			expect(eventStream.data).to.be.eql('');
-		});
-
-		it('saves event name', () => {
-			const line = 'event: testevent\n';
-			eventStream.buf = line;
-
-			eventStream.parseEventStreamLine(0, line.indexOf(':'), line.indexOf('\n'));
-
-			expect(eventStream.event).to.be.true;
-			expect(eventStream.eventName).to.eql('testevent');
-		});
-
-		it('saves event data', () => {
-			const line = 'data: {"data":"test"}\n';
-			eventStream.buf = line;
-
-			eventStream.parseEventStreamLine(0, line.indexOf(':'), line.indexOf('\n'));
-
-			expect(eventStream.data).to.eql('{"data":"test"}\n');
-		});
-
-		it('saves event name and data on separate lines', () => {
-			const lines = ['event: testevent\n', 'data: {"data":"test"}\n'];
-			for (const line of lines) {
-				eventStream.buf = line;
-
-				eventStream.parseEventStreamLine(0, line.indexOf(':'), line.indexOf('\n'));
-			}
-
-			expect(eventStream.event).to.be.true;
-			expect(eventStream.eventName).to.eql('testevent');
-			expect(eventStream.data).to.eql('{"data":"test"}\n');
-		});
-
-		it('emits event on blank line after saving event name and data', () => {
-			const handler = sinon.spy();
-			eventStream.event = true;
-			eventStream.eventName = 'testevent';
-			eventStream.data = '{"data":"test"}\n';
-			eventStream.on('event', handler);
-
-			eventStream.parseEventStreamLine(0, -1, 0);
-
-			expect(handler).to.have.been.calledWith({
-				name: 'testevent',
-				data: 'test'
-			});
-		});
-
-		it('emits error if the event handler crashes', () => {
-			const errorHandler = sinon.spy();
-			eventStream.event = true;
-			eventStream.eventName = 'testevent';
-			eventStream.data = '{"data":"test"}\n';
-			eventStream.on('error', errorHandler);
-			eventStream.on('event', () => {
-				throw new Error('failed!');
-			});
-
-			eventStream.parseEventStreamLine(0, -1, 0);
-
-			expect(errorHandler).to.have.been.called;
-		});
-
-		it('clears the event after emitting it', () => {
-			eventStream.event = true;
-			eventStream.eventName = 'testevent';
-			eventStream.data = '{"data":"test"}\n';
-
-			eventStream.parseEventStreamLine(0, -1, 0);
-
-			expect(eventStream.event).to.be.false;
-			expect(eventStream.eventName).to.be.undefined;
-			expect(eventStream.data).to.eql('');
-		});
-
-		it('ignores multiple blank lines in succession', () => {
-			const handler = sinon.spy();
-			eventStream.on('event', handler);
-
-			eventStream.parseEventStreamLine(0, -1, 0);
-			eventStream.parseEventStreamLine(0, -1, 0);
-			eventStream.parseEventStreamLine(0, -1, 0);
-
-			expect(handler).not.to.have.been.called;
-		});
-	});
-});

package/test/FakeAgent.js

@@ -1,27 +0,0 @@
-'use strict';
-class FakeAgent {
-	get({ uri, auth, headers, query, context }){
-		return this.request({ uri, method: 'get', auth, headers, query, context });
-	}
-
-	head({ uri, auth, headers, query, context }){
-		return this.request({ uri, method: 'head', auth, headers, query, context });
-	}
-
-	post({ uri, headers, data, auth, context }){
-		return this.request({ uri, method: 'post', auth, headers, data, context });
-	}
-
-	put({ uri, auth, headers, data, query, context }){
-		return this.request({ uri, method: 'put', auth, headers, data, query, context });
-	}
-
-	delete({ uri, auth, headers, data, context }){
-		return this.request({ uri, method: 'delete', auth, headers, data, context });
-	}
-
-	request(opts){
-		return Promise.resolve(opts);
-	}
-}
-module.exports = FakeAgent;

package/test/Library.spec.js

@@ -1,40 +0,0 @@
-'use strict';
-const { expect } = require('./test-setup');
-const Library = require('../src/Library');
-
-const client = {};
-
-
-describe('Library', () => {
-	describe('constructor', () => {
-		it('sets attributes', () => {
-			const library = new Library(client, {
-				attributes: {
-					name: 'testlib',
-					version: '1.0.0'
-				}
-			});
-			expect(library.name).to.equal('testlib');
-			expect(library.version).to.equal('1.0.0');
-		});
-	});
-
-	describe('download', () => {
-		it('return the file contents', () => {
-			client.downloadFile = (url) => {
-				return Promise.resolve(`${url}-content`);
-			};
-
-			const library = new Library(client, {
-				attributes: {
-					name: 'testlib',
-					version: '1.0.0'
-				},
-				links: {
-					download: 'url'
-				}
-			});
-			expect(library.download()).to.eventually.equal('url-content');
-		});
-	});
-});

package/test/Particle.integration.js

@@ -1,38 +0,0 @@
-'use strict';
-const { expect, sinon } = require('./test-setup');
-const Particle = require('../src/Particle');
-
-describe('Particle', () => {
-	let api;
-
-	beforeEach(() => {
-		api = new Particle({ baseUrl: '' });
-	});
-
-	describe('downloadFile', () => {
-		it('download the file', () => {
-			const uri = 'https://binaries.particle.io/libraries/neopixel/neopixel-0.0.10.tar.gz';
-			const fileSize = 25505;
-			return api.downloadFile({ uri })
-				.then(contents => {
-					expect(contents.length || contents.byteLength).to.equal(fileSize);
-				});
-		});
-	});
-
-	describe('context', () => {
-		it('adds headers for the context', () => {
-			api.setContext('tool', { name:'cli', version:'1.2.3' });
-			api.setContext('project', { name:'blinky', version:'0.0.1' });
-			api.agent._promiseResponse = sinon.stub().resolves();
-			return api.flashTinker('deviceID', 'auth').then(() => {
-				expect(api.agent._promiseResponse).to.have.been.calledOnce;
-				const req = api.agent._promiseResponse.firstCall.args[0];
-				const options = req[1];
-				expect(req).to.be.ok;
-				expect(options.headers).to.have.property('X-Particle-Tool').eql('cli@1.2.3');
-				expect(options.headers).to.have.property('X-Particle-Project').eql('blinky; version=0.0.1');
-			});
-		});
-	});
-});