twitter 5.5.1 → 5.6.0

data/lib/twitter/rest/client.rb

@@ -2,9 +2,11 @@ require 'base64'
 require 'faraday'
 require 'faraday/request/multipart'
 require 'json'
+require 'timeout'
 require 'twitter/client'
 require 'twitter/error'
 require 'twitter/error/configuration_error'
+require 'twitter/error/request_timeout'
 require 'twitter/rest/api/direct_messages'
 require 'twitter/rest/api/favorites'
 require 'twitter/rest/api/friends_and_followers'
@@ -60,8 +62,8 @@ module Twitter
             :user_agent => user_agent,
           },
           :request => {
-            :open_timeout => 5,
-            :timeout => 10,
+            :open_timeout => 10,
+            :timeout => 30,
           },
         }
       end
@@ -69,29 +71,24 @@ module Twitter
       # @note Faraday's middleware stack implementation is comparable to that of Rack middleware.  The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.
       # @see https://github.com/technoweenie/faraday#advanced-middleware-usage
       # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
-      # @return [Faraday::Builder]
+      # @return [Faraday::RackBuilder]
       def middleware
-        @middleware ||= Faraday::Builder.new do |builder|
+        @middleware ||= Faraday::RackBuilder.new do |faraday|
           # Convert file uploads to Faraday::UploadIO objects
-          builder.use Twitter::REST::Request::MultipartWithFile
-          # Checks for files in the payload
-          builder.use Faraday::Request::Multipart
-          # Convert request params to "www-form-urlencoded"
-          builder.use Faraday::Request::UrlEncoded
+          faraday.request :multipart_with_file
+          # Checks for files in the payload, otherwise leaves everything untouched
+          faraday.request :multipart
+          # Encodes as "application/x-www-form-urlencoded" if not already encoded
+          faraday.request :url_encoded
           # Handle error responses
-          builder.use Twitter::REST::Response::RaiseError
+          faraday.response :raise_error
           # Parse JSON response bodies
-          builder.use Twitter::REST::Response::ParseJson
-          # Set Faraday's HTTP adapter
-          builder.adapter Faraday.default_adapter
+          faraday.response :parse_json
+          # Set default HTTP adapter
+          faraday.adapter :net_http
         end
       end
 
-      # Perform an HTTP DELETE request
-      def delete(path, params = {})
-        request(:delete, path, params)
-      end
-
       # Perform an HTTP GET request
       def get(path, params = {})
         request(:get, path, params)
@@ -103,11 +100,6 @@ module Twitter
         request(:post, path, params, signature_params)
       end
 
-      # Perform an HTTP PUT request
-      def put(path, params = {})
-        request(:put, path, params)
-      end
-
       # @return [Boolean]
       def bearer_token?
         !!bearer_token
@@ -127,23 +119,31 @@ module Twitter
         @connection ||= Faraday.new(ENDPOINT, connection_options)
       end
 
-      def request(method, path, params = {}, signature_params = params) # rubocop:disable ParameterLists
+      def request(method, path, params = {}, signature_params = params)
         response = connection.send(method.to_sym, path, params) do |request|
-          bearer_token_request = params.delete(:bearer_token_request)
-          if bearer_token_request
-            request.headers[:accept] = '*/*' # It is important we set this, otherwise we get an error.
-            request.headers[:authorization] = bearer_token_credentials_auth_header
-            request.headers[:content_type] = 'application/x-www-form-urlencoded; charset=UTF-8'
-          else
-            request.headers[:authorization] = auth_token(method, path, params, signature_params)
-          end
+          request.headers.update(request_headers(method, path, params, signature_params))
         end
         response.env
+      rescue Faraday::Error::TimeoutError, Timeout::Error => error
+        raise(Twitter::Error::RequestTimeout.new(error))
       rescue Faraday::Error::ClientError, JSON::ParserError => error
-        raise Twitter::Error.new(error) # rubocop:disable RaiseArgs
+        fail(Twitter::Error.new(error))
+      end
+
+      def request_headers(method, path, params = {}, signature_params = params)
+        bearer_token_request = params.delete(:bearer_token_request)
+        headers = {}
+        if bearer_token_request
+          headers[:accept]        = '*/*'
+          headers[:authorization] = bearer_token_credentials_auth_header
+          headers[:content_type]  = 'application/x-www-form-urlencoded; charset=UTF-8'
+        else
+          headers[:authorization] = auth_token(method, path, params, signature_params)
+        end
+        headers
       end
 
-      def auth_token(method, path, params = {}, signature_params = params) # rubocop:disable ParameterLists
+      def auth_token(method, path, params = {}, signature_params = params)
         if !user_token?
           @bearer_token = token unless bearer_token?
           bearer_auth_header

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

@@ -36,3 +36,5 @@ module Twitter
     end
   end
 end
+
+Faraday::Request.register_middleware :multipart_with_file => Twitter::REST::Request::MultipartWithFile

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

