twitter 5.6.0 → 5.7.0

data/lib/twitter/rest/oauth.rb

@@ -0,0 +1,65 @@
+require 'twitter/request'
+require 'twitter/rest/utils'
+require 'twitter/rest/response/parse_error_json'
+require 'twitter/token'
+
+module Twitter
+  module REST
+    module OAuth
+      include Twitter::REST::Utils
+
+      # Allows a registered application to obtain an OAuth 2 Bearer Token, which can be used to make API requests
+      # on an application's own behalf, without a user context.
+      #
+      # Only one bearer token may exist outstanding for an application, and repeated requests to this method
+      # will yield the same already-existent token until it has been invalidated.
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/oauth2/token
+      # @rate_limited No
+      # @authentication Required
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::Token] The Bearer Token. token_type should be 'bearer'.
+      # @param options [Hash] A customizable set of options.
+      # @example Generate a Bearer Token
+      #   client = Twitter::REST::Client.new(:consumer_key => "abc", :consumer_secret => 'def')
+      #   bearer_token = client.token
+      def token(options = {})
+        options[:bearer_token_request] = true
+        options[:grant_type] ||= 'client_credentials'
+        perform_with_object(:post, '/oauth2/token', options, Twitter::Token)
+      end
+      alias_method :bearer_token, :token
+
+      # Allows a registered application to revoke an issued OAuth 2 Bearer Token by presenting its client credentials.
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/oauth2/invalidate_token
+      # @rate_limited No
+      # @authentication Required
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @param access_token [String, Twitter::Token] The bearer token to revoke.
+      # @param options [Hash] A customizable set of options.
+      # @return [Twitter::Token] The invalidated token. token_type should be nil.
+      def invalidate_token(access_token, options = {})
+        access_token = access_token.access_token if access_token.is_a?(Twitter::Token)
+        options[:access_token] = access_token
+        perform_with_object(:post, '/oauth2/invalidate_token', options, Twitter::Token)
+      end
+
+      # Allows a registered application to revoke an issued OAuth 2 Bearer Token by presenting its client credentials.
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/oauth2/invalidate_token
+      # @rate_limited No
+      # @authentication Required
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [String] The token string.
+      def reverse_token
+        conn = connection.dup
+        conn.builder.swap(4, Twitter::REST::Response::ParseErrorJson)
+        response = conn.post('/oauth/request_token?x_auth_mode=reverse_auth') do |request|
+          request.headers[:authorization] = oauth_auth_header(:post, 'https://api.twitter.com/oauth/request_token', :x_auth_mode => 'reverse_auth').to_s
+        end
+        response.body
+      end
+    end
+  end
+end

data/lib/twitter/rest/places_and_geo.rb

