initial version

Author: markfodor

.eslintrc.json

@@ -0,0 +1,16 @@
+{
+	"rules": {
+		"indent": ["error", "tab"],
+		"quotes": ["error", "double"],
+		"max-len": ["error", 250],
+		"curly": "error",
+		"camelcase": ["error", {"properties": "never"}],
+		"no-trailing-spaces": ["error"],
+		"no-irregular-whitespace": ["error"]
+	},
+	"env": {
+		"browser": true,
+		"node": true,
+		"es6": true
+	}
+}

.github/custom_text.png

@@ -0,0 +1,3 @@
+node_modules
+uploads
+npm-debug.log

.github/duration.png

@@ -0,0 +1,5 @@
+{
+	"extends": "stylelint-config-standard",
+	"font-family-name-quotes": "double-where-recommended",
+	"block-no-empty": false
+}

.gitignore

@@ -0,0 +1,3 @@
+## [1.0.0] - 2017-12-31
+
+- Prints estimated travel time in minutes from origin to destination

.stylelintrc

@@ -0,0 +1,69 @@
+module.exports = function(grunt) {
+	require("time-grunt")(grunt);
+	grunt.initConfig({
+		pkg: grunt.file.readJSON("package.json"),
+		eslint: {
+			options: {
+				configFile: ".eslintrc.json",
+				fix: true
+			},
+			target: ["*.js"]
+		},
+		stylelint: {
+			simple: {
+				options: {
+					configFile: ".stylelintrc",
+					fix: true
+				},
+				src: ["*.css"]
+			}
+		},
+		jsonlint: {
+			main: {
+				src: ["package.json", "translations/*.json"],
+				options: {
+					reporter: "jshint"
+				}
+			}
+		},
+		markdownlint: {
+			all: {
+				options: {
+					config: {
+						"default": true,
+						"line-length": false,
+						"blanks-around-headers": false,
+						"no-duplicate-header": false,
+						"no-inline-html": false,
+						"MD010": false,
+						"MD001": false,
+						"MD031": false,
+						"MD040": false,
+						"MD002": false,
+						"MD029": false,
+						"MD041": false,
+						"MD032": false,
+						"MD036": false,
+						"MD037": false,
+						"MD009": false,
+						"MD018": false,
+						"MD012": false,
+						"MD026": false,
+						"MD038": false
+					}
+				},
+				src: ["README.md", "CHANGELOG.md", "LICENSE.txt"]
+			}
+		},
+		yamllint: {
+			all: [".travis.yml"]
+		}
+	});
+	grunt.loadNpmTasks("grunt-eslint");
+	//FIXME
+	//grunt.loadNpmTasks("grunt-stylelint");
+	grunt.loadNpmTasks("grunt-jsonlint");
+	grunt.loadNpmTasks("grunt-yamllint");
+	grunt.loadNpmTasks("grunt-markdownlint");
+	grunt.registerTask("default", ["eslint", "jsonlint", "markdownlint", "yamllint"]);
+};

CHANGELOG.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mark Fodor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Gruntfile.js

@@ -0,0 +1,129 @@
+/* global Module */
+
+/* Magic Mirror
+ * Module: MMM-trafficmate
+ *
+ * By Mark Fodor https://github.com/markfodor
+ * MIT Licensed.
+ */
+Module.register("MMM-trafficmate", {
+	defaults: {
+		defaultText: config.defaultText || 'Route duration: ',
+        travelMode: config.travelMode || 'DRIVING',
+        origin: config.origin,
+        destination: config.destination,
+        apiKey: config.apiKey,
+        updateInterval: 6000,
+        retryDelay: 5000
+    },
+
+	start: function () {
+		var self = this;
+		this.reponse = null;
+
+		//Flag for check if module is loaded
+		this.loaded = false;
+
+		//TODO apiKey check
+		var googleScript = document.createElement("script");
+		googleScript.src = "https://maps.googleapis.com/maps/api/js?key=" + self.config.apiKey;
+		document.getElementsByTagName("body")[0].appendChild(googleScript);
+
+		// Schedule update timer.
+		setInterval(function () {
+			self.getData();
+			self.updateDom();
+		}, this.config.updateInterval);
+	},
+
+	getData: function () {
+		var self = this;
+
+		if (google) {
+			var directionsService = new google.maps.DirectionsService;
+			directionsService.route({
+				destination: self.config.destination,
+				origin: self.config.origin,
+				travelMode: self.config.travelMode
+			}, function (response, status) {
+				if (status === "OK") {
+					self.response = response;
+				} else {
+					Log.error("Directions request failed due to " + status);
+				}
+			});
+		} else {
+			Log.error("Cloud not load google service.");
+		}
+	},
+
+	/* scheduleUpdate()
+     * Schedule next update.
+     *
+     * argument delay number - Milliseconds before next update.
+     *  If empty, this.config.updateInterval is used.
+     */
+	scheduleUpdate: function (delay) {
+		var nextLoad = this.config.updateInterval;
+		if (typeof delay !== "undefined" && delay >= 0) {
+			nextLoad = delay;
+		}
+		nextLoad = nextLoad;
+		var self = this;
+		setTimeout(function () {
+			self.getData();
+		}, nextLoad);
+	},
+
+	getDom: function () {
+		var duration = this.response ? this.response.routes[0].legs[0].duration.text : "Loading...";
+
+		// create element wrapper for show into the module
+		var wrapper = document.createElement("div");
+		wrapper.innerHTML = this.config.defaultText + duration;
+
+		// Data from helper
+		if (this.dataNotification) {
+			var wrapperDataNotification = document.createElement("div");
+			// translations  + datanotification
+			wrapperDataNotification.innerHTML = this.translate("UPDATE") + ": " + this.dataNotification.date;
+
+			wrapper.appendChild(wrapperDataNotification);
+		}
+		return wrapper;
+	},
+
+	getScripts: function () {
+		return [];
+	},
+
+	// Load translations files
+	getTranslations: function () {
+		//FIXME: This can be load a one file javascript definition
+		return {
+			en: "translations/en.json",
+			es: "translations/es.json"
+		};
+	},
+
+	processData: function (data) {
+		var self = this;
+		if (this.loaded === false) {
+			self.updateDom(self.config.animationSpeed);
+		}
+		this.loaded = true;
+
+		// the data if load
+		// send notification to helper
+		this.sendSocketNotification("MMM-trafficmate-NOTIFICATION", data);
+	},
+
+	// socketNotificationReceived from helper
+	socketNotificationReceived: function (notification, payload) {
+		if (notification === "MMM-trafficmate-NOTIFICATION") {
+			// set dataNotification
+			this.dataNotification = payload;
+			this.updateDom();
+		}
+	},
+});

