twitter 8.2.0 → 8.3.0

data/lib/twitter/rest/tweets.rb

@@ -9,66 +9,81 @@ require "twitter/utils"
 
 module Twitter
   module REST
+    # Methods for working with tweets
     module Tweets
       include Twitter::REST::UploadUtils
       include Twitter::REST::Utils
       include Twitter::Utils
+
+      # Maximum tweets per request
       MAX_TWEETS_PER_REQUEST = 100
 
       # Returns up to 100 of the first retweets of a given tweet
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/statuses/retweets/:id
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.retweets(25938088801)
       # @return [Array<Twitter::Tweet>]
       # @param tweet [Integer, String, URI, Twitter::Tweet] A Tweet ID, URI, or object.
       # @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.
+      # @option options [Integer] :count Specifies the number of records to retrieve.
+      # @option options [Boolean, String, Integer] :trim_user Include only the author's ID.
       def retweets(tweet, options = {})
-        perform_get_with_objects("/1.1/statuses/retweets/#{extract_id(tweet)}.json", options, Twitter::Tweet)
+        perform_get_with_objects("/1.1/statuses/retweets/#{extract_id(tweet)}.json", options, Tweet)
       end
 
-      # Show up to 100 users who retweeted the Tweet
+      # Shows up to 100 users who retweeted the Tweet
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/statuses/retweets/:id
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.retweeters_of(25938088801)
       # @return [Array]
       # @param tweet [Integer, String, URI, Twitter::Tweet] A Tweet ID, URI, or object.
       # @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.
-      # @option options [Boolean] :ids_only ('false') Only return user IDs instead of full user objects.
+      # @option options [Integer] :count Specifies the number of records to retrieve.
+      # @option options [Boolean, String, Integer] :trim_user Include only the author's ID.
+      # @option options [Boolean] :ids_only Only return user IDs.
       def retweeters_of(tweet, options = {})
         options = options.dup
-        ids_only = !!options.delete(:ids_only)
+        ids_only = options.delete(:ids_only)
         retweeters = retweets(tweet, options).collect(&:user)
         ids_only ? retweeters.collect(&:id) : retweeters
       end
 
       # Returns a Tweet
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/statuses/show/:id
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @raise [Twitter::Error::Forbidden] Error raised when supplied status is over 280 characters.
+      # @example
+      #   client.status(25938088801)
       # @return [Twitter::Tweet] The requested Tweet.
       # @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.
+      # @option options [Boolean, String, Integer] :trim_user Include only the author's ID.
       def status(tweet, options = {})
-        perform_get_with_object("/1.1/statuses/show/#{extract_id(tweet)}.json", options, Twitter::Tweet)
+        perform_get_with_object("/1.1/statuses/show/#{extract_id(tweet)}.json", options, Tweet)
       end
 
       # Returns Tweets
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/statuses/lookup
       # @rate_limited Yes
       # @authentication Required
+      # @example
+      #   client.statuses(25938088801, 25938088802)
       # @return [Array<Twitter::Tweet>] The requested Tweets.
       # @overload statuses(*tweets)
       #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
@@ -77,19 +92,22 @@ 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)
-        arguments = Twitter::Arguments.new(args)
+        arguments = Arguments.new(args)
         flat_pmap(arguments.each_slice(MAX_TWEETS_PER_REQUEST)) do |tweets|
-          perform_post_with_objects("/1.1/statuses/lookup.json", arguments.options.merge(id: tweets.collect { |u| extract_id(u) }.join(",")), Twitter::Tweet)
+          perform_post_with_objects("/1.1/statuses/lookup.json", arguments.options.merge(id: tweets.collect { |u| extract_id(u) }.join(",")), Tweet)
         end
       end
 
       # Destroys the specified Tweets
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/statuses/destroy/:id
       # @note The authenticating user must be the author of the specified Tweets.
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.destroy_status(25938088801)
       # @return [Array<Twitter::Tweet>] The deleted Tweets.
       # @overload destroy_status(*tweets)
       #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
@@ -98,71 +116,82 @@ 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)
-        arguments = Twitter::Arguments.new(args)
+        arguments = Arguments.new(args)
         pmap(arguments) do |tweet|
