rest-client 1.6.7 → 1.8.0

data/lib/restclient/abstract_response.rb

@@ -1,10 +1,11 @@
 require 'cgi'
+require 'http-cookie'
 
 module RestClient
 
   module AbstractResponse
 
-    attr_reader :net_http_res, :args
+    attr_reader :net_http_res, :args, :request
 
     # HTTP status code
     def code
@@ -22,11 +23,36 @@ module RestClient
       @raw_headers ||= @net_http_res.to_hash
     end
 
+    def response_set_vars(net_http_res, args, request)
+      @net_http_res = net_http_res
+      @args = args
+      @request = request
+    end
+
     # Hash of cookies extracted from response headers
     def cookies
-      @cookies ||= (self.headers[:set_cookie] || {}).inject({}) do |out, cookie_content|
-        out.merge parse_cookie(cookie_content)
+      hash = {}
+
+      cookie_jar.cookies.each do |cookie|
+        hash[cookie.name] = cookie.value
       end
+
+      hash
+    end
+
+    # Cookie jar extracted from response headers.
+    #
+    # @return [HTTP::CookieJar]
+    #
+    def cookie_jar
+      return @cookie_jar if @cookie_jar
+
+      jar = HTTP::CookieJar.new
+      headers.fetch(:set_cookie, []).each do |cookie|
+        jar.parse(cookie, @request.url)
+      end
+
+      @cookie_jar = jar
     end
 
     # Return the default behavior corresponding to the response code:
@@ -61,28 +87,31 @@ module RestClient
 
     # Follow a redirection
     def follow_redirection request = nil, result = nil, & block
+      new_args = @args.dup
+
       url = headers[:location]
       if url !~ /^http/
-        url = URI.parse(args[:url]).merge(url).to_s
+        url = URI.parse(request.url).merge(url).to_s
       end
-      args[:url] = url
+      new_args[:url] = url
       if request
         if request.max_redirects == 0
           raise MaxRedirectsReached
         end
-        args[:password] = request.password
-        args[:user] = request.user
-        args[:headers] = request.headers
-        args[:max_redirects] = request.max_redirects - 1
-        # pass any cookie set in the result
-        if result && result['set-cookie']
-          args[:headers][:cookies] = (args[:headers][:cookies] || {}).merge(parse_cookie(result['set-cookie']))
-        end
+        new_args[:password] = request.password
+        new_args[:user] = request.user
+        new_args[:headers] = request.headers
+        new_args[:max_redirects] = request.max_redirects - 1
+
+        # TODO: figure out what to do with original :cookie, :cookies values
+        new_args[:headers]['Cookie'] = HTTP::Cookie.cookie_value(
+          cookie_jar.cookies(new_args.fetch(:url)))
       end
-      Request.execute args, &block
+
+      Request.execute(new_args, &block)
     end
 
-    def AbstractResponse.beautify_headers(headers)
+    def self.beautify_headers(headers)
       headers.inject({}) do |out, (key, value)|
         out[key.gsub(/-/, '_').downcase.to_sym] = %w{ set-cookie }.include?(key.downcase) ? value : value.first
         out

data/lib/restclient/exceptions.rb

@@ -21,7 +21,7 @@ module RestClient
               305 => 'Use Proxy', # http/1.1
               306 => 'Switch Proxy', # no longer used
               307 => 'Temporary Redirect', # http/1.1
-              
+
               400 => 'Bad Request',
               401 => 'Unauthorized',
               402 => 'Payment Required',
@@ -40,13 +40,16 @@ module RestClient
               415 => 'Unsupported Media Type',
               416 => 'Requested Range Not Satisfiable',
               417 => 'Expectation Failed',
-              418 => 'I\'m A Teapot',
+              418 => 'I\'m A Teapot', #RFC2324
               421 => 'Too Many Connections From This IP',
               422 => 'Unprocessable Entity', #WebDAV
               423 => 'Locked', #WebDAV
               424 => 'Failed Dependency', #WebDAV
               425 => 'Unordered Collection', #WebDAV
-              426 => 'Upgrade Required', 
+              426 => 'Upgrade Required',
+              428 => 'Precondition Required', #RFC6585
+              429 => 'Too Many Requests', #RFC6585
+              431 => 'Request Header Fields Too Large', #RFC6585
               449 => 'Retry With', #Microsoft
               450 => 'Blocked By Windows Parental Controls', #Microsoft
 
@@ -59,7 +62,9 @@ module RestClient
               506 => 'Variant Also Negotiates',
               507 => 'Insufficient Storage', #WebDAV
               509 => 'Bandwidth Limit Exceeded', #Apache
-              510 => 'Not Extended'}
+              510 => 'Not Extended',
+              511 => 'Network Authentication Required', # RFC6585
+  }
 
   # Compatibility : make the Response act like a Net::HTTPResponse when needed
   module ResponseForException
@@ -81,10 +86,11 @@ module RestClient
   # probably an HTML error page) is e.response.
   class Exception < RuntimeError
     attr_accessor :response
