everpeace / async-twitter-client

Async Twitter client on top of Ning/Netty/Akka

Asynchronous Twitter client intended to be used with the Twitter Streaming API. Build on top of Ning/Netty/Akka provided a fully async end to end communication.

Each "Streaming Session" consist on a long running Http connection and a group of actors who take care of the different stages.

Twitter sends the information by chunks. Then, each part will represent an individual message to be processed.

Usage:

object ConsoleTwitterClient extends App {

  val s = Actor.actorOf(new ConsoleTwitterSession).start()
  s ! Filter()

  // Wait some time to get some news
  Thread.sleep(20000)

  // Stop everything.... if there is another way, let me know!
  EventHandler.shutdown()
  Actor.registry.shutdownAll()
  Actor.remote.shutdown()
  Scheduler.shutdown()

}

class ConsoleTwitterSession extends DefaultTwitterStreamingSession {
  def username = "someusername"

  def password = "somepass"

  val defaultTracks = Set("akka", "scala")

  def handler = this.self.spawnLink[PrinterActor]
}

class PrinterActor extends Actor with Logging {
  def receive = {
    case EntityReceived(tweet) => info("Tweet: %s \n".format(tweet))
    case ExceptionOnProcessing(throwable) => info("Exception on stream: %s \n".format(throwable))
    case ErrorCodeOnProcessing(code) => info("Error code recieved: %s \n".format(code))
  }
}

So, you have to provide the handler (PrinterActor) and the login credentials. The DefaultTwitterStreamingSession use basic authentication. But, it should be easy to customize it and use OAuth.

DefaultTwitterStreamingSession Looks like

trait DefaultTwitterStreamingSession
  extends TwitterStreamingSession[Tweet] with BackOffStreamReconnectionStrategy with JsonEntitySerializer with BasicAuthenticationMechanism