tweetstream 1.1.0.rc1 → 1.1.0.rc2

data/README.md

@@ -51,6 +51,33 @@ user ids:
 The methods available to TweetStream::Client will be kept in parity
 with the methods available on the Streaming API wiki page.
 
+Using the Twitter Userstream
+----------------------------
+
+Using the Twitter userstream works similarly to the regular streaming, except you use the userstream method.
+
+    # Use 'userstream' to get message from your stream
+    TweetStream::Client.new.userstream do |status|
+      puts status.text
+    end
+
+
+You also can use method hooks for both regular timeline statuses and direct messages.
+
+    client = TweetStream::Client.new
+
+    client.on_direct_message do |direct_message|
+      puts "direct message"
+      puts direct_message.text
+    end
+
+    client.on_timeline_status do |status|
+      puts "timeline status"
+      puts status.text
+    end
+
+    client.userstream
+
 Configuration and Changes in 1.1.0
 ----------------------------------
 
@@ -96,8 +123,7 @@ specify a parser during configuration:
       config.parser   = :yajl
     end.
 
-Available options are `:yajl`, `:json_gem` (default),
-`:json_pure`, and `:active_support`.
+Available options are `:yajl`, `:json_gem`, `:json_pure`, and `:ok_json`.
 
 Handling Deletes and Rate Limitations
 -------------------------------------
@@ -189,17 +215,16 @@ It is also possible to create a daemonized script quite easily
 using the TweetStream library:
 
     # The third argument is an optional process name
-    TweetStream::Daemon.new('username','password', 'tracker').track('term1', 'term2') do |status|
+    TweetStream::Daemon.new('tracker').track('term1', 'term2') do |status|
       # do something in the background
     end
 
-If you put the above into a script and run the script with `ruby scriptname.rb`, you will see a list of daemonization commands such
-as start, stop, and run.
+If you put the above into a script and run the script with `ruby scriptname.rb`,
+you will see a list of daemonization commands such as start, stop, and run.
 
 TODO
 ----
 
-* UserStream support
 * SiteStream support
 
 Note on Patches/Pull Requests

data/Rakefile

@@ -1,3 +1,5 @@
+#!/usr/bin/env rake
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 

data/examples/growl_daemon.rb

@@ -4,11 +4,19 @@ require 'ruby-growl'
 
 if args_start = ARGV.index('--')
   username, password = ARGV[args_start + 1].split(':')
-  tracks = ARGV[args_start + 2 .. -1] 
+  tracks = ARGV[args_start + 2 .. -1]
   puts "Starting a GrowlTweet to track: #{tracks.inspect}"
 end
 
-TweetStream::Daemon.new(username,password).track(*tracks) do |status|
+TweetStream.configure do |config|
+  config.consumer_key = 'abcdefghijklmnopqrstuvwxyz'
+  config.consumer_secret = '0123456789'
+  config.oauth_token = 'abcdefghijklmnopqrstuvwxyz'
+  config.oauth_token_secret = '0123456789'
+  config.auth_method = :oauth
+end
+
+TweetStream::Daemon.new('tracker').track(*tracks) do |status|
   g = Growl.new 'localhost', 'growltweet', ['tweet']
   g.notify 'tweet', status.user.screen_name, status.text
 end

data/examples/oauth.rb

@@ -10,8 +10,12 @@ TweetStream.configure do |config|
   config.parser   = :yajl
 end
 
-TweetStream::Client.new.on_error do |message|
+client = TweetStream::Client.new
+
+client.on_error do |message|
   puts message
-end.track("yankees")  do |status|
+end
+
+client.track("yankees")  do |status|
   puts "#{status.text}"
 end

data/examples/userstream.rb

@@ -0,0 +1,27 @@
+require 'yajl'
+require 'tweetstream'
+
+TweetStream.configure do |config|
+  config.consumer_key = 'abcdefghijklmnopqrstuvwxyz'
+  config.consumer_secret = '0123456789'
+  config.oauth_token = 'abcdefghijklmnopqrstuvwxyz'
+  config.oauth_token_secret = '0123456789'
+  config.auth_method = :oauth
+  config.parser   = :yajl
+end
+
+client = TweetStream::Client.new
+
+client.on_error do |message|
+  puts message
+end
+
+client.on_direct_message do |direct_message|
+  puts direct_message.text
+end
+
+client.on_timeline_status  do |status|
+  puts status.text
+end
+
+client.userstream

