twitter 5.8.0 → 5.9.0

data/lib/twitter/rest/friends_and_followers.rb

@@ -151,7 +151,7 @@ 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 unfollow(*args)
-        parallel_user_objects_from_response(:post, '/1.1/friendships/destroy.json', args)
+        parallel_users_from_response(:post, '/1.1/friendships/destroy.json', args)
       end
       alias_method :destroy_friendship, :unfollow
       deprecate_alias :friendship_destroy, :unfollow

data/lib/twitter/rest/lists.rb

@@ -477,10 +477,12 @@ module Twitter
       # @param user[Integer, String, Twitter::User] A Twitter user ID, screen_name, or object.
       # @return [Hash]
       def merge_owner!(hash, user)
-        unless hash[:owner_id] || hash[:owner_screen_name]
-          user ||= screen_name
+        return hash if hash[:owner_id] || hash[:owner_screen_name]
+        if user
           merge_user!(hash, user, 'owner')
           hash[:owner_id] = hash.delete(:owner_user_id) unless hash[:owner_user_id].nil?
+        else
+          hash[:owner_id] = user_id
         end
         hash
       end

data/lib/twitter/rest/spam_reporting.rb

@@ -20,7 +20,7 @@ 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 report_spam(*args)
-        parallel_user_objects_from_response(:post, '/1.1/users/report_spam.json', args)
+        parallel_users_from_response(:post, '/1.1/users/report_spam.json', args)
       end
     end
   end

data/lib/twitter/rest/tweets.rb

@@ -11,6 +11,7 @@ module Twitter
     module Tweets
       include Twitter::REST::Utils
       include Twitter::Utils
+      MAX_TWEETS_PER_REQUEST = 100
 
       # Returns up to 100 of the first retweets of a given tweet
       #
@@ -38,7 +39,7 @@ module Twitter
       # @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 [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
-      # @option options [Boolean] :ids_only ('false') Only return user ids instead of full user objects.
+      # @option options [Boolean] :ids_only ('false') Only return user IDs instead of full user objects.
       def retweeters_of(tweet, options = {})
         ids_only = !!options.delete(:ids_only)
         retweeters = retweets(tweet, options).collect(&:user)
@@ -62,19 +63,24 @@ module Twitter
 
       # Returns Tweets
       #
-      # @see https://dev.twitter.com/docs/api/1.1/get/statuses/show/:id
+      # @see https://dev.twitter.com/docs/api/1.1/get/statuses/lookup
       # @rate_limited Yes
-      # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @authentication Required
       # @return [Array<Twitter::Tweet>] The requested Tweets.
       # @overload statuses(*tweets)
       #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
       # @overload statuses(*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.
+      #   @option options [Symbol, String] :method Requests users via a GET request instead of the standard POST request if set to ':get'.
+      #   @option options [Boolean] :include_entities The tweet entities node will be disincluded when set to false.
       #   @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
       def statuses(*args)
-        parallel_tweets_from_response(:get, '/1.1/statuses/show', args)
+        arguments = Twitter::Arguments.new(args)
+        request_method = arguments.options.delete(:method) || :post
+        flat_pmap(arguments.each_slice(MAX_TWEETS_PER_REQUEST)) do |tweets|
+          perform_with_objects(request_method, '/1.1/statuses/lookup.json', arguments.options.merge(:id => tweets.collect { |u| extract_id(u) }.join(',')), Twitter::Tweet)
+        end
       end
 
       # Destroys the specified Tweets
@@ -92,7 +98,10 @@ module Twitter
       #   @param options [Hash] A customizable set of options.
       #   @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
       def destroy_status(*args)
-        parallel_tweets_from_response(:post, '/1.1/statuses/destroy', args)
+        arguments = Twitter::Arguments.new(args)
+        pmap(arguments) do |tweet|
+          perform_with_object(:post, "/1.1/statuses/destroy/#{extract_id(tweet)}.json", arguments.options, Twitter::Tweet)
+        end
       end
       alias_method :destroy_tweet, :destroy_status
       deprecate_alias :status_destroy, :destroy_status
