twitter 5.1.0 → 5.2.0

data/lib/twitter/rest/api/suggested_users.rb

@@ -13,12 +13,12 @@ module Twitter
         # @rate_limited Yes
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-        # @overload suggestions(options={})
+        # @overload suggestions(options = {})
         #   Returns the list of suggested user categories
         #
         #   @see https://dev.twitter.com/docs/api/1.1/get/users/suggestions
         #   @param options [Hash] A customizable set of options.
-        # @overload suggestions(slug, options={})
+        # @overload suggestions(slug, options = {})
         #   Returns the users in a given category
         #
         #   @see https://dev.twitter.com/docs/api/1.1/get/users/suggestions/:slug
@@ -29,7 +29,7 @@ module Twitter
           if arguments.last
             object_from_response(Twitter::Suggestion, :get, "/1.1/users/suggestions/#{arguments.pop}.json", arguments.options)
           else
-            objects_from_response(Twitter::Suggestion, :get, "/1.1/users/suggestions.json", arguments.options)
+            objects_from_response(Twitter::Suggestion, :get, '/1.1/users/suggestions.json', arguments.options)
           end
         end
 
@@ -41,10 +41,9 @@ module Twitter
         # @param slug [String] The short name of list or a category.
         # @param options [Hash] A customizable set of options.
         # @return [Array<Twitter::User>]
-        def suggest_users(slug, options={})
+        def suggest_users(slug, options = {})
           objects_from_response(Twitter::User, :get, "/1.1/users/suggestions/#{slug}/members.json", options)
         end
-
       end
     end
   end

data/lib/twitter/rest/api/timelines.rb

@@ -23,10 +23,10 @@ module Twitter
         # @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.
-        def mentions_timeline(options={})
-          objects_from_response(Twitter::Tweet, :get, "/1.1/statuses/mentions_timeline.json", options)
+        def mentions_timeline(options = {})
+          objects_from_response(Twitter::Tweet, :get, '/1.1/statuses/mentions_timeline.json', options)
         end
-        alias mentions mentions_timeline
+        alias_method :mentions, :mentions_timeline
 
         # Returns the 20 most recent Tweets posted by the specified user
         #
@@ -36,7 +36,7 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Array<Twitter::Tweet>]
-        # @overload user_timeline(user, options={})
+        # @overload user_timeline(user, options = {})
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
         #   @param options [Hash] A customizable set of options.
         #   @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
@@ -47,7 +47,7 @@ module Twitter
         #   @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_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.
         def user_timeline(*args)
-          objects_from_response_with_user(Twitter::Tweet, :get, "/1.1/statuses/user_timeline.json", args)
+          objects_from_response_with_user(Twitter::Tweet, :get, '/1.1/statuses/user_timeline.json', args)
         end
 
         # Returns the 20 most recent retweets posted by the specified user
@@ -66,12 +66,12 @@ 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.
-        def retweeted_by_user(user, options={})
+        def retweeted_by_user(user, options = {})
           retweets_from_timeline(options) do |opts|
             user_timeline(user, opts)
           end
         end
-        alias retweeted_by retweeted_by_user
+        alias_method :retweeted_by, :retweeted_by_user
 
         # Returns the 20 most recent retweets posted by the authenticating user
         #
@@ -88,7 +88,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.
-        def retweeted_by_me(options={})
+        def retweeted_by_me(options = {})
           retweets_from_timeline(options) do |opts|
             user_timeline(opts)
           end
@@ -111,8 +111,8 @@ module Twitter
         # @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 The tweet entities node will be disincluded when set to false.
-        def home_timeline(options={})
-          objects_from_response(Twitter::Tweet, :get, "/1.1/statuses/home_timeline.json", options)
+        def home_timeline(options = {})
+          objects_from_response(Twitter::Tweet, :get, '/1.1/statuses/home_timeline.json', options)
         end
 
         # Returns the 20 most recent retweets posted by users the authenticating user follow.