data/lib/tweetstream.rb

@@ -2,41 +2,31 @@ require 'tweetstream/configuration'
 require 'tweetstream/client'
 require 'tweetstream/hash'
 require 'tweetstream/status'
+require 'tweetstream/direct_message'
 require 'tweetstream/user'
+require 'tweetstream/error'
 require 'tweetstream/daemon'
 
 module TweetStream
   extend Configuration
 
-  class Terminated < ::StandardError; end
-  class Error < ::StandardError; end
-  class ConnectionError < TweetStream::Error; end
-  # A ReconnectError is raised when the maximum number of retries has
-  # failed to re-establish a connection.
-  class ReconnectError < StandardError
-    attr_accessor :timeout, :retries
-    def initialize(timeout, retries)
-      self.timeout = timeout
-      self.retries = retries
-      super("Failed to reconnect after #{retries} tries.")
+  class << self
+    # Alias for TweetStream::Client.new
+    #
+    # @return [TweetStream::Client]
+    def new(options={})
+      TweetStream::Client.new(options)
     end
-  end
-
-  # Alias for TweetStream::Client.new
-  #
-  # @return [TweetStream::Client]
-  def self.client(options={})
-    TweetStream::Client.new(options)
-  end
 
-  # Delegate to TweetStream::Client
-  def self.method_missing(method, *args, &block)
-    return super unless client.respond_to?(method)
-    client.send(method, *args, &block)
-  end
+    # Delegate to TweetStream::Client
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
 
-  # Delegate to TweetStream::Client
-  def self.respond_to?(method)
-    client.respond_to?(method) || super
+    # Delegate to TweetStream::Client
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
   end
-end
+end

data/lib/tweetstream/client.rb

@@ -13,18 +13,17 @@ module TweetStream
   # methods and provide a block that will perform actions on
   # a yielded TweetStream::Status. For example:
   #
-  #     TweetStream::Client.new('user','pass').track('fail') do |status|
+  #     TweetStream::Client.new.track('fail') do |status|
   #       puts "[#{status.user.screen_name}] #{status.text}"
   #     end
   #
   # For information about a daemonized TweetStream client,
   # view the TweetStream::Daemon class.
   class Client
-    attr_accessor :username, :password
-    attr_reader :parser
 
     # @private
     attr_accessor *Configuration::VALID_OPTIONS_KEYS
+    attr_accessor :timer
 
     # Creates a new API
     def initialize(options={})
@@ -39,16 +38,6 @@ module TweetStream
       parser_from(parser)
     end
 
-    # Create a new client with the Twitter credentials
-    # of the account you want to be using its API quota.
-    # You may also set the JSON parsing library as specified
-    # in the #parser= setter.
-    # def initialize(ouser, pass, parser = :json_gem)
-    #   self.username = user
-    #   self.password = pass
-    #   self.parser = parser
-    # end
-
     # Returns all public statuses. The Firehose is not a generally
     # available resource. Few applications require this level of access.
     # Creative use of a combination of other resources and various access
@@ -122,10 +111,15 @@ module TweetStream
       start('statuses/filter', query_params.merge(:method => :post), &block)
     end
 
+    # Make a call to the userstream api for currently authenticated user
+    def userstream(&block)
+      start('', :extra_stream_parameters => {:host => "userstream.twitter.com", :path => "/2/user.json"}, &block)
+    end
+
     # Set a Proc to be run when a deletion notice is received
     # from the Twitter stream. For example:
     #
-    #     @client = TweetStream::Client.new('user','pass')
+    #     @client = TweetStream::Client.new
     #     @client.on_delete do |status_id, user_id|
     #       Tweet.delete(status_id)
     #     end
@@ -146,7 +140,7 @@ module TweetStream
     # Set a Proc to be run when a rate limit notice is received
     # from the Twitter stream. For example:
     #
-    #     @client = TweetStream::Client.new('user','pass')
+    #     @client = TweetStream::Client.new
     #     @client.on_limit do |discarded_count|
     #       # Make note of discarded count
     #     end
