rest-client 1.2.0 → 1.3.0

data/lib/restclient/mixin/response.rb

@@ -3,8 +3,7 @@ module RestClient
     module Response
       attr_reader :net_http_res
 
-      # HTTP status code, always 200 since RestClient throws exceptions for
-      # other codes.
+      # HTTP status code
       def code
         @code ||= @net_http_res.code.to_i
       end
@@ -22,15 +21,32 @@ module RestClient
 
       # Hash of cookies extracted from response headers
       def cookies
-        @cookies ||= (self.headers[:set_cookie] || "").split('; ').inject({}) do |out, raw_c|
-          key, val = raw_c.split('=')
-          unless %w(expires domain path secure).member?(key)
-            out[key] = val
+        @cookies ||= (self.headers[:set_cookie] || []).inject({}) do |out, cookie_content|
+          # correctly parse comma-separated cookies containing HTTP dates (which also contain a comma)
+          cookie_content.split(/,\s*/).inject([""]) { |array, blob| 
+            blob =~ /expires=.+?$/ ? array.push(blob) : array.last.concat(blob)
+            array
+          }.each do |cookie|
+            next if cookie.empty?
+            key, *val = cookie.split(";").first.split("=")
+            out[key] = val.join("=")
           end
           out
         end
       end
 
+      # Return the default behavior corresponding to the response code:
+      # the response itself for code in 200..206 and an exception in other cases
+      def return!
+        if (200..206).include? code
+          self
+        elsif Exceptions::EXCEPTIONS_MAP[code]
+          raise Exceptions::EXCEPTIONS_MAP[code], self
+        else
+          raise RequestFailed, self
+        end
+      end
+
       def self.included(receiver)
         receiver.extend(RestClient::Mixin::Response::ClassMethods)
       end
@@ -38,7 +54,7 @@ module RestClient
       module ClassMethods
         def beautify_headers(headers)
           headers.inject({}) do |out, (key, value)|
-            out[key.gsub(/-/, '_').downcase.to_sym] = value.first
+            out[key.gsub(/-/, '_').downcase.to_sym] = %w{set-cookie}.include?(key.downcase) ? value : value.first
             out
           end
         end

data/lib/restclient/payload.rb

@@ -138,7 +138,7 @@ module RestClient
       end
 
       def create_regular_field(s, k, v)
-        s.write("Content-Disposition: multipart/form-data; name=\"#{k}\"")
+        s.write("Content-Disposition: form-data; name=\"#{k}\"")
         s.write(EOL)
         s.write(EOL)
         s.write(v)
@@ -146,7 +146,7 @@ module RestClient
 
       def create_file_field(s, k, v)
         begin