-          perform_post_with_object("/1.1/statuses/destroy/#{extract_id(tweet)}.json", arguments.options, Twitter::Tweet)
+          perform_post_with_object("/1.1/statuses/destroy/#{extract_id(tweet)}.json", arguments.options, Tweet)
         end
       end
-      alias destroy_tweet destroy_status
+      # @!method destroy_tweet
+      #   @api public
+      #   @see #destroy_status
+      alias_method :destroy_tweet, :destroy_status
 
       # Updates the authenticating user's status
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/statuses/update
-      # @note A status update with text identical to the authenticating user's current status will be ignored to prevent duplicates.
+      # @note Duplicate statuses are ignored to prevent duplicates.
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Twitter::Tweet] The created Tweet. When the tweet is deemed a duplicate by Twitter, returns the last Tweet from the user's timeline.
+      # @example
+      #   client.update('I just posted a status update!')
+      # @return [Twitter::Tweet] The created Tweet.
       # @param status [String] The text of your status update, up to 280 characters.
       # @param options [Hash] A customizable set of options.
-      # @option options [Boolean, String, Integer] :possibly_sensitive Set to true for content which may not be suitable for every audience.
-      # @option options [Twitter::Tweet] :in_reply_to_status An existing status that the update is in reply to. If the status being replied to was not originally posted by the authenticated user, the text of the status must begin with an @-mention, or twitter will reject the update.
-      # @option options [Integer] :in_reply_to_status_id The ID of an existing status that the update is in reply to.
-      # @option options [Float] :lat The latitude of the location this tweet refers to. 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 of the location this tweet refers to. The valid ranges 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 [Twitter::Place] :place A place in the world. These can be retrieved from {Twitter::REST::PlacesAndGeo#reverse_geocode}.
-      # @option options [String] :place_id A place in the world. These IDs can be retrieved from {Twitter::REST::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.
+      # @option options [Boolean, String, Integer] :possibly_sensitive Sensitive content flag.
+      # @option options [Twitter::Tweet] :in_reply_to_status An existing status to reply to.
+      # @option options [Integer] :in_reply_to_status_id The ID of a status to reply to.
+      # @option options [Float] :lat The latitude of the location.
+      # @option options [Float] :long The longitude of the location.
+      # @option options [Twitter::Place] :place A place in the world.
+      # @option options [String] :place_id A place ID.
+      # @option options [String] :display_coordinates Pin on exact coordinates.
+      # @option options [Boolean, String, Integer] :trim_user Include only the author's ID.
       def update(status, options = {})
         update!(status, options)
-      rescue Twitter::Error::DuplicateStatus
-        user_timeline(count: 1).first
+      rescue Error::DuplicateStatus
+        user_timeline(count: 1).first # steep:ignore NoMethod
       end
 
-      # Updates the authenticating user's status
+      # Updates the authenticating user's status, raising an error on duplicate
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/statuses/update
-      # @note A status update with text identical to the authenticating user's current status will be ignored to prevent duplicates.
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @raise [Twitter::Error::DuplicateStatus] Error raised when a duplicate status is posted.
+      # @example
+      #   client.update!('I just posted a status update!')
       # @return [Twitter::Tweet] The created Tweet.
       # @param status [String] The text of your status update, up to 280 characters.
       # @param options [Hash] A customizable set of options.
-      # @option options [Boolean, String, Integer] :possibly_sensitive Set to true for content which may not be suitable for every audience.
-      # @option options [Twitter::Tweet] :in_reply_to_status An existing status that the update is in reply to. If the status being replied to was not originally posted by the authenticated user, the text of the status must begin with an @-mention, or twitter will reject the update.
-      # @option options [Integer] :in_reply_to_status_id The ID of an existing status that the update is in reply to.
-      # @option options [Float] :lat The latitude of the location this tweet refers to. 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 of the location this tweet refers to. The valid ranges 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 [Twitter::Place] :place A place in the world. These can be retrieved from {Twitter::REST::PlacesAndGeo#reverse_geocode}.
-      # @option options [String] :place_id A place in the world. These IDs can be retrieved from {Twitter::REST::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.
+      # @option options [Boolean, String, Integer] :possibly_sensitive Sensitive content flag.
+      # @option options [Twitter::Tweet] :in_reply_to_status An existing status to reply to.
+      # @option options [Integer] :in_reply_to_status_id The ID of a status to reply to.
+      # @option options [Float] :lat The latitude of the location.
+      # @option options [Float] :long The longitude of the location.
+      # @option options [Twitter::Place] :place A place in the world.
+      # @option options [String] :place_id A place ID.
+      # @option options [String] :display_coordinates Pin on exact coordinates.
+      # @option options [Boolean, String, Integer] :trim_user Include only the author's ID.
       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?