@@ -168,7 +162,7 @@ module TweetStream
     # processing of the stream. Note that TweetStream will automatically
     # try to reconnect, this is for reference only. Don't panic!
     #
-    #     @client = TweetStream::Client.new('user','pass')
+    #     @client = TweetStream::Client.new
     #     @client.on_error do |message|
     #       # Make note of error message
     #     end
@@ -186,10 +180,73 @@ module TweetStream
       end
     end
 
+    # Set a Proc to be run when a direct message is encountered in the
+    # processing of the stream.
+    #
+    #     @client = TweetStream::Client.new
+    #     @client.on_direct_message do |direct_message|
+    #       # do something with the direct message
+    #     end
+    #
+    # Block must take one argument: the direct message.
+    # If no block is given, it will return the currently set
+    # direct message proc. When a block is given, the TweetStream::Client
+    # object is returned to allow for chaining.
+    def on_direct_message(&block)
+      if block_given?
+        @on_direct_message = block
+        self
+      else
+        @on_direct_message
+      end
+    end
+
+    # Set a Proc to be run whenever anything is encountered in the
+    # processing of the stream.
+    #
+    #     @client = TweetStream::Client.new
+    #     @client.on_anything do |status|
+    #       # do something with the status
+    #     end
+    #
+    # Block can take one or two arguments. |status (, client)|
+    # If no block is given, it will return the currently set
+    # timeline status proc. When a block is given, the TweetStream::Client
+    # object is returned to allow for chaining.
+    def on_anything(&block)
+      if block_given?
+        @on_anything = block
+        self
+      else
+        @on_anything
+      end
+    end
+
+    # Set a Proc to be run when a regular timeline message is encountered in the
+    # processing of the stream.
+    #
+    #     @client = TweetStream::Client.new
+    #     @client.on_timeline_message do |status|
+    #       # do something with the status
+    #     end
+    #
+    # Block can take one or two arguments. |status (, client)|
+    # If no block is given, it will return the currently set
+    # timeline status proc. When a block is given, the TweetStream::Client
+    # object is returned to allow for chaining.
+    def on_timeline_status(&block)
+      if block_given?
+        @on_timeline_status = block
+        self
+      else
+        @on_timeline_status
+      end
+    end
+
     # Set a Proc to be run when connection established.
     # Called in EventMachine::Connection#post_init
     #
-    #     @client = TweetStream::Client.new('user','pass')
+    #     @client = TweetStream::Client.new
     #     @client.on_inited do
     #       puts 'Connected...'
     #     end
@@ -203,27 +260,59 @@ module TweetStream
       end
     end
 
+    # Set a Proc to be run on a regular interval
+    # independent of timeline status updates
+    #
+    #     @client = TweetStream::Client.new
+    #     @client.on_interval(20) do
+    #       # do something every 20 seconds
+    #     end
+    #
+    def on_interval(time_interval=nil, &block)
+      if block_given?
+        @on_interval_time = time_interval
+        @on_interval_proc = block
+        self
+      else
+        [@on_interval_time, @on_interval_proc]
+      end
+    end
+
     def start(path, query_parameters = {}, &block) #:nodoc:
       method = query_parameters.delete(:method) || :get
       delete_proc = query_parameters.delete(:delete) || self.on_delete
       limit_proc = query_parameters.delete(:limit) || self.on_limit
       error_proc = query_parameters.delete(:error) || self.on_error
       inited_proc = query_parameters.delete(:inited) || self.on_inited
+      direct_message_proc = query_parameters.delete(:direct_message) || self.on_direct_message
+      timeline_status_proc = query_parameters.delete(:timeline_status) || self.on_timeline_status
+      anything_proc = query_parameters.delete(:anything) || self.on_anything
 
       params = normalize_filter_parameters(query_parameters)
 
+      extra_stream_parameters = query_parameters.delete(:extra_stream_parameters) || {}
+
       uri = method == :get ? build_uri(path, params) : build_uri(path)
 
