tweetstream 2.1.0 → 2.2.0

data/lib/tweetstream/version.rb

@@ -1,3 +1,3 @@
 module TweetStream
-  VERSION = '2.1.0' unless defined?(TweetStream::VERSION)
+  VERSION = '2.2.0' unless defined?(TweetStream::VERSION)
 end

data/spec/fixtures/delete.json

@@ -0,0 +1,8 @@
+{
+  "delete": {
+    "status": {
+      "id": 1234,
+      "user_id": 3
+    }
+  }
+}

data/spec/fixtures/favorite.json

@@ -0,0 +1,150 @@
+{"target":
+  {"id": 598914668,
+   "verified": false,
+   "id_str": "598914668",
+   "profile_background_tile": false,
+   "location": "",
+   "profile_sidebar_fill_color": "DDEEF6",
+   "contributors_enabled": false,
+   "notifications": false,
+   "geo_enabled": false,
+   "profile_image_url_https": "https://si0.twimg.com/profile_images/2276724218/raf46pju0mijc6ixm6ke_normal.jpeg",
+   "utc_offset": null,
+   "default_profile": true,
+   "statuses_count": 151,
+   "name": "dev4sns",
+   "profile_background_color": "C0DEED",
+   "friends_count": 15,
+   "show_all_inline_media": false,
+   "protected": false,
+   "follow_request_sent": false,
+   "screen_name": "dev4sns",
+   "listed_count": 0,
+   "profile_background_image_url": "http://a0.twimg.com/images/themes/theme1/bg.png",
+   "lang": "ko",
+   "profile_link_color": "0084B4",
+   "time_zone": null,
+   "description": "Dev 계정입니다.",
+   "is_translator": false,
+   "profile_use_background_image": true,
+   "url": null,
+   "profile_text_color": "333333",
+   "created_at": "Mon Jun 04 04:07:27 +0000 2012",
+   "default_profile_image": false,
+   "profile_background_image_url_https":
+    "https://si0.twimg.com/images/themes/theme1/bg.png",
+   "favourites_count": 0,
+   "profile_sidebar_border_color": "C0DEED",
+   "profile_image_url":
+    "http://a0.twimg.com/profile_images/2276724218/raf46pju0mijc6ixm6ke_normal.jpeg",
+   "following": true,
+   "followers_count": 5},
+ "target_object":
+  {"id_str": "228029422597443584",
+   "in_reply_to_user_id": null,
+   "truncated": false,
+   "contributors": null,
+   "retweet_count": 0,
+   "possibly_sensitive_editable": true,
+   "favorited": false,
+   "coordinates": null,
+   "geo": null,
+   "possibly_sensitive": false,
+   "user":
+    {"id": 598914668,
+     "verified": false,
+     "id_str": "598914668",
+     "profile_background_tile": false,
+     "location": "",
+     "profile_sidebar_fill_color": "DDEEF6",
+     "contributors_enabled": false,
+     "notifications": false,
+     "geo_enabled": false,
+     "profile_image_url_https":
+      "https://si0.twimg.com/profile_images/2276724218/raf46pju0mijc6ixm6ke_normal.jpeg",
+     "utc_offset": null,
+     "default_profile": true,
+     "statuses_count": 151,
+     "name": "dev4sns",
+     "profile_background_color": "C0DEED",
+     "friends_count": 15,
+     "show_all_inline_media": false,
+     "protected": false,
+     "follow_request_sent": false,
+     "screen_name": "dev4sns",
+     "listed_count": 0,
+     "profile_background_image_url":
+      "http://a0.twimg.com/images/themes/theme1/bg.png",
+     "lang": "ko",
+     "profile_link_color": "0084B4",
+     "time_zone": null,
+     "description": "Dev 계정입니다.",
+     "is_translator": false,
+     "profile_use_background_image": true,
+     "url": null,
+     "profile_text_color": "333333",
+     "created_at": "Mon Jun 04 04:07:27 +0000 2012",
+     "default_profile_image": false,
+     "profile_background_image_url_https":
+      "https://si0.twimg.com/images/themes/theme1/bg.png",
+     "favourites_count": 0,
+     "profile_sidebar_border_color": "C0DEED",
+     "profile_image_url":
+      "http://a0.twimg.com/profile_images/2276724218/raf46pju0mijc6ixm6ke_normal.jpeg",
+     "following": true,
+     "followers_count": 5},
+   "in_reply_to_status_id_str": null,
+   "in_reply_to_screen_name": null,
+   "source": "<a href=\"http://www.a2m.co.kr\" rel=\"nofollow\">Dev Acct</a>",
+   "in_reply_to_user_id_str": null,
+   "retweeted": false,
+   "in_reply_to_status_id": null,
+   "id": 228029422597443584,
+   "place": null,
+   "text": "asdf http://t.co/CRX3fCRa",
+   "created_at": "Wed Jul 25 07:30:25 +0000 2012"},
+ "source":
+  {"id": 459909498,
+   "verified": false,
+   "id_str": "459909498",
+   "profile_background_tile": false,
+   "location": "",
+   "profile_sidebar_fill_color": "DDEEF6",
+   "contributors_enabled": false,
+   "notifications": false,
+   "geo_enabled": false,
+   "profile_image_url_https":
+    "https://si0.twimg.com/sticky/default_profile_images/default_profile_6_normal.png",
+   "utc_offset": null,
+   "default_profile": true,
+   "statuses_count": 124,
+   "name": "Brian Park",
+   "profile_background_color": "C0DEED",
+   "friends_count": 3,
+   "show_all_inline_media": false,
+   "protected": false,
+   "follow_request_sent": false,
+   "screen_name": "bdares",
+   "listed_count": 0,
+   "profile_background_image_url":
+    "http://a0.twimg.com/images/themes/theme1/bg.png",
+   "lang": "en",
+   "profile_link_color": "0084B4",
+   "time_zone": null,
+   "description": "",
+   "is_translator": false,
+   "profile_use_background_image": true,
+   "url": null,
+   "profile_text_color": "333333",
+   "created_at": "Tue Jan 10 05:33:52 +0000 2012",
+   "default_profile_image": true,
+   "profile_background_image_url_https":
+    "https://si0.twimg.com/images/themes/theme1/bg.png",
+   "favourites_count": 14,
+   "profile_sidebar_border_color": "C0DEED",
+   "profile_image_url":
+    "http://a0.twimg.com/sticky/default_profile_images/default_profile_6_normal.png",
+   "following": false,
+   "followers_count": 1},
+ "event": "favorite",
+ "created_at": "Mon Aug 06 02:24:16 +0000 2012"}

