tweetstream 0.1.5 → 0.1.7

data/README.rdoc

@@ -90,6 +90,24 @@ Twitter recommends honoring deletions as quickly as possible, and
 you would likely be wise to integrate this functionality into your
 application.
 
+== Terminating a TweetStream
+
+It is often the case that you will need to change the parameters of your
+track or follow tweet streams. In the case that you need to terminate
+a stream, simply call <tt>TweetStream::Client.stop from within your
+loop:
+
+    # Stop after collecting 10 statuses
+    @statuses = []
+    TweetStream::Client.new('username','password').track('term1', 'term2') do |status|
+      @statuses << status
+      TweetStream::Client.stop if @statuses.size >= 10
+    end
+    
+When <tt>stop</tt> is called, TweetStream will return from the block
+the last successfully yielded status, allowing you to make note of
+it in your application as necessary.
+
 == Daemonizing
 
 It is also possible to create a daemonized script quite easily

data/Rakefile

@@ -16,10 +16,18 @@ begin
     gem.add_dependency 'daemons'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
+namespace :release do
+  %w(patch minor major).each do |level|
+    desc "Tag a #{level} version and push it to Gemcutter."
+    multitask level.to_sym => %w(version:bump:patch release gemcutter:release)
+  end
+end
+
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.7

data/lib/tweetstream/client.rb

@@ -148,9 +148,19 @@ module TweetStream
         elsif hash[:limit] && hash[:limit][:track]
           limit_proc.call(hash[:limit][:track]) if limit_proc.is_a?(Proc)
         elsif hash[:text] && hash[:user]
-          yield TweetStream::Status.new(hash)
+          @last_status = TweetStream::Status.new(hash)
+          yield @last_status
         end
       end
+    rescue TweetStream::Terminated
+      return @last_status
+    rescue Yajl::HttpStream::InvalidContentType
+      raise TweetStream::ConnectionError, "There was an error connecting to the Twitter streaming service. Please check your credentials and the current status of the Streaming API."
+    end
+    
+    # Terminate the currently running TweetStream.
+    def self.stop
+      raise TweetStream::Terminated
     end
  
     protected

data/lib/tweetstream.rb

@@ -3,3 +3,9 @@ require 'tweetstream/hash'
 require 'tweetstream/status'
 require 'tweetstream/user'
 require 'tweetstream/daemon'
+
+module TweetStream
+  class Terminated < ::StandardError; end
+  class Error < ::StandardError; end
+  class ConnectionError < TweetStream::Error; end
+end

data/spec/tweetstream/client_spec.rb

@@ -75,6 +75,11 @@ describe TweetStream::Client do
       @yielded.should be_true
     end
     
+    it 'should wrap Yajl errors in TweetStream errors' do
+      Yajl::HttpStream.should_receive(:get).once.with(URI.parse('http://abc:def@stream.twitter.com/1/cool.json'), :symbolize_keys => true).and_raise(Yajl::HttpStream::InvalidContentType)
+      lambda{@client.start('cool')}.should raise_error(TweetStream::ConnectionError)
+    end
+    
     {
       :delete => {:delete => {:status => {:id => 1234, :user_id => 3}}},
       :limit => {:limit => {:track => 1234}}
@@ -160,4 +165,21 @@ describe TweetStream::Client do
       @client.track('rock')
     end
   end
+  
+  describe '.stop' do
+    it 'should raise a TweetStream::Terminated error' do
+      lambda{ TweetStream::Client.stop }.should raise_error(TweetStream::Terminated)
+    end
+    
+    it 'should not cause a TweetStream to crash with a real exception' do
+      @client = TweetStream::Client.new('abc','def')
+      @statuses = []
+      Yajl::HttpStream.should_receive(:get).once.with(URI.parse('http://abc:def@stream.twitter.com/1/statuses/filter.json?track=musicmonday'), :symbolize_keys => true).and_yield(sample_tweets[0])
+      @client.track('musicmonday') do |status|
+        @statuses << status
+        TweetStream::Client.stop
+      end.should == @statuses.first
+      @statuses.size.should == 1
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tweetstream
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-26 00:00:00 -04:00
+date: 2009-10-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency