twitter 5.6.0 → 5.7.0

data/lib/twitter/rest/direct_messages.rb

@@ -0,0 +1,138 @@
+require 'twitter/arguments'
+require 'twitter/direct_message'
+require 'twitter/request'
+require 'twitter/rest/utils'
+require 'twitter/user'
+require 'twitter/utils'
+
+module Twitter
+  module REST
+    module DirectMessages
+      include Twitter::REST::Utils
+      include Twitter::Utils
+
+      # Returns the 20 most recent direct messages sent to the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/direct_messages
+      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::DirectMessage>] Direct messages sent to the authenticating user.
+      # @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 [Integer] :page Specifies the page of results to retrieve.
+      def direct_messages_received(options = {})
+        perform_with_objects(:get, '/1.1/direct_messages.json', options, Twitter::DirectMessage)
+      end
+
+      # Returns the 20 most recent direct messages sent by the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/direct_messages/sent
+      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::DirectMessage>] Direct messages sent by the authenticating user.
+      # @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 [Integer] :page Specifies the page of results to retrieve.
+      def direct_messages_sent(options = {})
+        perform_with_objects(:get, '/1.1/direct_messages/sent.json', options, Twitter::DirectMessage)
+      end
+
+      # Returns a direct message
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/direct_messages/show
+      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::DirectMessage] The requested messages.
+      # @param id [Integer] A direct message ID.
+      # @param options [Hash] A customizable set of options.
+      def direct_message(id, options = {})
+        options[:id] = id
+        perform_with_object(:get, '/1.1/direct_messages/show.json', options, Twitter::DirectMessage)
+      end
+
+      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::DirectMessage>] The requested messages.
+      # @overload direct_messages(options = {})
+      #   Returns the 20 most recent direct messages sent to the authenticating user
+      #
+      #   @see https://dev.twitter.com/docs/api/1.1/get/direct_messages
+      #   @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 [Integer] :page Specifies the page of results to retrieve.
+      # @overload direct_messages(*ids)
+      #   Returns direct messages
+      #
+      #   @see https://dev.twitter.com/docs/api/1.1/get/direct_messages/show
+      #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
+      # @overload direct_messages(*ids, options)
+      #   Returns direct messages
+      #
+      #   @see https://dev.twitter.com/docs/api/1.1/get/direct_messages/show
+      #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
+      #   @param options [Hash] A customizable set of options.
+      def direct_messages(*args)
+        arguments = Twitter::Arguments.new(args)
+        if arguments.empty?
+          direct_messages_received(arguments.options)
+        else
+          parallel_map(arguments) do |id|
+            direct_message(id, arguments.options)
+          end
+        end
+      end
+
+      # Destroys direct messages
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/direct_messages/destroy
+      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @rate_limited No
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::DirectMessage>] Deleted direct message.
+      # @overload destroy_direct_message(*ids)
+      #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
+      # @overload destroy_direct_message(*ids, options)
+      #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
+      #   @param options [Hash] A customizable set of options.
+      def destroy_direct_message(*args)
+        parallel_objects_from_response(Twitter::DirectMessage, :post, '/1.1/direct_messages/destroy.json', args)
+      end
+      deprecate_alias :direct_message_destroy, :destroy_direct_message
+
+      # Sends a new direct message to the specified user from the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/direct_messages/new
+      # @rate_limited No
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::DirectMessage] The sent message.
+      # @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
+      # @param text [String] The text of your direct message, up to 140 characters.
+      # @param options [Hash] A customizable set of options.
+      def create_direct_message(user, text, options = {})
+        merge_user!(options, user)
+        options[:text] = text
+        perform_with_object(:post, '/1.1/direct_messages/new.json', options, Twitter::DirectMessage)
+      end
+      alias_method :d, :create_direct_message
+      alias_method :m, :create_direct_message
+      alias_method :dm, :create_direct_message
+      deprecate_alias :direct_message_create, :create_direct_message
+    end
+  end
+end

data/lib/twitter/rest/favorites.rb