LICENSE

@@ -0,0 +1,60 @@
+# MMM-trafficmate
+This is a traffic module for the [MagicMirror](https://github.com/MichMich/MagicMirror). 
+It is able to print estimated travel time in minutes from origin to destination.
+
+![Route duration](.github/duration.png)
+
+## Used technolgies/tools
+* [Magic Mirror Module Template](https://github.com/roramirez/MagicMirror-Module-Template)
+* [Google Directions API](https://developers.google.com/maps/documentation/javascript/directions)
+
+## Installation
+Clone this repository in your `modules` folder, and install dependencies:
+```bash
+cd ~/MagicMirror/modules # adapt directory if you are using a different one
+git clone https://github.com/markfodor/MMM-trafficmate.git
+cd MMM-trafficmate
+npm install
+```
+
+Add the module to your `config/config.js` file.
+```js
+{
+    module: 'MMM-trafficmate',
+    position: 'top_right',
+    config: {
+        apiKey: '<YOUR_API_KEY>',
+        origin: '<ROUTE_ORIGIN>',
+        destination: '<ROUTE_DESTINATION>'
+    }
+},
+```
+**The _apiKey_, _origin_ and _destination_ fields are mandatory**.
+
+Optional config properties
+
+| Name | Options | Default value |
+| --- | --- | --- |
+| defaultText | - | "Route duration: " |
+| travleMode | "DRIVING" / "WALKING" / "BICYCLING" / "TRANSIT" | "DRIVING" |
+
+## Running tests
+Run the `test` npm script
+```
+npm test
+```
+
+Current Tests:
+- [ESLint](http://eslint.org/) for linting the javascript
+- [stylelint](https://stylelint.io/) for linting the CSS with [stylelint-config-standard](https://github.com/stylelint/stylelint-config-standard) as its base
+- [jsonlint](https://github.com/zaach/jsonlint) for linting the translation files
+- [markdownlint](https://github.com/DavidAnson/markdownlint) for checking the markdown files (`README.md`, `CHANGELOG.md`, `LICENSE.txt`)
+- [js-yaml](https://github.com/nodeca/js-yaml) to lint the `.travis.yml` (run through [grunt-yamllint](https://github.com/geedew/grunt-yamllint))
+
+If it is possible it will also automatically fix some issues.
+
+## Contribution
+If you have any suggest, please let me know [by an issue](https://github.com/markfodor/MMM-trafficmate/issues/new).
+
+## License
+[The MIT License (MIT)](LICENSE)

MMM-trafficmate.css

@@ -0,0 +1,47 @@
+/* Magic Mirror
+ * Node Helper: MMM-trafficmate
+ *
+ * By Mark Fodor https://github.com/markfodor
+ * MIT Licensed.
+ */
+
+var NodeHelper = require("node_helper");
+
+module.exports = NodeHelper.create({
+
+	// Override socketNotificationReceived method.
+
+	/* socketNotificationReceived(notification, payload)
+	 * This method is called when a socket notification arrives.
+	 *
+	 * argument notification string - The identifier of the noitication.
+	 * argument payload mixed - The payload of the notification.
+	 */
+	socketNotificationReceived: function(notification, payload) {
+		if (notification === "MMM-trafficmate-NOTIFICATION") {
+			console.log("Working notification system. Notification:", notification, "payload: ", payload);
+			// Send notification
+			this.sendNotificationTest(this.anotherFunction()); //Is possible send objects :)
+		}
+	},
+
+	// Example function send notification test
+	sendNotificationTest: function(payload) {
+		this.sendSocketNotification("MMM-trafficmate-NOTIFICATION", payload);
+	},
+
+	// this you can create extra routes for your module
+	extraRoutes: function() {
+		var self = this;
+		this.expressApp.get("/MMM-trafficmate/extra_route", function(req, res) {
+			// call another function
+			values = self.anotherFunction();
+			res.send(values);
+		});
+	},
+
+	// Test another function
+	anotherFunction: function() {
+		return {date: new Date()};
+	}
+});