Module: Twitter::REST::FriendsAndFollowers

Includes:
Utils, Utils
Included in:
API
Defined in:
lib/twitter/rest/friends_and_followers.rb

Overview

Methods for working with friends and followers

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary collapse

Methods included from Utils

flat_pmap, pmap

Instance Method Details

#follow(*users) ⇒ Array<Twitter::User> #follow(*users, options) ⇒ Array<Twitter::User> Also known as: create_friendship

Follows the specified users unless they are already followed

Examples:

client.follow('sferik')

Overloads:

  • #follow(*users) ⇒ Array<Twitter::User>

    Parameters:

    • users (Enumerable<Integer, String, Twitter::User>) —

      A collection of Twitter user IDs, screen names, or objects.

  • #follow(*users, options) ⇒ Array<Twitter::User>

    Parameters:

    • users (Enumerable<Integer, String, Twitter::User>) —

      A collection of Twitter user IDs, screen names, or objects.

    • options (Hash) —

      A customizable set of options.

    Options Hash (options):

    • :follow (Boolean) — default: false —

      Enable notifications for the target user.

Returns:

Raises:

See Also:



129
130
131
132
133
134
135
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 129

def follow(*args)
  arguments = Arguments.new(args)
  existing_friends = friend_ids.to_a
  new_friends = users(args).collect(&:id) # steep:ignore NoMethod

  follow!(new_friends - existing_friends, arguments.options)
end

#follow!(*users) ⇒ Array<Twitter::User> #follow!(*users, options) ⇒ Array<Twitter::User> Also known as: create_friendship!

Follows the specified users

Examples:

client.follow!('sferik')

Overloads:

  • #follow!(*users) ⇒ Array<Twitter::User>

    Parameters:

    • users (Enumerable<Integer, String, Twitter::User>) —

      A collection of Twitter user IDs, screen names, or objects.

  • #follow!(*users, options) ⇒ Array<Twitter::User>

    Parameters:

    • users (Enumerable<Integer, String, Twitter::User>) —

      A collection of Twitter user IDs, screen names, or objects.

    • options (Hash) —

      A customizable set of options.

    Options Hash (options):

    • :follow (Boolean) — default: false —

      Enable notifications for the target user.

Returns:

Raises:

See Also:



157
158
159
160
161
162
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 157

def follow!(*args)
  arguments = Arguments.new(args)
  pmap(arguments) do |user|
    perform_post_with_object("/1.1/friendships/create.json", merge_user(arguments.options, user), User) # steep:ignore ArgumentTypeMismatch
  end
end

#follower_ids(options = {}) ⇒ Twitter::Cursor #follower_ids(user, options = {}) ⇒ Twitter::Cursor

Returns IDs of users following the specified user

Examples:

client.follower_ids

Overloads:

  • #follower_ids(options = {}) ⇒ Twitter::Cursor

    Returns an array of numeric IDs for every user following the authenticated user

    Parameters:

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

      A customizable set of options.

  • #follower_ids(user, options = {}) ⇒ Twitter::Cursor

    Returns an array of numeric IDs for every user following 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.

Returns:

Raises:

See Also:



58
59
60
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 58

def follower_ids(*args)
  cursor_from_response_with_user(:ids, nil, "/1.1/followers/ids.json", args)
end

#followers(options = {}) ⇒ Twitter::Cursor #followers(user, options = {}) ⇒ Twitter::Cursor

Returns a collection of users following the specified user

Examples:

client.followers

Overloads:

  • #followers(options = {}) ⇒ Twitter::Cursor

    Returns a cursored collection of user objects for users following the authenticated user.

    Parameters:

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

      A customizable set of options.

    Options Hash (options):

    • :skip_status (Boolean, String, Integer) —

      Do not include contributee’s Tweets when set to true, ‘t’ or 1.

    • :include_user_entities (Boolean, String, Integer) —

      The user entities node will be disincluded when set to false.

  • #followers(user, options = {}) ⇒ Twitter::Cursor

    Returns a cursored collection of user objects for users following 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):

    • :skip_status (Boolean, String, Integer) —

      Do not include contributee’s Tweets when set to true, ‘t’ or 1.

    • :include_user_entities (Boolean, String, Integer) —

      The user entities node will be disincluded when set to false.

Returns:

Raises:

See Also:



280
281
282
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 280

def followers(*args)
  cursor_from_response_with_user(:users, User, "/1.1/followers/list.json", args)
end

#friend_ids(options = {}) ⇒ Twitter::Cursor #friend_ids(user, options = {}) ⇒ Twitter::Cursor

Returns IDs of users the specified user is following

Examples:

client.friend_ids

Overloads:

  • #friend_ids(options = {}) ⇒ Twitter::Cursor

    Returns an array of numeric IDs for every user the authenticated user is following

    Parameters:

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

      A customizable set of options.

  • #friend_ids(user, options = {}) ⇒ Twitter::Cursor

    Returns an array of numeric IDs for every user the specified user is following

    Parameters:

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

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

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

      A customizable set of options.

Returns:

Raises:

See Also:



35
36
37
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 35

def friend_ids(*args)
  cursor_from_response_with_user(:ids, nil, "/1.1/friends/ids.json", args)
end

#friends(options = {}) ⇒ Twitter::Cursor #friends(user, options = {}) ⇒ Twitter::Cursor Also known as: following

Returns a collection of users the specified user is following

Examples:

client.friends