@@ -0,0 +1,108 @@
+require 'twitter/arguments'
+require 'twitter/error'
+require 'twitter/request'
+require 'twitter/rest/utils'
+require 'twitter/tweet'
+require 'twitter/user'
+require 'twitter/utils'
+
+module Twitter
+  module REST
+    module Favorites
+      include Twitter::REST::Utils
+      include Twitter::Utils
+
+      # @see https://dev.twitter.com/docs/api/1.1/get/favorites/list
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::Tweet>] favorite Tweets.
+      # @overload favorites(options = {})
+      #   Returns the 20 most recent favorite Tweets for the authenticating user
+      #
+      #   @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 [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
+      # @overload favorites(user, options = {})
+      #   Returns the 20 most recent favorite Tweets for the specified user
+      #
+      #   @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] :count Specifies the number of records to retrieve. Must be less than or equal to 100.
+      #   @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
+      def favorites(*args)
+        arguments = Twitter::Arguments.new(args)
+        merge_user!(arguments.options, arguments.pop) if arguments.last
+        perform_with_objects(:get, '/1.1/favorites/list.json', arguments.options, Twitter::Tweet)
+      end
+
+      # Un-favorites the specified Tweets as the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/favorites/destroy
+      # @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 un-favorited Tweets.
+      # @overload unfavorite(*tweets)
+      #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
+      # @overload unfavorite(*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.
+      def unfavorite(*args)
+        parallel_objects_from_response(Twitter::Tweet, :post, '/1.1/favorites/destroy.json', args)
+      end
+      alias_method :destroy_favorite, :unfavorite
+      deprecate_alias :favorite_destroy, :unfavorite
+
+      # Favorites the specified Tweets as the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/favorites/create
+      # @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 favorited Tweets.
+      # @overload favorite(*tweets)
+      #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
+      # @overload favorite(*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.
+      def favorite(*args)
+        arguments = Twitter::Arguments.new(args)
+        parallel_map(arguments) do |tweet|
+          begin
+            perform_with_object(:post, '/1.1/favorites/create.json', arguments.options.merge(:id => extract_id(tweet)), Twitter::Tweet)
+          rescue Twitter::Error::AlreadyFavorited
+            next
+          end
+        end.compact
+      end
+      alias_method :fav, :favorite
+      alias_method :fave, :favorite
+      deprecate_alias :favorite_create, :favorite
+
+      # Favorites the specified Tweets as the authenticating user and raises an error if one has already been favorited
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/favorites/create
+      # @rate_limited No
+      # @authentication Requires user context
+      # @raise [Twitter::Error::AlreadyFavorited] Error raised when tweet has already been favorited.
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::Tweet>] The favorited Tweets.
+      # @overload favorite(*tweets)
+      #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
+      # @overload favorite(*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.
+      def favorite!(*args)
+        arguments = Twitter::Arguments.new(args)
+        parallel_map(arguments) do |tweet|
+          perform_with_object(:post, '/1.1/favorites/create.json', arguments.options.merge(:id => extract_id(tweet)), Twitter::Tweet)
+        end
+      end
+      alias_method :create_favorite!, :favorite!
+      alias_method :fav!, :favorite!
+      alias_method :fave!, :favorite!
+      deprecate_alias :favorite_create!, :favorite!
+    end
+  end
+end

data/lib/twitter/rest/friends_and_followers.rb