-          s.write("Content-Disposition: multipart/form-data; name=\"#{k}\"; filename=\"#{v.respond_to?(:original_filename) ? v.original_filename : File.basename(v.path)}\"#{EOL}")
+          s.write("Content-Disposition: form-data; name=\"#{k}\"; 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)

data/lib/restclient/request.rb

@@ -20,16 +20,18 @@ module RestClient
   # * :timeout and :open_timeout
   # * :ssl_client_cert, :ssl_client_key, :ssl_ca_file
   class Request
+
     attr_reader :method, :url, :payload, :headers, :processed_headers,
                 :cookies, :user, :password, :timeout, :open_timeout,
                 :verify_ssl, :ssl_client_cert, :ssl_client_key, :ssl_ca_file,
                 :raw_response
 
-    def self.execute(args)
-      new(args).execute
+
+    def self.execute(args, &block)
+      new(args).execute &block
     end
 
-    def initialize(args)
+    def initialize args
       @method = args[:method] or raise ArgumentError, "must pass :method"
       @url = args[:url] or raise ArgumentError, "must pass :url"
       @headers = args[:headers] || {}
@@ -48,23 +50,25 @@ module RestClient
       @processed_headers = make_headers headers
     end
 
-    def execute
-      execute_inner
+    def execute &block
+      execute_inner &block
     rescue Redirect => e
+      @processed_headers.delete "Content-Length"
+      @processed_headers.delete "Content-Type"
       @url = e.url
       @method = :get
       @payload = nil
-      execute
+      execute &block
     end
 
-    def execute_inner
+    def execute_inner &block
       uri = parse_url_with_auth(url)
-      transmit uri, net_http_request_class(method).new(uri.request_uri, processed_headers), payload
+      transmit uri, net_http_request_class(method).new(uri.request_uri, processed_headers), payload, &block
     end
 
     def make_headers user_headers
       unless @cookies.empty?
-        user_headers[:cookie] = @cookies.map {|key, val| "#{key.to_s}=#{val}" }.join('; ')
+        user_headers[:cookie] = @cookies.map {|(key, val)| "#{key.to_s}=#{val}" }.sort.join(",")
       end
 
       headers = default_headers.merge(user_headers).inject({}) do |final, (key, value)|
@@ -73,13 +77,13 @@ module RestClient
           target_value = value.to_s
           final[target_key] = MIME::Types.type_for_extension target_value
         elsif 'ACCEPT' == target_key.upcase
-            # Accept can be composed of several comma-separated values
-            if value.is_a? Array
-              target_values = value
-            else
-              target_values = value.to_s.split ','
-            end
-            final[target_key] = target_values.map{ |ext| MIME::Types.type_for_extension(ext.to_s.strip)}.join(', ')
+          # Accept can be composed of several comma-separated values
+          if value.is_a? Array
+            target_values = value
+          else
+            target_values = value.to_s.split ','
+          end
+          final[target_key] = target_values.map{ |ext| MIME::Types.type_for_extension(ext.to_s.strip)}.join(', ')
         else
           final[target_key] = value.to_s
         end
@@ -132,8 +136,8 @@ module RestClient
       end
     end
 
-    def transmit(uri, req, payload)
-      setup_credentials(req)
+    def transmit uri, req, payload, &block
+      setup_credentials req
 
       net = net_http_class.new(uri.host, uri.port)
       net.use_ssl = uri.is_a?(URI::HTTPS)
@@ -148,20 +152,12 @@ module RestClient
       net.read_timeout = @timeout if @timeout
       net.open_timeout = @open_timeout if @open_timeout
 
-      display_log request_log
+      log_request
 
       net.start do |http|
         res = http.request(req, payload) { |http_response| fetch_body(http_response) }
-        result = process_result(res)
-        display_log response_log(res)
-
-        if result.kind_of?(String) or @method == :head
-          Response.new(result, res)
-        elsif @raw_response
-          RawResponse.new(@tf, res)
-        else
-          Response.new(nil, res)
-        end
+        log_response res
+        process_result res, &block
       end
     rescue EOFError
       raise RestClient::ServerBrokeConnection
@@ -181,14 +177,16 @@ module RestClient
         @tf = Tempfile.new("rest-client")
         size, total = 0, http_response.header['Content-Length'].to_i
         http_response.read_body do |chunk|
-          @tf.write(chunk)
+          @tf.write chunk
           size += chunk.size
-          if size == 0
-            display_log("#{@method} #{@url} done (0 length file)")
-          elsif total == 0
-            display_log("#{@method} #{@url} (zero content length)")
-          else
-            display_log("#{@method} #{@url} %d%% done (%d of %d)" % [(size * 100) / total, size, total])
+          if RestClient.log
+            if size == 0
+              RestClient.log << "#{@method} #{@url} done (0 length file\n)"
+            elsif total == 0
+              RestClient.log << "#{@method} #{@url} (zero content length)\n"
+            else
+              RestClient.log << "#{@method} #{@url} %d%% done (%d of %d)\n" % [(size * 100) / total, size, total]
+            end
           end
         end
         @tf.close
@@ -199,13 +197,17 @@ module RestClient
       http_response
     end
 
-    def process_result(res)
-      if res.code =~ /\A2\d{2}\z/
+    def process_result res
+      if @raw_response
         # We don't decode raw requests
-        unless @raw_response
-          self.class.decode res['content-encoding'], res.body if res.body
-        end
-      elsif %w(301 302 303).include? res.code
+        response = RawResponse.new(@tf, res)
+      else
+        response = Response.new(Request.decode(res['content-encoding'], res.body), res)
+      end
+
+      code = res.code.to_i
+
+      if (301..303).include? code
         url = res.header['Location']
 
         if url !~ /^http/
@@ -213,53 +215,40 @@ module RestClient
           uri.path = "/#{url}".squeeze('/')
           url = uri.to_s
         end
-
         raise Redirect, url
-      elsif res.code == "304"
-        raise NotModified, res
-      elsif res.code == "401"
-        raise Unauthorized, res
-      elsif res.code == "404"
-        raise ResourceNotFound, res
       else
-        raise RequestFailed, res
+        if block_given?
+          yield response
+        else
+          response.return!
+        end
       end
     end
 
-    def self.decode(content_encoding, body)
+    def self.decode content_encoding, body
       if content_encoding == 'gzip' and not body.empty?
         Zlib::GzipReader.new(StringIO.new(body)).read
       elsif content_encoding == 'deflate'
-        Zlib::Inflate.new.inflate(body)
+        Zlib::Inflate.new.inflate body
       else
         body
       end
     end
 
-    def request_log
+    def log_request
       if RestClient.log
         out = []
         out << "RestClient.#{method} #{url.inspect}"
-        out << "headers: #{processed_headers.inspect}"
-        out << "paylod: #{payload.short_inspect}" if payload
-        out.join(', ')
+        out << payload.short_inspect if payload
+        out << processed_headers.inspect.gsub(/^\{/, '').gsub(/\}$/, '')
+        RestClient.log << out.join(', ') + "\n"
       end
     end
 
-    def response_log(res)
-      size = @raw_response ? File.size(@tf.path) : (res.body.nil? ? 0 : res.body.size)
-      "# => #{res.code} #{res.class.to_s.gsub(/^Net::HTTP/, '')} | #{(res['Content-type'] || '').gsub(/;.*$/, '')} #{size} bytes"
-    end
-
-    def display_log(msg)
-      return unless log_to = RestClient.log
-
-      if log_to == 'stdout'
-        STDOUT.puts msg
-      elsif log_to == 'stderr'
-        STDERR.puts msg
-      else
-        File.open(log_to, 'a') { |f| f.puts msg }
+    def log_response res
+      if RestClient.log
+        size = @raw_response ? File.size(@tf.path) : (res.body.nil? ? 0 : res.body.size)
+        RestClient.log << "# => #{res.code} #{res.class.to_s.gsub(/^Net::HTTP/, '')} | #{(res['Content-type'] || '').gsub(/;.*$/, '')} #{size} bytes\n"
       end
     end
 
@@ -274,7 +263,7 @@ module MIME
 
     # Return the first found content-type for a value considered as an extension or the value itself
     def type_for_extension ext
-      candidates =  @extension_index[ext]
+      candidates = @extension_index[ext]
       candidates.empty? ? ext : candidates[0].content_type
     end
 

data/lib/restclient/resource.rb

@@ -34,10 +34,11 @@ module RestClient
   #   site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
   #
   class Resource
-    attr_reader :url, :options
+    attr_reader :url, :options, :block
 
-    def initialize(url, options={}, backwards_compatibility=nil)
+    def initialize(url, options={}, backwards_compatibility=nil, &block)
       @url = url
+      @block = block
       if options.class == Hash
         @options = options
       else # compatibility with previous versions
@@ -45,38 +46,38 @@ module RestClient
       end
     end
 
-    def get(additional_headers={}, &b)
+    def get(additional_headers={}, &block)
       headers = (options[:headers] || {}).merge(additional_headers)
       Request.execute(options.merge(
               :method => :get,
               :url => url,
-              :headers => headers), &b)
+              :headers => headers), &(block || @block))
     end
 
