twitter 4.1.2 → 4.2.0

data/CHANGELOG.md

@@ -1,6 +1,14 @@
+4.2.0
+-----
+* [Use new resource for `Twitter::API#retweets_of_me`](https://github.com/sferik/twitter/commit/d88ca1e91af06e748c31dcda287326028cf28258)
+* [`Twitter::API#favorite` no longer raises `Twitter::Error::Forbidden`](https://github.com/sferik/twitter/commit/65c01133a96106a6b0c61bc16cb2ffec38fa5e25)
+* [`Twitter::API#retweet` no longer raises `Twitter::Error::Forbidden`](https://github.com/sferik/twitter/commit/f1322ab12c573229ea3dc8decda2e2ea8b36fc31)
+* [Add `Twitter::Error::AlreadyFavorited`](https://github.com/sferik/twitter/commit/34710927e00d4dc5abc049bfc198bdd337fba1bd)
+* [Add `Twitter::Error::AlreadyRetweeted`](https://github.com/sferik/twitter/commit/2a231a0888dcd65dbef2dc92571e06d50f845cca)
+
 4.1.2
 -----
-* [Add abort_on_exception to threaded_map](https://github.com/sferik/twitter/commit/15c9a7c221f24226c1003b76b287d2b2ed9306cb)
+* [Add abort_on_exception to `Enumerable#threaded_map`](https://github.com/sferik/twitter/commit/15c9a7c221f24226c1003b76b287d2b2ed9306cb) ([@aheaven87](http://twitter.com/aheaven87))
 
 4.1.1
 -----

data/README.md

@@ -216,7 +216,7 @@ Twitter.update("I'm tweeting with @gem!")
 Applications that make requests on behalf of multiple Twitter users should
 avoid using global configuration. In this case, you may still specify the
 `consumer_key` and `consumer_secret` globally. (In a Rails application, this
-could go in `config/initiliazers/twitter.rb`.)
+could go in `config/initializers/twitter.rb`.)
 
 ```ruby
 Twitter.configure do |config|

data/lib/twitter/api.rb

@@ -6,6 +6,8 @@ require 'twitter/core_ext/hash'
 require 'twitter/core_ext/kernel'
 require 'twitter/cursor'
 require 'twitter/direct_message'
+require 'twitter/error/already_favorited'
+require 'twitter/error/already_retweeted'
 require 'twitter/error/forbidden'
 require 'twitter/error/not_found'
 require 'twitter/language'
@@ -1372,7 +1374,7 @@ module Twitter
     # @option options [String] :until Optional. Returns tweets generated before the given date. Date should be formatted as YYYY-MM-DD.
     # @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.
     # @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
-    # @option options [Boolean, String, Integer] :include_entities Specifies that each tweet should include an 'entities' node including metadata about the tweet such as: user_mentions, urls, and hashtags.
+    # @option options [Boolean, String, Integer] :include_entities The tweet entities node will be disincluded when set to false.
     # @return [Twitter::SearchResults] Return tweets that match a specified query with search metadata
     # @example Returns tweets related to twitter
     #   Twitter.search('twitter')
@@ -1443,13 +1445,50 @@ module Twitter
     def favorite(*args)
       options = args.extract_options!
       args.flatten.threaded_map do |id|
-        object_from_response(Twitter::Tweet, :post, "/1.1/favorites/create.json", options.merge(:id => id))
-      end
+        begin
+          object_from_response(Twitter::Tweet, :post, "/1.1/favorites/create.json", options.merge(:id => id))
+        rescue Twitter::Error::Forbidden => error
+          raise unless error.message == Twitter::Error::AlreadyFavorited::MESSAGE
+        end
+      end.compact
     end
     alias fav favorite
     alias fave favorite
     alias favorite_create favorite
 
+    # Favorites the specified Tweets as the authenticating user and raises an error if one has already been favorited
+    #
+    # @see https://dev.twitter.com/docs/api/1.1/post/favorites/create
+    # @rate_limited No
+    # @authentication_required Requires user context
+    # @raise [Twitter::Error::AlreadyFavorited] Error raised when tweet has already been favorited.
+    # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+    # @return [Array<Twitter::Tweet>] The favorited Tweets.
+    # @overload favorite(*ids)
+    #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
+    #   @example Favorite the Tweet with the ID 25938088801
+    #     Twitter.favorite(25938088801)
+    # @overload favorite(*ids, options)
+    #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
+    #   @param options [Hash] A customizable set of options.
+    def favorite!(*args)
+      options = args.extract_options!
+      args.flatten.threaded_map do |id|
+        begin
+          object_from_response(Twitter::Tweet, :post, "/1.1/favorites/create.json", options.merge(:id => id))
+        rescue Twitter::Error::Forbidden => error
+          if error.message == "You have already favorited this status"
+            raise Twitter::Error::AlreadyFavorited.new("Tweet with the ID #{id} has already been favorited by the authenticated user.")
+          else
+            raise
+          end
+        end
+      end
+    end
+    alias fav! favorite!
+    alias fave! favorite!
+    alias favorite_create! favorite!
+
     # Un-favorites the specified Tweets as the authenticating user
     #
     # @see https://dev.twitter.com/docs/api/1.1/post/favorites/destroy
@@ -1488,7 +1527,7 @@ module Twitter
     # @option options [Boolean, String, Integer] :exclude_replies This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count tweets - this is because the count parameter retrieves that many tweets before filtering out retweets and replies.
     # @option options [Boolean, String, Integer] :include_rts Specifies that the timeline should include native retweets in addition to regular tweets. Note: If you're using the trim_user parameter in conjunction with include_rts, the retweets will no longer contain a full user object.
     # @option options [Boolean, String, Integer] :contributor_details Specifies that the contributors element should be enhanced to include the screen_name of the contributor.
-    # @option options [Boolean, String, Integer] :include_entities Specifies that each tweet should include an 'entities' node including metadata about the tweet such as: user_mentions, urls, and hashtags.
+    # @option options [Boolean, String, Integer] :include_entities The tweet entities node will be disincluded when set to false.
     # @example Return the 20 most recent Tweets, including retweets if they exist, posted by the authenticating user and the users they follow
     #   Twitter.home_timeline
     def home_timeline(options={})
@@ -1583,7 +1622,7 @@ module Twitter
     # @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
     # @option options [Boolean, String, Integer] :exclude_replies This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count tweets - this is because the count parameter retrieves that many tweets before filtering out retweets and replies.
     # @option options [Boolean, String, Integer] :contributor_details Specifies that the contributors element should be enhanced to include the screen_name of the contributor.
-    # @option options [Boolean, String, Integer] :include_entities Specifies that each tweet should include an 'entities' node including metadata about the tweet such as: user_mentions, urls, and hashtags.
+    # @option options [Boolean, String, Integer] :include_entities The tweet entities node will be disincluded when set to false.
     # @example Return the 20 most recent retweets posted by users followed by the authenticating user
     #   Twitter.retweeted_to_me
     def retweeted_to_me(options={})
@@ -1596,27 +1635,22 @@ module Twitter
 
     # Returns the 20 most recent tweets of the authenticated user that have been retweeted by others
     #
-    # @see https://dev.twitter.com/docs/api/1.1/get/statuses/user_timeline
-    # @note This method can only return up to 3,200 Tweets.
+    # @see https://dev.twitter.com/docs/api/1.1/get/statuses/retweets_of_me
     # @rate_limited Yes
     # @authentication_required Requires user context
     # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
     # @return [Array<Twitter::Tweet>]
     # @param options [Hash] A customizable set of options.
+    # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
     # @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
     # @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
-    # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
     # @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
-    # @option options [Boolean, String, Integer] :exclude_replies This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count tweets - this is because the count parameter retrieves that many tweets before filtering out retweets and replies.
-    # @option options [Boolean, String, Integer] :contributor_details Specifies that the contributors element should be enhanced to include the screen_name of the contributor.
+    # @option options [Boolean, String, Integer] :include_entities The tweet entities node will be disincluded when set to false.
+    # @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
     # @example Return the 20 most recent tweets of the authenticated user that have been retweeted by others
     #   Twitter.retweets_of_me
     def retweets_of_me(options={})
-      options[:include_rts] = false
-      count = options[:count] || DEFAULT_TWEETS_PER_REQUEST
-      collect_with_count(count) do |count_options|
-        user_timeline(options.merge(count_options)).select{|tweet| tweet.retweet_count.to_i > 0}
-      end
+      collection_from_response(Twitter::Tweet, :get, "/1.1/statuses/retweets_of_me.json", options)
     end
 
     # Returns the 20 most recent Tweets posted by the specified user
@@ -1847,12 +1881,11 @@ module Twitter
     end
     alias tweet_destroy status_destroy
 
-    # Retweets tweets
+    # Retweets the specified Tweets as the authenticating user
     #
     # @see https://dev.twitter.com/docs/api/1.1/post/statuses/retweet/:id
     # @rate_limited Yes
     # @authentication_required Requires user context
-    # @raise [Twitter::Error::Forbidden] Error raised when tweet has already been retweeted.
     # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
     # @return [Array<Twitter::Tweet>] The original tweets with retweet details embedded.
     # @overload retweet(*ids)
@@ -1866,12 +1899,51 @@ module Twitter
     def retweet(*args)
       options = args.extract_options!
       args.flatten.threaded_map do |id|
-        response = post("/1.1/statuses/retweet/#{id}.json", options)
-        retweeted_status = response.dup
-        retweeted_status[:body] = response[:body].delete(:retweeted_status)
-        retweeted_status[:body][:retweeted_status] = response[:body]
-        Twitter::Tweet.from_response(retweeted_status)
-      end
+        begin
+          response = post("/1.1/statuses/retweet/#{id}.json", options)
+          retweeted_status = response.dup
+          retweeted_status[:body] = response[:body].delete(:retweeted_status)
+          retweeted_status[:body][:retweeted_status] = response[:body]
+          Twitter::Tweet.from_response(retweeted_status)
+        rescue Twitter::Error::Forbidden => error
+          raise unless error.message == Twitter::Error::AlreadyRetweeted::MESSAGE
+        end
+      end.compact
+    end
+
+    # Retweets the specified Tweets as the authenticating user and raises an error if one has already been retweeted
+    #
+    # @see https://dev.twitter.com/docs/api/1.1/post/statuses/retweet/:id
+    # @rate_limited Yes
+    # @authentication_required Requires user context
+    # @raise [Twitter::Error::AlreadyRetweeted] Error raised when tweet has already been retweeted.
+    # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+    # @return [Array<Twitter::Tweet>] The original tweets with retweet details embedded.
+    # @overload retweet(*ids)
+    #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
+    #   @example Retweet the Tweet with the ID 28561922516
+    #     Twitter.retweet(28561922516)
+    # @overload retweet(*ids, options)
+    #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
+    #   @param options [Hash] A customizable set of options.
+    #   @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
+    def retweet!(*args)
+      options = args.extract_options!
+      args.flatten.threaded_map do |id|
+        begin
+          response = post("/1.1/statuses/retweet/#{id}.json", options)
+          retweeted_status = response.dup
+          retweeted_status[:body] = response[:body].delete(:retweeted_status)
+          retweeted_status[:body][:retweeted_status] = response[:body]
+          Twitter::Tweet.from_response(retweeted_status)
+        rescue Twitter::Error::Forbidden => error
+          if error.message == "sharing is not permissible for this status (Share validations failed)"
+            raise Twitter::Error::AlreadyRetweeted.new("Tweet with the ID #{id} has already been retweeted by the authenticated user.")
+          else
+            raise
+          end
+        end
+      end.compact
     end
 
     # Updates the authenticating user's status

data/lib/twitter/basic_user.rb

@@ -4,5 +4,8 @@ module Twitter
   class BasicUser < Twitter::Identity
     attr_reader :following, :screen_name
     alias following? following
+    alias handle screen_name
+    alias username screen_name
+    alias user_name screen_name
   end
 end

data/lib/twitter/core_ext/enumerable.rb

@@ -1,15 +1,23 @@
 module Enumerable
 
   def threaded_map
+    abort_on_exception do
+      threads = []
+      each do |object|
+        threads << Thread.new { yield object }
+      end
+      threads.map(&:value)
+    end
+  end
+
+  private
+
+  def abort_on_exception
     initial_abort_on_exception = Thread.abort_on_exception
     Thread.abort_on_exception ||= true
-    threads = []
-    each do |object|
-      threads << Thread.new { yield object }
-    end
-    values = threads.map(&:value)
+    value = yield
     Thread.abort_on_exception = initial_abort_on_exception
-    values
+    value
   end
 
 end

data/lib/twitter/error/already_favorited.rb

@@ -0,0 +1,10 @@
+require 'twitter/error/forbidden'
+
+module Twitter
+  class Error
+    # Raised when a Tweet has already been favorited
+    class AlreadyFavorited < Twitter::Error::Forbidden
+      MESSAGE = "You have already favorited this status"
+    end
+  end
+end

data/lib/twitter/error/already_retweeted.rb

@@ -0,0 +1,10 @@
+require 'twitter/error/forbidden'
+
+module Twitter
+  class Error
+    # Raised when a Tweet has already been retweeted
+    class AlreadyRetweeted < Twitter::Error::Forbidden
+      MESSAGE = "sharing is not permissible for this status (Share validations failed)"
+    end
+  end
+end

data/lib/twitter/version.rb

@@ -1,8 +1,8 @@
 module Twitter
   class Version
     MAJOR = 4 unless defined? Twitter::MAJOR
-    MINOR = 1 unless defined? Twitter::MINOR
-    PATCH = 2 unless defined? Twitter::PATCH
+    MINOR = 2 unless defined? Twitter::MINOR
+    PATCH = 0 unless defined? Twitter::PATCH
     PRE = nil unless defined? Twitter::PRE
 
     class << self

data/spec/fixtures/already_favorited.json

@@ -0,0 +1 @@
+{"errors":[{"message":"You have already favorited this status","code":139}]}

data/spec/fixtures/already_retweeted.json

@@ -0,0 +1 @@
+{"errors":"sharing is not permissible for this status (Share validations failed)"}

data/spec/twitter/api/statuses_spec.rb

@@ -53,6 +53,46 @@ describe Twitter::API do
       expect(tweets.first).to be_a Twitter::Tweet
       expect(tweets.first.text).to eq "The problem with your code is that it's doing exactly what you told it to do."
     end
+    context "already favorited" do
+      before do
+        stub_post("/1.1/favorites/create.json").with(:body => {:id => "25938088801"}).to_return(:status => 403, :body => fixture("already_favorited.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+      it "does not raises an error" do
+        expect{@client.favorite(25938088801)}.not_to raise_error
+      end
+    end
+  end
+
+  describe "#favorite!" do
+    before do
+      stub_post("/1.1/favorites/create.json").with(:body => {:id => "25938088801"}).to_return(:body => fixture("status.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+    it "requests the correct resource" do
+      @client.favorite!(25938088801)
+      expect(a_post("/1.1/favorites/create.json").with(:body => {:id => "25938088801"})).to have_been_made
+    end
+    it "returns an array of favorited Tweets" do
+      tweets = @client.favorite!(25938088801)
+      expect(tweets).to be_an Array
+      expect(tweets.first).to be_a Twitter::Tweet
+      expect(tweets.first.text).to eq "The problem with your code is that it's doing exactly what you told it to do."
+    end
+    context "forbidden" do
+      before do
+        stub_post("/1.1/favorites/create.json").with(:body => {:id => "25938088801"}).to_return(:status => 403, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+      it "raises a Forbidden error" do
+        expect{@client.favorite!(25938088801)}.to raise_error(Twitter::Error::Forbidden)
+      end
+    end
+    context "already favorited" do
+      before do
+        stub_post("/1.1/favorites/create.json").with(:body => {:id => "25938088801"}).to_return(:status => 403, :body => fixture("already_favorited.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+      it "raises an AlreadyFavorited error" do
+        expect{@client.favorite!(25938088801)}.to raise_error(Twitter::Error::AlreadyFavorited, "Tweet with the ID 25938088801 has already been favorited by the authenticated user.")
+      end
+    end
   end
 
   describe "#unfavorite" do
@@ -159,19 +199,17 @@ describe Twitter::API do
 
   describe "#retweets_of_me" do
     before do
-      stub_get("/1.1/statuses/user_timeline.json").with(:query => {:include_rts => "false", :count => "200"}).to_return(:body => fixture("statuses.json"), :headers => {:content_type => "application/json; charset=utf-8"})
-      stub_get("/1.1/statuses/user_timeline.json").with(:query => {:include_rts => "false", :count => "200", :max_id => "244102490646278145"}).to_return(:body => fixture("statuses.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+      stub_get("/1.1/statuses/retweets_of_me.json").to_return(:body => fixture("statuses.json"), :headers => {:content_type => "application/json; charset=utf-8"})
     end
     it "requests the correct resource" do
       @client.retweets_of_me
-      expect(a_get("/1.1/statuses/user_timeline.json").with(:query => {:include_rts => "false", :count => "200"})).to have_been_made
-      expect(a_get("/1.1/statuses/user_timeline.json").with(:query => {:include_rts => "false", :count => "200", :max_id => "244102490646278145"})).to have_been_made
+      expect(a_get("/1.1/statuses/retweets_of_me.json")).to have_been_made
     end
     it "returns the 20 most recent tweets of the authenticated user that have been retweeted by others" do
       tweets = @client.retweets_of_me
       expect(tweets).to be_an Array
       expect(tweets.first).to be_a Twitter::Tweet
-      expect(tweets.first.text).to eq "RT @olivercameron: Mosaic looks cool: http://t.co/A8013C9k"
+      expect(tweets.first.text).to eq "Happy Birthday @imdane. Watch out for those @rally pranksters!"
     end
   end
 
@@ -371,6 +409,48 @@ describe Twitter::API do
       expect(tweets.first.retweeted_tweet.text).to eq "RT @gruber: As for the Series, I'm for the Giants. Fuck Texas, fuck Nolan Ryan, fuck George Bush."
       expect(tweets.first.retweeted_tweet.id).not_to eq tweets.first.id
     end
+    context "already retweeted" do
+      before do
+        stub_post("/1.1/statuses/retweet/28561922516.json").to_return(:status => 403, :body => fixture("already_retweeted.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+      it "does not raise an error" do
+        expect{@client.retweet(28561922516)}.not_to raise_error
+      end
+    end
+  end
+
+  describe "#retweet!" do
+    before do
+      stub_post("/1.1/statuses/retweet/28561922516.json").to_return(:body => fixture("retweet.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+    it "requests the correct resource" do
+      @client.retweet!(28561922516)
+      expect(a_post("/1.1/statuses/retweet/28561922516.json")).to have_been_made
+    end
+    it "returns an array of Tweets with retweet details embedded" do
+      tweets = @client.retweet!(28561922516)
+      expect(tweets).to be_an Array
+      expect(tweets.first).to be_a Twitter::Tweet
+      expect(tweets.first.text).to eq "As for the Series, I'm for the Giants. Fuck Texas, fuck Nolan Ryan, fuck George Bush."
+      expect(tweets.first.retweeted_tweet.text).to eq "RT @gruber: As for the Series, I'm for the Giants. Fuck Texas, fuck Nolan Ryan, fuck George Bush."
+      expect(tweets.first.retweeted_tweet.id).not_to eq tweets.first.id
+    end
+    context "fobidden" do
+      before do
+        stub_post("/1.1/statuses/retweet/28561922516.json").to_return(:status => 403, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+      it "raises a Forbidden error" do
+        expect{@client.retweet!(28561922516)}.to raise_error(Twitter::Error::Forbidden)
+      end
+    end
+    context "already retweeted" do
+      before do
+        stub_post("/1.1/statuses/retweet/28561922516.json").to_return(:status => 403, :body => fixture("already_retweeted.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+      it "raises an AlreadyRetweeted error" do
+        expect{@client.retweet!(28561922516)}.to raise_error(Twitter::Error::AlreadyRetweeted, "Tweet with the ID 28561922516 has already been retweeted by the authenticated user.")
+      end
+    end
   end
 
   describe "#tweet" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitter
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-20 00:00:00.000000000 Z
+date: 2012-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -248,6 +248,8 @@ files:
 - lib/twitter/entity/url.rb
 - lib/twitter/entity/user_mention.rb
 - lib/twitter/entity.rb
+- lib/twitter/error/already_favorited.rb
+- lib/twitter/error/already_retweeted.rb
 - lib/twitter/error/bad_gateway.rb
 - lib/twitter/error/bad_request.rb
 - lib/twitter/error/client_error.rb
@@ -298,6 +300,8 @@ files:
 - spec/fixtures/about_me.json
 - spec/fixtures/activity_summary.json
 - spec/fixtures/all.json
+- spec/fixtures/already_favorited.json
+- spec/fixtures/already_retweeted.json
 - spec/fixtures/bad_gateway.json
 - spec/fixtures/bad_request.json
 - spec/fixtures/by_friends.json
@@ -457,6 +461,8 @@ test_files:
 - spec/fixtures/about_me.json
 - spec/fixtures/activity_summary.json
 - spec/fixtures/all.json
+- spec/fixtures/already_favorited.json
+- spec/fixtures/already_retweeted.json
 - spec/fixtures/bad_gateway.json
 - spec/fixtures/bad_request.json
 - spec/fixtures/by_friends.json