RubyGems - rest-client - Versions diffs - 1.3.1 → 1.4.0.a - Mend

rest-client 1.3.1 → 1.4.0.a

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of rest-client might be problematic. Click here for more details.

Files changed (19) hide show

data/README.rdoc +41 -12
data/Rakefile +26 -23
data/VERSION +1 -1
data/history.md +13 -0
data/lib/restclient.rb +14 -1
data/lib/restclient/abstract_response.rb +87 -0
data/lib/restclient/exceptions.rb +41 -30
data/lib/restclient/payload.rb +13 -10
data/lib/restclient/raw_response.rb +7 -6
data/lib/restclient/request.rb +16 -35
data/lib/restclient/response.rb +36 -12
data/spec/{mixin/response_spec.rb → abstract_response_spec.rb} +3 -12
data/spec/integration_spec.rb +3 -3
data/spec/payload_spec.rb +9 -0
data/spec/raw_response_spec.rb +1 -1
data/spec/request_spec.rb +8 -42
data/spec/response_spec.rb +68 -10
metadata +23 -12
data/lib/restclient/mixin/response.rb +0 -64

data/README.rdoc CHANGED

@@ -49,11 +49,12 @@ See RestClient::Resource module docs for details.
 See RestClient::Resource docs for details.
-== Exceptions
+== Exceptions (see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html)
 * for results code between 200 and 206 a RestClient::Response will be returned
-* for results code between 301 and 303 the redirection will be automatically followed
-* for other result codes a RestClient::Exception holding the Response will be raised, a specific exception class will be thrown for know error codes
+* for results code 301 and 302 the redirection will be followed if the request is a get or a head
+* for result code 303 the redirection will be followed and the request transformed into a get
+* for other cases a RestClient::Exception holding the Response will be raised, a specific exception class will be thrown for know error codes
    RestClient.get 'http://example.com/resource'
    ➔ RestClient::ResourceNotFound: RestClient::ResourceNotFound
@@ -63,19 +64,19 @@ See RestClient::Resource docs for details.
    rescue => e
      e.response
    end
-   ➔ "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\n<html><head>\n<title>404 Not Found</title>..."
+   ➔ 404 Resource Not Found | text/html 282 bytes
 == Result handling
 A block can be passed to the RestClient method, this block will then be called with the Response.
-Response.return! can be called to invoke the default response's behavior (return the Response for 200..206, raise an exception in other cases).
+Response.return! can be called to invoke the default response's behavior.
   # Don't raise exceptions but return the response
-  RestClient.get('http://example.com/resource'){|response| response}
-  ➔ "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\n<html><head>\n<title>404 Not Found</title>..."
+  RestClient.get('http://example.com/resource'){|response| response }
+  ➔ 404 Resource Not Found | text/html 282 bytes
   # Manage a specific error code