-    def post(payload, additional_headers={}, &b)
+    def post(payload, additional_headers={}, &block)
       headers = (options[:headers] || {}).merge(additional_headers)
       Request.execute(options.merge(
               :method => :post,
               :url => url,
               :payload => payload,
-              :headers => headers), &b)
+              :headers => headers), &(block || @block))
     end
 
-    def put(payload, additional_headers={}, &b)
+    def put(payload, additional_headers={}, &block)
       headers = (options[:headers] || {}).merge(additional_headers)
       Request.execute(options.merge(
               :method => :put,
               :url => url,
               :payload => payload,
-              :headers => headers), &b)
+              :headers => headers), &(block || @block))
     end
 
-    def delete(additional_headers={}, &b)
+    def delete(additional_headers={}, &block)
       headers = (options[:headers] || {}).merge(additional_headers)
       Request.execute(options.merge(
               :method => :delete,
               :url => url,
-              :headers => headers), &b)
+              :headers => headers), &(block || @block))
     end
 
     def to_s

data/spec/exceptions_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/base'
 
 describe RestClient::Exception do
   it "sets the exception message to ErrorMessage" do
-    RestClient::ResourceNotFound.new.message.should == 'Resource not found'
+    RestClient::ResourceNotFound.new.message.should == 'Resource Not Found'
   end
 
   it "contains exceptions in RestClient" do
@@ -29,10 +29,8 @@ describe RestClient::RequestFailed do
   end
 
   it "http_body convenience method for fetching the body (decoding when necessary)" do