@@ -200,6 +209,7 @@ module Twitter
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @raise [Twitter::Error::UnacceptableIO] Error when the IO object for the media argument does not have a to_io method.
       # @return [Twitter::Tweet] The created Tweet.
       # @param status [String] The text of your status update, up to 140 characters.
       # @param media [File, Hash] A File object with your picture (PNG, JPEG or GIF)
@@ -214,6 +224,7 @@ module Twitter
       # @option options [String] :display_coordinates Whether or not to put a pin on the exact coordinates a tweet has been sent from.
       # @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
       def update_with_media(status, media, options = {})
+        fail(Twitter::Error::UnacceptableIO.new) unless media.respond_to?(:to_io)
         hash = options.dup
         hash[:in_reply_to_status_id] = hash.delete(:in_reply_to_status).id unless hash[:in_reply_to_status].nil?
         hash[:place_id] = hash.delete(:place).woeid unless hash[:place].nil?
@@ -287,17 +298,6 @@ module Twitter
 
     private
 
-      # @param request_method [Symbol]
-      # @param path [String]
-      # @param args [Array]
-      # @return [Array<Twitter::Tweet>]
-      def parallel_tweets_from_response(request_method, path, args)
-        arguments = Twitter::Arguments.new(args)
-        pmap(arguments) do |tweet|
-          perform_with_object(request_method, path + "/#{extract_id(tweet)}.json", arguments.options, Twitter::Tweet)
-        end
-      end
-
       def post_retweet(tweet, options)
         response = post("/1.1/statuses/retweet/#{extract_id(tweet)}.json", options).body
         Twitter::Tweet.new(response)

data/lib/twitter/rest/users.rb

@@ -34,7 +34,7 @@ module Twitter
         request_method = options.size.zero? ? :get : :post
         response = send(request_method.to_sym, '/1.1/account/settings.json', options).body
         # https://dev.twitter.com/issues/59
-        response.update(:trend_location => Array(response[:trend_location]).first)
+        response.update(:trend_location => response.fetch(:trend_location, []).first)
         Twitter::Settings.new(response)
       end
 
@@ -136,19 +136,21 @@ module Twitter
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::User>] User objects that the authenticating user is blocking.
       # @param options [Hash] A customizable set of options.
-      # @option options [Integer] :page Specifies the page of results to retrieve.
-      def blocking(options = {})
+      # @option options [Boolean] :include_entities The tweet entities node will be disincluded when set to false.
+      # @option options [Boolean, String, Integer] :skip_status Do not include user's Tweets when set to true, 't' or 1.
+      def blocked(options = {})
         perform_with_cursor(:get, '/1.1/blocks/list.json', options, :users, Twitter::User)
       end
+      deprecate_alias :blocking, :blocked
 
-      # Returns an array of numeric user ids the authenticating user is blocking
+      # Returns an array of numeric user IDs the authenticating user is blocking
       #
       # @see https://dev.twitter.com/docs/api/1.1/get/blocks/ids
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor] Numeric user IDs the authenticating user is blocking.
-      # @overload block(options = {})
+      # @overload blocked_ids(options = {})
       #   @param options [Hash] A customizable set of options.
       def blocked_ids(*args)
         arguments = Twitter::Arguments.new(args)
@@ -191,7 +193,7 @@ 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 block(*args)
-        parallel_user_objects_from_response(:post, '/1.1/blocks/create.json', args)
+        parallel_users_from_response(:post, '/1.1/blocks/create.json', args)
       end
 
       # Un-blocks the users specified by the authenticating user
