Module: Twitter::REST::Favorites

Includes:

Utils, Utils

Included in:

API

Defined in:

lib/twitter/rest/favorites.rb

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary

• #favorite(*args) ⇒ Array<Twitter::Tweet> (also: #fav, #fave)

  Favorites the specified Tweets as the authenticating user.

• #favorite!(*args) ⇒ Array<Twitter::Tweet> (also: #create_favorite!, #fav!, #fave!)

  Favorites the specified Tweets as the authenticating user and raises an error if one has already been favorited.

• #favorites(*args) ⇒ Array<Twitter::Tweet>

  Favorite Tweets.

• #unfavorite(*args) ⇒ Array<Twitter::Tweet> (also: #destroy_favorite)

  Un-favorites the specified Tweets as the authenticating user.

• #unfavorite!(*args) ⇒ Array<Twitter::Tweet>

  Un-favorites the specified Tweets as the authenticating user and raises an error if one is not found.

Methods included from Utils

flat_pmap, pmap

Instance Method Details

#favorite(*tweets) ⇒ Array<Twitter::Tweet> #favorite(*tweets, options) ⇒ Array<Twitter::Tweet> Also known as: fav, fave

Favorites the specified Tweets as the authenticating user

Overloads:

• #favorite(*tweets) ⇒ Array<Twitter::Tweet>

  Parameters:

  • tweets (Enumerable<Integer, String, URI, Twitter::Tweet>) —

    A collection of Tweet IDs, URIs, or objects.

• #favorite(*tweets, options) ⇒ Array<Twitter::Tweet>

  Parameters:

  • tweets (Enumerable<Integer, String, URI, Twitter::Tweet>) —

    A collection of Tweet IDs, URIs, or objects.

  • options (Hash) —

    A customizable set of options.

Returns:

• (Array<Twitter::Tweet>) —

  The favorited Tweets.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/post/favorites/create

Rate Limited?:

• No

Authentication:

• Requires user context

# File 'lib/twitter/rest/favorites.rb', line 89

def favorite(*args)
  arguments = Twitter::Arguments.new(args)
  pmap(arguments) do |tweet|
    perform_post_with_object("/1.1/favorites/create.json", arguments.options.merge(id: extract_id(tweet)), Twitter::Tweet)
  rescue Twitter::Error::AlreadyFavorited, Twitter::Error::NotFound
    next
  end.compact
end

#favorite!(*tweets) ⇒ Array<Twitter::Tweet> #favorite!(*tweets, options) ⇒ Array<Twitter::Tweet> Also known as: create_favorite!, fav!, fave!

Favorites the specified Tweets as the authenticating user and raises an error if one has already been favorited

Overloads:

• #favorite!(*tweets) ⇒ Array<Twitter::Tweet>

  Parameters:

  • tweets (Enumerable<Integer, String, URI, Twitter::Tweet>) —

    A collection of Tweet IDs, URIs, or objects.

• #favorite!(*tweets, options) ⇒ Array<Twitter::Tweet>

  Parameters:

  • tweets (Enumerable<Integer, String, URI, Twitter::Tweet>) —

    A collection of Tweet IDs, URIs, or objects.

  • options (Hash) —

    A customizable set of options.

Returns:

• (Array<Twitter::Tweet>) —

  The favorited Tweets.

Raises:

• (Twitter::Error::AlreadyFavorited) —

  Error raised when tweet has already been favorited.

• (Twitter::Error::NotFound) —

  Error raised when tweet does not exist or has been deleted.

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/post/favorites/create

Rate Limited?:

• No

Authentication:

• Requires user context

# File 'lib/twitter/rest/favorites.rb', line 114

def favorite!(*args)
  arguments = Twitter::Arguments.new(args)
  pmap(arguments) do |tweet|
    perform_post_with_object("/1.1/favorites/create.json", arguments.options.merge(id: extract_id(tweet)), Twitter::Tweet)
  end
end

#favorites(options = {}) ⇒ Array<Twitter::Tweet> #favorites(user, options = {}) ⇒ Array<Twitter::Tweet>

