friends_and_followers.rb in twitter-5.2.0

- old
+ new

@@ -14,43 +14,43 @@
         # @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={})
+        # @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={})
+        # @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)
+          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={})
+        # @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={})
+        # @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)
+          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
@@ -64,11 +64,11 @@
         #   @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)
-          objects_from_response(Twitter::User, :get, "/1.1/friendships/lookup.json", arguments.options)
+          objects_from_response(Twitter::User, :get, '/1.1/friendships/lookup.json', arguments.options)
         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
@@ -76,12 +76,12 @@
         # @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={})
-          cursor_from_response(:ids, nil, :get, "/1.1/friendships/incoming.json", options)
+        def friendships_incoming(options = {})
+          cursor_from_response(:ids, nil, :get, '/1.1/friendships/incoming.json', options)
         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
@@ -89,12 +89,12 @@
         # @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={})
-          cursor_from_response(:ids, nil, :get, "/1.1/friendships/outgoing.json", options)
+        def friendships_outgoing(options = {})
+          cursor_from_response(:ids, nil, :get, '/1.1/friendships/outgoing.json', options)
         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
@@ -116,11 +116,11 @@
           new_friends = Thread.new do
             users(args).map(&:id)
           end
           follow!(new_friends.value - existing_friends.value, arguments.options)
         end
-        alias create_friendship follow
+        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
@@ -136,18 +136,19 @@
         #   @option options [Boolean] :follow (false) Enable notifications for the target user.
         def follow!(*args)
           arguments = Twitter::Arguments.new(args)
           arguments.flatten.threaded_map do |user|
             begin
-              object_from_response(Twitter::User, :post, "/1.1/friendships/create.json", merge_user(arguments.options, user))
+              object_from_response(Twitter::User, :post, '/1.1/friendships/create.json', merge_user(arguments.options, user))
             rescue Twitter::Error::Forbidden
               # This error will be raised if the user doesn't have permission to
               # follow list_member, for whatever reason.
+              next
             end
           end.compact
         end
-        alias create_friendship! follow!
+        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
@@ -159,13 +160,13 @@
         #   @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)
-          threaded_user_objects_from_response(:post, "/1.1/friendships/destroy.json", args)
+          threaded_user_objects_from_response(:post, '/1.1/friendships/destroy.json', args)
         end
-        alias destroy_friendship unfollow
+        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
@@ -175,13 +176,13 @@
         # @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={})
+        def friendship_update(user, options = {})
           merge_user!(options, user)
-          object_from_response(Twitter::Relationship, :post, "/1.1/friendships/update.json", options)
+          object_from_response(Twitter::Relationship, :post, '/1.1/friendships/update.json', options)
         end
 
         # Returns detailed information about the relationship between two users
         #
         # @see https://dev.twitter.com/docs/api/1.1/get/friendships/show
@@ -190,19 +191,19 @@
         # @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")
+        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")
+          merge_user!(options, target, 'target')
           options[:target_id] = options.delete(:target_user_id) unless options[:target_user_id].nil?
-          object_from_response(Twitter::Relationship, :get, "/1.1/friendships/show.json", options)
+          object_from_response(Twitter::Relationship, :get, '/1.1/friendships/show.json', options)
         end
-        alias friendship_show friendship
-        alias relationship friendship
+        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
@@ -210,78 +211,77 @@
         # @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={})
+        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={})
+        # @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={})
+        # @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)
+          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 [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Twitter::Cursor]
-        # @overload friends(options={})
+        # @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={})
+        # @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)
+          cursor_from_response_with_user(:users, Twitter::User, :get, '/1.1/friends/list.json', args)
         end
-        alias following friends
+        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].map(&:to_i)
+        def no_retweet_ids(options = {})
+          get('/1.1/friendships/no_retweets/ids.json', options)[:body].map(&:to_i)
         end
-        alias no_retweets_ids no_retweet_ids
-
+        alias_method :no_retweets_ids, :no_retweet_ids
       end
     end
   end
 end