Merge pull request #735 from particle-iot/fix/publish

Remove `--private` and `--public` args from `publish`

Author: keeramis

src/cli/publish.js

@@ -2,15 +2,6 @@ module.exports = ({ commandProcessor, root }) => {
 	commandProcessor.createCommand(root, 'publish', 'Publish an event to the cloud', {
 		params: '<event> [data]',
 		options: {
-			'private': {
-				boolean: true,
-				default: true,
-				description: 'Publish to the private stream'
-			},
-			'public': {
-				boolean: true,
-				description: 'Publish to the public stream'
-			},
 			'product': {
 				description: 'Publish to the given Product ID or Slug\'s stream'
 			}

src/cli/publish.test.js

@@ -25,11 +25,9 @@ describe('Publish Command-Line Interface', () => {
 		});
 
 		it('Parses options', () => {
-			const argv = commandProcessor.parse(root, ['publish', 'my-event', '--private', '--public', '--product', '12345']);
+			const argv = commandProcessor.parse(root, ['publish', 'my-event', '--product', '12345']);
 			expect(argv.clierror).to.equal(undefined);
 			expect(argv.params).to.eql({ event: 'my-event', data: undefined });
-			expect(argv.private).to.equal(true);
-			expect(argv.public).to.equal(true);
 			expect(argv.product).to.equal('12345');
 		});
 
@@ -56,8 +54,6 @@ describe('Publish Command-Line Interface', () => {
 					'Usage: particle publish [options] <event> [data]',
 					'',
 					'Options:',
-					'  --private  Publish to the private stream  [boolean] [default: true]',
-					'  --public   Publish to the public stream  [boolean]',
 					'  --product  Publish to the given Product ID or Slug\'s stream  [string]',
 					'',
 					'Examples:',

src/cmd/api.js

@@ -209,13 +209,13 @@ module.exports = class ParticleApi {
 		);
 	}
 
-	publishEvent(name, data, isPrivate, product){
+	publishEvent(name, data, product){
 		return this._wrap(
 			this.api.publishEvent({
 				name,
 				data,
 				product,
-				isPrivate,
+				isPrivate: true,
 				auth: this.accessToken
 			})
 		);

src/cmd/publish.js

@@ -11,16 +11,14 @@ module.exports = class PublishCommand extends CLICommandBase {
 		super(...args);
 	}
 
-	publishEvent({ private: isPrivate, public: isPublic, product, params: { event, data } }){
-		isPrivate = (isPublic && !product) ? false : isPrivate; // `isPrivate: true` by default see: src/cli/publish.js
-		const visibility = isPrivate ? 'private' : 'public';
-		let epilogue = `${visibility} event: ${event}`;
+	publishEvent({ product, params: { event, data } }){
+		let epilogue = `private event: ${event}`;
 
 		if (product){
 			epilogue += ` to product: ${product}`;
 		}
 
-		const publishEvent = createAPI().publishEvent(event, data, isPrivate, product);
+		const publishEvent = createAPI().publishEvent(event, data, product);
 		return this.ui.showBusySpinnerUntilResolved(`Publishing ${epilogue}`, publishEvent)
 			.then(() => this.ui.stdout.write(`Published ${epilogue}${os.EOL}${os.EOL}`))
 			.catch(error => {

src/lib/api-client.js

@@ -946,7 +946,7 @@ module.exports = class ApiClient {
 		});
 	}
 
-	publishEvent(eventName, data, setPrivate){
+	publishEvent(eventName, data){
 		const { request, _access_token: token } = this;
 		let self = this;
 
@@ -959,7 +959,7 @@ module.exports = class ApiClient {
 					name: eventName,
 					data: data,
 					access_token: token,
-					private: setPrivate
+					private: true
 				}
 			};
 
@@ -977,11 +977,7 @@ module.exports = class ApiClient {
 					return reject(body);
 				}
 
-				console.log(
-					`Published ${setPrivate ? 'private' : 'public'}`,
-					'event:',
-					eventName
-				);
+				console.log(`Published private event: ${eventName}`);
 				console.log('');
 				resolve(body);
 			});

test/e2e/publish.e2e.js

@@ -15,8 +15,6 @@ describe('Publish Commands', () => {
 		'  -q, --quiet    Decreases how much logging to display  [count]',
 		'',
 		'Options:',
-		'  --private  Publish to the private stream  [boolean] [default: true]',
-		'  --public   Publish to the public stream  [boolean]',
 		'  --product  Publish to the given Product ID or Slug\'s stream  [string]',
 		'',
 		'Examples:',
@@ -66,24 +64,6 @@ describe('Publish Commands', () => {
 		expect(exitCode).to.equal(0);
 	});
 
-	it('Publishes a private event', async () => {
-		const args = ['publish', eventName, '--private'];
-		const { stdout, stderr, exitCode } = await cli.run(args);
-
-		expect(stdout).to.include(`Published private event: ${eventName}${os.EOL}`);
-		expect(stderr).to.equal('');
-		expect(exitCode).to.equal(0);
-	});
-
-	it('Publishes a public event', async () => {
-		const args = ['publish', eventName, '--public'];
-		const { stdout, stderr, exitCode } = await cli.run(args);
-
-		expect(stdout).to.include(`Published public event: ${eventName}${os.EOL}`);
-		expect(stderr).to.equal('');
-		expect(exitCode).to.equal(0);
-	});
-
 	it('Publishes a product event', async () => {
 		const args = ['publish', eventName, '--product', PRODUCT_01_ID];
 		const { stdout, stderr, exitCode } = await cli.run(args);
@@ -94,16 +74,7 @@ describe('Publish Commands', () => {
 	});
 
 	it('Publishes a private product event', async () => {
-		const args = ['publish', eventName, '--product', PRODUCT_01_ID, '--private'];
-		const { stdout, stderr, exitCode } = await cli.run(args);
-
-		expect(stdout).to.include(`Published private event: ${eventName} to product: ${PRODUCT_01_ID}${os.EOL}`);
-		expect(stderr).to.equal('');
-		expect(exitCode).to.equal(0);
-	});
-
-	it('Ignores `--public` flag when publishing a product event', async () => {
-		const args = ['publish', eventName, '--product', PRODUCT_01_ID, '--public'];
+		const args = ['publish', eventName, '--product', PRODUCT_01_ID];
 		const { stdout, stderr, exitCode } = await cli.run(args);
 
 		expect(stdout).to.include(`Published private event: ${eventName} to product: ${PRODUCT_01_ID}${os.EOL}`);