@@ -207,14 +209,14 @@ 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 unblock(*args)
-        parallel_user_objects_from_response(:post, '/1.1/blocks/destroy.json', args)
+        parallel_users_from_response(:post, '/1.1/blocks/destroy.json', args)
       end
 
       # Returns extended information for up to 100 users
       #
       # @see https://dev.twitter.com/docs/api/1.1/get/users/lookup
       # @rate_limited Yes
-      # @authentication Requires user context
+      # @authentication Required
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::User>] The requested users.
       # @overload users(*users)
@@ -252,8 +254,8 @@ module Twitter
       #   @option options [Boolean, String, Integer] :skip_status Do not include user's Tweets when set to true, 't' or 1.
       def user(*args)
         arguments = Twitter::Arguments.new(args)
-        if arguments.last
-          merge_user!(arguments.options, arguments.pop)
+        if arguments.last || user_id?
+          merge_user!(arguments.options, arguments.pop || user_id)
           perform_with_object(:get, '/1.1/users/show.json', arguments.options, Twitter::User)
         else
           verify_credentials(arguments.options)
@@ -305,7 +307,7 @@ module Twitter
       #   @param options [Hash] A customizable set of options.
       #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
       def contributees(*args)
-        user_objects_from_response(:get, '/1.1/users/contributees.json', args)
+        users_from_response(:get, '/1.1/users/contributees.json', args)
       end
 
       # Returns an array of users who can contribute to the specified account
@@ -323,7 +325,7 @@ module Twitter
       #   @param options [Hash] A customizable set of options.
       #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
       def contributors(*args)
-        user_objects_from_response(:get, '/1.1/users/contributors.json', args)
+        users_from_response(:get, '/1.1/users/contributors.json', args)
       end
 
       # Removes the authenticating user's profile banner image
@@ -375,9 +377,71 @@ module Twitter
       #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
       def profile_banner(*args)
         arguments = Twitter::Arguments.new(args)
-        merge_user!(arguments.options, arguments.pop || screen_name) unless arguments.options[:user_id] || arguments.options[:screen_name]
+        merge_user!(arguments.options, arguments.pop || user_id) unless arguments.options[:user_id] || arguments.options[:screen_name]
         perform_with_object(:get, '/1.1/users/profile_banner.json', arguments.options, Twitter::ProfileBanner)
       end
+
+      # Mutes the users specified by the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/mutes/users/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 muted users.
+      # @overload mute(*users)
+      #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
+      # @overload mute(*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 mute(*args)
+        parallel_users_from_response(:post, '/1.1/mutes/users/create.json', args)
+      end
+
+      # Un-mutes the user specified by the authenticating user.
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/mutes/users/destroy
+      # @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 un-muted users.
+      # @overload unmute(*users)
+      #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
+      # @overload unmute(*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 unmute(*args)
+        parallel_users_from_response(:post, '/1.1/mutes/users/destroy.json', args)
+      end
+
+      # Returns an array of user objects that the authenticating user is muting
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/mutes/users/list
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::User>] User objects that the authenticating user is muting.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Boolean] :include_entities The tweet entities node will be disincluded when set to false.
+      # @option options [Boolean, String, Integer] :skip_status Do not include user's Tweets when set to true, 't' or 1.
+      def muted(options = {})
+        perform_with_cursor(:get, '/1.1/mutes/users/list.json', options, :users, Twitter::User)
+      end
+      deprecate_alias :muting, :muted
+
+      # Returns an array of numeric user IDs the authenticating user is muting
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/mutes/users/ids
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::Cursor] Numeric user IDs the authenticating user is muting
+      # @overload muted_ids(options = {})
+      #   @param options [Hash] A customizable set of options.
+      def muted_ids(*args)
+        arguments = Twitter::Arguments.new(args)
+        merge_user!(arguments.options, arguments.pop)
+        perform_with_cursor(:get, '/1.1/mutes/users/ids.json', arguments.options, :ids)
+      end
     end
   end
 end

data/lib/twitter/rest/utils.rb