-  RestClient.get('http://my-rest-service.com/resource'){ |response|
+  RestClient.get('http://my-rest-service.com/resource'){ |response, &block|
     case response.code
     when 200
       p "It worked !"
@@ -83,7 +84,19 @@ Response.return! can be called to invoke the default response's behavior (return
     when 423
       raise SomeCustomExceptionIfYouWant
     else
-      response.return!
+      response.return! &block
+    end
+  }
+  # Follow redirections for all request types and not only for get and head
+  # RFC : "If the 301 (or 302) status code is received in response to a request other than GET or HEAD,
+  #        the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user,
+  #        since this might change the conditions under which the request was issued."
+  RestClient.get('http://my-rest-service.com/resource'){ |response, &block|
+    if [301, 302].include? response.code
+      response.follow_redirection &block
+    else
+      response.return! &block
     end
   }
@@ -103,17 +116,17 @@ For cases not covered by the general API, you can use the RestClient::Resource c
 The restclient shell command gives an IRB session with RestClient already loaded:
   $ restclient
-  ➔ RestClient.get 'http://example.com'
+  >> RestClient.get 'http://example.com'
 Specify a URL argument for get/post/put/delete on that resource:
   $ restclient http://example.com
-  ➔ put '/resource', 'data'
+  >> put '/resource', 'data'
 Add a user and password for authenticated resources:
   $ restclient https://example.com user pass
-  ➔ delete '/private/resource'
+  >> delete '/private/resource'
 Create ~/.restclient for named sessions:
@@ -197,6 +210,22 @@ extract and set headers for them as needed:
 Self-signed certificates can be generated with the openssl command-line tool.
+== Hook
+RestClient.add_before_execution_proc add a Proc to be called before each execution, it's handy if you need a direct access to the http request.
+Example:
+  # Add oath support using the oauth gem
+  require 'oauth'
+  access_token = ...
+  RestClient.add_before_execution_proc do |req, params|
+    access_token.sign! req
+  end
+  RestClient.get 'http://example.com'
 == Meta
 Written by Adam Wiggins, major modifications by Blake Mizerany, maintained by Julien Kirch

data/Rakefile CHANGED

@@ -3,16 +3,19 @@ require 'rake'
 require 'jeweler'
 Jeweler::Tasks.new do |s|
-	s.name = "rest-client"
-	s.description = "A simple HTTP and REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete."
-	s.summary = "Simple HTTP and REST client for Ruby, inspired by microframework syntax for specifying actions."
-	s.author = "Adam Wiggins"
-	s.email = "rest.client@librelist.com"
-	s.homepage = "http://github.com/archiloque/rest-client"
-	s.rubyforge_project = "rest-client"
-	s.has_rdoc = true
-	s.files = FileList["[A-Z]*", "{bin,lib,spec}/**/*"]
-	s.executables = %w(restclient)
+  s.name = "rest-client"
+  s.description = "A simple HTTP and REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete."
+  s.summary = "Simple HTTP and REST client for Ruby, inspired by microframework syntax for specifying actions."
+  s.author = "Adam Wiggins"
+  s.email = "rest.client@librelist.com"
+  s.homepage = "http://github.com/archiloque/rest-client"
+  s.rubyforge_project = "rest-client"
+  s.has_rdoc = true
+  s.files = FileList["[A-Z]*", "{bin,lib,spec}/**/*"]
+  s.executables = %w(restclient)
+  s.add_dependency("mime-types", ">= 1.16")
+  s.add_development_dependency("webmock", ">= 0.9.1")
+  s.add_development_dependency("rspec")
 end
 Jeweler::RubyforgeTasks.new
@@ -23,21 +26,21 @@ require 'spec/rake/spectask'
 desc "Run all specs"
 Spec::Rake::SpecTask.new('spec') do |t|
-	t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
-	t.spec_files = FileList['spec/*_spec.rb']
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/*_spec.rb']
 end
 desc "Print specdocs"
 Spec::Rake::SpecTask.new(:doc) do |t|
-	t.spec_opts = ["--format", "specdoc", "--dry-run"]
-	t.spec_files = FileList['spec/*_spec.rb']
+  t.spec_opts = ["--format", "specdoc", "--dry-run"]
+  t.spec_files = FileList['spec/*_spec.rb']
 end
 desc "Run all examples with RCov"
 Spec::Rake::SpecTask.new('rcov') do |t|
-	t.spec_files = FileList['spec/*_spec.rb']
-	t.rcov = true
-	t.rcov_opts = ['--exclude', 'examples']
+  t.spec_files = FileList['spec/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'examples']
 end
 task :default => :spec
@@ -47,11 +50,11 @@ task :default => :spec
 require 'rake/rdoctask'
 Rake::RDocTask.new do |t|
-	t.rdoc_dir = 'rdoc'
-	t.title    = "rest-client, fetch RESTful resources effortlessly"
-	t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
-	t.options << '--charset' << 'utf-8'
-	t.rdoc_files.include('README.rdoc')
-	t.rdoc_files.include('lib/*.rb')
+  t.rdoc_dir = 'rdoc'
+  t.title    = "rest-client, fetch RESTful resources effortlessly"
+  t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  t.options << '--charset' << 'utf-8'
+  t.rdoc_files.include('README.rdoc')
+  t.rdoc_files.include('lib/*.rb')
 end

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 1.3.1
1	+ 1.4.0.a

data/history.md CHANGED

@@ -1,3 +1,14 @@
+# 1.4.0
+- Response is no more a String, and the mixin is replaced by an abstract_response, existing calls are redirected to response body with a warning.
+- enable repeated parameters  RestClient.post 'http://example.com/resource', :param1 => ['one', 'two', 'three'], => :param2 => 'foo' (patch provided by Rodrigo Panachi)
+- fixed the redirect code concerning relative path and query string combination (patch provided by Kevin Read)
+- redirection code moved to Response so redirection can be customized using the block syntax
+- only get and head redirections are now followed by default, as stated in the specification
+- added RestClient.add_before_execution_proc to hack the http request, like for oauth
+The response change may be breaking in rare cases.
 # 1.3.1
 - added compatibility to enable responses in exception to act like Net::HTTPResponse
@@ -11,6 +22,8 @@
 - all http error codes have now a corresponding exception class and all of them contain the Reponse -> this means that the raised exception can be different
 - changed "Content-Disposition: multipart/form-data" to "Content-Disposition: form-data" per RFC 2388 (patch provided by Kyle Crawford)
+The only breaking change should be the exception classes, but as the new classes inherits from the existing ones, the breaking cases should be rare.
 # 1.2.0
 - formatting changed from tabs to spaces

data/lib/restclient.rb CHANGED

@@ -11,7 +11,7 @@ end
 require File.dirname(__FILE__) + '/restclient/exceptions'
 require File.dirname(__FILE__) + '/restclient/request'
-require File.dirname(__FILE__) + '/restclient/mixin/response'
+require File.dirname(__FILE__) + '/restclient/abstract_response'
 require File.dirname(__FILE__) + '/restclient/response'
 require File.dirname(__FILE__) + '/restclient/raw_response'
 require File.dirname(__FILE__) + '/restclient/resource'
@@ -126,6 +126,7 @@ module RestClient
         else
           file_logger = Class.new do
             attr_writer :target_file
             def << obj
               File.open(@target_file, 'a') { |f| f.puts obj }
             end
@@ -148,4 +149,16 @@ module RestClient
     @@env_log || @@log
   end
+  @@before_execution_procs = []
+  # Add a Proc to be called before each request in executed.
+  # The proc parameters will be the http request and the request params.
+  def self.add_before_execution_proc &proc
+    @@before_execution_procs << proc
+  end
+  def self.before_execution_procs # :nodoc:
+    @@before_execution_procs
+  end
 end

data/lib/restclient/abstract_response.rb ADDED

@@ -0,0 +1,87 @@
+module RestClient
+  class AbstractResponse
+    attr_reader :net_http_res, :args
+    def initialize net_http_res, args
+      @net_http_res = net_http_res
+      @args = args
+    end
+    # HTTP status code
+    def code
+      @code ||= @net_http_res.code.to_i
+    end
+    # A hash of the headers, beautified with symbols and underscores.
+    # e.g. "Content-type" will become :content_type.
+    def headers
+      @headers ||= self.class.beautify_headers(@net_http_res.to_hash)
+    end
+    # The raw headers.
+    def raw_headers
+      @raw_headers ||= @net_http_res.to_hash
+    end
+    # Hash of cookies extracted from response headers
+    def cookies
+      @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, redirection for 301 and 302 in get and head cases, redirection for 303 and an exception in other cases
+    def return! &block
+      if (200..206).include? code
+        self
+      elsif [301, 302].include? code
+        unless [:get, :head].include? args[:method]
+          raise Exceptions::EXCEPTIONS_MAP[code], self
+        else
+          follow_redirection &block
+        end
+      elsif code == 303
+        args[:method] = :get
+        args.delete :payload
+        follow_redirection &block
+      elsif Exceptions::EXCEPTIONS_MAP[code]
+        raise Exceptions::EXCEPTIONS_MAP[code], self
+      else
+        raise RequestFailed, self
+      end
+    end
+    def inspect
+      "#{code} #{STATUSES[code]} | #{(headers[:content_type] || '').gsub(/;.*$/, '')} #{size} bytes\n"
+    end
+    # Follow a redirection
+    def follow_redirection &block
+      url = headers[:location]
+      if url !~ /^http/
+        url = URI.parse(args[:url]).merge(url).to_s
+      end
+      args[:url] = url
+      Request.execute args, &block
+    end
+    def AbstractResponse.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
+      end
+    end
+  end
+end

data/lib/restclient/exceptions.rb CHANGED

@@ -1,5 +1,44 @@
 module RestClient
+  STATUSES = {100 => 'Continue',
+              101 => 'Switching Protocols',
+              200 => 'OK',
+              201 => 'Created',
+              202 => 'Accepted',
+              203 => 'Non-Authoritative Information',
+              204 => 'No Content',
+              205 => 'Reset Content',
+              206 => 'Partial Content',
+              300 => 'Multiple Choices',
+              301 => 'Moved Permanently',
+              302 => 'Found',
+              303 => 'See Other',
+              304 => 'Not Modified',
+              305 => 'Use Proxy',
+              400 => 'Bad Request',
+              401 => 'Unauthorized',
+              403 => 'Forbidden',
+              404 => 'Resource Not Found',
+              405 => 'Method Not Allowed',
+              406 => 'Not Acceptable',
+              407 => 'Proxy Authentication Required',
+              408 => 'Request Timeout',
+              409 => 'Conflict',
+              410 => 'Gone',
+              411 => 'Length Required',
+              412 => 'Precondition Failed',
+              413 => 'Request Entity Too Large',
+              414 => 'Request-URI Too Long',
+              415 => 'Unsupported Media Type',
+              416 => 'Requested Range Not Satisfiable',
+              417 => 'Expectation Failed',
+              500 => 'Internal Server Error',
+              501 => 'Not Implemented',
+              502 => 'Bad Gateway',
+              503 => 'Service Unavailable',
+              504 => 'Gateway Timeout',
+              505 => 'HTTP Version Not Supported'}
   # Compatibility : make the Response act like a Net::HTTPResponse when needed
   module ResponseForException
     def method_missing symbol, *args
@@ -34,7 +73,7 @@ module RestClient
     end
     def http_body
-      @response
+      @response.body
     end
     def inspect
@@ -65,35 +104,7 @@ module RestClient
     EXCEPTIONS_MAP = {}
   end
-  {300 => 'Multiple Choices',
-   301 => 'Moved Permanently',
-   302 => 'Found',
-   303 => 'See Other',
-   304 => 'Not Modified',
-   305 => 'Use Proxy',
-   400 => 'Bad Request',
-   401 => 'Unauthorized',
-   403 => 'Forbidden',
-   404 => 'Resource Not Found',
-   405 => 'Method Not Allowed',
-   406 => 'Not Acceptable',
-   407 => 'Proxy Authentication Required',
-   408 => 'Request Timeout',
-   409 => 'Conflict',
-   410 => 'Gone',
-   411 => 'Length Required',
-   412 => 'Precondition Failed',
-   413 => 'Request Entity Too Large',
-   414 => 'Request-URI Too Long',
-   415 => 'Unsupported Media Type',
-   416 => 'Requested Range Not Satisfiable',
-   417 => 'Expectation Failed',
-   500 => 'Internal Server Error',
-   501 => 'Not Implemented',
-   502 => 'Bad Gateway',
-   503 => 'Service Unavailable',
-   504 => 'Gateway Timeout',
-   505 => 'HTTP Version Not Supported'}.each_pair do |code, message|
+  STATUSES.each_pair do |code, message|
     # Compatibility
     superclass = ([304, 401, 404].include? code) ? ExceptionWithResponse : RequestFailed

data/lib/restclient/payload.rb CHANGED

@@ -54,14 +54,17 @@ module RestClient
       # Flatten parameters by converting hashes of hashes to flat hashes
       # {keys1 => {keys2 => value}} will be transformed into {keys1[key2] => value}
       def flatten_params(params, parent_key = nil)
-        result = {}
-        params.keys.map do |key|
+        result = []
+        params.each do |key, value|
           calculated_key = parent_key ? "#{parent_key}[#{escape key}]" : escape(key)
-          value = params[key]
           if value.is_a? Hash
-            result.merge!(flatten_params(value, calculated_key))
+            result << flatten_params(value, calculated_key).flatten
+          elsif value.is_a? Array
+            value.each do |elem|
+              result << [calculated_key, elem]
+            end
           else
-            result[calculated_key] = value
+            result << [calculated_key, value]
           end
         end
         result
@@ -88,15 +91,15 @@ module RestClient
       end
       def short_inspect
-        (size > 100 ? "#{size} byte length" : inspect)
+        (size > 100 ? "#{size} byte(s) length" : inspect)
       end
     end
     class UrlEncoded < Base
       def build_stream(params = nil)
-        @stream = StringIO.new(flatten_params(params).map do |k, v|
-          "#{k}=#{escape(v)}"
+        @stream = StringIO.new(flatten_params(params).collect do |entry|
+          "#{entry[0]}=#{escape(entry[1])}"
         end.join("&"))
         @stream.seek(0)
       end
@@ -116,9 +119,9 @@ module RestClient
         @stream.write(b + EOL)
         if params.is_a? Hash
-          x = flatten_params(params).to_a
+          x = flatten_params(params)
         else
-          x = params.to_a
+          x = params
         end
         last_index = x.length - 1

data/lib/restclient/raw_response.rb CHANGED

@@ -1,5 +1,3 @@
-require File.dirname(__FILE__) + '/mixin/response'
 module RestClient
   # The response from RestClient on a raw request looks like a string, but is
   # actually one of these.  99% of the time you're making a rest call all you
@@ -11,13 +9,12 @@ module RestClient
   # In addition, if you do not use the response as a string, you can access
   # a Tempfile object at res.file, which contains the path to the raw
   # downloaded request body.
-  class RawResponse
-    include RestClient::Mixin::Response
+  class RawResponse < AbstractResponse
     attr_reader :file
-    def initialize(tempfile, net_http_res)
-      @net_http_res = net_http_res
+    def initialize tempfile, net_http_res, args
+      super net_http_res, args
       @file = tempfile
     end
@@ -26,5 +23,9 @@ module RestClient
       @file.read
     end
+    def size
+      File.size file
+    end
   end
 end

data/lib/restclient/request.rb CHANGED

@@ -21,11 +21,10 @@ module RestClient
   # * :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
+    attr_reader :method, :url, :headers, :cookies,
+                :payload, :user, :password, :timeout,
+                :open_timeout, :raw_response, :verify_ssl, :ssl_client_cert,
+                :ssl_client_key, :ssl_ca_file, :processed_headers, :args
     def self.execute(args, &block)
       new(args).execute &block
@@ -48,20 +47,10 @@ module RestClient
       @ssl_ca_file = args[:ssl_ca_file] || nil
       @tf = nil # If you are a raw request, this is your tempfile
       @processed_headers = make_headers headers
+      @args = args
     end
     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 &block
-    end
-    def execute_inner &block
       uri = parse_url_with_auth(url)
       transmit uri, net_http_request_class(method).new(uri.request_uri, processed_headers), payload, &block
     end
@@ -152,6 +141,10 @@ module RestClient
       net.read_timeout = @timeout if @timeout
       net.open_timeout = @open_timeout if @open_timeout
+      RestClient.before_execution_procs.each do |block|
+        block.call(req, args)
+      end
       log_request
       net.start do |http|
@@ -197,32 +190,20 @@ module RestClient
       http_response
     end
-    def process_result res
+    def process_result res, &block
       if @raw_response
         # We don't decode raw requests
-        response = RawResponse.new(@tf, res)
+        response = RawResponse.new(@tf, res, args)
       else
-        response = Response.new(Request.decode(res['content-encoding'], res.body), res)
+        response = Response.new(Request.decode(res['content-encoding'], res.body), res, args)
       end
-      code = res.code.to_i
-      if (301..303).include? code
-        url = res.header['Location']
-        if url !~ /^http/
-          uri = URI.parse(@url)
-          uri.path = "/#{url}".squeeze('/')
-          url = uri.to_s
-        end
-        raise Redirect, url
+      if block_given?
+        block.call response, &block
       else
-        if block_given?
-          yield response
-        else
-          response.return!
-        end
+        response.return! &block
       end
     end
     def self.decode content_encoding, body

data/lib/restclient/response.rb CHANGED

@@ -1,19 +1,43 @@
-require File.dirname(__FILE__) + '/mixin/response'
 module RestClient
-  # The response from RestClient looks like a string, but is actually one of
-  # these.  99% of the time you're making a rest call all you care about is
-  # the body, but on the occassion you want to fetch the headers you can:
-  #
-  #   RestClient.get('http://example.com').headers[:content_type]
+  # A Response from RestClient, you can access the response body, the code or the headers.
   #
-  class Response < String
+  class Response < AbstractResponse
+    attr_reader :body
+    def initialize body, net_http_res, args
+      super net_http_res, args
+      @body = body || ""
+    end
-    include RestClient::Mixin::Response
+    def method_missing symbol, *args
+      if body.respond_to? symbol
+        warn "[warning] The Response is no more a String, please update your code"
+        body.send symbol, *args
+      else
+        super
+      end
+    end
+    def == o
+      if super
+        true
+      else
+        equal_body = (body == o)
+        if equal_body
+          warn "[warning] The Response is no more a String, please update your code"
+        end
+        equal_body
+      end
+    end
+    def to_s
+      body.to_s
+    end
-    def initialize(string, net_http_res)
-      @net_http_res = net_http_res
-      super(string || "")
+    def size
+      body.size
     end
   end

data/spec/{mixin/response_spec.rb → abstract_response_spec.rb} RENAMED

@@ -1,18 +1,9 @@
-require File.dirname(__FILE__) + '/../base'
+require File.dirname(__FILE__) + '/base'
-class MockResponse
-  include RestClient::Mixin::Response
-  def initialize(body, res)
-    @net_http_res = res
-    @body = body
-  end
-end
-describe RestClient::Mixin::Response do
+describe RestClient::AbstractResponse do
   before do
     @net_http_res = mock('net http response')
-    @response = MockResponse.new('abc', @net_http_res)
+    @response = RestClient::AbstractResponse.new(@net_http_res, {})
   end
   it "fetches the numeric response code" do

data/spec/integration_spec.rb CHANGED

@@ -10,14 +10,14 @@ describe RestClient do
     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
+    response.body.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"
+    response.body.should == "i'm gziped\n"
   end
   it "a 404" do
@@ -29,7 +29,7 @@ describe RestClient do
     rescue RestClient::ResourceNotFound => e
       e.http_code.should == 404
       e.response.code.should == 404
-      e.response.should == body
+      e.response.body.should == body
       e.http_body.should == body
     end
   end

data/spec/payload_spec.rb CHANGED

@@ -10,6 +10,8 @@ describe RestClient::Payload do
     it "should form properly encoded params" do
       RestClient::Payload::UrlEncoded.new({:foo => 'bar'}).to_s.
               should == "foo=bar"
+      ["foo=bar&baz=qux", "baz=qux&foo=bar"].should include(
+      RestClient::Payload::UrlEncoded.new({:foo => 'bar', :baz => 'qux'}).to_s)
     end
     it "should properly handle hashes as parameter" do
@@ -26,6 +28,13 @@ describe RestClient::Payload do
               should == "foo[bar]=baz"
     end
+    it "should properyl handle arrays as repeated parameters" do
+      RestClient::Payload::UrlEncoded.new({:foo => ['bar']}).to_s.
+              should == "foo=bar"
+      RestClient::Payload::UrlEncoded.new({:foo => ['bar', 'baz']}).to_s.
+              should == "foo=bar&foo=baz"
+    end
   end
   context "A multipart Payload" do

data/spec/raw_response_spec.rb CHANGED

@@ -4,7 +4,7 @@ describe RestClient::RawResponse do
   before do
     @tf = mock("Tempfile", :read => "the answer is 42", :open => true)
     @net_http_res = mock('net http response')
-    @response = RestClient::RawResponse.new(@tf, @net_http_res)
+    @response = RestClient::RawResponse.new(@tf, @net_http_res, {})
   end
   it "behaves like string" do

data/spec/request_spec.rb CHANGED

@@ -1,5 +1,8 @@
 require File.dirname(__FILE__) + '/base'
+require 'webmock/rspec'
+include WebMock
 describe RestClient::Request do
   before do
     @request = RestClient::Request.new(:method => :put, :url => 'http://some/resource', :payload => 'payload')
@@ -45,7 +48,8 @@ describe RestClient::Request do
     res.stub!(:code).and_return("200")
     res.stub!(:body).and_return('body')
     res.stub!(:[]).with('content-encoding').and_return(nil)
-    @request.process_result(res).should == 'body'
+    @request.process_result(res).body.should == 'body'
+    @request.process_result(res).to_s.should == 'body'
   end
   it "doesn't classify successful requests as failed" do
@@ -153,7 +157,7 @@ describe RestClient::Request do
     @request.should_receive(:net_http_request_class).with(:put).and_return(klass)
     klass.should_receive(:new).and_return('result')
     @request.should_receive(:transmit).with(@uri, 'result', kind_of(RestClient::Payload::Base))
-    @request.execute_inner
+    @request.execute
   end
   it "transmits the request with Net::HTTP" do
@@ -225,11 +229,6 @@ describe RestClient::Request do
     lambda { @request.transmit(@uri, 'req', nil) }.should raise_error(RestClient::ServerBrokeConnection)
   end
-  it "execute calls execute_inner" do
-    @request.should_receive(:execute_inner)
-    @request.execute
-  end
   it "class method execute wraps constructor" do
     req = mock("rest request")
     RestClient::Request.should_receive(:new).with(1 => 2).and_return(req)
@@ -237,39 +236,6 @@ describe RestClient::Request do
     RestClient::Request.execute(1 => 2)
   end
-  describe "redirection" do
-    it "raises a Redirect with the new location when the response is in the 30x range" do
-      res = mock('response', :code => '301', :header => { 'Location' => 'http://new/resource'}, :[] => ['content-encoding' => ''], :body => '' )
-      lambda { @request.process_result(res) }.should raise_error(RestClient::Redirect) { |e| e.url.should == 'http://new/resource'}
-    end
-    it "handles redirects with relative paths" do
-      res = mock('response', :code => '301', :header => { 'Location' => 'index' }, :[] => ['content-encoding' => ''], :body => '' )
-      lambda { @request.process_result(res) }.should raise_error(RestClient::Redirect) { |e| e.url.should == 'http://some/index' }
-    end
-    it "handles redirects with absolute paths" do
-      @request.instance_variable_set('@url', 'http://some/place/else')
-      res = mock('response', :code => '301', :header => { 'Location' => '/index' }, :[] => ['content-encoding' => ''], :body => '' )
-      lambda { @request.process_result(res) }.should raise_error(RestClient::Redirect) { |e| e.url.should == 'http://some/index' }
-    end
-    it "uses GET and clears payload and removes possible harmful headers when following 30x redirects" do
-      url = "http://example.com/redirected"
-      @request.should_receive(:execute_inner).once.ordered.and_raise(RestClient::Redirect.new(url))
-      @request.should_receive(:execute_inner).once.ordered do
-        @request.processed_headers.should_not have_key("Content-Length")
-        @request.url.should == url
-        @request.method.should == :get
-        @request.payload.should be_nil
-      end
-      @request.execute
-    end
-  end
   describe "exception" do
     it "raises Unauthorized when the response is 401" do
       res = mock('response', :code => '401', :[] => ['content-encoding' => ''], :body => '' )
@@ -324,8 +290,8 @@ describe RestClient::Request do
     it "logs a post request with a large payload" do
       log = RestClient.log = []
       RestClient::Request.new(:method => :post, :url => 'http://url', :payload => ('x' * 1000)).log_request
-      ['RestClient.post "http://url", 1000 byte length, "Accept-encoding"=>"gzip, deflate", "Content-Length"=>"1000", "Accept"=>"*/*; q=0.5, application/xml"' + "\n",
-       'RestClient.post "http://url", 1000 byte length, "Accept"=>"*/*; q=0.5, application/xml", "Accept-encoding"=>"gzip, deflate", "Content-Length"=>"1000"' + "\n"].should include(log[0])
+      ['RestClient.post "http://url", 1000 byte(s) length, "Accept-encoding"=>"gzip, deflate", "Content-Length"=>"1000", "Accept"=>"*/*; q=0.5, application/xml"' + "\n",
+       'RestClient.post "http://url", 1000 byte(s) length, "Accept"=>"*/*; q=0.5, application/xml", "Accept-encoding"=>"gzip, deflate", "Content-Length"=>"1000"' + "\n"].should include(log[0])
     end
     it "logs input headers as a hash" do

