GitHub datasource

examples/swift_repos.json

@@ -0,0 +1,128 @@
+{
+	"version": 1,
+	"allow_edit": true,
+	"plugins": [],
+	"panes": [
+		{
+			"title": "libswiftnav",
+			"width": 1,
+			"row": {
+				"3": 1
+			},
+			"col": {
+				"3": 1
+			},
+			"col_width": 1,
+			"widgets": [
+				{
+					"type": "text_widget",
+					"settings": {
+						"title": "Pull Requests",
+						"size": "regular",
+						"value": "datasources[\"libswiftnav\"][\"num_pull_requests\"]",
+						"animate": true
+					}
+				},
+				{
+					"type": "text_widget",
+					"settings": {
+						"title": "Open Issues",
+						"size": "regular",
+						"value": "datasources[\"libswiftnav\"][\"num_open_issues\"]",
+						"animate": true
+					}
+				},
+				{
+					"type": "indicator",
+					"settings": {
+						"title": "Build Status (master)",
+						"value": "datasources[\"libswiftnav\"][\"build_status\"]",
+						"on_text": "passing"
+					}
+				},
+				{
+					"type": "text_widget",
+					"settings": {
+						"title": "Code Coverage",
+						"size": "regular",
+						"value": "datasources[\"libswiftnav\"][\"code_coverage\"]",
+						"animate": true,
+						"units": "%"
+					}
+				}
+			]
+		},
+		{
+			"title": "piksi_firmware",
+			"width": 1,
+			"row": {
+				"3": 1
+			},
+			"col": {
+				"3": 2
+			},
+			"col_width": 1,
+			"widgets": [
+				{
+					"type": "text_widget",
+					"settings": {
+						"title": "Pull Requests",
+						"size": "regular",
+						"value": "datasources[\"piksi_firmware\"][\"num_pull_requests\"]",
+						"animate": true
+					}
+				},
+				{
+					"type": "text_widget",
+					"settings": {
+						"title": "Open Issues",
+						"size": "regular",
+						"value": "datasources[\"piksi_firmware\"][\"num_open_issues\"]",
+						"animate": true
+					}
+				},
+				{
+					"type": "indicator",
+					"settings": {
+						"title": "Build Status (master)",
+						"value": "datasources[\"piksi_firmware\"][\"build_status\"]",
+						"on_text": "passing"
+					}
+				}
+			]
+		}
+	],
+	"datasources": [
+		{
+			"name": "libswiftnav",
+			"type": "GitHub",
+			"settings": {
+				"user": "swift-nav",
+				"repo": "libswiftnav",
+				"auth": false,
+				"client_id": "",
+				"client_secret": "",
+				"use_travis": true,
+				"use_coveralls": true,
+				"branch": "master",
+				"refresh": 120
+			}
+		},
+		{
+			"name": "piksi_firmware",
+			"type": "GitHub",
+			"settings": {
+				"user": "swift-nav",
+				"repo": "piksi_firmware",
+				"auth": false,
+				"client_id": "",
+				"client_secret": "",
+				"use_travis": true,
+				"use_coveralls": false,
+				"branch": "master",
+				"refresh": 120
+			}
+		}
+	],
+	"columns": 3
+}

index-dev.html

@@ -36,6 +36,7 @@
                 "lib/js/freeboard/freeboard.js",
 
                 "plugins/freeboard/freeboard.datasources.js",
+                "plugins/freeboard/github.datasources.js",
                 "plugins/freeboard/freeboard.widgets.js",
                 "examples/plugin_example.js",
 

js/freeboard.plugins.js

@@ -1700,3 +1700,140 @@ freeboard.loadDatasourcePlugin({
     });
 
 }());
