rest-client 1.1.0 → 1.6.3

data/spec/resource_spec.rb

@@ -1,75 +1,134 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
+
+require 'webmock/rspec'
+include WebMock
 
 describe RestClient::Resource do
-	before do
-		@resource = RestClient::Resource.new('http://some/resource', :user => 'jane', :password => 'mypass', :headers => { 'X-Something' => '1'})
-	end
-
-	context "Resource delegation" do
-		it "GET" do
-			RestClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => { 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
-			@resource.get
-		end
-
-		it "POST" do
-			RestClient::Request.should_receive(:execute).with(:method => :post, :url => 'http://some/resource', :payload => 'abc', :headers => { :content_type => 'image/jpg', 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
-			@resource.post 'abc', :content_type => 'image/jpg'
-		end
-
-		it "PUT" do
-			RestClient::Request.should_receive(:execute).with(:method => :put, :url => 'http://some/resource', :payload => 'abc', :headers => { :content_type => 'image/jpg', 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
-			@resource.put 'abc', :content_type => 'image/jpg'
-		end
-
-		it "DELETE" do
-			RestClient::Request.should_receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => { 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
-			@resource.delete
-		end
-
-		it "overrides resource headers" do
-			RestClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => { 'X-Something' => '2'}, :user => 'jane', :password => 'mypass')
-			@resource.get 'X-Something' => '2'
-		end
-	end
-
-	it "can instantiate with no user/password" do
-		@resource = RestClient::Resource.new('http://some/resource')
-	end
-
-	it "is backwards compatible with previous constructor" do
-		@resource = RestClient::Resource.new('http://some/resource', 'user', 'pass')
-		@resource.user.should == 'user'
-		@resource.password.should == 'pass'
-	end
-
-	it "concatenates urls, inserting a slash when it needs one" do
-		@resource.concat_urls('http://example.com', 'resource').should == 'http://example.com/resource'
-	end
-
-	it "concatenates urls, using no slash if the first url ends with a slash" do
-		@resource.concat_urls('http://example.com/', 'resource').should == 'http://example.com/resource'
-	end
-
-	it "concatenates urls, using no slash if the second url starts with a slash" do
-		@resource.concat_urls('http://example.com', '/resource').should == 'http://example.com/resource'
-	end
-
-	it "concatenates even non-string urls, :posts + 1 => 'posts/1'" do
-		@resource.concat_urls(:posts, 1).should == 'posts/1'
-	end
-
-	it "offers subresources via []" do
-		parent = RestClient::Resource.new('http://example.com')
-		parent['posts'].url.should == 'http://example.com/posts'
-	end
-
-	it "transports options to subresources" do
-		parent = RestClient::Resource.new('http://example.com', :user => 'user', :password => 'password')
-		parent['posts'].user.should == 'user'
-		parent['posts'].password.should == 'password'
-	end
-
-	it "prints its url with to_s" do
-		RestClient::Resource.new('x').to_s.should == 'x'
-	end
+  before do
+    @resource = RestClient::Resource.new('http://some/resource', :user => 'jane', :password => 'mypass', :headers => {'X-Something' => '1'})
+  end
+
+  context "Resource delegation" do
+    it "GET" do
+      RestClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => {'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
+      @resource.get
+    end
+
+    it "HEAD" do
+      RestClient::Request.should_receive(:execute).with(:method => :head, :url => 'http://some/resource', :headers => {'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
+      @resource.head
+    end
+
+    it "POST" do
+      RestClient::Request.should_receive(:execute).with(:method => :post, :url => 'http://some/resource', :payload => 'abc', :headers => {:content_type => 'image/jpg', 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
+      @resource.post 'abc', :content_type => 'image/jpg'
+    end
+
+    it "PUT" do
+      RestClient::Request.should_receive(:execute).with(:method => :put, :url => 'http://some/resource', :payload => 'abc', :headers => {:content_type => 'image/jpg', 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
+      @resource.put 'abc', :content_type => 'image/jpg'
+    end
+
+    it "PATCH" do
+      RestClient::Request.should_receive(:execute).with(:method => :patch, :url => 'http://some/resource', :payload => 'abc', :headers => {:content_type => 'image/jpg', 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
+      @resource.patch 'abc', :content_type => 'image/jpg'
+    end
+
+    it "DELETE" do
+      RestClient::Request.should_receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => {'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
+      @resource.delete
+    end
+
+    it "overrides resource headers" do
+      RestClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => {'X-Something' => '2'}, :user => 'jane', :password => 'mypass')
+      @resource.get 'X-Something' => '2'
+    end
+  end
+
+  it "can instantiate with no user/password" do
+    @resource = RestClient::Resource.new('http://some/resource')
+  end
+
+  it "is backwards compatible with previous constructor" do
+    @resource = RestClient::Resource.new('http://some/resource', 'user', 'pass')
+    @resource.user.should == 'user'
+    @resource.password.should == 'pass'
+  end
+
+  it "concatenates urls, inserting a slash when it needs one" do
+    @resource.concat_urls('http://example.com', 'resource').should == 'http://example.com/resource'
+  end
+
+  it "concatenates urls, using no slash if the first url ends with a slash" do
+    @resource.concat_urls('http://example.com/', 'resource').should == 'http://example.com/resource'
+  end
+
+  it "concatenates urls, using no slash if the second url starts with a slash" do
+    @resource.concat_urls('http://example.com', '/resource').should == 'http://example.com/resource'
+  end
+
+  it "concatenates even non-string urls, :posts + 1 => 'posts/1'" do
+    @resource.concat_urls(:posts, 1).should == 'posts/1'
+  end
+
+  it "offers subresources via []" do
+    parent = RestClient::Resource.new('http://example.com')
+    parent['posts'].url.should == 'http://example.com/posts'
+  end
+
+  it "transports options to subresources" do
+    parent = RestClient::Resource.new('http://example.com', :user => 'user', :password => 'password')
+    parent['posts'].user.should == 'user'
+    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
+
+  describe 'block' do
+    it 'can use block when creating the resource' do
+      stub_request(:get, 'www.example.com').to_return(:body => '', :status => 404)
+      resource = RestClient::Resource.new('www.example.com') { |response, request| 'foo' }
+      resource.get.should == 'foo'
+    end
+
+    it 'can use block when executing the resource' do
+      stub_request(:get, 'www.example.com').to_return(:body => '', :status => 404)
+      resource = RestClient::Resource.new('www.example.com')
+      resource.get { |response, request| 'foo' }.should == 'foo'
+    end
+
+    it 'execution block override resource block' do
+      stub_request(:get, 'www.example.com').to_return(:body => '', :status => 404)
+      resource = RestClient::Resource.new('www.example.com') { |response, request| 'foo' }
+      resource.get { |response, request| 'bar' }.should == 'bar'
+    end
+
+  end
 end

data/spec/response_spec.rb

@@ -1,21 +1,169 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__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)
-	end
-
-	it "behaves like string" do
-		@response.should == '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 == ""
-	end
-	
-	it "test headers and raw headers" do
-		@response.raw_headers["Status"][0].should == "200 OK"
-		@response.headers[:status].should == "200 OK"
-	end
+  before do
+    @net_http_res = mock('net http response', :to_hash => {"Status" => ["200 OK"]}, :code => 200)
+    @request = mock('http request', :user => nil, :password => nil)
+    @response = RestClient::Response.create('abc', @net_http_res, {})
+  end
+
+  it "behaves like string" do
+    @response.should.to_s == 'abc'
+    @response.to_str.should == 'abc'
+    @response.to_i.should == 200
+  end
+
+  it "accepts nil strings and sets it to empty for the case of HEAD" do
+    RestClient::Response.create(nil, @net_http_res, {}).should.to_s == ""
+  end
+
+  it "test headers and raw headers" do
+    @response.raw_headers["Status"][0].should == "200 OK"
+    @response.headers[:status].should == "200 OK"
+  end
+
+  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.create('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.create('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",
+              "remember_me" => "",
+              "user" => "somebody"
+      }
+    end
+
+    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.create('abc', net_http_res, {})
+      response.cookies.should == {
+              "main_page" => "main_page_no_rewrite",
+              "remember_me" => "",
+              "user" => "somebody"
+      }
+    end
+  end
+
+  describe "exceptions processing" 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.create('abc', net_http_res, {})
+        response.return! @request
+      end
+    end
+
+    it "should throw an exception for other codes" do
+      RestClient::Exceptions::EXCEPTIONS_MAP.each_key do |code|
+        unless (200..207).include? code
+          net_http_res = mock('net http response', :code => code.to_i)
+          response = RestClient::Response.create('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 "follows a redirection and keep the parameters" do
+      stub_request(:get, 'http://foo:bar@some/resource').with(:headers => {'Accept' => 'application/json'}).to_return(:body => '', :status => 301, :headers => {'Location' => 'http://new/resource'})
+      stub_request(:get, 'http://foo:bar@new/resource').with(:headers => {'Accept' => 'application/json'}).to_return(:body => 'Foo')
+      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})
+      lambda { response.return!(@request)}.should raise_error(RestClient::MovedPermanently)
+    end
+
+    it "doesn't follow a 302 when the request is a post" do
+      net_http_res = mock('net http response', :code => 302)
+      response = RestClient::Response.create('abc', net_http_res, {:method => :post})
+      lambda { response.return!(@request)}.should raise_error(RestClient::Found)
+    end
+
+    it "doesn't follow a 307 when the request is a post" do
+      net_http_res = mock('net http response', :code => 307)
+      response = RestClient::Response.create('abc', net_http_res, {:method => :post})
+      lambda { response.return!(@request)}.should raise_error(RestClient::TemporaryRedirect)
+    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.create('abc', net_http_res, {:method => :put})
+      lambda { response.return!(@request)}.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
+    
+    it "follows no more than 10 redirections before raising error" do
+      stub_request(:get, 'http://some/redirect-1').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://some/redirect-2'})
+      stub_request(:get, 'http://some/redirect-2').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://some/redirect-2'})
+      lambda { RestClient::Request.execute(:url => 'http://some/redirect-1', :method => :get) }.should raise_error(RestClient::MaxRedirectsReached)
+      WebMock.should have_requested(:get, 'http://some/redirect-2').times(10)
+    end
+    
+    it "follows no more than max_redirects redirections, if specified" do
+      stub_request(:get, 'http://some/redirect-1').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://some/redirect-2'})
+      stub_request(:get, 'http://some/redirect-2').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://some/redirect-2'})
+      lambda { RestClient::Request.execute(:url => 'http://some/redirect-1', :method => :get, :max_redirects => 5) }.should raise_error(RestClient::MaxRedirectsReached)
+      WebMock.should have_requested(:get, 'http://some/redirect-2').times(5)
+    end
+  end
+
+
 end

data/spec/restclient_spec.rb

@@ -1,53 +1,73 @@
-require File.dirname(__FILE__) + '/base'
+require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
 
 describe RestClient do
-	describe "API" do
-		it "GET" do
-			RestClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => {})
-			RestClient.get('http://some/resource')
-		end
-
-		it "POST" do
-			RestClient::Request.should_receive(:execute).with(:method => :post, :url => 'http://some/resource', :payload => 'payload', :headers => {})
-			RestClient.post('http://some/resource', 'payload')
-		end
-
-		it "PUT" do
-			RestClient::Request.should_receive(:execute).with(:method => :put, :url => 'http://some/resource', :payload => 'payload', :headers => {})
-			RestClient.put('http://some/resource', 'payload')
-		end
-
-		it "DELETE" do
-			RestClient::Request.should_receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => {})
-			RestClient.delete('http://some/resource')
-		end
-
-		it "HEAD" do
-			RestClient::Request.should_receive(:execute).with(:method => :head, :url => 'http://some/resource', :headers => {})
-			RestClient.head('http://some/resource')
-		end
-	end
-
-	describe "logging" do
-		after do
-			RestClient.log = nil
-		end
-
-		it "gets the log source from the RESTCLIENT_LOG environment variable" do
-			ENV.stub!(:[]).with('RESTCLIENT_LOG').and_return('from env')
-			RestClient.log = 'from class method'
-			RestClient.log.should == 'from env'
-		end
-
-		it "sets a destination for log output, used if no environment variable is set" do
-			ENV.stub!(:[]).with('RESTCLIENT_LOG').and_return(nil)
-			RestClient.log = 'from class method'
-			RestClient.log.should == 'from class method'
-		end
-
-		it "returns nil (no logging) if neither are set (default)" do
-			ENV.stub!(:[]).with('RESTCLIENT_LOG').and_return(nil)
-			RestClient.log.should == nil
-		end
-	end
+  describe "API" do
+    it "GET" do
+      RestClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => {})
+      RestClient.get('http://some/resource')
+    end
+
+    it "POST" do
+      RestClient::Request.should_receive(:execute).with(:method => :post, :url => 'http://some/resource', :payload => 'payload', :headers => {})
+      RestClient.post('http://some/resource', 'payload')
+    end
+
+    it "PUT" do
+      RestClient::Request.should_receive(:execute).with(:method => :put, :url => 'http://some/resource', :payload => 'payload', :headers => {})
+      RestClient.put('http://some/resource', 'payload')
+    end
+
+    it "PATCH" do
+      RestClient::Request.should_receive(:execute).with(:method => :patch, :url => 'http://some/resource', :payload => 'payload', :headers => {})
+      RestClient.patch('http://some/resource', 'payload')
+    end
+
+    it "DELETE" do
+      RestClient::Request.should_receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => {})
+      RestClient.delete('http://some/resource')
+    end
+
+    it "HEAD" 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
+    after do
+      RestClient.log = nil
+    end
+
+    it "uses << if the log is not a string" do
+      log = RestClient.log = []
+      log.should_receive(:<<).with('xyz')
+      RestClient.log << 'xyz'
+    end
+
+    it "displays the log to stdout" do
+      RestClient.log = 'stdout'
+      STDOUT.should_receive(:puts).with('xyz')
+      RestClient.log << 'xyz'
+    end
+
+    it "displays the log to stderr" do
+      RestClient.log = 'stderr'
+      STDERR.should_receive(:puts).with('xyz')
+      RestClient.log << 'xyz'
+    end
+
+    it "append the log to the requested filename" do
+      RestClient.log = '/tmp/restclient.log'
+      f = mock('file handle')
+      File.should_receive(:open).with('/tmp/restclient.log', 'a').and_yield(f)
+      f.should_receive(:puts).with('xyz')
+      RestClient.log << 'xyz'
+    end
+  end
+
 end