@@ -29,3 +29,5 @@ module Twitter
     end
   end
 end
+
+Faraday::Response.register_middleware :parse_json => Twitter::REST::Response::ParseJson

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

@@ -24,3 +24,5 @@ module Twitter
     end
   end
 end
+
+Faraday::Response.register_middleware :raise_error => Twitter::REST::Response::RaiseError

data/lib/twitter/search_results.rb

@@ -1,38 +1,38 @@
+require 'cgi'
 require 'twitter/enumerable'
+require 'twitter/utils'
+require 'uri'
 
 module Twitter
   class SearchResults
     include Twitter::Enumerable
+    include Twitter::Utils
     attr_reader :attrs
     alias_method :to_h, :attrs
-    alias_method :to_hash, :attrs
-    alias_method :to_hsh, :attrs
+    deprecate_alias :to_hash, :to_h
+    deprecate_alias :to_hsh, :to_h
 
     class << self
       # Construct a new SearchResults object from a response hash
       #
       # @param response [Hash]
-      # @param client [Twitter::REST::Client]
-      # @param path [String]
+      # @param request [Twitter::Request]
       # @return [Twitter::SearchResults]
-      def from_response(response, client, request_method, path, options) # rubocop:disable ParameterLists
-        new(response[:body], client, request_method, path, options)
+      def from_response(response, request)
+        new(response[:body], request)
       end
     end
 
     # Initializes a new SearchResults object
     #
     # @param attrs [Hash]
-    # @param client [Twitter::REST::Client]
-    # @param request_method [String, Symbol]
-    # @param path [String]
-    # @param options [Hash]
+    # @param request [Twitter::Request]
     # @return [Twitter::SearchResults]
-    def initialize(attrs, client, request_method, path, options = {}) # rubocop:disable ParameterLists
-      @client = client
-      @request_method = request_method.to_sym
-      @path = path
-      @options = options
+    def initialize(attrs, request)
+      @client = request.client
+      @request_method = request.verb
+      @path = request.path
+      @options = request.options
       @collection = []
       self.attrs = attrs
     end
@@ -41,60 +41,38 @@ module Twitter
 
     # @return [Boolean]
     def last?
-      !next_results?
+      !next_page?
     end
 
     # @return [Boolean]
-    def next_results?
-      !!(@attrs[:search_metadata] && @attrs[:search_metadata][:next_results])
+    def next_page?
+      !!@attrs[:search_metadata][:next_results] unless @attrs[:search_metadata].nil?
     end
-    alias_method :next_page?, :next_results?
-    alias_method :next?, :next_results?
 
     # Returns a Hash of query parameters for the next result in the search
     #
     # @note Returned Hash can be merged into the previous search options list to easily access the next page.
     # @return [Hash] The parameters needed to fetch the next page.
-    def next_results
-      if next_results?
-        query_string = strip_first_character(@attrs[:search_metadata][:next_results])
-        query_string_to_hash(query_string)
+    def next_page
+      if next_page?
+        query_string_to_hash(@attrs[:search_metadata][:next_results])
       end
     end
-    alias_method :next_page, :next_results
-    alias_method :next, :next_results
 
+    # @return [Hash]
     def fetch_next_page
       response = @client.send(@request_method, @path, next_page)
       self.attrs = response[:body]
     end
 
+    # @param attrs [Hash]
+    # @return [Hash]
     def attrs=(attrs)
       @attrs = attrs
-      Array(@attrs[:statuses]).map do |tweet|
+      Array(@attrs[:statuses]).collect do |tweet|
         @collection << Tweet.new(tweet)
       end
-    end
-
-    # Returns the string with the first character removed
-    #
-    # @param string [String]
-    # @return [String] A copy of string without the first character.
-    # @example Returns the query string with the question mark removed
-    #   strip_first_character("?foo=bar&baz=qux") #=> "foo=bar&baz=qux"
-    def strip_first_character(string)
-      strip_first_character!(string.dup)
-    end
-
-    # Removes the first character from a string
-    #
-    # @param string [String]
-    # @return [String] The string without the first character.
-    # @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
+      @attrs
     end
 
     # Converts query string to a hash
@@ -104,18 +82,8 @@ module Twitter
     # @example Convert query string to a hash
     #   query_string_to_hash("foo=bar&baz=qux") #=> {:foo=>"bar", :baz=>"qux"}
     def query_string_to_hash(query_string)
-      symbolize_keys(Faraday::Utils.parse_nested_query(query_string))
-    end
-
-    # Converts hash's keys to symbols
-    #
-    # @note Does not support nested hashes.
-    # @param hash [Hash]
-    # @return [Hash] The hash with symbols as keys.
-    # @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] }]
+      query = CGI.parse(URI.parse(query_string).query)
+      Hash[query.collect { |key, value| [key.to_sym, value.first] }]
     end
   end
 end

data/lib/twitter/streaming/client.rb