+
+// ┌────────────────────────────────────────────────────────────────────┐ \\
+// │ GitHub Data Source Plugin                                          │ \\
+// ├────────────────────────────────────────────────────────────────────┤ \\
+// │ Copyright © 2015 Fergus Noble                                      │ \\
+// ├────────────────────────────────────────────────────────────────────┤ \\
+// │ Licensed under the MIT license.                                    │ \\
+// └────────────────────────────────────────────────────────────────────┘ \\
+
+(function () {
+	var jsonDatasource = function (settings, updateCallback) {
+		var self = this;
+		var updateTimer = null;
+		var currentSettings = settings;
+
+		function updateRefresh(refreshTime) {
+			if (updateTimer) {
+				clearInterval(updateTimer);
+			}
+
+			updateTimer = setInterval(function () {
+				self.updateNow();
+			}, refreshTime);
+		}
+
+		updateRefresh(currentSettings.refresh * 1000);
+
+		this.updateNow = function () {
+			var auth = currentSettings.auth ?
+				"?client_id=" + currentSettings.client_id +
+				"&client_secret=" + currentSettings.client_secret : "";
+			var path = currentSettings.user + "/" + currentSettings.repo;
+
+			$.when(
+				$.get("https://api.github.com/repos/" + path + auth),
+				$.get("https://api.github.com/repos/" + path + "/pulls" + auth),
+				currentSettings.use_travis ? $.get("https://api.travis-ci.org/repos/" + path + "/branches/" + currentSettings.branch) : null,
+				currentSettings.use_coveralls ? $.get("http://cors.io/?u=https://coveralls.io/github/" + path + ".json?branch=" + currentSettings.branch) : null
+			).then(function(github, github_pr, travis, coveralls) {
+
+				var data = {};
+				data["num_pull_requests"] = github_pr[0].length;
+				data["pull_requests"] = github_pr[0];
+				data["num_open_issues"] = github[0]['open_issues_count'];
+				data["github_repo"] = github[0];
+				if (travis) {
+					data["build_status"] = travis[0]['branch']['state'];
+					data["travis"] = travis[0];
+				}
+				if (coveralls) {
+					data["coveralls"] = JSON.parse(coveralls[0]);
+					var cc = data["coveralls"]["covered_percent"];
+					data["code_coverage"] = Number(Math.round(cc+'e2')+'e-2');
+				}
+				updateCallback(data);
+
+			});
+		}
+
+		this.onDispose = function () {
+			clearInterval(updateTimer);
+			updateTimer = null;
+		}
+
+		this.onSettingsChanged = function (newSettings) {
+			currentSettings = newSettings;
+			updateRefresh(currentSettings.refresh * 1000);
+			self.updateNow();
+		}
+	};
+
+	freeboard.loadDatasourcePlugin({
+		type_name: "GitHub",
+		settings: [
+			{
+				name: "user",
+				display_name: "GitHub user / organization",
+				type: "text"
+			},
+			{
+				name: "repo",
+				display_name: "GitHub repo",
+				type: "text"
+			},
+			{
+				name: "auth",
+				display_name: "Use Authentication",
+				type: "boolean",
+				default_value: false
+			},
+			{
+				name: "client_id",
+				display_name: "Client ID",
+				description: 'GitHub Application Client ID',
+				type: "text"
+			},
+			{
+				name: "client_secret",
+				display_name: "Client Secret",
+				description: 'GitHub Application Client Secret',
+				type: "text"
+			},
+			{
+				name: "use_travis",
+				display_name: "Use Travis",
+				description: 'Pull CI status from TravisCI',
+				type: "boolean",
+				default_value: true
+			},
+			{
+				name: "use_coveralls",
+				display_name: "Use Coveralls",
+				description: 'Pull code coverage from Coveralls',
+				type: "boolean",
+				default_value: true
+			},
+			{
+				name: "branch",
+				display_name: "Branch",
+				description: 'Branch for build and coverage status',
+				type: "text",
+				default_value: "master"
+			},
+			{
+				name: "refresh",
+				display_name: "Refresh Every",
+				type: "number",
+				suffix: "seconds",
+				default_value: 120
+			},
+		],
+		newInstance: function (settings, newInstanceCallback, updateCallback) {
+			newInstanceCallback(new jsonDatasource(settings, updateCallback));
+		}
+	});
+
+}());