Full test coverage of client, ready for 1.0 release.

Author: Michael Bleigh

lib/tweetstream/client.rb

@@ -173,7 +173,6 @@ def on_error(&block)
         @on_limit = block
         self
       else
-        return Proc.new{|e| puts e.inspect}
         @on_limit
       end
     end
@@ -187,10 +186,6 @@ def start(path, query_parameters = {}, &block) #:nodoc:
       uri = method == :get ? build_uri(path, query_parameters) : build_uri(path)
 
       EventMachine::run {
-        @cancel_timer = EventMachine::PeriodicTimer.new(1) do
-          EventMachine::stop_event_loop if @stop || TweetStream::Client.stop?
-        end
-        
         @stream = Twitter::JSONStream.connect(
           :path => uri,
           :auth => "#{URI.encode self.username}:#{URI.encode self.password}",
@@ -230,24 +225,14 @@ def start(path, query_parameters = {}, &block) #:nodoc:
       }
     end
 
-    # Terminate the currently running TweetStream.
-    def self.stop
-      raise TweetStream::Terminated
-    end
-
     # Terminate the currently running TweetStream.
     def stop
       EventMachine.stop_event_loop
-      true
     end
 
+    # Terminate the currently running TweetStream
     def self.stop
       EventMachine.stop_event_loop
-      true
-    end
-    
-    def self.stop?
-      @stop
     end
 
     protected

lib/tweetstream/hash.rb

@@ -1,7 +1,9 @@
 class TweetStream::Hash < ::Hash #:nodoc: all
   def initialize(other_hash = {})
     other_hash.keys.each do |key|
-      self[key.to_sym] = other_hash[key]
+      value = other_hash[key]
+      value = TweetStream::Hash.new(value) if value.is_a?(::Hash)
+      self[key.to_sym] = value
     end
   end
 

lib/tweetstream/status.rb

@@ -5,4 +5,8 @@ def initialize(hash)
     super
     self[:user] = TweetStream::User.new(self[:user])
   end
+  
+  def id
+    self[:id] || super
+  end
 end

lib/tweetstream/user.rb

@@ -1,5 +1,7 @@
 # A simple Hash wrapper that gives you method-based
 # access to user properties returned by the streamer.
 class TweetStream::User < TweetStream::Hash
-  
+  def id
+    self[:id] || super
+  end
 end

spec/spec_helper.rb

@@ -6,6 +6,7 @@
 require 'spec'
 require 'spec/autorun'
 require 'yajl'
+require 'json'
 
 def sample_tweets
   if @tweets

spec/tweetstream/client_spec.rb

@@ -53,10 +53,98 @@
 
   describe '#start' do
     before do
+      @stream = stub("Twitter::JSONStream", 
+        :connect => true,
+        :unbind => true, 
+        :each_item => true, 
+        :on_error => true,
+        :on_max_reconnects => true,
+        :connection_completed => true
+      )
+      EM.stub!(:run).and_yield
+      Twitter::JSONStream.stub!(:connect).and_return(@stream)
       @client = TweetStream::Client.new('abc','def')
     end
-
 
+    it 'should try to connect via a JSON stream' do
+      Twitter::JSONStream.should_receive(:connect).with(
+        :auth => 'abc:def',
+        :content => 'track=monday',
+        :path => URI.parse('/1/statuses/filter.json'),
+        :method => 'POST',
+        :user_agent => 'TweetStream'
+      ).and_return(@stream)
+      
+      @client.track('monday')
+    end
+    
+    describe '#each_item' do
+      it 'should call the appropriate parser' do
+        @client = TweetStream::Client.new('abc','def',:active_support)
+        TweetStream::Parsers::ActiveSupport.should_receive(:decode).and_return({})
+        @stream.should_receive(:each_item).and_yield(sample_tweets[0].to_json)
+        @client.track('abc','def')
+      end
+      
+      it 'should yield a TweetStream::Status' do
+        @stream.should_receive(:each_item).and_yield(sample_tweets[0].to_json)
+        @client.track('abc'){|s| s.should be_kind_of(TweetStream::Status)}
+      end
+      
+      it 'should also yield the client if a block with arity 2 is given' do
+        @stream.should_receive(:each_item).and_yield(sample_tweets[0].to_json)
+        @client.track('abc'){|s,c| c.should == @client}
+      end
+      
+      it 'should include the proper values' 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)
+        @client.track('abc') do |s| 
+          s[:id].should == 123
+          s.user.screen_name.should == 'monkey'
+          s.text.should == 'Oo oo aa aa'
+        end
+      end
+      
+      it 'should call the on_delete if specified' do
+        delete = '{ "delete": { "status": { "id": 1234, "user_id": 3 } } }'
+        @stream.should_receive(:each_item).and_yield(delete)
+        @client.on_delete do |id, user_id| 
+          id.should == 1234
+          user_id.should == 3
+        end.track('abc')
+      end
+      
+      it 'should call the on_limit if specified' do
+        limit = '{ "limit": { "track": 1234 } }'
+        @stream.should_receive(:each_item).and_yield(limit)
+        @client.on_limit do |track|
+          track.should == 1234
+        end.track('abc')
+      end
+    end
+    
+    describe '#on_error' do
+      it 'should pass the message on to the error block' do
+        @stream.should_receive(:on_error).and_yield('Uh oh')
+        @client.on_error do |m|
+          m.should == 'Uh oh'
+        end.track('abc')
+      end
+    end
+    
+    describe '#on_max_reconnects' do
+      it 'should raise a ReconnectError' do
+        @stream.should_receive(:on_max_reconnects).and_yield(30, 20)
+        lambda{@client.track('abc')}.should raise_error(TweetStream::ReconnectError) do |e|
+          e.timeout.should == 30
+          e.retries.should == 20
+        end
+      end
+    end
   end
 
   describe ' API methods' do

spec/tweetstream/parser_spec.rb

@@ -24,4 +24,16 @@
       end
     end
   end
+  
+  class FakeParser
+    def self.decode(text)
+      {}
+    end
+  end
+  
+  it 'should be settable to a class' do
+    @client = TweetStream::Client.new('abc','def')
+    @client.parser = FakeParser
+    @client.parser.should == FakeParser
+  end
 end

spec/tweetstream/status_spec.rb

@@ -6,4 +6,10 @@
     @status.user.is_a?(TweetStream::User).should be_true
     @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.id.should == 123
+    @status.user.id.should == 345
+  end
 end