@@ -0,0 +1,84 @@
+require 'twitter/geo_results'
+require 'twitter/place'
+require 'twitter/request'
+require 'twitter/rest/utils'
+
+module Twitter
+  module REST
+    module PlacesAndGeo
+      include Twitter::REST::Utils
+
+      # Returns all the information about a known place
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/geo/id/:place_id
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @param place_id [String] A place in the world. These IDs can be retrieved from {Twitter::REST::PlacesAndGeo#reverse_geocode}.
+      # @param options [Hash] A customizable set of options.
+      # @return [Twitter::Place] The requested place.
+      def place(place_id, options = {})
+        perform_with_object(:get, "/1.1/geo/id/#{place_id}.json", options, Twitter::Place)
+      end
+
+      # Searches for up to 20 places that can be used as a place_id
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/geo/reverse_geocode
+      # @note This request is an informative call and will deliver generalized results about geography.
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Float] :lat The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.
+      # @option options [Float] :long The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.
+      # @option options [String] :accuracy ('0m') A hint on the "region" in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet. If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).
+      # @option options [String] :granularity ('neighborhood') This is the minimal granularity of place types to return and must be one of: 'poi', 'neighborhood', 'city', 'admin' or 'country'.
+      # @option options [Integer] :max_results A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many "nearby" results to return. Ideally, only pass in the number of places you intend to display to the user here.
+      # @return [Array<Twitter::Place>]
+      def reverse_geocode(options = {})
+        perform_with_object(:get, '/1.1/geo/reverse_geocode.json', options, Twitter::GeoResults)
+      end
+
+      # Search for places that can be attached to a {Twitter::REST::Tweets#update}
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/geo/search
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Float] :lat The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.
+      # @option options [Float] :long The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.
+      # @option options [String] :query Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name.
+      # @option options [String] :ip An IP address. Used when attempting to fix geolocation based off of the user's IP address.
+      # @option options [String] :granularity ('neighborhood') This is the minimal granularity of place types to return and must be one of: 'poi', 'neighborhood', 'city', 'admin' or 'country'.
+      # @option options [String] :accuracy ('0m') A hint on the "region" in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet. If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).
+      # @option options [Integer] :max_results A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many "nearby" results to return. Ideally, only pass in the number of places you intend to display to the user here.
+      # @option options [String] :contained_within This is the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found.
+      # @option options [String] :"attribute:street_address" This option searches for places which have this given street address. There are other well-known and application-specific attributes available. Custom attributes are also permitted.
+      # @return [Array<Twitter::Place>]
+      def geo_search(options = {})
+        perform_with_object(:get, '/1.1/geo/search.json', options, Twitter::GeoResults)
+      end
+      alias_method :places_nearby, :geo_search
+
+      # Locates places near the given coordinates which are similar in name
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/geo/similar_places
+      # @note Conceptually, you would use this method to get a list of known places to choose from first. Then, if the desired place doesn't exist, make a request to {Twitter::REST::PlacesAndGeo#place} to create a new one. The token contained in the response is the token necessary to create a new place.
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Float] :lat The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.
+      # @option options [Float] :long The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.
+      # @option options [String] :name The name a place is known as.
+      # @option options [String] :contained_within This is the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found.
+      # @option options [String] :"attribute:street_address" This option searches for places which have this given street address. There are other well-known and application-specific attributes available. Custom attributes are also permitted.
+      # @return [Array<Twitter::Place>]
+      def similar_places(options = {})
+        perform_with_object(:get, '/1.1/geo/similar_places.json', options, Twitter::GeoResults)
+      end
+      alias_method :places_similar, :similar_places
+    end
+  end
+end

data/lib/twitter/rest/request/multipart_with_file.rb

@@ -9,13 +9,13 @@ module Twitter
         JPEG_REGEX = /\.jpe?g/i
         PNG_REGEX = /\.png$/i
 
-        def call(env)
-          env[:body].each do |key, value|
+        def call(request)
+          request.body.each do |key, value|
             if value.respond_to?(:to_io)
-              env[:body][key] = Faraday::UploadIO.new(value, mime_type(value.path), value.path)
+              request.body[key] = Faraday::UploadIO.new(value, mime_type(value.path), value.path)
             end
-          end if env[:body].is_a?(::Hash)
-          @app.call(env)
+          end if request.body.is_a?(::Hash)
+          @app.call(request)
         end
 
       private

data/lib/twitter/rest/response/parse_json.rb

@@ -16,10 +16,8 @@ module Twitter
           end
         end
 
-        def on_complete(env)
-          if respond_to?(:parse)
-            env[:body] = parse(env[:body]) unless unparsable_status_codes.include?(env[:status])
-          end
+        def on_complete(response)
+          response.body = parse(response.body) if respond_to?(:parse) && !unparsable_status_codes.include?(response.status)
         end
 
         def unparsable_status_codes

data/lib/twitter/rest/response/raise_error.rb

@@ -1,24 +1,33 @@
 require 'faraday'
-require 'twitter/error/bad_gateway'
-require 'twitter/error/bad_request'
-require 'twitter/error/forbidden'
-require 'twitter/error/gateway_timeout'
-require 'twitter/error/internal_server_error'
-require 'twitter/error/not_acceptable'
-require 'twitter/error/not_found'
-require 'twitter/error/service_unavailable'
-require 'twitter/error/too_many_requests'
-require 'twitter/error/unauthorized'
-require 'twitter/error/unprocessable_entity'
+require 'twitter/error'
 
 module Twitter
   module REST
     module Response
       class RaiseError < Faraday::Response::Middleware