-        perform_post_with_object("/1.1/statuses/update.json", hash.merge(status:), Twitter::Tweet)
+        perform_post_with_object("/1.1/statuses/update.json", hash.merge(status:), Tweet)
       end
 
       # Retweets the specified Tweets as the authenticating user
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/statuses/retweet/:id
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.retweet(25938088801)
       # @return [Array<Twitter::Tweet>] The original tweets with retweet details embedded.
       # @overload retweet(*tweets)
       #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
@@ -171,22 +200,25 @@ 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 retweet(*args)
-        arguments = Twitter::Arguments.new(args)
+        arguments = Arguments.new(args)
         pmap(arguments) do |tweet|
           post_retweet(extract_id(tweet), arguments.options)
-        rescue Twitter::Error::AlreadyRetweeted, Twitter::Error::NotFound
-          next
+        rescue Error::AlreadyRetweeted, Error::NotFound
+          nil
         end.compact
       end
 
-      # Retweets the specified Tweets as the authenticating user and raises an error if one has already been retweeted
+      # Retweets the specified Tweets and raises an error if already retweeted
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/statuses/retweet/:id
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::AlreadyRetweeted] Error raised when tweet has already been retweeted.
       # @raise [Twitter::Error::NotFound] Error raised when tweet does not exist or has been deleted.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.retweet!(25938088801)
       # @return [Array<Twitter::Tweet>] The original tweets with retweet details embedded.
       # @overload retweet!(*tweets)
       #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
@@ -195,70 +227,77 @@ 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 retweet!(*args)
-        arguments = Twitter::Arguments.new(args)
+        arguments = Arguments.new(args)
         pmap(arguments) do |tweet|
           post_retweet(extract_id(tweet), arguments.options)
-        end.compact
+        end
       end
 
       # Updates the authenticating user's status with media
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/statuses/update_with_media
-      # @note A status update with text/media identical to the authenticating user's current status will NOT be ignored
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.update_with_media('I just posted a photo!', File.new('/path/to/image.png'))
       # @return [Twitter::Tweet] The created Tweet.
       # @param status [String] The text of your status update, up to 280 characters.
-      # @param media [File, Array<File>] An image file or array of image files (PNG, JPEG or GIF).
+      # @param media [File, Array<File>] An image file or array of image files.
       # @param options [Hash] A customizable set of options.
-      # @option options [Boolean, String, Integer] :possibly_sensitive Set to true for content which may not be suitable for every audience.
-      # @option options [Twitter::Tweet] :in_reply_to_status An existing status that the update is in reply to.
-      # @option options [Integer] :in_reply_to_status_id The ID of an existing Tweet that the update is in reply to.
-      # @option options [Float] :lat The latitude of the location this tweet refers to. 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 of the location this tweet refers to. The valid ranges 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 [Twitter::Place] :place A place in the world. These can be retrieved from {Twitter::REST::PlacesAndGeo#reverse_geocode}.
-      # @option options [String] :place_id A place in the world. These IDs can be retrieved from {Twitter::REST::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.
+      # @option options [Boolean, String, Integer] :possibly_sensitive Sensitive content flag.
+      # @option options [Twitter::Tweet] :in_reply_to_status An existing status to reply to.
+      # @option options [Integer] :in_reply_to_status_id The ID of a status to reply to.
+      # @option options [Float] :lat The latitude of the location.
+      # @option options [Float] :long The longitude of the location.
+      # @option options [Twitter::Place] :place A place in the world.
+      # @option options [String] :place_id A place ID.
+      # @option options [String] :display_coordinates Pin on exact coordinates.
+      # @option options [Boolean, String, Integer] :trim_user Include only the author's ID.
       def update_with_media(status, media, options = {})
-        options = options.dup
         media_ids = pmap(array_wrap(media)) do |medium|