data/spec/fixtures/limit.json

@@ -0,0 +1,5 @@
+{
+  "limit": {
+    "track": 1234
+  }
+}

data/spec/fixtures/scrub_geo.json

@@ -0,0 +1,8 @@
+{
+  "scrub_geo": {
+    "user_id": 1234,
+    "user_id_str": "1234",
+    "up_to_status_id":9876,
+    "up_to_status_id_string": "9876"
+  }
+}

data/spec/fixtures/status_withheld.json

@@ -0,0 +1,7 @@
+{
+  "status_withheld":{
+      "id":1234567890,
+      "user_id":123456,
+      "withheld_in_countries":["de", "ar"]
+  }
+}

data/spec/fixtures/user_withheld.json

@@ -0,0 +1,6 @@
+{
+  "user_withheld":{
+    "id":123456,
+    "withheld_in_countries":["de","ar"]
+  }
+}

data/spec/spec_helper.rb

@@ -13,24 +13,22 @@ require 'webmock/rspec'
 require 'yajl'
 require 'json'
 
+def samples(fixture)
+  samples = []
+  Yajl::Parser.parse(fixture(fixture), :symbolize_keys => true) do |hash|
+    samples << hash
+  end
+  samples
+end
+
 def sample_tweets
   return @tweets if @tweets
-
-  @tweets = []
-  Yajl::Parser.parse(fixture('statuses.json'), :symbolize_keys => true) do |hash|
-    @tweets << hash
-  end
-  @tweets
+  @tweets = samples('statuses.json')
 end
 
 def sample_direct_messages
   return @direct_messages if @direct_messages
-
-  @direct_messages = []
-  Yajl::Parser.parse(fixture('direct_messages.json'), :symbolize_keys => true) do |hash|
-    @direct_messages << hash
-  end
-  @direct_messages
+  @direct_messages = samples('direct_messages.json')
 end
 
 def fixture_path