-    attr_writer   :message
+    attr_writer :message
 
     def initialize response = nil, initial_response_code = nil
       @response = response
+      @message = nil
       @initial_response_code = initial_response_code
 
       # compatibility: this make the exception behave like a Net::HTTPResponse
@@ -111,7 +117,7 @@ module RestClient
     def to_s
       inspect
     end
-    
+
     def message
       @message || self.class.name
     end
@@ -154,7 +160,9 @@ module RestClient
   # A redirect was encountered; caught by execute to retry with the new url.
   class Redirect < Exception
 
-    message = 'Redirect'
+    def message
+      'Redirect'
+    end
 
     attr_accessor :url
 
@@ -163,8 +171,10 @@ module RestClient
     end
   end
 
-  class MaxRedirectsReached < Exception	
-    message = 'Maximum number of redirect reached'	
+  class MaxRedirectsReached < Exception
+    def message
+      'Maximum number of redirect reached'
+    end
   end
 
   # The server broke the connection prior to the request completing.  Usually
@@ -185,8 +195,8 @@ module RestClient
   end
 end
 
-# backwards compatibility
 class RestClient::Request
+  # backwards compatibility
   Redirect = RestClient::Redirect
   Unauthorized = RestClient::Unauthorized
   RequestFailed = RestClient::RequestFailed

data/lib/restclient/payload.rb

@@ -9,14 +9,14 @@ module RestClient
     def generate(params)
       if params.is_a?(String)
         Base.new(params)
-      elsif params.respond_to?(:read)
-        Streamed.new(params)
-      elsif params
+      elsif params.is_a?(Hash)
         if params.delete(:multipart) == true || has_file?(params)
           Multipart.new(params)
         else
           UrlEncoded.new(params)
         end
+      elsif params.respond_to?(:read)
+        Streamed.new(params)
       else
         nil
       end
@@ -25,12 +25,12 @@ module RestClient
     def has_file?(params)
       params.any? do |_, v|
         case v
-          when Hash
-            has_file?(v)
-          when Array
-            has_file_array?(v)
-          else
-            v.respond_to?(:path) && v.respond_to?(:read)
+        when Hash
+          has_file?(v)
+        when Array
+          has_file_array?(v)
+        else
+          v.respond_to?(:path) && v.respond_to?(:read)
         end
       end
     end
@@ -38,13 +38,13 @@ module RestClient
     def has_file_array?(params)
       params.any? do |v|
         case v
-          when Hash
-            has_file?(v)
-          when Array
-            has_file_array?(v)
-          else
-            v.respond_to?(:path) && v.respond_to?(:read)
-          end
+        when Hash
+          has_file?(v)
+        when Array
+          has_file_array?(v)
+        else
+          v.respond_to?(:path) && v.respond_to?(:read)
+        end
       end
     end
 
@@ -147,12 +147,15 @@ module RestClient
 
       # for UrlEncoded escape the keys
       def handle_key key
-        URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+        Parser.escape(key.to_s, Escape)
       end
 
       def headers
         super.merge({'Content-Type' => 'application/x-www-form-urlencoded'})
       end
+
+      Parser = URI.const_defined?(:Parser) ? URI::Parser.new : URI
+      Escape = Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
     end
 
     class Multipart < Base
@@ -201,7 +204,7 @@ module RestClient
           s.write(" filename=\"#{v.respond_to?(:original_filename) ? v.original_filename : File.basename(v.path)}\"#{EOL}")
           s.write("Content-Type: #{v.respond_to?(:content_type) ? v.content_type : mime_for(v.path)}#{EOL}")
           s.write(EOL)
-          while data = v.read(8124)
+          while (data = v.read(8124))
             s.write(data)
           end
         ensure

data/lib/restclient/platform.rb

@@ -0,0 +1,30 @@
+module RestClient
+  module Platform
+    # Return true if we are running on a darwin-based Ruby platform. This will
+    # be false for jruby even on OS X.
+    #
+    # @return [Boolean]
+    def self.mac_mri?
+      RUBY_PLATFORM.include?('darwin')
+    end
+
+    # Return true if we are running on Windows.
+    #
+    # @return [Boolean]
+    #
+    def self.windows?
+      # Ruby only sets File::ALT_SEPARATOR on Windows, and the Ruby standard
+      # library uses that to test what platform it's on.
+      !!File::ALT_SEPARATOR
+    end
+
+    # Return true if we are running on jruby.
+    #
+    # @return [Boolean]
+    #
+    def self.jruby?
+      # defined on mri >= 1.9
+      RUBY_ENGINE == 'jruby'
+    end
+  end
+end

data/lib/restclient/raw_response.rb

@@ -13,12 +13,13 @@ module RestClient
 
     include AbstractResponse
 
-    attr_reader :file
+    attr_reader :file, :request
 
-    def initialize tempfile, net_http_res, args
+    def initialize(tempfile, net_http_res, args, request)
       @net_http_res = net_http_res
       @args = args
       @file = tempfile
+      @request = request
     end
 
     def to_s