@@ -131,7 +131,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] :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.
-        def retweeted_to_me(options={})
+        def retweeted_to_me(options = {})
           retweets_from_timeline(options) do |opts|
             home_timeline(opts)
           end
@@ -151,8 +151,8 @@ 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] :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.
-        def retweets_of_me(options={})
-          objects_from_response(Twitter::Tweet, :get, "/1.1/statuses/retweets_of_me.json", options)
+        def retweets_of_me(options = {})
+          objects_from_response(Twitter::Tweet, :get, '/1.1/statuses/retweets_of_me.json', options)
         end
 
       private
@@ -166,13 +166,13 @@ module Twitter
         end
 
         # @param tweets [Array]
-        # @return [Array]
+        # @return [Array<Twitter::Tweet>]
         def select_retweets(tweets)
           tweets.select(&:retweet?)
         end
 
         # @param count [Integer]
-        # @return [Array]
+        # @return [Array<Twitter::Tweet>]
         def collect_with_count(count, &block)
           options = {}
           options[:count] = MAX_TWEETS_PER_REQUEST
@@ -188,14 +188,13 @@ module Twitter
 
         # @param collection [Array]
         # @param max_id [Integer, NilClass]
-        # @return [Array]
-        def collect_with_max_id(collection=[], max_id=nil, &block)
+        # @return [Array<Twitter::Tweet>]
+        def collect_with_max_id(collection = [], max_id = nil, &block)
           tweets = yield(max_id)
           return collection if tweets.nil?
           collection += tweets
           tweets.empty? ? collection.flatten : collect_with_max_id(collection, tweets.last.id - 1, &block)
         end
-
       end
     end
   end

data/lib/twitter/rest/api/trends.rb

@@ -14,16 +14,16 @@ module Twitter
         # @rate_limited Yes
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-        # @param id [Integer] The {https://developer.yahoo.com/geo/geoplanet Yahoo! Where On Earth ID} of the location to return trending information for. WOEIDs can be retrieved by calling {Twitter::REST::API::Trends#trend_locations}. Global information is available by using 1 as the WOEID.
+        # @param id [Integer] The {https://developer.yahoo.com/geo/geoplanet Yahoo! Where On Earth ID} of the location to return trending information for. WOEIDs can be retrieved by calling {Twitter::REST::API::Trends#trends_available}. Global information is available by using 1 as the WOEID.
         # @param options [Hash] A customizable set of options.
         # @option options [String] :exclude Setting this equal to 'hashtags' will remove all hashtags from the trends list.
         # @return [Array<Twitter::Trend>]
-        def trends(id=1, options={})
+        def trends(id = 1, options = {})
           options[:id] = id
-          object_from_response(Twitter::TrendResults, :get, "/1.1/trends/place.json", options)
+          object_from_response(Twitter::TrendResults, :get, '/1.1/trends/place.json', options)
         end
-        alias local_trends trends
-        alias trends_place trends
+        alias_method :local_trends, :trends
+        alias_method :trends_place, :trends
 
         # Returns the locations that Twitter has trending topic information for
         #
@@ -33,10 +33,10 @@ module Twitter
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @param options [Hash] A customizable set of options.
         # @return [Array<Twitter::Place>]
-        def trends_available(options={})
-          objects_from_response(Twitter::Place, :get, "/1.1/trends/available.json", options)
+        def trends_available(options = {})
+          objects_from_response(Twitter::Place, :get, '/1.1/trends/available.json', options)
         end
-        alias trend_locations trends_available
+        alias_method :trend_locations, :trends_available
 
         # Returns the locations that Twitter has trending topic information for, closest to a specified location.
         #
@@ -48,10 +48,9 @@ module Twitter
         # @option options [Float] :lat If provided with a :long option the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for latitude are -90.0 to +90.0 (North is positive) inclusive.
         # @option options [Float] :long If provided with a :lat option the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for longitude are -180.0 to +180.0 (East is positive) inclusive.
         # @return [Array<Twitter::Place>]
