Path: | README.markdown |
Last Update: | Thu Dec 02 22:26:22 +0000 2010 |
# twitter-stream
Simple Ruby client library for [twitter streaming API](apiwiki.twitter.com/Streaming-API-Documentation). Uses [EventMachine](rubyeventmachine.com/) for connection handling. Adheres to twitter‘s [reconnection guidline](apiwiki.twitter.com/Streaming-API-Documentation#Connecting).
JSON format only.
## Install
sudo gem install twitter-stream -s http://gemcutter.org
## Usage
require 'rubygems' require 'twitter/json_stream' EventMachine::run { stream = Twitter::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