@@ -62,7 +62,7 @@ module Twitter
       # @param path [String]
       # @param args [Array]
       # @return [Array<Twitter::User>]
-      def parallel_user_objects_from_response(request_method, path, args)
+      def parallel_users_from_response(request_method, path, args)
         arguments = Twitter::Arguments.new(args)
         pmap(arguments) do |user|
           perform_with_object(request_method, path, merge_user(arguments.options, user), Twitter::User)
@@ -73,9 +73,9 @@ module Twitter
       # @param path [String]
       # @param args [Array]
       # @return [Array<Twitter::User>]
-      def user_objects_from_response(request_method, path, args)
+      def users_from_response(request_method, path, args)
         arguments = Twitter::Arguments.new(args)
-        merge_user!(arguments.options, arguments.pop || screen_name) unless arguments.options[:user_id] || arguments.options[:screen_name]
+        merge_user!(arguments.options, arguments.pop || user_id) unless arguments.options[:user_id] || arguments.options[:screen_name]
         perform_with_objects(request_method, path, arguments.options, Twitter::User)
       end
 
@@ -110,12 +110,16 @@ module Twitter
       # @return [Twitter::Cursor]
       def cursor_from_response_with_user(collection_name, klass, request_method, path, args) # rubocop:disable ParameterLists
         arguments = Twitter::Arguments.new(args)
-        merge_user!(arguments.options, arguments.pop || screen_name) unless arguments.options[:user_id] || arguments.options[:screen_name]
+        merge_user!(arguments.options, arguments.pop || user_id) unless arguments.options[:user_id] || arguments.options[:screen_name]
         perform_with_cursor(request_method, path, arguments.options, collection_name, klass)
       end
 
-      def screen_name
-        @screen_name ||= verify_credentials.screen_name
+      def user_id
+        @user_id ||= verify_credentials(:include_entities => false, :skip_status => true).id
+      end
+
+      def user_id?
+        instance_variable_defined?(:@user_id)
       end
 
       def merge_default_cursor!(options)

data/lib/twitter/search_results.rb

@@ -58,7 +58,7 @@ module Twitter
     # @return [Hash]
     def attrs=(attrs)
       @attrs = attrs
-      Array(@attrs[:statuses]).collect do |tweet|
+      @attrs.fetch(:statuses, []).collect do |tweet|
         @collection << Tweet.new(tweet)
       end
       @attrs

data/lib/twitter/settings.rb

@@ -2,9 +2,10 @@ require 'twitter/base'
 
 module Twitter
   class Settings < Twitter::Base
-    attr_reader :always_use_https, :discoverable_by_email, :geo_enabled,
-                :language, :protected, :screen_name, :show_all_inline_media,
-                :sleep_time, :time_zone
+    attr_reader :language, :screen_name, :sleep_time, :time_zone
     object_attr_reader :Place, :trend_location
+    predicate_attr_reader :always_use_https, :discoverable_by_email,
+                          :geo_enabled, :protected, :show_all_inline_media,
+                          :use_cookie_personalization
   end
 end

data/lib/twitter/source_user.rb

@@ -2,7 +2,8 @@ require 'twitter/basic_user'
 
 module Twitter
   class SourceUser < Twitter::BasicUser
-    attr_reader :all_replies, :blocking, :can_dm, :followed_by, :marked_spam,
-                :notifications_enabled, :want_retweets
+    predicate_attr_reader :all_replies, :blocking, :can_dm, :followed_by,
+                          :marked_spam, :muting, :notifications_enabled,
+                          :want_retweets
   end
 end

data/lib/twitter/streaming/client.rb

@@ -9,13 +9,17 @@ module Twitter
   module Streaming
     class Client < Twitter::Client
       attr_writer :connection