-          upload(medium)[:media_id]
+          upload(medium).fetch(:media_id)
         end
         update!(status, options.merge(media_ids: media_ids.join(",")))
       end
 
       # Returns oEmbed for a Tweet
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/statuses/oembed
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.oembed(25938088801)
       # @return [Twitter::OEmbed] OEmbed for the requested Tweet.
       # @param tweet [Integer, String, URI, Twitter::Tweet] A Tweet ID, URI, or object.
       # @param options [Hash] A customizable set of options.
-      # @option options [Integer] :maxwidth The maximum width in pixels that the embed should be rendered at. This value is constrained to be between 250 and 550 pixels.
-      # @option options [Boolean, String, Integer] :hide_media Specifies whether the embedded Tweet should automatically expand images which were uploaded via {https://dev.twitter.com/rest/reference/post/statuses/update_with_media POST statuses/update_with_media}. When set to either true, t or 1 images will not be expanded. Defaults to false.
-      # @option options [Boolean, String, Integer] :hide_thread Specifies whether the embedded Tweet should automatically show the original message in the case that the embedded Tweet is a reply. When set to either true, t or 1 the original Tweet will not be shown. Defaults to false.
-      # @option options [Boolean, String, Integer] :omit_script Specifies whether the embedded Tweet HTML should include a `<script>` element pointing to widgets.js. In cases where a page already includes widgets.js, setting this value to true will prevent a redundant script element from being included. When set to either true, t or 1 the `<script>` element will not be included in the embed HTML, meaning that pages must include a reference to widgets.js manually. Defaults to false.
-      # @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/web/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.
-      # @option options [String] :widget_type Set to video to return a Twitter Video embed for the given Tweet.
-      # @option options [Boolean, String] :hide_tweet Applies to video type only. Set to 1 or true to link directly to the Tweet URL instead of displaying a Tweet overlay when a viewer clicks on the Twitter bird logo.
+      # @option options [Integer] :maxwidth The maximum width in pixels.
+      # @option options [Boolean, String, Integer] :hide_media Hide uploaded images.
+      # @option options [Boolean, String, Integer] :hide_thread Hide original message for replies.
+      # @option options [Boolean, String, Integer] :omit_script Omit widgets.js script element.
+      # @option options [String] :align Alignment: left, right, center, or none.
+      # @option options [String] :related Related users for Web Intents.
+      # @option options [String] :lang Language code for the rendered embed.
+      # @option options [String] :widget_type Set to video for video embed.
+      # @option options [Boolean, String] :hide_tweet Link directly to Tweet URL.
       def oembed(tweet, options = {})
         options = options.dup
         options[:id] = extract_id(tweet)
-        perform_get_with_object("/1.1/statuses/oembed.json", options, Twitter::OEmbed)
+        perform_get_with_object("/1.1/statuses/oembed.json", options, OEmbed)
       end
 
       # Returns oEmbeds for Tweets
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/statuses/oembed
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.oembeds(25938088801, 25938088802)
       # @return [Array<Twitter::OEmbed>] OEmbeds for the requested Tweets.
       # @overload oembed(*tweets)
       #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
@@ -273,18 +312,21 @@ module Twitter
       #   @option options [String] :related A value for the TWT related parameter, as described in {https://dev.twitter.com/web/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 oembeds(*args)
-        arguments = Twitter::Arguments.new(args)
+        arguments = Arguments.new(args)
         pmap(arguments) do |tweet|
-          oembed(extract_id(tweet), arguments.options)
+          oembed(tweet, arguments.options)
         end
       end
 
-      # Returns a collection of up to 100 user IDs belonging to users who have retweeted the tweet specified by the id parameter.
+      # Returns up to 100 user IDs who retweeted the tweet
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/statuses/retweeters/ids
       # @rate_limited Yes
       # @authentication Required
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.retweeters_ids(25938088801)
       # @return [Twitter::Cursor]
       # @overload retweeters_ids(options)
       #   @param options [Hash] A customizable set of options.
@@ -292,17 +334,20 @@ module Twitter
       #   @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 = Arguments.new(args)
         arguments.options[:id] ||= extract_id(arguments.first)
         perform_get_with_cursor("/1.1/statuses/retweeters/ids.json", arguments.options, :ids)
       end
 
       # Untweets a retweeted status as the authenticating user
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/statuses/unretweet/:id
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.unretweet(25938088801)
       # @return [Array<Twitter::Tweet>] The original tweets with retweet details embedded.
       # @overload unretweet(*tweets)
       #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
