tweetstream 0.1.3 → 0.1.4

data/README.rdoc

@@ -47,6 +47,49 @@ user ids:
 The methods available to TweetStream::Client will be kept in parity
 with the methods available on the Streaming API wiki page.
 
+== Handling Deletes and Rate Limitations
+
+Sometimes the Streaming API will send messages other than statuses.
+Specifically, it does so when a status is deleted or rate limitations
+have caused some tweets not to appear in the stream. To handle these,
+you can use the on_delete and on_limit methods. Example:
+
+    @client = TweetStream::Client.new('user','pass')
+    
+    @client.on_delete do |status_id, user_id|
+      Tweet.delete(status_id)
+    end
+    
+    @client.on_limit do |skip_count|
+      # do something
+    end  
+    
+    @client.track('intridea')
+    
+The on_delete and on_limit methods can also be chained, like so:
+
+    TweetStream::Client.new('user','pass').on_delete{ |status_id, user_id|
+      Tweet.delete(status_id)
+    }.on_limit { |skip_count|
+      # do something
+    }.track('intridea') do |status|
+      # do something with the status like normal
+    end
+    
+You can also provide <tt>:delete</tt> and/or <tt>:limit</tt> 
+options when you make your method call:
+
+    TweetStream::Client.new('user','pass').track('intridea',
+      :delete => Proc.new{ |status_id, user_id| # do something },
+      :limit => Proc.new{ |skip_count| # do something }
+    ) do |status
+      # do something with the status like normal
+    end
+    
+Twitter recommends honoring deletions as quickly as possible, and
+you would likely be wise to integrate this functionality into your
+application.
+
 == Daemonizing
 
 It is also possible to create a daemonized script quite easily

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/tweetstream/client.rb

@@ -94,11 +94,62 @@ module TweetStream
       start('statuses/filter', query_params, &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.on_delete do |status_id, user_id|
+    #       Tweet.delete(status_id)
+    #     end
+    #
+    # Block must take two arguments: the status id and the user id.
+    # If no block is given, it will return the currently set 
+    # deletion proc. When a block is given, the TweetStream::Client
+    # object is returned to allow for chaining.
+    def on_delete(&block)
+      if block_given?
+        @on_delete = block
+        self
+      else
+        @on_delete
+      end
+    end
+    
+    # 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.on_limit do |discarded_count|
+    #       # Make note of discarded count
+    #     end
+    #
+    # Block must take one argument: the number of discarded tweets.
+    # If no block is given, it will return the currently set 
+    # limit proc. When a block is given, the TweetStream::Client
+    # object is returned to allow for chaining.
+    def on_limit(&block)
+      if block_given?
+        @on_limit = block
+        self
+      else
+        @on_limit
+      end
+    end
+    
     def start(path, query_parameters = {}, &block) #:nodoc:
-      uri = build_uri(path, query_parameters)
+      delete_proc = query_parameters.delete(:delete) || self.on_delete
+      limit_proc = query_parameters.delete(:limit) || self.on_limit
       
+      uri = build_uri(path, query_parameters)
+            
       Yajl::HttpStream.get(uri, :symbolize_keys => true) do |hash|
-        yield TweetStream::Status.new(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[:text] && hash[:user]
+          yield TweetStream::Status.new(hash)
+        end
       end
     end
  

data/spec/spec_helper.rb

@@ -12,7 +12,7 @@ def sample_tweets
     @tweets
   else
     @tweets = []
-    Yajl::Parser.parse(File.open(File.dirname(__FILE__) + '/data/statuses.json', 'r')) do |hash|
+    Yajl::Parser.parse(File.open(File.dirname(__FILE__) + '/data/statuses.json', 'r'), :symbolize_keys => true) do |hash|
       @tweets << hash
     end
     @tweets

data/spec/tweetstream/client_spec.rb

@@ -74,6 +74,28 @@ describe TweetStream::Client do
       end
       @yielded.should be_true
     end
+    
+    {
+      :delete => {:delete => {:status => {:id => 1234, :user_id => 3}}},
+      :limit => {:limit => {:track => 1234}}
+    }.each_pair do |special_method, special_object|
+      it "should make a call to the #{special_method} proc if a #{special_method} object is given" do
+        @called = false
+        @proc = Proc.new{|*args| @called = true }
+        @client.send("on_#{special_method}", &@proc)
+        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(special_object)
+        @client.track('musicmonday')
+        @called.should == true
+      end
+      
+      it "should accept a proc on a :#{special_method} option if a #{special_method} object is given" do
+        @called = false
+        @proc = Proc.new{|*args| @called = true }
+        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(special_object)
+        @client.track('musicmonday', special_method => @proc)
+        @called.should == true
+      end
+    end
   end
   
   describe ' API methods' do
@@ -113,6 +135,20 @@ describe TweetStream::Client do
       @client.filter(:follow => 123)
     end
   end
+  
+  %w(on_delete on_limit).each do |proc_setter|
+    describe "##{proc_setter}" do
+      before do
+        @client = TweetStream::Client.new('abc','def')
+      end
+      
+      it 'should set when a block is given' do
+        proc = Proc.new{|a,b| puts a }
+        @client.send(proc_setter, &proc)
+        @client.send(proc_setter).should == proc
+      end
+    end
+  end
 
   describe '#track' do
     before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tweetstream
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Michael Bleigh