twitter 5.1.0 → 5.2.0

data/lib/twitter/settings.rb

@@ -3,8 +3,8 @@ 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
+                :language, :protected, :screen_name, :show_all_inline_media,
+                :sleep_time, :time_zone
     object_attr_reader :Place, :trend_location
   end
 end

data/lib/twitter/size.rb

@@ -5,7 +5,7 @@ module Twitter
   class Size < Twitter::Base
     include Equalizer.new(:h, :w)
     attr_reader :h, :resize, :w
-    alias height h
-    alias width w
+    alias_method :height, :h
+    alias_method :width, :w
   end
 end

data/lib/twitter/source_user.rb

@@ -3,6 +3,6 @@ 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
+                :notifications_enabled, :want_retweets
   end
 end

data/lib/twitter/streaming/client.rb

@@ -4,8 +4,6 @@ require 'twitter/client'
 require 'twitter/streaming/connection'
 require 'twitter/streaming/response'
 require 'twitter/streaming/message_parser'
-require 'twitter/streaming/event'
-require 'twitter/streaming/friend_list'
 
 module Twitter
   module Streaming
@@ -15,34 +13,74 @@ module Twitter
       # Initializes a new Client object
       #
       # @return [Twitter::Streaming::Client]
-      def initialize(options={}, &block)
+      def initialize(options = {}, &block)
         super
         @connection = Streaming::Connection.new
       end
 
-      # @yield [Twitter::Tweet] A stream of tweets.
-      def filter(options={}, &block)
+      # Returns public statuses that match one or more filter predicates
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/post/statuses/filter
+      # @see https://dev.twitter.com/docs/streaming-apis/parameters
+      # @note At least one predicate parameter (follow, locations, or track) must be specified.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :follow A comma separated list of user IDs, indicating the users to return statuses for in the stream.
+      # @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.
+      def filter(options = {}, &block)
         request(:post, 'https://stream.twitter.com:443/1.1/statuses/filter.json', options, &block)
       end
 
-      # @yield [Twitter::Tweet] A stream of tweets.
-      def firehose(options={}, &block)
+      # Returns all public statuses
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/statuses/firehose
+      # @see https://dev.twitter.com/docs/streaming-apis/parameters
+      # @note This endpoint requires special permission to access.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :count The number of messages to backfill.
+      # @yield [Twitter::Tweet, Twitter::Streaming::Event, Twitter::DirectMessage, Twitter::Streaming::FriendList, Twitter::Streaming::DeletedTweet, Twitter::Streaming::StallWarning] A stream of Twitter objects.
+      def firehose(options = {}, &block)
         request(:get, 'https://stream.twitter.com:443/1.1/statuses/firehose.json', options, &block)
       end
 
-      # @yield [Twitter::Tweet] A stream of tweets.
-      def sample(options={}, &block)
+      # Returns a small random sample of all public statuses
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/statuses/sample
+      # @see https://dev.twitter.com/docs/streaming-apis/parameters
+      # @yield [Twitter::Tweet, Twitter::Streaming::Event, Twitter::DirectMessage, Twitter::Streaming::FriendList, Twitter::Streaming::DeletedTweet, Twitter::Streaming::StallWarning] A stream of Twitter objects.
+      def sample(options = {}, &block)
         request(:get, 'https://stream.twitter.com:443/1.1/statuses/sample.json', options, &block)
       end
 
-      # @yield [Twitter::Tweet] A stream of tweets.
+      # Streams messages for a set of user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/site
+      # @see https://dev.twitter.com/docs/streaming-apis/streams/site
+      # @see https://dev.twitter.com/docs/streaming-apis/parameters
+      # @param follow [Enumerable<Integer, String, Twitter::User>] A list of user IDs, indicating the users to return statuses for in the stream.
+      # @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.
+      # @yield [Twitter::Tweet, Twitter::Streaming::Event, Twitter::DirectMessage, Twitter::Streaming::FriendList, Twitter::Streaming::DeletedTweet, Twitter::Streaming::StallWarning] A stream of Twitter objects.
       def site(*args, &block)
         arguments = Arguments.new(args)
-        request(:get, 'https://sitestream.twitter.com:443/1.1/site.json', arguments.options.merge(:follow => arguments.join(',')), &block)
+        user_ids = collect_user_ids(arguments)
+        request(:get, 'https://sitestream.twitter.com:443/1.1/site.json', arguments.options.merge(:follow => user_ids.join(',')), &block)
       end
 