-        def on_complete(env)
-          status_code = env[:status].to_i
-          error_class = Twitter::Error.errors[status_code]
-          fail error_class.from_response(env) if error_class
+        def on_complete(response)
+          status_code = response.status.to_i
+          klass = Twitter::Error.errors[status_code]
+          if klass
+            error = if klass == Twitter::Error::Forbidden
+              handle_forbidden_errors(response)
+            else
+              klass.from_response(response)
+            end
+            fail(error)
+          end
+        end
+
+      private
+
+        def handle_forbidden_errors(response)
+          error = Twitter::Error::Forbidden.from_response(response)
+          klass = Twitter::Error.forbidden_messages[error.message]
+          if klass
+            klass.from_response(response)
+          else
+            error
+          end
         end
       end
     end

data/lib/twitter/rest/saved_searches.rb

@@ -0,0 +1,93 @@
+require 'twitter/arguments'
+require 'twitter/request'
+require 'twitter/rest/utils'
+require 'twitter/saved_search'
+require 'twitter/utils'
+
+module Twitter
+  module REST
+    module SavedSearches
+      include Twitter::REST::Utils
+      include Twitter::Utils
+
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::SavedSearch>] The saved searches.
+      # @overload saved_search(options = {})
+      #   Returns the authenticated user's saved search queries
+      #
+      #   @see https://dev.twitter.com/docs/api/1.1/get/saved_searches/list
+      #   @param options [Hash] A customizable set of options.
+      # @overload saved_search(*ids)
+      #   Retrieve the data for saved searches owned by the authenticating user
+      #
+      #   @see https://dev.twitter.com/docs/api/1.1/get/saved_searches/show/:id
+      #   @param ids [Enumerable<Integer>] A collection of saved search IDs.
+      # @overload saved_search(*ids, options)
+      #   Retrieve the data for saved searches owned by the authenticating user
+      #
+      #   @see https://dev.twitter.com/docs/api/1.1/get/saved_searches/show/:id
+      #   @param ids [Enumerable<Integer>] A collection of saved search IDs.
+      #   @param options [Hash] A customizable set of options.
+      def saved_searches(*args)
+        arguments = Twitter::Arguments.new(args)
+        if arguments.empty?
+          perform_with_objects(:get, '/1.1/saved_searches/list.json', arguments.options, Twitter::SavedSearch)
+        else
+          parallel_map(arguments) do |id|
+            saved_search(id, arguments.options)
+          end
+        end
+      end
+
+      # Retrieve the data for saved searches owned by the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/saved_searches/show/:id
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::SavedSearch] The saved searches.
+      # @param id [Integer] The ID of the saved search.
+      # @param options [Hash] A customizable set of options.
+      def saved_search(id, options = {})
+        perform_with_object(:get, "/1.1/saved_searches/show/#{id}.json", options, Twitter::SavedSearch)
+      end
+
+      # Creates a saved search for the authenticated user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/saved_searches/create
+      # @rate_limited No
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::SavedSearch] The created saved search.
+      # @param query [String] The query of the search the user would like to save.
+      # @param options [Hash] A customizable set of options.
+      def create_saved_search(query, options = {})
+        perform_with_object(:post, '/1.1/saved_searches/create.json', options.merge(:query => query), Twitter::SavedSearch)
+      end
+      deprecate_alias :saved_search_create, :create_saved_search
+
+      # Destroys saved searches for the authenticated user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/saved_searches/destroy/:id
+      # @note The search specified by ID must be owned by the authenticating user.
+      # @rate_limited No
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::SavedSearch>] The deleted saved searches.
+      # @overload destroy_saved_search(*ids)
+      #   @param ids [Enumerable<Integer>] A collection of saved search IDs.
+      # @overload destroy_saved_search(*ids, options)
+      #   @param ids [Enumerable<Integer>] A collection of saved search IDs.
+      #   @param options [Hash] A customizable set of options.
+      def destroy_saved_search(*args)
+        arguments = Twitter::Arguments.new(args)
+        parallel_map(arguments) do |id|
+          perform_with_object(:post, "/1.1/saved_searches/destroy/#{id}.json", arguments.options, Twitter::SavedSearch)
+        end
+      end
+      deprecate_alias :saved_search_destroy, :destroy_saved_search
+    end
+  end
+end

