// jquery.tweet.js - see http://tweet.seaofclouds.com/ or https://github.com/seaofclouds/tweet for more info // copyright (c) 2008-2011 todd matthews & steve purcell (function (factory) { if (typeof define === 'function' && define.amd) define(['jquery'], factory); // amd support for requirejs etc. else factory(jquery); }(function ($) { $.fn.tweet = function(o){ var s = $.extend({ username: null, // [string or array] required unless using the 'query' option; one or more twitter screen names (use 'list' option for multiple names, where possible) list: null, // [string] optional name of list belonging to username favorites: false, // [boolean] display the user's favorites instead of his tweets query: null, // [string] optional search query (see also: http://search.twitter.com/operators) avatar_size: null, // [integer] height and width of avatar if displayed (48px max) count: 3, // [integer] how many tweets to display? fetch: null, // [integer] how many tweets to fetch via the api (set this higher than 'count' if using the 'filter' option) page: 1, // [integer] which page of results to fetch (if count != fetch, you'll get unexpected results) retweets: true, // [boolean] whether to fetch (official) retweets (not supported in all display modes) intro_text: null, // [string] do you want text before your your tweets? outro_text: null, // [string] do you want text after your tweets? join_text: null, // [string] optional text in between date and tweet, try setting to "auto" auto_join_text_default: "i said,", // [string] auto text for non verb: "i said" bullocks auto_join_text_ed: "i", // [string] auto text for past tense: "i" surfed auto_join_text_ing: "i am", // [string] auto tense for present tense: "i was" surfing auto_join_text_reply: "i replied to", // [string] auto tense for replies: "i replied to" @someone "with" auto_join_text_url: "i was looking at", // [string] auto tense for urls: "i was looking at" http:... loading_text: null, // [string] optional loading text, displayed while tweets load refresh_interval: null, // [integer] optional number of seconds after which to reload tweets twitter_url: "twitter.com", // [string] custom twitter url, if any (apigee, etc.) twitter_api_url: "api.twitter.com", // [string] custom twitter api url, if any (apigee, etc.) twitter_search_url: "search.twitter.com", // [string] custom twitter search url, if any (apigee, etc.) template: "{avatar}{time}{join}{text}", // [string or function] template used to construct each tweet
  • - see code for available vars comparator: function(tweet1, tweet2) { // [function] comparator used to sort tweets (see array.sort) return tweet2["tweet_time"] - tweet1["tweet_time"]; }, filter: function(tweet) { // [function] whether or not to include a particular tweet (be sure to also set 'fetch') return true; } // you can attach callbacks to the following events using jquery's standard .bind() mechanism: // "loaded" -- triggered when tweets have been fetched and rendered }, o); // see http://daringfireball.net/2010/07/improved_regex_for_matching_urls var url_regexp = /\b((?:https?:\/\/|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}\/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s`!()\[\]{};:'".,<>?â«â»â€œâ€â€˜â€™]))/gi; // expand values inside simple string templates with {placeholders} function t(template, info) { if (typeof template === "string") { var result = template; for(var key in info) { var val = info[key]; result = result.replace(new regexp('{'+key+'}','g'), val === null ? '' : val); } return result; } else return template(info); } // export the t function for use when passing a function as the 'template' option $.extend({tweet: {t: t}}); function replacer (regex, replacement) { return function() { var returning = []; this.each(function() { returning.push(this.replace(regex, replacement)); }); return $(returning); }; } function escapehtml(s) { return s.replace(//g,"^>"); } $.fn.extend({ linkuser: replacer(/(^|[\w])@(\w+)/gi, "$1@$2"), // support various latin1 (\u00**) and arabic (\u06**) alphanumeric chars linkhash: replacer(/(?:^| )[\#]+([\w\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff\u0600-\u06ff]+)/gi, ' #$1'), makeheart: replacer(/(<)+[3]/gi, "") }); function linkurls(text, entities) { return text.replace(url_regexp, function(match) { var url = (/^[a-z]+:/i).test(match) ? match : "http://"+match; var text = match; for(var i = 0; i < entities.length; ++i) { var entity = entities[i]; if (entity.url == url && entity.expanded_url) { url = entity.expanded_url; text = entity.display_url; break; } } return ""+escapehtml(text)+""; }); } function parse_date(date_str) { // the non-search twitter apis return inconsistently-formatted dates, which date.parse // cannot handle in ie. we therefore perform the following transformation: // "wed apr 29 08:53:31 +0000 2009" => "wed, apr 29 2009 08:53:31 +0000" return date.parse(date_str.replace(/^([a-z]{3})( [a-z]{3} \d\d?)(.*)( \d{4})$/i, '$1,$2$4$3')); } function relative_time(date) { var relative_to = (arguments.length > 1) ? arguments[1] : new date(); var delta = parseint((relative_to.gettime() - date) / 1000, 10); var r = ''; if (delta < 1) { r = 'just now'; } else if (delta < 60) { r = delta + ' seconds ago'; } else if(delta < 120) { r = 'about a minute ago'; } else if(delta < (45*60)) { r = 'about ' + (parseint(delta / 60, 10)).tostring() + ' minutes ago'; } else if(delta < (2*60*60)) { r = 'about an hour ago'; } else if(delta < (24*60*60)) { r = 'about ' + (parseint(delta / 3600, 10)).tostring() + ' hours ago'; } else if(delta < (48*60*60)) { r = 'about a day ago'; } else { r = 'about ' + (parseint(delta / 86400, 10)).tostring() + ' days ago'; } return r; } function build_auto_join_text(text) { if (text.match(/^(@([a-za-z0-9-_]+)) .*/i)) { return s.auto_join_text_reply; } else if (text.match(url_regexp)) { return s.auto_join_text_url; } else if (text.match(/^((\w+ed)|just) .*/im)) { return s.auto_join_text_ed; } else if (text.match(/^(\w*ing) .*/i)) { return s.auto_join_text_ing; } else { return s.auto_join_text_default; } } function build_api_url() { var proto = ('https:' == document.location.protocol ? 'https:' : 'http:'); var count = (s.fetch === null) ? s.count : s.fetch; var common_params = '&include_entities=1&callback=?'; if (s.list) { return proto+"//"+s.twitter_api_url+"/1/"+s.username[0]+"/lists/"+s.list+"/statuses.json?page="+s.page+"&per_page="+count+common_params; } else if (s.favorites) { return proto+"//"+s.twitter_api_url+"/favorites/"+s.username[0]+".json?page="+s.page+"&count="+count+common_params; } else if (s.query === null && s.username.length == 1) { return proto+'//'+s.twitter_api_url+'/1/statuses/user_timeline.json?screen_name='+s.username[0]+'&count='+count+(s.retweets ? '&include_rts=1' : '')+'&page='+s.page+common_params; } else { var query = (s.query || 'from:'+s.username.join(' or from:')); return proto+'//'+s.twitter_search_url+'/search.json?&q='+encodeuricomponent(query)+'&rpp='+count+'&page='+s.page+common_params; } } function extract_avatar_url(item, secure) { if (secure) { return ('user' in item) ? item.user.profile_image_url_https : extract_avatar_url(item, false). replace(/^http:\/\/[a-z0-9]{1,3}\.twimg\.com\//, "https://s3.amazonaws.com/twitter_production/"); } else { return item.profile_image_url || item.user.profile_image_url; } } // convert twitter api objects into data available for // constructing each tweet
  • using a template function extract_template_data(item){ var o = {}; o.item = item; o.source = item.source; o.screen_name = item.from_user || item.user.screen_name; // the actual user name is not returned by all twitter apis, so please do not // file an issue if it is empty: o.name = item.from_user_name || item.user.name; o.avatar_size = s.avatar_size; o.avatar_url = extract_avatar_url(item, (document.location.protocol === 'https:')); o.retweet = typeof(item.retweeted_status) != 'undefined'; o.tweet_time = parse_date(item.created_at); o.join_text = s.join_text == "auto" ? build_auto_join_text(item.text) : s.join_text; o.tweet_id = item.id_str; o.twitter_base = "http://"+s.twitter_url+"/"; o.user_url = o.twitter_base+o.screen_name; o.tweet_url = o.user_url+"/status/"+o.tweet_id; o.reply_url = o.twitter_base+"intent/tweet?in_reply_to="+o.tweet_id; o.retweet_url = o.twitter_base+"intent/retweet?tweet_id="+o.tweet_id; o.favorite_url = o.twitter_base+"intent/favorite?tweet_id="+o.tweet_id; o.retweeted_screen_name = o.retweet && item.retweeted_status.user.screen_name; o.tweet_relative_time = relative_time(o.tweet_time); o.entities = item.entities ? (item.entities.urls || []).concat(item.entities.media || []) : []; o.tweet_raw_text = o.retweet ? ('rt @'+o.retweeted_screen_name+' '+item.retweeted_status.text) : item.text; // avoid '...' in long retweets o.tweet_text = $([linkurls(o.tweet_raw_text, o.entities)]).linkuser().linkhash()[0]; o.tweet_text_fancy = $([o.tweet_text]).makeheart()[0]; // default spans, and pre-formatted blocks for common layouts o.user = t('{screen_name}', o); o.join = s.join_text ? t(' {join_text} ', o) : ' '; o.avatar = o.avatar_size ? t('{screen_name}\'s avatar', o) : ''; o.time = t('
    {tweet_relative_time}', o); o.text = t('{tweet_text_fancy}', o); o.reply_action = t('reply', o); o.retweet_action = t('retweet', o); o.favorite_action = t('favorite', o); return o; } function load(widget) { var intro = '

    '+s.intro_text+'

    '; var outro = '

    '+s.outro_text+'

    '; var loading = $('

    '+s.loading_text+'

    '); if (s.loading_text) $(widget).not(":has(.tweet_list)").empty().append(loading); $.getjson(build_api_url(), function(data){ var list = $('
    '); var tweets = $.map(data.results || data, extract_template_data); tweets = $.grep(tweets, s.filter).sort(s.comparator).slice(0, s.count); list.append($.map(tweets, function(o) { return '
    ' + t(s.template, o) + '
    '; }).join('')). children('dl:first').addclass('tweet_first').end(). children('dl:odd').addclass('tweet_even').end(). children('dl:even').addclass('tweet_odd'); $(widget).empty().append(list); if (s.intro_text) list.before(intro); if (s.outro_text) list.after(outro); $(widget).trigger("loaded").trigger((tweets.length === 0 ? "empty" : "full")); if (s.refresh_interval) { window.settimeout(function() { $(widget).trigger("tweet:load"); }, 1000 * s.refresh_interval); } }); } return this.each(function(i, widget){ if(s.username && typeof(s.username) == "string"){ s.username = [s.username]; } $(widget).unbind("tweet:load").bind("tweet:load", function(){ load(widget); }).trigger("tweet:load"); }); }; }));