particle-api-js 9.4.1 → 10.1.0

package/test/Client.spec.js

@@ -1,7 +1,7 @@
-import { expect, sinon } from './test-setup';
-import Client from '../src/Client';
-import * as fixtures from './fixtures';
-import Library from '../src/Library';
+const { expect, sinon } = require('./test-setup');
+const Client = require('../src/Client');
+const fixtures = require('./fixtures');
+const Library = require('../src/Library');
 
 let api;
 const token = 'tok';
@@ -25,7 +25,7 @@ describe('Client', () => {
 
 	describe('libraries', () => {
 		it('resolves to a list of Library objects', () => {
-			api.listLibraries = () => Promise.resolve({ body: fixtures.readJSON('libraries.json') });
+			api.listLibraries = () => Promise.resolve({ body: fixtures.read('libraries.json') });
 			return client.libraries().then(libraries => {
 				expect(libraries.length).to.equal(1);
 				expect(libraries[0].name).to.equal('neopixel');
@@ -35,7 +35,7 @@ describe('Client', () => {
 
 	describe('library', () => {
 		it('resolves to a Library objects', () => {
-			api.getLibrary = () => Promise.resolve({ body: fixtures.readJSON('library.json') });
+			api.getLibrary = () => Promise.resolve({ body: fixtures.read('library.json') });
 			return client.library('neopixel').then(library => {
 				expect(library.name).to.equal('neopixel');
 			});
@@ -44,7 +44,7 @@ describe('Client', () => {
 
 	describe('libraryVersions', () => {
 		it('resolves to a Library objects', () => {
-			api.getLibraryVersions = () => Promise.resolve({ body: fixtures.readJSON('libraryVersions.json') });
+			api.getLibraryVersions = () => Promise.resolve({ body: fixtures.read('libraryVersions.json') });
 			return client.libraryVersions().then(libraries => {
 				expect(libraries.length).to.equal(9);
 				expect(libraries[0].name).to.equal('neopixel');

package/test/Defaults.spec.js

@@ -1,5 +1,5 @@
-import { expect } from './test-setup';
-import Defaults from '../src/Defaults';
+const { expect } = require('./test-setup');
+const Defaults = require('../src/Defaults');
 
 describe('Default Particle constructor options', () => {
 	it('includes baseUrl', () => {

package/test/EventStream.spec.js

@@ -1,8 +1,8 @@
-import { sinon, expect } from './test-setup';
-import http from 'http';
-import { EventEmitter } from 'events';
+const { sinon, expect } = require('./test-setup');
+const http = require('http');
+const { EventEmitter } = require('events');
 
-import EventStream from '../src/EventStream';
+const EventStream = require('../src/EventStream');
 
 describe('EventStream', () => {
 	afterEach(() => {
@@ -32,6 +32,7 @@ describe('EventStream', () => {
 
 	describe('connect', () => {
 		it('successfully connects to http', () => {
+			sinon.useFakeTimers({ shouldAdvanceTime: true });
 			const fakeRequest = makeRequest();
 			sinon.stub(http, 'request').callsFake(() => {
 				setImmediate(() => {
@@ -57,6 +58,7 @@ describe('EventStream', () => {
 		});
 
 		it('returns http errors on connect', () => {
+			sinon.useFakeTimers({ shouldAdvanceTime: true });
 			const fakeRequest = makeRequest();
 			sinon.stub(http, 'request').callsFake(() => {
 				setImmediate(() => {

package/test/FakeAgent.js

@@ -1,4 +1,4 @@
-export default class FakeAgent {
+class FakeAgent {
 	get({ uri, auth, headers, query, context }){
 		return this.request({ uri, method: 'get', auth, headers, query, context });
 	}
@@ -23,4 +23,4 @@ export default class FakeAgent {
 		return new Promise((resolve) => resolve(opts));
 	}
 }
-
+module.exports = FakeAgent;

package/test/Library.spec.js

@@ -1,5 +1,5 @@
-import { expect } from './test-setup';
-import Library from '../src/Library';
+const { expect } = require('./test-setup');
+const Library = require('../src/Library');
 
 let client = {};
 

package/test/Particle.integration.js

@@ -1,17 +1,16 @@
-import { expect, sinon } from './test-setup';
-import Particle from '../src/Particle';
-
+const { expect, sinon } = require('./test-setup');
+const Particle = require('../src/Particle');
 
 describe('Particle', () => {
 	let api;
 
 	beforeEach(() => {
-		api = new Particle();
+		api = new Particle({ baseUrl: '' });
 	});
 
 	describe('downloadFile', () => {
 		it('download the file', () => {
-			const uri = 'https://s3.amazonaws.com/binaries.particle.io/libraries/neopixel/neopixel-0.0.10.tar.gz';
+			const uri = 'https://binaries.particle.io/libraries/neopixel/neopixel-0.0.10.tar.gz';
 			const fileSize = 25505;
 			return api.downloadFile({ uri })
 				.then(contents => {
@@ -28,9 +27,10 @@ describe('Particle', () => {
 			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(req.header).to.have.property('X-Particle-Tool').eql('cli@1.2.3');
-				expect(req.header).to.have.property('X-Particle-Project').eql('blinky; version=0.0.1');
+				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');
 			});
 		});
 	});

package/test/Particle.spec.js

@@ -1,10 +1,10 @@
-import should from 'should'; // monkeypatch the world~!1
-import Particle from '../src/Particle';
-import Defaults from '../src/Defaults';
-import Client from '../src/Client';
-import EventStream from '../src/EventStream';
-import FakeAgent from './FakeAgent';
-import { sinon, expect } from './test-setup';
+const should = require('should'); // monkeypatch the world~!1
+const Particle = require('../src/Particle');
+const Defaults = require('../src/Defaults');
+const Client = require('../src/Client');
+const EventStream = require('../src/EventStream');
+const FakeAgent = require('./FakeAgent');
+const { sinon, expect } = require('./test-setup');
 
 let api;
 
@@ -95,12 +95,49 @@ const props = {
 	groups: ['foo', 'bar'],
 	dateRange: '2020-05-15T18:29:45.000Z,2020-05-19T18:29:45.000Z',
 	rectBl: '56.185412,-4.049868',
-	rectTr: '56.571537,-5.385920'
+	rectTr: '56.571537,-5.385920',
+	blockId: 1,
+	runId: 1,
+	block: {
+		enabled: true,
+		name: 'block-1',
+		description: 'hello world',
+		logic: {
+			type: 'JavaScript',
+			code: 'console.log("hello from block-1");'
+		},
+		matchers: [
+			{
+				type: 'PubSub',
+				enabled: true,
+				product_id: 9001,
+				event_name: 'main',
+			},
+			{
+				type: 'Chron',
+				enabled: true,
+				cron: '0 0 1 * *',
+				start_at: '2021-05-15T18:29:45.000Z',
+				end_at: '2021-05-19T18:29:45.000Z',
+			}
+		]
+	},
+	ledgerName: 'myledger',
+	ledger: {
+		scope: 'Owner',
+		name: 'myledger',
+		description: 'my ledger',
+		direction: 'Downstream'
+	},
+	scopeValue: '1234'
 };
 
 const product = 'ze-product-v1';
 const propsWithProduct = Object.assign({ product }, props);
 
+const org = 'test-org';
+const propsWithOrg = Object.assign({ org }, props);
+
 class Common {
 	static expectCredentials({ form }){
 		form.username.should.equal(props.username);
@@ -854,15 +891,15 @@ describe('ParticleAPI', () => {
 
 		describe('.downloadFirmwareBinary', () => {
 			it('generates request', () => {
-				sinon.stub(api, '_provideFileData').callsFake(x => Promise.resolve(x));
+				sinon.stub(api, 'request').callsFake(x => Promise.resolve(x));
 				const req = api.downloadFirmwareBinary(propsWithProduct);
-				api._provideFileData.callCount.should.equal(1);
+				api.request.callCount.should.equal(1);
 				return req.then((results) => {
 					results.should.match({
 						uri: `/v1/binaries/${props.binaryId}`,
 						method: 'get',
 						auth: props.auth,
-						raw: true
+						isBuffer: true
 					});
 				});
 			});
@@ -1916,12 +1953,12 @@ describe('ParticleAPI', () => {
 
 		describe('.downloadFile', () => {
 			it('generates request', () => {
-				sinon.stub(api, '_provideFileData').callsFake(x => Promise.resolve(x));
+				sinon.stub(api, 'request').callsFake(x => Promise.resolve(x));
 				const uri = 'http://example.com/path/to/file.png';
 				const req = api.downloadFile({ uri });
-				api._provideFileData.callCount.should.equal(1);
+				api.request.callCount.should.equal(1);
 				return req.then((results) => {
-					results.should.match({ uri, method: 'get', raw: true });
+					results.should.match({ uri, method: 'get', isBuffer: true });
 				});
 			});
 		});
@@ -2137,17 +2174,17 @@ describe('ParticleAPI', () => {
 
 		describe('.downloadProductFirmware', () => {
 			it('generates request', () => {
-				sinon.stub(api, '_provideFileData').callsFake(x => Promise.resolve(x));
+				sinon.stub(api, 'request').callsFake(x => Promise.resolve(x));
 				const req = api.downloadProductFirmware(propsWithProduct);
-				api._provideFileData.callCount.should.equal(1);
+				api.request.callCount.should.equal(1);
 				return req.then((results) => {
 					results.should.match({
 						uri: `/v1/products/${product}/firmware/${props.version}/binary`,
 						method: 'get',
 						auth: props.auth,
 						headers: props.headers,
-						context: {},
-						raw: true
+						context: undefined,
+						isBuffer: true
 					});
 				});
 			});
@@ -2537,6 +2574,154 @@ describe('ParticleAPI', () => {
 			});
 		});
 
+		describe('.createLogicBlock', () => {
+			it('generates request', () => {
+				return api.createLogicBlock(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'post',
+						uri: `/v1/orgs/${org}/blocks`,
+						auth: props.auth,
+						data: {
+							block: {
+								enabled: true,
+								name: 'block-1',
+								description: 'hello world',
+								logic: {
+									type: 'JavaScript',
+									code: 'console.log("hello from block-1");'
+								},
+								matchers: [
+									{
+										type: 'PubSub',
+										enabled: true,
+										product_id: parseInt(props.productId),
+										event_name: props.event,
+									},
+									{
+										type: 'Chron',
+										enabled: true,
+										cron: '0 0 1 * *',
+										start_at: '2021-05-15T18:29:45.000Z',
+										end_at: '2021-05-19T18:29:45.000Z',
+									}
+								]
+							}
+						}
+					});
+				});
+			});
+		});
+
+		describe('.getLogicBlock', () => {
+			it('generates request', () => {
+				return api.getLogicBlock(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'get',
+						uri: `/v1/orgs/${org}/blocks/${props.blockId}`,
+						auth: props.auth
+					});
+				});
+			});
+		});
+
+		describe('.updateLogicBlock', () => {
+			it('generates request', () => {
+				return api.updateLogicBlock(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'put',
+						uri: `/v1/orgs/${org}/blocks/${props.blockId}`,
+						auth: props.auth,
+						data: {
+							block: {
+								enabled: true,
+								name: 'block-1',
+								description: 'hello world',
+								logic: {
+									type: 'JavaScript',
+									code: 'console.log("hello from block-1");'
+								},
+								matchers: [
+									{
+										type: 'PubSub',
+										enabled: true,
+										product_id: parseInt(props.productId),
+										event_name: props.event,
+									},
+									{
+										type: 'Chron',
+										enabled: true,
+										cron: '0 0 1 * *',
+										start_at: '2021-05-15T18:29:45.000Z',
+										end_at: '2021-05-19T18:29:45.000Z',
+									}
+								]
+							}
+						}
+					});
+				});
+			});
+		});
+
+		describe('.deleteLogicBlock', () => {
+			it('generates request', () => {
+				return api.deleteLogicBlock(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'delete',
+						uri: `/v1/orgs/${org}/blocks/${props.blockId}`,
+						auth: props.auth
+					});
+				});
+			});
+		});
+
+		describe('.listLogicBlocks', () => {
+			it('generates request', () => {
+				return api.listLogicBlocks(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'get',
+						uri: `/v1/orgs/${org}/blocks`,
+						auth: props.auth
+					});
+				});
+			});
+		});
+
+		describe('.listBlockRuns', () => {
+			it('generates request', () => {
+				return api.listBlockRuns(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'get',
+						uri: `/v1/orgs/${org}/blocks/${props.blockId}/runs`,
+						auth: props.auth,
+					});
+				});
+			});
+		});
+
+		describe('.getBlockRun', () => {
+			it('generates request', () => {
+				return api.getBlockRun(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'get',
+						uri: `/v1/orgs/${org}/blocks/${props.blockId}/runs/${props.runId}`,
+						auth: props.auth,
+					});
+				});
+			});
+		});
+
+		describe('.getBlockRunLog', () => {
+			it('generates request', () => {
+				return api.getBlockRunLog(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'get',
+						uri: `/v1/orgs/${org}/blocks/${props.blockId}/runs/${props.runId}/logs`,
+						auth: props.auth,
+					});
+				});
+			});
+		});
+
 		describe('.deleteUser', () => {
 			it('sends request to delete the current user', () => {
 				return api.deleteUser(props).then(result => {
@@ -2550,6 +2735,135 @@ describe('ParticleAPI', () => {
 				});
 			});
 		});
+
+		describe('.createLedger', () => {
+			it('generates request', () => {
+				return api.createLedger(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'post',
+						uri: `/v1/orgs/${org}/ledgers`,
+						auth: props.auth,
+						data: {
+							ledger: {
+								scope: 'Owner',
+								name: 'myledger',
+								description: 'my ledger',
+								direction: 'Downstream'
+							}
+						}
+					});
+				});
+			});
+		});
+
+		describe('.getLedger', () => {
+			it('generates request', () => {
+				return api.getLedger(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'get',
+						uri: `/v1/orgs/${org}/ledgers/${props.ledgerName}`,
+						auth: props.auth
+					});
+				});
+			});
+		});
+
+		describe('.updateLedger', () => {
+			it('generates request', () => {
+				return api.updateLedger(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'put',
+						uri: `/v1/orgs/${org}/ledgers/${props.ledgerName}`,
+						auth: props.auth,
+						data: {
+							ledger: {
+								scope: 'Owner',
+								name: 'myledger',
+								description: 'my ledger',
+								direction: 'Downstream'
+							}
+						}
+					});
+				});
+			});
+		});
+
+		describe('.archiveLedger', () => {
+			it('generates request', () => {
+				return api.archiveLedger(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'delete',
+						uri: `/v1/orgs/${org}/ledgers/${props.ledgerName}`,
+						auth: props.auth
+					});
+				});
+			});
+		});
+
+		describe('.listLedgers', () => {
+			it('generates request', () => {
+				return api.listLedgers(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'get',
+						uri: `/v1/orgs/${org}/ledgers`,
+						auth: props.auth
+					});
+				});
+			});
+		});
+
+		describe('.getLedgerInstance', () => {
+			it('generates request', () => {
+				return api.getLedgerInstance(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'get',
+						uri: `/v1/orgs/${org}/ledgers/${props.ledgerName}/instances/${props.scopeValue}`,
+						auth: props.auth
+					});
+				});
+			});
+		});
+
+		describe('.setLedgerInstance', () => {
+			it('generates request', () => {
+				return api.setLedgerInstance(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'put',
+						uri: `/v1/orgs/${org}/ledgers/${props.ledgerName}/instances/${props.scopeValue}`,
+						auth: props.auth,
+						data: {
+							data: {
+								sentient: true
+							}
+						}
+					});
+				});
+			});
+		});
+
+		describe('.deleteLedgerInstance', () => {
+			it('generates request', () => {
+				return api.deleteLedgerInstance(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'delete',
+						uri: `/v1/orgs/${org}/ledgers/${props.ledgerName}/instances/${props.scopeValue}`,
+						auth: props.auth
+					});
+				});
+			});
+		});
+
+		describe('.listLedgerInstances', () => {
+			it('generates request', () => {
+				return api.listLedgerInstances(propsWithOrg).then((results) => {
+					results.should.match({
+						method: 'get',
+						uri: `/v1/orgs/${org}/ledgers/${props.ledgerName}/instances`,
+						auth: props.auth
+					});
+				});
+			});
+		});
 	});
 
 	describe('backwards-compatibility function aliases', () => {

package/test/fixtures/index.js

@@ -1,16 +1,8 @@
-/* In order for the tests to run in the browser the fixture files must
- * be loaded statically into an object. The 'brfs' module will replace
- * the fs.readFileSync('static_path') call by the contents of the file.
- */
-const fs = require('fs'); // import syntax doesn't work inside karma
-
 
 const fixtures = {
-	'libraries.json': fs.readFileSync(__dirname + '/libraries.json'),
-	'library.json': fs.readFileSync(__dirname + '/library.json'),
-	'libraryVersions.json': fs.readFileSync(__dirname + '/libraryVersions.json'),
-	'test-library-publish-0.0.1.tar.gz': fs.readFileSync(__dirname + '/test-library-publish-0.0.1.tar.gz'),
-	'test-library-publish-0.0.2.tar.gz': fs.readFileSync(__dirname + '/test-library-publish-0.0.2.tar.gz'),
+	'libraries.json': require('./libraries.json'),
+	'library.json': require('./library.json'),
+	'libraryVersions.json': require('./libraryVersions.json')
 };
 
 function read(filename) {
@@ -20,10 +12,4 @@ function read(filename) {
 	return fixtures[filename];
 }
 
-function readJSON(filename) {
-	return JSON.parse(read(filename));
-}
-
-export {
-	read, readJSON
-};
+module.exports = { read };

package/test/support/FixtureHttpServer.js

@@ -1,9 +1,9 @@
 // Serve files from the fixture folder
-import express from 'express';
-import * as fixtures from '../fixtures';
+const express = require('express');
+const fixtures = require('../fixtures');
 
 
-export default class FixtureHttpServer {
+class FixtureHttpServer {
 	constructor(){
 		this.app = express();
 		this.app.get('/:filename', (req, res) => {
@@ -23,3 +23,5 @@ export default class FixtureHttpServer {
 		return `http://localhost:${this.server.address().port}`;
 	}
 }
+
+module.exports = FixtureHttpServer;

package/test/test-setup.js

@@ -1,16 +1,16 @@
 // Set up the Mocha test framework with the Chai assertion library and
 // the Sinon mock library
 
-import chai from 'chai';
-import sinon from 'sinon';
-import sinonChai from 'sinon-chai';
-import chaiAsPromised from 'chai-as-promised';
+const chai = require('chai');
+const sinon = require('sinon');
+const sinonChai = require('sinon-chai');
+const chaiAsPromised = require('chai-as-promised');
 
 chai.use(sinonChai);
 chai.use(chaiAsPromised);
 const expect = chai.expect;
 
-export {
+module.exports = {
 	chai,
 	sinon,
 	expect

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es6",
+    "allowJs": true,
+    "checkJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true
+  },
+  "types": ["node"],
+  "include": [ "src" ],
+  "exclude": ["node_modules"]
+}

package/webpack.config.js

@@ -0,0 +1,45 @@
+const path = require('path');
+const webpack = require('webpack');
+const TerserPlugin = require('terser-webpack-plugin');
+
+module.exports = (env) => {
+	return {
+		mode: env.mode,
+		target: 'web',
+		entry: './src/Particle.js',
+		devtool: 'source-map',
+		output: {
+			filename: `particle${env.mode === 'production' ? '.min' : ''}.js`,
+			path: path.resolve(__dirname, 'dist'),
+			clean: true,
+			library: {
+				name: 'Particle',
+				type: 'var'
+			}
+		},
+		optimization: {
+			minimize: env.mode === 'production',
+			minimizer: [new TerserPlugin({
+				extractComments: false,
+				terserOptions: {
+					format: {
+						comments: false
+					}
+				}
+			})]
+		},
+		resolve: {
+			fallback: {
+				buffer: require.resolve('buffer'),
+				events: require.resolve('events'),
+				url: require.resolve('url')
+			}
+		},
+		plugins: [
+			new webpack.ProvidePlugin({
+				Buffer: ['buffer', 'Buffer'],
+				process: 'process/browser',
+			})
+		]
+	};
+};