data/spec/tweetstream/client_authentication_spec.rb

@@ -31,7 +31,7 @@ describe TweetStream::Client do
 
     it 'should try to connect via a JSON stream with basic auth' do
       EM::Twitter::Client.should_receive(:connect).with(
-        :path => URI.parse('/1/statuses/filter.json'),
+        :path => '/1/statuses/filter.json',
         :method => 'POST',
         :user_agent => TweetStream::Configuration::DEFAULT_USER_AGENT,
         :on_inited => nil,
@@ -61,7 +61,7 @@ describe TweetStream::Client do
 
     it 'should try to connect via a JSON stream with oauth' do
       EM::Twitter::Client.should_receive(:connect).with(
-        :path => URI.parse('/1/statuses/filter.json'),
+        :path => '/1/statuses/filter.json',
         :method => 'POST',
         :user_agent => TweetStream::Configuration::DEFAULT_USER_AGENT,
         :on_inited => nil,

data/spec/tweetstream/client_site_stream_spec.rb

@@ -34,27 +34,27 @@ describe TweetStream::Client do
       end
 
       it "uses the sitestream uri" do
-        EM::Twitter::Client.should_receive(:connect).with(hash_including(:path => "/2b/site.json")).and_return(@stream)
+        @client.should_receive(:start).once.with('/2b/site.json', an_instance_of(Hash)).and_return(@stream)
         @client.sitestream
       end
 
       it 'supports "with followings" when followings set as a boolean' do
-        @client.should_receive(:start).once.with('', hash_including(:with => 'followings')).and_return(@stream)
+        @client.should_receive(:start).once.with('/2b/site.json', hash_including(:with => 'followings')).and_return(@stream)
         @client.sitestream(['115192457'], :followings => true)
       end
 
       it 'supports "with followings" when followings set as an option' do
-        @client.should_receive(:start).once.with('', hash_including(:with => 'followings')).and_return(@stream)
+        @client.should_receive(:start).once.with('/2b/site.json', hash_including(:with => 'followings')).and_return(@stream)
         @client.sitestream(['115192457'], :with => 'followings')
       end
 
       it 'supports "with user"' do
-        @client.should_receive(:start).once.with('', hash_including(:with => 'user')).and_return(@stream)
+        @client.should_receive(:start).once.with('/2b/site.json', hash_including(:with => 'user')).and_return(@stream)
         @client.sitestream(['115192457'], :with => 'user')
       end
 
       it 'supports "replies all"' do
-        @client.should_receive(:start).once.with('', hash_including(:replies => 'all')).and_return(@stream)
+        @client.should_receive(:start).once.with('/2b/site.json', hash_including(:replies => 'all')).and_return(@stream)
         @client.sitestream(['115192457'], :replies => 'all')
       end
 

data/spec/tweetstream/client_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe TweetStream::Client do
   before(:each) do
     TweetStream.configure do |config|
@@ -11,42 +9,6 @@ describe TweetStream::Client do
     @client = TweetStream::Client.new
   end
 
-  describe '#build_uri' do
-    it 'should return a URI' do
-      @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
-      @client.send(:build_uri, 'awesome').path.should == '/1/awesome.json'
-    end
-
-    it 'should add on a query string if such parameters are specified' do
-      @client.send(:build_uri, 'awesome', :q => 'abc').query.should == 'q=abc'
-    end
-  end
-
-  describe '#build_post_body' do
-    it 'should return a blank string if passed a nil value' do
-      @client.send(:build_post_body, nil).should == ''
-    end
-
-    it 'should return a blank string if passed an empty hash' do
-      @client.send(:build_post_body, {}).should == ''
-    end
-
-    it 'should add a query parameter for a key' do
-      @client.send(:build_post_body, {:query => 'abc'}).should == 'query=abc'
-    end
-
-    it 'should escape characters in the value' do
-      @client.send(:build_post_body, {:query => 'awesome guy'}).should == 'query=awesome+guy'
-    end
-
-    it 'should join multiple pairs together' do
-      ['a=b&c=d','c=d&a=b'].include?(@client.send(:build_post_body, {:a => 'b', :c => 'd'})).should be_true
-    end
-  end
-
   describe '#start' do
     before do
       @stream = stub("EM::Twitter::Client",
@@ -76,6 +38,12 @@ describe TweetStream::Client do
       @client.track('abc')
     end
 
+    it 'warns when callbacks are passed as options' do
+      @stream.stub(:each).and_yield(nil)
+      Kernel.should_receive(:warn).with(/Passing callbacks via the options hash is deprecated and will be removed in TweetStream 3.0/)
+      @client.track('abc', :inited => Proc.new { })
+    end
+
     describe '#each' do
       it 'calls the appropriate parser' do
         @client = TweetStream::Client.new
@@ -84,9 +52,9 @@ describe TweetStream::Client do
         @client.track('abc','def')
       end
 
-      it 'yields a Twitter::Status' do
+      it 'yields a Twitter::Tweet' do
         @stream.should_receive(:each).and_yield(sample_tweets[0].to_json)
-        @client.track('abc'){|s| s.should be_kind_of(Twitter::Status)}
+        @client.track('abc'){|s| s.should be_kind_of(Twitter::Tweet)}
       end
 
       it 'yields the client if a block with arity 2 is given' do
@@ -108,8 +76,7 @@ describe TweetStream::Client do
       end
 
       it 'should call the on_scrub_geo callback if specified' do
-        scrub_geo = '{ "scrub_geo": { "user_id": 1234, "user_id_str": "1234", "up_to_status_id":9876, "up_to_status_id_string": "9876" } }'
-        @stream.should_receive(:each).and_yield(scrub_geo)
+        @stream.should_receive(:each).and_yield(fixture('scrub_geo.json'))
         @client.on_scrub_geo do |up_to_status_id, user_id|
           up_to_status_id.should == 9876
           user_id.should == 1234
@@ -117,8 +84,7 @@ describe TweetStream::Client do
       end
 
       it 'calls the on_delete callback' do
-        delete = '{ "delete": { "status": { "id": 1234, "user_id": 3 } } }'
-        @stream.should_receive(:each).and_yield(delete)
+        @stream.should_receive(:each).and_yield(fixture('delete.json'))
         @client.on_delete do |id, user_id|
           id.should == 1234
           user_id.should == 3
@@ -126,11 +92,33 @@ describe TweetStream::Client do
       end
 
       it 'calls the on_limit callback' do
-        limit = '{ "limit": { "track": 1234 } }'
-        @stream.should_receive(:each).and_yield(limit)
-        @client.on_limit do |track|
-          track.should == 1234
+        limit = nil
+        @stream.should_receive(:each).and_yield(fixture('limit.json'))
+        @client.on_limit do |l|
+          limit = l
         end.track('abc')
+
+        limit.should eq(1234)
+      end
+
+      it 'calls the on_status_withheld callback' do
+        status = nil
+        @stream.should_receive(:each).and_yield(fixture('status_withheld.json'))
+        @client.on_status_withheld do |s|
+          status = s
+        end.track('abc')
+
+        status[:user_id].should eq(123456)
+      end
+
+      it 'calls the on_user_withheld callback' do
+        status = nil
+        @stream.should_receive(:each).and_yield(fixture('user_withheld.json'))
+        @client.on_user_withheld do |s|
+          status = s
+        end.track('abc')
+
+        status[:id].should eq(123456)
       end
 
       context "using on_anything" do
@@ -138,11 +126,12 @@ describe TweetStream::Client do
           hash = {:id => 1234}
           @stream.should_receive(:each).and_yield(hash.to_json)
           yielded_hash = nil
-          @client.on_anything do |hash|
-            yielded_hash = hash
+          @client.on_anything do |h|
+            yielded_hash = h
           end.track('abc')
+
           yielded_hash.should_not be_nil
-          yielded_hash[:id].should == 1234
+          yielded_hash[:id].should eq(1234)
         end
         it 'yields itself if block has an arity of 2' do
           hash = {:id => 1234}
@@ -244,7 +233,7 @@ describe TweetStream::Client do
     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, "Failed to reconnect after 20 tries.")
+        lambda{ @client.track('abc') }.should raise_error(TweetStream::ReconnectError, "Failed to reconnect after 20 tries.")
       end
     end
   end
@@ -252,64 +241,64 @@ describe TweetStream::Client do
   describe 'API methods' do
     %w(firehose retweet sample links).each do |method|
       it "##{method} should make a call to start with \"statuses/#{method}\"" do
-        @client.should_receive(:start).once.with('statuses/' + method, {})
+        @client.should_receive(:start).once.with('/1/statuses/' + method + '.json', {})
         @client.send(method)
       end
     end
 
     describe '#filter' do
       it 'makes a call to "statuses/filter" with the query params provided' do
-        @client.should_receive(:start).once.with('statuses/filter', :follow => 123, :method => :post)
+        @client.should_receive(:start).once.with('/1/statuses/filter.json', :follow => 123, :method => :post)
         @client.filter(:follow => 123)
       end
       it 'makes a call to "statuses/filter" with the query params provided longitude/latitude pairs, separated by commas ' do
-        @client.should_receive(:start).once.with('statuses/filter', :locations => '-122.75,36.8,-121.75,37.8,-74,40,-73,41', :method => :post)
+        @client.should_receive(:start).once.with('/1/statuses/filter.json', :locations => '-122.75,36.8,-121.75,37.8,-74,40,-73,41', :method => :post)
         @client.filter(:locations => '-122.75,36.8,-121.75,37.8,-74,40,-73,41')
       end
     end
 
     describe '#follow' do
       it 'makes a call to start with "statuses/filter" and a follow query parameter' do
-        @client.should_receive(:start).once.with('statuses/filter', :follow => [123], :method => :post)
+        @client.should_receive(:start).once.with('/1/statuses/filter.json', :follow => [123], :method => :post)
         @client.follow(123)
       end
 
       it 'comma-joins multiple arguments' do
-        @client.should_receive(:start).once.with('statuses/filter', :follow => [123,456], :method => :post)
+        @client.should_receive(:start).once.with('/1/statuses/filter.json', :follow => [123,456], :method => :post)
         @client.follow(123, 456)
       end
     end
 
     describe '#locations' do
       it 'should call #start with "statuses/filter" with the query params provided longitude/latitude pairs' do
-        @client.should_receive(:start).once.with('statuses/filter', :locations => ['-122.75,36.8,-121.75,37.8,-74,40,-73,41'], :method => :post)
+        @client.should_receive(:start).once.with('/1/statuses/filter.json', :locations => ['-122.75,36.8,-121.75,37.8,-74,40,-73,41'], :method => :post)
         @client.locations('-122.75,36.8,-121.75,37.8,-74,40,-73,41')
       end
 
       it 'should call #start with "statuses/filter" with the query params provided longitude/latitude pairs and additional filter' do
-        @client.should_receive(:start).once.with('statuses/filter', :locations => ['-122.75,36.8,-121.75,37.8,-74,40,-73,41'], :track => 'rock', :method => :post)
+        @client.should_receive(:start).once.with('/1/statuses/filter.json', :locations => ['-122.75,36.8,-121.75,37.8,-74,40,-73,41'], :track => 'rock', :method => :post)
         @client.locations('-122.75,36.8,-121.75,37.8,-74,40,-73,41', :track => 'rock')
       end
     end
 
     describe '#track' do
       it 'makes a call to start with "statuses/filter" and a track query parameter' do
-        @client.should_receive(:start).once.with('statuses/filter', :track => ['test'], :method => :post)
+        @client.should_receive(:start).once.with('/1/statuses/filter.json', :track => ['test'], :method => :post)
         @client.track('test')
       end
 
       it 'comma-joins multiple arguments' do
-        @client.should_receive(:start).once.with('statuses/filter', :track => ['foo', 'bar', 'baz'], :method => :post)
+        @client.should_receive(:start).once.with('/1/statuses/filter.json', :track => ['foo', 'bar', 'baz'], :method => :post)
         @client.track('foo', 'bar', 'baz')
       end
 
       it 'comma-joins an array of arguments' do
-        @client.should_receive(:start).once.with('statuses/filter', :track => [['foo','bar','baz']], :method => :post)
+        @client.should_receive(:start).once.with('/1/statuses/filter.json', :track => [['foo','bar','baz']], :method => :post)
         @client.track(['foo','bar','baz'])
       end
 
       it 'should call #start with "statuses/filter" and the provided queries' do
-        @client.should_receive(:start).once.with('statuses/filter', :track => ['rock'], :method => :post)
+        @client.should_receive(:start).once.with('/1/statuses/filter.json', :track => ['rock'], :method => :post)
         @client.track('rock')
       end
     end