rest-client 1.6.7 → 2.1.0

data/spec/unit/resource_spec.rb

@@ -0,0 +1,134 @@
+require_relative '_lib'
+
+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
+      expect(RestClient::Request).to receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => {'X-Something' => '1'}, :user => 'jane', :password => 'mypass', :log => nil)
+      @resource.get
+    end
+
+    it "HEAD" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :head, :url => 'http://some/resource', :headers => {'X-Something' => '1'}, :user => 'jane', :password => 'mypass', :log => nil)
+      @resource.head
+    end
+
+    it "POST" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :post, :url => 'http://some/resource', :payload => 'abc', :headers => {:content_type => 'image/jpg', 'X-Something' => '1'}, :user => 'jane', :password => 'mypass', :log => nil)
+      @resource.post 'abc', :content_type => 'image/jpg'
+    end
+
+    it "PUT" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :put, :url => 'http://some/resource', :payload => 'abc', :headers => {:content_type => 'image/jpg', 'X-Something' => '1'}, :user => 'jane', :password => 'mypass', :log => nil)
+      @resource.put 'abc', :content_type => 'image/jpg'
+    end
+
+    it "PATCH" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :patch, :url => 'http://some/resource', :payload => 'abc', :headers => {:content_type => 'image/jpg', 'X-Something' => '1'}, :user => 'jane', :password => 'mypass', :log => nil)
+      @resource.patch 'abc', :content_type => 'image/jpg'
+    end
+
+    it "DELETE" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => {'X-Something' => '1'}, :user => 'jane', :password => 'mypass', :log => nil)
+      @resource.delete
+    end
+
+    it "overrides resource headers" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => {'X-Something' => '2'}, :user => 'jane', :password => 'mypass', :log => nil)
+      @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')
+    expect(@resource.user).to eq 'user'
+    expect(@resource.password).to eq 'pass'
+  end
+
+  it "concatenates urls, inserting a slash when it needs one" do
+    expect(@resource.concat_urls('http://example.com', 'resource')).to eq 'http://example.com/resource'
+  end
+
+  it "concatenates urls, using no slash if the first url ends with a slash" do
+    expect(@resource.concat_urls('http://example.com/', 'resource')).to eq 'http://example.com/resource'
+  end
+
+  it "concatenates urls, using no slash if the second url starts with a slash" do
+    expect(@resource.concat_urls('http://example.com', '/resource')).to eq 'http://example.com/resource'
+  end
+
+  it "concatenates even non-string urls, :posts + 1 => 'posts/1'" do
+    expect(@resource.concat_urls(:posts, 1)).to eq 'posts/1'
+  end
+
+  it "offers subresources via []" do
+    parent = RestClient::Resource.new('http://example.com')
+    expect(parent['posts'].url).to eq 'http://example.com/posts'
+  end
+
+  it "transports options to subresources" do
+    parent = RestClient::Resource.new('http://example.com', :user => 'user', :password => 'password')
+    expect(parent['posts'].user).to eq 'user'
+    expect(parent['posts'].password).to eq 'password'
+  end
+
+  it "passes a given block to subresources" do
+    block = proc {|r| r}
+    parent = RestClient::Resource.new('http://example.com', &block)
+    expect(parent['posts'].block).to eq block
+  end
+
+  it "the block should be overrideable" do
+    block1 = proc {|r| r}
+    block2 = proc {|r| }
+    parent = RestClient::Resource.new('http://example.com', &block1)
+    # parent['posts', &block2].block.should eq block2 # ruby 1.9 syntax
+    expect(parent.send(:[], 'posts', &block2).block).to eq block2
+    expect(parent.send(:[], 'posts', &block2).block).not_to eq block1
+  end
+
+  # Test fails on jruby 9.1.[0-5].* due to
+  # https://github.com/jruby/jruby/issues/4217
+  it "the block should be overrideable in ruby 1.9 syntax",
+      :unless => (RUBY_ENGINE == 'jruby' && JRUBY_VERSION =~ /\A9\.1\.[0-5]\./) \
+  do
+    block1 = proc {|r| r}
+    block2 = ->(r) {}
+
+    parent = RestClient::Resource.new('http://example.com', &block1)
+    expect(parent['posts', &block2].block).to eq block2
+    expect(parent['posts', &block2].block).not_to eq block1
+  end
+
+  it "prints its url with to_s" do
+    expect(RestClient::Resource.new('x').to_s).to eq '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' }
+      expect(resource.get).to eq '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')
+      expect(resource.get { |response, request| 'foo' }).to eq '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' }
+      expect(resource.get { |response, request| 'bar' }).to eq 'bar'
+    end
+
+  end
+end