-        def trends_closest(options={})
-          objects_from_response(Twitter::Place, :get, "/1.1/trends/closest.json", options)
+        def trends_closest(options = {})
+          objects_from_response(Twitter::Place, :get, '/1.1/trends/closest.json', options)
         end
-
       end
     end
   end

data/lib/twitter/rest/api/tweets.rb

@@ -23,7 +23,7 @@ module Twitter
         # @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 100.
         # @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 retweets(tweet, options={})
+        def retweets(tweet, options = {})
           id = extract_id(tweet)
           objects_from_response(Twitter::Tweet, :get, "/1.1/statuses/retweets/#{id}.json", options)
         end
@@ -40,7 +40,7 @@ module Twitter
         # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 100.
         # @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] :ids_only ('false') Only return user ids instead of full user objects.
-        def retweeters_of(tweet, options={})
+        def retweeters_of(tweet, options = {})
           ids_only = !!options.delete(:ids_only)
           retweeters = retweets(tweet, options).map(&:user)
           ids_only ? retweeters.map(&:id) : retweeters
@@ -57,7 +57,7 @@ module Twitter
         # @param tweet [Integer, String, URI, Twitter::Tweet] A Tweet ID, URI, or object.
         # @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 status(tweet, options={})
+        def status(tweet, options = {})
           id = extract_id(tweet)
           object_from_response(Twitter::Tweet, :get, "/1.1/statuses/show/#{id}.json", options)
         end
@@ -76,7 +76,7 @@ module Twitter
         #   @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 statuses(*args)
-          threaded_tweets_from_response(:get, "/1.1/statuses/show", args)
+          threaded_tweets_from_response(:get, '/1.1/statuses/show', args)
         end
 
         # Destroys the specified Tweets
@@ -94,9 +94,9 @@ module Twitter
         #   @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 destroy_status(*args)
-          threaded_tweets_from_response(:post, "/1.1/statuses/destroy", args)
+          threaded_tweets_from_response(:post, '/1.1/statuses/destroy', args)
         end
-        alias destroy_tweet destroy_status
+        alias_method :destroy_tweet, :destroy_status
         deprecate_alias :status_destroy, :destroy_status
         deprecate_alias :tweet_destroy, :destroy_status
 
@@ -118,11 +118,11 @@ module Twitter
         # @option options [String] :place_id A place in the world. These IDs can be retrieved from {Twitter::REST::API::PlacesAndGeo#reverse_geocode}.
         # @option options [String] :display_coordinates Whether or not to put a pin on the exact coordinates a tweet has been sent from.
         # @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 update(status, options={})
+        def update(status, options = {})
           hash = options.dup
           hash[:in_reply_to_status_id] = hash.delete(:in_reply_to_status).id unless hash[:in_reply_to_status].nil?
           hash[:place_id] = hash.delete(:place).woeid unless hash[:place].nil?
-          object_from_response(Twitter::Tweet, :post, "/1.1/statuses/update.json", hash.merge(:status => status))
+          object_from_response(Twitter::Tweet, :post, '/1.1/statuses/update.json', hash.merge(:status => status))
         rescue Twitter::Error::Forbidden => error
           handle_forbidden_error(Twitter::Error::AlreadyPosted, error)
         end
@@ -198,11 +198,11 @@ module Twitter
         # @option options [String] :place_id A place in the world. These IDs can be retrieved from {Twitter::REST::API::PlacesAndGeo#reverse_geocode}.
         # @option options [String] :display_coordinates Whether or not to put a pin on the exact coordinates a tweet has been sent from.
         # @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 update_with_media(status, media, options={})
+        def update_with_media(status, media, options = {})
           hash = options.dup
           hash[:in_reply_to_status_id] = hash.delete(:in_reply_to_status).id unless hash[:in_reply_to_status].nil?
           hash[:place_id] = hash.delete(:place).woeid unless hash[:place].nil?