+      stream_params = {
+        :path       => uri,
+        :method     => method.to_s.upcase,
+        :user_agent => user_agent,
+        :on_inited  => inited_proc,
+        :filters    => params.delete(:track),
+        :params     => params,
+        :ssl        => true
+      }.merge(auth_params).merge(extra_stream_parameters)
+
+      EventMachine.epoll
+      EventMachine.kqueue
+
       EventMachine::run {
-        stream_params = {
-          :path       => uri,
-          :method     => method.to_s.upcase,
-          :user_agent => user_agent,
-          :on_inited  => inited_proc,
-          :filters    => params.delete(:track),
-          :params     => params,
-          :ssl        => true
-        }.merge(auth_params)
+        if @on_interval_proc.is_a?(Proc)
+          interval = @on_interval_time || Configuration::DEFAULT_TIMER_INTERVAL
+          proc = @on_interval_proc
+          @timer = EM.add_periodic_timer(interval, &proc)
+        end
 
         @stream = Twitter::JSONStream.connect(stream_params)
         @stream.each_item do |item|
@@ -240,23 +329,31 @@ module TweetStream
           end
 
           hash = TweetStream::Hash.new(raw_hash)
-
           if hash[:delete] && hash[:delete][:status]
             delete_proc.call(hash[:delete][:status][:id], hash[:delete][:status][:user_id]) if delete_proc.is_a?(Proc)
           elsif hash[:limit] && hash[:limit][:track]
             limit_proc.call(hash[:limit][:track]) if limit_proc.is_a?(Proc)
+
+          elsif hash[:direct_message]
+            yield_message_to direct_message_proc, TweetStream::DirectMessage.new(hash[:direct_message])
+
           elsif hash[:text] && hash[:user]
             @last_status = TweetStream::Status.new(hash)
-
-            # Give the block the option to receive either one
-            # or two arguments, depending on its arity.
-            case block.arity
-              when 1
-                yield @last_status
-              when 2
-                yield @last_status, self
+            yield_message_to timeline_status_proc, @last_status
+
+            if block_given?
+              # Give the block the option to receive either one
+              # or two arguments, depending on its arity.
+              case block.arity
+                when 1
+                  yield @last_status
+                when 2
+                  yield @last_status, self
+              end
             end
           end
+
+          yield_message_to anything_proc, hash
         end
 
         @stream.on_error do |message|
@@ -292,14 +389,11 @@ module TweetStream
 
     def build_post_body(query) #:nodoc:
       return '' unless query && query.is_a?(::Hash) && query.size > 0
-      pairs = []
 
-      query.each_pair do |k,v|
+      query.map do |k, v|
         v = v.flatten.collect { |q| q.to_s }.join(',') if v.is_a?(Array)
-        pairs << "#{k.to_s}=#{CGI.escape(v.to_s)}"
-      end
-
-      pairs.join('&')
+        "#{k.to_s}=#{CGI.escape(v.to_s)}"
+      end.join('&')
     end
 
     def normalize_filter_parameters(query_parameters = {})
@@ -326,5 +420,16 @@ module TweetStream
         }
       end
     end
+
+    def yield_message_to(procedure, message)
+      if procedure.is_a?(Proc)
+        case procedure.arity
+        when 1
+          procedure.call(message)
+        when 2
+          procedure.call(message, self)
+        end
+      end
+    end
   end
 end

data/lib/tweetstream/configuration.rb

@@ -47,6 +47,9 @@ module TweetStream
     # By default, don't set a user oauth secret
     DEFAULT_OAUTH_TOKEN_SECRET = nil
 
+    # Default time interval for use with on_interval
+    DEFAULT_TIMER_INTERVAL = 30
+
     # @private
     attr_accessor *VALID_OPTIONS_KEYS
 

data/lib/tweetstream/daemon.rb

@@ -8,7 +8,15 @@ require 'daemons'
 #     require 'rubygems'
 #     require 'tweetstream'
 #
-#     TweetStream::Daemon.new('user','pass', 'tracker').track('intridea') do |status|
+#     TweetStream.configure do |config|
+#       config.consumer_key = 'abcdefghijklmnopqrstuvwxyz'
+#       config.consumer_secret = '0123456789'
+#       config.oauth_token = 'abcdefghijklmnopqrstuvwxyz'
+#       config.oauth_token_secret = '0123456789'
+#       config.auth_method = :oauth
+#     end
+#
+#     TweetStream::Daemon.new('tracker').track('intridea') do |status|
 #       # do something here
 #     end
 #