-      # @yield [Twitter::Tweet] A stream of tweets.
-      def user(options={}, &block)
+      # Streams messages for a single user
+      #
+      # @see https://dev.twitter.com/docs/api/1.1/get/user
+      # @see https://dev.twitter.com/docs/streaming-apis/streams/user
+      # @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] :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.
+      def user(options = {}, &block)
         request(:get, 'https://userstream.twitter.com:443/1.1/user.json', options, &block)
       end
 
@@ -54,19 +92,19 @@ module Twitter
         elsif instance_variable_defined?(:@before_request)
           @before_request
         else
-          Proc.new {}
+          proc {}
         end
       end
 
     private
 
-      def request(method, uri, params, &block)
+      def request(method, uri, params, &block) # rubocop:disable ParameterLists
         before_request.call
         headers  = default_headers.merge(:authorization => oauth_auth_header(method, uri, params).to_s)
         request  = HTTP::Request.new(method, uri + '?' + to_url_params(params), headers)
         response = Streaming::Response.new do |data|
-          if item = Streaming::MessageParser.parse(data)
-            yield item
+          if item = Streaming::MessageParser.parse(data) # rubocop:disable AssignmentInCondition, IfUnlessModifier
+            block.call(item)
           end
         end
         @connection.stream(request, response)
@@ -74,7 +112,7 @@ module Twitter
 
       def to_url_params(params)
         params.map do |param, value|
-          [param, URI.encode(value)].join("=")
+          [param, URI.encode(value)].join('=')
         end.sort.join('&')
       end
 
@@ -84,6 +122,21 @@ module Twitter
           :user_agent => user_agent,
         }
       end
+
+      def collect_user_ids(users)
+        user_ids = []
+        users.flatten.each do |user|
+          case user
+          when Integer
+            user_ids << user
+          when String
+            user_ids << user.to_i
+          when Twitter::User
+            user_ids << user.id
+          end
+        end
+        user_ids
+      end
     end
   end
 end

data/lib/twitter/streaming/connection.rb

@@ -5,18 +5,16 @@ require 'resolv'
 module Twitter
   module Streaming
     class Connection
-
       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)
         ssl_client.connect
         request.stream(ssl_client)
-        while body = ssl_client.readpartial(1024)
+        while body = ssl_client.readpartial(1024) # rubocop:disable AssignmentInCondition, WhileUntilModifier
           response << body
         end
       end
-
     end
   end
 end

data/lib/twitter/streaming/deleted_tweet.rb

@@ -0,0 +1,8 @@
+module Twitter
+  module Streaming
+    class DeletedTweet < Twitter::Identity
+      attr_reader :user_id
+    end
+    DeletedStatus = DeletedTweet # rubocop:disable ConstantName
+  end
+end

data/lib/twitter/streaming/event.rb

@@ -1,28 +1,28 @@
 module Twitter
   module Streaming
     class Event
-
       LIST_EVENTS = [
-        :list_created, :list_destroyed, :list_updated, :list_member_added, 
-        :list_member_added, :list_member_removed, :list_user_subscribed, 
-        :list_user_subscribed, :list_user_unsubscribed, :list_user_unsubscribed
+        :list_created, :list_destroyed, :list_updated, :list_member_added,
+        :list_member_added, :list_member_removed, :list_user_subscribed,
+        :list_user_subscribed, :list_user_unsubscribed, :list_user_unsubscribed,
       ]
 
       TWEET_EVENTS = [
-        :favorite, :unfavorite
+        :favorite, :unfavorite,
       ]
-        
+
       attr_reader :name, :source, :target, :target_object
 
       # @param data [Hash]
       def initialize(data)
-        @name = data[:event].intern
+        @name = data[:event].to_sym
         @source = Twitter::User.new(data[:source])
         @target = Twitter::User.new(data[:target])
         @target_object = target_object_factory(@name, data[:target_object])
       end
 
     private
+
       def target_object_factory(event_name, data)
         if LIST_EVENTS.include?(event_name)
           Twitter::List.new(data)
@@ -32,4 +32,4 @@ module Twitter
       end
     end
   end
-end
+end

data/lib/twitter/streaming/friend_list.rb

@@ -1,13 +1,6 @@
 module Twitter
   module Streaming
-    class FriendList
-
-      attr_reader :friend_ids
-
-      # @param friend_ids [Array]
-      def initialize(friend_ids)
-        @friend_ids = friend_ids
-      end
+    class FriendList < Array
     end
   end