data/spec/response_spec.rb CHANGED

@@ -1,17 +1,20 @@
 require File.dirname(__FILE__) + '/base'
+require 'webmock/rspec'
+include WebMock
 describe RestClient::Response do
   before do
     @net_http_res = mock('net http response', :to_hash => {"Status" => ["200 OK"]})
-    @response = RestClient::Response.new('abc', @net_http_res)
+    @response = RestClient::Response.new('abc', @net_http_res, {})
   end
   it "behaves like string" do
-    @response.should == 'abc'
+    @response.should.to_s == 'abc'
   end
   it "accepts nil strings and sets it to empty for the case of HEAD" do
-    RestClient::Response.new(nil, @net_http_res).should == ""
+    RestClient::Response.new(nil, @net_http_res, {}).should.to_s == ""
   end
   it "test headers and raw headers" do
@@ -22,14 +25,14 @@ describe RestClient::Response do
   describe "cookie processing" do
     it "should correctly deal with one Set-Cookie header with one cookie inside" do
       net_http_res = mock('net http response', :to_hash => {"etag" => ["\"e1ac1a2df945942ef4cac8116366baad\""], "set-cookie" => ["main_page=main_page_no_rewrite; path=/; expires=Tue, 20-Jan-2015 15:03:14 GMT"]})