@@ -26,9 +34,9 @@ class TweetStream::Daemon < TweetStream::Client
   # Twitter account you wish to use. The daemon has
   # an optional process name for use when querying
   # running processes.
-  def initialize(user, pass, app_name=nil, parser=:json_gem)
+  def initialize(app_name=nil)
     @app_name = app_name
-    super(user, pass, parser)
+    super({})
   end
 
   def start(path, query_parameters = {}, &block) #:nodoc:

data/lib/tweetstream/direct_message.rb

@@ -0,0 +1,6 @@
+class TweetStream::DirectMessage < TweetStream::Hash
+  def initialize(hash)
+    super
+    self[:user] = self[:sender] = TweetStream::User.new(self[:sender])
+  end
+end

data/lib/tweetstream/error.rb

@@ -0,0 +1,15 @@
+module TweetStream
+  class Terminated < ::StandardError; end
+  class Error < ::StandardError; end
+  class ConnectionError < TweetStream::Error; end
+  # A ReconnectError is raised when the maximum number of retries has
+  # failed to re-establish a connection.
+  class ReconnectError < StandardError
+    attr_accessor :timeout, :retries
+    def initialize(timeout, retries)
+      self.timeout = timeout
+      self.retries = retries
+      super("Failed to reconnect after #{retries} tries.")
+    end
+  end
+end

data/lib/tweetstream/status.rb

@@ -5,7 +5,7 @@ class TweetStream::Status < TweetStream::Hash
     super
     self[:user] = TweetStream::User.new(self[:user])
   end
-  
+
   def id
     self[:id] || super
   end

data/lib/tweetstream/version.rb

@@ -1,3 +1,3 @@
 module TweetStream
-  VERSION = '1.1.0.rc1'
+  VERSION = '1.1.0.rc2'
 end

data/spec/data/direct_messages.json

@@ -0,0 +1 @@
+{"direct_message":{"created_at":"Sat Sep 24 18:59:38 +0000 2011", "id_str":"4227325281", "sender_screen_name":"coreyhaines", "sender":{"name":"Corey Haines", "profile_sidebar_fill_color":"DAECF4", "profile_sidebar_border_color":"C6E2EE", "profile_background_tile":false, "profile_image_url":"http://a0.twimg.com/profile_images/1508969901/Photo_on_2011-08-22_at_19.15__3_normal.jpg", "created_at":"Sun Dec 23 18:11:29 +0000 2007", "location":"Chicago, IL", "follow_request_sent":false, "id_str":"11458102", "is_translator":false, "profile_link_color":"1F98C7", "default_profile":false, "favourites_count":122, "contributors_enabled":false, "url":"http://www.coreyhaines.com", "id":11458102, "profile_image_url_https":"https://si0.twimg.com/profile_images/1508969901/Photo_on_2011-08-22_at_19.15__3_normal.jpg", "utc_offset":-21600, "profile_use_background_image":true, "listed_count":593, "lang":"en", "followers_count":5764, "protected":false, "profile_text_color":"663B12", "notifications":false, "description":"Software Journeyman, Coderetreat Facilitator, Cofounder of MercuryApp.com, Awesome....\r\nI make magic!", "verified":false, "profile_background_color":"C6E2EE", "geo_enabled":false, "profile_background_image_url_https":"https://si0.twimg.com/images/themes/theme2/bg.gif", "time_zone":"Central Time (US & Canada)", "profile_background_image_url":"http://a1.twimg.com/images/themes/theme2/bg.gif", "default_profile_image":false, "friends_count":423, "statuses_count":35950, "following":false, "screen_name":"coreyhaines", "show_all_inline_media":false}, "recipient_screen_name":"coreyhainestest", "text":"waddup gain", "id":4227325281, "recipient":{"name":"Corey's Test Account", "profile_sidebar_fill_color":"DDEEF6", "profile_sidebar_border_color":"C0DEED", "profile_background_tile":false, "profile_image_url":"http://a2.twimg.com/sticky/default_profile_images/default_profile_3_normal.png", "created_at":"Sat Sep 24 13:04:56 +0000 2011", "location":null, "follow_request_sent":false, "id_str":"379145826", "is_translator":false, "profile_link_color":"0084B4", "default_profile":true, "favourites_count":0, "contributors_enabled":false, "url":null, "id":379145826, "profile_image_url_https":"https://si0.twimg.com/sticky/default_profile_images/default_profile_3_normal.png", "utc_offset":null, "profile_use_background_image":true, "listed_count":0, "lang":"en", "followers_count":1, "protected":false, "profile_text_color":"333333", "notifications":false, "description":null, "verified":false, "profile_background_color":"C0DEED", "geo_enabled":false, "profile_background_image_url_https":"https://si0.twimg.com/images/themes/theme1/bg.png", "time_zone":null, "profile_background_image_url":"http://a0.twimg.com/images/themes/theme1/bg.png", "default_profile_image":true, "friends_count":1, "statuses_count":21, "following":true, "screen_name":"coreyhainestest", "show_all_inline_media":false}, "recipient_id":379145826, "sender_id":11458102}}