-end
+end

data/lib/twitter/streaming/message_parser.rb

@@ -1,8 +1,14 @@
+require 'twitter/direct_message'
+require 'twitter/streaming/deleted_tweet'
+require 'twitter/streaming/event'
+require 'twitter/streaming/friend_list'
+require 'twitter/streaming/stall_warning'
+require 'twitter/tweet'
+
 module Twitter
   module Streaming
     class MessageParser
-
-      def self.parse(data)
+      def self.parse(data) # rubocop:disable CyclomaticComplexity
         if data[:id]
           Tweet.new(data)
         elsif data[:event]
@@ -11,12 +17,12 @@ module Twitter
           DirectMessage.new(data[:direct_message])
         elsif data[:friends]
           FriendList.new(data[:friends])
-        elsif data[:delete]
-          if data[:delete][:status]
-            Tweet.new(data[:delete][:status].merge(:deleted => true))
-          end
+        elsif data[:delete] && data[:delete][:status]
+          DeletedTweet.new(data[:delete][:status])
+        elsif data[:warning]
+          StallWarning.new(data[:warning])
         end
       end
     end
   end
-end
+end

data/lib/twitter/streaming/response.rb

@@ -3,7 +3,6 @@ require 'buftok'
 module Twitter
   module Streaming
     class Response
-
       # Initializes a new Response object
       #
       # @return [Twitter::Streaming::Response]
@@ -28,7 +27,6 @@ module Twitter
           @block.call(JSON.parse(line, :symbolize_names => true))
         end
       end
-
     end
   end
 end

data/lib/twitter/streaming/stall_warning.rb

@@ -0,0 +1,7 @@
+module Twitter
+  module Streaming
+    class StallWarning < Twitter::Base
+      attr_reader :code, :message, :percent_full
+    end
+  end
+end

data/lib/twitter/suggestion.rb

@@ -13,6 +13,5 @@ module Twitter
       end
     end
     memoize :users
-
   end
 end

data/lib/twitter/token.rb

@@ -3,15 +3,14 @@ require 'twitter/base'
 module Twitter
   class Token < Twitter::Base
     attr_reader :access_token, :token_type
-    alias to_s access_token
+    alias_method :to_s, :access_token
 
-    BEARER_TYPE = "bearer"
+    BEARER_TYPE = 'bearer'
 
     # @return [Boolean]
     def bearer?
       @attrs[:token_type] == BEARER_TYPE
     end
     memoize :bearer?
-
   end
 end

data/lib/twitter/trend_results.rb

@@ -9,27 +9,25 @@ module Twitter
     include Twitter::Enumerable
     include Memoizable
     attr_reader :attrs
-    alias to_h attrs
-    alias to_hash attrs
-    alias to_hsh attrs
+    alias_method :to_h, :attrs
+    alias_method :to_hash, :attrs
+    alias_method :to_hsh, :attrs
 
     class << self
-
       # Construct a new TrendResults object from a response hash
       #
       # @param response [Hash]
       # @return [Twitter::Base]
-      def from_response(response={})
+      def from_response(response = {})
         new(response[:body].first)
       end
-
     end
 
     # Initializes a new TrendResults object
     #
     # @param attrs [Hash]
     # @return [Twitter::TrendResults]
-    def initialize(attrs={})
+    def initialize(attrs = {})
       @attrs = attrs
       @collection = Array(@attrs[:trends]).map do |trend|
         Trend.new(trend)
@@ -60,6 +58,5 @@ module Twitter
       !@attrs[:locations].nil? && !@attrs[:locations].first.nil?
     end
     memoize :location?
-
   end
 end

data/lib/twitter/tweet.rb

@@ -4,39 +4,33 @@ module Twitter
   class Tweet < Twitter::Identity
     include Twitter::Creatable
     attr_reader :favorite_count, :favorited, :in_reply_to_screen_name,
-      :in_reply_to_attrs_id, :in_reply_to_status_id, :in_reply_to_user_id,
-      :lang, :retweet_count, :retweeted, :source, :text, :truncated
-    alias favorites_count favorite_count
-    alias favoriters_count favorite_count
-    alias in_reply_to_tweet_id in_reply_to_status_id
-    alias retweeters_count retweet_count
-    attr_reader :deleted
+                :in_reply_to_attrs_id, :in_reply_to_status_id,
+                :in_reply_to_user_id, :lang, :retweet_count, :retweeted,
+                :source, :text, :truncated
+    alias_method :favorites_count, :favorite_count
+    alias_method :favoriters_count, :favorite_count
+    alias_method :in_reply_to_tweet_id, :in_reply_to_status_id
+    alias_method :retweeters_count, :retweet_count
     object_attr_reader :GeoFactory, :geo
     object_attr_reader :Metadata, :metadata
     object_attr_reader :Place, :place
     object_attr_reader :Tweet, :retweeted_status
