rest-client 1.6.14 → 2.0.2

data/rest-client.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 
-require File.expand_path("../lib/restclient/version", __FILE__)
+require File.expand_path('../lib/restclient/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name = 'rest-client'
@@ -10,17 +10,22 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
   s.email = 'rest.client@librelist.com'
   s.executables = ['restclient']
-  s.extra_rdoc_files = ["README.rdoc", "history.md"]
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- spec/*`.split("\n")
+  s.extra_rdoc_files = ['README.md', 'history.md']
+  s.files = `git ls-files -z`.split("\0")
+  s.test_files = `git ls-files -z spec/`.split("\0")
   s.homepage = 'https://github.com/rest-client/rest-client'
   s.summary = 'Simple HTTP and REST client for Ruby, inspired by microframework syntax for specifying actions.'
 
-  s.add_dependency(%q<mime-types>, ["~> 1.16"])
-  s.add_development_dependency(%q<rdoc>, [">= 2.4.2"])
-  s.add_development_dependency(%q<rake>, ["~> 10.0"])
-  s.add_development_dependency(%q<webmock>, ["~> 1.4"])
-  s.add_development_dependency(%q<rspec>, ["~> 2.4"])
-  s.add_development_dependency(%q<pry>)
-end
+  s.add_development_dependency('webmock', '~> 2.0')
+  s.add_development_dependency('rspec', '~> 3.0')
+  s.add_development_dependency('pry', '~> 0')
+  s.add_development_dependency('pry-doc', '~> 0')
+  s.add_development_dependency('rdoc', '>= 2.4.2', '< 6.0')
+  s.add_development_dependency('rubocop', '~> 0')
+
+  s.add_dependency('http-cookie', '>= 1.0.2', '< 2.0')
+  s.add_dependency('mime-types', '>= 1.16', '< 4.0')
+  s.add_dependency('netrc', '~> 0.8')
 
+  s.required_ruby_version = '>= 2.0.0'
+end

data/rest-client.windows.gemspec

@@ -0,0 +1,19 @@
+#
+# Gemspec for Windows platforms. We can't put these in the main gemspec because
+# it results in bundler platform hell when trying to build the gem.
+#
+# Set $BUILD_PLATFORM when calling gem build with this gemspec to build for
+# Windows platforms like x86-mingw32.
+#
+s = eval(File.read(File.join(File.dirname(__FILE__), 'rest-client.gemspec')))
+
+platform = ENV['BUILD_PLATFORM'] || RUBY_PLATFORM
+
+case platform
+when /(mingw32|mswin32)/
+  # ffi is needed for RestClient::Windows::RootCerts
+  s.add_dependency('ffi', '~> 1.9')
+  s.platform = platform
+end
+
+s

data/spec/helpers.rb

@@ -0,0 +1,22 @@
+require 'uri'
+
+module Helpers
+  def response_double(opts={})
+    double('response', {:to_hash => {}}.merge(opts))
+  end
+
+  def fake_stderr
+    original_stderr = $stderr
+    $stderr = StringIO.new
+    yield
+    $stderr.string
+  ensure
+    $stderr = original_stderr
+  end
+
+  def request_double(url: 'http://example.com', method: 'get')
+    double('request', url: url, uri: URI.parse(url), method: method,
+           user: nil, password: nil, cookie_jar: HTTP::CookieJar.new,
+           redirection_history: nil, args: {url: url, method: method})
+  end
+end

data/spec/integration/_lib.rb

@@ -0,0 +1 @@
+require_relative '../spec_helper'

data/spec/integration/capath_verisign/415660c1.0

@@ -0,0 +1,14 @@
+-----BEGIN CERTIFICATE-----
+MIICPDCCAaUCEHC65B0Q2Sk0tjjKewPMur8wDQYJKoZIhvcNAQECBQAwXzELMAkG
+A1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMTcwNQYDVQQLEy5DbGFz
+cyAzIFB1YmxpYyBQcmltYXJ5IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MB4XDTk2
+MDEyOTAwMDAwMFoXDTI4MDgwMTIzNTk1OVowXzELMAkGA1UEBhMCVVMxFzAVBgNV
+BAoTDlZlcmlTaWduLCBJbmMuMTcwNQYDVQQLEy5DbGFzcyAzIFB1YmxpYyBQcmlt
+YXJ5IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIGfMA0GCSqGSIb3DQEBAQUAA4GN
+ADCBiQKBgQDJXFme8huKARS0EN8EQNvjV69qRUCPhAwL0TPZ2RHP7gJYHyX3KqhE
+BarsAx94f56TuZoAqiN91qyFomNFx3InzPRMxnVx0jnvT0Lwdd8KkMaOIG+YD/is
+I19wKTakyYbnsZogy1Olhec9vn2a/iRFM9x2Fe0PonFkTGUugWhFpwIDAQABMA0G
+CSqGSIb3DQEBAgUAA4GBALtMEivPLCYATxQT3ab7/AoRhIzzKBxnki98tsX63/Do
+lbwdj2wsqFHMc9ikwFPwTtYmwHYBV4GSXiHx0bH/59AhWM1pF+NEHJwZRDmJXNyc
+AA9WjQKZ7aKQRUzkuxCkPfAyAw7xzvjoyVGM5mKf5p/AfbdynMk2OmufTqj/ZA1k
+-----END CERTIFICATE-----

data/spec/integration/capath_verisign/7651b327.0

@@ -0,0 +1,14 @@
+-----BEGIN CERTIFICATE-----
+MIICPDCCAaUCEHC65B0Q2Sk0tjjKewPMur8wDQYJKoZIhvcNAQECBQAwXzELMAkG
+A1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMTcwNQYDVQQLEy5DbGFz
+cyAzIFB1YmxpYyBQcmltYXJ5IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MB4XDTk2
+MDEyOTAwMDAwMFoXDTI4MDgwMTIzNTk1OVowXzELMAkGA1UEBhMCVVMxFzAVBgNV
+BAoTDlZlcmlTaWduLCBJbmMuMTcwNQYDVQQLEy5DbGFzcyAzIFB1YmxpYyBQcmlt
+YXJ5IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIGfMA0GCSqGSIb3DQEBAQUAA4GN
+ADCBiQKBgQDJXFme8huKARS0EN8EQNvjV69qRUCPhAwL0TPZ2RHP7gJYHyX3KqhE
+BarsAx94f56TuZoAqiN91qyFomNFx3InzPRMxnVx0jnvT0Lwdd8KkMaOIG+YD/is
+I19wKTakyYbnsZogy1Olhec9vn2a/iRFM9x2Fe0PonFkTGUugWhFpwIDAQABMA0G
+CSqGSIb3DQEBAgUAA4GBALtMEivPLCYATxQT3ab7/AoRhIzzKBxnki98tsX63/Do
+lbwdj2wsqFHMc9ikwFPwTtYmwHYBV4GSXiHx0bH/59AhWM1pF+NEHJwZRDmJXNyc
+AA9WjQKZ7aKQRUzkuxCkPfAyAw7xzvjoyVGM5mKf5p/AfbdynMk2OmufTqj/ZA1k
+-----END CERTIFICATE-----

data/spec/integration/capath_verisign/README

@@ -0,0 +1,8 @@
+The CA path symlinks can be created by c_rehash(1ssl).
+
+But in order for the tests to work on Windows, they have to be regular files.
+You can turn them all into regular files by running this on a GNU system:
+
+    for file in $(find . -type l); do
+        cp -iv --remove-destination $(readlink -e $file) $file
+    done

data/spec/integration/capath_verisign/verisign.crt

@@ -0,0 +1,14 @@
+-----BEGIN CERTIFICATE-----
+MIICPDCCAaUCEHC65B0Q2Sk0tjjKewPMur8wDQYJKoZIhvcNAQECBQAwXzELMAkG
+A1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMTcwNQYDVQQLEy5DbGFz
+cyAzIFB1YmxpYyBQcmltYXJ5IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MB4XDTk2
+MDEyOTAwMDAwMFoXDTI4MDgwMTIzNTk1OVowXzELMAkGA1UEBhMCVVMxFzAVBgNV
+BAoTDlZlcmlTaWduLCBJbmMuMTcwNQYDVQQLEy5DbGFzcyAzIFB1YmxpYyBQcmlt
+YXJ5IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIGfMA0GCSqGSIb3DQEBAQUAA4GN
+ADCBiQKBgQDJXFme8huKARS0EN8EQNvjV69qRUCPhAwL0TPZ2RHP7gJYHyX3KqhE
+BarsAx94f56TuZoAqiN91qyFomNFx3InzPRMxnVx0jnvT0Lwdd8KkMaOIG+YD/is
+I19wKTakyYbnsZogy1Olhec9vn2a/iRFM9x2Fe0PonFkTGUugWhFpwIDAQABMA0G
+CSqGSIb3DQEBAgUAA4GBALtMEivPLCYATxQT3ab7/AoRhIzzKBxnki98tsX63/Do
+lbwdj2wsqFHMc9ikwFPwTtYmwHYBV4GSXiHx0bH/59AhWM1pF+NEHJwZRDmJXNyc
+AA9WjQKZ7aKQRUzkuxCkPfAyAw7xzvjoyVGM5mKf5p/AfbdynMk2OmufTqj/ZA1k
+-----END CERTIFICATE-----

data/spec/integration/httpbin_spec.rb

@@ -0,0 +1,87 @@
+require_relative '_lib'
+require 'json'
+
+describe RestClient::Request do
+  before(:all) do
+    WebMock.disable!
+  end
+
+  after(:all) do
+    WebMock.enable!
+  end
+
+  def default_httpbin_url
+    # add a hack to work around java/jruby bug
+    # java.lang.RuntimeException: Could not generate DH keypair with backtrace
+    # Also (2017-04-09) Travis Jruby versions have a broken CA keystore
+    if ENV['TRAVIS_RUBY_VERSION'] =~ /\Ajruby-/
+      'http://httpbin.org/'
+    else
+      'https://httpbin.org/'
+    end
+  end
+
+  def httpbin(suffix='')
+    url = ENV.fetch('HTTPBIN_URL', default_httpbin_url)
+    unless url.end_with?('/')
+      url += '/'
+    end
+
+    url + suffix
+  end
+
+  def execute_httpbin(suffix, opts={})
+    opts = {url: httpbin(suffix)}.merge(opts)
+    RestClient::Request.execute(opts)
+  end
+
+  def execute_httpbin_json(suffix, opts={})
+    JSON.parse(execute_httpbin(suffix, opts))
+  end
+
+  describe '.execute' do
+    it 'sends a user agent' do
+      data = execute_httpbin_json('user-agent', method: :get)
+      expect(data['user-agent']).to match(/rest-client/)
+    end
+
+    it 'receives cookies on 302' do
+      expect {
+        execute_httpbin('cookies/set?foo=bar', method: :get, max_redirects: 0)
+      }.to raise_error(RestClient::Found) { |ex|
+        expect(ex.http_code).to eq 302
+        expect(ex.response.cookies['foo']).to eq 'bar'
+      }
+    end
+
+    it 'passes along cookies through 302' do
+      data = execute_httpbin_json('cookies/set?foo=bar', method: :get)
+      expect(data).to have_key('cookies')
+      expect(data['cookies']['foo']).to eq 'bar'
+    end
+
+    it 'handles quote wrapped cookies' do
+      expect {
+        execute_httpbin('cookies/set?foo=' + CGI.escape('"bar:baz"'),
+                        method: :get, max_redirects: 0)
+      }.to raise_error(RestClient::Found) { |ex|
+        expect(ex.http_code).to eq 302
+        expect(ex.response.cookies['foo']).to eq '"bar:baz"'
+      }
+    end
+
+    it 'sends basic auth' do
+      user = 'user'
+      pass = 'pass'
+
+      data = execute_httpbin_json("basic-auth/#{user}/#{pass}", method: :get, user: user, password: pass)
+      expect(data).to eq({'authenticated' => true, 'user' => user})
+
+      expect {
+        execute_httpbin_json("basic-auth/#{user}/#{pass}", method: :get, user: user, password: 'badpass')
+      }.to raise_error(RestClient::Unauthorized) { |ex|
+        expect(ex.http_code).to eq 401
+      }
+    end
+  end
+end

data/spec/integration/integration_spec.rb

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+require_relative '_lib'
+require 'base64'
+
+describe RestClient do
+
+  it "a simple request" do
+    body = 'abc'
+    stub_request(:get, "www.example.com").to_return(:body => body, :status => 200)
+    response = RestClient.get "www.example.com"
+    expect(response.code).to eq 200
+    expect(response.body).to eq 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"
+    expect(response.code).to eq 200
+    expect(response.body).to eq "i'm gziped\n"
+  end
+
+  it "a 404" do
+    body = "Ho hai ! I'm not here !"
+    stub_request(:get, "www.example.com").to_return(:body => body, :status => 404)
+    begin
+      RestClient.get "www.example.com"
+      raise
+    rescue RestClient::ResourceNotFound => e
+      expect(e.http_code).to eq 404
+      expect(e.response.code).to eq 404
+      expect(e.response.body).to eq body
+      expect(e.http_body).to eq body
+    end
+  end
+
+  describe 'charset parsing' do
+    it 'handles utf-8' do
+      body = "λ".force_encoding('ASCII-8BIT')
+      stub_request(:get, "www.example.com").to_return(
+        :body => body, :status => 200, :headers => {
+          'Content-Type' => 'text/plain; charset=UTF-8'
+      })
+      response = RestClient.get "www.example.com"
+      expect(response.encoding).to eq Encoding::UTF_8
+      expect(response.valid_encoding?).to eq true
+    end
+
+    it 'handles windows-1252' do
+      body = "\xff".force_encoding('ASCII-8BIT')
+      stub_request(:get, "www.example.com").to_return(
+        :body => body, :status => 200, :headers => {
+          'Content-Type' => 'text/plain; charset=windows-1252'
+      })
+      response = RestClient.get "www.example.com"
+      expect(response.encoding).to eq Encoding::WINDOWS_1252
+      expect(response.encode('utf-8')).to eq "ÿ"
+      expect(response.valid_encoding?).to eq true
+    end
+
+    it 'handles binary' do
+      body = "\xfe".force_encoding('ASCII-8BIT')
+      stub_request(:get, "www.example.com").to_return(
+        :body => body, :status => 200, :headers => {
+          'Content-Type' => 'application/octet-stream; charset=binary'
+      })
+      response = RestClient.get "www.example.com"
+      expect(response.encoding).to eq Encoding::BINARY
+      expect {
+        response.encode('utf-8')
+      }.to raise_error(Encoding::UndefinedConversionError)
+      expect(response.valid_encoding?).to eq true
+    end
+
+    it 'handles euc-jp' do
+      body = "\xA4\xA2\xA4\xA4\xA4\xA6\xA4\xA8\xA4\xAA".
+        force_encoding(Encoding::BINARY)
+      body_utf8 = 'あいうえお'
+      expect(body_utf8.encoding).to eq Encoding::UTF_8
+
+      stub_request(:get, 'www.example.com').to_return(
+        :body => body, :status => 200, :headers => {
+          'Content-Type' => 'text/plain; charset=EUC-JP'
+      })
+      response = RestClient.get 'www.example.com'
+      expect(response.encoding).to eq Encoding::EUC_JP
+      expect(response.valid_encoding?).to eq true
+      expect(response.length).to eq 5
+      expect(response.encode('utf-8')).to eq body_utf8
+    end
+
+    it 'defaults to the default encoding' do
+      stub_request(:get, 'www.example.com').to_return(
+        body: 'abc', status: 200, headers: {
+          'Content-Type' => 'text/plain'
+        })
+
+      response = RestClient.get 'www.example.com'
+      # expect(response.encoding).to eq Encoding.default_external
+      expect(response.encoding).to eq Encoding::UTF_8
+    end
+
+    it 'handles invalid encoding' do
+      stub_request(:get, 'www.example.com').to_return(
+        body: 'abc', status: 200, headers: {
+          'Content-Type' => 'text; charset=plain'
+        })
+
+      response = RestClient.get 'www.example.com'
+      # expect(response.encoding).to eq Encoding.default_external
+      expect(response.encoding).to eq Encoding::UTF_8
+    end
+
+    it 'leaves images as binary' do
+      gif = Base64.strict_decode64('R0lGODlhAQABAAAAADs=')
+
+      stub_request(:get, 'www.example.com').to_return(
+        body: gif, status: 200, headers: {
+          'Content-Type' => 'image/gif'
+        })
+
+      response = RestClient.get 'www.example.com'
+      expect(response.encoding).to eq Encoding::BINARY
+    end
+  end
+end

data/spec/integration/request_spec.rb

@@ -1,37 +1,68 @@
-require File.join( File.dirname(File.expand_path(__FILE__)), '../base')
+require_relative '_lib'
 
 describe RestClient::Request do
+  before(:all) do
+    WebMock.disable!
+  end
+
+  after(:all) do
+    WebMock.enable!
+  end
+
   describe "ssl verification" do
     it "is successful with the correct ca_file" do
       request = RestClient::Request.new(
         :method => :get,
         :url => 'https://www.mozilla.org',
-        :verify_ssl => OpenSSL::SSL::VERIFY_PEER,
         :ssl_ca_file => File.join(File.dirname(__FILE__), "certs", "digicert.crt")
       )
       expect { request.execute }.to_not raise_error
     end
 
-    # I don' think this feature is useful anymore (under 1.9.3 at the very least).
-    #
-    # Exceptions in verify_callback are ignored; RestClient has to catch OpenSSL::SSL::SSLError
-    # and either re-throw it as is, or throw SSLCertificateNotVerified
-    # based on the contents of the message field of the original exception
-    #.
-    # The client has to handle OpenSSL::SSL::SSLError exceptions anyway,
-    # why make them handle both OpenSSL *AND* RestClient exceptions???
+    it "is successful with the correct ca_path" do
+      request = RestClient::Request.new(
+        :method => :get,
+        :url => 'https://www.mozilla.org',
+        :ssl_ca_path => File.join(File.dirname(__FILE__), "capath_digicert")
+      )
+      expect { request.execute }.to_not raise_error
+    end
+
+    # TODO: deprecate and remove RestClient::SSLCertificateNotVerified and just
+    # pass through OpenSSL::SSL::SSLError directly. See note in
+    # lib/restclient/request.rb.
     #
-    # also see https://github.com/ruby/ruby/blob/trunk/ext/openssl/ossl.c#L237
-    it "is unsuccessful with an incorrect ca_file" do
+    # On OS X, this test fails since Apple has patched OpenSSL to always fall
+    # back on the system CA store.
+    it "is unsuccessful with an incorrect ca_file", :unless => RestClient::Platform.mac_mri? do
       request = RestClient::Request.new(
         :method => :get,
-        :url => 'https://www.mozilla.com',
-        :verify_ssl => OpenSSL::SSL::VERIFY_PEER,
+        :url => 'https://www.mozilla.org',
         :ssl_ca_file => File.join(File.dirname(__FILE__), "certs", "verisign.crt")
       )
       expect { request.execute }.to raise_error(RestClient::SSLCertificateNotVerified)
     end
 
+    # On OS X, this test fails since Apple has patched OpenSSL to always fall
+    # back on the system CA store.
+    it "is unsuccessful with an incorrect ca_path", :unless => RestClient::Platform.mac_mri? do
+      request = RestClient::Request.new(
+        :method => :get,
+        :url => 'https://www.mozilla.org',
+        :ssl_ca_path => File.join(File.dirname(__FILE__), "capath_verisign")
+      )
+      expect { request.execute }.to raise_error(RestClient::SSLCertificateNotVerified)
+    end
+
+    it "is successful using the default system cert store" do
+      request = RestClient::Request.new(
+        :method => :get,
+        :url => 'https://www.mozilla.org',
+        :verify_ssl => true,
+      )
+      expect {request.execute }.to_not raise_error
+    end
+
     it "executes the verify_callback" do
       ran_callback = false
       request = RestClient::Request.new(
@@ -42,34 +73,55 @@ describe RestClient::Request do
           ran_callback = true
           preverify_ok
         },
-        :ssl_ca_file => File.join(File.dirname(__FILE__), "certs", "digicert.crt")
       )
       expect {request.execute }.to_not raise_error
-      ran_callback.should eq(true)
+      expect(ran_callback).to eq(true)
     end
 
     it "fails verification when the callback returns false",
-       :unless => RestClient::Platform.mac? do
+       :unless => RestClient::Platform.mac_mri? do
       request = RestClient::Request.new(
         :method => :get,
         :url => 'https://www.mozilla.org',
         :verify_ssl => true,
         :ssl_verify_callback => lambda { |preverify_ok, store_ctx| false },
-        :ssl_ca_file => File.join(File.dirname(__FILE__), "certs", "digicert.crt")
       )
       expect { request.execute }.to raise_error(RestClient::SSLCertificateNotVerified)
     end
 
     it "succeeds verification when the callback returns true",
-       :unless => RestClient::Platform.mac? do
+       :unless => RestClient::Platform.mac_mri? do
       request = RestClient::Request.new(
         :method => :get,
         :url => 'https://www.mozilla.org',
         :verify_ssl => true,
         :ssl_ca_file => File.join(File.dirname(__FILE__), "certs", "verisign.crt"),
-        :ssl_verify_callback => lambda { |preverify_ok, store_ctx| true }
+        :ssl_verify_callback => lambda { |preverify_ok, store_ctx| true },
       )
       expect { request.execute }.to_not raise_error
     end
   end
+
+  describe "timeouts" do
+    it "raises OpenTimeout when it hits an open timeout" do
+      request = RestClient::Request.new(
+        :method => :get,
+        :url => 'http://www.mozilla.org',
+        :open_timeout => 1e-10,
+      )
+      expect { request.execute }.to(
+        raise_error(RestClient::Exceptions::OpenTimeout))
+    end
+
+    it "raises ReadTimeout when it hits a read timeout via :read_timeout" do
+      request = RestClient::Request.new(
+        :method => :get,
+        :url => 'https://www.mozilla.org',
+        :read_timeout => 1e-10,
+      )
+      expect { request.execute }.to(
+        raise_error(RestClient::Exceptions::ReadTimeout))
+    end
+  end
+
 end