@@ -311,32 +356,44 @@ 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 unretweet(*args)
-        arguments = Twitter::Arguments.new(args)
+        arguments = Arguments.new(args)
         pmap(arguments) do |tweet|
           post_unretweet(extract_id(tweet), arguments.options)
-        rescue Twitter::Error::NotFound
-          next
+        rescue Error::NotFound
+          nil
         end.compact
       end
 
-    private
+      private
 
+      # Wraps object in an array if not already an array
+      #
+      # @api private
+      # @return [Array]
       def array_wrap(object)
-        if object.respond_to?(:to_ary)
-          object.to_ary || [object]
-        else
-          [object]
-        end
+        object.instance_of?(Array) ? object : [object]
       end
 
-      def post_retweet(tweet, options)
-        response = perform_post("/1.1/statuses/retweet/#{extract_id(tweet)}.json", options)
-        Twitter::Tweet.new(response)
+      # Posts a retweet
+      #
+      # @api private
+      # @param tweet_id [Integer] The tweet ID to retweet
+      # @param options [Hash] Request options
+      # @return [Twitter::Tweet]
+      def post_retweet(tweet_id, options)
+        response = perform_post("/1.1/statuses/retweet/#{tweet_id}.json", options)
+        Tweet.new(response)
       end
 
-      def post_unretweet(tweet, options)
-        response = perform_post("/1.1/statuses/unretweet/#{extract_id(tweet)}.json", options)
-        Twitter::Tweet.new(response)
+      # Posts an unretweet
+      #
+      # @api private
+      # @param tweet_id [Integer] The tweet ID to unretweet
+      # @param options [Hash] Request options
+      # @return [Twitter::Tweet]
+      def post_unretweet(tweet_id, options)
+        response = perform_post("/1.1/statuses/unretweet/#{tweet_id}.json", options)
+        Tweet.new(response)
       end
     end
   end

data/lib/twitter/rest/undocumented.rb

@@ -6,13 +6,19 @@ require "twitter/user"
 
 module Twitter
   module REST
+    # Undocumented Twitter API endpoints
     module Undocumented
       include Twitter::REST::Utils
 
+      # Returns users following followers of the specified user
+      #
+      # @api public
       # @note Undocumented
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.following_followers_of('sferik')
       # @return [Twitter::Cursor]
       # @overload following_followers_of(options = {})
       #   Returns users following followers of the specified user
@@ -24,19 +30,22 @@ module Twitter
       #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
       #   @param options [Hash] A customizable set of options.
       def following_followers_of(*args)
-        cursor_from_response_with_user(:users, Twitter::User, "/users/following_followers_of.json", args)
+        cursor_from_response_with_user(:users, User, "/users/following_followers_of.json", args)
       end
 
       # Returns Tweets count for a URI
       #
+      # @api public
       # @note Undocumented
       # @rate_limited No
       # @authentication Not required
+      # @example
+      #   client.tweet_count('https://twitter.com')
       # @return [Integer]
       # @param url [String, URI] A URL.
       # @param options [Hash] A customizable set of options.
       def tweet_count(url, options = {})
-        HTTP.get("https://cdn.api.twitter.com/1/urls/count.json", params: options.merge(url: url.to_s)).parse["count"]
+        HTTP.get("https://cdn.api.twitter.com/1/urls/count.json", params: options.merge(url: url.to_s)).parse["count"] # steep:ignore NoMethod
       end
     end
   end

data/lib/twitter/rest/upload_utils.rb

@@ -2,70 +2,86 @@ require "twitter/rest/request"
 
 module Twitter
   module REST
+    # Utilities for uploading media to Twitter
+    #
+    # @api private
     module UploadUtils
-    private
+      private
 
-      # Uploads images and videos. Videos require multiple requests and uploads in chunks of 5 Megabytes.
-      # The only supported video format is mp4.
+      # Uploads images and videos to Twitter
       #
+      # @api private
       # @see https://developer.twitter.com/en/docs/media/upload-media/uploading-media/media-best-practices
+      # @return [Hash]
       def upload(media, media_category_prefix: "tweet")
         ext = File.extname(media)
         return chunk_upload(media, "video/mp4", "#{media_category_prefix}_video") if ext == ".mp4"
         return chunk_upload(media, "video/quicktime", "#{media_category_prefix}_video") if ext == ".mov"
         return chunk_upload(media, "image/gif", "#{media_category_prefix}_gif") if ext == ".gif" && File.size(media) > 5_000_000
 
