twitter 8.2.0 → 8.3.0

data/lib/twitter/rest/favorites.rb

@@ -7,14 +7,20 @@ require "twitter/utils"
 
 module Twitter
   module REST
+    # Methods for working with favorite tweets
     module Favorites
       include Twitter::REST::Utils
       include Twitter::Utils
 
+      # Returns favorite Tweets for the user
+      #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/favorites/list
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.favorites
       # @return [Array<Twitter::Tweet>] favorite Tweets.
       # @overload favorites(options = {})
       #   Returns the 20 most recent favorite Tweets for the authenticating user
@@ -30,17 +36,20 @@ module Twitter
       #   @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
       #   @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)
+        arguments = 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)
+        perform_get_with_objects("/1.1/favorites/list.json", arguments.options, Tweet)
       end
 
       # Un-favorites the specified Tweets as the authenticating user
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/favorites/destroy
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.unfavorite(25938088801)
       # @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.
@@ -48,22 +57,28 @@ module Twitter
       #   @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)
-        arguments = Twitter::Arguments.new(args)
+        arguments = 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
+          perform_post_with_object("/1.1/favorites/destroy.json", arguments.options.merge(id: extract_id(tweet)), Tweet)
+        rescue Error::NotFound
+          nil
         end.compact
       end
-      alias destroy_favorite unfavorite
+      # @!method destroy_favorite
+      #   @api public
+      #   @see #unfavorite
+      alias_method :destroy_favorite, :unfavorite
 
-      # Un-favorites the specified Tweets as the authenticating user and raises an error if one is not found
+      # Un-favorites the specified Tweets and raises an error if not found
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/favorites/destroy
       # @rate_limited No
       # @authentication Requires user context
       # @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.unfavorite!(25938088801)
       # @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.
@@ -71,15 +86,18 @@ module Twitter
       #   @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)
+        parallel_objects_from_response(Tweet, :post, "/1.1/favorites/destroy.json", args)
       end
 
       # Favorites the specified Tweets as the authenticating user
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/favorites/create
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.favorite(25938088801)
       # @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.
@@ -87,24 +105,33 @@ module Twitter
       #   @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)
+        arguments = 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
+          perform_post_with_object("/1.1/favorites/create.json", arguments.options.merge(id: extract_id(tweet)), Tweet)
+        rescue Error::AlreadyFavorited, Error::NotFound
+          nil
         end.compact
       end
-      alias fav favorite
-      alias fave favorite
+      # @!method fav
+      #   @api public
+      #   @see #favorite
+      alias_method :fav, :favorite
+      # @!method fave
+      #   @api public
+      #   @see #favorite
+      alias_method :fave, :favorite
 
-      # Favorites the specified Tweets as the authenticating user and raises an error if one has already been favorited
+      # Favorites the specified Tweets and raises an error if already favorited
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/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::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.favorite!(25938088801)
       # @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.
@@ -112,14 +139,23 @@ module Twitter
       #   @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)
+        arguments = 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)
+          perform_post_with_object("/1.1/favorites/create.json", arguments.options.merge(id: extract_id(tweet)), Tweet)
         end
       end
-      alias create_favorite! favorite!
-      alias fav! favorite!
-      alias fave! favorite!
+      # @!method create_favorite!
+      #   @api public
+      #   @see #favorite!
+      alias_method :create_favorite!, :favorite!
+      # @!method fav!
+      #   @api public
+      #   @see #favorite!
+      alias_method :fav!, :favorite!
+      # @!method fave!
+      #   @api public
+      #   @see #favorite!
+      alias_method :fave!, :favorite!
     end
   end
 end

data/lib/twitter/rest/form_encoder.rb

@@ -1,27 +1,67 @@
 module Twitter
   module REST
+    # Encodes form data for HTTP requests
     class FormEncoder
+      # Characters that don't need to be escaped
       UNESCAPED_CHARS = /[^a-z0-9\-._~]/i
 
+      # Encodes data hash into form-encoded string
+      #
+      # @api public
+      # @example
+      #   Twitter::REST::FormEncoder.encode(name: "test", value: 123)
+      # @param data [Hash] The data to encode
+      # @return [String]
       def self.encode(data)
-        data.collect do |k, v|
-          if v.nil?
-            ::URI::DEFAULT_PARSER.escape(k.to_s, UNESCAPED_CHARS)
-          elsif v.respond_to?(:to_ary)
-            v.to_ary.collect do |w|
-              str = ::URI::DEFAULT_PARSER.escape(k.to_s, UNESCAPED_CHARS)
-              unless w.nil?
-                str << "="
-                str << ::URI::DEFAULT_PARSER.escape(w.to_s, UNESCAPED_CHARS)
-              end
-            end.join("&")
-          else
-            str = ::URI::DEFAULT_PARSER.escape(k.to_s, UNESCAPED_CHARS)
-            str << "="
-            str << ::URI::DEFAULT_PARSER.escape(v.to_s, UNESCAPED_CHARS)
-          end
-        end.join("&")
+        data.collect { |k, v| encode_pair(k, v) }.join("&")
       end