data/lib/twitter/rest/search.rb

@@ -0,0 +1,37 @@
+require 'twitter/request'
+require 'twitter/search_results'
+
+module Twitter
+  module REST
+    module Search
+      MAX_TWEETS_PER_REQUEST = 100
+
+      # Returns tweets that match a specified query.
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/search/tweets
+      # @see https://dev.twitter.com/docs/using-search
+      # @note Please note that Twitter's search service and, by extension, the Search API is not meant to be an exhaustive source of Tweets. Not all Tweets will be indexed or made available via the search interface.
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @param q [String] A search term.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :geocode Returns tweets by users located within a given radius of the given latitude/longitude. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by "latitude,longitude,radius", where radius units must be specified as either "mi" (miles) or "km" (kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly.
+      # @option options [String] :lang Restricts tweets to the given language, given by an ISO 639-1 code.
+      # @option options [String] :locale Specify the language of the query you are sending (only ja is currently effective). This is intended for language-specific clients and the default should work in the majority of cases.
+      # @option options [String] :result_type Specifies what type of search results you would prefer to receive. Options are "mixed", "recent", and "popular". The current default is "mixed."
+      # @option options [Integer] :count The number of tweets to return per page, up to a maximum of 100.
+      # @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 The tweet entities node will be disincluded when set to false.
+      # @return [Twitter::SearchResults] Return tweets that match a specified query with search metadata
+      def search(q, options = {})
+        options[:count] ||= MAX_TWEETS_PER_REQUEST
+        request = Twitter::Request.new(self, :get, '/1.1/search/tweets.json', options.merge(:q => q))
+        response = get(request.path, request.options).body
+        Twitter::SearchResults.new(response, request)
+      end
+    end
+  end
+end

data/lib/twitter/rest/spam_reporting.rb

@@ -0,0 +1,27 @@
+require 'twitter/request'
+require 'twitter/rest/utils'
+require 'twitter/user'
+
+module Twitter
+  module REST
+    module SpamReporting
+      include Twitter::REST::Utils
+
+      # The users specified are blocked by the authenticated user and reported as spammers
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/users/report_spam
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::User>] The reported users.
+      # @overload report_spam(*users)
+      #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
+      # @overload report_spam(*users, options)
+      #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
+      #   @param options [Hash] A customizable set of options.
+      def report_spam(*args)
+        parallel_user_objects_from_response(:post, '/1.1/users/report_spam.json', args)
+      end
+    end
+  end
+end

data/lib/twitter/rest/suggested_users.rb

@@ -0,0 +1,49 @@
+require 'twitter/arguments'
+require 'twitter/request'
+require 'twitter/rest/utils'
+require 'twitter/suggestion'
+require 'twitter/user'
+
+module Twitter
+  module REST
+    module SuggestedUsers
+      include Twitter::REST::Utils
+
+      # @return [Array<Twitter::Suggestion>]
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @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 = {})
+      #   Returns the users in a given category
+      #
+      #   @see https://dev.twitter.com/docs/api/1.1/get/users/suggestions/:slug
+      #   @param slug [String] The short name of list or a category.
+      #   @param options [Hash] A customizable set of options.
+      def suggestions(*args)
+        arguments = Twitter::Arguments.new(args)
+        if arguments.last
+          perform_with_object(:get, "/1.1/users/suggestions/#{arguments.pop}.json", arguments.options, Twitter::Suggestion)
+        else
+          perform_with_objects(:get, '/1.1/users/suggestions.json', arguments.options, Twitter::Suggestion)
+        end
+      end
+
+      # Access the users in a given category of the Twitter suggested user list and return their most recent Tweet if they are not a protected user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/users/suggestions/:slug/members
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @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 = {})
+        perform_with_objects(:get, "/1.1/users/suggestions/#{slug}/members.json", options, Twitter::User)
+      end
+    end
+  end
+end