@@ -0,0 +1,281 @@
+require 'twitter/arguments'
+require 'twitter/cursor'
+require 'twitter/relationship'
+require 'twitter/request'
+require 'twitter/rest/utils'
+require 'twitter/user'
+require 'twitter/utils'
+
+module Twitter
+  module REST
+    module FriendsAndFollowers
+      include Twitter::REST::Utils
+      include Twitter::Utils
+
+      # @see https://dev.twitter.com/docs/api/1.1/get/friends/ids
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::Cursor]
+      # @overload friend_ids(options = {})
+      #   Returns an array of numeric IDs for every user the authenticated user is following
+      #
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Integer] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
+      # @overload friend_ids(user, options = {})
+      #   Returns an array of numeric IDs for every user the specified user is following
+      #
+      #   @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] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
+      def friend_ids(*args)
+        cursor_from_response_with_user(:ids, nil, :get, '/1.1/friends/ids.json', args)
+      end
+
+      # @see https://dev.twitter.com/docs/api/1.1/get/followers/ids
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::Cursor]
+      # @overload follower_ids(options = {})
+      #   Returns an array of numeric IDs for every user following the authenticated user
+      #
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
+      # @overload follower_ids(user, options = {})
+      #   Returns an array of numeric IDs for every user following the specified user
+      #
+      #   @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] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
+      def follower_ids(*args)
+        cursor_from_response_with_user(:ids, nil, :get, '/1.1/followers/ids.json', args)
+      end
+
+      # Returns the relationship of the authenticating user to the comma separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none.
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/lookup
+      # @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 requested users.
+      # @overload friendships(*users)
+      #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
+      # @overload friendships(*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 friendships(*args)
+        arguments = Twitter::Arguments.new(args)
+        merge_users!(arguments.options, arguments)
+        perform_with_objects(:get, '/1.1/friendships/lookup.json', arguments.options, Twitter::User)
+      end
+
+      # Returns an array of numeric IDs for every user who has a pending request to follow the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/incoming
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::Cursor]
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
+      def friendships_incoming(options = {})
+        perform_with_cursor(:get, '/1.1/friendships/incoming.json', options, :ids)
+      end
+
+      # Returns an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/outgoing
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::Cursor]
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
+      def friendships_outgoing(options = {})
+        perform_with_cursor(:get, '/1.1/friendships/outgoing.json', options, :ids)
+      end
+
+      # Allows the authenticating user to follow the specified users, unless they are already followed
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/friendships/create
+      # @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 followed users.
+      # @overload follow(*users)
+      #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
+      # @overload follow(*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.
+      #   @option options [Boolean] :follow (false) Enable notifications for the target user.
+      def follow(*args)
+        arguments = Twitter::Arguments.new(args)
+        existing_friends = Thread.new do
+          friend_ids.to_a
+        end
+        new_friends = Thread.new do
+          users(args).collect(&:id)
+        end
+        follow!(new_friends.value - existing_friends.value, arguments.options)
+      end
+      alias_method :create_friendship, :follow
+      deprecate_alias :friendship_create, :follow
+
+      # Allows the authenticating user to follow the specified users
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/friendships/create
+      # @rate_limited No
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::User>] The followed users.
+      # @overload follow!(*users)
+      #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
+      # @overload follow!(*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.
+      #   @option options [Boolean] :follow (false) Enable notifications for the target user.
+      def follow!(*args)
+        arguments = Twitter::Arguments.new(args)
+        parallel_map(arguments) do |user|
+          perform_with_object(:post, '/1.1/friendships/create.json', merge_user(arguments.options, user), Twitter::User)
+        end.compact
+      end
+      alias_method :create_friendship!, :follow!
+      deprecate_alias :friendship_create!, :follow!
+
+      # Allows the authenticating user to unfollow the specified users
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/friendships/destroy
+      # @rate_limited No
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::User>] The unfollowed users.
+      # @overload unfollow(*users)
+      #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
+      # @overload unfollow(*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 unfollow(*args)
+        parallel_user_objects_from_response(:post, '/1.1/friendships/destroy.json', args)
+      end
+      alias_method :destroy_friendship, :unfollow
+      deprecate_alias :friendship_destroy, :unfollow
+
+      # Allows one to enable or disable retweets and device notifications from the specified user.
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/friendships/update
+      # @rate_limited No
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::Relationship]
+      # @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 [Boolean] :device Enable/disable device notifications from the target user.
+      # @option options [Boolean] :retweets Enable/disable retweets from the target user.
+      def friendship_update(user, options = {})
+        merge_user!(options, user)
+        perform_with_object(:post, '/1.1/friendships/update.json', options, Twitter::Relationship)
+      end
+
+      # Returns detailed information about the relationship between two users
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/show
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::Relationship]
+      # @param source [Integer, String, Twitter::User] The Twitter user ID, screen name, or object of the source user.
+      # @param target [Integer, String, Twitter::User] The Twitter user ID, screen name, or object of the target user.
+      # @param options [Hash] A customizable set of options.
+      def friendship(source, target, options = {})
+        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_with_object(:get, '/1.1/friendships/show.json', options, Twitter::Relationship)
+      end
+      alias_method :friendship_show, :friendship
+      alias_method :relationship, :friendship
+
+      # Test for the existence of friendship between two users
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/show
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Boolean] true if user_a follows user_b, otherwise false.
+      # @param source [Integer, String, Twitter::User] The Twitter user ID, screen name, or object of the source user.
+      # @param target [Integer, String, Twitter::User] The Twitter user ID, screen name, or object of the target user.
+      # @param options [Hash] A customizable set of options.
+      def friendship?(source, target, options = {})
+        friendship(source, target, options).source.following?
+      end
+
+      # Returns a cursored collection of user objects for users following the specified user.
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/followers/list
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::Cursor]
+      # @overload followers(options = {})
+      #   Returns a cursored collection of user objects for users following the authenticated user.
+      #
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Integer] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
+      #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
+      #   @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
+      # @overload followers(user, options = {})
+      #   Returns a cursored collection of user objects for users following the specified user.
+      #
+      #   @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] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
+      #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
+      #   @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
+      def followers(*args)
+        cursor_from_response_with_user(:users, Twitter::User, :get, '/1.1/followers/list.json', args)
+      end
+
+      # Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/show
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twittera:Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::Cursor]
+      # @overload friends(options = {})
+      #   Returns a cursored collection of user objects for every user the authenticated user is following (otherwise known as their "friends").
+      #
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Integer] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
+      #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
+      #   @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
+      # @overload friends(user, options = {})
+      #   Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").
+      #
+      #   @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] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
+      #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
+      #   @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
+      def friends(*args)
+        cursor_from_response_with_user(:users, Twitter::User, :get, '/1.1/friends/list.json', args)
+      end
+      alias_method :following, :friends
+
+      # Returns a collection of user IDs that the currently authenticated user does not want to receive retweets from.
+      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/no_retweets/ids
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Integer>]
+      # @param options [Hash] A customizable set of options.
+      def no_retweet_ids(options = {})
+        get('/1.1/friendships/no_retweets/ids.json', options).body.collect(&:to_i)
+      end
+      alias_method :no_retweets_ids, :no_retweet_ids
+    end
+  end
+end