-    alias retweet retweeted_status
-    alias retweeted_tweet retweeted_status
-    alias retweet? retweeted_status?
-    alias retweeted_tweet? retweeted_status?
+    alias_method :retweet, :retweeted_status
+    alias_method :retweeted_tweet, :retweeted_status
+    alias_method :retweet?, :retweeted_status?
+    alias_method :retweeted_tweet?, :retweeted_status?
     object_attr_reader :User, :user, :status
 
     # @return [Boolean]
     def entities?
-      !@attrs[:entities].nil? && @attrs[:entities].any?{|_, array| !array.empty?}
+      !@attrs[:entities].nil? && @attrs[:entities].any? { |_, array| !array.empty? }
     end
     memoize :entities?
 
     def filter_level
-      @attrs[:filter_level] || "none"
+      @attrs[:filter_level] || 'none'
     end
     memoize :filter_level
-    
-    # @note Not a real entity
-    # @return [Boolean]
-    def deleted?
-      deleted == true
-    end
 
     # @return [String]
     # @note May be > 140 characters.
@@ -82,7 +76,7 @@ module Twitter
       Addressable::URI.parse("https://twitter.com/#{user.screen_name}/status/#{id}")
     end
     memoize :uri
-    alias url uri
+    alias_method :url, :uri
 
     # @note Must include entities in your request for this method to work
     # @return [Array<Twitter::Entity::URI>]
@@ -90,7 +84,7 @@ module Twitter
       entities(Entity::URI, :urls)
     end
     memoize :uris
-    alias urls uris
+    alias_method :urls, :uris
 
     # @note Must include entities in your request for this method to work
     # @return [Array<Twitter::Entity::UserMention>]
@@ -113,8 +107,6 @@ module Twitter
         []
       end
     end
-
   end
-
-  Status = Tweet
+  Status = Tweet # rubocop:disable ConstantName
 end

data/lib/twitter/user.rb

@@ -7,32 +7,32 @@ module Twitter
     PREDICATE_URI_METHOD_REGEX = /_uri\?$/
     include Twitter::Creatable
     attr_reader :connections, :contributors_enabled, :default_profile,
-      :default_profile_image, :description, :favourites_count,
-      :follow_request_sent, :followers_count, :friends_count, :geo_enabled,
-      :is_translator, :lang, :listed_count, :location, :name, :notifications,
-      :profile_background_color, :profile_background_image_url,
-      :profile_background_image_url_https, :profile_background_tile,
-      :profile_link_color, :profile_sidebar_border_color,
-      :profile_sidebar_fill_color, :profile_text_color,
-      :profile_use_background_image, :protected, :statuses_count, :time_zone,
-      :utc_offset, :verified
-    alias favorites_count favourites_count
+                :default_profile_image, :description, :favourites_count,
+                :follow_request_sent, :followers_count, :friends_count,
+                :geo_enabled, :is_translator, :lang, :listed_count, :location,
+                :name, :notifications, :profile_background_color,
+                :profile_background_image_url,
+                :profile_background_image_url_https, :profile_background_tile,
+                :profile_link_color, :profile_sidebar_border_color,
+                :profile_sidebar_fill_color, :profile_text_color,
+                :profile_use_background_image, :protected, :statuses_count,
+                :time_zone, :utc_offset, :verified
+    alias_method :favorites_count, :favourites_count
     remove_method :favourites_count
-    alias profile_background_image_uri profile_background_image_url
-    alias profile_background_image_uri_https profile_background_image_url_https
-    alias translator? is_translator
-    alias tweets_count statuses_count
+    alias_method :profile_background_image_uri, :profile_background_image_url
+    alias_method :profile_background_image_uri_https, :profile_background_image_url_https
+    alias_method :translator?, :is_translator
+    alias_method :tweets_count, :statuses_count
     object_attr_reader :Tweet, :status, :user
-    alias tweet status
-    alias tweet? status?
-    alias tweeted? status?
+    alias_method :tweet, :status
+    alias_method :tweet?, :status?
+    alias_method :tweeted?, :status?
 
     class << self