Returns favorite Tweets.

Overloads:

• #favorites(options = {}) ⇒ Array<Twitter::Tweet>

  Returns the 20 most recent favorite Tweets for the authenticating user

  Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

  Options Hash (options):

  • :count (Integer) —

    Specifies the number of records to retrieve. Must be less than or equal to 200.

  • :since_id (Integer) —

    Returns results with an ID greater than (that is, more recent than) the specified ID.

• #favorites(user, options = {}) ⇒ Array<Twitter::Tweet>

  Returns the 20 most recent favorite Tweets for the specified user

  Parameters:

  • user (Integer, String, Twitter::User) —

    A Twitter user ID, screen name, URI, or object.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

  Options Hash (options):

  • :count (Integer) —

    Specifies the number of records to retrieve. Must be less than or equal to 200.

  • :since_id (Integer) —

    Returns results with an ID greater than (that is, more recent than) the specified ID.

Returns:

• (Array<Twitter::Tweet>) —

  favorite Tweets.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/get/favorites/list

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/twitter/rest/favorites.rb', line 32

def favorites(*args)
  arguments = Twitter::Arguments.new(args)
  merge_user!(arguments.options, arguments.pop) if arguments.last
  perform_get_with_objects("/1.1/favorites/list.json", arguments.options, Twitter::Tweet)
end

#unfavorite(*tweets) ⇒ Array<Twitter::Tweet> #unfavorite(*tweets, options) ⇒ Array<Twitter::Tweet> Also known as: destroy_favorite

Un-favorites the specified Tweets as the authenticating user

Overloads:

• #unfavorite(*tweets) ⇒ Array<Twitter::Tweet>

  Parameters:

  • tweets (Enumerable<Integer, String, URI, Twitter::Tweet>) —

    A collection of Tweet IDs, URIs, or objects.

• #unfavorite(*tweets, options) ⇒ Array<Twitter::Tweet>

  Parameters:

  • tweets (Enumerable<Integer, String, URI, Twitter::Tweet>) —

    A collection of Tweet IDs, URIs, or objects.

  • options (Hash) —

    A customizable set of options.

Returns:

• (Array<Twitter::Tweet>) —

  The un-favorited Tweets.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/post/favorites/destroy

Rate Limited?:

• No

Authentication:

• Requires user context

# File 'lib/twitter/rest/favorites.rb', line 50

def unfavorite(*args)
  arguments = Twitter::Arguments.new(args)
  pmap(arguments) do |tweet|
    perform_post_with_object("/1.1/favorites/destroy.json", arguments.options.merge(id: extract_id(tweet)), Twitter::Tweet)
  rescue Twitter::Error::NotFound
    next
  end.compact
end

#unfavorite!(*tweets) ⇒ Array<Twitter::Tweet> #unfavorite!(*tweets, options) ⇒ Array<Twitter::Tweet>

Un-favorites the specified Tweets as the authenticating user and raises an error if one is not found

Overloads:

• #unfavorite!(*tweets) ⇒ Array<Twitter::Tweet>

  Parameters:

  • tweets (Enumerable<Integer, String, URI, Twitter::Tweet>) —

    A collection of Tweet IDs, URIs, or objects.

• #unfavorite!(*tweets, options) ⇒ Array<Twitter::Tweet>

  Parameters:

  • tweets (Enumerable<Integer, String, URI, Twitter::Tweet>) —

    A collection of Tweet IDs, URIs, or objects.

  • options (Hash) —

    A customizable set of options.

Returns:

• (Array<Twitter::Tweet>) —

  The un-favorited Tweets.

Raises:

• (Twitter::Error::NotFound) —

  Error raised when tweet does not exist or has been deleted.

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/post/favorites/destroy

Rate Limited?:

• No

Authentication:

• Requires user context

# File 'lib/twitter/rest/favorites.rb', line 73

def unfavorite!(*args)
  parallel_objects_from_response(Twitter::Tweet, :post, "/1.1/favorites/destroy.json", args)
end