+
+      # Encodes a key-value pair
+      #
+      # @api private
+      # @param key [Object] The key to encode
+      # @param value [Object] The value to encode
+      # @return [String]
+      def self.encode_pair(key, value)
+        if value.nil?
+          escape(key)
+        elsif value.respond_to?(:to_ary)
+          encode_array(key, value.to_ary)
+        else
+          "#{escape(key)}=#{escape(value)}"
+        end
+      end
+
+      # Encodes an array of values with the same key
+      #
+      # @api private
+      # @param key [Object] The key to encode
+      # @param array [Array] The array of values
+      # @return [String]
+      def self.encode_array(key, array)
+        array.collect { |item| encode_array_item(key, item) }
+      end
+
+      # Encodes a single array item
+      #
+      # @api private
+      # @param key [Object] The key to encode
+      # @param item [Object] The item to encode
+      # @return [String]
+      def self.encode_array_item(key, item)
+        item.nil? ? escape(key) : "#{escape(key)}=#{escape(item)}"
+      end
+
+      # URI escapes a value
+      #
+      # @api private
+      # @param value [Object] The value to escape
+      # @return [String]
+      def self.escape(value)
+        URI::DEFAULT_PARSER.escape(value.to_s, UNESCAPED_CHARS) # steep:ignore UnknownConstant
+      end
+
+      private_class_method :encode_pair, :encode_array, :encode_array_item, :escape
     end
   end
 end

data/lib/twitter/rest/friends_and_followers.rb

@@ -8,14 +8,20 @@ require "twitter/utils"
 
 module Twitter
   module REST
+    # Methods for working with friends and followers
     module FriendsAndFollowers
       include Twitter::REST::Utils
       include Twitter::Utils
 
+      # Returns IDs of users the specified user is following
+      #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/friends/ids
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.friend_ids
       # @return [Twitter::Cursor]
       # @overload friend_ids(options = {})
       #   Returns an array of numeric IDs for every user the authenticated user is following
@@ -30,10 +36,15 @@ module Twitter
         cursor_from_response_with_user(:ids, nil, "/1.1/friends/ids.json", args)
       end
 
+      # Returns IDs of users following the specified user
+      #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/followers/ids
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.follower_ids
       # @return [Twitter::Cursor]
       # @overload follower_ids(options = {})
       #   Returns an array of numeric IDs for every user following the authenticated user