data/spec/spec_helper.rb

@@ -24,3 +24,13 @@ def sample_tweets
     @tweets
   end
 end
+
+def sample_direct_messages
+  return @direct_messages if @direct_messages
+
+  @direct_messages = []
+  Yajl::Parser.parse(File.open(File.dirname(__FILE__) + '/data/direct_messages.json', 'r')) do |hash|
+    @direct_messages << hash
+  end
+  @direct_messages
+end

data/spec/tweetstream/client_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe TweetStream::Client do
   before(:each) do
@@ -12,7 +12,7 @@ describe TweetStream::Client do
 
   describe '#build_uri' do
     it 'should return a URI' do
-      @client.send(:build_uri, '').is_a?(URI).should be_true
+      @client.send(:build_uri, '').should be_kind_of(URI)
     end
 
     it 'should have the specified path with the version prefix and a json extension' do
@@ -123,6 +123,81 @@ describe TweetStream::Client do
         end.track('abc')
       end
 
+      context "using on_anything" do
+        it "yields the raw hash" do
+          hash = {:id => 1234}
+          @stream.should_receive(:each_item).and_yield(hash.to_json)
+          yielded_hash = nil
+          @client.on_anything do |hash|
+            yielded_hash = hash
+          end.track('abc')
+          yielded_hash.should_not be_nil
+          yielded_hash.id.should == 1234
+        end
+        it 'yields itself if block has an arity of 2' do
+          hash = {:id => 1234}
+          @stream.should_receive(:each_item).and_yield(hash.to_json)
+          yielded_client = nil
+          @client.on_anything do |_, client|
+            yielded_client = client
+          end.track('abc')
+          yielded_client.should_not be_nil
+          yielded_client.should == @client
+        end
+      end
+
+      context 'using on_timeline_status' do
+        it 'yields a Status' do
+          tweet = sample_tweets[0]
+          tweet[:id] = 123
+          tweet[:user][:screen_name] = 'monkey'
+          tweet[:text] = "Oo oo aa aa"
+          @stream.should_receive(:each_item).and_yield(tweet.to_json)
+          yielded_status = nil
+          @client.on_timeline_status do |status|
+            yielded_status = status
+          end.track('abc')
+          yielded_status.should_not be_nil
+          yielded_status[:id].should == 123
+          yielded_status.user.screen_name.should == 'monkey'
+          yielded_status.text.should == 'Oo oo aa aa'
+        end
+        it 'yields itself if block has an arity of 2' do
+          @stream.should_receive(:each_item).and_yield(sample_tweets[0].to_json)
+          yielded_client = nil
+          @client.on_timeline_status do |_, client|
+            yielded_client = client
+          end.track('abc')
+          yielded_client.should_not be_nil
+          yielded_client.should == @client
+        end
+      end
+
+      context 'using on_direct_message' do
+        it 'yields a DirectMessage' do
+          direct_message = sample_direct_messages[0]
+          direct_message["direct_message"]["id"] = 1234
+          direct_message["direct_message"]["sender"]["screen_name"] = "coder"
+          @stream.should_receive(:each_item).and_yield(direct_message.to_json)
+          yielded_dm = nil
+          @client.on_direct_message do |dm|
+            yielded_dm = dm
+          end.userstream
+          yielded_dm.should_not be_nil
+          yielded_dm.id.should == 1234
+          yielded_dm.user.screen_name.should == "coder"
+        end
+
+        it 'yields itself if block has an arity of 2' do
+          @stream.should_receive(:each_item).and_yield(sample_direct_messages[0].to_json)
+          yielded_client = nil
+          @client.on_direct_message do |_, client|
+            yielded_client = client
+          end.userstream
+          yielded_client.should == @client
+        end
+      end
+
       it 'should call on_error if a non-hash response is received' do
         @stream.should_receive(:each_item).and_yield('["favorited"]')
         @client.on_error do |message|
