🔖 v0.5.9

updated contributing guide

.gitignore

@@ -1,7 +1,8 @@
 node_modules
 npm-debug.log
 domain.json
-
+dist
+config.gypi
 
 // osx garbage
 *.DS_Store

.travis.yml

@@ -1,3 +1,38 @@
+sudo: required
+dist: trusty
+
+os:
+- osx
+- linux
+
+addons:
+  apt:
+    packages:
+    - build-essential
+    - libxext-dev
+    - libxtst-dev
+    - libxkbfile-dev
+
 language: node_js
 node_js:
-  - 'node'
+- '6'
+
+before_install:
+- npm install -g gulp
+- npm install
+
+cache:
+  directories:
+  - node_modules
+  - app/node_modules
+  - $HOME/.electron
+  - $HOME/.cache
+
+script:
+- npm run travis
+notifications:
+  webhooks:
+    urls:
+      - https://zulip.org/zulipbot/travis
+    on_success: always
+    on_failure: always

CONTRIBUTING.md

@@ -1,16 +1,24 @@
-#Contributing Guidelines
+# Contributing Guidelines
 
 Thanks for taking the time to contribute!
 
-The following is a set of guidelines for contributing to zulip-electron. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
+The following is a set of guidelines for contributing to zulip-electron. These are just guidelines, not rules, use your best judgement and feel free to propose changes to this document in a pull request.
 
 ## Getting Started
 
 Zulip-Desktop app is built on top of [Electron](http://electron.atom.io/). If you are new to Electron please head over to [this](http://jlord.us/essential-electron/) great article.
 
+## Community
+
+* The whole zulip documentation such as development environment, setting up with zulip project, testing, code of conduct can be read [here](https://zulip.readthedocs.io).
+
+* If you have any questions regarding zulip-electron, open an [issue](https://github.com/zulip/zulip-electron/issues/new/) or ask it [here](https://chat.zulip.org/#narrow/stream/electron).
+
 ## Issue
 Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/zulip/zulip-electron/issues). If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/zulip/zulip-electron/issues/new). Please pay attention to following points while opening an issue.
 
+The [Zulipbot](https://github.com/zulip/zulipbot) helps to claim the issue by commenting the following in the comment section: "**@zulipbot** claim". **@zulipbot** will assign you to the issue and label the issue as **in progress**. For more details, check out [**@zulipbot**](https://github.com/zulip/zulipbot).
+
 ### Does it happen on web browsers? (especially Chrome)
 Zulip-Desktop is based on Electron, which integrates the Chrome engine within a standalone application.
 If the problem you encounter can be reproduced on web browsers, it may be an issue with Zulip web app.

README.md

@@ -1,13 +1,27 @@
 # Zulip Desktop Client 
+[![Build Status](https://travis-ci.org/zulip/zulip-electron.svg?branch=master)](https://travis-ci.org/zulip/zulip-electron)
+[![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/zulip/zulip-electron?branch=master&svg=true)](https://ci.appveyor.com/project/akashnimare/zulip-electron/branch/master)
+[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
 
 This is an experimental replacement for the [Zulip Desktop
 app](https://github.com/zulip/zulip-desktop) implemented in
-[Electron](http://electron.atom.io/).
+[Electron](http://electron.atom.io/).eeee
 
 The goal is to achieve feature-compatibility with the old desktop app
 and then start adding cool features like easy support for
 multi-account, auto-updates etc.
 
+## Prerequisites
+* node >= v6.3.1
+> Use [nvm](https://github.com/creationix/nvm) to install the current stable version of node
+
+
+* python (v2.7.x recommended)
+* If you're on Debian or Ubuntu, you'll need to install following packages:
+```sh
+$ sudo apt-get install build-essential libxext-dev libxtst-dev libxkbfile-dev
+```
+
 ## Installation
 
 Clone the source locally:
@@ -16,14 +30,6 @@ Clone the source locally:
 $ git clone https://github.com/zulip/zulip-electron
 $ cd zulip-electron
 ```
-If you're on Debian or Ubuntu, you'll also need to install
-`nodejs-legacy`:
-
-Use your package manager to install `npm`.
-
-```sh
-$ sudo apt-get install npm nodejs-legacy
-```
 
 Install project dependencies:
 
@@ -41,19 +47,32 @@ Start and watch changes
 ```sh
 $ npm run dev
 ```
+# Making a release
+
+To package app into an installer use command:
+```
+npm run dist
+```
+It will start the packaging process for operating system you are running this command on. Ready for distribution file (e.g. dmg, windows installer, deb package) will be outputted to `dist` directory.
+
+You can create Windows installer only when running on Windows, the same is true for Linux and OSX. So to generate all three installers you need all three operating systems.
+
 
 ## Features
 
 - [x] Native Notifications
-- [x] Spell Checker
+- [x] SpellChecker
-- [x] Keyboard Shortcuts
+- [x] OSX/Win/Linux installer
-- Default shortcuts - <kbd>cmdOrctrl + k </kbd>
+- [x] Automatic Updates (macOS/Windows)
-- Change Zulip Server: <kbd>cmdOrctrl + ,</kbd>
+- [x] Keyboard shortcuts
-- Back: <kbd>cmdOrctrl + [</kbd>
+
-- Forward: <kbd>cmdOrctrl + ]</kbd>
+Description            | Keys
-- [ ] OSX/Win/Linux installer
+-----------------------| -----------------------
-- [ ] Launch on OS startup
+Default shortcuts      | <kbd>Cmd/Ctrl</kbd> <kbd>k</kbd>
-- [ ] Automatic Updates
+Change Zulip Server    | <kbd>Cmd/Ctrl</kbd> <kbd>,</kbd>
+Back                   | <kbd>Cmd/Ctrl</kbd> <kbd>[</kbd>
+Forward                | <kbd>Cmd/Ctrl</kbd> <kbd>]</kbd>
+
 
 ## Contribute
 

app/main/autoupdater.js

@@ -0,0 +1,47 @@
+'use strict';
+const {app, dialog} = require('electron');
+const {autoUpdater} = require('electron-updater');
+
+function appUpdater() {
+	// Log whats happening
+	const log = require('electron-log');
+	log.transports.file.level = 'info';
+	autoUpdater.logger = log;
+	/*
+	autoUpdater.on('error', err => log.info(err));
+	autoUpdater.on('checking-for-update', () => log.info('checking-for-update'));
+	autoUpdater.on('update-available', () => log.info('update-available'));
+	autoUpdater.on('update-not-available', () => log.info('update-not-available'));
+	*/
+
+	// Ask the user if update is available
+	// eslint-disable-next-line no-unused-vars
+	autoUpdater.on('update-downloaded', (event, info) => {
+		// let message = app.getName() + ' ' + info.releaseName + ' is now available. It will be installed the next time you restart the application.';
+		// if (info.releaseNotes) {
+			// const splitNotes = info.releaseNotes.split(/[^\r]\n/);
+			// message += '\n\nRelease notes:\n';
+			// splitNotes.forEach(notes => {
+				// message += notes + '\n\n';
+			// });
+		// }
+		// Ask user to update the app
+		dialog.showMessageBox({
+			type: 'question',
+			buttons: ['Install and Relaunch', 'Later'],
+			defaultId: 0,
+			message: 'A new version of ' + app.getName() + ' has been downloaded',
+			detail: 'It will be installed the next time you restart the application'
+		}, response => {
+			if (response === 0) {
+				setTimeout(() => autoUpdater.quitAndInstall(), 1);
+			}
+		});
+	});
+	// init for updates
+	autoUpdater.checkForUpdates();
+}
+
+exports = module.exports = {
+	appUpdater
+};

app/main/domain.js

@@ -0,0 +1,48 @@
+const {app} = require('electron').remote;
+const ipcRenderer = require('electron').ipcRenderer;
+const JsonDB = require('node-json-db');
+const request = require('request');
+
+const db = new JsonDB(app.getPath('userData') + '/domain.json', true, true);
+const data = db.getData('/');
+
+console.log(data.domain);
+window.addDomain = function () {
+	let newDomain = document.getElementById('url').value;
+	newDomain = newDomain.replace(/^https?:\/\//, '');
+	newDomain = newDomain.replace(/^http?:\/\//, '');
+	if (newDomain === '') {
+		document.getElementById('server-status').innerHTML = 'Please input a value';
+	} else {
+		document.getElementById('main').innerHTML = 'Checking...';
+		if (newDomain.indexOf('localhost:') >= 0) {
+			const domain = 'http://' + newDomain;
+			const checkDomain = domain + '/static/audio/zulip.ogg';
+			request(checkDomain, (error, response) => {
+				if (!error && response.statusCode !== 404) {
+					document.getElementById('main').innerHTML = 'Connect';
+					db.push('/domain', domain);
+					ipcRenderer.send('new-domain', domain);
+				} else {
+					document.getElementById('main').innerHTML = 'Connect';
+					document.getElementById('server-status').innerHTML = 'Not a valid Zulip Local Server.';
+				}
+			});
+			//	});
+		} else {
+			const domain = 'https://' + newDomain;
+			const checkDomain = domain + '/static/audio/zulip.ogg';
+
+			request(checkDomain, (error, response) => {
+				if (!error && response.statusCode !== 404) {
+					document.getElementById('main').innerHTML = 'Connect';
+					db.push('/domain', domain);
+					ipcRenderer.send('new-domain', domain);
+				} else {
+					document.getElementById('main').innerHTML = 'Connect';
+					document.getElementById('server-status').innerHTML = 'Not a valid Zulip Server.';
+				}
+			});
+		}
+	}
+};

app/main/index.js

@@ -1,36 +1,128 @@
 'use strict';
 const path = require('path');
+const fs = require('fs');
+const os = require('os');
 const electron = require('electron');
 const {app} = require('electron');
-const electronLocalshortcut = require('electron-localshortcut');
 const ipc = require('electron').ipcMain;
-const Configstore = require('configstore');
+const {dialog} = require('electron');
+const https = require('https');
+const http = require('http');
+const electronLocalshortcut = require('electron-localshortcut');
+const Configstore = require('electron-config');
 const JsonDB = require('node-json-db');
-const SpellChecker = require('simple-spellchecker');
+const isDev = require('electron-is-dev');
 const tray = require('./tray');
 const appMenu = require('./menu');
-const link = require('./link-helper');
+const {linkIsInternal, skipImages} = require('./link-helper');
-
+const {appUpdater} = require('./autoupdater');
-const {linkIsInternal} = link;
 
 const db = new JsonDB(app.getPath('userData') + '/domain.json', true, true);
 const data = db.getData('/');
 
 // adds debug features like hotkeys for triggering dev tools and reload
 require('electron-debug')();
-require('electron-context-menu')();
 
-const conf = new Configstore('Zulip-Desktop');
+const conf = new Configstore();
 
-// spellchecker enabled
+function userOS() {
-let myDictionary = null;
+	if (os.platform() === 'darwin') {
+		return 'Mac';
+	}
+	if (os.platform() === 'linux') {
+		return 'Linux';
+	}
+	if (os.platform() === 'win32' || os.platform() === 'win64') {
+		if (parseFloat(os.release()) < 6.2) {
+			return 'Windows 7';
+		} else {
+			return 'Windows 10';
+		}
+	}
+}
+
+// setting userAgent so that server-side code can identify the desktop app
+const isUserAgent = 'ZulipElectron/' + app.getVersion() + ' ' + userOS();
 
 // prevent window being garbage collected
 let mainWindow;
 let targetLink;
 
 // Load this url in main window
-const targetUrl = 'file://' + path.join(__dirname, '../renderer', 'index.html');
+const staticURL = 'file://' + path.join(__dirname, '../renderer', 'index.html');
+
+const targetURL = function () {
+	if (data.domain === undefined) {
+		return staticURL;
+	}
+	return data.domain;
+};
+
+function serverError(targetURL) {
+	if (targetURL.indexOf('localhost:') < 0 && data.domain) {
+		const req = https.request(targetURL + '/static/audio/zulip.ogg', res => {
+			console.log('Server StatusCode:', res.statusCode);
+			console.log('You are connected to:', res.req._headers.host);
+			if (res.statusCode >= 500 && res.statusCode <= 599) {
+				return dialog.showErrorBox('SERVER IS DOWN!', 'We are getting a ' + res.statusCode + ' error status from the server ' + res.req._headers.host + '. Please try again after some time or you may switch server.');
+			}
+		});
+		req.on('error', e => {
+			console.error(e);
+		});
+		req.end();
+	} else if (data.domain) {
+		const req = http.request(targetURL + '/static/audio/zulip.ogg', res => {
+			console.log('Server StatusCode:', res.statusCode);
+			console.log('You are connected to:', res.req._headers.host);
+		});
+		req.on('error', e => {
+			console.error(e);
+		});
+		req.end();
+	}
+}
+
+function checkConnectivity() {
+	return dialog.showMessageBox({
+		title: 'Internet connection problem',
+		message: 'No internet available! Try again?',
+		type: 'warning',
+		buttons: ['Try again', 'Close'],
+		defaultId: 0
+	}, index => {
+		if (index === 0) {
+			mainWindow.webContents.reload();
+		}
+		if (index === 1) {
+			app.quit();
+		}
+	});
+}
+
+function checkConnection() {
+	// eslint-disable-next-line no-unused-vars
+	mainWindow.webContents.on('did-fail-load', (event, errorCode, errorDescription, validatedURL) => {
+		if (errorDescription === 'ERR_INTERNET_DISCONNECTED' || errorDescription === 'ERR_PROXY_CONNECTION_FAILED') {
+			console.log('Error Description:' + errorDescription);
+			checkConnectivity();
+		}
+	});
+}
+
+const isAlreadyRunning = app.makeSingleInstance(() => {
+	if (mainWindow) {
+		if (mainWindow.isMinimized()) {
+			mainWindow.restore();
+		}
+
+		mainWindow.show();
+	}
+});
+
+if (isAlreadyRunning) {
+	app.quit();
+}
 
 function checkWindowURL() {
 	if (data.domain !== undefined) {
@@ -39,17 +131,19 @@ function checkWindowURL() {
 	return targetLink;
 }
 
-const APP_ICON = path.join(__dirname, '../resources', 'Icon');
+function isWindowsOrmacOS() {
+	return process.platform === 'darwin' || process.platform === 'win32';
+}
 
-const spellDict = path.join(__dirname, '../../node_modules/simple-spellchecker/dict');
+const APP_ICON = path.join(__dirname, '../resources', 'Icon');
 
 const iconPath = () => {
 	return APP_ICON + (process.platform === 'win32' ? '.ico' : '.png');
 };
 
 function onClosed() {
-	// dereference the window
+	// Dereference the window
-	// for multiple windows store them in an array
+	// For multiple windows, store them in an array
 	mainWindow = null;
 }
 
@@ -77,12 +171,23 @@ function createMainWindow() {
 		minHeight: 400,
 		webPreferences: {
 			preload: path.join(__dirname, 'preload.js'),
-			nodeIntegration: true,
+			plugins: true,
-			plugins: true
+			allowDisplayingInsecureContent: true,
-		}
+			nodeIntegration: false
+		},
+		show: false
+	});
+
+	win.once('ready-to-show', () => {
+		win.show();
+	});
+
+	serverError(targetURL());
+
+	win.loadURL(targetURL(), {
+		userAgent: isUserAgent + ' ' + win.webContents.getUserAgent()
 	});
 
-	win.loadURL(targetUrl);
 	win.on('closed', onClosed);
 	win.setTitle('Zulip');
 
@@ -134,6 +239,8 @@ function createMainWindow() {
 app.commandLine.appendSwitch('ignore-certificate-errors', 'true');
 
 app.on('window-all-closed', () => {
+	// unregister all the shortcuts so that they don't interfare with other apps
+	electronLocalshortcut.unregisterAll(mainWindow);
 	if (process.platform !== 'darwin') {
 		app.quit();
 	}
@@ -148,24 +255,10 @@ app.on('activate', () => {
 app.on('ready', () => {
 	electron.Menu.setApplicationMenu(appMenu);
 	mainWindow = createMainWindow();
-	tray.create(mainWindow);
+	tray.create();
 
 	const page = mainWindow.webContents;
 
-	// Add spellcheck dictionary
-	SpellChecker.getDictionary('en-US', spellDict, (err, result) => {
-		if (!err) {
-			myDictionary = result;
-		}
-	});
-
-	// Define function for consult the dictionary.
-	ipc.on('checkspell', (event, word) => {
-		if (myDictionary !== null && word !== null) {
-			event.returnValue = myDictionary.spellCheck(word);
-		}
-	});
-
 	// TODO - use global shortcut instead
 	electronLocalshortcut.register(mainWindow, 'CommandOrControl+R', () => {
 		mainWindow.reload();
@@ -183,33 +276,46 @@ app.on('ready', () => {
 		}
 	});
 
-	// electronLocalshortcut.register(mainWindow, 'CommandOrControl+=', () => {
+	page.on('dom-ready', () => {
-	// 	page.send('zoomIn');
+		page.insertCSS(fs.readFileSync(path.join(__dirname, 'preload.css'), 'utf8'));
-	// });
+		mainWindow.show();
-
+	});
-	// electronLocalshortcut.register(mainWindow, 'CommandOrControl+-', () => {
-	// 	page.send('zoomOut');
-	// });
-
-	// electronLocalshortcut.register(mainWindow, 'CommandOrControl+0', () => {
-	// 	page.send('zoomActualSize');
-	// });
 
 	page.on('new-window', (event, url) => {
-		if (mainWindow.useDefaultWindowBehaviour) {
+		if (linkIsInternal(checkWindowURL(), url) && url.match(skipImages) === null) {
-			mainWindow.useDefaultWindowBehaviour = false;
-			return;
-		}
-		if (linkIsInternal(checkWindowURL(), url)) {
 			event.preventDefault();
 			return mainWindow.loadURL(url);
 		}
 		event.preventDefault();
 		electron.shell.openExternal(url);
 	});
+
+	page.once('did-frame-finish-load', () => {
+		const checkOS = isWindowsOrmacOS();
+		if (checkOS && !isDev) {
+			// Initate auto-updates on MacOS and Windows
+			appUpdater();
+		}
+	});
+	checkConnection();
+});
+
+app.on('will-quit', () => {
+	// unregister all the shortcuts so that they don't interfare with other apps
+	electronLocalshortcut.unregisterAll(mainWindow);
 });
 
 ipc.on('new-domain', (e, domain) => {
+	// mainWindow.loadURL(domain);
+	if (!mainWindow) {
+		mainWindow = createMainWindow();
 		mainWindow.loadURL(domain);
+	} else if (mainWindow.isMinimized()) {
+		mainWindow.loadURL(domain);
+		mainWindow.show();
+	} else {
+		mainWindow.loadURL(domain);
+		serverError(domain);
+	}
 	targetLink = domain;
 });

app/main/link-helper.js

@@ -2,11 +2,14 @@ const wurl = require('wurl');
 
 // Check link if it's internal/external
 function linkIsInternal(currentUrl, newUrl) {
-	const currentDomain = wurl('domain', currentUrl);
+	const currentDomain = wurl('hostname', currentUrl);
-	const newDomain = wurl('domain', newUrl);
+	const newDomain = wurl('hostname', newUrl);
 	return currentDomain === newDomain;
 }
 
+// We'll be needing this to open images in default browser
+const skipImages = '.jpg|.gif|.png|.jpeg|.JPG|.PNG';
+
 exports = module.exports = {
-	linkIsInternal
+	linkIsInternal, skipImages
 };

app/main/menu.js

@@ -2,10 +2,13 @@
 const os = require('os');
 const electron = require('electron');
 
+const {dialog} = require('electron');
+
 const app = electron.app;
 const BrowserWindow = electron.BrowserWindow;
 const shell = electron.shell;
 const appName = app.getName();
+const tray = require('./tray');
 
 const {addDomain, about} = require('./windowmanager');
 
@@ -19,10 +22,17 @@ function sendAction(action) {
 	win.webContents.send(action);
 }
 
+function clearCache() {
+	const win = BrowserWindow.getAllWindows()[0];
+	const ses = win.webContents.session;
+	ses.clearCache(() => {
+		dialog.showMessageBox({type: 'info', buttons: [], message: 'Cache cleared!'});
+	});
+}
+
 const viewSubmenu = [
 	{
 		label: 'Reload',
-		accelerator: 'CmdOrCtrl+R',
 		click(item, focusedWindow) {
 			if (focusedWindow) {
 				focusedWindow.reload();
@@ -65,6 +75,14 @@ const viewSubmenu = [
 	{
 		type: 'separator'
 	},
+	{
+		label: 'Toggle Tray Icon',
+		click(item, focusedWindow) {
+			if (focusedWindow) {
+				tray.toggle();
+			}
+		}
+	},
 	{
 		label: 'Toggle Developer Tools',
 		accelerator: process.platform === 'darwin' ? 'Alt+Command+I' : 'Ctrl+Shift+I',
@@ -119,11 +137,9 @@ const darwinTpl = [
 			{
 				label: 'Change Zulip Server',
 				accelerator: 'Cmd+,',
-				click(item, focusedWindow) {
+				click() {
-					if (focusedWindow) {
 					addDomain();
 				}
-				}
 			},
 			{
 				label: 'Keyboard shortcuts',
@@ -137,8 +153,15 @@ const darwinTpl = [
 			{
 				type: 'separator'
 			},
+			{
+				label: 'Clear Cache',
+				click() {
+					clearCache();
+				}
+			},
 			{
 				label: 'Log Out',
+				accelerator: 'Cmd+L',
 				click(item, focusedWindow) {
 					if (focusedWindow) {
 						sendAction('log-out');
@@ -247,11 +270,9 @@ const otherTpl = [
 			{
 				label: 'Change Zulip Server',
 				accelerator: 'Ctrl+,',
-				click(item, focusedWindow) {
+				click() {
-					if (focusedWindow) {
 					addDomain();
 				}
-				}
 			},
 			{
 				type: 'separator'
@@ -268,8 +289,15 @@ const otherTpl = [
 			{
 				type: 'separator'
 			},
+			{
+				label: 'Clear Cache',
+				click() {
+					clearCache();
+				}
+			},
 			{
 				label: 'Log Out',
+				accelerator: 'Ctrl+L',
 				click(item, focusedWindow) {
 					if (focusedWindow) {
 						sendAction('log-out');
@@ -317,7 +345,6 @@ const otherTpl = [
 			{
 				role: 'selectall'
 			}
-
 		]
 	},
 	{

app/main/preload.css

@@ -0,0 +1 @@
+/* We'll be overriding default styling so that app look more native * / 

app/main/preload.js

@@ -1,18 +1,19 @@
 'use strict';
 const ipcRenderer = require('electron').ipcRenderer;
-const webFrame = require('electron').webFrame;
+const {webFrame} = require('electron');
+const {spellChecker} = require('./spellchecker');
 
-// Implement spellcheck using electron api
+const _setImmediate = setImmediate;
-
+const _clearImmediate = clearImmediate;
-webFrame.setSpellCheckProvider('en-US', false, {
+process.once('loaded', () => {
-	spellCheck: text => {
+	global.setImmediate = _setImmediate;
-		const res = ipcRenderer.sendSync('checkspell', text);
+	global.clearImmediate = _clearImmediate;
-		return res === null ? true : res;
-	}
 });
 
-// Handle zooming functionality
+// eslint-disable-next-line import/no-unassigned-import
+require('./domain');
 
+// handle zooming functionality
 const zoomIn = () => {
 	webFrame.setZoomFactor(webFrame.getZoomFactor() + 0.1);
 };
@@ -25,7 +26,7 @@ const zoomActualSize = () => {
 	webFrame.setZoomFactor(1);
 };
 
-// Get zooming actions from main process
+// get zooming actions from main process
 ipcRenderer.on('zoomIn', () => {
 	zoomIn();
 });
@@ -48,8 +49,18 @@ ipcRenderer.on('log-out', () => {
 
 ipcRenderer.on('shortcut', () => {
 	// create the menu for the below
+	const node = document.querySelector('a[data-overlay-trigger=keyboard-shortcuts]');
+	// additional check
+	if (node.text.trim().toLowerCase() === 'keyboard shortcuts') {
+		node.click();
+	} else {
+		// atleast click the dropdown
 		document.querySelector('.dropdown-toggle').click();
-
+	}
-	const nodes = document.querySelectorAll('.dropdown-menu li:nth-child(4) a');
+});
-	nodes[nodes.length - 1].click();
+
+// To prevent failing this script on linux we need to load it after the document loaded
+document.addEventListener('DOMContentLoaded', () => {
+	// init spellchecker
+	spellChecker();
 });

app/main/spellchecker.js

@@ -0,0 +1,27 @@
+const {SpellCheckHandler, ContextMenuListener, ContextMenuBuilder} = require('electron-spellchecker');
+
+function spellChecker() {
+	// Implement spellcheck using electron api
+	window.spellCheckHandler = new SpellCheckHandler();
+	window.spellCheckHandler.attachToInput();
+
+	// Start off as US English
+	window.spellCheckHandler.switchLanguage('en-US');
+
+	const contextMenuBuilder = new ContextMenuBuilder(window.spellCheckHandler);
+	const contextMenuListener = new ContextMenuListener(info => {
+		contextMenuBuilder.showPopupMenu(info);
+	});
+
+	// Clean up events after you navigate away from this page;
+	// otherwise, you may experience errors
+	window.addEventListener('beforeunload', () => {
+	// eslint-disable-next-line no-undef
+		spellCheckHandler.unsubscribe();
+		contextMenuListener.unsubscribe();
+	});
+}
+
+exports = module.exports = {
+	spellChecker
+};

app/main/tray.js

@@ -6,21 +6,16 @@ const {addDomain, about} = require('./windowmanager');
 
 let tray = null;
 
-const APP_ICON = path.join(__dirname, '../resources', 'Icon');
+const APP_ICON = path.join(__dirname, '../resources/tray', 'tray');
 
 const iconPath = () => {
-	return APP_ICON + (process.platform === 'win32' ? '.ico' : '.png');
+	if (process.platform === 'linux') {
+		return APP_ICON + 'linux.png';
+	}
+	return APP_ICON + (process.platform === 'win32' ? 'win.ico' : 'osx.png');
 };
 
-exports.create = () => {
+const createHandler = () => {
-	// Noone is using this feature. so let's hide it for now.
-	// const toggleWin = () => {
-	// 	if (win.isVisible()) {
-	// 		win.hide();
-	// 	} else {
-	// 		win.show();
-	// 	}
-	// };
 	const contextMenu = electron.Menu.buildFromTemplate([
 		{
 			label: 'About',
@@ -33,11 +28,9 @@ exports.create = () => {
 		},
 		{
 			label: 'Change Zulip server',
-			click(item, focusedWindow) {
+			click() {
-				if (focusedWindow) {
 				addDomain();
 			}
-			}
 		},
 		{
 			type: 'separator'
@@ -66,3 +59,23 @@ exports.create = () => {
 	tray.setContextMenu(contextMenu);
 };
 
+const destroyHandler = () => {
+	tray.destroy();
+	if (tray.isDestroyed()) {
+		tray = null;
+	} else {
+		throw new Error('Tray icon not properly destroyed.');
+	}
+};
+
+const toggleHandler = () => {
+	if (tray) {
+		destroyHandler();
+	} else {
+		createHandler();
+	}
+};
+
+exports.create = createHandler;
+exports.destroy = destroyHandler;
+exports.toggle = toggleHandler;

app/main/windowmanager.js

@@ -2,6 +2,11 @@
 const path = require('path');
 const electron = require('electron');
 
+const APP_ICON = path.join(__dirname, '../resources', 'Icon');
+
+const iconPath = () => {
+	return APP_ICON + (process.platform === 'win32' ? '.ico' : '.png');
+};
 let domainWindow;
 let aboutWindow;
 
@@ -14,10 +19,14 @@ function onClosed() {
 // Change Zulip server Window
 function createdomainWindow() {
 	const domainwin = new electron.BrowserWindow({
+		title: 'Switch Server',
 		frame: false,
 		height: 300,
 		resizable: false,
-		width: 400
+		width: 400,
+		show: false,
+		icon: iconPath()
+
 	});
 	const domainURL = 'file://' + path.join(__dirname, '../renderer', 'pref.html');
 	domainwin.loadURL(domainURL);
@@ -25,13 +34,20 @@ function createdomainWindow() {
 
 	return domainwin;
 }
-
 // Call this window onClick addDomain in tray
 function addDomain() {
 	domainWindow = createdomainWindow();
+	domainWindow.once('ready-to-show', () => {
 		domainWindow.show();
+	});
+	setTimeout(() => {
+		if (domainWindow !== null) {
+			if (!domainWindow.isDestroyed()) {
+				domainWindow.destroy();
+			}
+		}
+	}, 15000);
 }
-
 // About window
 function createAboutWindow() {
 	const aboutwin = new electron.BrowserWindow({
@@ -61,9 +77,9 @@ function createAboutWindow() {
 // Call this onClick About in tray
 function about() {
 	aboutWindow = createAboutWindow();
+	aboutWindow.once('ready-to-show', () => {
 		aboutWindow.show();
+	});
 }
 
-exports = module.exports = {
+exports = module.exports = {addDomain, about};
-	addDomain, about
-};

app/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "zulip",
+  "productName": "Zulip",
+  "version": "0.5.9",
+  "description": "Zulip Desktop App",
+  "license": "Apache-2.0",
+  "email": "<svnitakash@gmail.com>",
+  "copyright": "©2017 Kandra Labs, Inc.",
+  "author": {
+    "name": "Akash Nimare",
+    "email": "svnitakash@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zulip/zulip-electron.git"
+  },
+  "bugs": {
+    "url": "https://github.com/zulip/zulip-electron/issues"
+  },
+  "main": "main/index.js",
+  "keywords": [
+    "Zulip",
+    "Group Chat app",
+    "electron-app",
+    "electron",
+    "Desktop app",
+    "InstantMessaging"
+  ],
+  "dependencies": {
+    "electron-config":"0.2.1",
+    "electron-debug": "1.1.0",
+    "electron-is-dev": "0.1.2",
+    "electron-localshortcut": "1.0.0",
+    "electron-log": "1.3.0",
+    "electron-spellchecker": "1.0.5",
+    "electron-updater": "1.11.2",
+    "https": "^1.0.0",
+    "node-json-db": "0.7.3",
+    "request": "2.79.0",
+    "wurl": "2.1.0"
+  }
+}

app/renderer/about.html

@@ -7,13 +7,17 @@
 	<body>
 	<div class="about">
 		<center><img src="../resources/zulip.png"></center>
-		<center><p class="detail"> Version : 0.0.1 </p>
+		<center><p class="detail" id="version"> Version : ?.?.? </p>
 		<center><p class="detail"> License : Apache </p>
 		<center><p class="detail"> Maintainer : Zulip </p>
 		<p class="left"><a class="bug" onclick="linkInBrowser()" href="#">Found bug?</a></p>
 	</div>
 	<script>
 
+	const app = require('electron').remote.app;
+	const version_tag = document.getElementById('version');
+	version_tag.innerHTML = ' Version : ' + app.getVersion() + ' ';
+
 	function linkInBrowser(event) {
 
 		const shell = require('electron').shell;

app/renderer/css/pref.css

@@ -72,12 +72,3 @@ button:focus {
     left: 25%;
     text-align: center;
 }
-
-#pic {
-width: 20px;
-left: 36%;
-margin-left: 4px;
-top: 63%;
-display: none;
-position: absolute;
-}

app/renderer/index.html

@@ -6,17 +6,6 @@
     <meta name="viewport" content="width=device-width">
     <title>Login - Zulip</title>
     <link rel="stylesheet" href="css/main.css" type="text/css" media="screen">
-    <script type="text/javascript">
-    const JsonDB = require('node-json-db');
-    const {app} = require('electron').remote;
-    const db = new JsonDB(app.getPath('userData') + '/domain.json', true, true);
-    const data = db.getData('/');
-
-    if (data.domain) {
-        window.location.href = data.domain;
-    }
-    </script>
-    <script>require('electron-connect').client.create()</script>
   </head>
   <body class="container-layout">
     <div class="section-main">
@@ -29,12 +18,12 @@
       <section class="content">
         <section class="server">
           <div class="container">
-            <h1>Login to Zulip Server</h1>
+            <h1>Enter your Zulip Server URL</h1>
             <form id="frm-signInForm" class="form-large" onsubmit="addDomain(); return false">
               <fieldset>
                 <div class="control-group control-required">
                   <div class="control-field">
-                    <input type="text" id="url"  autofocus="autofocus" spellcheck="false" placeholder="zulip.tabbott.net">
+                    <input type="text" id="url"  autofocus="autofocus" spellcheck="false" placeholder="Server URL">
                   </div>
                 </div>
                 <div class="control-group">
@@ -49,6 +38,5 @@
         </section>
       </section>
     </div>
-    <script src="js/main.js"></script>
   </body>
 </html>

app/renderer/js/main.js

@@ -1,30 +0,0 @@
-/* global app */
-// eslint-disable-next-line no-unused-vars
-function addDomain() {
-	const request = require('request');
-	const ipcRenderer = require('electron').ipcRenderer;
-	const JsonDB = require('node-json-db');
-
-	const db = new JsonDB(app.getPath('userData') + '/domain.json', true, true);
-
-	document.getElementById('main').innerHTML = 'checking...';
-
-	let newDomain = document.getElementById('url').value;
-	newDomain = newDomain.replace(/^https?:\/\//, '');
-
-	const domain = 'https://' + newDomain;
-	const checkDomain = domain + '/static/audio/zulip.ogg';
-
-	request(checkDomain, (error, response) => {
-		if (!error && response.statusCode !== 404) {
-			document.getElementById('main').innerHTML = 'Connect';
-			db.push('/domain', domain);
-			ipcRenderer.send('new-domain', domain);
-			// window.location.href = domain;
-		} else {
-			document.getElementById('main').innerHTML = 'Connect';
-			document.getElementById('server-status').innerHTML = 'Not a vaild Zulip Server.';
-		}
-	});
-}
-

app/renderer/js/pref.js

@@ -1,4 +1,5 @@
 'use strict';
+// eslint-disable-next-line import/no-extraneous-dependencies
 const {remote} = require('electron');
 
 const prefWindow = remote.getCurrentWindow();
@@ -13,33 +14,54 @@ document.addEventListener('keydown', event => {
 	}
 });
 // eslint-disable-next-line no-unused-vars
-function addDomain() {
+window.prefDomain = function () {
 	const request = require('request');
+	// eslint-disable-next-line import/no-extraneous-dependencies
 	const ipcRenderer = require('electron').ipcRenderer;
 	const JsonDB = require('node-json-db');
-	const {app} = require('electron').remote;
+	// eslint-disable-next-line import/no-extraneous-dependencies
+	const {
+		app
+	} = require('electron').remote;
 
 	const db = new JsonDB(app.getPath('userData') + '/domain.json', true, true);
-	document.getElementById('main').innerHTML = 'checking...';
-	document.getElementById('pic').style.display = 'block';
 
 	let newDomain = document.getElementById('url').value;
 	newDomain = newDomain.replace(/^https?:\/\//, '');
+	newDomain = newDomain.replace(/^http?:\/\//, '');
 
-	const domain = 'https://' + newDomain;
+	if (newDomain === '') {
+		document.getElementById('urladded').innerHTML = 'Please input a value';
+	} else {
+		document.getElementById('main').innerHTML = 'Checking...';
+		if (newDomain.indexOf('localhost:') >= 0) {
+			const domain = 'http://' + newDomain;
 			const checkDomain = domain + '/static/audio/zulip.ogg';
-
 			request(checkDomain, (error, response) => {
 				if (!error && response.statusCode !== 404) {
-			document.getElementById('pic').style.display = 'none';
 					document.getElementById('main').innerHTML = 'Switch';
 					document.getElementById('urladded').innerHTML = 'Switched to ' + newDomain;
 					db.push('/domain', domain);
 					ipcRenderer.send('new-domain', domain);
 				} else {
-			document.getElementById('pic').style.display = 'none';
 					document.getElementById('main').innerHTML = 'Switch';
-			document.getElementById('urladded').innerHTML = 'Not a vaild Zulip server.';
+					document.getElementById('urladded').innerHTML = 'Not a valid Zulip Local Server.';
 				}
 			});
-}
+		} else {
+			const domain = 'https://' + newDomain;
+			const checkDomain = domain + '/static/audio/zulip.ogg';
+			request(checkDomain, (error, response) => {
+				if (!error && response.statusCode !== 404) {
+					document.getElementById('main').innerHTML = 'Switch';
+					document.getElementById('urladded').innerHTML = 'Switched to ' + newDomain;
+					db.push('/domain', domain);
+					ipcRenderer.send('new-domain', domain);
+				} else {
+					document.getElementById('main').innerHTML = 'Switch';
+					document.getElementById('urladded').innerHTML = 'Not a valid Zulip Server.';
+				}
+			});
+		}
+	}
+};

app/renderer/pref.html

@@ -3,17 +3,14 @@
 	<head>
 		<meta charset="UTF-8">
 		<link rel="stylesheet" href="css/pref.css">
-		<script type="text/javascript">
-		</script>
 	</head>
 	<body>
 		<div class="close" id="close-button">Close</div>
 		<div class="form">
-			<form onsubmit="addDomain(); return false">
+			<form onsubmit="prefDomain(); return false">
-				<input id="url" type="text" placeholder="zulip.example.com">
+				<input id="url" type="text" placeholder="Server URL">
-				<button type="submit" id="main" value="Submit" onclick="addDomain();">
+				<button type="submit" id="main" value="Submit">
 				Switch</button>
-				<img id="pic" src="img/loader.gif" />
 			</form>
 			<p id="urladded"><p>
 			</div>

appveyor.yml

@@ -0,0 +1,23 @@
+version: build{build}
+
+platform:
+  - x64
+os: Previous Visual Studio 2015
+
+cache:
+  - node_modules
+  
+install:
+  - ps: Install-Product node 6 x64
+  - git reset --hard HEAD
+  - npm install npm -g
+  - node --version
+  - npm --version
+  - python --version
+  - npm install
+  - npm install -g gulp
+
+build: off  
+
+test_script:
+  - npm run test

build/icons/1024x1024.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1b92ae5c6e5fb0e5b7fcdb46fe102fa0ca7f4d150016cf1a461c0e86921bc731
+size 163336

gulpfile.js

@@ -1,5 +1,6 @@
 'use strict';
 const gulp = require('gulp');
+const mocha = require('gulp-mocha');
 const electron = require('electron-connect').server.create({
 	verbose: true
 });
@@ -27,4 +28,9 @@ gulp.task('reload:renderer', done => {
 	done();
 });
 
-gulp.task('default', ['dev']);
+// Test app using mocha+spectron
+gulp.task('test', () => {
+	return gulp.src('tests/index.js').pipe(mocha());
+});
+
+gulp.task('default', ['dev', 'test']);

package.json

@@ -1,9 +1,16 @@
 {
-  "name": "Zulip-Desktop",
+  "name": "zulip",
   "productName": "Zulip",
-  "version": "0.3.1",
+  "version": "0.5.9",
+  "main": "./app/main",
   "description": "Zulip Desktop App",
-  "license": "MIT",
+  "license": "Apache-2.0",
+  "email": "<svnitakash@gmail.com>",
+  "copyright": "©2017 Kandra Labs, Inc.",
+  "author": {
+    "name": "Akash Nimare",
+    "email": "svnitakash@gmail.com"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/zulip/zulip-electron.git"
@@ -11,38 +18,84 @@
   "bugs": {
     "url": "https://github.com/zulip/zulip-electron/issues"
   },
-  "main": "app/main/index.js",
   "scripts": {
-    "test": "xo",
+    "start": "electron ./app/main",
-    "start": "electron .",
+    "postinstall": "install-app-deps",
+    "test": "gulp test && xo",
     "dev": "gulp dev",
-    "build:osx": "electron-packager . --out=dist --app-version=$npm_package_version --prune --asar --icon=app/resources/Icon.icns --overwrite --platform=darwin --arch=x64",
+    "pack": "build --dir",
-    "build": "electron-packager . --out=dist --app-version=$npm_package_version --prune --asar --overwrite --all"
+    "dist": "build",
+    "build:win": "build --win nsis-web --ia32 --x64",
+    "travis": "cd ./scripts && ./travis-build-test.sh"
+  },
+  "build": {
+    "appId": "org.zulip.zulip-electron",
+    "asar": true,
+    "files": [
+      "**/*",
+      "!node_modules/@paulcbetts/cld/deps/cld${/*}"
+    ],
+    "copyright": "©2017 Kandra Labs, Inc.",
+    "mac": {
+      "category": "public.app-category.productivity"
+    },
+    "linux": {
+      "category": "",
+      "packageCategory": "GNOME;GTK;Network;InstantMessaging",
+      "description": "Zulip Desktop Client for Linux",
+      "target": [
+        "deb",
+        "AppImage"
+      ],
+      "maintainer": "Akash Nimare <svnitakash@gmail.com>"
+    },
+    "deb": {
+      "synopsis": "Zulip Desktop App"
+    },
+    "dmg": {
+      "background": "build/appdmg.png",
+      "icon": "build/icon.icns",
+      "iconSize": 128,
+      "contents": [
+        {
+          "x": 380,
+          "y": 240,
+          "type": "link",
+          "path": "/Applications"
+        },
+        {
+          "x": 122,
+          "y": 240,
+          "type": "file"
+        }
+      ]
+    },
+    "win": {
+      "target": "nsis",
+      "icon": "build/icon.ico"
+      },
+    "nsis": {
+      "perMachine": true,
+      "oneClick": false
+    }
   },
   "keywords": [
     "Zulip",
     "Group Chat app",
     "electron-app",
-    "electron"
+    "electron",
+    "Desktop app",
+    "InstantMessaging"
   ],
-  "dependencies": {
-    "configstore": "^2.0.0",
-    "dialogs": "1.1.14",
-    "electron-context-menu": "0.4.0",
-    "electron-debug": "^1.0.0",
-    "electron-dl": "^0.2.0",
-    "electron-localshortcut": "^0.6.1",
-    "node-json-db": "^0.7.2",
-    "request": "^2.74.0",
-    "simple-spellchecker": "^0.9.0",
-    "wurl": "^2.1.0"
-  },
   "devDependencies": {
+    "assert": "^1.4.1",
     "devtron": "^1.1.0",
-    "electron": "1.3.3",
+    "electron-builder": "16.6.0",
+    "electron": "1.4.15",
     "electron-connect": "^0.4.6",
-    "electron-packager": "^7.0.0",
     "gulp": "^3.9.1",
+    "gulp-mocha": "^3.0.1",
+    "spectron": "^3.3.0",
     "xo": "*"
   },
   "xo": {
@@ -53,15 +106,23 @@
         "rules": {
           "max-lines": [
             "warn",
-            350
+            500
           ],
-          "no-warning-comments": 0
+          "no-warning-comments": 0,
+          "no-else-return": 0,
+          "import/no-unresolved": 0,
+          "import/no-extraneous-dependencies": 0
         }
       }
     ],
+    "ignore": [
+      "tests/*.js",
+      "app/main/macos-swipe-navigation.js"
+    ],
     "envs": [
       "node",
-      "browser"
+      "browser",
+      "mocha"
     ]
   }
 }

scripts/travis-build-test.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
+  export {no_proxy,NO_PROXY}="127.0.0.1,localhost"
+	export DISPLAY=:99.0
+  sh -e /etc/init.d/xvfb start
+  sleep 3
+fi
+
+npm run test

tests/index.js

@@ -0,0 +1,27 @@
+const assert = require('assert')
+const Application = require('spectron').Application
+
+describe('application launch', function () {
+  this.timeout(15000)
+
+  beforeEach(function () {
+    this.app = new Application({
+      path: require('electron'),
+      args: [__dirname + '/../app/renderer/index.html']
+    })
+    return this.app.start()
+  })
+
+  afterEach(function () {
+    if (this.app && this.app.isRunning()) {
+      return this.app.stop()
+    }
+  })
+
+  it('shows an initial window', function () {
+    return this.app.client.getWindowCount().then(function (count) {
+      assert.equal(count, 1)
+    })
+  })
+})
+

zulip-electron-launcher.sh

@@ -0,0 +1,109 @@
+#!/bin/bash
+
+# Zulip Beta Client Launcher
+
+# This script ensures that you have the latest version of the specified branch
+# (defaults to master if none specified) and then updates or installs all your
+# required npm modules.
+
+# I recommend symlinking this script into your PATH.
+
+# {{{ showUsage()
+
+showUsage()
+{
+	echo "Usage: $0 <branch_name>"
+	echo "Example: $0 dev"
+	exit 1
+}
+
+# }}}
+# {{{ envSetup()
+
+envSetup()
+{
+	defaultBranch="master"
+	startingDir=`pwd`
+	requirePop=0
+
+	# Check command line arguments
+	if [ "$#" -gt "1" ]
+	then
+		showUsage
+	elif [ "$#" -eq "1" ]
+	then
+		myBranch=$1
+	else
+		myBranch=$defaultBranch
+	fi
+
+	# Set workingDir
+	if [ -L $0 ]
+	then
+		realPath=`ls -l $0 | cut -d '>' -f 2`
+		workingDir=`dirname $realPath`
+	else
+		workingDir="."
+	fi
+
+	# Set name of upstreamRemote
+	cd $workingDir
+	git remote -v | grep "github\.com.zulip.zulip-electron.git (fetch)" > /dev/null 2>&1
+	if [ $? -eq 0 ]
+	then
+		upstreamRemote=`git remote -v | grep "github\.com.zulip.zulip-electron.git (fetch)" | awk '{ print $1 }'`
+	else
+		upstreamRemote="origin"
+	fi
+}
+
+# }}}
+# {{{ gitCheckout()
+
+gitCheckout()
+{
+	git fetch $upstreamRemote
+	git checkout $myBranch
+	git rebase $upstreamRemote/master
+	if [ $? -gt 0 ]
+	then
+		echo "Stashing uncommitted changes and doing a new git pull"
+		git stash && requirePop=1
+		git rebase $upstreamRemote/master
+	fi
+}
+
+# }}}
+# {{{ npmInstallStart()
+
+npmInstallStart()
+{
+	npm install
+	npm start &
+}
+
+# }}}
+# {{{ cleanUp()
+
+cleanUp()
+{
+	# Switch back to branch we started on
+	git checkout -
+
+	# Pop if we stashed
+	if [ $requirePop -eq 1 ]
+	then
+		echo "Popping out uncommitted changes"
+		git stash pop
+	fi
+
+	# Return the whatever dir we started in
+	cd $startingDir
+}
+
+# }}}
+
+envSetup $*
+gitCheckout
+npmInstallStart
+cleanUp