Overloads:

  • #friends(options = {}) ⇒ Twitter::Cursor

    Returns a cursored collection of user objects for every user the authenticated user is following (otherwise known as their “friends”).

    Parameters:

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

      A customizable set of options.

    Options Hash (options):

    • :skip_status (Boolean, String, Integer) —

      Do not include contributee’s Tweets when set to true, ‘t’ or 1.

    • :include_user_entities (Boolean, String, Integer) —

      The user entities node will be disincluded when set to false.

  • #friends(user, options = {}) ⇒ Twitter::Cursor

    Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their “friends”).

    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):

    • :skip_status (Boolean, String, Integer) —

      Do not include contributee’s Tweets when set to true, ‘t’ or 1.

    • :include_user_entities (Boolean, String, Integer) —

      The user entities node will be disincluded when set to false.

Returns:

Raises:

See Also:



307
308
309
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 307

def friends(*args)
  cursor_from_response_with_user(:users, User, "/1.1/friends/list.json", args)
end

#friendship(source, target, options = {}) ⇒ Twitter::Relationship Also known as: friendship_show, relationship

Returns detailed information about the relationship between two users

Examples:

client.friendship('sferik', 'pengwynn')

Parameters:

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

    The Twitter user ID, screen name, or object of the source user.

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

    The Twitter user ID, screen name, or object of the target user.

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

    A customizable set of options.

Returns:

Raises:

See Also:



223
224
225
226
227
228
229
230
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 223

def friendship(source, target, options = {})
  options = options.dup
  merge_user!(options, source, "source")
  options[:source_id] = options.delete(:source_user_id) unless options[:source_user_id].nil?
  merge_user!(options, target, "target")
  options[:target_id] = options.delete(:target_user_id) unless options[:target_user_id].nil?
  perform_get_with_object("/1.1/friendships/show.json", options, Relationship)
end

#friendship?(source, target, options = {}) ⇒ Boolean

Tests for the existence of friendship between two users

Examples:

client.friendship?('sferik', 'pengwynn')

Parameters:

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

    The Twitter user ID, screen name, or object of the source user.

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

    The Twitter user ID, screen name, or object of the target user.

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

    A customizable set of options.

Returns:

  • (Boolean) —

    true if user_a follows user_b, otherwise false.

Raises:

See Also:



253
254
255
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 253

def friendship?(source, target, options = {})
  friendship(source, target, options).source.following?
end

#friendship_update(user, options = {}) ⇒ Twitter::Relationship

Enables or disables retweets and notifications from the user

Examples:

client.friendship_update('sferik', retweets: false)

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):

  • :device (Boolean) —

    Enable/disable device notifications from the target user.

  • :retweets (Boolean) —

    Enable/disable retweets from the target user.

Returns:

Raises:

See Also:



205
206
207
208
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 205

def friendship_update(user, options = {})
  merge_user!(options, user)
  perform_post_with_object("/1.1/friendships/update.json", options, Relationship)
end

#friendships(*users) ⇒ Array<Twitter::User> #friendships(*users, options) ⇒ Array<Twitter::User>

Returns the relationship of the authenticating user to the users

Examples:

client.friendships('sferik', 'pengwynn')

Overloads:

  • #friendships(*users) ⇒ Array<Twitter::User>

    Parameters:

    • users (Enumerable<Integer, String, Twitter::User>) —

      A collection of Twitter user IDs, screen names, or objects.

  • #friendships(*users, options) ⇒ Array<Twitter::User>

    Parameters:

    • users (Enumerable<Integer, String, Twitter::User>) —

      A collection of Twitter user IDs, screen names, or objects.

    • options (Hash) —

      A customizable set of options.

Returns:

Raises:

See Also:



77
78
79
80
81
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 77

def friendships(*args)
  arguments = Arguments.new(args)
  merge_users!(arguments.options, arguments)
  perform_get_with_objects("/1.1/friendships/lookup.json", arguments.options, User)
end

#friendships_incoming(options = {}) ⇒ Twitter::Cursor

Returns IDs of users with pending follow requests

Examples:

client.friendships_incoming

Parameters:

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

    A customizable set of options.

Returns:

Raises:

See Also:



94
95
96
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 94

def friendships_incoming(options = {})
  perform_get_with_cursor("/1.1/friendships/incoming.json", options, :ids)
end

#friendships_outgoing(options = {}) ⇒ Twitter::Cursor

Returns IDs of protected users with pending follow requests

Examples:

client.friendships_outgoing

Parameters:

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

    A customizable set of options.

Returns:

Raises:

See Also:



109
110
111
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 109

def friendships_outgoing(options = {})
  perform_get_with_cursor("/1.1/friendships/outgoing.json", options, :ids)
end

#no_retweet_ids(options = {}) ⇒ Array<Integer> Also known as: no_retweets_ids

Returns IDs of users you don’t want to receive retweets from

Examples:

client.no_retweet_ids

Parameters:

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

    A customizable set of options.

Returns:

  • (Array<Integer>)

Raises:

See Also:



326
327
328
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 326

def no_retweet_ids(options = {})
  perform_get("/1.1/friendships/no_retweets/ids.json", options).collect(&:to_i)
end

#unfollow(*users) ⇒ Array<Twitter::User> #unfollow(*users, options) ⇒ Array<Twitter::User> Also known as: destroy_friendship

Unfollows the specified users

Examples:

client.unfollow('sferik')

Overloads:

  • #unfollow(*users) ⇒ Array<Twitter::User>

    Parameters:

    • users (Enumerable<Integer, String, Twitter::User>) —

      A collection of Twitter user IDs, screen names, or objects.

  • #unfollow(*users, options) ⇒ Array<Twitter::User>

    Parameters:

    • users (Enumerable<Integer, String, Twitter::User>) —

      A collection of Twitter user IDs, screen names, or objects.

    • options (Hash) —

      A customizable set of options.

Returns:

Raises:

See Also:



183
184
185
 
# File 'lib/twitter/rest/friends_and_followers.rb', line 183

def unfollow(*args)
  parallel_users_from_response(:post, "/1.1/friendships/destroy.json", args)
end