rest-client 1.6.0 → 1.6.1.a

data/README.rdoc

@@ -100,11 +100,11 @@ A block can be passed to the RestClient method, this block will then be called w
 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, request| response }
+  RestClient.get('http://example.com/resource'){|response, request, result| response }
   ➔ 404 Resource Not Found | text/html 282 bytes
 
   # Manage a specific error code
-  RestClient.get('http://my-rest-service.com/resource'){ |response, request, &block|
+  RestClient.get('http://my-rest-service.com/resource'){ |response, request, result, &block|
     case response.code
     when 200
       p "It worked !"
@@ -112,7 +112,7 @@ Response.return! can be called to invoke the default response's behavior.
     when 423
       raise SomeCustomExceptionIfYouWant
     else
-      response.return!(request, &block)
+      response.return!(request, result, &block)
     end
   }
 
@@ -120,11 +120,11 @@ Response.return! can be called to invoke the default response's behavior.
   # RFC : "If the 301, 302 or 307 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, request, &block|
+  RestClient.get('http://my-rest-service.com/resource'){ |response, request, result, &block|
     if [301, 302, 307].include? response.code
-      response.follow_redirection(request, &block)
+      response.follow_redirection(request, result, &block)
     else
-      response.return!(request, &block)
+      response.return!(request, result, &block)
     end
   }
 

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.6.1

data/history.md

@@ -1,3 +1,12 @@
+# 1.6.1
+
+- add response body in Exception#inspect
+- add support for RestClient.options
+- fix tests for 1.9.2 (patch provided by Niko Dittmann)
+- block passing in Resource#[] (patch provided by Niko Dittmann)
+- cookies set in a response should be kept in a redirect
+- HEAD requests should process parameters just like GET (patch provided by Rob Eanes)
+
 # 1.6.0
 
 - forgot to include rest-client.rb in the gem

data/lib/restclient.rb

@@ -84,6 +84,10 @@ module RestClient
     Request.execute(:method => :head, :url => url, :headers => headers, &block)
   end
 
+  def self.options(url, headers={}, &block)
+    Request.execute(:method => :options, :url => url, :headers => headers, &block)
+  end
+
   class << self
     attr_accessor :proxy
   end

data/lib/restclient/abstract_response.rb

@@ -25,34 +25,29 @@ module RestClient
     # Hash of cookies extracted from response headers
     def cookies
       @cookies ||= (self.headers[:set_cookie] || {}).inject({}) do |out, cookie_content|
-        CGI::Cookie::parse(cookie_content).each do |key, cookie|
-          unless ['expires', 'path'].include? key
-            out[CGI::escape(key)] = cookie.value[0] ? (CGI::escape(cookie.value[0]) || '') : ''
-          end
-        end
-        out
+        out.merge parse_cookie(cookie_content)
       end
     end
 
     # Return the default behavior corresponding to the response code:
     # the response itself for code in 200..206, redirection for 301, 302 and 307 in get and head cases, redirection for 303 and an exception in other cases
-    def return! request  = nil, &block
+    def return! request  = nil, result = nil, & block
       if (200..207).include? code
         self
       elsif [301, 302, 307].include? code
         unless [:get, :head].include? args[:method]
-          raise Exceptions::EXCEPTIONS_MAP[code], self
+          raise Exceptions::EXCEPTIONS_MAP[code].new(self, code)
         else
-          follow_redirection(request, &block)
+          follow_redirection(request, result, & block)
         end
       elsif code == 303
         args[:method] = :get
         args.delete :payload
-        follow_redirection(request, &block)
+        follow_redirection(request, result, & block)
       elsif Exceptions::EXCEPTIONS_MAP[code]
-        raise Exceptions::EXCEPTIONS_MAP[code], self
+        raise Exceptions::EXCEPTIONS_MAP[code].new(self, code)
       else
-        raise RequestFailed, self
+        raise RequestFailed self
       end
     end
 
@@ -65,7 +60,7 @@ module RestClient
     end
 
     # Follow a redirection
-    def follow_redirection request = nil, &block
+    def follow_redirection request = nil, result = nil, & block
       url = headers[:location]
       if url !~ /^http/
         url = URI.parse(args[:url]).merge(url).to_s
@@ -75,6 +70,10 @@ module RestClient
         args[:password] = request.password
         args[:user] = request.user
         args[:headers] = request.headers
+        # 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
       end
       Request.execute args, &block
     end
@@ -85,5 +84,19 @@ module RestClient
         out
       end
     end
+
+    private
+
+    # Parse a cookie value and return its content in an Hash
+    def parse_cookie cookie_content
+      out = {}
+      CGI::Cookie::parse(cookie_content).each do |key, cookie|
+        unless ['expires', 'path'].include? key
+          out[CGI::escape(key)] = cookie.value[0] ? (CGI::escape(cookie.value[0]) || '') : ''
+        end
+      end
+      out
+    end
   end
+
 end

data/lib/restclient/exceptions.rb

@@ -82,8 +82,9 @@ module RestClient
   class Exception < RuntimeError
     attr_accessor :message, :response
 
-    def initialize response = nil
+    def initialize response = nil, initial_response_code = nil
       @response = response
+      @initial_response_code = initial_response_code
 
       # compatibility: this make the exception behave like a Net::HTTPResponse
       response.extend ResponseForException if response
@@ -91,7 +92,11 @@ module RestClient
 
     def http_code
       # return integer for compatibility
-      @response.code.to_i if @response
+      if @response
+        @response.code.to_i
+      else
+        @initial_response_code
+      end
     end
 
     def http_body
@@ -99,7 +104,11 @@ module RestClient
     end
 
     def inspect
-      "#{self.class} : #{http_code} #{message}"
+      "#{message}: #{http_body}"
+    end
+
+    def to_s
+      inspect
     end
 
   end
@@ -131,7 +140,7 @@ module RestClient
     # Compatibility
     superclass = ([304, 401, 404].include? code) ? ExceptionWithResponse : RequestFailed
     klass = Class.new(superclass) do
-      send(:define_method, :message) {message}
+      send(:define_method, :message) {"#{http_code ? "#{http_code} " : ''}#{message}"}
     end
     klass_constant = const_set message.delete(' \-\''), klass
     Exceptions::EXCEPTIONS_MAP[code] = klass_constant
@@ -158,7 +167,7 @@ module RestClient
 
   class SSLCertificateNotVerified < Exception
     def initialize(message)
-      super(nil)
+      super nil, nil
       self.message = message
     end
   end

data/lib/restclient/request.rb

@@ -62,7 +62,7 @@ module RestClient
 
     # Extract the query parameters for get request and append them to the url
     def process_get_params url, headers
-      if method == :get
+      if [:get, :head].include? method
         get_params = {}
         headers.delete_if do |key, value|
           if 'params' == key.to_s.downcase && value.is_a?(Hash)
@@ -215,9 +215,9 @@ module RestClient
       end
 
       if block_given?
-        block.call(response, self, & block)
+        block.call(response, self, res, & block)
       else
-        response.return!(self, & block)
+        response.return!(self, res, & block)
       end
 
     end

data/lib/restclient/resource.rb

@@ -130,8 +130,13 @@ module RestClient
     #   comments = first_post['comments']
     #   comments.post 'Hello', :content_type => 'text/plain'
     #
-    def [](suburl)
-      self.class.new(concat_urls(url, suburl), options)
+    def [](suburl, &new_block)
+      case
+        when block_given? then self.class.new(concat_urls(url, suburl), options, &new_block)
+        when block        then self.class.new(concat_urls(url, suburl), options, &block)
+      else
+        self.class.new(concat_urls(url, suburl), options)
+      end
     end
 
     def concat_urls(url, suburl) # :nodoc:

data/spec/abstract_response_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
 
 describe RestClient::AbstractResponse do
 

data/spec/base.rb

@@ -1,3 +1,9 @@
+def is_ruby_19?
+  RUBY_VERSION == '1.9.1' or RUBY_VERSION == '1.9.2'
+end
+
+Encoding.default_internal = Encoding.default_external = "ASCII-8BIT" if is_ruby_19?
+
 require 'rubygems'
 require 'spec'
 

data/spec/exceptions_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
 
 require 'webmock/rspec'
 include WebMock

data/spec/integration/request_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../base'
+require File.join( File.dirname(File.expand_path(__FILE__)), '../base')
 
 describe RestClient::Request do
   describe "ssl verification" do

data/spec/integration_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
 
 require 'webmock/rspec'
 include WebMock

data/spec/payload_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/base"
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
 
 describe RestClient::Payload do
   context "A regular Payload" do

data/spec/raw_response_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
 
 describe RestClient::RawResponse do
   before do

data/spec/request2_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
 
 require 'webmock/rspec'
 include WebMock

data/spec/request_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
 
 require 'webmock/rspec'
 include WebMock

data/spec/resource_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
 
 require 'webmock/rspec'
 include WebMock
@@ -72,6 +72,31 @@ describe RestClient::Resource do
     parent['posts'].password.should == 'password'
   end
 
+  it "passes a given block to subresources" do
+    block = Proc.new{|r| r}
+    parent = RestClient::Resource.new('http://example.com', &block)
+    parent['posts'].block.should == block
+  end
+
+  it "the block should be overrideable" do
+    block1 = Proc.new{|r| r}
+    block2 = Proc.new{|r| r}
+    parent = RestClient::Resource.new('http://example.com', &block1)
+    # parent['posts', &block2].block.should == block2 # ruby 1.9 syntax
+    parent.send(:[], 'posts', &block2).block.should == block2
+  end
+
+  it "the block should be overrideable in ruby 1.9 syntax" do
+    block = Proc.new{|r| r}
+    parent = RestClient::Resource.new('http://example.com', &block)
+    r19_syntax = %q{
+      parent['posts', &->(r){r}].block.should_not == block
+    }
+    if is_ruby_19?
+      eval(r19_syntax)
+    end
+  end
+
   it "prints its url with to_s" do
     RestClient::Resource.new('x').to_s.should == 'x'
   end

data/spec/response_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
 
 require 'webmock/rspec'
 include WebMock
@@ -90,6 +90,12 @@ describe RestClient::Response do
       RestClient::Request.execute(:url => 'http://some/resource', :method => :get, :user => 'foo', :password => 'bar', :headers => {:accept => :json}).body.should == 'Foo'
     end
 
+    it "follows a redirection and keep the cookies" do
+      stub_request(:get, 'http://some/resource').to_return(:body => '', :status => 301, :headers => {'Set-Cookie' => CGI::Cookie.new('Foo', 'Bar'), 'Location' => 'http://new/resource', })
+      stub_request(:get, 'http://new/resource').with(:headers => {'Cookie' => 'Foo=Bar'}).to_return(:body => 'Qux')
+      RestClient::Request.execute(:url => 'http://some/resource', :method => :get).body.should == 'Qux'
+    end
+
     it "doesn't follow a 301 when the request is a post" do
       net_http_res = mock('net http response', :code => 301)
       response = RestClient::Response.create('abc', net_http_res, {:method => :post})

data/spec/restclient_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
 
 describe RestClient do
   describe "API" do
@@ -26,6 +26,11 @@ describe RestClient do
       RestClient::Request.should_receive(:execute).with(:method => :head, :url => 'http://some/resource', :headers => {})
       RestClient.head('http://some/resource')
     end
+
+    it "OPTIONS" do
+      RestClient::Request.should_receive(:execute).with(:method => :options, :url => 'http://some/resource', :headers => {})
+      RestClient.options('http://some/resource')
+    end
   end
 
   describe "logging" do

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: rest-client
 version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
+  hash: 14
+  prerelease: true
   segments: 
   - 1
   - 6
-  - 0
-  version: 1.6.0
+  - 1
+  - a
+  version: 1.6.1.a
 platform: ruby
 authors: 
 - Adam Wiggins
@@ -16,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-28 00:00:00 +02:00
+date: 2010-07-24 00:00:00 +02:00
 default_executable: restclient
 dependencies: 
 - !ruby/object:Gem::Dependency