data/spec/unit/response_spec.rb

@@ -0,0 +1,252 @@
+require_relative '_lib'
+
+describe RestClient::Response, :include_helpers do
+  before do
+    @net_http_res = res_double(to_hash: {'Status' => ['200 OK']}, code: '200', body: 'abc')
+    @example_url = 'http://example.com'
+    @request = request_double(url: @example_url, method: 'get')
+    @response = response_from_res_double(@net_http_res, @request, duration: 1)
+  end
+
+  it "behaves like string" do
+    expect(@response.to_s).to eq 'abc'
+    expect(@response.to_str).to eq 'abc'
+
+    expect(@response).to receive(:warn)
+    expect(@response.to_i).to eq 0
+  end
+
+  it "accepts nil strings and sets it to empty for the case of HEAD" do
+    # TODO
+    expect(RestClient::Response.create(nil, @net_http_res, @request).to_s).to eq ""
+  end
+
+  describe 'header processing' do
+    it "test headers and raw headers" do
+      expect(@response.raw_headers["Status"][0]).to eq "200 OK"
+      expect(@response.headers[:status]).to eq "200 OK"
+    end
+
+    it 'handles multiple headers by joining with comma' do
+      net_http_res = res_double(to_hash: {'My-Header' => ['foo', 'bar']}, code: '200', body: nil)
+      example_url = 'http://example.com'
+      request = request_double(url: example_url, method: 'get')
+      response = response_from_res_double(net_http_res, request)
+
+      expect(response.raw_headers['My-Header']).to eq ['foo', 'bar']
+      expect(response.headers[:my_header]).to eq 'foo, bar'
+    end
+  end
+
+  describe "cookie processing" do
+    it "should correctly deal with one Set-Cookie header with one cookie inside" do
+      header_val = "main_page=main_page_no_rewrite; path=/; expires=Sat, 10-Jan-2037 15:03:14 GMT".freeze
+
+      net_http_res = double('net http response', :to_hash => {"etag" => ["\"e1ac1a2df945942ef4cac8116366baad\""], "set-cookie" => [header_val]})
+      response = RestClient::Response.create('abc', net_http_res, @request)
+      expect(response.headers[:set_cookie]).to eq [header_val]
+      expect(response.cookies).to eq({ "main_page" => "main_page_no_rewrite" })
+    end
+
+    it "should correctly deal with multiple cookies [multiple Set-Cookie headers]" do
+      net_http_res = double('net http response', :to_hash => {"etag" => ["\"e1ac1a2df945942ef4cac8116366baad\""], "set-cookie" => ["main_page=main_page_no_rewrite; path=/; expires=Sat, 10-Jan-2037 15:03:14 GMT", "remember_me=; path=/; expires=Sat, 10-Jan-2037 00:00:00 GMT", "user=somebody; path=/; expires=Sat, 10-Jan-2037 00:00:00 GMT"]})
+      response = RestClient::Response.create('abc', net_http_res, @request)
+      expect(response.headers[:set_cookie]).to eq ["main_page=main_page_no_rewrite; path=/; expires=Sat, 10-Jan-2037 15:03:14 GMT", "remember_me=; path=/; expires=Sat, 10-Jan-2037 00:00:00 GMT", "user=somebody; path=/; expires=Sat, 10-Jan-2037 00:00:00 GMT"]
+      expect(response.cookies).to eq({
+        "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 = double('net http response', :to_hash => {"etag" => ["\"e1ac1a2df945942ef4cac8116366baad\""], "set-cookie" => ["main_page=main_page_no_rewrite; path=/; expires=Sat, 10-Jan-2037 15:03:14 GMT, remember_me=; path=/; expires=Sat, 10-Jan-2037 00:00:00 GMT, user=somebody; path=/; expires=Sat, 10-Jan-2037 00:00:00 GMT"]})
+      response = RestClient::Response.create('abc', net_http_res, @request)
+      expect(response.cookies).to eq({
+        "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 = res_double(:code => '200')
+        resp = RestClient::Response.create('abc', net_http_res, @request)
+        resp.return!
+      end
+    end
+
+    it "should throw an exception for other codes" do
+      RestClient::Exceptions::EXCEPTIONS_MAP.each_pair do |code, exc|
+        unless (200..207).include? code
+          net_http_res = res_double(:code => code.to_i)
+          resp = RestClient::Response.create('abc', net_http_res, @request)
+          allow(@request).to receive(:max_redirects).and_return(5)
+          expect { resp.return! }.to raise_error(exc)
+        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')
+      expect(RestClient::Request.execute(:url => 'http://some/resource', :method => :get).body).to eq 'Foo'
+    end
+
+    it "keeps redirection history" 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')
+      r = RestClient::Request.execute(url: 'http://some/resource', method: :get)
+      expect(r.body).to eq 'Foo'
+      expect(r.history.length).to eq 1
+      expect(r.history.fetch(0)).to be_a(RestClient::Response)
+      expect(r.history.fetch(0).code).to be 301
+    end
+
+    it "follows a redirection and keep the parameters" do
+      stub_request(:get, 'http://some/resource').with(:headers => {'Accept' => 'application/json'}, :basic_auth => ['foo', 'bar']).to_return(:body => '', :status => 301, :headers => {'Location' => 'http://new/resource'})
+      stub_request(:get, 'http://new/resource').with(:headers => {'Accept' => 'application/json'}, :basic_auth => ['foo', 'bar']).to_return(:body => 'Foo')
+      expect(RestClient::Request.execute(:url => 'http://some/resource', :method => :get, :user => 'foo', :password => 'bar', :headers => {:accept => :json}).body).to eq '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' => 'Foo=Bar', 'Location' => 'http://some/new_resource', })
+      stub_request(:get, 'http://some/new_resource').with(:headers => {'Cookie' => 'Foo=Bar'}).to_return(:body => 'Qux')
+      expect(RestClient::Request.execute(:url => 'http://some/resource', :method => :get).body).to eq 'Qux'
+    end
+
+    it 'respects cookie domains on redirect' do
+      stub_request(:get, 'http://some.example.com/').to_return(:body => '', :status => 301,
+        :headers => {'Set-Cookie' => 'Foo=Bar', 'Location' => 'http://new.example.com/', })
+      stub_request(:get, 'http://new.example.com/').with(
+        :headers => {'Cookie' => 'passedthrough=1'}).to_return(:body => 'Qux')
+
+      expect(RestClient::Request.execute(:url => 'http://some.example.com/', :method => :get, cookies: [HTTP::Cookie.new('passedthrough', '1', domain: 'new.example.com', path: '/')]).body).to eq 'Qux'
+    end
+
+    it "doesn't follow a 301 when the request is a post" do
+      net_http_res = res_double(:code => 301)
+      response = response_from_res_double(net_http_res, request_double(method: 'post'))
+
+      expect {
+        response.return!
+      }.to raise_error(RestClient::MovedPermanently)
+    end
+
+    it "doesn't follow a 302 when the request is a post" do
+      net_http_res = res_double(:code => 302)
+      response = response_from_res_double(net_http_res, request_double(method: 'post'))
+
+      expect {
+        response.return!
+      }.to raise_error(RestClient::Found)
+    end
+
+    it "doesn't follow a 307 when the request is a post" do
+      net_http_res = res_double(:code => 307)
+      response = response_from_res_double(net_http_res, request_double(method: 'post'))
+
+      expect(response).not_to receive(:follow_redirection)
+      expect {
+        response.return!
+      }.to raise_error(RestClient::TemporaryRedirect)
+    end
+
+    it "doesn't follow a redirection when the request is a put" do
+      net_http_res = res_double(:code => 301)
+      response = response_from_res_double(net_http_res, request_double(method: 'put'))
+      expect {
+        response.return!
+      }.to 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')
+      expect(RestClient::Request.execute(:url => 'http://some/resource', :method => :put).body).to eq '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')
+      expect(RestClient::Request.execute(:url => 'http://some/resource', :method => :head).body).to eq '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')
+      expect(RestClient::Request.execute(:url => 'http://some/resource', :method => :get).body).to eq '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')
+      expect(RestClient::Request.execute(:url => 'http://some/resource', :method => :get).body).to eq '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')
+      expect(RestClient::Request.execute(:url => 'http://some/resource', :method => :get).body).to eq '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'})
+      expect {
+        RestClient::Request.execute(url: 'http://some/redirect-1', method: :get)
+      }.to raise_error(RestClient::MovedPermanently) { |ex|
+        ex.response.history.each {|r| expect(r).to be_a(RestClient::Response) }
+        expect(ex.response.history.length).to eq 10
+      }
+      expect(WebMock).to 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'})
+      expect {
+        RestClient::Request.execute(url: 'http://some/redirect-1', method: :get, max_redirects: 5)
+      }.to raise_error(RestClient::MovedPermanently) { |ex|
+        expect(ex.response.history.length).to eq 5
+      }
+      expect(WebMock).to have_requested(:get, 'http://some/redirect-2').times(5)
+    end
+
+    it "allows for manual following of redirects" do
+      stub_request(:get, 'http://some/redirect-1').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://some/resource'})
+      stub_request(:get, 'http://some/resource').to_return(:body => 'Qux', :status => 200)
+
+      begin
+        RestClient::Request.execute(url: 'http://some/redirect-1', method: :get, max_redirects: 0)
+      rescue RestClient::MovedPermanently => err
+        resp = err.response.follow_redirection
+      else
+        raise 'notreached'
+      end
+
+      expect(resp.code).to eq 200
+      expect(resp.body).to eq 'Qux'
+    end
+  end
+
+  describe "logging" do
+    it "uses the request's logger" do
+      stub_request(:get, 'http://some/resource').to_return(body: 'potato', status: 200)
+
+      logger = double('logger', '<<' => true)
+      request = RestClient::Request.new(url: 'http://some/resource', method: :get, log: logger)
+
+      expect(logger).to receive(:<<)
+
+      request.execute
+    end
+  end
+end

