Twitter realtime API client
Ruby
Switch branches/tags
Pull request Compare This branch is 12 commits ahead of collectiveidea:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
fixtures/twitter_stream
lib/twitter_stream
spec
.gitignore
README.markdown
Rakefile
VERSION
xh5-twitter-stream.gemspec

README.markdown

xh5-twitter-stream

Forked from original TwitterStream gem. This fork doesn't use Twitter::Module.

Simple Ruby client library for twitter streaming API. Uses EventMachine for connection handling. Adheres to twitter's reconnection guidline.

JSON format only.

Install

sudo gem install xh5-twitter-stream -s http://gemcutter.org

Usage

require 'rubygems'
require 'twitter_stream/json_stream'

EventMachine::run {
  stream = TwitterStream::JSONStream.connect(
    :path    => '/1/statuses/filter.json?track=football',
    :auth    => 'LOGIN:PASSWORD'
  )

  stream.each_item do |item|
    # Do someting with unparsed JSON item.
  end

  stream.on_error do |message|
    # No need to worry here. It might be an issue with Twitter. 
    # Log message for future reference. JSONStream will try to reconnect after a timeout.
  end
  
  stream.on_max_reconnects do |timeout, retries|
    # Something is wrong on your side. Send yourself an email.
  end
}

Examples

Open examples/reader.rb. Replace LOGIN:PASSWORD with your real twitter login and password. And ruby examples/reader.rb