@@ -48,12 +59,15 @@ module Twitter
         cursor_from_response_with_user(:ids, nil, "/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.
+      # Returns the relationship of the authenticating user to the users
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/friendships/lookup
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.friendships('sferik', 'pengwynn')
       # @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.
@@ -61,41 +75,50 @@ module Twitter
       #   @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)
+        arguments = Arguments.new(args)
         merge_users!(arguments.options, arguments)
-        perform_get_with_objects("/1.1/friendships/lookup.json", arguments.options, Twitter::User)
+        perform_get_with_objects("/1.1/friendships/lookup.json", arguments.options, User)
       end
 
-      # Returns an array of numeric IDs for every user who has a pending request to follow the authenticating user
+      # Returns IDs of users with pending follow requests
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/friendships/incoming
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.friendships_incoming
       # @return [Twitter::Cursor]
       # @param options [Hash] A customizable set of options.
       def friendships_incoming(options = {})
         perform_get_with_cursor("/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
+      # Returns IDs of protected users with pending follow requests
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/friendships/outgoing
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.friendships_outgoing
       # @return [Twitter::Cursor]
       # @param options [Hash] A customizable set of options.
       def friendships_outgoing(options = {})
         perform_get_with_cursor("/1.1/friendships/outgoing.json", options, :ids)
       end
 
-      # Allows the authenticating user to follow the specified users, unless they are already followed
+      # Follows the specified users unless they are already followed
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/friendships/create
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.follow('sferik')
       # @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.
@@ -104,23 +127,26 @@ module Twitter
       #   @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)
+        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
-      alias create_friendship follow
+      # @!method create_friendship
+      #   @api public
+      #   @see #follow
+      alias_method :create_friendship, :follow
 
-      # Allows the authenticating user to follow the specified users
+      # Follows the specified users
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/friendships/create
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.follow!('sferik')
       # @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.
@@ -129,19 +155,25 @@ module Twitter
       #   @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)
+        arguments = Arguments.new(args)
         pmap(arguments) do |user|
-          perform_post_with_object("/1.1/friendships/create.json", merge_user(arguments.options, user), Twitter::User)
-        end.compact
+          perform_post_with_object("/1.1/friendships/create.json", merge_user(arguments.options, user), User) # steep:ignore ArgumentTypeMismatch
+        end
       end
-      alias create_friendship! follow!
+      # @!method create_friendship!
+      #   @api public
+      #   @see #follow!
+      alias_method :create_friendship!, :follow!
 
-      # Allows the authenticating user to unfollow the specified users
+      # Unfollows the specified users
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/friendships/destroy
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.unfollow('sferik')
       # @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.
@@ -151,14 +183,20 @@ module Twitter
       def unfollow(*args)
         parallel_users_from_response(:post, "/1.1/friendships/destroy.json", args)
       end
-      alias destroy_friendship unfollow
+      # @!method destroy_friendship
+      #   @api public
+      #   @see #unfollow
+      alias_method :destroy_friendship, :unfollow
 
-      # Allows one to enable or disable retweets and device notifications from the specified user.
+      # Enables or disables retweets and notifications from the user
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/post/friendships/update
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.friendship_update('sferik', retweets: false)
       # @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.
@@ -166,15 +204,18 @@ module Twitter
       # @option options [Boolean] :retweets Enable/disable retweets from the target user.
       def friendship_update(user, options = {})
         merge_user!(options, user)
-        perform_post_with_object("/1.1/friendships/update.json", options, Twitter::Relationship)
+        perform_post_with_object("/1.1/friendships/update.json", options, Relationship)
       end
 
       # Returns detailed information about the relationship between two users
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/friendships/show
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.friendship('sferik', 'pengwynn')
       # @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.
@@ -185,17 +226,26 @@ module Twitter
         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, Twitter::Relationship)
+        perform_get_with_object("/1.1/friendships/show.json", options, Relationship)
       end
-      alias friendship_show friendship
-      alias relationship friendship
+      # @!method friendship_show
+      #   @api public
+      #   @see #friendship
+      alias_method :friendship_show, :friendship
+      # @!method relationship
+      #   @api public
+      #   @see #friendship
+      alias_method :relationship, :friendship
 
-      # Test for the existence of friendship between two users
+      # Tests for the existence of friendship between two users
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/friendships/show
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.friendship?('sferik', 'pengwynn')
       # @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.
@@ -204,12 +254,15 @@ module Twitter
         friendship(source, target, options).source.following?
       end
 
-      # Returns a cursored collection of user objects for users following the specified user.
+      # Returns a collection of users following the specified user
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/followers/list
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.followers
       # @return [Twitter::Cursor]
       # @overload followers(options = {})
       #   Returns a cursored collection of user objects for users following the authenticated user.
@@ -225,15 +278,18 @@ module Twitter
       #   @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, "/1.1/followers/list.json", args)
+        cursor_from_response_with_user(:users, User, "/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").
+      # Returns a collection of users the specified user is following
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/friends/list
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.friends
       # @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").
@@ -249,21 +305,31 @@ module Twitter
       #   @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, "/1.1/friends/list.json", args)
+        cursor_from_response_with_user(:users, User, "/1.1/friends/list.json", args)
       end
-      alias following friends
+      # @!method following
+      #   @api public
+      #   @see #friends
+      alias_method :following, :friends
 
-      # Returns a collection of user IDs that the currently authenticated user does not want to receive retweets from.
+      # Returns IDs of users you don't want to receive retweets from
+      #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/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.
+      # @example
+      #   client.no_retweet_ids
       # @return [Array<Integer>]
       # @param options [Hash] A customizable set of options.
       def no_retweet_ids(options = {})
         perform_get("/1.1/friendships/no_retweets/ids.json", options).collect(&:to_i)
       end
-      alias no_retweets_ids no_retweet_ids
+      # @!method no_retweets_ids
+      #   @api public
+      #   @see #no_retweet_ids
+      alias_method :no_retweets_ids, :no_retweet_ids
     end
   end
 end

data/lib/twitter/rest/help.rb

@@ -4,37 +4,47 @@ require "twitter/rest/utils"
 
 module Twitter
   module REST
+    # Methods for accessing Twitter help resources
     module Help
       include Twitter::REST::Utils
 
       # Returns the list of languages supported by Twitter
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/help/languages
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.languages
       # @return [Array<Twitter::Language>]
       def languages(options = {})
-        perform_get_with_objects("/1.1/help/languages.json", options, Twitter::Language)
+        perform_get_with_objects("/1.1/help/languages.json", options, Language)
       end
 
-      # Returns {https://twitter.com/privacy Twitter's Privacy Policy}
+      # Returns Twitter's Privacy Policy
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/help/privacy
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.privacy
       # @return [String]
       def privacy(options = {})
         perform_get("/1.1/help/privacy.json", options)[:privacy]
       end
 
-      # Returns {https://twitter.com/tos Twitter's Terms of Service}
+      # Returns Twitter's Terms of Service
       #
+      # @api public
       # @see https://dev.twitter.com/rest/reference/get/help/tos
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example
+      #   client.tos
       # @return [String]
       def tos(options = {})
         perform_get("/1.1/help/tos.json", options)[:tos]