-
     private
 
       def alias_predicate_uri_methods(method)
-        for replacement in %w(_url? _uri_https? _url_https?)
+        %w(_url? _uri_https? _url_https?).each do |replacement|
           alias_method_sub(method, PREDICATE_URI_METHOD_REGEX, replacement)
         end
       end
@@ -40,7 +40,6 @@ module Twitter
       def alias_method_sub(method, pattern, replacement)
         alias_method(method.to_s.sub(pattern, replacement).to_sym, method)
       end
-
     end
 
     # @return [Array<Twitter::Entity::URI>]
@@ -50,25 +49,25 @@ module Twitter
       end
     end
     memoize :description_uris
-    alias description_urls description_uris
+    alias_method :description_urls, :description_uris
 
     # Return the URL to the user's profile banner image
     #
     # @param size [String, Symbol] The size of the image. Must be one of: 'mobile', 'mobile_retina', 'web', 'web_retina', 'ipad', or 'ipad_retina'
     # @return [String]
-    def profile_banner_uri(size=:web)
+    def profile_banner_uri(size = :web)
       parse_encoded_uri(insecure_uri([@attrs[:profile_banner_url], size].join('/'))) if @attrs[:profile_banner_url]
     end
-    alias profile_banner_url profile_banner_uri
+    alias_method :profile_banner_url, :profile_banner_uri
 
     # Return the secure URL to the user's profile banner image
     #
     # @param size [String, Symbol] The size of the image. Must be one of: 'mobile', 'mobile_retina', 'web', 'web_retina', 'ipad', or 'ipad_retina'
     # @return [String]
-    def profile_banner_uri_https(size=:web)
+    def profile_banner_uri_https(size = :web)
       parse_encoded_uri([@attrs[:profile_banner_url], size].join('/')) if @attrs[:profile_banner_url]
     end
-    alias profile_banner_url_https profile_banner_uri_https
+    alias_method :profile_banner_url_https, :profile_banner_uri_https
 
     # @return [Boolean]
     def profile_banner_uri?
@@ -81,16 +80,16 @@ module Twitter
     #
     # @param size [String, Symbol] The size of the image. Must be one of: 'mini', 'normal', 'bigger' or 'original'
     # @return [String]
-    def profile_image_uri(size=:normal)
+    def profile_image_uri(size = :normal)
       parse_encoded_uri(insecure_uri(profile_image_uri_https(size))) if @attrs[:profile_image_url_https]
     end
-    alias profile_image_url profile_image_uri
+    alias_method :profile_image_url, :profile_image_uri
 
     # Return the secure URL to the user's profile image
     #
     # @param size [String, Symbol] The size of the image. Must be one of: 'mini', 'normal', 'bigger' or 'original'
     # @return [String]
-    def profile_image_uri_https(size=:normal)
+    def profile_image_uri_https(size = :normal)
       # The profile image URL comes in looking like like this:
       # https://a0.twimg.com/profile_images/1759857427/image1326743606_normal.png
       # It can be converted to any of the following sizes:
@@ -99,7 +98,7 @@ module Twitter
       # https://a0.twimg.com/profile_images/1759857427/image1326743606_bigger.png
       parse_encoded_uri(@attrs[:profile_image_url_https].sub(PROFILE_IMAGE_SUFFIX_REGEX, profile_image_suffix(size))) if @attrs[:profile_image_url_https]
     end
-    alias profile_image_url_https profile_image_uri_https
+    alias_method :profile_image_url_https, :profile_image_uri_https
 
     def profile_image_uri?
       !!@attrs[:profile_image_url_https]
@@ -112,7 +111,7 @@ module Twitter
       Addressable::URI.parse("https://twitter.com/#{screen_name}")
     end
     memoize :uri
-    alias url uri
+    alias_method :url, :uri
 
     # @return [String] The URL to the user's website.
     def website
@@ -136,8 +135,7 @@ module Twitter
     end
 
     def profile_image_suffix(size)
-      :original == size.to_sym ? "\\1" : "_#{size}\\1"
+      :original == size.to_sym ? '\\1' : "_#{size}\\1"
     end
-
   end
 end

data/lib/twitter/version.rb

@@ -1,18 +1,15 @@
 module Twitter
   class Version
     MAJOR = 5
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
     PRE = nil
 
     class << self
-
       # @return [String]
       def to_s
         [MAJOR, MINOR, PATCH, PRE].compact.join('.')
       end
-
     end
-
   end
 end