-      response = RestClient::Response.new('abc', net_http_res)
+      response = RestClient::Response.new('abc', net_http_res, {})
       response.headers[:set_cookie].should == ["main_page=main_page_no_rewrite; path=/; expires=Tue, 20-Jan-2015 15:03:14 GMT"]
       response.cookies.should == { "main_page" => "main_page_no_rewrite" }
     end
     it "should correctly deal with multiple cookies [multiple Set-Cookie headers]" do
       net_http_res = mock('net http response', :to_hash => {"etag" => ["\"e1ac1a2df945942ef4cac8116366baad\""], "set-cookie" => ["main_page=main_page_no_rewrite; path=/; expires=Tue, 20-Jan-2015 15:03:14 GMT", "remember_me=; path=/; expires=Thu, 01-Jan-1970 00:00:00 GMT", "user=somebody; path=/; expires=Thu, 01-Jan-1970 00:00:00 GMT"]})
-      response = RestClient::Response.new('abc', net_http_res)
+      response = RestClient::Response.new('abc', net_http_res, {})
       response.headers[:set_cookie].should == ["main_page=main_page_no_rewrite; path=/; expires=Tue, 20-Jan-2015 15:03:14 GMT", "remember_me=; path=/; expires=Thu, 01-Jan-1970 00:00:00 GMT", "user=somebody; path=/; expires=Thu, 01-Jan-1970 00:00:00 GMT"]
       response.cookies.should == {
               "main_page" => "main_page_no_rewrite",
@@ -40,7 +43,7 @@ describe RestClient::Response do
     it "should correctly deal with multiple cookies [one Set-Cookie header with multiple cookies]" do
       net_http_res = mock('net http response', :to_hash => {"etag" => ["\"e1ac1a2df945942ef4cac8116366baad\""], "set-cookie" => ["main_page=main_page_no_rewrite; path=/; expires=Tue, 20-Jan-2015 15:03:14 GMT, remember_me=; path=/; expires=Thu, 01-Jan-1970 00:00:00 GMT, user=somebody; path=/; expires=Thu, 01-Jan-1970 00:00:00 GMT"]})
-      response = RestClient::Response.new('abc', net_http_res)
+      response = RestClient::Response.new('abc', net_http_res, {})
       response.cookies.should == {
               "main_page" => "main_page_no_rewrite",
               "remember_me" => "",
@@ -53,20 +56,75 @@ describe RestClient::Response do
     it "should return itself for normal codes" do
       (200..206).each do |code|
         net_http_res = mock('net http response', :code => '200')
-        response = RestClient::Response.new('abc', net_http_res)
+        response = RestClient::Response.new('abc', net_http_res, {})
         response.return!
       end
     end
     it "should throw an exception for other codes" do
       RestClient::Exceptions::EXCEPTIONS_MAP.each_key do |code|
-        net_http_res = mock('net http response', :code => code.to_i)
-        response = RestClient::Response.new('abc', net_http_res)
-        lambda { response.return!}.should raise_error
+        unless (200..206).include? code
+          net_http_res = mock('net http response', :code => code.to_i)
+          response = RestClient::Response.new('abc', net_http_res, {})
+          lambda { response.return!}.should raise_error
+        end
       end
     end
   end
+  describe "redirection" do
+    it "follows a redirection when the request is a get" do
+      stub_request(:get, 'http://some/resource').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://new/resource'})
+      stub_request(:get, 'http://new/resource').to_return(:body => 'Foo')
+      RestClient::Request.execute(:url => 'http://some/resource', :method => :get).body.should == 'Foo'
+    end
+    it "doesn't follow a redirection when the request is a post" do
+      net_http_res = mock('net http response', :code => 301)
+      response = RestClient::Response.new('abc', net_http_res, {:method => :post})
+      lambda { response.return!}.should raise_error(RestClient::MovedPermanently)
+    end
+    it "doesn't follow a redirection when the request is a put" do
+      net_http_res = mock('net http response', :code => 301)
+      response = RestClient::Response.new('abc', net_http_res, {:method => :put})
+      lambda { response.return!}.should raise_error(RestClient::MovedPermanently)
+    end
+    it "follows a redirection when the request is a post and result is a 303" do
+      stub_request(:put, 'http://some/resource').to_return(:body => '', :status => 303, :headers => {'Location' => 'http://new/resource'})
+      stub_request(:get, 'http://new/resource').to_return(:body => 'Foo')
+      RestClient::Request.execute(:url => 'http://some/resource', :method => :put).body.should == 'Foo'
+    end
+    it "follows a redirection when the request is a head" do
+      stub_request(:head, 'http://some/resource').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://new/resource'})
+      stub_request(:head, 'http://new/resource').to_return(:body => 'Foo')
+      RestClient::Request.execute(:url => 'http://some/resource', :method => :head).body.should == 'Foo'
+    end
+    it "handles redirects with relative paths" do
+      stub_request(:get, 'http://some/resource').to_return(:body => '', :status => 301, :headers => {'Location' => 'index'})
+      stub_request(:get, 'http://some/index').to_return(:body => 'Foo')
+      RestClient::Request.execute(:url => 'http://some/resource', :method => :get).body.should == 'Foo'
+    end
+    it "handles redirects with relative path and query string" do
+      stub_request(:get, 'http://some/resource').to_return(:body => '', :status => 301, :headers => {'Location' => 'index?q=1'})
+      stub_request(:get, 'http://some/index?q=1').to_return(:body => 'Foo')
+      RestClient::Request.execute(:url => 'http://some/resource', :method => :get).body.should == 'Foo'
+    end
+    it "follow a redirection when the request is a get and the response is in the 30x range" do
+      stub_request(:get, 'http://some/resource').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://new/resource'})
+      stub_request(:get, 'http://new/resource').to_return(:body => 'Foo')
+      RestClient::Request.execute(:url => 'http://some/resource', :method => :get).body.should == 'Foo'
+    end
+  end
 end

metadata CHANGED

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rest-client
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  prerelease: true
+  segments:
+  - 1
+  - 4
+  - 0
+  - a
+  version: 1.4.0.a
 platform: ruby
 authors:
 - Adam Wiggins
@@ -10,19 +16,22 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-01-25 00:00:00 +01:00
+date: 2010-02-22 00:00:00 +01:00
 default_executable: restclient
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
-  type: :runtime
-  version_requirement:
-  version_requirements: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
+        segments:
+        - 1
+        - 16
         version: "1.16"
-    version:
+  type: :runtime
+  version_requirements: *id001
 description: "A simple Simple HTTP and REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete."
 email: rest.client@librelist.com
 executables:
@@ -40,7 +49,7 @@ files:
 - lib/rest_client.rb
 - lib/restclient.rb
 - lib/restclient/exceptions.rb
-- lib/restclient/mixin/response.rb
+- lib/restclient/abstract_response.rb
 - lib/restclient/net_http_ext.rb
 - lib/restclient/payload.rb
 - lib/restclient/raw_response.rb
@@ -51,7 +60,7 @@ files:
 - spec/exceptions_spec.rb
 - spec/integration_spec.rb
 - spec/master_shake.jpg
-- spec/mixin/response_spec.rb
+- spec/abstract_response_spec.rb
 - spec/payload_spec.rb
 - spec/raw_response_spec.rb
 - spec/request_spec.rb
@@ -72,18 +81,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
+      segments:
+      - 0
       version: "0"
-  version:
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
+      segments:
+      - 0
       version: "0"
-  version:
 requirements: []
 rubyforge_project: rest-client
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key:
 specification_version: 3
 summary: Simple REST client for Ruby, inspired by microframework syntax for specifying actions.
@@ -91,7 +102,7 @@ test_files:
 - spec/base.rb
 - spec/exceptions_spec.rb
 - spec/integration_spec.rb
-- spec/mixin/response_spec.rb
+- spec/abstract_response_spec.rb
 - spec/payload_spec.rb
 - spec/raw_response_spec.rb
 - spec/request_spec.rb

data/lib/restclient/mixin/response.rb DELETED

@@ -1,64 +0,0 @@
-module RestClient
-  module Mixin
-    module Response
-      attr_reader :net_http_res
-      # HTTP status code
-      def code
-        @code ||= @net_http_res.code.to_i
-      end
-      # A hash of the headers, beautified with symbols and underscores.
-      # e.g. "Content-type" will become :content_type.
-      def headers
-        @headers ||= self.class.beautify_headers(@net_http_res.to_hash)
-      end
-      # The raw headers.
-      def raw_headers
-        @raw_headers ||= @net_http_res.to_hash
-      end
-      # Hash of cookies extracted from response headers
-      def cookies
-        @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
-      module ClassMethods
-        def 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
-          end
-        end
-      end
-    end
-  end
-end