@@ -145,6 +220,17 @@ describe TweetStream::Client do
           m.should == 'Uh oh'
         end.track('abc')
       end
+
+      it 'should return the block when defined' do
+        @client.on_error do |m|
+          puts 'ohai'
+        end
+        @client.on_error.should be_kind_of(Proc)
+      end
+
+      it 'should return nil when undefined' do
+        @client.on_error.should be_nil
+      end
     end
 
     describe '#on_max_reconnects' do
@@ -208,6 +294,27 @@ describe TweetStream::Client do
         @client.send(proc_setter, &proc)
         @client.send(proc_setter).should == proc
       end
+
+      it 'should return nil when undefined' do
+        @client.send(proc_setter).should be_nil
+      end
+    end
+  end
+
+  describe '#on_interval' do
+    it 'should set when a block is given' do
+      @client.on_interval(5) { puts 'hi' }
+      @client.on_interval[0].should == 5
+      @client.on_interval[1].should be_kind_of(Proc)
+    end
+
+    it 'should should create a periodic timer' do
+      # need to figure out a better way to test this
+      # for now, using on_inited to stop the reactor
+      proc = Proc.new{ puts 'hi' }
+      EM.should_receive(:add_periodic_timer).once.with(5)
+      @client.on_inited { EM.stop }.on_interval(5, &proc)
+      @client.track('go')
     end
   end
 
@@ -287,6 +394,18 @@ describe TweetStream::Client do
 
         @client.track('monday')
       end
+
+      context "when calling #userstream" do
+        it "sends the userstream host" do
+          Twitter::JSONStream.should_receive(:connect).with(hash_including(:host => "userstream.twitter.com")).and_return(@stream)
+          @client.userstream
+        end
+
+        it "uses the userstream uri" do
+          Twitter::JSONStream.should_receive(:connect).with(hash_including(:path => "/2/user.json")).and_return(@stream)
+          @client.userstream
+        end
+      end
     end
   end
 

data/spec/tweetstream/direct_message_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe TweetStream::DirectMessage do
+  it 'modifies the :sender key into a TweetStream::User object called #user' do
+    @status = TweetStream::DirectMessage.new({:sender => {:screen_name => 'bob'}})
+    @status.user.should be_kind_of(TweetStream::User)
+    @status.user.screen_name.should == 'bob'
+  end
+
+  it 'transforms the sender into a TweetStream::User object called #sender' do
+    @status = TweetStream::DirectMessage.new({:sender => {:screen_name => 'bob'}})
+    @status.sender.should be_kind_of(TweetStream::User)
+    @status.sender.screen_name.should == 'bob'
+  end
+
+  it 'overrides the #id method for itself and the user' do
+    @status = TweetStream::DirectMessage.new({:id => 123, :sender => {:id => 345}})
+    @status.id.should == 123
+    @status.user.id.should == 345
+  end
+end

data/spec/tweetstream/status_spec.rb

@@ -1,14 +1,14 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe TweetStream::Status do
   it 'should modify the :user key into a TweetStream::User object' do
-    @status = TweetStream::Status.new(:user => {:screen_name => 'bob'})
-    @status.user.is_a?(TweetStream::User).should be_true
+    @status = TweetStream::Status.new({:user => {:screen_name => 'bob'}})
+    @status.user.should be_kind_of(TweetStream::User)
     @status.user.screen_name.should == 'bob'
   end
-  
+
   it 'should override the #id method for itself and the user' do
-    @status = TweetStream::Status.new(:id => 123, :user => {:id => 345})
+    @status = TweetStream::Status.new({:id => 123, :user => {:id => 345}})
     @status.id.should == 123
     @status.user.id.should == 345
   end

data/spec/tweetstream_spec.rb

@@ -22,13 +22,19 @@ describe TweetStream do
     it "should return the same results as a client" do
       MultiJson.should_receive(:decode).and_return({})
       @stream.should_receive(:each_item).and_yield(sample_tweets[0].to_json)