data/spec/unit/restclient_spec.rb

@@ -0,0 +1,80 @@
+require_relative '_lib'
+
+describe RestClient do
+  describe "API" do
+    it "GET" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => {})
+      RestClient.get('http://some/resource')
+    end
+
+    it "POST" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :post, :url => 'http://some/resource', :payload => 'payload', :headers => {})
+      RestClient.post('http://some/resource', 'payload')
+    end
+
+    it "PUT" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :put, :url => 'http://some/resource', :payload => 'payload', :headers => {})
+      RestClient.put('http://some/resource', 'payload')
+    end
+
+    it "PATCH" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :patch, :url => 'http://some/resource', :payload => 'payload', :headers => {})
+      RestClient.patch('http://some/resource', 'payload')
+    end
+
+    it "DELETE" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => {})
+      RestClient.delete('http://some/resource')
+    end
+
+    it "HEAD" do
+      expect(RestClient::Request).to receive(:execute).with(:method => :head, :url => 'http://some/resource', :headers => {})
+      RestClient.head('http://some/resource')
+    end
+
+    it "OPTIONS" do
+      expect(RestClient::Request).to 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 = []
+      expect(log).to receive(:<<).with('xyz')
+      RestClient.log << 'xyz'
+    end
+
+    it "displays the log to stdout" do
+      RestClient.log = 'stdout'
+      expect(STDOUT).to receive(:puts).with('xyz')
+      RestClient.log << 'xyz'
+    end
+
+    it "displays the log to stderr" do
+      RestClient.log = 'stderr'
+      expect(STDERR).to receive(:puts).with('xyz')
+      RestClient.log << 'xyz'
+    end
+
+    it "append the log to the requested filename" do
+      RestClient.log = '/tmp/restclient.log'
+      f = double('file handle')
+      expect(File).to receive(:open).with('/tmp/restclient.log', 'a').and_yield(f)
+      expect(f).to receive(:puts).with('xyz')
+      RestClient.log << 'xyz'
+    end
+  end
+
+  describe 'version' do
+    # test that there is a sane version number to avoid accidental 0.0.0 again
+    it 'has a version > 2.0.0.alpha, < 3.0' do
+      ver = Gem::Version.new(RestClient.version)
+      expect(Gem::Requirement.new('> 2.0.0.alpha', '< 3.0')).to be_satisfied_by(ver)
+    end
+  end
+end