data/lib/twitter/rest/timelines.rb

@@ -0,0 +1,200 @@
+require 'twitter/request'
+require 'twitter/rest/utils'
+require 'twitter/tweet'
+require 'twitter/user'
+
+module Twitter
+  module REST
+    module Timelines
+      include Twitter::REST::Utils
+      DEFAULT_TWEETS_PER_REQUEST = 20
+      MAX_TWEETS_PER_REQUEST = 200
+
+      # Returns the 20 most recent mentions (statuses containing @username) for the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/statuses/mentions_timeline
+      # @note This method can only return up to 800 Tweets.
+      # @rate_limited Yes
+      # @authentication 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] :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.
+      def mentions_timeline(options = {})
+        perform_with_objects(:get, '/1.1/statuses/mentions_timeline.json', options, Twitter::Tweet)
+      end
+      alias_method :mentions, :mentions_timeline
+
+      # Returns the 20 most recent Tweets posted by the specified user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/statuses/user_timeline
+      # @note This method can only return up to 3,200 Tweets.
+      # @rate_limited Yes
+      # @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 = {})
+      #   @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.
+      #   @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_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)
+      end
+
+      # Returns the 20 most recent retweets posted by the specified user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/statuses/user_timeline
+      # @note This method can only return up to 3,200 Tweets.
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::Tweet>]
+      # @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.
+      # @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.
+      def retweeted_by_user(user, options = {})
+        retweets_from_timeline(options) do |opts|
+          user_timeline(user, opts)
+        end
+      end
+      alias_method :retweeted_by, :retweeted_by_user
+
+      # Returns the 20 most recent retweets posted by the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/statuses/user_timeline
+      # @note This method can only return up to 3,200 Tweets.
+      # @rate_limited Yes
+      # @authentication 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] :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.
+      def retweeted_by_me(options = {})
+        retweets_from_timeline(options) do |opts|
+          user_timeline(opts)
+        end
+      end
+
+      # Returns the 20 most recent Tweets, including retweets if they exist, posted by the authenticating user and the users they follow
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/statuses/home_timeline
+      # @note This method can only return up to 800 Tweets, including retweets.
+      # @rate_limited Yes
+      # @authentication 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] :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] :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 = {})
+        perform_with_objects(:get, '/1.1/statuses/home_timeline.json', options, Twitter::Tweet)
+      end
+
+      # Returns the 20 most recent retweets posted by users the authenticating user follow.
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/statuses/home_timeline
+      # @note This method can only return up to 800 Tweets, including retweets.
+      # @rate_limited Yes
+      # @authentication 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] :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.
+      def retweeted_to_me(options = {})
+        retweets_from_timeline(options) do |opts|
+          home_timeline(opts)
+        end
+      end
+
+      # 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/retweets_of_me
+      # @rate_limited Yes
+      # @authentication 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 [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 = {})
+        perform_with_objects(:get, '/1.1/statuses/retweets_of_me.json', options, Twitter::Tweet)
+      end
+
+    private
+
+      def retweets_from_timeline(options)
+        options[:include_rts] = true
+        count = options[:count] || DEFAULT_TWEETS_PER_REQUEST
+        collect_with_count(count) do |count_options|
+          select_retweets(yield(options.merge(count_options)))
+        end
+      end
+
+      # @param tweets [Array]
+      # @return [Array<Twitter::Tweet>]
+      def select_retweets(tweets)
+        tweets.select(&:retweet?)
+      end
+
+      # @param count [Integer]
+      # @return [Array<Twitter::Tweet>]
+      def collect_with_count(count)
+        options = {}
+        options[:count] = MAX_TWEETS_PER_REQUEST
+        collect_with_max_id do |max_id|
+          options[:max_id] = max_id unless max_id.nil?
+          if count > 0
+            tweets = yield(options)
+            count -= tweets.length
+            tweets
+          end
+        end.flatten.compact[0...count]
+      end
+
+      # @param collection [Array]
+      # @param max_id [Integer, NilClass]
+      # @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