-        Twitter::REST::Request.new(self, :multipart_post, "https://upload.twitter.com/1.1/media/upload.json", key: :media, file: media).perform
+        Request.new(self, :multipart_post, "https://upload.twitter.com/1.1/media/upload.json", key: :media, file: media).perform
       end
 
+      # Uploads large media in chunks
+      #
+      # @api private
       # @raise [Twitter::Error::TimeoutError] Error raised when the upload is longer than the value specified in Twitter::Client#timeouts[:upload].
       # @raise [Twitter::Error::MediaError] Error raised when Twitter return an error about a media which is not mapped by the gem.
       # @raise [Twitter::Error::MediaInternalError] Error raised when Twitter returns an InternalError error.
       # @raise [Twitter::Error::InvalidMedia] Error raised when Twitter returns an InvalidMedia error.
       # @raise [Twitter::Error::UnsupportedMedia] Error raised when Twitter returns an UnsupportedMedia error.
       # @see https://developer.twitter.com/en/docs/media/upload-media/uploading-media/chunked-media-upload
+      # @return [Hash]
       def chunk_upload(media, media_type, media_category)
-        Timeout.timeout(timeouts&.fetch(:upload, nil), Twitter::Error::TimeoutError) do
-          init = Twitter::REST::Request.new(self, :post, "https://upload.twitter.com/1.1/media/upload.json",
-                                            command: "INIT",
-                                            media_type:,
-                                            media_category:,
-                                            total_bytes: media.size).perform
-          append_media(media, init[:media_id])
+        Timeout.timeout(timeouts&.fetch(:upload, nil), Error::TimeoutError) do # steep:ignore UnknownConstant,NoMethod
+          init = Request.new(self, :post, "https://upload.twitter.com/1.1/media/upload.json",
+            command: "INIT",
+            media_type:,
+            media_category:,
+            total_bytes: media.size).perform
+          append_media(media, init.fetch(:media_id))
           media.close
-          finalize_media(init[:media_id])
+          finalize_media(init.fetch(:media_id))
         end
       end
 
+      # Appends media chunks
+      #
+      # @api private
       # @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-append
+      # @return [void]
       def append_media(media, media_id)
         until media.eof?
           chunk = media.read(5_000_000)
           seg ||= -1
-          Twitter::REST::Request.new(self, :multipart_post, "https://upload.twitter.com/1.1/media/upload.json",
-                                     command: "APPEND",
-                                     media_id:,
-                                     segment_index: seg += 1,
-                                     key: :media,
-                                     file: StringIO.new(chunk)).perform
+          Request.new(self, :multipart_post, "https://upload.twitter.com/1.1/media/upload.json",
+            command: "APPEND",
+            media_id:,
+            segment_index: seg += 1,
+            key: :media,
+            file: StringIO.new(chunk)).perform
         end
       end
 
+      # Finalizes a media upload
+      #
+      # @api private
       # @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-finalize
       # @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/get-media-upload-status
+      # @return [Hash]
       def finalize_media(media_id)
-        response = Twitter::REST::Request.new(self, :post, "https://upload.twitter.com/1.1/media/upload.json",
-                                              command: "FINALIZE", media_id:).perform
-        failed_or_succeeded = %w[failed succeeded]
+        response = Request.new(self, :post, "https://upload.twitter.com/1.1/media/upload.json",
+          command: "FINALIZE", media_id:).perform
+        terminal_states = %w[failed succeeded]
 
         loop do
-          return response if !response[:processing_info] || failed_or_succeeded.include?(response[:processing_info][:state])
+          processing_info = response[:processing_info]
+          return response if !processing_info || terminal_states.include?(processing_info[:state])
 
-          sleep(response[:processing_info][:check_after_secs])
-          response = Twitter::REST::Request.new(self, :get, "https://upload.twitter.com/1.1/media/upload.json",
-                                                command: "STATUS", media_id:).perform
+          sleep(processing_info.fetch(:check_after_secs))
+          response = Request.new(self, :get, "https://upload.twitter.com/1.1/media/upload.json",
+            command: "STATUS", media_id:).perform
         end
-        response
       end
     end
   end