-    @response.stub!(:[]).with('content-encoding').and_return('gzip')
-    @response.stub!(:body).and_return('compressed body')
-    RestClient::Request.should_receive(:decode).with('gzip', 'compressed body').and_return('plain body')
-    RestClient::RequestFailed.new(@response).http_body.should == 'plain body'
+    RestClient::RequestFailed.new(@response).http_code.should == 502
+    RestClient::RequestFailed.new(@response).message.should == 'HTTP status code 502'
   end
 
   it "shows the status code in the message" do

data/spec/integration_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/base'
+
+require 'webmock/rspec'
+include WebMock
+
+describe RestClient do
+
+  it "a simple request" do
+    body = 'abc'
+    stub_request(:get, "www.example.com").to_return(:body => body, :status => 200)
+    response = RestClient.get "www.example.com"
+    response.code.should == 200
+    response.should == body
+  end
+
+  it "a simple request with gzipped content" do
+    stub_request(:get, "www.example.com").with(:headers => { 'Accept-Encoding' => 'gzip, deflate' }).to_return(:body => "\037\213\b\b\006'\252H\000\003t\000\313T\317UH\257\312,HM\341\002\000G\242(\r\v\000\000\000", :status => 200,  :headers => { 'Content-Encoding' => 'gzip' } )
+    response = RestClient.get "www.example.com"
+    response.code.should == 200
+    response.should == "i'm gziped\n"
+  end
+
+  it "a 404" do
+    body = "Ho hai ! I'm not here !"
+    stub_request(:get, "www.example.com").to_return(:body => body, :status => 404)
+    begin
+      RestClient.get "www.example.com"
+      raise
+    rescue RestClient::ResourceNotFound => e
+      e.http_code.should == 404
+      e.response.code.should == 404
+      e.response.should == body
+      e.http_body.should == body
+    end
+  end
+
+
+end

data/spec/mixin/response_spec.rb

@@ -5,7 +5,7 @@ class MockResponse
 
   def initialize(body, res)
     @net_http_res = res
-    @body = @body
+    @body = body
   end
 end
 

data/spec/payload_spec.rb

@@ -39,11 +39,11 @@ describe RestClient::Payload do
       m = RestClient::Payload::Multipart.new([[:bar, "baz"], [:foo, "bar"]])
       m.to_s.should == <<-EOS
 --#{m.boundary}\r
-Content-Disposition: multipart/form-data; name="bar"\r
+Content-Disposition: form-data; name="bar"\r
 \r
 baz\r
 --#{m.boundary}\r
-Content-Disposition: multipart/form-data; name="foo"\r
+Content-Disposition: form-data; name="foo"\r
 \r
 bar\r
 --#{m.boundary}--\r
@@ -55,7 +55,7 @@ bar\r
       m = RestClient::Payload::Multipart.new({:foo => f})
       m.to_s.should == <<-EOS
 --#{m.boundary}\r
-Content-Disposition: multipart/form-data; name="foo"; filename="master_shake.jpg"\r
+Content-Disposition: form-data; name="foo"; filename="master_shake.jpg"\r
 Content-Type: image/jpeg\r
 \r
 #{IO.read(f.path)}\r
@@ -70,7 +70,7 @@ Content-Type: image/jpeg\r
       m = RestClient::Payload::Multipart.new({:foo => f})
       m.to_s.should == <<-EOS
 --#{m.boundary}\r
-Content-Disposition: multipart/form-data; name="foo"; filename="foo.txt"\r
+Content-Disposition: form-data; name="foo"; filename="foo.txt"\r
 Content-Type: text/plain\r
 \r
 #{IO.read(f.path)}\r
@@ -82,7 +82,7 @@ Content-Type: text/plain\r
       m = RestClient::Payload::Multipart.new({:bar => {:baz => "foo"}})
       m.to_s.should == <<-EOS
 --#{m.boundary}\r
-Content-Disposition: multipart/form-data; name="bar[baz]"\r
+Content-Disposition: form-data; name="bar[baz]"\r
 \r
 foo\r
 --#{m.boundary}--\r
@@ -94,7 +94,7 @@ foo\r
       m = RestClient::Payload::Multipart.new({:foo => {:bar => f}})
       m.to_s.should == <<-EOS
 --#{m.boundary}\r
-Content-Disposition: multipart/form-data; name="foo[bar]"; filename="foo.txt"\r
+Content-Disposition: form-data; name="foo[bar]"; filename="foo.txt"\r
 Content-Type: text/plain\r
 \r
 #{IO.read(f.path)}\r