twitter 5.1.1 → 5.2.0

data/lib/twitter/rest/client.rb

@@ -88,23 +88,23 @@ module Twitter
       end
 
       # Perform an HTTP DELETE request
-      def delete(path, params={})
+      def delete(path, params = {})
         request(:delete, path, params)
       end
 
       # Perform an HTTP GET request
-      def get(path, params={})
+      def get(path, params = {})
         request(:get, path, params)
       end
 
       # Perform an HTTP POST request
-      def post(path, params={})
-        signature_params = params.values.any?{|value| value.respond_to?(:to_io)} ? {} : params
+      def post(path, params = {})
+        signature_params = params.values.any? { |value| value.respond_to?(:to_io) } ? {} : params
         request(:post, path, params, signature_params)
       end
 
       # Perform an HTTP PUT request
-      def put(path, params={})
+      def put(path, params = {})
         request(:put, path, params)
       end
 
@@ -127,7 +127,7 @@ module Twitter
         @connection ||= Faraday.new(ENDPOINT, connection_options)
       end
 
-      def request(method, path, params={}, signature_params=params)
+      def request(method, path, params = {}, signature_params = params) # rubocop:disable ParameterLists
         response = connection.send(method.to_sym, path, params) do |request|
           bearer_token_request = params.delete(:bearer_token_request)
           if bearer_token_request
@@ -143,7 +143,7 @@ module Twitter
         raise Twitter::Error
       end
 
-      def auth_token(method, path, params={}, signature_params=params)
+      def auth_token(method, path, params = {}, signature_params = params) # rubocop:disable ParameterLists
         if !user_token?
           @bearer_token = token unless bearer_token?
           bearer_auth_header
@@ -167,9 +167,8 @@ module Twitter
 
       # Base64.strict_encode64 is not available on Ruby 1.8.7
       def strict_encode64(str)
-        Base64.encode64(str).gsub("\n", "")
+        Base64.encode64(str).gsub("\n", '')
       end
-
     end
   end
 end

data/lib/twitter/rest/request/multipart_with_file.rb

@@ -29,7 +29,6 @@ module Twitter
             'application/octet-stream'
           end
         end
-
       end
     end
   end

data/lib/twitter/rest/response/parse_error_json.rb

@@ -4,11 +4,9 @@ module Twitter
   module REST
     module Response
       class ParseErrorJson < Twitter::REST::Response::ParseJson
-
         def unparsable_status_codes
           super + [200]
         end
-
       end
     end
   end

data/lib/twitter/rest/response/parse_json.rb

@@ -5,7 +5,6 @@ module Twitter
   module REST
     module Response
       class ParseJson < Faraday::Response::Middleware
-
         def parse(body)
           case body
           when /\A^\s*$\z/, nil
@@ -24,7 +23,6 @@ module Twitter
         def unparsable_status_codes
           [204, 301, 302, 304]
         end
-
       end
     end
   end

data/lib/twitter/rest/response/raise_error.rb

@@ -15,13 +15,11 @@ module Twitter
   module REST
     module Response
       class RaiseError < Faraday::Response::Middleware
-
         def on_complete(env)
           status_code = env[:status].to_i
           error_class = Twitter::Error.errors[status_code]
-          raise error_class.from_response(env) if error_class
+          fail error_class.from_response(env) if error_class
         end
-
       end
     end
   end

data/lib/twitter/search_results.rb

@@ -4,27 +4,25 @@ module Twitter
   class SearchResults
     include Twitter::Enumerable
     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 SearchResults object from a response hash
       #
       # @param response [Hash]
       # @return [Twitter::Base]
-      def from_response(response={})
+      def from_response(response = {})
         new(response[:body])
       end
-
     end
 
     # Initializes a new SearchResults object
     #
     # @param attrs [Hash]
     # @return [Twitter::SearchResults]
-    def initialize(attrs={})
+    def initialize(attrs = {})
       @attrs = attrs
       @collection = Array(@attrs[:statuses]).map do |tweet|
         Tweet.new(tweet)
@@ -55,8 +53,8 @@ module Twitter
     def results_per_page
       @attrs[:search_metadata][:count] if @attrs[:search_metadata]
     end
-    alias rpp results_per_page
-    alias count results_per_page
+    alias_method :rpp, :results_per_page
+    alias_method :count, :results_per_page
 
     # @return [Integer]
     def since_id
@@ -67,7 +65,7 @@ module Twitter
     def next_results?
       !!(@attrs[:search_metadata] && @attrs[:search_metadata][:next_results])
     end
-    alias next_page? next_results?
+    alias_method :next_page?, :next_results?
 
     # Returns a Hash of query parameters for the next result in the search
     #
@@ -79,7 +77,7 @@ module Twitter
         query_string_to_hash(query_string)
       end
     end
-    alias next_page next_results
+    alias_method :next_page, :next_results
 
     # Returns a Hash of query parameters for the refresh URL in the search
     #
@@ -89,7 +87,7 @@ module Twitter
       query_string = strip_first_character(@attrs[:search_metadata][:refresh_url])
       query_string_to_hash(query_string)
     end
-    alias refresh_page refresh_results
+    alias_method :refresh_page, :refresh_results
 
   private
 
@@ -110,7 +108,7 @@ module Twitter
     # @example Remove the first character from a query string
     #   strip_first_character!("?foo=bar&baz=qux") #=> "foo=bar&baz=qux"
     def strip_first_character!(string)
-      string[0] = ""
+      string[0] = ''
       string
     end
 
@@ -132,8 +130,7 @@ module Twitter
     # @example Convert hash's keys to symbols
     #   symbolize_keys({"foo"=>"bar", "baz"=>"qux"}) #=> {:foo=>"bar", :baz=>"qux"}
     def symbolize_keys(hash)
-      Hash[hash.map{|key, value| [key.to_sym, value]}]
+      Hash[hash.map { |key, value| [key.to_sym, value] }]
     end
-
   end
 end

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