github-activity-feed
Version:
A widget for displaying GitHub activity for a user.
397 lines (350 loc) • 20.8 kB
JavaScript
/*!
* GitHub Activity Stream - v0.1.4 - 10/7/2015
* https://github.com/caseyscarborough/github-activity
*
* Copyright (c) 2015 Casey Scarborough
* MIT License
* http://opensource.org/licenses/MIT
*/
var GitHubActivity = (function() {
'use strict';
var obj = {};
var config = {};
var methods = {
renderLink: function(url, title, cssClass) {
if (!title) { title = url; }
if (typeof(cssClass) === 'undefined') cssClass = "";
return Mustache.render('<a class="' + cssClass + '" href="{{url}}" target="_blank">{{{title}}}</a>', { url: url, title: title });
},
renderGitHubLink: function(url, title, cssClass) {
if (!title) { title = url; }
if (typeof(cssClass) === 'undefined') cssClass = "";
return methods.renderLink('https://github.com/' + url, title, cssClass);
},
getMessageFor: function(data) {
var p = data.payload;
data.repoLink = methods.renderGitHubLink(data.repo.name);
data.userGravatar = Mustache.render('<div class="gha-gravatar-user"><img src="{{url}}" class="gha-gravatar-small"></div>', { url: data.actor.avatar_url });
// Get the branch name if it exists.
if (p.ref) {
if (p.ref.substring(0, 11) === 'refs/heads/') {
data.branch = p.ref.substring(11);
} else {
data.branch = p.ref;
}
data.branchLink = methods.renderGitHubLink(data.repo.name + '/tree/' + data.branch, data.branch) + ' at ';
}
// Only show the first 6 characters of the SHA of each commit if given.
if (p.commits) {
var shaDiff = p.before + '...' + p.head;
var length = p.commits.length;
if (length === 2) {
// If there are 2 commits, show message 'View comparison for these 2 commits >>'
data.commitsMessage = Mustache.render('<a href="https://github.com/{{repo}}/compare/{{shaDiff}}">View comparison for these 2 commits »</a>', { repo: data.repo.name, shaDiff: shaDiff });
} else if (length > 2) {
// If there are more than two, show message '(numberOfCommits - 2) more commits >>'
data.commitsMessage = Mustache.render('<a href="https://github.com/{{repo}}/compare/{{shaDiff}}">{{length}} more ' + pluralize('commit', length - 2) + ' »</a>', { repo: data.repo.name, shaDiff: shaDiff, length: p.size - 2 });
}
p.commits.forEach(function(d, i) {
if (d.message.length > 66) {
d.message = d.message.substring(0, 66) + '...';
}
if (i < 2) {
d.shaLink = methods.renderGitHubLink(data.repo.name + '/commit/' + d.sha, d.sha.substring(0, 6), 'gha-sha');
d.committerGravatar = Mustache.render('<img class="gha-gravatar-commit" src="https://gravatar.com/avatar/{{hash}}" width="16" />', { hash: md5(d.author.email.trim().toLowerCase()) });
} else {
// Delete the rest of the commits after the first 2, and then break out of the each loop.
p.commits.splice(2, p.size);
return false;
}
});
}
// Get the link if this is an IssueEvent.
if (p.issue) {
var title = data.repo.name + "#" + p.issue.number;
data.issueLink = methods.renderLink(p.issue.html_url, title);
data.issueType = "issue";
if (p.issue.pull_request) {
data.issueType = "pull request";
}
}
// Retrieve the pull request link if this is a PullRequestEvent.
if (p.pull_request) {
var pr = p.pull_request;
data.pullRequestLink = methods.renderLink(pr.html_url, data.repo.name + "#" + pr.number);
data.mergeMessage = "";
// If this was a merge, set the merge message.
if (p.pull_request.merged) {
data.eventType = "merged";
var message = '{{c}} ' + pluralize('commit', pr.commits) + ' with {{a}} ' + pluralize('addition', pr.additions) + ' and {{d}} ' + pluralize('deletion', pr.deletions);
data.mergeMessage = Mustache.render('<br><small class="gha-message-merge">' + message + '</small>', { c: pr.commits, a: pr.additions, d: pr.deletions });
} else {
data.eventType = "closed";
}
if (data.type === 'PullRequestReviewEvent') {
if (p.review.state === "commented") {
data.eventType = "commented on";
} else if (p.review.state === "changes_requested") {
data.eventType = "requested changes on";
} else if (p.review.state === "approved") {
data.pullRequestEventType = "approved";
}
}
}
// Get the link if this is a PullRequestReviewCommentEvent
if (p.comment && p.comment.pull_request_url) {
var title = data.repo.name + "#" + p.comment.pull_request_url.split('/').pop();
data.pullRequestLink = methods.renderLink(p.comment.html_url, title);
}
// Get the comment if one exists, and trim it to 150 characters.
if (p.comment && p.comment.body) {
data.comment = p.comment.body;
if (data.comment.length > 150) {
data.comment = data.comment.substring(0, 150) + '...';
}
if (p.comment.html_url && p.comment.commit_id) {
var title = data.repo.name + '@' + p.comment.commit_id.substring(0, 10);
data.commentLink = methods.renderLink(p.comment.html_url, title);
}
}
if (data.type === 'ReleaseEvent') {
data.tagLink = methods.renderLink(p.release.html_url, p.release.tag_name);
data.zipLink = methods.renderLink(p.release.zipball_url, 'Download Source Code (zip)');
}
// Wiki event
if (data.type === 'GollumEvent') {
var page = p.pages[0];
data.actionType = page.action;
data.message = data.actionType.charAt(0).toUpperCase() + data.actionType.slice(1) + ' ';
data.message += methods.renderGitHubLink(page.html_url, page.title);
}
if (data.type === 'FollowEvent') data.targetLink = methods.renderGitHubLink(p.target.login);
if (data.type === 'ForkEvent') data.forkLink = methods.renderGitHubLink(p.forkee.full_name);
if (data.type === 'MemberEvent') data.memberLink = methods.renderGitHubLink(p.member.login);
if (p.gist) {
data.actionType = p.action === 'fork' ? p.action + 'ed' : p.action + 'd';
data.gistLink = methods.renderLink(p.gist.html_url, 'gist: ' + p.gist.id);
}
var message = Mustache.render(templates[data.type], data);
var timeString = millisecondsToStr(new Date() - new Date(data.created_at));
var icon;
if (data.type == 'CreateEvent' && (['repository', 'branch', 'tag'].indexOf(p.ref_type) >= 0)) {
// Display separate icons depending on type of create event.
icon = icons[data.type + '_' + p.ref_type];
} else if (data.type === 'PullRequestReviewEvent') {
icon = icons[data.type + '_' + p.review.state];
} else {
icon = icons[data.type]
}
var activity = { message: message, icon: icon, timeString: timeString, userLink: methods.renderGitHubLink(data.actor.login) };
if (singleLineActivities.indexOf(data.type) > -1) {
return Mustache.render(templates.SingleLineActivity, activity);
}
return Mustache.render(templates.Activity, activity);
},
getHeaderHTML: function(data) {
if (data.name) {
data.userNameLink = methods.renderLink(data.html_url, data.name);
} else {
data.withoutName = ' without-name';
}
data.userLink = methods.renderLink(data.html_url, data.login);
data.gravatarLink = methods.renderLink(data.html_url, '<img src="' + data.avatar_url + '">');
return Mustache.render(templates.UserHeader, data);
},
getActivityHTML: function(data, limit) {
var text = '';
var dataLength = data.length;
if (limit && limit > dataLength) {
limit = dataLength;
}
limit = limit ? limit : dataLength;
if (limit === 0) {
return Mustache.render(templates.NoActivity, {});
}
for (var i = 0; i < limit; i++) {
text += methods.getMessageFor(data[i]);
}
return text;
},
getOutputFromRequest: function(url, callback) {
var request = new XMLHttpRequest();
request.open('GET', url);
request.setRequestHeader('Accept', 'application/vnd.github.v3+json');
if (config.credentials && config.credentials.username && config.credentials.personalAccessToken) {
request.setRequestHeader('Authorization', 'Basic ' + btoa(config.credentials.username + ':' + config.credentials.personalAccessToken));
}
request.onreadystatechange = function() {
if (request.readyState === 4) {
if (request.status >= 200 && request.status < 300){
var data = JSON.parse(request.responseText);
callback(undefined, data);
} else {
callback('request for ' + url + ' yielded status ' + request.status);
}
}
};
request.onerror = function() { callback('An error occurred connecting to ' + url); };
request.send();
},
renderStream: function(output, div) {
div.innerHTML = Mustache.render(templates.Stream, { text: output, footer: templates.Footer });
div.style.position = 'relative';
},
writeOutput: function(selector, content) {
var div = selector.charAt(0) === '#' ? document.getElementById(selector.substring(1)) : document.getElementsByClassName(selector.substring(1));
if (div instanceof HTMLCollection) {
for (var i = 0; i < div.length; i++) {
methods.renderStream(content, div[i]);
}
} else {
methods.renderStream(content, div);
}
},
renderIfReady: function(selector, header, activity) {
if (header && activity) {
methods.writeOutput(selector, header + activity);
}
}
};
obj.feed = function(options) {
config = options;
if (!options.username || !options.selector) {
throw "You must specify the username and selector options for the activity stream.";
return false;
}
var selector = options.selector,
userUrl = 'https://api.github.com/users/' + options.username,
eventsUrl = userUrl + '/events',
header,
activity;
if (!!options.repository){
eventsUrl = 'https://api.github.com/repos/' + options.username + '/' + options.repository + '/events';
}
if (!!options.eventsUrl){
eventsUrl = options.eventsUrl;
}
// Allow templates override
if (typeof options.templates == 'object') {
for (var template in templates) {
if (typeof options.templates[template] == 'string') {
templates[template] = options.templates[template];
}
}
}
methods.getOutputFromRequest(userUrl, function(error, output) {
if (error) {
header = Mustache.render(templates.UserNotFound, { username: options.username });
} else {
header = methods.getHeaderHTML(output)
}
methods.renderIfReady(selector, header, activity)
});
methods.getOutputFromRequest(eventsUrl, function(error, output) {
if (error) {
activity = Mustache.render(templates.EventsNotFound, { username: options.username });
} else {
var limit = options.limit != 'undefined' ? parseInt(options.limit, 10) : null;
activity = methods.getActivityHTML(output, limit);
}
methods.renderIfReady(selector, header, activity);
});
};
return obj;
}());
// Takes in milliseconds and converts it to a human readable time,
// such as 'about 3 hours ago' or '23 days ago'
function millisecondsToStr(milliseconds) {
'use strict';
function numberEnding(number) {
return (number > 1) ? 's ago' : ' ago';
}
var temp = Math.floor(milliseconds / 1000);
var years = Math.floor(temp / 31536000);
if (years) return years + ' year' + numberEnding(years);
var months = Math.floor((temp %= 31536000) / 2592000);
if (months) return months + ' month' + numberEnding(months);
var days = Math.floor((temp %= 2592000) / 86400);
if (days) return days + ' day' + numberEnding(days);
var hours = Math.floor((temp %= 86400) / 3600);
if (hours) return 'about ' + hours + ' hour' + numberEnding(hours);
var minutes = Math.floor((temp %= 3600) / 60);
if (minutes) return minutes + ' minute' + numberEnding(minutes);
var seconds = temp % 60;
if (seconds) return seconds + ' second' + numberEnding(seconds);
return 'just now';
}
// Pluralizes a word, but only works when the word requires
// an 's' to be added for pluralization.
function pluralize(word, number) {
// Yeah I know, this sucks.
if (number !== 1) return word + 's';
return word;
}
/** MD5 methods written by Joseph Myers. http://www.myersdaily.org/joseph/javascript/md5-text.html */
function md5cycle(f,h){var g=f[0],e=f[1],j=f[2],i=f[3];g=ff(g,e,j,i,h[0],7,-680876936);i=ff(i,g,e,j,h[1],12,-389564586);j=ff(j,i,g,e,h[2],17,606105819);e=ff(e,j,i,g,h[3],22,-1044525330);g=ff(g,e,j,i,h[4],7,-176418897);i=ff(i,g,e,j,h[5],12,1200080426);j=ff(j,i,g,e,h[6],17,-1473231341);e=ff(e,j,i,g,h[7],22,-45705983);g=ff(g,e,j,i,h[8],7,1770035416);i=ff(i,g,e,j,h[9],12,-1958414417);j=ff(j,i,g,e,h[10],17,-42063);e=ff(e,j,i,g,h[11],22,-1990404162);g=ff(g,e,j,i,h[12],7,1804603682);i=ff(i,g,e,j,h[13],12,-40341101);j=ff(j,i,g,e,h[14],17,-1502002290);e=ff(e,j,i,g,h[15],22,1236535329);g=gg(g,e,j,i,h[1],5,-165796510);i=gg(i,g,e,j,h[6],9,-1069501632);j=gg(j,i,g,e,h[11],14,643717713);e=gg(e,j,i,g,h[0],20,-373897302);g=gg(g,e,j,i,h[5],5,-701558691);i=gg(i,g,e,j,h[10],9,38016083);j=gg(j,i,g,e,h[15],14,-660478335);e=gg(e,j,i,g,h[4],20,-405537848);g=gg(g,e,j,i,h[9],5,568446438);i=gg(i,g,e,j,h[14],9,-1019803690);j=gg(j,i,g,e,h[3],14,-187363961);e=gg(e,j,i,g,h[8],20,1163531501);g=gg(g,e,j,i,h[13],5,-1444681467);i=gg(i,g,e,j,h[2],9,-51403784);j=gg(j,i,g,e,h[7],14,1735328473);e=gg(e,j,i,g,h[12],20,-1926607734);g=hh(g,e,j,i,h[5],4,-378558);i=hh(i,g,e,j,h[8],11,-2022574463);j=hh(j,i,g,e,h[11],16,1839030562);e=hh(e,j,i,g,h[14],23,-35309556);g=hh(g,e,j,i,h[1],4,-1530992060);i=hh(i,g,e,j,h[4],11,1272893353);j=hh(j,i,g,e,h[7],16,-155497632);e=hh(e,j,i,g,h[10],23,-1094730640);g=hh(g,e,j,i,h[13],4,681279174);i=hh(i,g,e,j,h[0],11,-358537222);j=hh(j,i,g,e,h[3],16,-722521979);e=hh(e,j,i,g,h[6],23,76029189);g=hh(g,e,j,i,h[9],4,-640364487);i=hh(i,g,e,j,h[12],11,-421815835);j=hh(j,i,g,e,h[15],16,530742520);e=hh(e,j,i,g,h[2],23,-995338651);g=ii(g,e,j,i,h[0],6,-198630844);i=ii(i,g,e,j,h[7],10,1126891415);j=ii(j,i,g,e,h[14],15,-1416354905);e=ii(e,j,i,g,h[5],21,-57434055);g=ii(g,e,j,i,h[12],6,1700485571);i=ii(i,g,e,j,h[3],10,-1894986606);j=ii(j,i,g,e,h[10],15,-1051523);e=ii(e,j,i,g,h[1],21,-2054922799);g=ii(g,e,j,i,h[8],6,1873313359);i=ii(i,g,e,j,h[15],10,-30611744);j=ii(j,i,g,e,h[6],15,-1560198380);e=ii(e,j,i,g,h[13],21,1309151649);g=ii(g,e,j,i,h[4],6,-145523070);i=ii(i,g,e,j,h[11],10,-1120210379);j=ii(j,i,g,e,h[2],15,718787259);e=ii(e,j,i,g,h[9],21,-343485551);f[0]=add32(g,f[0]);f[1]=add32(e,f[1]);f[2]=add32(j,f[2]);f[3]=add32(i,f[3])}function cmn(h,e,d,c,g,f){e=add32(add32(e,h),add32(c,f));return add32((e<<g)|(e>>>(32-g)),d)}function ff(g,f,k,j,e,i,h){return cmn((f&k)|((~f)&j),g,f,e,i,h)}function gg(g,f,k,j,e,i,h){return cmn((f&j)|(k&(~j)),g,f,e,i,h)}function hh(g,f,k,j,e,i,h){return cmn(f^k^j,g,f,e,i,h)}function ii(g,f,k,j,e,i,h){return cmn(k^(f|(~j)),g,f,e,i,h)}function md51(c){txt="";var e=c.length,d=[1732584193,-271733879,-1732584194,271733878],b;for(b=64;b<=c.length;b+=64){md5cycle(d,md5blk(c.substring(b-64,b)))}c=c.substring(b-64);var a=[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0];for(b=0;b<c.length;b++){a[b>>2]|=c.charCodeAt(b)<<((b%4)<<3)}a[b>>2]|=128<<((b%4)<<3);if(b>55){md5cycle(d,a);for(b=0;b<16;b++){a[b]=0}}a[14]=e*8;md5cycle(d,a);return d}function md5blk(b){var c=[],a;for(a=0;a<64;a+=4){c[a>>2]=b.charCodeAt(a)+(b.charCodeAt(a+1)<<8)+(b.charCodeAt(a+2)<<16)+(b.charCodeAt(a+3)<<24)}return c}var hex_chr="0123456789abcdef".split("");function rhex(c){var b="",a=0;for(;a<4;a++){b+=hex_chr[(c>>(a*8+4))&15]+hex_chr[(c>>(a*8))&15]}return b}function hex(a){for(var b=0;b<a.length;b++){a[b]=rhex(a[b])}return a.join("")}function md5(a){return hex(md51(a))}function add32(d,c){return(d+c)&4294967295}if(md5("hello")!="5d41402abc4b2a76b9719d911017c592"){function add32(a,d){var c=(a&65535)+(d&65535),b=(a>>16)+(d>>16)+(c>>16);return(b<<16)|(c&65535)}};
var templates = {
Stream: '<div class="gha-feed">{{{text}}}<div class="gha-push-small"></div>{{{footer}}}</div>',
Activity: '<div id="{{id}}" class="gha-activity">\
<div class="gha-activity-icon"><span class="octicon mega-octicon octicon-{{icon}}"></span></div>\
<div class="gha-message"><div class="gha-time">{{{timeString}}}</div>{{{userLink}}} {{{message}}}</div>\
<div class="gha-clear"></div>\
</div>',
SingleLineActivity: '<div class="gha-activity gha-small">\
<div class="gha-activity-icon"><span class="octicon octicon-{{icon}}"></span></div>\
<div class="gha-message"><div class="gha-time">{{{timeString}}}</div>{{{userLink}}} {{{message}}}</div>\
<div class="gha-clear"></div>\
</div>',
UserHeader: '<div class="gha-header">\
<div class="gha-github-icon"><span class="octicon octicon-mark-github"></span></div>\
<div class="gha-user-info{{withoutName}}">{{{userNameLink}}}<p>{{{userLink}}}</p></div>\
<div class="gha-gravatar">{{{gravatarLink}}}</div>\
</div><div class="gha-push"></div>',
Footer: '<div class="gha-footer">Public Activity <a href="https://github.com/caseyscarborough/github-activity" target="_blank">GitHub Activity Stream</a>',
NoActivity: '<div class="gha-info">This user does not have any recent public activity.</div>',
UserNotFound: '<div class="gha-info">User {{username}} wasn\'t found.</div>',
EventsNotFound: '<div class="gha-info">Events for user {{username}} not found.</div>',
CommitCommentEvent: 'commented on commit {{{commentLink}}}<br>{{{userGravatar}}}<small>{{comment}}</small>',
CreateEvent: 'created {{payload.ref_type}} {{{branchLink}}}{{{repoLink}}}',
DeleteEvent: 'deleted {{payload.ref_type}} {{payload.ref}} at {{{repoLink}}}',
FollowEvent: 'started following {{{targetLink}}}',
ForkEvent: 'forked {{{repoLink}}} to {{{forkLink}}}',
GistEvent: '{{actionType}} {{{gistLink}}}',
GollumEvent: '{{actionType}} the {{{repoLink}}} wiki<br>{{{userGravatar}}}<small>{{{message}}}</small>',
IssueCommentEvent: 'commented on {{issueType}} {{{issueLink}}}<br>{{{userGravatar}}}<small>{{comment}}</small>',
IssuesEvent: '{{payload.action}} issue {{{issueLink}}}<br>{{{userGravatar}}}<small>{{payload.issue.title}}</small>',
MemberEvent: 'added {{{memberLink}}} to {{{repoLink}}}',
PublicEvent: 'open sourced {{{repoLink}}}',
PullRequestEvent: '{{eventType}} pull request {{{pullRequestLink}}}<br>{{{userGravatar}}}<small>{{payload.pull_request.title}}</small>{{{mergeMessage}}}',
PullRequestReviewEvent: '{{eventType}} pull request {{{pullRequestLink}}}.<br>{{{userGravatar}}}<small>{{payload.review.body}}</small>',
PullRequestReviewCommentEvent: 'commented on pull request {{{pullRequestLink}}}<br>{{{userGravatar}}}<small>{{comment}}</small>',
PushEvent: 'pushed to {{{branchLink}}}{{{repoLink}}}<br>\
<ul class="gha-commits">{{#payload.commits}}<li><small>{{{committerGravatar}}} {{{shaLink}}} {{message}}</small></li>{{/payload.commits}}</ul>\
<small class="gha-message-commits">{{{commitsMessage}}}</small>',
ReleaseEvent: 'released {{{tagLink}}} at {{{repoLink}}}<br>{{{userGravatar}}}<small><span class="octicon octicon-cloud-download"></span> {{{zipLink}}}</small>',
WatchEvent: 'starred {{{repoLink}}}'
},
icons = {
CommitCommentEvent: 'comment-discussion',
CreateEvent_repository: 'repo-create',
CreateEvent_tag: 'tag',
CreateEvent_branch: 'git-branch-create',
DeleteEvent: 'repo-delete',
FollowEvent: 'person-follow',
ForkEvent: 'repo-forked',
GistEvent: 'gist',
GollumEvent: 'repo',
IssuesEvent: 'issue-opened',
IssueCommentEvent: 'comment-discussion',
MemberEvent: 'person',
PublicEvent: 'globe',
PullRequestEvent: 'git-pull-request',
PullRequestReviewEvent_approved: 'check',
PullRequestReviewEvent_commented: 'comment-discussion',
PullRequestReviewEvent_changes_requested: 'alert',
PullRequestReviewCommentEvent: 'comment-discussion',
PushEvent: 'git-commit',
ReleaseEvent: 'tag',
WatchEvent: 'star'
},
singleLineActivities = [ 'CreateEvent', 'DeleteEvent', 'FollowEvent', 'ForkEvent', 'GistEvent', 'MemberEvent', 'WatchEvent' ];