Read Me

Basic examples

// get data for stream "bdainton/kindle"
var stream = new massrel.Stream('bdainton', 'kindle');

stream.poller({
  limit: 10,    // number of tweets per poll
  frequency: 30 // how often to get new tweets
}).batch(function(tweets) {
    // resort so tweets on top are the newest
    reorder = [];
    while(tweets.length > 0) {
      reorder.push(tweets.pop());
    }
    
    // print array of new tweets
    console.log(reorder);
}).start();

Advanced examples

Create stream

var stream = new massrel.Stream('bdainton', 'kindle');

Create pollers

//gets a NEW poller for the stream
var poller = stream.poller();

For each poller instance usually a callback is either added to .each or .batch but not both

Poller enumerator

Callback invoked for each tweet as they come in from oldest tweet to newest

poller.each(function(tweet) {
  // invoke for every tweet that is return from the api
  // from oldest to newest
  console.log(tweet);

  // "this" is the poller instance
})

Poller batch

Callback invoked for each poll that has more than zero tweets

poller.batch(function(tweets) {
  // all tweets from each poll that have > 0 tweets
  console.log(tweets);

  // "this" is the poller instance
})

Start poller

// start grabbing tweets
poller.start();

Stop poller

setTimeout(function() {
  // in 1 minute, stop getting tweets
  poller.stop();
}, 60000);

Poller example

// the best part is that it is chainable
stream.poller({ frequency: 30 }).each(function(tweet) {
  var container = document.getElementById('tweet-quick');

  var ptag = document.createElement('p');
  ptag.innerHTML = tweet.text;
  container.insertBefore(ptag, container.firstChild);
}).start();

Delayed queue example

Basically if you want to display tweets on a regular interval

// here is an example of delayed queue
var poller = stream.poller();
var queue = new massrel.PollerQueue(poller);

poller.start();

queue.next(function(tweet, step) {
  var container = document.getElementById('tweet-delay');

  var ptag = document.createElement('p');
  ptag.innerHTML = tweet.text;
  container.insertBefore(ptag, container.firstChild);
  setTimeout(step, 1000);
});

Shorthand

var poller = stream.poller().queue(function(tweet, step) {
  var container = document.getElementById('tweet-delay');

  var ptag = document.createElement('p');
  ptag.innerHTML = tweet.text;
  container.insertBefore(ptag, container.firstChild);
  setTimeout(step, 1000);
}).start();

Change log

v0.9.9

• top_period_relative is a new partam on Stream#meta (b0e3013f24)
• bind current poller instance to this in Poller#more callback (45e8c496a3)
• fixed bug so that the massrel.js lib doesn't replace any existing global massrel global object (71ac8a739e)
• fixed bug that prevented newer statuses from being pulled in correctly if Poller#more was called before Poller#start (19c96fc767)
• stay_realtime is a new param for Poller (default: true) (replaces old catch_up param) (cb9c796692...f860ea3ba0, and bug fix c85cd339d3)

v0.9.8

• num_hours is a new param on Stream#meta
• keywords now works when polling streamer

v0.9.7

• catch race condition that prevents MetaPoller from being stopped when called to stop (fixes #1)
• num_days is a new param on Stream#meta
• num_minutes is a new param on Stream#meta
• intent url generator (e.g. massrel.intents.tweet({ text: 'Awesome!!', hashtags: ['awesome', 'nice'] });)

v0.9.6

• enable intents by default in Context
• top_periods is a new param on Stream#meta
• finish is a new param on Stream#meta
• added a way for you to update MetaPoller options on the fly

v0.9.5

• add keywords param for streams
• meta poller for Account (use Account#metaPoller)
• global minimum poll value. for use in a possible QoS implementation

v0.9.4

• fix mispelled method names in Account and Stream which caused #meta to break when called (builMetaParams changed to buildMetaParams)

v0.9.3

• added Poller#more method to pull older statuses from a timeline. It keeps track of the last item in the list for subsequent requests
• created query param builder methods for stream and account requests (use Stream#buildParams, Stream.buildMetaParams, or Account#buildMetaParams)

v0.9.2

• added conveniece wrapper for polling stream meta info (use Stream#metaPoller)
• define API as AMD if public AMD define method exists

v0.9.1

• first versioned package
• overhall system to use jburke/r.js & almond for build system

TO DO

• tests
• conversations/reply-to in status UI
• better abstraction to update relative time in status periodically
• include optional param to show author location in status UI
• break out jsonp_factory to be a replaceable io transport, so we can use XHR or CORS easily in future
• use HTTPS urls when on a secure page
• change anchor text to use entitites given in in JSON (/entities/urls)
• better date handling (is8601 and twitter formmated date conversion not very thorough)
• build out Account API (e.g. Account#streams instead of just Account#meta)
• abstract Poller class to handle of data besides streams api (meta anyone?) (this was solved by creating a new type MetaPoller)