-          object_from_response(Twitter::Tweet, :post, "/1.1/statuses/update_with_media.json", hash.merge('media[]' => media, 'status' => status))
+          object_from_response(Twitter::Tweet, :post, '/1.1/statuses/update_with_media.json', hash.merge('media[]' => media, 'status' => status))
         rescue Twitter::Error::Forbidden => error
           handle_forbidden_error(Twitter::Error::AlreadyPosted, error)
         end
@@ -223,9 +223,9 @@ module Twitter
         # @option options [String] :align Specifies whether the embedded Tweet should be left aligned, right aligned, or centered in the page. Valid values are left, right, center, and none. Defaults to none, meaning no alignment styles are specified for the Tweet.
         # @option options [String] :related A value for the TWT related parameter, as described in {https://dev.twitter.com/docs/intents Web Intents}. This value will be forwarded to all Web Intents calls.
         # @option options [String] :lang Language code for the rendered embed. This will affect the text and localization of the rendered HTML.
-        def oembed(tweet, options={})
+        def oembed(tweet, options = {})
           options[:id] = extract_id(tweet)
-          object_from_response(Twitter::OEmbed, :get, "/1.1/statuses/oembed.json", options)
+          object_from_response(Twitter::OEmbed, :get, '/1.1/statuses/oembed.json', options)
         end
 
         # Returns oEmbeds for Tweets
@@ -261,16 +261,16 @@ module Twitter
         # @rate_limited Yes
         # @authentication Required
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-        # @return [Array<Integer>]
+        # @return [Twitter::Cursor]
         # @overload retweeters_ids(options)
         #   @param options [Hash] A customizable set of options.
-        # @overload retweeters_ids(id, options={})
+        # @overload retweeters_ids(id, options = {})
         #   @param tweet [Integer, String, URI, Twitter::Tweet] A Tweet ID, URI, or object.
         #   @param options [Hash] A customizable set of options.
         def retweeters_ids(*args)
           arguments = Twitter::Arguments.new(args)
           arguments.options[:id] ||= extract_id(arguments.first)
-          cursor_from_response(:ids, nil, :get, "/1.1/statuses/retweeters/ids.json", arguments.options)
+          cursor_from_response(:ids, nil, :get, '/1.1/statuses/retweeters/ids.json', arguments.options)
         end
 
       private
@@ -295,7 +295,6 @@ module Twitter
           retweeted_status[:body][:retweeted_status] = response[:body]
           Twitter::Tweet.from_response(retweeted_status)
         end
-
       end
     end
   end

data/lib/twitter/rest/api/undocumented.rb

@@ -15,14 +15,14 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         #
-        # @overload following_followers_of(options={})
+        # @overload following_followers_of(options = {})
         #   Returns users following followers of the specified user
         #
         #   @param options [Hash] A customizable set of options.
         #     @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
         #     @return [Twitter::Cursor]
         #
-        # @overload following_followers_of(user, options={})
+        # @overload following_followers_of(user, options = {})
         #   Returns users following followers of the authenticated user
         #
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
@@ -30,7 +30,7 @@ module Twitter
         #     @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
         #     @return [Twitter::Cursor]
         def following_followers_of(*args)
-          cursor_from_response_with_user(:users, Twitter::User, :get, "/users/following_followers_of.json", args)
+          cursor_from_response_with_user(:users, Twitter::User, :get, '/users/following_followers_of.json', args)
         end
 
         # Returns Tweets count for a URI
@@ -41,11 +41,10 @@ module Twitter
         # @return [Integer]
         # @param uri [String, URI] A URI.
         # @param options [Hash] A customizable set of options.
-        def tweet_count(uri, options={})
-          connection = Faraday.new("https://cdn.api.twitter.com", connection_options.merge(:builder => middleware))
-          connection.get("/1/urls/count.json", options.merge(:url => uri.to_s)).body[:count]
+        def tweet_count(uri, options = {})
+          connection = Faraday.new('https://cdn.api.twitter.com', connection_options.merge(:builder => middleware))
+          connection.get('/1/urls/count.json', options.merge(:url => uri.to_s)).body[:count]
         end
-
       end
     end
   end