@@ -13,7 +13,7 @@ module Twitter
       # Initializes a new Client object
       #
       # @return [Twitter::Streaming::Client]
-      def initialize(options = {}, &block)
+      def initialize(options = {})
         super
         @connection = Streaming::Connection.new
       end
@@ -99,20 +99,20 @@ module Twitter
 
     private
 
-      def request(method, uri, params, &block) # rubocop:disable ParameterLists
+      def request(method, uri, params)
         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) # rubocop:disable AssignmentInCondition, IfUnlessModifier
-            block.call(item)
+            yield(item)
           end
         end
         @connection.stream(request, response)
       end
 
       def to_url_params(params)
-        params.map do |param, value|
+        params.collect do |param, value|
           [param, URI.encode(value)].join('=')
         end.sort.join('&')
       end

data/lib/twitter/suggestion.rb

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

data/lib/twitter/trend_results.rb

@@ -1,17 +1,19 @@
+require 'memoizable'
 require 'twitter/creatable'
 require 'twitter/enumerable'
-require 'memoizable'
 require 'twitter/null_object'
+require 'twitter/utils'
 
 module Twitter
   class TrendResults
     include Twitter::Creatable
     include Twitter::Enumerable
+    include Twitter::Utils
     include Memoizable
     attr_reader :attrs
     alias_method :to_h, :attrs
-    alias_method :to_hash, :attrs
-    alias_method :to_hsh, :attrs
+    deprecate_alias :to_hash, :to_h
+    deprecate_alias :to_hsh, :to_h
 
     class << self
       # Construct a new TrendResults object from a response hash
@@ -29,7 +31,7 @@ module Twitter
     # @return [Twitter::TrendResults]
     def initialize(attrs = {})
       @attrs = attrs
-      @collection = Array(@attrs[:trends]).map do |trend|
+      @collection = Array(@attrs[:trends]).collect do |trend|
         Trend.new(trend)
       end
     end

data/lib/twitter/tweet.rb

@@ -10,11 +10,11 @@ module Twitter
                 :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_method :favorites_count, :favorite_count
-    alias_method :favoriters_count, :favorite_count
+    deprecate_alias :favorites_count, :favorite_count
+    deprecate_alias :favoriters_count, :favorite_count
     alias_method :in_reply_to_tweet_id, :in_reply_to_status_id
     alias_method :reply?, :in_reply_to_status_id?
-    alias_method :retweeters_count, :retweet_count
+    deprecate_alias :retweeters_count, :retweet_count
     object_attr_reader :GeoFactory, :geo
     object_attr_reader :Metadata, :metadata
     object_attr_reader :Place, :place

data/lib/twitter/user.rb

@@ -34,7 +34,7 @@ module Twitter
 
     # @return [Array<Twitter::Entity::URI>]
     def description_uris
-      Array(@attrs[:entities][:description][:urls]).map do |entity|
+      Array(@attrs[:entities][:description][:urls]).collect do |entity|
         Entity::URI.new(entity)
       end
     end

data/lib/twitter/utils.rb

@@ -1,13 +1,28 @@
 module Twitter
   module Utils
-    module_function
+    class << self
+      def included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    module ClassMethods
+      def deprecate_alias(new_name, old_name)
+        define_method(new_name) do |*args, &block|
+          warn "#{Kernel.caller.first}: [DEPRECATION] ##{new_name} is deprecated. Use ##{old_name} instead."
+          send(old_name, *args, &block)
+        end
+      end
+    end
+
     def parallel_map(enumerable)
       # Don't bother spawning a new thread if there's only one item
       if enumerable.count == 1
-        enumerable.map { |object| yield object }
+        enumerable.collect { |object| yield object }
       else
-        enumerable.map { |object| Thread.new { yield object } }.map(&:value)
+        enumerable.collect { |object| Thread.new { yield object } }.collect(&:value)
       end
     end
+    module_function :parallel_map
   end
 end

data/lib/twitter/version.rb

@@ -1,8 +1,8 @@
 module Twitter
   class Version
     MAJOR = 5
-    MINOR = 5
-    PATCH = 1
+    MINOR = 6
+    PATCH = 0
     PRE = nil
 
     class << self

data/spec/helper.rb

@@ -8,7 +8,7 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 
 SimpleCov.start do
   add_filter '/spec/'
-  minimum_coverage(99.35)
+  minimum_coverage(99.42)
 end
 
 require 'twitter'

data/spec/twitter/error_spec.rb

@@ -36,7 +36,7 @@ describe Twitter::Error do
           stub_get('/1.1/statuses/user_timeline.json').with(:query => {:screen_name => 'sferik'}).to_return(:status => status, :body => body_message)
         end
         it "raises #{exception.name}" do
-          expect { @client.user_timeline('sferik') }.to raise_error exception
+          expect { @client.user_timeline('sferik') }.to raise_error(exception)
         end
       end
     end