module Twitter::REST::Tweets
Constants
- MAX_TWEETS_PER_REQUEST
Public Instance Methods
Destroys the specified Tweets
@see 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. @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.
@overload destroy_status
(*tweets, options)
@param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects. @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.
# File lib/twitter/rest/tweets.rb, line 100 def destroy_status(*args) arguments = Twitter::Arguments.new(args) pmap(arguments) do |tweet| perform_post_with_object("/1.1/statuses/destroy/#{extract_id(tweet)}.json", arguments.options, Twitter::Tweet) end end
Returns oEmbed for a Tweet
@see 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. @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 {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 {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.
# File lib/twitter/rest/tweets.rb, line 252 def oembed(tweet, options = {}) options = options.dup options[:id] = extract_id(tweet) perform_get_with_object('/1.1/statuses/oembed.json', options, Twitter::OEmbed) end
Returns oEmbeds for Tweets
@see 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. @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.
@overload oembed(*tweets, options)
@param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects. @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.
# File lib/twitter/rest/tweets.rb, line 277 def oembeds(*args) arguments = Twitter::Arguments.new(args) pmap(arguments) do |tweet| oembed(extract_id(tweet), arguments.options) end end
Retweets the specified Tweets
as the authenticating user
@see 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. @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.
@overload retweet(*tweets, options)
@param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects. @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.
# File lib/twitter/rest/tweets.rb, line 173 def retweet(*args) arguments = Twitter::Arguments.new(args) pmap(arguments) do |tweet| begin post_retweet(extract_id(tweet), arguments.options) rescue Twitter::Error::AlreadyRetweeted, Twitter::Error::NotFound next end end.compact end
Retweets the specified Tweets
as the authenticating user and raises an error if one has already been retweeted
@see 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. @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.
@overload retweet!(*tweets, options)
@param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects. @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.
# File lib/twitter/rest/tweets.rb, line 199 def retweet!(*args) arguments = Twitter::Arguments.new(args) pmap(arguments) do |tweet| post_retweet(extract_id(tweet), arguments.options) end.compact end
Returns a collection of up to 100 user IDs belonging to users who have retweeted the tweet specified by the id parameter.
@see 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. @return [Twitter::Cursor] @overload retweeters_ids
(options)
@param options [Hash] A customizable set of 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.
# File lib/twitter/rest/tweets.rb, line 296 def retweeters_ids(*args) arguments = Twitter::Arguments.new(args) arguments.options[:id] ||= extract_id(arguments.first) perform_get_with_cursor('/1.1/statuses/retweeters/ids.json', arguments.options, :ids) end
Show up to 100 users who retweeted the Tweet
@see 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. @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.
# File lib/twitter/rest/tweets.rb, line 45 def retweeters_of(tweet, options = {}) options = options.dup ids_only = !!options.delete(:ids_only) retweeters = retweets(tweet, options).collect(&:user) ids_only ? retweeters.collect(&:id) : retweeters end
Returns up to 100 of the first retweets of a given tweet
@see 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. @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.
# File lib/twitter/rest/tweets.rb, line 29 def retweets(tweet, options = {}) perform_get_with_objects("/1.1/statuses/retweets/#{extract_id(tweet)}.json", options, Twitter::Tweet) end
Returns a Tweet
@see 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. @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.
# File lib/twitter/rest/tweets.rb, line 63 def status(tweet, options = {}) perform_get_with_object("/1.1/statuses/show/#{extract_id(tweet)}.json", options, Twitter::Tweet) end
Returns Tweets
@see dev.twitter.com/rest/reference/get/statuses/lookup @rate_limited Yes @authentication Required @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.
@overload statuses(*tweets, options)
@param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects. @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.
# File lib/twitter/rest/tweets.rb, line 79 def statuses(*args) arguments = Twitter::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) end end
Untweets a retweeted status as the authenticating user
@see 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. @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.
@overload unretweet(*tweets, options)
@param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects. @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.
# File lib/twitter/rest/tweets.rb, line 315 def unretweet(*args) arguments = Twitter::Arguments.new(args) pmap(arguments) do |tweet| begin post_unretweet(extract_id(tweet), arguments.options) rescue Twitter::Error::NotFound next end end.compact end
Updates the authenticating user's status
@see 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. @return [Twitter::Tweet] The created Tweet
. When the tweet is deemed a duplicate by Twitter
, returns the last Tweet
from the user's timeline. @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.
# File lib/twitter/rest/tweets.rb, line 127 def update(status, options = {}) update!(status, options) rescue Twitter::Error::DuplicateStatus user_timeline(count: 1).first end
Updates the authenticating user's status
@see 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. @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.
# File lib/twitter/rest/tweets.rb, line 153 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: status), Twitter::Tweet) end
Updates the authenticating user's status with media
@see 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. @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 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.
# File lib/twitter/rest/tweets.rb, line 226 def update_with_media(status, media, options = {}) options = options.dup media_ids = pmap(array_wrap(media)) do |medium| upload(medium)[:media_id] end update!(status, options.merge(media_ids: media_ids.join(','))) end
Private Instance Methods
# File lib/twitter/rest/tweets.rb, line 328 def array_wrap(object) if object.respond_to?(:to_ary) object.to_ary || [object] else [object] end end
# File lib/twitter/rest/tweets.rb, line 336 def post_retweet(tweet, options) response = perform_post("/1.1/statuses/retweet/#{extract_id(tweet)}.json", options) Twitter::Tweet.new(response) end
# File lib/twitter/rest/tweets.rb, line 341 def post_unretweet(tweet, options) response = perform_post("/1.1/statuses/unretweet/#{extract_id(tweet)}.json", options) Twitter::Tweet.new(response) end