-      TweetStream.track('abc','def').should == TweetStream::Client.new.track('abc','def')
+      TweetStream.new.track('abc','def').should == TweetStream::Client.new.track('abc','def')
     end
   end
 
-  describe ".client" do
+  describe ".new" do
     it "should be a TweetStream::Client" do
-      TweetStream.client.should be_a TweetStream::Client
+      TweetStream.new.should be_a TweetStream::Client
+    end
+  end
+
+  describe '.respond_to?' do
+    it "should take an optional argument" do
+      TweetStream.respond_to?(:new, true).should be_true
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tweetstream
 version: !ruby/object:Gem::Version
-  version: 1.1.0.rc1
+  version: 1.1.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-19 00:00:00.000000000Z
+date: 2011-09-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter-stream
-  requirement: &2152826800 !ruby/object:Gem::Requirement
+  requirement: &2153824280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.1.14
   type: :runtime
   prerelease: false
-  version_requirements: *2152826800
+  version_requirements: *2153824280
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: &2152826340 !ruby/object:Gem::Requirement
+  requirement: &2153823820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *2152826340
+  version_requirements: *2153823820
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2152858380 !ruby/object:Gem::Requirement
+  requirement: &2153823360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *2152858380
+  version_requirements: *2153823360
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152857920 !ruby/object:Gem::Requirement
+  requirement: &2153822900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *2152857920
+  version_requirements: *2153822900
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2152857460 !ruby/object:Gem::Requirement
+  requirement: &2153822440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *2152857460
+  version_requirements: *2153822440
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2152857000 !ruby/object:Gem::Requirement
+  requirement: &2153821980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *2152857000
+  version_requirements: *2153821980
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &2152856540 !ruby/object:Gem::Requirement
+  requirement: &2153821520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *2152856540
+  version_requirements: *2153821520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152856080 !ruby/object:Gem::Requirement
+  requirement: &2153821060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2152856080
+  version_requirements: *2153821060
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2152855620 !ruby/object:Gem::Requirement
+  requirement: &2153820600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2152855620
+  version_requirements: *2153820600
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2152855160 !ruby/object:Gem::Requirement
+  requirement: &2153820140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 1.5.1
   type: :development
   prerelease: false
-  version_requirements: *2152855160
+  version_requirements: *2153820140
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2152854700 !ruby/object:Gem::Requirement
+  requirement: &2153819680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,7 +131,7 @@ dependencies:
         version: 0.4.3
   type: :development
   prerelease: false
-  version_requirements: *2152854700
+  version_requirements: *2153819680
 description: TweetStream allows you to easily consume the Twitter Streaming API utilizing
   the YAJL Ruby gem.
 email:
@@ -153,17 +153,22 @@ files:
 - Rakefile
 - examples/growl_daemon.rb
 - examples/oauth.rb
+- examples/userstream.rb
 - lib/tweetstream.rb
 - lib/tweetstream/client.rb
 - lib/tweetstream/configuration.rb
 - lib/tweetstream/daemon.rb
+- lib/tweetstream/direct_message.rb
+- lib/tweetstream/error.rb
 - lib/tweetstream/hash.rb
 - lib/tweetstream/status.rb
 - lib/tweetstream/user.rb
 - lib/tweetstream/version.rb
+- spec/data/direct_messages.json
 - spec/data/statuses.json
 - spec/spec_helper.rb
 - spec/tweetstream/client_spec.rb
+- spec/tweetstream/direct_message_spec.rb
 - spec/tweetstream/hash_spec.rb
 - spec/tweetstream/parser_spec.rb
 - spec/tweetstream/status_spec.rb
@@ -194,9 +199,11 @@ signing_key:
 specification_version: 3
 summary: TweetStream is a simple wrapper for consuming the Twitter Streaming API.
 test_files:
+- spec/data/direct_messages.json
 - spec/data/statuses.json
 - spec/spec_helper.rb
 - spec/tweetstream/client_spec.rb
+- spec/tweetstream/direct_message_spec.rb
 - spec/tweetstream/hash_spec.rb
 - spec/tweetstream/parser_spec.rb
 - spec/tweetstream/status_spec.rb