+      attr_accessor :tcp_socket_class, :ssl_socket_class
 
       # Initializes a new Client object
       #
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :tcp_socket_class A class that Connection will use to create a new TCP socket.
+      # @option options [String] :ssl_socket_class A class that Connection will use to create a new SSL socket.
       # @return [Twitter::Streaming::Client]
       def initialize(options = {})
         super
-        @connection = Streaming::Connection.new
+        @connection = Streaming::Connection.new(options)
       end
 
       # Returns public statuses that match one or more filter predicates
@@ -77,7 +81,8 @@ module Twitter
       # @see https://dev.twitter.com/docs/streaming-apis/parameters
       # @param options [Hash] A customizable set of options.
       # @option options [String] :with Specifies whether to return information for just the users specified in the follow parameter, or include messages from accounts they follow.
-      # @option options [String] :replies Specifies whether stall warnings should be delivered.
+      # @option options [String] :replies Specifies whether to return additional @replies.
+      # @option options [String] :stall_warnings Specifies whether stall warnings should be delivered.
       # @option options [String] :track Includes additional Tweets matching the specified keywords. Phrases of keywords are specified by a comma-separated list.
       # @option options [String] :locations Includes additional Tweets falling within the specified bounding boxes.
       # @yield [Twitter::Tweet, Twitter::Streaming::Event, Twitter::DirectMessage, Twitter::Streaming::FriendList, Twitter::Streaming::DeletedTweet, Twitter::Streaming::StallWarning] A stream of Twitter objects.

data/lib/twitter/streaming/connection.rb

@@ -5,10 +5,17 @@ require 'resolv'
 module Twitter
   module Streaming
     class Connection
+      def initialize(opts = {})
+        @tcp_socket_class = opts.fetch(:tcp_socket_class) { TCPSocket }
+        @ssl_socket_class = opts.fetch(:ssl_socket_class) { OpenSSL::SSL::SSLSocket }
+      end
+      attr_reader :tcp_socket_class, :ssl_socket_class
+
       def stream(request, response)
         client_context = OpenSSL::SSL::SSLContext.new
-        client         = TCPSocket.new(Resolv.getaddress(request.uri.host), request.uri.port)
-        ssl_client     = OpenSSL::SSL::SSLSocket.new(client, client_context)
+        client         = @tcp_socket_class.new(Resolv.getaddress(request.uri.host), request.uri.port)
+        ssl_client     = @ssl_socket_class.new(client, client_context)
+
         ssl_client.connect
         request.stream(ssl_client)
         while body = ssl_client.readpartial(1024) # rubocop:disable AssignmentInCondition, WhileUntilModifier

data/lib/twitter/streaming/response.rb

@@ -16,9 +16,9 @@ module Twitter
         @parser << data
       end
 
-      def on_headers_complete(headers)
-        # TODO: handle response codes
-        p(:status_code => @parser.status_code, :header => headers) unless @parser.status_code == 200
+      def on_headers_complete(_headers)
+        error = Twitter::Error.errors[@parser.status_code]
+        fail error.new if error
       end
 
       def on_body(data)

data/lib/twitter/suggestion.rb

@@ -8,7 +8,7 @@ module Twitter
 
     # @return [Array<Twitter::User>]
     def users
-      Array(@attrs[:users]).collect do |user|
+      @attrs.fetch(:users, []).collect do |user|
         User.new(user)
       end
     end

data/lib/twitter/target_user.rb

@@ -2,6 +2,6 @@ require 'twitter/basic_user'
 
 module Twitter
   class TargetUser < Twitter::BasicUser
-    attr_reader :followed_by
+    predicate_attr_reader :followed_by
   end
 end

data/lib/twitter/trend.rb

@@ -4,7 +4,8 @@ require 'twitter/base'
 module Twitter
   class Trend < Twitter::Base
     include Equalizer.new(:name)
-    attr_reader :events, :name, :promoted_content, :query
+    attr_reader :events, :name, :query
+    predicate_attr_reader :promoted_content
     uri_attr_reader :uri
   end
 end